stamp 0.0.2 → 0.0.3

data/README.md

@@ -19,26 +19,33 @@ 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")   # "Monday, June  9, 2011"
-date.stamp("Sun Aug 5")             # "Mon Jun  9"
-date.stamp("01/01/99")              # "06/09/11"
-date.stamp("DOB: 01/01/2000")       # "DOB: 06/09/2011"
+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"
 ```
 
 ### Features
 
 * Abbreviated and full names of months and weekdays are recognized.
 * Days with or without a leading zero work instinctively.
-* You can use whatever month, weekday, day, or year value makes sense in your
-  examples.
 * Include any extraneous text you'd like, e.g. "DOB:".
 
+### Disambiguation by value
+
+You can use any month, weekday, day, or year value that makes sense in your
+examples, and stamp can often infer your intent based on context, but there
+may be times that you need to use unambiguous values to make your intent more
+explicit.
+
+For example, "01/09" could refer to January 9, September 1, or
+January 2009. More explicit examples include "12/31", "31/12", and "12/99".
+
+Using unambiguous values will also help people who read the code in the
+future understand your intent.
+
 ### Limitations
 
-* "01/09/99" is assumed to be January 9, not September 1. Patches to make this
-  configurable are welcome. Even better, make it smart enough to disambiguate
-  given an example like 31/01/99, where 31 is obviously not a month.
-* "01-Jan-1999" doesn't work yet (see @wip cucumber scenario). Patches welcome!
 * Support for time formatting by example is coming soon. Patches welcome!
 
 Did I mention? Patches welcome!
@@ -60,6 +67,8 @@ More coming soon, including time formats by example.
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
 * Fork the project
+* Run `bundle install`
+* Run `rake` to execute the cucumber specs and make sure they all pass
 * Start a feature/bugfix branch
 * Commit and push until you are happy with your contribution
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.

data/cucumber.yml

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

data/features/stamp.feature

@@ -4,39 +4,44 @@ Feature: Stamping a date
   formats a date given a human-readable example.
 
   Scenario Outline: Formatting dates by example
-    Given the date December 9, 2011
+    Given the date October 9, 2011
     When I stamp the example "<example>"
     Then I produce "<output>"
     And I like turtles
 
     Examples:
-      | example                 | output                    |
-      | January                 | December                  |
-      | Jan                     | Dec                       |
-      | Jan 1                   | Dec  9                    |
-      | Jan 01                  | Dec 09                    |
-      | Jan 10                  | Dec 09                    |
-      | Jan 1, 1999             | Dec  9, 2011              |
-      | Sunday                  | Friday                    |
-      | Sun                     | Fri                       |
-      | Sun, Jan 1              | Fri, Dec  9               |
-      | Sunday, January 1, 1999 | Friday, December  9, 2011 |
-      | 01/1999                 | 12/2011                   |
-      | 01/01                   | 12/09                     |
-      | 01/31                   | 12/09                     |
-      | 01/01/1999              | 12/09/2011                |
-      | 01/01/99                | 12/09/11                  |
-      | DOB: 01-31-1999         | DOB: 12-09-2011           |
+      | example                  | output                   |
+      | January                  | October                  |
+      | Jan                      | Oct                      |
+      | Jan 1                    | Oct  9                   |
+      | Jan 01                   | Oct 09                   |
+      | Jan 10                   | Oct 09                   |
+      | Jan 1, 1999              | Oct  9, 2011             |
+      | Monday                   | Sunday                   |
+      | Mon                      | Sun                      |
+      | Tue, Jan 1               | Sun, Oct  9              |
+      | Tuesday, January 1, 1999 | Sunday, October  9, 2011 |
+      | 01/1999                  | 10/2011                  |
+      | 01/01                    | 10/09                    |
+      | 01/31                    | 10/09                    |
+      | 01/99                    | 10/11                    |
+      | 01/01/1999               | 10/09/2011               |
+      | 12/31/99                 | 10/09/11                 |
+      | 31/12                    | 09/10                    |
+      | 31/12/99                 | 09/10/11                 |
+      | 31-Jan-1999              | 09-Oct-2011              |
+      | 1999-12-31               | 2011-10-09               |
+      | DOB: 12-31-1999          | DOB: 10-09-2011          |
 
   @wip
   Scenario Outline: Examples that aren't supported quite yet
-    Given the date December 9, 2011
+    Given the date October 9, 2011
     When I stamp the example "<example>"
     Then I produce "<output>"
 
     Examples:
-      | example     | output      |
-      | 01-Jan-1999 | 09-Dec-2011 |
+      | example | output |
+      |         |        |
 
   Scenario: strftime directives just get passed through
     Given the date December 21, 2012

data/lib/stamp.rb

@@ -23,8 +23,15 @@ module Stamp
     TWO_DIGIT_REGEXP       = /\d{2}/
     FOUR_DIGIT_REGEXP      = /\d{4}/
 
-    DATE_DELIMITER_REGEXP  = /(\/|\-)/ # forward slash or dash
+    # DATE_DELIMITER_REGEXP  = /(\/|\-)/ # forward slash or dash
 
+    # OBVIOUS_MINUTES        = 32..59
+    # OBVIOUS_HOURS
+    # OBVIOUS_SECONDS
+
+    OBVIOUS_YEARS          = 60..99
+    OBVIOUS_MONTHS         = 12
+    OBVIOUS_DAYS           = 28..31
 
     def stamp(example)
       strftime(strftime_directives(example))
@@ -40,7 +47,6 @@ module Stamp
         directive = strftime_directive(term, previous_directive)
         directives << (directive || term)
 
-        previous_term = term
         previous_directive = directive unless directive.nil?
       end
 
@@ -66,13 +72,25 @@ module Stamp
         '%Y'
 
       when TWO_DIGIT_REGEXP
-        case previous_directive
-        when '%m', '%b', '%B' # a month
-          '%d' # day with leading zero
-        when '%d', '%e'       # a day
-          '%y' # two-digit year
+        # try to discern obvious intent based on the example value
+        case term.to_i
+        when OBVIOUS_YEARS
+          '%y'
+        when OBVIOUS_MONTHS
+          '%m'
+        when OBVIOUS_DAYS
+          '%d'
         else
-          '%m' # month
+          # the intent isn't obvious based on the example value, so try to
+          # disambiguate based on context
+          case previous_directive
+          when '%m', '%b', '%B' # a month
+            '%d' # day with leading zero
+          when '%d', '%e'       # a day
+            '%y' # two-digit year
+          else
+            '%m' # month
+          end
         end
 
       when ONE_DIGIT_REGEXP

data/lib/stamp/version.rb

@@ -1,3 +1,3 @@
 module Stamp
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Jeremy Weiskotten