kronic 0.1

data/HISTORY

@@ -0,0 +1,2 @@
+0.1 - 19 September 2010
+  * Initial release!

data/README.rdoc

@@ -0,0 +1,24 @@
+= Kronic
+
+A dirt simple library for parsing human readable dates (Today, Yesterday, Last Monday).
+
+== Why not Chronic or Tickle
+
+Chronic and Tickle both parse a *heap* of formats. That's not useful to me when they fail on cases I want (14 Sep), and also not useful because I don't need times or spans. I just want to replace my calendar picker.
+
+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.
+
+== Usage
+
+  gem install kronic
+
+  Kronic.parse("Today")     # => Date.today
+  Kronic.format(Date.today) # => "Today"
+
+See the specs for all the supported formats (there are not many).
+
+== 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.

data/lib/kronic.rb

@@ -0,0 +1,58 @@
+require 'active_support/core_ext'
+require 'active_support/duration'
+require 'active_support/time_with_zone'
+
+class Kronic
+  def self.parse(string)
+    string = string.downcase
+    today  = Date.today
+
+    return Date.today     if string == 'today'
+    return Date.yesterday if string == 'yesterday'
+
+    tokens = string.split(/\s+/)
+
+    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]]
+    end
+
+    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
+
+      return nil unless month
+
+      result = Date.new(year, month, day)
+      result -= 1.year if result > Date.today
+      return result
+    end
+
+    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
+
+  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
+    end
+  end
+end

data/spec/kronic_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe Kronic do
+  def self.should_parse(string, date)
+    it "should parse '#{string}'" do
+      Kronic.parse(string).should == date
+    end
+  end
+
+  def self.should_format(string, date)
+    it "should format '#{string}'" do
+      Kronic.format(date).should == string
+    end
+  end
+
+  def self.date(key)
+    {
+      :today  => Date.new(2010, 9, 19),
+      :monday => Date.new(2010, 9, 13),
+      :sep_4  => Date.new(2010, 9, 4)
+    }.fetch(key)
+  end
+
+  before :all do
+    Timecop.freeze(Date.new(2010, 9, 19))
+  end
+
+  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 September', date(:sep_4))
+  should_parse('14 Sep 2008', Date.new(2008, 9, 14))
+  should_parse('bogus',       nil)
+
+  should_format('Today',       date(:today))
+  should_format('Yesterday',   date(:today) - 1.day)
+  should_format('Last Monday', date(:monday))
+  should_format('14 September 2008', Date.new(2008, 9, 14))
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'rspec'
+require 'timecop'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+require 'kronic'

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: kronic
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  version: "0.1"
+platform: ruby
+authors: 
+- Xavier Shay
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-19 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: 
+email: 
+- hello@xaviershay.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- spec/kronic_spec.rb
+- spec/spec_helper.rb
+- lib/kronic.rb
+- README.rdoc
+- HISTORY
+has_rdoc: true
+homepage: http://github.com/xaviershay/kronic
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A dirt simple library for parsing human readable dates
+test_files: []
+