kronic 0.1.1 → 0.2.0

data/HISTORY

@@ -1,3 +1,7 @@
+0.2.0
+  * Support "tomorrow"
+  * Support "this monday"
+
 0.1.1 - 19 September 2010
   * Kronic.parse will explode in fewer scenarios!
 

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 60 lines of code.
+Oh yeah, Kronic is less than 100 lines of code.
 
 == Usage
 
@@ -18,8 +18,8 @@ Oh yeah, Kronic is less than 60 lines of code.
   Kronic.parse("Today")     # => Date.today
   Kronic.format(Date.today) # => "Today"
 
-Supported formats: Today, yesterday, last thursday, 14 Sep, 14 June 2010
+Supported formats: Today, yesterday, tomorrow, last thursday, this thursday, 14 Sep, 14 June 2010. Any dates without a year are assumed to be in the past.
 
 == Future
 
-I only need date selection in the past for my application, so Kronic only does that so far. I'm not opposed to support "next monday", patches welcome. Kronic will be totally timezone aware. It may or may not be now, I haven't specced it.
+Kronic will be totally timezone aware. It may or may not be now, I haven't specced it. Maybe a flag to toggle interpretation of dates without years.

data/lib/kronic.rb

@@ -1,71 +1,99 @@
 require 'active_support/core_ext'
-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.
+  # Public: Converts a human readable day (Today, yesterday) to a Date.
   #
   # 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.
+  #
+  # Returns the Date, or nil if the input could not be parsed.
   def self.parse(string)
-    # 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'
-    return Date.yesterday if string == 'yesterday'
+    parse_nearby_days(string, today) ||
+      parse_last_or_this_day(string, today) ||
+      parse_exact_date(string, today)
+  end
+
+  # Public: Converts a date to a human readable string.
+  #
+  # date - The Date to be converted
+  # opts - The Hash options used to customize formatting
+  #        :today - The reference point for calculations (default: Date.today)
+  #
+  # 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
+      when (2..7)   then "This " + date.strftime("%A")
+      when 1        then "Tomorrow"
+      when 0        then "Today"
+      when -1       then "Yesterday"
+      when (-7..-2) then "Last " + date.strftime("%A")
+      else              date.strftime("%e %B %Y").strip
+    end
+  end
 
-    tokens = string.split(/\s+/)
+  class << self
+    private
 
-    # Last X
-    if tokens[0] == 'last'
-      days = (1..7).map {|x| 
-        (Date.today - x.days) 
-      }.inject({}) {|a, x| 
-        a.update(x.strftime("%A").downcase => x) 
-      }
-      return days[tokens[1]]
+    # Examples
+    #
+    #   month_from_name("January") # => 1
+    #   month_from_name("Jan")     # => 1
+    def month_from_name(month)
+      return nil unless month
+
+      human_month = month.downcase.humanize
+      Date::MONTHNAMES.index(human_month) || Date::ABBR_MONTHNAMES.index(human_month)
     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  = if tokens[2]
-        tokens[2] =~ /^[0-9]+$/ ? tokens[2].to_i : nil
-      else
-        today.year
-      end
+    # Parse "Today", "Tomorrow" and "Yesterday"
+    def parse_nearby_days(string, today)
+      return today         if string == 'today'
+      return today - 1.day if string == 'yesterday'
+      return today + 1.day if string == 'tomorrow'
+    end
 
-      return nil unless day && month && year
+    # Parse "Last Monday", "This Monday"
+    def parse_last_or_this_day(string, today)
+      tokens = string.split(/\s+/)
 
-      result = Date.new(year, month, day)
-      result -= 1.year if result > Date.today
-      return result
+      if %w(last this).include?(tokens[0])
+        days = (1..7).map {|x| 
+          today + (tokens[0] == 'last' ? -x.days : x.days)
+        }.inject({}) {|a, x| 
+          a.update(x.strftime("%A").downcase => x) 
+        }
+
+        days[tokens[1]]
+      end
     end
 
-    nil
-  end
+    # Parse "14 Sep, 14 September, 14 September 2010"
+    def parse_exact_date(string, today)
+      tokens = string.split(/\s+/)
 
-  # 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"
-      when 1      then "Yesterday"
-      when (2..7) then "Last " + date.strftime("%A")
-      else              date.strftime("%e %B %Y").strip
+      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
+        end
+
+        return nil unless day && month && year
+
+        result = Date.new(year, month, day)
+        result -= 1.year if result > today
+        result
+      end
     end
   end
 end

data/spec/kronic_spec.rb

@@ -15,15 +15,16 @@ describe Kronic do
 
   def self.date(key)
     {
-      :today  => Date.new(2010, 9, 19),
-      :monday => Date.new(2010, 9, 13),
+      :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)
     }.fetch(key)
   end
 
   before :all do
-    Timecop.freeze(Date.new(2010, 9, 19))
+    Timecop.freeze(self.class.date(:today))
   end
 
   should_parse('Today',       date(:today))
@@ -31,7 +32,9 @@ describe Kronic do
   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('Tomorrow',    date(:today) + 1.day)
+  should_parse('Last Monday', date(:last_monday))
+  should_parse('This Monday', date(:next_monday))
   should_parse('4 Sep',       date(:sep_4))
   should_parse('4  Sep',      date(:sep_4))
   should_parse('4 September', date(:sep_4))
@@ -40,10 +43,12 @@ describe Kronic do
   should_parse('bogus',       nil)
   should_parse('14',          nil)
   should_parse('14 bogus in', nil)
-  should_parse('14 September oen', nil)
+  should_parse('14 June oen', nil)
 
   should_format('Today',       date(:today))
   should_format('Yesterday',   date(:today) - 1.day)
-  should_format('Last Monday', date(:monday))
+  should_format('Tomorrow',    date(:today) + 1.day)
+  should_format('Last Monday', date(:last_monday))
+  should_format('This Monday', date(:next_monday))
   should_format('14 September 2008', Date.new(2008, 9, 14))
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 1
-  version: 0.1.1
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Xavier Shay
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-19 00:00:00 +01:00
+date: 2010-09-20 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -30,6 +30,49 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: i18n
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
+        - beta
+        - 16
+        version: 2.0.0.beta.16
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: timecop
+  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