kronic 0.1 → 0.1.1

data/HISTORY

@@ -1,2 +1,5 @@
+0.1.1 - 19 September 2010
+  * Kronic.parse will explode in fewer scenarios!
+
 0.1 - 19 September 2010
   * Initial release!

data/README.rdoc

@@ -14,10 +14,11 @@ Oh yeah, Kronic is less than 60 lines of code.
 
   gem install kronic
 
+  require 'kronic'
   Kronic.parse("Today")     # => Date.today
   Kronic.format(Date.today) # => "Today"
 
-See the specs for all the supported formats (there are not many).
+Supported formats: Today, yesterday, last thursday, 14 Sep, 14 June 2010
 
 == Future
 

data/Rakefile

@@ -0,0 +1,8 @@
+desc 'Default: run specs.'
+task :default => :spec
+
+# RSpec provided helper doesn't like me, for now just run it myself
+desc "Run specs"
+task :spec do
+  exec("rspec spec/*_spec.rb")
+end

data/lib/kronic.rb

@@ -3,8 +3,25 @@ require 'active_support/duration'
 require 'active_support/time_with_zone'
 
 class Kronic
+  # Converts a human readable day (Today, yesterday) to a date in the past.
+  # Supported inputs include Today, yesterday, last thursday, 14 Sep, 14
+  # June 2010, all case-insensitive.
+  #
+  # Will call #to_s on the input, so can process Symbols or whatever other
+  # object you wish to throw at it.
   def self.parse(string)
-    string = string.downcase
+    # TODO: You could totally clean this method up, if you wanted
+    def self.month_from_name(month)
+      months = (1..12).map {|x|
+        Date.new(2010, x, 1)
+      }.inject({}) {|a, x|
+        a.update(x.strftime("%B").downcase => x.month)
+      }
+      
+      months[month] || months.detect {|name, number| name.starts_with?(month) }.try(:last)
+    end
+
+    string = string.to_s.downcase.strip
     today  = Date.today
 
     return Date.today     if string == 'today'
@@ -12,6 +29,7 @@ class Kronic
 
     tokens = string.split(/\s+/)
 
+    # Last X
     if tokens[0] == 'last'
       days = (1..7).map {|x| 
         (Date.today - x.days) 
@@ -21,13 +39,17 @@ class Kronic
       return days[tokens[1]]
     end
 
+    # 14 Sep, 14 September, 14 September 2010
     if tokens[0] =~ /^[0-9]+$/
-
       day   = tokens[0].to_i
       month = month_from_name(tokens[1])
-      year  = tokens[2] ? tokens[2].to_i : today.year
+      year  = if tokens[2]
+        tokens[2] =~ /^[0-9]+$/ ? tokens[2].to_i : nil
+      else
+        today.year
+      end
 
-      return nil unless month
+      return nil unless day && month && year
 
       result = Date.new(year, month, day)
       result -= 1.year if result > Date.today
@@ -37,16 +59,7 @@ class Kronic
     nil
   end
 
-  def self.month_from_name(month)
-    months = (1..12).map {|x|
-      Date.new(2010, x, 1)
-    }.inject({}) {|a, x|
-      a.update(x.strftime("%B").downcase => x.month)
-    }
-    
-    months[month] || months.detect {|name, number| name.starts_with?(month) }.last
-  end
-
+  # Converts a date to a human readable string.
   def self.format(date, opts = {})
     case ((opts[:today] || Date.today).to_date - date.to_date).to_i
       when 0      then "Today"

data/spec/kronic_spec.rb

@@ -17,7 +17,8 @@ describe Kronic do
     {
       :today  => Date.new(2010, 9, 19),
       :monday => Date.new(2010, 9, 13),
-      :sep_4  => Date.new(2010, 9, 4)
+      :sep_4  => Date.new(2010, 9, 4),
+      :sep_20 => Date.new(2009, 9, 20)
     }.fetch(key)
   end
 
@@ -26,13 +27,20 @@ describe Kronic do
   end
 
   should_parse('Today',       date(:today))
+  should_parse(:today,        date(:today))
   should_parse('today',       date(:today))
+  should_parse('  Today',     date(:today))
   should_parse('Yesterday',   date(:today) - 1.day)
   should_parse('Last Monday', date(:monday))
   should_parse('4 Sep',       date(:sep_4))
+  should_parse('4  Sep',      date(:sep_4))
   should_parse('4 September', date(:sep_4))
+  should_parse('20 Sep',      date(:sep_20))
   should_parse('14 Sep 2008', Date.new(2008, 9, 14))
   should_parse('bogus',       nil)
+  should_parse('14',          nil)
+  should_parse('14 bogus in', nil)
+  should_parse('14 September oen', nil)
 
   should_format('Today',       date(:today))
   should_format('Yesterday',   date(:today) - 1.day)

metadata

@@ -5,7 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  version: "0.1"
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Xavier Shay
@@ -44,6 +45,7 @@ files:
 - lib/kronic.rb
 - README.rdoc
 - HISTORY
+- Rakefile
 has_rdoc: true
 homepage: http://github.com/xaviershay/kronic
 licenses: []