kronic 0.4.1 → 1.0.0

data/Gemfile

@@ -1,3 +1,7 @@
 source :rubygems
 
 gemspec
+
+platforms(:ruby) do
+  gem 'therubyracer', '>= 0.8.0.pre2'
+end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    kronic (0.4)
+    kronic (0.4.1)
 
 GEM
   remote: http://rubygems.org/
@@ -18,6 +18,7 @@ GEM
     rspec-mocks (2.0.0.beta.22)
       rspec-core (= 2.0.0.beta.22)
       rspec-expectations (= 2.0.0.beta.22)
+    therubyracer (0.8.0.pre2)
     timecop (0.3.5)
     tzinfo (0.3.23)
 
@@ -29,5 +30,6 @@ DEPENDENCIES
   activesupport
   kronic!
   rspec (>= 2.0.0.beta.16)
+  therubyracer (>= 0.8.0.pre2)
   timecop
   tzinfo

data/HISTORY

@@ -1,23 +1,27 @@
-0.4.1
+1.0.0 - 27 October 2010
+  * Added javascript implementation
+  * Committed to backwards compatibility for current API until v2
+
+0.4.1 - 22 October 2010
   * Fixed parsing of "January 1999" (returns nil, rather than raising an exception)
-  * Support optional commas in delimeters: "Sep 14, 2010"
+  * Support optional commas in delimiters: "Sep 14, 2010"
 
-0.4.0
+0.4.0 - 30 September 2010
   * Support ISO 8601 dates ("2010-09-30")
   * Kronic.format supports Time and DateTime as a parameter
   * Ironclad guarantee it works on 1.8.7, 1.9.2, Rubinius, and JRuby
 
-0.3.0
+0.3.0 - 27 September 2010
   * 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
+0.2.1 - 20 September 2010
   * Removed dependency on active_support, no external dependencies!
   * Dates in the future with a year specified are parsed correctly
 
-0.2.0
+0.2.0 - 20 September 2010
   * Support "tomorrow"
   * Support "this monday"
 

data/README.rdoc

@@ -1,17 +1,11 @@
 = 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 about 150 lines of code with no dependencies.
+A dirt simple library for parsing human readable dates (Today, Yesterday, Last Monday). Both a ruby and a javascript implementation are included.
 
 == Usage
 
+=== Ruby
+
   gem install kronic
 
   require 'kronic'
@@ -20,12 +14,49 @@ Oh yeah, Kronic is about 150 lines of code with no dependencies.
 
 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 (that's what my app needs, so that's what it does).
 
+=== Javascript
+
+Install by grabbing the latest versions direct from github:
+
+  curl http://github.com/xaviershay/kronic/raw/master/lib/js/strftime.js > public/javascripts/strftime.js
+  curl http://github.com/xaviershay/kronic/raw/master/lib/js/kronic.js   > public/javascripts/kronic.js
+
+Use with the following script:
+
+  <script src="/javascripts/strftime.js" type="text/javascript"></script> 
+  <script src="/javascripts/kronic.js"   type="text/javascript"></script>
+  <script>
+    Kronic.parse("Today");
+    Kronic.format(new Date());
+  </script>
+
+== 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 about 150 lines of ruby code with no dependencies, and provides a javascript implementation.
+
 == Compatibility
 
 Kronic does not require ActiveSupport, but if it is present Kronic will use the current time zone. In short, everything should work as you would expect.
 
-Kronic is tested on 1.8.7, 1.9.2, Rubinius, and JRuby.
+Kronic is tested on 1.8.7, 1.9.2, Rubinius 1.1, and JRuby 1.5.1.
+
+== Developing
+
+  git clone git://github.com/xaviershay/kronic.git
+  bundle install # May take a while, needs to install therubyracer/V8 to test JS
+  rake
+  open spec/kronic_spec.rb
+
+There are comments to help you along but it is pretty basic code, so everything should make sense pretty quickly. The javascript code is a direct translation of the ruby code, and as such it is undocumented - just refer back to the ruby code. strftime.js is an external library bundled here for convenience. Do not change it.
+
+The exact same set of specs are run again the ruby and javascript libraries, so they should be 100% compatible.
+
+Patches welcome! Fork and send a pull request. Please follow coding conventions already in use. If +jsl+ (JSLint) is in your path, rake will run it over the javascript implementation. There are currently no warnings, please keep it that way.
 
-== Future
+== Status
 
-Current release is a release candidate for 1.0, when the API will be declared stable. i18n work has been started in a branch, and also in yolk's fork. I'm not using this personally. Maybe also a flag to toggle the interpretation of dates without years would be nice. Neither of those things will be in 1.0 I don't reckon.
+Current release is stable, and being used in production sites. Some I18n work is in yolk's fork, but it is lagging behind the current release. I am not using this personally. Maybe also a flag to toggle the interpretation of dates without years would be nice, but not something I need.

data/Rakefile

@@ -4,5 +4,8 @@ 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")
+  commands = []
+  commands << "bundle exec rspec spec/*_spec.rb"
+  commands << "jsl -nologo -process lib/js/kronic.js" if `which jsl`.length > 0
+  exec commands.join(" && ")
 end

data/lib/kronic.rb

@@ -23,8 +23,9 @@ class Kronic
   end
 
   # 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.
+  # available and set (it is added by active_support and rails by default),
+  # 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
@@ -48,7 +49,7 @@ class Kronic
 
     DELIMITER           = /[,\s]+/
     NUMBER              = /^[0-9]+$/
-    NUMBER_WITH_ORDINAL = /^[0-9]+(st|nd|rd|th)?$/
+    NUMBER_WITH_ORDINAL = /^([0-9]+)(st|nd|rd|th)?$/
     ISO_8601_DATE       = /^([0-9]{4})-?(1[0-2]|0?[1-9])-?(3[0-1]|[1-2][0-9]|0?[1-9])$/
 
     MONTH_NAMES = Date::MONTHNAMES.zip(Date::ABBR_MONTHNAMES).flatten.compact.map {|x| 

data/spec/kronic_spec.rb

@@ -1,18 +1,37 @@
 require 'spec_helper'
 
 describe Kronic do
-  def self.should_parse(string, date)
-    it "should parse '#{string}'" do
-      Kronic.parse(string).should == date
+  extend KronicMatchers
+
+  if js_supported?
+    # JRuby cannot currently run the specs against the JS implementation
+    before :all do
+      reset_timezone
+
+      @js = V8::Context.new
+      @js['alert'] = proc {|s| puts s.inspect } # For debugging, not used normally
+      %w(strftime kronic).each do |file|
+        @js.eval(File.open(File.dirname(__FILE__) + "/../lib/js/#{file}.js").read)
+      end
+      @js.eval("Kronic")['today'] = proc { date(:today).to_time }
     end
   end
 
-  def self.should_format(string, date)
-    it "should format '#{string}'" do
-      Kronic.format(date).should == string
-    end
+  before :each do
+    reset_timezone
+    Timecop.freeze(Time.utc(
+      date(:today).year,
+      date(:today).month,
+      date(:today).day
+    ))
   end
 
+  after :each do
+    Timecop.return
+  end
+
+  # A constant set of dates are used for testing, the current system time is frozen
+  # to date(:today) for the duration of each test.
   def self.date(key)
     {
       :today       => Date.new(2010, 9, 18),
@@ -25,53 +44,44 @@ describe Kronic do
   end
   def date(key); self.class.date(key); end;
 
-  before :each do
-    Time.zone = nil
-    ENV['TZ'] = "Australia/Melbourne"
-    d = date(:today)
-    Timecop.freeze(Time.utc(d.year, d.month, d.day))
-  end
-
-  after :each do
-    Timecop.return
-  end
+  # it_should_parse and it_should_format macros are defined in spec/spec_helper.rb
+  it_should_parse('Today',              date(:today))
+  it_should_parse(:today,               date(:today))
+  it_should_parse('today',              date(:today))
+  it_should_parse('  Today',            date(:today))
+  it_should_parse('Yesterday',          date(:today) - 1)
+  it_should_parse('Tomorrow',           date(:today) + 1)
+  it_should_parse('Last Monday',        date(:last_monday))
+  it_should_parse('This Monday',        date(:next_monday))
+  it_should_parse('4 Sep',              date(:sep_4))
+  it_should_parse('4  Sep',             date(:sep_4))
+  it_should_parse('4 September',        date(:sep_4))
+  it_should_parse('20 Sep',             date(:sep_20))
+  it_should_parse('28 Sep 2010',        date(:sep_28))
+  it_should_parse('14 Sep 2008',        Date.new(2008, 9, 14))
+  it_should_parse('14th Sep 2008',      Date.new(2008, 9, 14))
+  it_should_parse('23rd Sep 2008',      Date.new(2008, 9, 23))
+  it_should_parse('September 14 2008',  Date.new(2008, 9, 14))
+  it_should_parse('Sep 14, 2008',       Date.new(2008, 9, 14))
+  it_should_parse('14 Sep, 2008',       Date.new(2008, 9, 14))
+  it_should_parse('Sep 4th',            date(:sep_4))
+  it_should_parse('September 4',        date(:sep_4))
+  it_should_parse('2008-09-04',         Date.new(2008, 9, 4))
+  it_should_parse('2008-9-4',           Date.new(2008, 9, 4))
+  it_should_parse('bogus',              nil)
+  it_should_parse('14',                 nil)
+  it_should_parse('14 bogus in',        nil)
+  it_should_parse('14 June oen',        nil)
+  it_should_parse('January 1999',       nil)
+  it_should_parse('Last M',             nil)
 
-  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)
-  should_parse('Tomorrow',           date(:today) + 1)
-  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))
-  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('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 14, 2008',       Date.new(2008, 9, 14))
-  should_parse('14 Sep, 2008',       Date.new(2008, 9, 14))
-  should_parse('Sep 4th',            date(:sep_4))
-  should_parse('September 4',        date(:sep_4))
-  should_parse('2008-09-04',         Date.new(2008, 9, 4))
-  should_parse('2008-9-4',           Date.new(2008, 9, 4))
-  should_parse('bogus',              nil)
-  should_parse('14',                 nil)
-  should_parse('14 bogus in',        nil)
-  should_parse('14 June oen',        nil)
-  should_parse('January 1999',       nil)
-
-  should_format('Today',             date(:today))
-  should_format('Yesterday',         date(:today) - 1)
-  should_format('Tomorrow',          date(:today) + 1)
-  should_format('Last Monday',       date(:last_monday))
-  should_format('This Monday',       date(:next_monday))
-  should_format('14 September 2008', Date.new(2008, 9, 14))
-  should_format('14 September 2008', Time.utc(2008, 9, 14))
+  it_should_format('Today',             date(:today))
+  it_should_format('Yesterday',         date(:today) - 1)
+  it_should_format('Tomorrow',          date(:today) + 1)
+  it_should_format('Last Monday',       date(:last_monday))
+  it_should_format('This Monday',       date(:next_monday))
+  it_should_format('14 September 2008', Date.new(2008, 9, 14))
+  it_should_format('14 September 2008', Time.utc(2008, 9, 14))
 
   describe 'timezone support' do
     before :all do
@@ -97,4 +107,9 @@ describe Kronic do
       Kronic.format(date(:today)).should == "Today"
     end
   end
+
+  def reset_timezone
+    Time.zone = nil
+    ENV['TZ'] = "Australia/Melbourne"
+  end
 end

data/spec/spec_helper.rb

@@ -2,6 +2,16 @@ require 'rspec'
 require 'timecop'
 require 'active_support/core_ext/integer/time'
 require 'active_support/core_ext/time/zones'
+require 'active_support/core_ext/time/calculations'
+require 'active_support/core_ext/date/conversions' # For nicer spec fail output
+
+$js_loaded = begin
+  require 'v8'
+  true
+rescue LoadError => e
+  # Can't run JS specs
+  false
+end
 
 $LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
 require 'kronic'
@@ -21,3 +31,40 @@ module MethodVisibility
     end
   end
 end
+
+module KronicMatchers
+  def it_should_parse(string, date)
+    it "should parse '#{string}'" do
+      Kronic.parse(string).should == date
+    end
+
+    if js_supported?
+      it "should parse '#{string}' (JS)" do
+        x = @js.evaluate("Kronic").parse(string)
+
+        if x.is_a?(Time)
+          x = x.to_date
+          Date.new(x.year, x.month, x.day).should == date
+        else
+          x.should == date
+        end
+      end
+    end
+  end
+
+  def it_should_format(string, date)
+    it "should format '#{string}'" do
+      Kronic.format(date).should == string
+    end
+
+    if js_supported?
+      it "should format '#{string}' (JS)" do
+        @js.evaluate("Kronic").format(date.to_time).should == string
+      end
+    end
+  end
+end
+
+def js_supported?
+  $js_loaded
+end

metadata

@@ -3,10 +3,10 @@ name: kronic
 version: !ruby/object:Gem::Version 
   prerelease: false
   segments: 
-  - 0
-  - 4
   - 1
-  version: 0.4.1
+  - 0
+  - 0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Xavier Shay
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-22 00:00:00 +10:30
+date: 2010-10-27 00:00:00 +11:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency