stamp 0.0.1 → 0.0.2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    stamp (0.0.1)
+    stamp (0.0.2)
 
 GEM
   remote: http://rubygems.org/
@@ -17,6 +17,7 @@ GEM
     gherkin (2.4.1)
       json (>= 1.4.6)
     json (1.5.3)
+    rake (0.9.2)
     term-ansicolor (1.0.5)
 
 PLATFORMS
@@ -24,4 +25,5 @@ PLATFORMS
 
 DEPENDENCIES
   cucumber
+  rake
   stamp!

data/LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2011 Jeremy Weiskotten
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -1,6 +1,6 @@
 # stamp
 
-Format dates and times based on examples, not arcane strftime directives.
+Format dates (and times, soon) based on examples, not arcane strftime directives.
 
 [![Build Status](http://travis-ci.org/jeremyw/stamp.png)](http://travis-ci.org/jeremyw/stamp)
 
@@ -10,13 +10,49 @@ Just `gem install stamp`, or add stamp to your Gemfile and `bundle install`.
 
 ## Usage
 
+Date objects get a powerful new method: #stamp. Provide an example date string
+with whatever month, day, year, and weekday parts you'd like, and your date
+will be formatted accordingly:
+
 ```ruby
 date = Date.new(2011, 6, 9)
-date.stamp("January 1, 1999")       # June 6, 2011
-date.stamp("Jan 09, 1999")          # Jun 06, 2011
-date.stamp("Jan 1")                 # Jun 6
+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"
 ```
 
+### 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:".
+
+### 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!
+
+If you need more obscure formatting options, you can include any valid
+[strftime](http://strfti.me) directives in your example string, and they'll
+just be passed along:
+
+```ruby
+date.stamp("Week #%U, %Y")         # "Week #23, 2011"
+````
+
+[Check out http://strfti.me](http://strfti.me) for more ideas.
+
 More coming soon, including time formats by example.
 
 ## Contributing to stamp

data/cucumber.yml

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

data/features/stamp.feature

@@ -3,18 +3,47 @@ Feature: Stamping a date
   the stamp method
   formats a date given a human-readable example.
 
-  Scenario Outline: Various examples
+  Scenario Outline: Formatting dates by example
     Given the date December 9, 2011
     When I stamp the example "<example>"
     Then I produce "<output>"
     And I like turtles
 
     Examples:
-      | example      | output       |
-      | pass-through | pass-through |
-      | January      | December     |
-      | Jan          | Dec          |
-      | Jan 1        | Dec  9       |
-      | Jan 01       | Dec 09       |
-      | Jan 10       | Dec 09       |
-      | Jan 1, 1999  | Dec  9, 2011 |
+      | 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           |
+
+  @wip
+  Scenario Outline: Examples that aren't supported quite yet
+    Given the date December 9, 2011
+    When I stamp the example "<example>"
+    Then I produce "<output>"
+
+    Examples:
+      | example     | output      |
+      | 01-Jan-1999 | 09-Dec-2011 |
+
+  Scenario: strftime directives just get passed through
+    Given the date December 21, 2012
+    When I stamp the example "John Cusack was in a movie about %b %d, %Y, but it wasn't very good."
+    Then I produce "John Cusack was in a movie about Dec 21, 2012, but it wasn't very good."
+
+  Scenario: Plain text just gets passed through
+    Given the date December 9, 2011
+    When I stamp the example "Just some plain old text."
+    Then I produce "Just some plain old text."

data/lib/stamp.rb

@@ -13,8 +13,18 @@ module Stamp
   # end
 
   module InstanceMethods
-    MONTHNAMES_REGEXP = /(#{Date::MONTHNAMES.compact.join('|')})/i
+
+    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}/
+
+    DATE_DELIMITER_REGEXP  = /(\/|\-)/ # forward slash or dash
+
 
     def stamp(example)
       strftime(strftime_directives(example))
@@ -22,31 +32,51 @@ module Stamp
 
     def strftime_directives(example)
       directives = []
+      previous_directive = nil
+
       terms = example.split(/\b/)
 
       terms.each_with_index do |term, index|
-        previous_term = (index == 0)            ? nil : terms[index - 1]
-        next_term     = (index == terms.size-1) ? nil : terms[index + 1]
+        directive = strftime_directive(term, previous_directive)
+        directives << (directive || term)
 
-        directives << (strftime_directive(term, previous_term, next_term) || term)
+        previous_term = term
+        previous_directive = directive unless directive.nil?
       end
 
       directives.join
     end
     private :strftime_directives
 
-    def strftime_directive(term, previous_term=nil, next_term=nil)
+    def strftime_directive(term, previous_directive=nil)
       case term
       when MONTHNAMES_REGEXP
         '%B'
+
       when ABBR_MONTHNAMES_REGEXP
         '%b'
-      when /\d{4}/
+
+      when DAYNAMES_REGEXP
+        '%A'
+
+      when ABBR_DAYNAMES_REGEXP
+        '%a'
+
+      when FOUR_DIGIT_REGEXP
         '%Y'
-      when /\d{2}/
-        '%d'
-      when /\d{1}/
-        '%e'
+
+      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
+        else
+          '%m' # month
+        end
+
+      when ONE_DIGIT_REGEXP
+        '%e' # day without leading zero
       end
     end
     private :strftime_directive

data/lib/stamp/version.rb

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

data/stamp.gemspec

@@ -17,4 +17,5 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_development_dependency "cucumber"
+  s.add_development_dependency "rake"
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Jeremy Weiskotten
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-29 00:00:00 -04:00
+date: 2011-06-30 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -30,6 +30,19 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
 description: Format dates and times based on examples, not arcane strftime directives.
 email: 
 - jeremy@weiskotten.com
@@ -44,8 +57,10 @@ files:
 - .rvmrc
 - Gemfile
 - Gemfile.lock
+- LICENSE.txt
 - README.md
 - Rakefile
+- cucumber.yml
 - features/stamp.feature
 - features/step_definitions/stamp_steps.rb
 - features/step_definitions/turtle_steps.rb