stamp 0.1.4 → 0.1.5

data/.gitignore

@@ -1,3 +1,5 @@
 *.gem
 .bundle
+.yardoc
+doc
 pkg/*

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown

data/Gemfile.lock

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

data/features/stamp.feature

@@ -9,37 +9,37 @@ Feature: Stamping a date
     Given the date September 8, 2011
     When I stamp the example "<example>"
     Then I produce "<output>"
-    And I like turtles
+      And I like turtles
 
     Examples:
-      | example                  | output                   |
-      | January                  | September                |
-      | Jan                      | Sep                      |
-      | Jan 1                    | Sep  8                   |
-      | Jan 01                   | Sep 08                   |
-      | Jan 10                   | Sep 08                   |
-      | Jan 1, 1999              | Sep  8, 2011             |
-      | Monday                   | Thursday                 |
-      | Tue, Jan 1               | Thu, Sep  8              |
+      | example                  | output                       |
+      | January                  | September                    |
+      | Jan                      | Sep                          |
+      | Jan 1                    | Sep  8                       |
+      | Jan 01                   | Sep 08                       |
+      | Jan 10                   | Sep 08                       |
+      | Jan 1, 1999              | Sep  8, 2011                 |
+      | Monday                   | Thursday                     |
+      | Tue, Jan 1               | Thu, Sep  8                  |
       | Tuesday, January 1, 1999 | Thursday, September  8, 2011 |
-      | 01/1999                  | 09/2011                  |
-      | 01/01                    | 09/08                    |
-      | 01/31                    | 09/08                    |
-      | 01/99                    | 09/11                    |
-      | 01/01/1999               | 09/08/2011               |
-      | 12/31/99                 | 09/08/11                 |
-      | 31/12                    | 08/09                    |
-      | 31/12/99                 | 08/09/11                 |
-      | 31-Jan-1999              | 08-Sep-2011              |
-      | 1999-12-31               | 2011-09-08               |
-      | DOB: 12-31-1999          | DOB: 09-08-2011          |
+      | 01/1999                  | 09/2011                      |
+      | 01/01                    | 09/08                        |
+      | 01/31                    | 09/08                        |
+      | 01/99                    | 09/11                        |
+      | 01/01/1999               | 09/08/2011                   |
+      | 12/31/99                 | 09/08/11                     |
+      | 31/12                    | 08/09                        |
+      | 31/12/99                 | 08/09/11                     |
+      | 31-Jan-1999              | 08-Sep-2011                  |
+      | 1999-12-31               | 2011-09-08                   |
+      | DOB: 12-31-1999          | DOB: 09-08-2011              |
 
   @time
   Scenario Outline: Formatting times by example
-    Given the time October 9, 2011 at 13:31:27
+    Given the time September 8, 2011 at 13:31:27
     When I stamp the example "<example>"
     Then I produce "<output>"
-    And I like turtles
+      And I like turtles
 
     Examples:
       | example     | output      |
@@ -53,13 +53,25 @@ Feature: Stamping a date
       | 08:59:59 PM | 01:31:27 PM |
       | 23:59:59    | 13:31:27    |
 
+  @date
+  @time
+  Scenario Outline: Formatting dates and times by example
+    Given the time September 8, 2011 at 13:31:27
+    When I stamp the example "<example>"
+    Then I produce "<output>"
+      And I like turtles
+
+    Examples:
+      | example                         | output                            |
+      | Jan 1, 1999 8:59 am             | Sep  8, 2011  1:31 pm             |
+      | 08:59 AM 1999-12-31             | 01:31 PM 2011-09-08               |
+      | Date: Jan 1, 1999 Time: 8:59 am | Date: Sep  8, 2011 Time:  1:31 pm |
 
   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 June 1, 1926
     When I stamp the example "Marilyn Monroe was born on January 1, 1999."
@@ -77,7 +89,7 @@ Feature: Stamping a date
 
   @wip
   Scenario Outline: Examples that aren't supported yet
-    Given the date October 9, 2011
+    Given the time September 8, 2011 at 13:31:27
     When I stamp the example "<example>"
     Then I produce "<output>"
 

data/lib/stamp.rb

@@ -12,7 +12,7 @@ module Stamp
   TWO_DIGIT_REGEXP       = /^\d{2}$/
   FOUR_DIGIT_REGEXP      = /^\d{4}$/
 
-  TIME_REGEXP            = /^(\d{1,2})(:)(\d{2})(\s*)(:)?(\d{2})?(\s*)?([ap]m)?$/i
+  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$/
@@ -38,18 +38,27 @@ module Stamp
     '%M' => '%S'
   }
 
-
+  # Formats a date/time using a human-friendly example as a template.
+  #
+  # @param  [String] example a human-friendly date/time example
+  # @return [String] the formatted date or time
+  #
+  # @example
+  #   Date.new(2012, 12, 21).stamp("Jan 1, 1999") #=> "Dec 21, 2012"
   def stamp(example)
     strftime(strftime_format(example))
   end
-
   alias :stamp_like  :stamp
   alias :format_like :stamp
 
-  private
-
   # Transforms the given string with example dates/times to a format string
   # suitable for strftime.
+  #
+  # @param  [String] example a human-friendly date/time example
+  # @return [String] a strftime-friendly format
+  #
+  # @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)
@@ -72,6 +81,8 @@ module Stamp
     words.join
   end
 
+  private
+
   # Transforms tokens that look like date/time parts to strftime directives.
   def strftime_directives(tokens)
     previous_directive = nil

data/lib/stamp/version.rb

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

data/stamp.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.email       = ["jeremy@weiskotten.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 examples, not arcane strftime directives.}
+  s.description = %Q{Format dates and times based on human-friendly examples, not arcane strftime directives.}
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: stamp
 version: !ruby/object:Gem::Version 
-  hash: 19
-  prerelease: 
+  prerelease: false
   segments: 
   - 0
   - 1
-  - 4
-  version: 0.1.4
+  - 5
+  version: 0.1.5
 platform: ruby
 authors: 
 - Jeremy Weiskotten
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-14 00:00:00 -04:00
+date: 2011-07-16 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,7 +25,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
@@ -40,13 +38,12 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
   type: :development
   version_requirements: *id002
-description: Format dates and times based on examples, not arcane strftime directives.
+description: Format dates and times based on human-friendly examples, not arcane strftime directives.
 email: 
 - jeremy@weiskotten.com
 executables: []
@@ -59,6 +56,7 @@ files:
 - .gitignore
 - .rvmrc
 - .travis.yml
+- .yardopts
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -86,7 +84,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -95,14 +92,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Date and time formatting for humans.