flexitime 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7761e5fbc7cf6ddf2a963ae8a38f8ade7b38db26eb2835b23def41df09599ad9
-  data.tar.gz: d7e5366d7d36c665f17d9695b563c894451538925efd016d5e4f0ed5ae695cab
+  metadata.gz: 6dfd029b07e75148e00109b01e4c6c17f09edfb2629dffe091a9003f2c1fb610
+  data.tar.gz: c4290263155f0291fcd2ca897075cb315f76f5a99fc20623042225cef6e3c3e7
 SHA512:
-  metadata.gz: fe193a2473e99b72abd0d94751a491f9f5971c8861a671053afc3151c7eea04588fb20a6279d7bd2fa3d33e4b5ec8e92f82f418f4bf4ad3d2e807daa8da8415a
-  data.tar.gz: 617842e3fd380181f280fe8ffdff7fea5bb52165596816b6ad0be9d7190bae37e3487840a28d7144f614c4d0f660ad652108d4a5cc9e8231e094cf90e2670d56
+  metadata.gz: c15e333e96e05f99b4dbed931f217be00a5c3832c47dc5adef7e5e76e740cf9fb2576deeece81e86e66cca10ba96c6492a97284bee49f7780c4f9a5a3bfeb039
+  data.tar.gz: '007581d7382a12508c861ca67b7024ce094251d33050467be371bc12ec1399a080f642a4bb0a7ba11b3ac4364a3e4eadc0f80ce0ec796e8781f9ce0f3969b0d0'

data/.github/workflows/ci.yml

@@ -17,20 +17,85 @@ jobs:
     strategy:
       fail-fast: false # should GitHub cancel all in-progress jobs if any matrix job fails
       matrix:
-        ruby-version:
-          - '2.5'
-          - '2.6'
-          - '2.7'
-          - '3.0'
-        gemfile:
-          - 'activesupport_4_0'
-          - 'activesupport_4_1'
-          - 'activesupport_4_2'
-          - 'activesupport_5_0'
-          - 'activesupport_5_1'
-          - 'activesupport_5_2'
-          - 'activesupport_6_0'
-          - 'activesupport_6_1'
+        ruby-version: ['2.5']
+        gemfile: ['activesupport_4_0']
+        include:
+          - ruby-version: '2.5'
+            gemfile: 'activesupport_4_1'
+          - ruby-version: '2.5'
+            gemfile: 'activesupport_4_2'
+          - ruby-version: '2.5'
+            gemfile: 'activesupport_5_0'
+          - ruby-version: '2.5'
+            gemfile: 'activesupport_5_1'
+          - ruby-version: '2.5'
+            gemfile: 'activesupport_5_2'
+          - ruby-version: '2.5'
+            gemfile: 'activesupport_6_0'
+          - ruby-version: '2.5'
+            gemfile: 'activesupport_6_1'
+          - ruby-version: '2.6'
+            gemfile: 'activesupport_4_0'
+          - ruby-version: '2.6'
+            gemfile: 'activesupport_4_1'
+          - ruby-version: '2.6'
+            gemfile: 'activesupport_4_2'
+          - ruby-version: '2.6'
+            gemfile: 'activesupport_5_0'
+          - ruby-version: '2.6'
+            gemfile: 'activesupport_5_1'
+          - ruby-version: '2.6'
+            gemfile: 'activesupport_5_2'
+          - ruby-version: '2.6'
+            gemfile: 'activesupport_6_0'
+          - ruby-version: '2.6'
+            gemfile: 'activesupport_6_1'
+          - ruby-version: '2.7'
+            gemfile: 'activesupport_4_0'
+          - ruby-version: '2.7'
+            gemfile: 'activesupport_4_1'
+          - ruby-version: '2.7'
+            gemfile: 'activesupport_4_2'
+          - ruby-version: '2.7'
+            gemfile: 'activesupport_5_0'
+          - ruby-version: '2.7'
+            gemfile: 'activesupport_5_1'
+          - ruby-version: '2.7'
+            gemfile: 'activesupport_5_2'
+          - ruby-version: '2.7'
+            gemfile: 'activesupport_6_0'
+          - ruby-version: '2.7'
+            gemfile: 'activesupport_6_1'
+          - ruby-version: '2.7'
+            gemfile: 'activesupport_7_0'
+          - ruby-version: '3.0'
+            gemfile: 'activesupport_4_2'
+          - ruby-version: '3.0'
+            gemfile: 'activesupport_5_0'
+          - ruby-version: '3.0'
+            gemfile: 'activesupport_5_1'
+          - ruby-version: '3.0'
+            gemfile: 'activesupport_5_2'
+          - ruby-version: '3.0'
+            gemfile: 'activesupport_6_0'
+          - ruby-version: '3.0'
+            gemfile: 'activesupport_6_1'
+          - ruby-version: '3.0'
+            gemfile: 'activesupport_7_0'
+          - ruby-version: '3.1'
+            gemfile: 'activesupport_4_2'
+          - ruby-version: '3.1'
+            gemfile: 'activesupport_5_0'
+          - ruby-version: '3.1'
+            gemfile: 'activesupport_5_1'
+          - ruby-version: '3.1'
+            gemfile: 'activesupport_5_2'
+          - ruby-version: '3.1'
+            gemfile: 'activesupport_6_0'
+          - ruby-version: '3.1'
+            gemfile: 'activesupport_6_1'
+          - ruby-version: '3.1'
+            gemfile: 'activesupport_7_0'
 
     env: # $BUNDLE_GEMFILE must be set at the job level, so it is set for all steps
       BUNDLE_GEMFILE: ${{ github.workspace }}/gemfiles/${{ matrix.gemfile }}.gemfile

data/Appraisals

@@ -11,6 +11,10 @@
 # Run each appraisal in turn or a single appraisal:-
 # $ bundle exec appraisal rspec
 # $ bundle exec appraisal activesupport-6-1 rspec
+appraise "activesupport-7-0" do
+  gem "activesupport", "~> 7.0"
+end
+
 appraise "activesupport-6-1" do
   gem "activesupport", "~> 6.1"
 end

data/CHANGELOG.md

@@ -1,5 +1,10 @@
-## [Unreleased]
+# Change Log
 
-## [0.1.0] - 2021-11-22
+## 1.0.0 - 2022-03-17
 
-- Initial release
+* Perform parsing using `Time.zone` ([d30b224](https://github.com/CircleSD/flexitime/commit/d30b224f40379331473f60d11f6dcc8b1875413d))
+* Add `first_date_part` and `precision` arguments to `parse` method ([18ce552](https://github.com/CircleSD/flexitime/commit/18ce5528caf2f1c6d2643b610a713e7d2cd6ce75))
+
+## 0.1.0 - 2021-11-22
+
+* Initial release

data/Gemfile.lock

@@ -1,18 +1,17 @@
 PATH
   remote: .
   specs:
-    flexitime (0.1.0)
+    flexitime (1.0.0)
       activesupport (>= 4.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.4.1)
+    activesupport (7.0.2.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
     appraisal (2.4.1)
       bundler
       rake
@@ -20,9 +19,10 @@ GEM
     ast (2.4.2)
     concurrent-ruby (1.1.9)
     diff-lcs (1.4.4)
-    i18n (1.8.11)
+    docile (1.4.0)
+    i18n (1.10.0)
       concurrent-ruby (~> 1.0)
-    minitest (5.14.4)
+    minitest (5.15.0)
     parallel (1.21.0)
     parser (3.0.2.0)
       ast (~> 2.4.1)
@@ -58,6 +58,12 @@ GEM
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
     standard (1.4.0)
       rubocop (= 1.22.3)
       rubocop-performance (= 1.11.5)
@@ -65,7 +71,6 @@ GEM
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.1.0)
-    zeitwerk (2.5.1)
 
 PLATFORMS
   arm64-darwin-21
@@ -75,6 +80,7 @@ DEPENDENCIES
   flexitime!
   rake (~> 13.0)
   rspec (~> 3.0)
+  simplecov
   standard
 
 BUNDLED WITH

data/README.md

@@ -1,8 +1,8 @@
 # Flexitime
 
-Flexitime is a Ruby date/time string parser with the intended purpose of converting a string value received from a UI or API into a Time object. It offers the flexibility of deciphering date/time strings in the most common formats with the ability to self-determine the expected order of the date parts when using [rails-i18n](https://github.com/svenfuchs/rails-i18n) or set this via a configuration option; configure the parser to return Time objects either in the system local time or for a specified [time zone](https://api.rubyonrails.org/classes/ActiveSupport/TimeZone.html); and set a desired precision for the Time object.
+Flexitime is a Ruby date/time string parser with the intended purpose of converting a string value received from a UI or API into an [ActiveSupport::TimeWithZone](https://api.rubyonrails.org/classes/ActiveSupport/TimeWithZone.html) object. It offers the flexibility of deciphering date/time strings in the most common formats with the ability to self-determine the expected order of the date parts when using [rails-i18n](https://github.com/svenfuchs/rails-i18n). The date order and a desired precision for the time object can also be set via configuration options or method arguments.
 
-The gem was born of the need to parse date, datetime & time strings in a multi-user environment supporting different locales and time zones. Depending upon the user's locale the UI would return date/time strings in different formats and in different orders (day/month/year or month/day/year). This variation in the ordering of the day and month parts proved to be the main catalyst to finding or creating a date/time parser. The resultant Time object needed to be created in the user's time zone and additionally the system stored times only to a minute precision. Flexitime was created to provide a simple yet flexible parser to meet these needs.
+The gem was born of the need to parse date, datetime & time strings in a multi-user environment supporting different locales and time zones. Depending upon the user's locale the UI would return date/time strings in different formats and in different orders (day/month/year or month/day/year). This variation in the ordering of the day and month parts proved to be the main catalyst to finding or creating a date/time parser. The resultant time object needed to be created in the user's time zone and additionally the system stored times only to a minute precision. Flexitime was created to provide a simple yet flexible parser to meet these needs.
 
 ![Build Status](https://github.com/CircleSD/flexitime/actions/workflows/ci.yml/badge.svg?branch=main)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
@@ -29,22 +29,107 @@ gem install flexitime
 
 ## Usage
 
-The Flexitime `parse` method accepts a string argument or an object that implements the `to_str` method to denote that it behaves like a string. When the string is recognised as a valid date, datetime or time it returns a Time object otherwise it returns `nil` if any of the date/time parts are invalid or the string does not match a recognised format.
+The Flexitime `parse` method accepts a string argument or an object that implements the `to_str` method (to denote that it behaves like a string). When the string is recognised as a valid date, datetime or time it returns an [ActiveSupport::TimeWithZone](https://api.rubyonrails.org/classes/ActiveSupport/TimeWithZone.html) object. If any of the date/time parts are invalid or the string does not match a recognised format the method returns `nil`.
+
+As Flexitime uses the [TimeZone](https://api.rubyonrails.org/classes/ActiveSupport/TimeZone.html) class, `Time.zone` should be set before using the `parse` method. If `Time.zone` is `nil` Flexitime will set the zone to UTC.
 
 ```ruby
-Flexitime.parse("23/08/2021")       # => 2021-08-23 00:00:00 +0100
-Flexitime.parse("23/08/2021 08:00") # => 2021-08-23 08:00:00 +0100
-Flexitime.parse("08:00")            # => 2021-11-21 08:00:00 +0000
+Time.zone = "London"
+Flexitime.parse("23/08/2021")       # => Mon, 23 Aug 2021 00:00:00.000000000 BST +01:00
+Flexitime.parse("23/08/2021 08:00") # => Mon, 23 Aug 2021 08:00:00.000000000 BST +01:00
+Flexitime.parse("08:00")            # => Mon, 14 Mar 2022 08:00:00.000000000 GMT +00:00
 ```
 
 ```ruby
+Time.zone = "London"
 Flexitime.parse("31/02/2021 08:00") # => nil
 Flexitime.parse("computer says no") # => nil
 ```
 
+### First Date Part
+
+The `first_date_part` option is used to denote the first part of the date within the string, either `:day` or `:month`. When using the [rails-I18n gem](https://github.com/svenfuchs/rails-i18n) if the first element of the "date.order" translation is :day or :month that will be used. Alternatively the option can be set manually via a configuration option or a `parse` argument. If the option has not been set then the default of `:day` is used.
+
+```ruby
+Time.zone = "London"
+I18n.locale = :"en-GB"
+I18n.t("date.order")          # => [:day, :month, :year]
+Flexitime.parse("01/06/2021") # => Tue, 01 Jun 2021 00:00:00.000000000 BST +01:00
+
+I18n.locale = :"en-US"
+I18n.t("date.order")          # => [:month, :day, :year]
+Flexitime.parse("01/06/2021") # => Wed, 06 Jan 2021 00:00:00.000000000 GMT +00:00
+```
+
+```ruby
+Time.zone = "London"
+Flexitime.first_date_part = :day
+Flexitime.parse("01/06/2021") # => Tue, 01 Jun 2021 00:00:00.000000000 BST +01:00
+
+Flexitime.first_date_part = :month
+Flexitime.parse("01/06/2021") # => Wed, 06 Jan 2021 00:00:00.000000000 GMT +00:00
+```
+
+```ruby
+Time.zone = "London"
+Flexitime.parse("01/06/2021", first_date_part: :day)   # => Tue, 01 Jun 2021 00:00:00.000000000 BST +01:00
+Flexitime.parse("01/06/2021", first_date_part: :month) # => Wed, 06 Jan 2021 00:00:00.000000000 GMT +00:00
+```
+
+Regardless of the `first_date_part` value, Flexitime will always attempt to parse a string starting with a 4 digit year, deciphering the format as year/month/day.
+
+```ruby
+Time.zone = "London"
+Flexitime.parse("2021-11-12 08:15") # => Fri, 12 Nov 2021 08:15:00.000000000 GMT +00:00
+```
+
+### Precision
+
+The `precision` option denotes the desired precision for the returned time objects. This defaults to minute (`:min`) meaning that the time object will be returned without seconds. The option can be set via a configuration option or a `parse` argument and the accepted values are `:day`, `:hour`, `:min`, `:sec` or `:usec`
+
+```ruby
+Time.zone = "London"
+Flexitime.precision = :day
+Flexitime.parse("2022-12-01T18:30:45.036711Z")  # => Thu, 01 Dec 2022 00:00:00.000000000 GMT +00:00
+Flexitime.precision = :hour
+Flexitime.parse("2022-12-01T18:30:45.036711Z")  # => Thu, 01 Dec 2022 18:00:00.000000000 GMT +00:00
+Flexitime.precision = :min
+Flexitime.parse("2022-12-01T18:30:45.036711Z")  # => Thu, 01 Dec 2022 18:30:00.000000000 GMT +00:00
+Flexitime.precision = :sec
+Flexitime.parse("2022-12-01T18:30:45.036711Z")  # => Thu, 01 Dec 2022 18:30:45.000000000 GMT +00:00
+Flexitime.precision = :usec
+Flexitime.parse("2022-12-01T18:30:45.036711Z")  # => Thu, 01 Dec 2022 18:30:45.036711000 GMT +00:00
+
+Flexitime.parse("2022-12-01T18:30:45.036711Z", precision: :day)  # => Thu, 01 Dec 2022 00:00:00.000000000 GMT +00:00
+Flexitime.parse("2022-12-01T18:30:45.036711Z", precision: :hour) # => Thu, 01 Dec 2022 18:00:00.000000000 GMT +00:00
+Flexitime.parse("2022-12-01T18:30:45.036711Z", precision: :min)  # => Thu, 01 Dec 2022 18:30:00.000000000 GMT +00:00
+Flexitime.parse("2022-12-01T18:30:45.036711Z", precision: :sec)  # => Thu, 01 Dec 2022 18:30:45.000000000 GMT +00:00
+Flexitime.parse("2022-12-01T18:30:45.036711Z", precision: :usec) # => Thu, 01 Dec 2022 18:30:45.036711000 GMT +00:00
+```
+
+### Ambiguous Year Future Bias
+
+The `ambiguous_year_future_bias` configuration option is used to determine the century when parsing a string containing a 2 digit year and defaults to 50.
+
+With a bias of 50, when the current year is 2020 the time object's year is set from within a range of >= 1970 and <= 2069
+
+With a bias of 20, when the current year is 2020 the time object's year is set from within a range of >= 2000 and <= 2099
+
+```ruby
+Time.zone = "London"
+Flexitime.parse("01/08/00").year # => 2000
+Flexitime.parse("01/08/71").year # => 2071
+Flexitime.parse("01/08/72").year # => 1972
+Flexitime.parse("01/08/99").year # => 1999
+```
+
+### Thread Safety
+
+The Flexitime `configuration` instance is stored in the currently executing thread as a thread-local variable in order to avoid conflicts with concurrent requests and make the variable threadsafe.
+
 ## Formats
 
-Flexitime uses regular expressions to match the string to the most common date & time formats and uses the matched parts to create a Time object.
+Flexitime uses regular expressions to match the string to the most common date & time formats and uses the matched parts to create a time object.
 
 Dates separated by either forward slashes `/` hyphens `-` or periods `.`; with 1 or 2 digit days and months; with 2 or 4 digit years; and with day/month or year first (always a 4 digit year).
 
@@ -87,89 +172,14 @@ Also times in the ISO 8601 Zulu format with between 1 and 6 digit milliseconds
 2021-08-01T08:15:30.144515Z
 ```
 
-If the string does not match any of the regular expressions then Flexitime will attempt to parse the string using the time class, so you lose nothing from using Flexitime and it will still return a Time object for a string containing, for example, an offset or words.
+If the string does not match any of the regular expressions then Flexitime will attempt to parse the string using the TimeZone class, so you lose nothing from using Flexitime and it will still return a time object for a string containing, for example, an offset or words.
 
 ```ruby
-Flexitime.parse("2021-01-02T09:00:00+02:00")  # => 2021-01-02 09:00:00 +0200
-Flexitime.parse("2nd January 2021")           # => 2021-01-02 00:00:00 +0000
+Time.zone = "Kyiv"
+Flexitime.parse("2022-02-24T09:00:00+02:00")  # => Thu, 24 Feb 2022 09:00:00.000000000 EET +02:00
+Flexitime.parse("2nd January 2021")           # => Sat, 02 Jan 2021 00:00:00.000000000 EET +02:00
 ```
 
-## Configuration
-
-### Time Class
-
-The Flexitime `time_class` configuration option is used to create Time objects and defaults to the `Time` class which will use the system local time zone. The `time_class` can be set to an ActiveSupport [TimeZone](https://api.rubyonrails.org/classes/ActiveSupport/TimeZone.html) to create Time objects using the specified time zone.
-
-```ruby
-Time.zone = "Europe/London"
-Flexitime.time_class = Time.zone
-Flexitime.parse("01/06/2021 17:00") # => Tue, 01 Jun 2021 17:00:00.000000000 BST +01:00
-```
-
-### First Date Part
-
-The Flexitime `first_date_part` configuration option is used to denote the first part of the date within the string, either `:day` or `:month`. When using the [rails-I18n gem](https://github.com/svenfuchs/rails-i18n) if the first element of the "date.order" translation is :day or :month that will be used. Alternatively the option can be set manually or finally the default of `:day` will be used.
-
-```ruby
-I18n.locale = :"en-GB"
-I18n.t("date.order")          # => [:day, :month, :year]
-Flexitime.parse("01/06/2021") # => 2021-06-01 00:00:00 +0100
-
-I18n.locale = :"en-US"
-I18n.t("date.order")          # => [:month, :day, :year]
-Flexitime.parse("01/06/2021") # => 2021-01-06 00:00:00 +0100
-```
-
-```ruby
-Flexitime.first_date_part = :day
-Flexitime.parse("01/06/2021") # => 2021-06-01 00:00:00 +0100
-
-Flexitime.first_date_part = :month
-Flexitime.parse("01/06/2021") # => 2021-01-06 00:00:00 +0100
-```
-
-Regardless of the `first_date_part` value, Flexitime will always attempt to parse a string starting with a 4 digit year, deciphering the format as year/month/day.
-
-```ruby
-Flexitime.parse("2021-11-12 08:15") # => 2021-11-12 08:15:00 +0000
-```
-
-### Precision
-
-The Flexitime `precision` configuration option denotes the desired precision for the returned Time objects. This defaults to minute (`:min`) meaning that the Time object will be returned without seconds. The accepted values are `:day`, `:hour`, `:min`, `:sec` or `:usec`
-
-```ruby
-Flexitime.precision = :day
-Flexitime.parse("2022-12-01T18:30:45.036711Z")  # => 2022-12-01 00:00:00 +0000
-Flexitime.precision = :hour
-Flexitime.parse("2022-12-01T18:30:45.036711Z")  # => 2022-12-01 18:00:00 +0000
-Flexitime.precision = :min
-Flexitime.parse("2022-12-01T18:30:45.036711Z")  # => 2022-12-01 18:30:00 +0000
-Flexitime.precision = :sec
-Flexitime.parse("2022-12-01T18:30:45.036711Z")  # => 2022-12-01 18:30:45 +0000
-Flexitime.precision = :usec
-Flexitime.parse("2022-12-01T18:30:45.036711Z")  # => 2022-12-01 18:30:45.036711 +0000
-```
-
-### Ambiguous Year Future Bias
-
-The Flexitime `ambiguous_year_future_bias` configuration option is used to determine the century when parsing a string containing a 2 digit year and defaults to 50.
-
-With a bias of 50, when the current year is 2020 the Time object's year is set from within a range of >= 1970 and <= 2069
-
-With a bias of 20, when the current year is 2020 the Time object's year is set from within a range of >= 2000 and <= 2099
-
-```ruby
-Flexitime.parse("01/08/00").year # => 2000
-Flexitime.parse("01/08/69").year # => 2069
-Flexitime.parse("01/08/70").year # => 1970
-Flexitime.parse("01/08/99").year # => 1999
-```
-
-### Thread Safety
-
-The Flexitime `configuration` instance is stored in the currently executing thread as a thread-local variable in order to avoid conflicts with concurrent requests and make the variable threadsafe.
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -190,7 +200,7 @@ Bug reports and pull requests are welcome on [GitHub](https://github.com/CircleS
 
 ## Credits
 
-Tom Preston-Werner and [Chronic](https://github.com/mojombo/chronic) which was our previous go-to parser of choice but is unfortunately no longer maintained and performs natural language parsing that we do not require. It was a useful reference in particular for the `time_class` and `ambiguous_year_future_bias` configuration options.
+Tom Preston-Werner and [Chronic](https://github.com/mojombo/chronic) which was our previous go-to parser of choice but is unfortunately no longer maintained and performs natural language parsing that we do not require. It was a useful reference in particular for the `ambiguous_year_future_bias` configuration options.
 
 Adam Meehan and [Timeliness](https://github.com/adzap/timeliness) which was a close match for our needs but proved to be too strict in its accepted formats particulary as we wanted to cater for a variety of date separators for both day/month/year and month/day/year date ordering. The gem provided some very useful inspiration in regards to code structure with forwarding for the configuration class and testing thread safety.
 

data/benchmark.rb

@@ -25,14 +25,7 @@ Benchmark.bm(50) do |benchmark|
     end
   end
 
-  benchmark.report("Flexitime.parse (with Time) datetime YMD") do
-    n.times do
-      Flexitime.parse("2021-08-12 12:30")
-    end
-  end
-
-  benchmark.report("Flexitime.parse (with Time.zone) datetime YMD") do
-    Flexitime.time_class = Time.zone
+  benchmark.report("Flexitime.parse datetime YMD") do
     n.times do
       Flexitime.parse("2021-08-12 12:30")
     end
@@ -52,14 +45,7 @@ Benchmark.bm(50) do |benchmark|
     end
   end
 
-  benchmark.report("Flexitime.parse (with Time) datetime DMY HM") do
-    n.times do
-      Flexitime.parse("23/08/2021 12:30")
-    end
-  end
-
-  benchmark.report("Flexitime.parse (with Time.zone) datetime DMY HM") do
-    Flexitime.time_class = Time.zone
+  benchmark.report("Flexitime.parse datetime DMY HM") do
     n.times do
       Flexitime.parse("23/08/2021 12:30")
     end
@@ -79,14 +65,7 @@ Benchmark.bm(50) do |benchmark|
     end
   end
 
-  benchmark.report("Flexitime.parse (with Time) datetime DMY HMS") do
-    n.times do
-      Flexitime.parse("23/08/2021 12:30:45")
-    end
-  end
-
-  benchmark.report("Flexitime.parse (with Time.zone) datetime DMY HMS") do
-    Flexitime.time_class = Time.zone
+  benchmark.report("Flexitime.parse datetime DMY HMS") do
     n.times do
       Flexitime.parse("23/08/2021 12:30:45")
     end
@@ -106,14 +85,7 @@ Benchmark.bm(50) do |benchmark|
     end
   end
 
-  benchmark.report("Flexitime.parse (with Time) time HM") do
-    n.times do
-      Flexitime.parse("12:30")
-    end
-  end
-
-  benchmark.report("Flexitime.parse (with Time.zone) time HM") do
-    Flexitime.time_class = Time.zone
+  benchmark.report("Flexitime.parse time HM") do
     n.times do
       Flexitime.parse("12:30")
     end
@@ -133,14 +105,7 @@ Benchmark.bm(50) do |benchmark|
     end
   end
 
-  benchmark.report("Flexitime.parse (with Time) time HMS") do
-    n.times do
-      Flexitime.parse("12:30:45")
-    end
-  end
-
-  benchmark.report("Flexitime.parse (with Time.zone) time HMS") do
-    Flexitime.time_class = Time.zone
+  benchmark.report("Flexitime.parse time HMS") do
     n.times do
       Flexitime.parse("12:30:45")
     end

data/flexitime.gemspec

@@ -44,6 +44,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "appraisal"
+  spec.add_development_dependency "simplecov"
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html

data/gemfiles/activesupport_7_0.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "standard"
+gem "activesupport", "~> 7.0"
+
+gemspec path: "../"

data/lib/flexitime/configuration.rb

@@ -7,16 +7,6 @@ module Flexitime
   class Configuration
     # = Configuration options
     #
-    # == time_class
-    # The time class used to create the Time object
-    # defaulting to Time which will use the system local time zone.
-    # This can be set to ActiveSupport::TimeZone to create a Time object
-    # using the specified time zone
-    #
-    #   Time.zone = "Europe/London"
-    #   Flexitime.time_class = Time.zone
-    #   Flexitime.parse("01/06/2021 17:00") # => Tue, 01 Jun 2021 17:00:00.000000000 BST +01:00
-    #
     # == first_date_part
     # The first part of the date within the string, either :day or :month
     # This can be set manually otherwise when using the rails-I18n gem if the first element
@@ -55,12 +45,10 @@ module Flexitime
     #   Flexitime.parse("01/08/70").year # => 1970
     #   Flexitime.parse("01/08/99").year # => 1999
     #
-    attr_accessor :time_class
     attr_reader :precision
     attr_accessor :ambiguous_year_future_bias
 
     def initialize
-      @time_class = ::Time
       @first_date_part = nil
       @precision = :min
       @ambiguous_year_future_bias = 50

data/lib/flexitime/parser.rb

@@ -22,37 +22,56 @@ module Flexitime
     # that use a period with hours & minutes
     HOUR_MINUTE_REGEX = %r{^(\d{1,2})[:.](\d{2})\s?([aApP][mM])?\.?$}
 
-    # Parse a String argument and create a Time object
-    # using the configuration time class and desired precision.
+    # Parse a String argument and create an ActiveSupport::TimeWithZone object using Time.zone
+    #
+    # The parse uses either the argument or configuration first_date_part (:day or :month)
+    # and either the argument or configuration precision (:day, :hour, :min, :sec or :usec).
     #
     # When the String contains a date or date/time or time that matches the regular expressions
-    # the time class local method is used to create a Time object
-    # otherwise the time class parse method is used to create a Time object
+    # the Time.zone local method is used to create a TimeWithZone object
+    # otherwise the Time.zone parse method is used to create a TimeWithZone object
     # and for an invalid date, date/time or time nil is returned.
-    def parse(str)
+    def parse(str, first_date_part: nil, precision: nil)
+      validate_options(first_date_part: first_date_part, precision: precision)
+
       str = str.is_a?(String) ? str : str.try(:to_str)
       return nil if str.blank?
 
-      parts = extract_parts(str)
+      parts = extract_parts(str, first_date_part: first_date_part)
 
       if parts.present?
-        create_time_from_parts(parts) if valid_date_parts?(parts)
+        create_time_from_parts(parts, precision: precision) if valid_date_parts?(parts)
       else
-        time_class_parse(str)
+        time_zone_parse(str, precision: precision)
       end
     end
 
     private
 
+    # Returns an ActiveSupport::TimeZone
+    def time_zone
+      Time.zone ||= "UTC"
+      Time.zone
+    end
+
+    # Ensure the parse method options are valid
+    # reusing the configuration class validation which raises an exception
+    def validate_options(first_date_part: nil, precision: nil)
+      return if first_date_part.blank? && precision.blank?
+      config = Configuration.new
+      config.first_date_part = first_date_part if first_date_part.present?
+      config.precision = precision if precision.present?
+    end
+
     # Extract date and time parts and return a Hash containing the parts
     # or nil if either the date or time string does not match a regex
-    def extract_parts(str)
+    def extract_parts(str, first_date_part: nil)
       date_str, time_str = separate_date_and_time(str)
 
-      date_parts = extract_date_parts(date_str)
+      date_parts = extract_date_parts(date_str, first_date_part: first_date_part)
 
       if date_parts.blank?
-        now = Flexitime.configuration.time_class.now
+        now = time_zone.now
         date_parts = {year: now.year, month: now.month, day: now.day}
         time_str = str.strip
       end
@@ -71,8 +90,8 @@ module Flexitime
       [parts.shift, parts.join(" ")]
     end
 
-    def extract_date_parts(str)
-      extract_iso_date_parts(str) || extract_local_date_parts(str)
+    def extract_date_parts(str, first_date_part: nil)
+      extract_iso_date_parts(str) || extract_local_date_parts(str, first_date_part: first_date_part)
     end
 
     def extract_iso_date_parts(str)
@@ -83,11 +102,12 @@ module Flexitime
       end
     end
 
-    def extract_local_date_parts(str)
+    def extract_local_date_parts(str, first_date_part: nil)
       # match array returns ["23-08-1973", "23", "08", "1973"]
       parts = str.match(LOCAL_DATE_REGEX).to_a.pop(3).map(&:to_i)
       if parts.present?
-        day, month = Flexitime.configuration.first_date_part == :day ? [parts.first, parts.second] : [parts.second, parts.first]
+        first_date_part ||= Flexitime.configuration.first_date_part
+        day, month = first_date_part == :day ? [parts.first, parts.second] : [parts.second, parts.first]
         {year: make_year(parts.third), month: month, day: day}
       end
     end
@@ -124,7 +144,7 @@ module Flexitime
     def make_year(year)
       return year if year.to_s.size > 2
 
-      start_year = Flexitime.configuration.time_class.now.year - Flexitime.configuration.ambiguous_year_future_bias
+      start_year = time_zone.now.year - Flexitime.configuration.ambiguous_year_future_bias
       century = (start_year / 100) * 100
       full_year = century + year
       full_year < start_year ? full_year + 100 : full_year
@@ -135,38 +155,40 @@ module Flexitime
       meridiem.to_s.downcase == "pm" ? hour + 12 : hour
     end
 
-    # Validate the day & month parts as Time#local accepts some invalid values
-    # such as Time.local(2021,2,30) returning "2021-03-02"
+    # Validate the day & month parts as Time.zone#local accepts some invalid values
+    # such as Time.zone.local(2021,2,30) returning "2021-03-02"
     def valid_date_parts?(parts)
       parts[:month] >= 1 && parts[:month] <= 12 && parts[:day] >= 1 &&
         parts[:day] <= Time.days_in_month(parts[:month], parts[:year])
     end
 
-    # Create a Time object using only those parts required for the configuration precision
-    def create_time_from_parts(parts)
-      time = Flexitime.configuration.time_class.local(*local_args_for_precision(parts))
+    # Create a TimeWithZone object object using only those parts required for the configuration precision
+    def create_time_from_parts(parts, precision: nil)
+      time = time_zone.local(*local_args_for_precision(parts, precision: precision))
       parts[:utc] ? (time + time.utc_offset) : time
     rescue
     end
 
     # Returns the date/time parts required for the configuration precision
-    def local_args_for_precision(parts)
+    def local_args_for_precision(parts, precision: nil)
       keys = [:year, :month, :day, :hour, :min, :sec, :usec]
-      index = keys.index(Flexitime.configuration.precision)
+      precision ||= Flexitime.configuration.precision
+      index = keys.index(precision)
       keys[0..index].map { |key| parts[key] }
     end
 
-    # Parse the string using the time class and set the configuration precision
-    def time_class_parse(str)
-      time = Flexitime.configuration.time_class.parse(str)
-      set_precision(time)
+    # Parse the string using Time.zone and set the configuration precision
+    def time_zone_parse(str, precision: nil)
+      time = time_zone.parse(str)
+      set_precision(time, precision: precision)
     rescue
     end
 
     # Set the precision, first checking if this is necessary
     # to avoid the overhead of calling the change method
-    def set_precision(time)
-      index = PRECISIONS.index(Flexitime.configuration.precision)
+    def set_precision(time, precision: nil)
+      precision ||= Flexitime.configuration.precision
+      index = PRECISIONS.index(precision)
       dismiss_part = PRECISIONS[index + 1]
       excess = PRECISIONS[(index + 1)..-1].sum { |key| time.send(key) }
       excess > 0 ? time.change(dismiss_part => 0) : time

data/lib/flexitime/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Flexitime
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

data/lib/flexitime.rb

@@ -5,6 +5,13 @@ require "forwardable"
 
 # Active Support Core Extensions
 # https://guides.rubyonrails.org/active_support_core_extensions.html
+begin
+  # workaround for activesupport 7.0
+  # ref: https://github.com/rails/rails/issues/43851
+  require "active_support/isolated_execution_state"
+rescue LoadError
+end
+require "active_support/time" # Time.zone
 require "active_support/core_ext/object/blank" # blank? and present?
 require "active_support/core_ext/array/access" # array second/third/fourth
 require "active_support/core_ext/time/calculations" # Time.days_in_month
@@ -16,8 +23,8 @@ require_relative "flexitime/parser"
 module Flexitime
   class << self
     extend Forwardable
-    def_delegators :configuration, :time_class, :first_date_part, :precision, :ambiguous_year_future_bias
-    def_delegators :configuration, :time_class=, :first_date_part=, :precision=, :ambiguous_year_future_bias=
+    def_delegators :configuration, :first_date_part, :precision, :ambiguous_year_future_bias
+    def_delegators :configuration, :first_date_part=, :precision=, :ambiguous_year_future_bias=
 
     include Flexitime::Parser
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flexitime
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Chris Hilton
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-22 00:00:00.000000000 Z
+date: 2022-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Ruby date/time string parser for common formats and different date orders
 email:
 - 449774+chrismhilton@users.noreply.github.com
@@ -98,6 +112,7 @@ files:
 - gemfiles/activesupport_5_2.gemfile
 - gemfiles/activesupport_6_0.gemfile
 - gemfiles/activesupport_6_1.gemfile
+- gemfiles/activesupport_7_0.gemfile
 - lib/flexitime.rb
 - lib/flexitime/configuration.rb
 - lib/flexitime/parser.rb