stamp 0.1.5 → 0.1.6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    stamp (0.1.5)
+    stamp (0.1.6)
 
 GEM
   remote: http://rubygems.org/

data/README.md

@@ -20,13 +20,13 @@ and weekday parts you'd like, and your date will be formatted accordingly:
 
 ```ruby
 date = Date.new(2011, 6, 9)
-date.stamp("March 1, 1999")         # "June  9, 2011"
-date.stamp("Jan 1, 1999")           # "Jun  9, 2011"
-date.stamp("Jan 01")                # "Jun 09"
-date.stamp("Sunday, May 1, 2000")   # "Thursday, June  9, 2011"
-date.stamp("Sun Aug 5")             # "Thu Jun  9"
-date.stamp("12/31/99")              # "06/09/11"
-date.stamp("DOB: 12/31/2000")       # "DOB: 06/09/2011"
+date.stamp("March 1, 1999")         #=> "June  9, 2011"
+date.stamp("Jan 1, 1999")           #=> "Jun  9, 2011"
+date.stamp("Jan 01")                #=> "Jun 09"
+date.stamp("Sunday, May 1, 2000")   #=> "Thursday, June  9, 2011"
+date.stamp("Sun Aug 5")             #=> "Thu Jun  9"
+date.stamp("12/31/99")              #=> "06/09/11"
+date.stamp("DOB: 12/31/2000")       #=> "DOB: 06/09/2011"
 ```
 
 ### Times
@@ -36,11 +36,11 @@ hours, minutes, and seconds when it sees colon-separated values:
 
 ```ruby
 time = Time.utc(2011, 6, 9, 20, 52, 30)
-time.stamp("3:00 AM")               # " 8:52 PM"
-time.stamp("01:00:00 AM")           # "08:52:30 PM"
-time.stamp("23:59")                 # "20:52"
-time.stamp("23:59:59")              # "20:52:30"
-time.stamp("Jan 1 at 01:00 AM")     # "Jun  9 at 08:52 PM"
+time.stamp("3:00 AM")               #=> " 8:52 PM"
+time.stamp("01:00:00 AM")           #=> "08:52:30 PM"
+time.stamp("23:59")                 #=> "20:52"
+time.stamp("23:59:59")              #=> "20:52:30"
+time.stamp("Jan 1 at 01:00 AM")     #=> "Jun  9 at 08:52 PM"
 ```
 
 ## Features
@@ -71,6 +71,24 @@ the case, the following aliases are available:
 * `stamp_like`
 * `format_like`
 
+### Rails Integration
+
+Stamp makes it easy to configure your application's common date and time
+formats in a more self-documenting way with the `strftime_format` method:
+
+```ruby
+# config/initializers/time_formats.rb
+Date::DATE_FORMATS[:short]    = Stamp.strftime_format("Mon Jan 1")
+Time::DATE_FORMATS[:military] = Stamp.strftime_format("23:59")
+```
+
+To use your formats:
+
+```ruby
+Date.today.to_s_(:short)  #=> "Sat Jul 16"
+Time.now.to_s(:military)  #=> "15:35"
+```
+
 ### Limitations
 
 * Time zone support hasn't been implemented. Patches welcome!
@@ -83,7 +101,7 @@ If you need more obscure formatting options, you can include any valid
 just be passed along:
 
 ```ruby
-Date.today.stamp("Week #%U, 1999")         # "Week #23, 2011"
+Date.today.stamp("Week #%U, 1999") #=> "Week #23, 2011"
 ````
 
 Check out [http://strfti.me](http://strfti.me) for more ideas.

data/Rakefile

@@ -3,4 +3,8 @@ require 'cucumber/rake/task'
 
 Cucumber::Rake::Task.new(:features)
 
+Cucumber::Rake::Task.new('features:wip', 'Run Cucumber features that are a work in progress') do |t|
+  t.profile = 'wip'
+end
+
 task :default => :features

data/cucumber.yml

@@ -1,3 +1,3 @@
 ---
 default: --tags ~@wip --strict
-wip: --tags @wip --strict
+wip: --tags @wip --wip

data/lib/stamp.rb

@@ -1,42 +1,24 @@
-require "stamp/version"
 require "date"
 require "time"
 
-module Stamp
-  MONTHNAMES_REGEXP      = /^(#{Date::MONTHNAMES.compact.join('|')})$/i
-  ABBR_MONTHNAMES_REGEXP = /^(#{Date::ABBR_MONTHNAMES.compact.join('|')})$/i
-  DAYNAMES_REGEXP        = /^(#{Date::DAYNAMES.join('|')})$/i
-  ABBR_DAYNAMES_REGEXP   = /^(#{Date::ABBR_DAYNAMES.join('|')})$/i
-
-  ONE_DIGIT_REGEXP       = /^\d{1}$/
-  TWO_DIGIT_REGEXP       = /^\d{2}$/
-  FOUR_DIGIT_REGEXP      = /^\d{4}$/
-
-  TIME_REGEXP            = /(\d{1,2})(:)(\d{2})(\s*)(:)?(\d{2})?(\s*)?([ap]m)?/i
-
-  MERIDIAN_LOWER_REGEXP  = /^(a|p)m$/
-  MERIDIAN_UPPER_REGEXP  = /^(A|P)M$/
-
-  # Disambiguate based on value
-  OBVIOUS_YEARS          = 60..99
-  OBVIOUS_MONTHS         = 12
-  OBVIOUS_DAYS           = 28..31
-  OBVIOUS_24_HOUR        = 13..23
+require "stamp/translator"
+require "stamp/version"
 
-  TWO_DIGIT_DATE_SUCCESSION = {
-    '%m' => '%d',
-    '%b' => '%d',
-    '%B' => '%d',
-    '%d' => '%y',
-    '%e' => '%y'
-  }
+module Stamp
 
-  TWO_DIGIT_TIME_SUCCESSION = {
-    '%H' => '%M',
-    '%I' => '%M',
-    '%l' => '%M',
-    '%M' => '%S'
-  }
+  # Transforms the given example dates/time format to a format string
+  # suitable for strftime.
+  #
+  # @param  [String] example a human-friendly date/time example
+  # @param  [#strftime] the Date or Time to be formatted. Optional, but may
+  #                     be used to support certain edge cases
+  # @return [String] a strftime-friendly format
+  #
+  # @example
+  #   Stamp.strftime_format("Jan 1, 1999") #=> "%b %e, %Y"
+  def self.strftime_format(example, target=nil)
+    Stamp::StrftimeTranslator.new(target).translate(example)
+  end
 
   # Formats a date/time using a human-friendly example as a template.
   #
@@ -51,7 +33,7 @@ module Stamp
   alias :stamp_like  :stamp
   alias :format_like :stamp
 
-  # Transforms the given string with example dates/times to a format string
+  # Transforms the given example date/time format to a format string
   # suitable for strftime.
   #
   # @param  [String] example a human-friendly date/time example
@@ -60,104 +42,12 @@ module Stamp
   # @example
   #   Date.today.strftime_format("Jan 1, 1999") #=> "%b %e, %Y"
   def strftime_format(example)
-    # extract any substrings that look like times, like "23:59" or "8:37 am"
-    before, time_example, after = example.partition(TIME_REGEXP)
-
-    # transform any date tokens to strftime directives
-    words = strftime_directives(before.split(/\b/)) do |token, previous_directive|
-      strftime_date_directive(token, previous_directive)
-    end
-
-    # transform the example time string to strftime directives
-    unless time_example.empty?
-      time_parts = time_example.scan(TIME_REGEXP).first
-      words += strftime_directives(time_parts) do |token, previous_directive|
-        strftime_time_directive(token, previous_directive)
-      end
-    end
-
-    # recursively process any remaining text
-    words << strftime_format(after) unless after.empty?
-    words.join
-  end
-
-  private
-
-  # Transforms tokens that look like date/time parts to strftime directives.
-  def strftime_directives(tokens)
-    previous_directive = nil
-    tokens.map do |token|
-      directive = yield(token, previous_directive)
-      previous_directive = directive unless directive.nil?
-      directive || token
-    end
-  end
-
-  def strftime_time_directive(token, previous_directive)
-    case token
-    when MERIDIAN_LOWER_REGEXP
-      if RUBY_VERSION =~ /^1.8/ && self.is_a?(Time)
-        # 1.8.7 doesn't implement %P
-        self.strftime("%p").downcase
-      else
-        '%P'
-      end
-
-    when MERIDIAN_UPPER_REGEXP
-      '%p'
-
-    when TWO_DIGIT_REGEXP
-      TWO_DIGIT_TIME_SUCCESSION[previous_directive] ||
-        case token.to_i
-        when OBVIOUS_24_HOUR
-          '%H' # 24-hour clock
-        else
-          '%I' # 12-hour clock with leading zero
-        end
-
-    when ONE_DIGIT_REGEXP
-      '%l' # hour without leading zero
-    end
+    # delegate to the class method, providing self as a target value to
+    # support certain edge cases
+    Stamp.strftime_format(example, self)
   end
 
-  def strftime_date_directive(token, previous_directive)
-    case token
-    when MONTHNAMES_REGEXP
-      '%B'
-
-    when ABBR_MONTHNAMES_REGEXP
-      '%b'
-
-    when DAYNAMES_REGEXP
-      '%A'
-
-    when ABBR_DAYNAMES_REGEXP
-      '%a'
-
-    when FOUR_DIGIT_REGEXP
-      '%Y'
-
-    when TWO_DIGIT_REGEXP
-      # try to discern obvious intent based on the example value
-      case token.to_i
-      when OBVIOUS_YEARS
-        '%y'
-      when OBVIOUS_MONTHS
-        '%m'
-      when OBVIOUS_DAYS
-        '%d'
-      else
-        # the intent isn't obvious based on the example value, so try to
-        # disambiguate based on context
-        TWO_DIGIT_DATE_SUCCESSION[previous_directive] || '%m'
-      end
-
-    when ONE_DIGIT_REGEXP
-      '%e' # day without leading zero
-    end
-  end
 end
 
-
 Date.send(:include, ::Stamp)
 Time.send(:include, ::Stamp)

data/lib/stamp/translator.rb

@@ -0,0 +1,139 @@
+module Stamp
+  class StrftimeTranslator
+    MONTHNAMES_REGEXP      = /^(#{Date::MONTHNAMES.compact.join('|')})$/i
+    ABBR_MONTHNAMES_REGEXP = /^(#{Date::ABBR_MONTHNAMES.compact.join('|')})$/i
+    DAYNAMES_REGEXP        = /^(#{Date::DAYNAMES.join('|')})$/i
+    ABBR_DAYNAMES_REGEXP   = /^(#{Date::ABBR_DAYNAMES.join('|')})$/i
+
+    ONE_DIGIT_REGEXP       = /^\d{1}$/
+    TWO_DIGIT_REGEXP       = /^\d{2}$/
+    FOUR_DIGIT_REGEXP      = /^\d{4}$/
+
+    TIME_REGEXP            = /(\d{1,2})(:)(\d{2})(\s*)(:)?(\d{2})?(\s*)?([ap]m)?/i
+
+    MERIDIAN_LOWER_REGEXP  = /^(a|p)m$/
+    MERIDIAN_UPPER_REGEXP  = /^(A|P)M$/
+
+    # Disambiguate based on value
+    OBVIOUS_YEARS          = 60..99
+    OBVIOUS_MONTHS         = 12
+    OBVIOUS_DAYS           = 28..31
+    OBVIOUS_24_HOUR        = 13..23
+
+    TWO_DIGIT_DATE_SUCCESSION = {
+      '%m' => '%d',
+      '%b' => '%d',
+      '%B' => '%d',
+      '%d' => '%y',
+      '%e' => '%y'
+    }
+
+    TWO_DIGIT_TIME_SUCCESSION = {
+      '%H' => '%M',
+      '%I' => '%M',
+      '%l' => '%M',
+      '%M' => '%S'
+    }
+
+    def initialize(target_date_or_time)
+      @target = target_date_or_time
+    end
+
+    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)
+
+      # transform any date tokens to strftime directives
+      words = strftime_directives(before.split(/\b/)) do |token, previous_directive|
+        strftime_date_directive(token, previous_directive)
+      end
+
+      # transform the example time string to strftime directives
+      unless time_example.empty?
+        time_parts = time_example.scan(TIME_REGEXP).first
+        words += strftime_directives(time_parts) do |token, previous_directive|
+          strftime_time_directive(token, previous_directive)
+        end
+      end
+
+      # recursively process any remaining text
+      words << translate(after) unless after.empty?
+      words.join
+    end
+
+    # Transforms tokens that look like date/time parts to strftime directives.
+    def strftime_directives(tokens)
+      previous_directive = nil
+      tokens.map do |token|
+        directive = yield(token, previous_directive)
+        previous_directive = directive unless directive.nil?
+        directive || token
+      end
+    end
+
+    def strftime_time_directive(token, previous_directive)
+      case token
+      when MERIDIAN_LOWER_REGEXP
+        if RUBY_VERSION =~ /^1.8/ && @target.is_a?(Time)
+          # 1.8.7 doesn't implement %P
+          @target.strftime("%p").downcase
+        else
+          '%P'
+        end
+
+      when MERIDIAN_UPPER_REGEXP
+        '%p'
+
+      when TWO_DIGIT_REGEXP
+        TWO_DIGIT_TIME_SUCCESSION[previous_directive] ||
+          case token.to_i
+          when OBVIOUS_24_HOUR
+            '%H' # 24-hour clock
+          else
+            '%I' # 12-hour clock with leading zero
+          end
+
+      when ONE_DIGIT_REGEXP
+        '%l' # hour without leading zero
+      end
+    end
+
+    def strftime_date_directive(token, previous_directive)
+      case token
+      when MONTHNAMES_REGEXP
+        '%B'
+
+      when ABBR_MONTHNAMES_REGEXP
+        '%b'
+
+      when DAYNAMES_REGEXP
+        '%A'
+
+      when ABBR_DAYNAMES_REGEXP
+        '%a'
+
+      when FOUR_DIGIT_REGEXP
+        '%Y'
+
+      when TWO_DIGIT_REGEXP
+        # try to discern obvious intent based on the example value
+        case token.to_i
+        when OBVIOUS_YEARS
+          '%y'
+        when OBVIOUS_MONTHS
+          '%m'
+        when OBVIOUS_DAYS
+          '%d'
+        else
+          # the intent isn't obvious based on the example value, so try to
+          # disambiguate based on context
+          TWO_DIGIT_DATE_SUCCESSION[previous_directive] || '%m'
+        end
+
+      when ONE_DIGIT_REGEXP
+        '%e' # day without leading zero
+      end
+    end
+
+  end
+end

data/lib/stamp/version.rb

@@ -1,3 +1,3 @@
 module Stamp
-  VERSION = "0.1.5"
+  VERSION = "0.1.6"
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 5
-  version: 0.1.5
+  - 6
+  version: 0.1.6
 platform: ruby
 authors: 
 - Jeremy Weiskotten
@@ -68,6 +68,7 @@ files:
 - features/step_definitions/turtle_steps.rb
 - features/support/env.rb
 - lib/stamp.rb
+- lib/stamp/translator.rb
 - lib/stamp/version.rb
 - stamp.gemspec
 has_rdoc: true