Add iso8601 and rfc3339 parsing to timezones #28272
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pixeltrix
force-pushed
the
add-iso8601-and-rfc3339-parsing
branch
from
416720f
to
901be2e
Compare
pixeltrix
changed the title
robin850
reviewed
Mar 3, 2017
| # | ||
| # Time.rfc3339('1999-12-31T14:00:00-10:00') # => 2000-01-01 00:00:00 -1000 | ||
| # | ||
| # If the the time or offset components are missing then an +ArgumentError+ |
There was a problem hiding this comment.
There is an extra "the" here. 😊
| # Time.zone = 'Hawaii' # => "Hawaii" | ||
| # Time.zone.iso8601('1999-12-31T14:00:00') # => Fri, 31 Dec 1999 14:00:00 HST -10:00 | ||
| # | ||
| # If the the time components are missing then they will be set to zero. |
| # Time.zone = 'Hawaii' # => "Hawaii" | ||
| # Time.zone.rfc3339('2000-01-01T00:00:00Z') # => Fri, 31 Dec 1999 14:00:00 HST -10:00 | ||
| # | ||
| # If the the time or zone components are missing then an +ArgumentError+ |
|
@robin850 thanks - my eyes are getting old 👴 |
Previously there was no way to get a ISO 8601 timestamp into a specific
timezone without either using `parse` or chaining methods. The new method
allows parsing directly into the timezone, e.g:
>> Time.zone = "Hawaii"
=> "Hawaii"
>> Time.zone.iso8601("1999-12-31T14:00:00Z")
=> Fri, 31 Dec 1999 14:00:00 HST -10:00
If the timestamp is a ISO 8601 date (YYYY-MM-DD) then the time is set
to midnight, e.g:
>> Time.zone = "Hawaii"
=> "Hawaii"
>> Time.zone.iso8601("1999-12-31")
=> Fri, 31 Dec 1999 00:00:00 HST -10:00
This new method has stricter semantics than the current `parse` method
and will raise an `ArgumentError` instead of returning nil, e.g:
>> Time.zone = "Hawaii"
=> "Hawaii"
>> Time.zone.iso8601("foobar")
ArgumentError: invalid date
>> Time.zone.parse("foobar")
=> nil
Previously there was no way to get a RFC 3339 timestamp
into a specific timezone without either using `parse` or
chaining methods. The new method allows parsing directly
into the timezone, e.g:
>> Time.zone = "Hawaii"
=> "Hawaii"
>> Time.zone.rfc3339("1999-12-31T14:00:00Z")
=> Fri, 31 Dec 1999 14:00:00 HST -10:00
This new method has stricter semantics than the current
`parse` method and will raise an `ArgumentError`
instead of returning nil, e.g:
>> Time.zone = "Hawaii"
=> "Hawaii"
>> Time.zone.rfc3339("foobar")
ArgumentError: invalid date
>> Time.zone.parse("foobar")
=> nil
It will also raise an `ArgumentError` when either the
time or offset components are missing, e.g:
>> Time.zone = "Hawaii"
=> "Hawaii"
>> Time.zone.rfc3339("1999-12-31")
ArgumentError: invalid date
>> Time.zone.rfc3339("1999-12-31T14:00:00")
ArgumentError: invalid date
The `Time.xmlschema` and consequently its alias `iso8601` accepts timestamps without a offset in contravention of the RFC 3339 standard. This method enforces that constraint and raises an `ArgumentError` if it doesn't.
For naming consistency when using the RFC 3339 profile of ISO 8601 in applications.
pixeltrix
force-pushed
the
add-iso8601-and-rfc3339-parsing
branch
from
6c63cfd
to
f0aeecd
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds
Time.rfc3339,ActiveSupport::TimeZone.rfc3339andActiveSupport::TimeZone.iso8601plusrfc3339aliases toxmlschemafor consistency when dealing with RFC 3339 timestamps in a Rails application.Previous to this you would have to do things like this to get RFC 3339 timestamps into a particular timezone, e.g:
Also this doesn't enforce strict compliance with RFC 3339 - invalid dates or missing components will return nil instead of raising and error. We already have
ActiveSupport::TimeZone.parseandActiveSupport::TimeZone.strptimeso adding these methods seem a natural fit - especially when converting a large number of timestamps, e.g:Added
rfc3339aliases toxmlschemasinceDateTimehas them and using time format names consistently within an application is better.