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

Add start_day parameter to Time#at_beginning_of_week #13446

Merged
merged 10 commits into from
May 24, 2023
Merged

Add start_day parameter to Time#at_beginning_of_week #13446

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
a34867d
Allow an optional `start_day` argument for `Time#at_beginning_of_week`
DanielGilchrist May 8, 2023
106bec6
Add test cases for if an invalid `String` or `Symbol` argument are pa…
DanielGilchrist May 8, 2023
fdb71f8
Drop `String | Symbol` overload and instead leverage Symbol autocasting
DanielGilchrist May 8, 2023
c277911
Run `crystal tool format`
DanielGilchrist May 8, 2023
614478c
Use autocasting in definition
DanielGilchrist May 8, 2023
261e71b
Merge branch 'master' into at-beginning-of-week-start-day
DanielGilchrist May 16, 2023
a08f0d2
Simplify documentation, use a more interesting example than monday an…
DanielGilchrist May 16, 2023
a4b6914
Add specs to assert hour, minute and day is set to 0 when using `Time…
DanielGilchrist May 16, 2023
85cc6b3
Use a fixed timestamp in documentation
DanielGilchrist May 16, 2023
071c709
Merge branch 'master' into at-beginning-of-week-start-day
DanielGilchrist May 18, 2023
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
31 changes: 31 additions & 0 deletions spec/std/time/time_spec.cr
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -659,6 +659,37 @@ describe Time do
Time.utc(2014, 11, i).at_beginning_of_week.should eq Time.utc(2014, 11, 3)
end

sunday_day_of_week = Time::DayOfWeek::Sunday
Time.utc(2014, 11, 1).at_beginning_of_week(sunday_day_of_week).should eq Time.utc(2014, 10, 26)
2.upto(8) do |i|
Time.utc(2014, 11, i).at_beginning_of_week(sunday_day_of_week).should eq Time.utc(2014, 11, 2)
end
Time.utc(2014, 11, 9).at_beginning_of_week(sunday_day_of_week).should eq Time.utc(2014, 11, 9)

Time.utc(2014, 11, 1).at_beginning_of_week(:sunday).should eq Time.utc(2014, 10, 26)
2.upto(8) do |i|
Time.utc(2014, 11, i).at_beginning_of_week(:sunday).should eq Time.utc(2014, 11, 2)
end
Time.utc(2014, 11, 9).at_beginning_of_week(:sunday).should eq Time.utc(2014, 11, 9)

Time.utc(2014, 11, 10).at_beginning_of_week(Time::DayOfWeek::Sunday).should eq Time.utc(2014, 11, 9)
Time.utc(2014, 11, 10).at_beginning_of_week(Time::DayOfWeek::Monday).should eq Time.utc(2014, 11, 10)
Time.utc(2014, 11, 10).at_beginning_of_week(Time::DayOfWeek::Tuesday).should eq Time.utc(2014, 11, 4)
Time.utc(2014, 11, 10).at_beginning_of_week(Time::DayOfWeek::Wednesday).should eq Time.utc(2014, 11, 5)
Time.utc(2014, 11, 10).at_beginning_of_week(Time::DayOfWeek::Thursday).should eq Time.utc(2014, 11, 6)
Time.utc(2014, 11, 10).at_beginning_of_week(Time::DayOfWeek::Friday).should eq Time.utc(2014, 11, 7)
Time.utc(2014, 11, 10).at_beginning_of_week(Time::DayOfWeek::Saturday).should eq Time.utc(2014, 11, 8)

at_beginning_of_week_default = Time.local.at_beginning_of_week
at_beginning_of_week_default.hour.should eq 0
at_beginning_of_week_default.minute.should eq 0
at_beginning_of_week_default.second.should eq 0

at_beginning_of_week_sunday = Time.local.at_beginning_of_week(:sunday)
at_beginning_of_week_sunday.hour.should eq 0
at_beginning_of_week_sunday.minute.should eq 0
at_beginning_of_week_sunday.second.should eq 0

t1.at_beginning_of_day.should eq Time.utc(2014, 11, 25)
t1.at_beginning_of_hour.should eq Time.utc(2014, 11, 25, 10)
t1.at_beginning_of_minute.should eq Time.utc(2014, 11, 25, 10, 11)
Expand Down
12 changes: 10 additions & 2 deletions src/time.cr
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1359,9 +1359,17 @@ struct Time

# Returns a copy of this `Time` representing the beginning of the week.
#
# The week starts on Monday by default, but can be configured by passing a different `start_day` as a `Time::DayOfWeek`.
#
# ```
# now = Time.utc(2023, 5, 16, 17, 53, 22)
# now.at_beginning_of_week # => 2023-05-15 00:00:00 UTC
# now.at_beginning_of_week(:sunday) # => 2023-05-14 00:00:00 UTC
# now.at_beginning_of_week(:wednesday) # => 2023-05-10 00:00:00 UTC
# ```
# TODO: Ensure correctness in local time-line.
def at_beginning_of_week : Time
(self - (day_of_week.value - 1).days).at_beginning_of_day
def at_beginning_of_week(start_day : Time::DayOfWeek = :monday) : Time
(self - ((day_of_week.value - start_day.value) % 7).days).at_beginning_of_day
end

def_at_end(year) { Time.local(year, 12, 31, 23, 59, 59, nanosecond: 999_999_999, location: location) }
Expand Down