Skip to content

Add location as required argument for Time.parse #6369

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

Merged
RX14 merged 2 commits into from
Aug 1, 2018
Merged

Add location as required argument for Time.parse #6369

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6cab1d8
Add location as required argument for Time.parse
straight-shoota Jul 12, 2018
41d6f3c
fixup! Add location as required argument for Time.parse
straight-shoota Jul 30, 2018
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
58 changes: 29 additions & 29 deletions spec/std/time/time_spec.cr
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ def Time.expect_invalid
end

private def parse_time(format, string)
Time.parse(format, string, Time::Location::UTC)
Time.parse_utc(format, string)
end

private def parse_time(string)
Time.parse(string, "%F %T.%N", Time::Location::UTC)
Time.parse_utc(string, "%F %T.%N")
end

describe Time do
Expand Down Expand Up @@ -540,10 +540,10 @@ describe Time do

it "parse fails without time zone" do
expect_raises(Time::Format::Error, "no default location provided") do
Time.parse("2017-12-01 20:15:13", "%F %T")
Time.parse!("2017-12-01 20:15:13", "%F %T")
end
Time.parse("2017-12-01 20:15:13", "%F %T", Time::Location.local).to_s("%F %T").should eq "2017-12-01 20:15:13"
Time.parse("2017-12-01 20:15:13 +01:00", "%F %T %:z").to_s("%F %T %:z").should eq "2017-12-01 20:15:13 +01:00"
Time.parse!("2017-12-01 20:15:13 +01:00", "%F %T %:z").to_s("%F %T %:z").should eq "2017-12-01 20:15:13 +01:00"
end

it "parses" do
Expand Down Expand Up @@ -605,57 +605,57 @@ describe Time do
patterns = {"%z", "%:z", "%::z"}

{"+0000", "+00:00", "+00:00:00"}.zip(patterns) do |string, pattern|
time = Time.parse(string, pattern)
time = Time.parse!(string, pattern)
time.offset.should eq 0
time.utc?.should be_false
time.location.fixed?.should be_true
end

{"-0000", "-00:00", "-00:00:00"}.zip(patterns) do |string, pattern|
time = Time.parse(string, pattern)
time = Time.parse!(string, pattern)
time.offset.should eq 0
time.utc?.should be_false
time.location.fixed?.should be_true
end

{"-0200", "-02:00", "-02:00:00"}.zip(patterns) do |string, pattern|
time = Time.parse(string, pattern)
time = Time.parse!(string, pattern)
time.offset.should eq -2 * 3600
time.utc?.should be_false
time.location.fixed?.should be_true
end

{"Z", "Z", "Z"}.zip(patterns) do |string, pattern|
time = Time.parse(string, pattern)
time = Time.parse!(string, pattern)
time.offset.should eq 0
time.utc?.should be_true
time.location.fixed?.should be_true
end

{"UTC", "UTC", "UTC"}.zip(patterns) do |string, pattern|
time = Time.parse(string, pattern)
time = Time.parse!(string, pattern)
time.offset.should eq 0
time.utc?.should be_true
time.location.fixed?.should be_true
end

time = Time.parse("+04:12:39", "%::z")
time = Time.parse!("+04:12:39", "%::z")
time.offset.should eq 4 * 3600 + 12 * 60 + 39
time.utc?.should be_false
time.location.fixed?.should be_true

time = Time.parse("-04:12:39", "%::z")
time = Time.parse!("-04:12:39", "%::z")
time.offset.should eq -1 * (4 * 3600 + 12 * 60 + 39)
time.utc?.should be_false
time.location.fixed?.should be_true
end

it "raises when time zone missing" do
expect_raises(Time::Format::Error, "Invalid timezone") do
Time.parse("", "%z")
Time.parse!("", "%z")
end
expect_raises(Time::Format::Error, "Invalid timezone") do
Time.parse("123456+01:00", "%3N%z")
Time.parse!("123456+01:00", "%3N%z")
end
end

Expand All @@ -672,85 +672,85 @@ describe Time do
# TODO %v

it do
time = Time.parse("2014-10-31 10:11:12 Z hi", "%F %T %z hi")
time = Time.parse!("2014-10-31 10:11:12 Z hi", "%F %T %z hi")
time.utc?.should be_true
time.to_utc.to_s.should eq("2014-10-31 10:11:12 UTC")
end

it do
time = Time.parse("2014-10-31 10:11:12 UTC hi", "%F %T %z hi")
time = Time.parse!("2014-10-31 10:11:12 UTC hi", "%F %T %z hi")
time.utc?.should be_true
time.to_utc.to_s.should eq("2014-10-31 10:11:12 UTC")
end

it do
time = Time.parse("2014-10-31 10:11:12 -06:00 hi", "%F %T %z hi")
time = Time.parse!("2014-10-31 10:11:12 -06:00 hi", "%F %T %z hi")
time.utc?.should be_false
time.location.fixed?.should be_true
time.offset.should eq -6 * 3600
time.to_utc.to_s.should eq("2014-10-31 16:11:12 UTC")
end

it do
time = Time.parse("2014-10-31 10:11:12 +05:00 hi", "%F %T %z hi")
time = Time.parse!("2014-10-31 10:11:12 +05:00 hi", "%F %T %z hi")
time.utc?.should be_false
time.location.fixed?.should be_true
time.offset.should eq 5 * 3600
time.to_utc.to_s.should eq("2014-10-31 05:11:12 UTC")
end

it do
time = Time.parse("2014-10-31 10:11:12 -06:00:00 hi", "%F %T %z hi")
time = Time.parse!("2014-10-31 10:11:12 -06:00:00 hi", "%F %T %z hi")
time.utc?.should be_false
time.location.fixed?.should be_true
time.offset.should eq -6 * 3600
time.to_utc.to_s.should eq("2014-10-31 16:11:12 UTC")
end

it do
time = Time.parse("2014-10-31 10:11:12 -060000 hi", "%F %T %z hi")
time = Time.parse!("2014-10-31 10:11:12 -060000 hi", "%F %T %z hi")
time.utc?.should be_false
time.location.fixed?.should be_true
time.offset.should eq -6 * 3600
time.to_utc.to_s.should eq("2014-10-31 16:11:12 UTC")
end

it "parses centiseconds" do
time = Time.parse("2016-09-09T17:03:28.45+01:00", "%FT%T.%L%z").to_utc
time = Time.parse!("2016-09-09T17:03:28.45+01:00", "%FT%T.%L%z").to_utc
time.to_s.should eq("2016-09-09 16:03:28 UTC")
time.millisecond.should eq(450)
time.nanosecond.should eq(450000000)
end

it "parses milliseconds with %L" do
time = Time.parse("2016-09-09T17:03:28.456+01:00", "%FT%T.%L%z").to_utc
time = Time.parse!("2016-09-09T17:03:28.456+01:00", "%FT%T.%L%z").to_utc
time.to_s.should eq("2016-09-09 16:03:28 UTC")
time.millisecond.should eq(456)
time.nanosecond.should eq(456000000)
end

it "parses milliseconds with %3N" do
time = Time.parse("2016-09-09T17:03:28.456+01:00", "%FT%T.%3N%z").to_utc
time = Time.parse!("2016-09-09T17:03:28.456+01:00", "%FT%T.%3N%z").to_utc
time.to_s.should eq("2016-09-09 16:03:28 UTC")
time.millisecond.should eq(456)
time.nanosecond.should eq(456000000)
end

it "parses microseconds with %6N" do
time = Time.parse("2016-09-09T17:03:28.456789+01:00", "%FT%T.%6N%z").to_utc
time = Time.parse!("2016-09-09T17:03:28.456789+01:00", "%FT%T.%6N%z").to_utc
time.to_s.should eq("2016-09-09 16:03:28 UTC")
time.millisecond.should eq(456)
time.nanosecond.should eq(456789000)
end

it "parses nanoseconds" do
time = Time.parse("2016-09-09T17:03:28.456789123+01:00", "%FT%T.%N%z").to_utc
time = Time.parse!("2016-09-09T17:03:28.456789123+01:00", "%FT%T.%N%z").to_utc
time.to_s.should eq("2016-09-09 16:03:28 UTC")
time.nanosecond.should eq(456789123)
end

it "parses nanoseconds with %9N" do
time = Time.parse("2016-09-09T17:03:28.456789123+01:00", "%FT%T.%9N%z").to_utc
time = Time.parse!("2016-09-09T17:03:28.456789123+01:00", "%FT%T.%9N%z").to_utc
time.to_s.should eq("2016-09-09 16:03:28 UTC")
time.nanosecond.should eq(456789123)
end
Expand All @@ -765,7 +765,7 @@ describe Time do
time = Time.parse("2016-09-09T17:03:28.456789123990", "%FT%T.%9N", Time::Location::UTC)
time.nanosecond.should eq(456789123)

time = Time.parse("2016-09-09T17:03:28.456789123999999+01:00", "%FT%T.%N%z")
time = Time.parse!("2016-09-09T17:03:28.456789123999999+01:00", "%FT%T.%N%z")
time.to_s.should eq("2016-09-09 17:03:28 +01:00")
time.nanosecond.should eq(456789123)

Expand All @@ -775,13 +775,13 @@ describe Time do
end

it "parses if some decimals are missing" do
time = Time.parse("2016-09-09T17:03:28.45+01:00", "%FT%T.%3N%z").to_utc
time = Time.parse!("2016-09-09T17:03:28.45+01:00", "%FT%T.%3N%z").to_utc
time.nanosecond.should eq(450000000)

time = Time.parse("2016-09-09T17:03:28.45678+01:00", "%FT%T.%6N%z").to_utc
time = Time.parse!("2016-09-09T17:03:28.45678+01:00", "%FT%T.%6N%z").to_utc
time.nanosecond.should eq(456780000)

time = Time.parse("2016-09-09T17:03:28.4567891+01:00", "%FT%T.%9N%z").to_utc
time = Time.parse!("2016-09-09T17:03:28.4567891+01:00", "%FT%T.%9N%z").to_utc
time.nanosecond.should eq(456789100)
end

Expand Down
55 changes: 53 additions & 2 deletions src/time.cr
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -935,12 +935,63 @@ struct Time
# See `Time::Format` for details.
#
# ```
# Time.parse("2016-04-05", "%F") # => 2016-04-05 00:00:00 +01:00
# Time.parse("2016-04-05", "%F", Time::Location.load("Europe/Berlin")) # => 2016-04-05 00:00:00.0 +02:00 Europe/Berlin
# ```
def self.parse(time : String, pattern : String, location : Location? = nil) : Time
#
# If there is no time zone information in the formatted time, *location* will
# be assumed. When *location* is `nil`, in such a case the parser will raise
# `Time::Format::Error`.
def self.parse(time : String, pattern : String, location : Location) : Time
Format.new(pattern, location).parse(time)
end

# Parses a `Time` from *time* string using the given *pattern*.
#
# See `Time::Format` for details.
#
# ```
# Time.parse!("2016-04-05 +00:00", "%F %:z") # => 2016-04-05 00:00:00.0 +00:00
# Time.parse!("2016-04-05", "%F") # raises Time::Format::Error
# ```
#
# If there is no time zone information in the formatted time, the parser will raise
# `Time::Format::Error`.
def self.parse!(time : String, pattern : String) : Time
Format.new(pattern, nil).parse(time)
end

# Parses a `Time` from *time* string using the given *pattern* and
# `Time::Location::UTC` as default location.
#
# See `Time::Format` for details.
#
# ```
# Time.parse_utc("2016-04-05", "%F") # => 2016-04-05 00:00:00.0 +00:00
# ```
#
# `Time::Location::UTC` will only be used as `location` if the formatted time
# does not contain any time zone information. The return value can't be
# assumed to be a UTC time (this can be achieved by calling `#to_utc`).
def self.parse_utc(time : String, pattern : String) : Time
parse(time, pattern, Location::UTC)
end

# Parses a `Time` from *time* string using the given *pattern* and
# `Time::Location.local` asdefault location
#
# See `Time::Format` for details.
#
# ```
# Time.parse_utc("2016-04-05", "%F") # => 2016-04-05 00:00:00.0 +00:00
# ```
#
# `Time::Location.local` will only be used as `location` if the formatted time
# does not contain any time zone information. The return value can't be
# assumed to be a UTC time (this can be achieved by calling `#to_local`).
def self.parse_local(time : String, pattern : String) : Time
parse(time, pattern, Location.local)
end

# Returns the number of seconds since the Unix epoch
# (`1970-01-01 00:00:00 UTC`).
#
Expand Down