timeliness 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 830b2a8f549031529ac5f153c60e80c4f6babae4edfd5e883fc954645f350322
-  data.tar.gz: 74ed311a9aa4a2da4d995a774e1ee438ee1454708cb25d991dfac30440d4cdcc
+  metadata.gz: '09a4713be8da3195a5d92e1cfbd2bfda98f35ff922674fd12339bcecc562e366'
+  data.tar.gz: d645f22bed3e99b5e2ebf971304e6f6acc6b657339f3d3d651ea67902258fb24
 SHA512:
-  metadata.gz: 66516e7c7cd33f1ef1c030f99a9e0ede74a39091c18d8c039310894a4e9ef7069c3630ac9bb6e2fe2f2b9be1acd68ca17e0036645842f56a489101776417264c
-  data.tar.gz: a1334464ba03f8c55245ab93ea8d26267900e5af3c2a6b6340d566e7cf59917758526ac2ab9165424568c84a8058932129fecc9a1caa844d2cb067bc0a679fdb
+  metadata.gz: 346644804949fc5398084ff04feecca71b6a415908433520932ff7f38985bcf6bb2c8db0dd048f3939286ebdf9d01fab4544ab9c45e5d2a6549984231f0ec329
+  data.tar.gz: 39b7862378f626fb7f361769deb81488cd7d5c3c86a61a81dff199ea4b6abc07d29422f64a16e8220085a49fc25c45216259c1e49d5a371533ac4255257fb25f

data/CHANGELOG.rdoc

@@ -1,3 +1,8 @@
+= 0.4.3 - 2019-06-16
+* Fixed `Timeliness.ambiguous_date_format` being used in new threads if custom value set
+* Moved all config from Timeliness to new Configuration class. Delegated all
+  old config methods to Timeliness.configuration instance.
+
 = 0.4.2 - 2019-06-15
 * Fixed thread safe issue that forced you to use one of the date format methods e.g. `use_euro_formats`
   to initialize the format sets in each new thread. Now a new thread will default to the global default (main thread).

data/lib/timeliness.rb

@@ -1,6 +1,7 @@
 require 'date'
 require 'forwardable'
 
+require 'timeliness/configuration'
 require 'timeliness/helpers'
 require 'timeliness/definitions'
 require 'timeliness/format'
@@ -13,38 +14,19 @@ module Timeliness
     extend Forwardable
     def_delegators Parser, :parse, :_parse
     def_delegators Definitions, :add_formats, :remove_formats, :use_us_formats, :use_euro_formats
-    attr_accessor :default_timezone, :date_for_time_type, :ambiguous_date_format, :ambiguous_year_threshold
-  end
-
-  # Default timezone. Options:
-  #   - :local (default)
-  #   - :utc
-  #   
-  #   If ActiveSupport loaded, also
-  #   - :current
-  #   - 'Zone name'
-  #
-  self.default_timezone = :local
+    attr_accessor :configuration
 
-  # Set the default date part for a time type values.
-  #
-  self.date_for_time_type = lambda { Time.now }
+    def_delegators :configuration, :default_timezone, :date_for_time_type, :ambiguous_date_format, :ambiguous_year_threshold
+    def_delegators :configuration, :default_timezone=, :date_for_time_type=, :ambiguous_date_format=, :ambiguous_year_threshold=
+  end
 
-  # Default parsing of ambiguous date formats. Options:
-  #   - :us (default, 01/02/2000 = 2nd of January 2000)
-  #   - :euro (01/02/2000 = 1st of February 2000)
-  #
-  self.ambiguous_date_format = :us
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
 
-  # Set the threshold value for a two digit year to be considered last century
-  #
-  # Default: 30
-  #
-  #   Example:
-  #     year = '29' is considered 2029
-  #     year = '30' is considered 1930
-  #
-  self.ambiguous_year_threshold = 30
+  def self.configure
+    yield(configuration)
+  end
 end
 
 Timeliness::Definitions.compile_formats

data/lib/timeliness/configuration.rb

@@ -0,0 +1,40 @@
+module Timeliness
+  class Configuration
+    # Default timezone. Options:
+    #   - :local (default)
+    #   - :utc
+    #   
+    #   If ActiveSupport loaded, also
+    #   - :current
+    #   - 'Zone name'
+    #
+    attr_accessor :default_timezone 
+
+    # Set the default date part for a time type values.
+    #
+    attr_accessor :date_for_time_type
+
+    # Default parsing of ambiguous date formats. Options:
+    #   - :us (default, 01/02/2000 = 2nd of January 2000)
+    #   - :euro (01/02/2000 = 1st of February 2000)
+    #
+    attr_accessor :ambiguous_date_format
+
+    # Set the threshold value for a two digit year to be considered last century
+    #
+    # Default: 30
+    #
+    #   Example:
+    #     year = '29' is considered 2029
+    #     year = '30' is considered 1930
+    #
+    attr_accessor :ambiguous_year_threshold
+
+    def initialize
+      @default_timezone = :local
+      @date_for_time_type = lambda { Time.now }
+      @ambiguous_date_format = :us
+      @ambiguous_year_threshold = 30
+    end
+  end
+end

data/lib/timeliness/definitions.rb

@@ -195,15 +195,17 @@ module Timeliness
       end
 
       def current_date_format
-        Thread.current["Timeliness.current_date_format"] ||= @current_date_format
+        Thread.current["Timeliness.current_date_format"] ||= Timeliness.configuration.ambiguous_date_format
       end
 
       # Get date format set for using current thread format setting
+      #
       def date_format_set
         instance_variable_get(:"@#{current_date_format}_date_format_set")
       end
 
       # Get datetime format set for using current thread format setting
+      #
       def datetime_format_set
         instance_variable_get(:"@#{current_date_format}_datetime_format_set")
       end
@@ -222,9 +224,6 @@ module Timeliness
 
       def compile_formats
         @sorted_token_keys        = nil
-        @current_date_format      = Timeliness.ambiguous_date_format
-
-        self.current_date_format  = @current_date_format
 
         @time_format_set          = FormatSet.compile(time_formats)
         @us_date_format_set       = FormatSet.compile(date_formats)

data/lib/timeliness/helpers.rb

@@ -15,7 +15,7 @@ module Timeliness
     def unambiguous_year(year)
       if year.length <= 2
         century = Time.now.year.to_s[0..1].to_i
-        century -= 1 if year.to_i >= Timeliness.ambiguous_year_threshold
+        century -= 1 if year.to_i >= Timeliness.configuration.ambiguous_year_threshold
         year = "#{century}#{year.rjust(2,'0')}"
       end
       year.to_i

data/lib/timeliness/parser.rb

@@ -105,7 +105,7 @@ module Timeliness
       end
 
       def shift_time_to_zone(time, zone=nil)
-        zone ||= Timeliness.default_timezone
+        zone ||= Timeliness.configuration.default_timezone
         case zone
         when :utc, :local
           time.send("get#{zone}")
@@ -117,7 +117,7 @@ module Timeliness
       end
 
       def create_time_in_zone(time_array, zone=nil)
-        zone ||= Timeliness.default_timezone
+        zone ||= Timeliness.configuration.default_timezone
         case zone
         when :utc, :local
           time_with_datetime_fallback(zone, *time_array)
@@ -153,11 +153,13 @@ module Timeliness
       end
 
       def evaluate_date_for_time_type
-        case Timeliness.date_for_time_type
+        date_for_time_type = Timeliness.configuration.date_for_time_type
+
+        case date_for_time_type
         when Array
-          Timeliness.date_for_time_type
+          date_for_time_type
         when Proc
-          v = Timeliness.date_for_time_type.call
+          v = date_for_time_type.call
           [v.year, v.month, v.day]
         end
       end

data/lib/timeliness/version.rb

@@ -1,3 +1,3 @@
 module Timeliness
-  VERSION = '0.4.2'
+  VERSION = '0.4.3'
 end

data/spec/timeliness/definitions_spec.rb

@@ -1,5 +1,4 @@
 describe Timeliness::Definitions do
-
   context "add_formats" do
     before do
       @default_formats = definitions.time_formats.dup
@@ -102,10 +101,16 @@ describe Timeliness::Definitions do
     end
   end
 
-  context "thread safe date format switching" do
+  context "thread safe ambiguous date format switching" do
     let(:ambiguous_date) { "01/02/2000" }
 
-    it "should allow indepdent regional format control in current thread" do
+    around do |example|
+      Timeliness::Definitions.compile_formats
+      example.call
+      Timeliness::Definitions.compile_formats
+    end
+
+    it "should allow independent control in current thread" do
       threads = {
         euro: Thread.new { Timeliness.use_euro_formats; sleep(0.005); Timeliness.parse(ambiguous_date) },
         us:   Thread.new { sleep(0.001); Timeliness.use_us_formats; Timeliness.parse(ambiguous_date) }
@@ -116,11 +121,13 @@ describe Timeliness::Definitions do
       expect(threads[:us].value).to eql(Time.new(2000,1,2))
     end
 
-    it 'should use default regional format in new threads' do
+    it 'should use default format in new threads' do
+      Timeliness.configuration.ambiguous_date_format = :euro
+
       thread = Thread.new { sleep(0.001); Timeliness.parse(ambiguous_date) }
       thread.join
 
-      expect(thread.value).to eql(Time.new(2000,1,2))
+      expect(thread.value).to eql(Time.new(2000,2,1))
     end
   end
 end

data/spec/timeliness/parser_spec.rb

@@ -1,19 +1,17 @@
 describe Timeliness::Parser do
-  around(:all) do |example|
-    current_default = Timeliness.default_timezone
-    current_zone = Time.zone
-    example.call
-    Time.zone = current_zone
-    Timeliness.default_timezone = current_default
-  end
-
   def self.timezone_settings(zone: nil, output: nil)
     before do
       Time.zone = zone if zone
-      Timeliness.default_timezone = output if output 
+      Timeliness.configuration.default_timezone = output if output 
     end
   end
 
+  around(:all) do |example|
+    current_zone = Time.zone
+    example.call
+    Time.zone = current_zone
+  end
+
   before(:all) do
     Timecop.freeze(2010,1,1,0,0,0)
   end
@@ -121,22 +119,25 @@ describe Timeliness::Parser do
       timezone_settings zone: 'Australia/Melbourne'
 
       it 'should return value using string zone adjusted to default :local timezone' do
-        Timeliness.default_timezone = :local
+        Timeliness.configuration.default_timezone = :local
+
         value = parse("Thu, 01 Jun 2000 03:00:00 MST")
         expect(value).to eq Time.utc(2000,6,1,10,0,0).getlocal
         expect(value.utc_offset).to eq Time.mktime(2000, 6, 1, 10, 0, 0).utc_offset
       end
 
       it 'should return value using string zone adjusted to default :current timezone' do
-        Timeliness.default_timezone = :current
+        Timeliness.configuration.default_timezone = :current
         Time.zone = 'Adelaide'
+
         value = parse("Thu, 01 Jun 2000 03:00:00 MST")
         expect(value).to eq Time.zone.local(2000,6,1,19,30,0)
         expect(value.utc_offset).to eq 9.5.hours
       end
 
       it 'should return value using string zone adjusted to :zone option string timezone' do
-        Timeliness.default_timezone = :local
+        Timeliness.configuration.default_timezone = :local
+
         value = parse("Thu, 01 Jun 2000 03:00:00 MST", :zone => 'Perth')
         expect(value).to eq Time.use_zone('Perth') { Time.zone.local(2000,6,1,18,0,0) }
         expect(value.utc_offset).to eq 8.hours
@@ -147,7 +148,7 @@ describe Timeliness::Parser do
       timezone_settings zone: 'Australia/Melbourne'
       
       it 'should return value using string zone adjusted to default :current timezone' do
-        Timeliness.default_timezone = :current
+        Timeliness.configuration.default_timezone = :current
 
         value = parse("2000-06-01T12:00:00Z")
         expect(value).to eq Time.zone.local(2000,6,1,22,0,0)
@@ -276,22 +277,16 @@ describe Timeliness::Parser do
 
     context "for time type" do
       context "with date from date_for_time_type" do
-        before do
-          @original = Timeliness.date_for_time_type
-        end
-
         it 'should return date array' do
-          Timeliness.date_for_time_type = [2010,1,1]
+          Timeliness.configuration.date_for_time_type = [2010,1,1]
+
           expect(parse('12:13:14', :time)).to eq Time.local(2010,1,1,12,13,14)
         end
 
         it 'should return date array evaluated lambda' do
-          Timeliness.date_for_time_type = lambda { Time.local(2010,2,1) }
-          expect(parse('12:13:14', :time)).to eq Time.local(2010,2,1,12,13,14)
-        end
+          Timeliness.configuration.date_for_time_type = lambda { Time.local(2010,2,1) }
 
-        after do
-          Timeliness.date_for_time_type = @original
+          expect(parse('12:13:14', :time)).to eq Time.local(2010,2,1,12,13,14)
         end
       end
 
@@ -303,7 +298,6 @@ describe Timeliness::Parser do
 
       context "with :zone option" do
         before(:all) do
-          Timecop.return
           @current_tz = ENV['TZ']
           ENV['TZ'] = 'Australia/Melbourne'
           Timecop.freeze(2010,1,1,0,0,0)
@@ -317,7 +311,6 @@ describe Timeliness::Parser do
         end
 
         after(:all) do
-          Timecop.return
           ENV['TZ'] = @current_tz
           Timecop.freeze(2010,1,1,0,0,0)
         end
@@ -442,13 +435,12 @@ describe Timeliness::Parser do
       end
 
       it "should allow custom threshold" do
-        default = Timeliness.ambiguous_year_threshold
-        Timeliness.ambiguous_year_threshold = 40
+        Timeliness.configuration.ambiguous_year_threshold = 40
+
         time_array = parser._parse('01-02-39', :date)
         expect(time_array).to eq [2039,2,1,nil,nil,nil,nil,nil]
         time_array = parser._parse('01-02-40', :date)
         expect(time_array).to eq [1940,2,1,nil,nil,nil,nil,nil]
-        Timeliness.ambiguous_year_threshold = default
       end
     end
   end
@@ -476,7 +468,8 @@ describe Timeliness::Parser do
 
     context "default timezone" do
       it "should be used if no zone value" do
-        Timeliness.default_timezone = :utc
+        Timeliness.configuration.default_timezone = :utc
+
         time = parser.make_time([2000,6,1,12,0,0])
         expect(time.utc_offset).to eq 0
       end
@@ -518,7 +511,7 @@ describe Timeliness::Parser do
 
     context "with no options" do
       it 'should return date_for_time_type values with no options' do
-        dummy_date = Timeliness.date_for_time_type.call
+        dummy_date = Timeliness.configuration.date_for_time_type.call
         expect(current_date).to eq [ dummy_date.year, dummy_date.month, dummy_date.day ]
       end
     end

data/spec/timeliness_helper.rb

@@ -34,4 +34,8 @@ I18n.available_locales = ['en', 'es']
 RSpec.configure do |c|
   c.mock_with :rspec
   c.include TimelinessHelpers
+
+  c.after do
+    Timeliness.configuration = Timeliness::Configuration.new
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timeliness
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors:
 - Adam Meehan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-15 00:00:00.000000000 Z
+date: 2019-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -95,6 +95,7 @@ files:
 - Rakefile
 - benchmark.rb
 - lib/timeliness.rb
+- lib/timeliness/configuration.rb
 - lib/timeliness/core_ext.rb
 - lib/timeliness/core_ext/string.rb
 - lib/timeliness/definitions.rb