timeliness 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22c5b15397d7f945442d9768efb71ebbb243e7d44b8948d8ccf03e31c70858b3
-  data.tar.gz: 96ac6e12fd20b0b5530e3ae99e60b2df81c9014bd7cedba26fa6e9395268d8b5
+  metadata.gz: 830b2a8f549031529ac5f153c60e80c4f6babae4edfd5e883fc954645f350322
+  data.tar.gz: 74ed311a9aa4a2da4d995a774e1ee438ee1454708cb25d991dfac30440d4cdcc
 SHA512:
-  metadata.gz: d3c968646a9f6bc9d867d31c062724e162c8824fd4feb9f76a682f46cfd20cf817948b06bb1f14731eb2f3bb2be5d433edcb39d51ee8655e863898940f9ebf08
-  data.tar.gz: 5eb2af292e5248ee58cfd539bad3491c668adf8c564579c1694ebffd0163e27d0353aec2bd0d478923d930d796d878ca8e99861ea15c9ea86d4bac9089ce16f8
+  metadata.gz: 66516e7c7cd33f1ef1c030f99a9e0ede74a39091c18d8c039310894a4e9ef7069c3630ac9bb6e2fe2f2b9be1acd68ca17e0036645842f56a489101776417264c
+  data.tar.gz: a1334464ba03f8c55245ab93ea8d26267900e5af3c2a6b6340d566e7cf59917758526ac2ab9165424568c84a8058932129fecc9a1caa844d2cb067bc0a679fdb

data/CHANGELOG.rdoc

@@ -1,3 +1,8 @@
+= 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).
+* Add `Timeliness.ambiguous_date_format` config setting (:us or :euro) to control global default for date format sets. 
+
 = 0.4.1 - 2019-06-11
 * Add format for ISO 8601 with usec and 'Z' UTC zone offset (jartek)
 * Fix ISO 8601 parsing bug where Z was not recognised as UTC

data/README.rdoc

@@ -236,7 +236,7 @@ To see all defined formats look at the {source code}[http://github.com/adzap/tim
 === US/Euro Formats
 
 The perennial problem for non-US developers or applications not primarily for the US, is the US date
-format of m/d/yy. This is ambiguous with the European format of d/m/yy. By default the gem uses the
+format of m/d/yy. This is can be ambiguous with the European format of d/m/yy. By default the gem uses the
 US formats as this is the Ruby default
 when it does date interpretation.
 
@@ -250,6 +250,13 @@ You can switch back to US formats with
 
   Timeliness.use_us_formats
 
+==== Thread Safety
+
+The switching of formats is threadsafe (since v0.4.0), however for each new thread the format default will be 
+the gem default, being the US format. To control default for your app and each new thread, use the config
+
+  Timeliness.ambiguous_date_format = :euro
+
 
 === Customising Formats
 

data/lib/timeliness.rb

@@ -2,7 +2,6 @@ require 'date'
 require 'forwardable'
 
 require 'timeliness/helpers'
-require 'timeliness/threadsafe_attr'
 require 'timeliness/definitions'
 require 'timeliness/format'
 require 'timeliness/format_set'
@@ -14,7 +13,7 @@ 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_year_threshold
+    attr_accessor :default_timezone, :date_for_time_type, :ambiguous_date_format, :ambiguous_year_threshold
   end
 
   # Default timezone. Options:
@@ -31,6 +30,12 @@ module Timeliness
   #
   self.date_for_time_type = lambda { Time.now }
 
+  # 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
+
   # Set the threshold value for a two digit year to be considered last century
   #
   # Default: 30

data/lib/timeliness/definitions.rb

@@ -155,9 +155,8 @@ module Timeliness
     DuplicateFormat = Class.new(StandardError)
 
     class << self
-      extend ThreadsafeAttr
       attr_accessor :time_formats, :date_formats, :datetime_formats, :format_tokens, :format_components, :timezone_mapping
-      threadsafe_attr_accessor :date_format_set, :time_format_set, :datetime_format_set
+      attr_reader :time_format_set, :date_format_set, :datetime_format_set
 
       # Adds new formats. Must specify format type and can specify a :before
       # option to nominate which format the new formats should be inserted in
@@ -191,35 +190,51 @@ module Timeliness
         compile_formats
       end
 
-      # Removes US date formats so that ambiguous dates are parsed as European format
+      def current_date_format=(value)
+        Thread.current["Timeliness.current_date_format"] = value
+      end
+
+      def current_date_format
+        Thread.current["Timeliness.current_date_format"] ||= @current_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
+
+      # Use date formats that return ambiguous dates parsed in European format
       #
       def use_euro_formats
-        self.date_format_set     = @euro_date_format_set
-        self.datetime_format_set = @euro_datetime_format_set
+        self.current_date_format = :euro
       end
 
-      # Restores default to parse ambiguous dates as US format
+      # Use date formats that return ambiguous dates parsed as US format
       #
       def use_us_formats
-        self.date_format_set     = @us_date_format_set
-        self.datetime_format_set = @us_datetime_format_set
+        self.current_date_format = :us
       end
 
       def compile_formats
-        @sorted_token_keys = nil
-        self.time_format_set   = FormatSet.compile(time_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)
         @us_datetime_format_set   = FormatSet.compile(datetime_formats)
         @euro_date_format_set     = FormatSet.compile(date_formats.select { |format| US_FORMAT_REGEXP !~ format })
         @euro_datetime_format_set = FormatSet.compile(datetime_formats.select { |format| US_FORMAT_REGEXP !~ format })
-
-        self.date_format_set     = @us_date_format_set
-        self.datetime_format_set = @us_datetime_format_set
       end
 
       def sorted_token_keys
-        @sorted_token_keys ||= format_tokens.keys.sort {|a,b| a.size <=> b.size }.reverse
+        @sorted_token_keys ||= format_tokens.keys.sort_by(&:size).reverse
       end
 
       # Returns format for type and other possible matching format set based on type

data/lib/timeliness/version.rb

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

data/spec/timeliness/definitions_spec.rb

@@ -102,15 +102,25 @@ describe Timeliness::Definitions do
     end
   end
 
-  context "threadsafety" do
-    it "should allow threadsafe use of regional formats" do
-      eu_date = "30/06/2016"
-      us_date = "06/30/2016"
-      threads = []
-      threads << Thread.new { Timeliness.use_euro_formats; sleep(0.005); Timeliness.parse(eu_date) }
-      threads << Thread.new { sleep(0.001); Timeliness.use_us_formats; Timeliness.parse(us_date) }
-      threads.each { |t| t.join }
-      threads.each { |t| expect(t.value).to eql(Time.new(2016,06,30)) }
+  context "thread safe date format switching" do
+    let(:ambiguous_date) { "01/02/2000" }
+
+    it "should allow indepdent regional format 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) }
+      }
+      threads.values.each { |t| t.join }
+
+      expect(threads[:euro].value).to eql(Time.new(2000,2,1))
+      expect(threads[:us].value).to eql(Time.new(2000,1,2))
+    end
+
+    it 'should use default regional format in new threads' do
+      thread = Thread.new { sleep(0.001); Timeliness.parse(ambiguous_date) }
+      thread.join
+
+      expect(thread.value).to eql(Time.new(2000,1,2))
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timeliness
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Adam Meehan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-11 00:00:00.000000000 Z
+date: 2019-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -102,7 +102,6 @@ files:
 - lib/timeliness/format_set.rb
 - lib/timeliness/helpers.rb
 - lib/timeliness/parser.rb
-- lib/timeliness/threadsafe_attr.rb
 - lib/timeliness/version.rb
 - spec/spec_helper.rb
 - spec/timeliness/core_ext/string_spec.rb

data/lib/timeliness/threadsafe_attr.rb

@@ -1,24 +0,0 @@
-module Timeliness
-  module ThreadsafeAttr
-    def threadsafe_attr_accessor(*attrs)
-      attrs.each do |attr|
-        storage_name = "#{name}.#{attr}".freeze
-        reader attr, storage_name
-        writer attr, storage_name
-      end
-    end
-
-    private
-    def reader(attr, storage_name)
-      define_method(attr) do
-        Thread.current[storage_name]
-      end
-    end
-
-    def writer(attr, storage_name)
-      define_method("#{attr}=") do |value|
-        Thread.current[storage_name] = value
-      end
-    end
-  end
-end