kronic 0.2.1 → 0.3

data/HISTORY

@@ -1,3 +1,9 @@
+0.3.0
+  * Support month before day ("June 14")
+  * Support day ordinals ("14th June")
+  * Use Time.zone if available
+  * Fix Kronic.format for ruby 1.8
+
 0.2.1
   * Removed dependency on active_support, no external dependencies!
   * Dates in the future with a year specified are parsed correctly

data/README.rdoc

@@ -8,7 +8,7 @@ Chronic and Tickle both parse a *heap* of formats. That's not useful to me when
 
 In addition, Kronic can take a date and give you a human readable form, neither of which Chronic nor Tickle does.
 
-Oh yeah, Kronic is less than 100 lines of code.
+Oh yeah, Kronic is about 100 lines of code.
 
 == Usage
 

data/lib/kronic.rb

@@ -2,25 +2,28 @@ require 'date'
 
 class Kronic
   # Public: Converts a human readable day (Today, yesterday) to a Date.
+  # If Time.zone is available and set (added by active_support and rails),
+  # Time.zone.today will be used as a reference point, otherwise Date.today
+  # will be used.
   #
-  # Will call #to_s on the input, so can process Symbols or whatever other
-  # object you wish to throw at it.
-  #
-  # string - The String to convert to a Date. Supported formats are: Today,
-  #          yesterday, tomorrow, last thursday, this thursday, 14 Sep,
-  #          14 June 2010. Parsing is case-insensitive.
+  # string - The String to convert to a Date. #to_s is called on the parameter.
+  #          Supported formats are: Today, yesterday, tomorrow, last thursday,
+  #          this thursday, 14 Sep, Sep 14, 14 June 2010. Parsing is 
+  #          case-insensitive.
   #
   # Returns the Date, or nil if the input could not be parsed.
   def self.parse(string)
     string = string.to_s.downcase.strip
-    today  = Date.today
+    now = today
 
-    parse_nearby_days(string, today) ||
-      parse_last_or_this_day(string, today) ||
-      parse_exact_date(string, today)
+    parse_nearby_days(string, now) ||
+      parse_last_or_this_day(string, now) ||
+      parse_exact_date(string, now)
   end
 
-  # Public: Converts a date to a human readable string.
+  # Public: Converts a date to a human readable string. If Time.zone is
+  # available and set (added by active_support and rails), Time.zone.today
+  # will be used as a reference point, otherwise Date.today will be used.
   #
   # date - The Date to be converted
   # opts - The Hash options used to customize formatting
@@ -29,7 +32,7 @@ class Kronic
   # Returns a relative string ("Today", "This Monday") if available, otherwise
   # the full representation of the date ("19 September 2010").
   def self.format(date, opts = {})
-    case (date.to_date - (opts[:today] || Date.today)).to_i
+    case (date - (opts[:today] || today)).to_i
       when (2..7)   then "This " + date.strftime("%A")
       when 1        then "Tomorrow"
       when 0        then "Today"
@@ -42,6 +45,17 @@ class Kronic
   class << self
     private
 
+    NUMBER              = /^[0-9]+$/
+    NUMBER_WITH_ORDINAL = /^[0-9]+(st|nd|rd|th)?$/
+
+    def today
+      if Time.respond_to?(:zone) && Time.zone
+        Time.zone.today
+      else
+        Date.today
+      end
+    end
+
     # Examples
     #
     #   month_from_name("january") # => 1
@@ -75,25 +89,34 @@ class Kronic
       end
     end
 
-    # Parse "14 Sep, 14 September, 14 September 2010"
+    # Parse "14 Sep", "14 September", "14 September 2010", "Sept 14 2010"
     def parse_exact_date(string, today)
       tokens = string.split(/\s+/)
 
-      if tokens[0] =~ /^[0-9]+$/ && tokens[1]
-        day   = tokens[0].to_i
-        month = month_from_name(tokens[1])
-        year  = if tokens[2]
-          tokens[2] =~ /^[0-9]+$/ ? tokens[2].to_i : nil
-        else
-          today.year
+      if tokens.length >= 2
+        if    tokens[0] =~ NUMBER_WITH_ORDINAL
+          parse_exact_date_parts(tokens[0], tokens[1], tokens[2], today)
+        elsif tokens[1] =~ NUMBER_WITH_ORDINAL
+          parse_exact_date_parts(tokens[1], tokens[0], tokens[2], today)
         end
+      end
+    end
+    
+    # Parses day, month and year parts
+    def parse_exact_date_parts(raw_day, raw_month, raw_year, today)
+      day   = raw_day.to_i
+      month = month_from_name(raw_month)
+      year = if raw_year
+        raw_year =~ NUMBER ? raw_year.to_i : nil
+      else
+        today.year
+      end
 
-        return nil unless day && month && year
+      return nil unless day && month && year
 
-        result = Date.new(year, month, day)
-        result = result << 12 if result > today && !tokens[2]
-        result
-      end
+      result = Date.new(year, month, day)
+      result = result << 12 if result > today && !raw_year
+      result
     end
   end
 end

data/spec/kronic_spec.rb

@@ -18,14 +18,18 @@ describe Kronic do
       :today       => Date.new(2010, 9, 18),
       :last_monday => Date.new(2010, 9, 13),
       :next_monday => Date.new(2010, 9, 20),
-      :sep_4  => Date.new(2010, 9, 4),
-      :sep_20 => Date.new(2009, 9, 20),
-      :sep_28 => Date.new(2010, 9, 28)
+      :sep_4       => Date.new(2010, 9, 4),
+      :sep_20      => Date.new(2009, 9, 20),
+      :sep_28      => Date.new(2010, 9, 28)
     }.fetch(key)
   end
+  def date(key); self.class.date(key); end;
 
-  before :all do
-    Timecop.freeze(self.class.date(:today))
+  before :each do 
+    Time.zone = nil
+    ENV['TZ'] = "Australia/Melbourne"
+    d = date(:today)
+    Timecop.freeze(Time.utc(d.year, d.month, d.day))
   end
 
   should_parse('Today',       date(:today))
@@ -41,7 +45,12 @@ describe Kronic do
   should_parse('4 September', date(:sep_4))
   should_parse('20 Sep',      date(:sep_20))
   should_parse('28 Sep 2010', date(:sep_28))
-  should_parse('14 Sep 2008', Date.new(2008, 9, 14))
+  should_parse('14 Sep 2008',       Date.new(2008, 9, 14))
+  should_parse('14th Sep 2008',     Date.new(2008, 9, 14))
+  should_parse('23rd Sep 2008',     Date.new(2008, 9, 23))
+  should_parse('September 14 2008', Date.new(2008, 9, 14))
+  should_parse('Sep 4th',     date(:sep_4))
+  should_parse('September 4', date(:sep_4))
   should_parse('bogus',       nil)
   should_parse('14',          nil)
   should_parse('14 bogus in', nil)
@@ -53,4 +62,30 @@ describe Kronic do
   should_format('Last Monday', date(:last_monday))
   should_format('This Monday', date(:next_monday))
   should_format('14 September 2008', Date.new(2008, 9, 14))
+
+  describe 'timezone support' do
+    before :all do
+      Time.extend(MethodVisibility)
+    end
+
+    it 'should be timezone aware if activesupport Time.zone is set' do
+      Time.zone = "US/Eastern"
+      Kronic.parse("today").should == date(:today) - 1
+      Kronic.format(date(:today) - 1).should == "Today"
+    end
+
+    it 'should fallback to Date.today if Time.zone is not available' do
+      Time.hide_class_method(:zone) do
+        Kronic.parse("today").should == date(:today)
+        Kronic.format(date(:today)).should == "Today"
+      end
+    end
+
+    it 'should fallback to Date.today if Time.zone is not set' do
+      Time.zone = nil
+      Kronic.parse("today").should == date(:today)
+      Kronic.format(date(:today)).should == "Today"
+    end
+  end
+
 end

data/spec/spec_helper.rb

@@ -1,5 +1,22 @@
 require 'rspec'
 require 'timecop'
+require 'active_support/core_ext'
 
 $LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
 require 'kronic'
+
+module MethodVisibility
+  # Used to toggle whether Time.zone is available, for testing with and
+  # without activesupport.
+  def hide_class_method(method)
+    metaclass = (class << self; self; end)
+    metaclass.send :alias_method, :old_method, method
+    metaclass.send :remove_method, method
+    begin
+      yield
+    ensure
+      metaclass.send :alias_method, method, :old_method
+      metaclass.send :remove_method, :old_method
+    end
+  end
+end

metadata

@@ -4,9 +4,8 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
-  - 1
-  version: 0.2.1
+  - 3
+  version: "0.3"
 platform: ruby
 authors: 
 - Xavier Shay
@@ -14,7 +13,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-20 00:00:00 +01:00
+date: 2010-09-27 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -47,6 +46,32 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: tzinfo
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
 description: 
 email: 
 - hello@xaviershay.com
@@ -63,7 +88,7 @@ files:
 - README.rdoc
 - HISTORY
 - Rakefile
-has_rdoc: true
+has_rdoc: false
 homepage: http://github.com/xaviershay/kronic
 licenses: []