Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Add &Util.end_of_service/1 #2335

Merged
merged 1 commit into from
Jan 17, 2025
Merged

chore: Add &Util.end_of_service/1 #2335

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 49 additions & 0 deletions lib/util/util.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -252,6 +252,55 @@ defmodule Util do

@doc """

The time corresponding to end-of-service, given that service day
boundaries at at 3am each day.

## Examples
iex> time = Timex.to_datetime(~N[2025-01-17T12:00:00], "America/New_York")
iex> Util.end_of_service(time)
#DateTime<2025-01-18 03:00:00-05:00 EST America/New_York>

# Does not shift to the next day if the given time is earlier than end-of-service
iex> time = Timex.to_datetime(~N[2025-01-17T02:00:00], "America/New_York")
iex> Util.end_of_service(time)
#DateTime<2025-01-17 03:00:00-05:00 EST America/New_York>

# Also handles times in UTC
iex> time = ~U[2025-01-17T17:00:00Z] # Noon in Eastern Time, given 5-hour offset
iex> Util.end_of_service(time)
#DateTime<2025-01-18 03:00:00-05:00 EST America/New_York>

iex> time = ~U[2025-01-17T06:00:00Z] # Early enough that it's before 3am
iex> Util.end_of_service(time)
#DateTime<2025-01-17 03:00:00-05:00 EST America/New_York>

The time returned is exactly equal to beginning of service the next
day, so when comparing to the time returned, use `&Timex.before?/2`
or equivalent for a strictly-less-than comparison.

## Examples
iex> now = Timex.to_datetime(~N[2025-01-17T12:00:00], "America/New_York")
iex> time_of_interest = Timex.to_datetime(~N[2025-01-18T03:00:00], "America/New_York") # Technically part of "tomorrow"'s service date
iex> Timex.before?(time_of_interest, Util.end_of_service(now))
false

iex> now = Timex.to_datetime(~N[2025-01-17T12:00:00], "America/New_York")
iex> time_of_interest = Timex.to_datetime(~N[2025-01-18T02:59:59], "America/New_York") # Part of "today"'s service date
iex> Timex.before?(time_of_interest, Util.end_of_service(now))
true

"""
@spec end_of_service(DateTime.t() | NaiveDateTime.t()) :: DateTime.t()
def end_of_service(current_time \\ Util.now()) do
current_time
|> service_date()
|> Timex.shift(days: 1)
|> Timex.to_datetime("America/New_York")
|> Timex.set(hour: 3)
end

@doc """

Returns an id property in a struct or nil

"""
Expand Down
Loading