stamp 0.5.0 → 0.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5c0058768a5169006ec3da166fdb88f082715295
+  data.tar.gz: fcf6e1e6fc53cdd3105b1eceb2099b4014b003fc
+SHA512:
+  metadata.gz: 5be616540b39f2dac3e8bef2e886e809b908446f70e4d18d291e84dc17d22a376b12ac75332a844611be190bebc6df71a072247ed6d75ff8c8bd4e9da8b1ef6d
+  data.tar.gz: c508e4cc1a1821006ced92ae88ca0b2bb7a766cf30d04eb26cdf56f244ed0f41788d08297993a89850bf625860cc38fec416e48448d36739c1d5611a931c2813

data/.travis.yml

@@ -3,6 +3,7 @@ rvm:
   - 1.9.2
   - 1.9.3
   - 2.0.0
+  - 2.1.2
   - ree
   - rbx
-  - jruby
+  - jruby

data/Gemfile

@@ -1,3 +1,3 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 gemspec

data/features/stamp.feature

@@ -19,6 +19,9 @@ Feature: Stamping a date
       | Jan 10                   | Sep 08                       |
       | Jan 1, 1999              | Sep 8, 2011                  |
       | Jan 12, 1999             | Sep 08, 2011                 |
+      | 1 Jan 1999               | 8 Sep 2011                   |
+      | 1/1/1999                 | 9/8/2011                     |
+      | 31/01/2013               | 08/09/2011                   |
       | 13 January 1999          | 08 September 2011            |
       | Monday                   | Thursday                     |
       | Tue, Jan 1               | Thu, Sep 8                   |
@@ -32,6 +35,7 @@ Feature: Stamping a date
       | 31/12                    | 08/09                        |
       | 31/12/99                 | 08/09/11                     |
       | 31-Jan-1999              | 08-Sep-2011                  |
+      | 1999-01-01               | 2011-09-08                   |
       | 1999-12-31               | 2011-09-08                   |
       | DOB: 12-31-1999          | DOB: 09-08-2011              |
 
@@ -117,15 +121,3 @@ Feature: Stamping a date
       | alias       |
       | stamp_like  |
       | format_like |
-
-  @wip
-  Scenario Outline: Examples that aren't supported yet
-    Given the time September 8, 2011 at 13:31:27
-    When I stamp the example "<example>"
-    Then I produce "<output>"
-
-    Examples:
-      | example | output |
-      | 8 am    | 1 pm   |
-      | 8am     | 1pm    |
-      | 8AM     | 1PM    |

data/lib/stamp.rb

@@ -3,20 +3,18 @@ require "time"
 
 require "stamp/emitters/modifiable"
 require "stamp/emitters/am_pm"
+require "stamp/emitters/ambiguous"
 require "stamp/emitters/composite"
 require "stamp/emitters/delegate"
 require "stamp/emitters/lookup"
 require "stamp/emitters/ordinal"
 require "stamp/emitters/string"
 require "stamp/emitters/two_digit"
+require "stamp/disambiguator"
 require "stamp/translator"
 require "stamp/version"
 
 module Stamp
-  # Limits the number of formats that we memoize to prevent unbounded
-  # memory consumption.
-  MEMOIZATION_CAP = 999
-
   # Formats a date/time using a human-friendly example as a template.
   #
   # @param [String] example a human-friendly date/time example
@@ -33,18 +31,20 @@ module Stamp
   alias :stamp_like  :stamp
   alias :format_like :stamp
 
+  private
+
   # Memoizes the set of emitter objects for the given +example+ in
   # order to improve performance.
   def memoize_stamp_emitters(example)
     @@memoized_stamp_emitters ||= {}
-    @@memoized_stamp_emitters.clear if @@memoized_stamp_emitters.size > MEMOIZATION_CAP
     @@memoized_stamp_emitters[example] ||= stamp_emitters(example)
   end
 
   def stamp_emitters(example)
-    Translator.new.translate(example)
+    emitters = Translator.new.translate(example)
+    Disambiguator.new(emitters).disambiguate!
   end
 end
 
 Date.send(:include, ::Stamp)
-Time.send(:include, ::Stamp)
+Time.send(:include, ::Stamp)

data/lib/stamp/disambiguator.rb

@@ -0,0 +1,23 @@
+class Disambiguator
+  attr_reader :emitters
+
+  def initialize(emitters)
+    @emitters = emitters
+  end
+
+  def disambiguate!
+    emitters.replace_each! do |emitter|
+      disambiguate(emitter)
+    end
+  end
+
+  private
+
+  def disambiguate(emitter)
+    if emitter.respond_to?(:disambiguate)
+      emitter.disambiguate(emitters)
+    else
+      emitter
+    end
+  end
+end

data/lib/stamp/emitters/ambiguous.rb

@@ -0,0 +1,24 @@
+module Stamp
+  module Emitters
+    class Ambiguous
+      attr_reader :potential_emitters
+
+      def initialize(*emitters)
+        @potential_emitters = emitters
+      end
+
+      def field
+        nil
+      end
+
+      def disambiguate(emitters)
+        other_emitters = emitters - self
+        known_fields = other_emitters.map { |e| e.field }.compact
+
+        potential_emitters.reject do |potential_emitter|
+          known_fields.include?(potential_emitter.field)
+        end.first
+      end
+    end
+  end
+end

data/lib/stamp/emitters/composite.rb

@@ -3,29 +3,40 @@ module Stamp
     class Composite
       include Enumerable
 
-      def initialize
-        @emitters = []
+      attr_reader :emitters
+
+      def initialize(emitters=[])
+        @emitters = emitters
       end
 
       def format(target)
         # NOTE using #each to build string because benchmarking shows
         # that it's ~20% faster than .map.join('')
         result = ''
-        @emitters.each { |e| result << e.format(target).to_s }
+        emitters.each { |e| result << e.format(target).to_s }
         result
       end
 
-      def <<(emitter)
-        if emitter.is_a?(Enumerable)
-          emitter.each { |e| @emitters << e }
-        else
-          @emitters << emitter
-        end
+      def <<(emitter)    
+        Array(emitter).each { |e| emitters << e }
       end
 
       def each(&block)
-        @emitters.each(&block)
+        emitters.each(&block)
+      end
+
+      def -(others)
+        emitters - Array(others)
+      end
+
+      # Replace each element as we iterate with the result of the given block.
+      def replace_each!
+        emitters.each_with_index do |emitter, index|
+          emitters[index] = yield(emitter)
+        end
+
+        self
       end
     end
   end
-end
+end

data/lib/stamp/translator.rb

@@ -34,48 +34,30 @@ module Stamp
     ORDINAL_DAY_REGEXP     = /^(\d{1,2})(st|nd|rd|th)$/
 
     # Disambiguate based on value
-    OBVIOUS_YEARS          = 60..99
-    OBVIOUS_MONTHS         = 12
-    OBVIOUS_DAYS           = 13..31
     OBVIOUS_24_HOUR        = 13..23
+    OBVIOUS_DAY            = 13..31
+    OBVIOUS_YEAR           = 32..99
 
     TWO_DIGIT_YEAR_EMITTER  = Emitters::TwoDigit.new(:year) { |year| year % 100 }
     TWO_DIGIT_MONTH_EMITTER = Emitters::TwoDigit.new(:month)
     TWO_DIGIT_DAY_EMITTER   = Emitters::TwoDigit.new(:day)
     HOUR_TO_12_HOUR         = lambda { |h| ((h - 1) % 12) + 1 }
 
-    OBVIOUS_DATE_MAP = {
-      OBVIOUS_YEARS  => TWO_DIGIT_YEAR_EMITTER,
-      OBVIOUS_MONTHS => TWO_DIGIT_MONTH_EMITTER,
-      OBVIOUS_DAYS   => TWO_DIGIT_DAY_EMITTER
-    }
-
-    TWO_DIGIT_DATE_SUCCESSION = {
-      :month => TWO_DIGIT_DAY_EMITTER,
-      :day   => TWO_DIGIT_YEAR_EMITTER,
-      :year  => TWO_DIGIT_MONTH_EMITTER
-    }
-
-    TWO_DIGIT_TIME_SUCCESSION = {
-      :hour => Emitters::TwoDigit.new(:min),
-      :min  => Emitters::TwoDigit.new(:sec)
-    }
-
     def translate(example)
       # extract any substrings that look like times, like "23:59" or "8:37 am"
       before, time_example, after = example.partition(TIME_REGEXP)
 
       # build emitters from the example date
       emitters = Emitters::Composite.new
-      emitters << build_emitters(before.split(/\b/)) do |token, previous_part|
-        date_emitter(token, previous_part)
+      emitters << build_emitters(before.split(/\b/)) do |token|
+        date_emitter(token)
       end
 
       # build emitters from the example time
       unless time_example.empty?
         time_parts = time_example.scan(TIME_REGEXP).first
-        emitters << build_emitters(time_parts) do |token, previous_part|
-          time_emitter(token, previous_part)
+        emitters << build_emitters(time_parts) do |token|
+          time_emitter(token)
         end
       end
 
@@ -86,16 +68,12 @@ module Stamp
 
     # Transforms tokens that look like date/time parts to emitter objects.
     def build_emitters(tokens)
-      previous_part = nil
       tokens.map do |token|
-        emitter = yield(token, previous_part)
-        previous_part = emitter.field unless emitter.nil?
-
-        emitter || Emitters::String.new(token)
+        yield(token) || Emitters::String.new(token)
       end
     end
 
-    def time_emitter(token, previous_part)
+    def time_emitter(token)
       case token
       when MERIDIAN_LOWER_REGEXP
         Emitters::AmPm.new
@@ -104,15 +82,10 @@ module Stamp
         Emitters::AmPm.new { |v| v.upcase }
 
       when TWO_DIGIT_REGEXP
-        TWO_DIGIT_TIME_SUCCESSION[previous_part] ||
-          case token.to_i
-          when OBVIOUS_24_HOUR
-            # 24-hour clock
-            Emitters::TwoDigit.new(:hour)
-          else
-            # 12-hour clock with leading zero
-            Emitters::TwoDigit.new(:hour, &HOUR_TO_12_HOUR)
-          end
+        Emitters::Ambiguous.new(
+          two_digit_hour_emitter(token),
+          Emitters::TwoDigit.new(:min),
+          Emitters::TwoDigit.new(:sec))
 
       when ONE_DIGIT_REGEXP
         # 12-hour clock without leading zero
@@ -120,7 +93,18 @@ module Stamp
       end
     end
 
-    def date_emitter(token, previous_part)
+    def two_digit_hour_emitter(token)
+      case token.to_i
+      when OBVIOUS_24_HOUR
+        # 24-hour clock
+        Emitters::TwoDigit.new(:hour)
+      else
+        # 12-hour clock with leading zero
+        Emitters::TwoDigit.new(:hour, &HOUR_TO_12_HOUR)
+      end
+    end
+
+    def date_emitter(token)
       case token
       when MONTHNAMES_REGEXP
         Emitters::Lookup.new(:month, Date::MONTHNAMES)
@@ -146,21 +130,22 @@ module Stamp
       when TWO_DIGIT_REGEXP
         value = token.to_i
 
-        obvious_mappings =
-          OBVIOUS_DATE_MAP.reject { |k,v| v.field == previous_part }
-
-        obvious_directive = obvious_mappings.find do |range, directive|
-          break directive if range === value
+        case value
+        when OBVIOUS_DAY
+          TWO_DIGIT_DAY_EMITTER
+        when OBVIOUS_YEAR
+          TWO_DIGIT_YEAR_EMITTER
+        else
+          Emitters::Ambiguous.new(
+            TWO_DIGIT_MONTH_EMITTER,
+            TWO_DIGIT_DAY_EMITTER,
+            TWO_DIGIT_YEAR_EMITTER)
         end
 
-        # if the intent isn't obvious based on the example value, try to
-        # disambiguate based on context
-        obvious_directive ||
-          TWO_DIGIT_DATE_SUCCESSION[previous_part] ||
-          TWO_DIGIT_MONTH_EMITTER
-
       when ONE_DIGIT_REGEXP
-        Emitters::Delegate.new(:day)
+        Emitters::Ambiguous.new(
+          Emitters::Delegate.new(:month),
+          Emitters::Delegate.new(:day))
       end
     end
 

data/lib/stamp/version.rb

@@ -1,3 +1,3 @@
 module Stamp
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

data/stamp.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |s|
   s.name        = "stamp"
   s.version     = Stamp::VERSION
   s.authors     = ["Jeremy Weiskotten"]
-  s.email       = ["jeremy@weiskotten.com"]
+  s.email       = ["jeremy@terriblelabs.com"]
   s.homepage    = "https://github.com/jeremyw/stamp"
   s.summary     = %Q{Date and time formatting for humans.}
   s.description = %Q{Format dates and times based on human-friendly examples, not arcane strftime directives.}

metadata

@@ -1,59 +1,54 @@
 --- !ruby/object:Gem::Specification
 name: stamp
 version: !ruby/object:Gem::Version
-  version: 0.5.0
-  prerelease: 
+  version: 0.6.0
 platform: ruby
 authors:
 - Jeremy Weiskotten
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-17 00:00:00.000000000 Z
+date: 2014-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Format dates and times based on human-friendly examples, not arcane strftime
   directives.
 email:
-- jeremy@weiskotten.com
+- jeremy@terriblelabs.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
-- .yardopts
+- ".gitignore"
+- ".travis.yml"
+- ".yardopts"
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
@@ -64,7 +59,9 @@ files:
 - features/step_definitions/stamp_steps.rb
 - features/support/env.rb
 - lib/stamp.rb
+- lib/stamp/disambiguator.rb
 - lib/stamp/emitters/am_pm.rb
+- lib/stamp/emitters/ambiguous.rb
 - lib/stamp/emitters/composite.rb
 - lib/stamp/emitters/delegate.rb
 - lib/stamp/emitters/lookup.rb
@@ -77,33 +74,26 @@ files:
 - stamp.gemspec
 homepage: https://github.com/jeremyw/stamp
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 167698609462982419
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 167698609462982419
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Date and time formatting for humans.
 test_files:
 - features/stamp.feature