timeliness 0.3.2 → 0.3.3

data/CHANGELOG.rdoc

@@ -1,3 +1,7 @@
+= 0.3.3 - 2011-01-02
+* Add String core extension for to_time, to_date and to_datetime methods, like ActiveSupport
+* Allow arbitrary format string as :format option and it will be compiled, if not found.
+
 = 0.3.2 - 2010-11-26
 * Catch all errors for ActiveSupport not being loaded for more helpful error
 

data/README.rdoc

@@ -130,6 +130,17 @@ The last two value are the microseconds, and zone abbreviation or offset.
 Note: The format for this value is not defined. You can add it yourself, easily.
 
 
+=== ActiveSupport Core Extensions
+
+To make it easier to use the parser in Rails or an app using ActiveSupport, you can add/override the methods
+for <tt>to_time</tt>, <tt>to_date</tt> and <tt>to_datetime</tt> on a string value. These methods will then use
+the Timeliness parser for converting a string, instead of the default.
+
+You just need to add this line to an initializer or other application file:
+
+  require 'timeliness/core_ext'
+
+
 == Formats
 
 The gem has default formats included which can be easily added to using the format syntax. Also 

data/Rakefile

@@ -1,6 +1,5 @@
 require 'rubygems'
 require 'rake/rdoctask'
-require 'rubygems/specification'
 require 'rspec/core/rake_task'
 
 GEM_NAME = "timeliness"

data/benchmark.rb

@@ -2,18 +2,18 @@ $:.unshift(File.expand_path('lib'))
 
 require 'benchmark'
 require 'time'
-require 'parsedate'
+require 'parsedate' unless RUBY_VERSION =~ /^1\.9\./
 require 'timeliness'
 
 if defined?(JRUBY_VERSION)
   # Warm up JRuby
-  20000.times do
+  20_000.times do
     Time.parse("2000-01-04 12:12:12")
     Timeliness::Parser.parse("2000-01-04 12:12:12", :datetime)
   end
 end
 
-n = 10000
+n = 10_000
 Benchmark.bm do |x|
   x.report('timeliness - datetime') {
     n.times do
@@ -102,8 +102,7 @@ Benchmark.bm do |x|
   x.report('ISO regexp for datetime') {
     n.times do
       "2000-01-04 12:12:12" =~ /\A(\d{4})-(\d{2})-(\d{2}) (\d{2})[\. :](\d{2})([\. :](\d{2}))?\Z/
-      microsec = ($7.to_f * 1_000_000).to_i
-      Time.mktime($1.to_i, $2.to_i, $3.to_i, $3.to_i, $5.to_i, $6.to_i, microsec)
+      Time.mktime($1.to_i, $2.to_i, $3.to_i, $3.to_i, $5.to_i, $6.to_i)
     end
   }
 
@@ -133,19 +132,21 @@ Benchmark.bm do |x|
     end
   }
 
-  x.report('parsedate - valid') {
-    n.times do
-      arr = ParseDate.parsedate("2000-01-04 12:12:12")
-      Date.new(*arr[0..2])
-      Time.mktime(*arr)
-    end
-  }
+  if defined?(ParseDate)
+    x.report('parsedate - valid') {
+      n.times do
+        arr = ParseDate.parsedate("2000-01-04 12:12:12")
+        Date.new(*arr[0..2])
+        Time.mktime(*arr)
+      end
+    }
 
-  x.report('parsedate - invalid ') {
-    n.times do
-      arr = ParseDate.parsedate("2000-00-04 12:12:12")
-    end
-  }
+    x.report('parsedate - invalid ') {
+      n.times do
+        arr = ParseDate.parsedate("2000-00-04 12:12:12")
+      end
+    }
+  end
 
   x.report('strptime - valid') {
     n.times do

data/lib/timeliness/core_ext.rb

@@ -0,0 +1,6 @@
+require 'timeliness/core_ext/string'
+
+module Timeliness
+  module CoreExt
+  end
+end

data/lib/timeliness/core_ext/string.rb

@@ -0,0 +1,22 @@
+class String
+
+  # Form can be either :utc (default) or :local.
+  def to_time(form = :utc)
+    return nil if self.blank?
+    Timeliness::Parser.parse(self, :datetime, :zone => form)
+  end
+
+  def to_date
+    return nil if self.blank?
+    values = Timeliness::Parser._parse(self, :date).map { |arg| arg || 0 }
+    ::Date.new(*values[0..2])
+  end
+
+  def to_datetime
+    return nil if self.blank?
+    values = Timeliness::Parser._parse(self, :datetime).map { |arg| arg || 0 }
+    values[7] = values[7]/24.hours.to_f if values[7] != 0
+    values[5] += Rational(values.delete_at(6), 1000000)
+    ::DateTime.civil(*values)
+  end
+end

data/lib/timeliness/definitions.rb

@@ -76,14 +76,16 @@ module Timeliness
       'ddd, dd mmm yyyy hh:nn:ss zo', # RFC 822
       'ddd mmm d hh:nn:ss zo yyyy', # Ruby time string
       'yyyy-mm-ddThh:nn:ssZ', # ISO 8601 without zone offset
-      'yyyy-mm-ddThh:nn:sszo' # ISO 8601 with zone offset
+      'yyyy-mm-ddThh:nn:sszo', # ISO 8601 with zone offset
+      'yyyy-mm-ddThh:nn:ss.u', # ISO 8601 with usec
+      'yyyy-mm-ddThh:nn:ss.uzo' # ISO 8601 with usec and offset
     ]
 
     # All tokens available for format construction. The token array is made of
     # regexp and key for format component mapping, if any.
     #
     @format_tokens = {
-      'ddd'  => [ '\w{3,9}' ],
+      'ddd'  => [ '\w{3,9}', :wday ],
       'dd'   => [ '\d{2}',   :day ],
       'd'    => [ '\d{1,2}', :day ],
       'mmm'  => [ '\w{3,9}', :month ],

data/lib/timeliness/format.rb

@@ -38,8 +38,8 @@ module Timeliness
       @regexp_string = format
       @regexp = Regexp.new("^(#{format})$")
       self
-    rescue
-      raise "The format '#{format_string}' failed to compile using regexp string #{format}."
+    rescue => ex
+      raise "The format '#{format_string}' failed to compile using regexp string #{format}. Error: #{ex.inspect}"
     end
 
     # Redefined on compile

data/lib/timeliness/format_set.rb

@@ -28,7 +28,7 @@ module Timeliness
     end
 
     def match(string, format_string=nil)
-      format = @formats_hash[format_string] if format_string
+      format = single_format(format_string) if format_string
       match_regexp = format && format.regexp || @regexp
 
       if match_data = match_regexp.match(string)
@@ -40,5 +40,8 @@ module Timeliness
       end
     end
 
+    def single_format(format_string)
+       @formats_hash[format_string] || Format.new(format_string).compile!
+    end
   end
 end

data/lib/timeliness/version.rb

@@ -1,3 +1,3 @@
 module Timeliness
-  VERSION = '0.3.2'
+  VERSION = '0.3.3'
 end

data/spec/spec_helper.rb

@@ -3,6 +3,7 @@ require 'rspec'
 require 'active_support/time'
 require 'timecop'
 require 'timeliness'
+require 'timeliness/core_ext'
 
 module TimelinessHelpers
   def parser

data/spec/timeliness/core_ext/string_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+
+describe Timeliness::CoreExt, 'String' do
+  # Test values taken from ActiveSupport unit tests for compatibility
+
+  describe "#to_time" do
+    it 'should convert valid string to Time object in default zone' do
+      "2005-02-27 23:50".to_time.should == Time.utc(2005, 2, 27, 23, 50)
+    end
+
+    it 'should convert ISO 8601 string to Time object' do
+      "2005-02-27T23:50:19.275038".to_time.should == Time.utc(2005, 2, 27, 23, 50, 19, 275038)
+    end
+
+    context "with :local" do
+      it 'should convert valid string to local time' do
+        "2005-02-27 23:50".to_time(:local).should == Time.local(2005, 2, 27, 23, 50)
+      end
+
+      it 'should convert ISO 8601 string to local time' do
+        "2005-02-27T23:50:19.275038".to_time(:local).should == Time.local(2005, 2, 27, 23, 50, 19, 275038)
+      end
+    end
+
+    it 'should convert valid future string to Time object' do
+      "2039-02-27 23:50".to_time(:local).should == Time.local_time(2039, 2, 27, 23, 50)
+    end
+
+    it 'should convert valid future string to Time object' do
+      "2039-02-27 23:50".to_time.should == DateTime.civil(2039, 2, 27, 23, 50)
+    end
+
+    it 'should convert empty string to nil' do
+      ''.to_time.should be_nil
+    end
+  end
+
+  describe "#to_datetime" do
+    it 'should convert valid string to DateTime object' do
+      "2039-02-27 23:50".to_datetime.should == DateTime.civil(2039, 2, 27, 23, 50)
+    end
+
+    it 'should convert to DateTime object with UTC offset' do
+      "2039-02-27 23:50".to_datetime.offset.should == 0
+    end
+
+    it 'should convert ISO 8601 string to DateTime object' do
+      datetime = DateTime.civil(2039, 2, 27, 23, 50, 19 + Rational(275038, 1000000), "-04:00")
+      "2039-02-27T23:50:19.275038-04:00".to_datetime.should == datetime
+    end
+
+    it 'should use Rubys default start value' do
+      # Taken from ActiveSupport unit tests. Not sure on the implication.
+      "2039-02-27 23:50".to_datetime.start.should == ::Date::ITALY
+    end
+
+    it 'should convert empty string to nil' do
+      ''.to_datetime.should be_nil
+    end
+  end
+
+  describe "#to_date" do
+    it 'should convert string to Date object' do
+      "2005-02-27".to_date.should == Date.new(2005, 2, 27)
+    end
+
+    it 'should convert empty string to nil' do
+      ''.to_date.should be_nil
+    end
+  end
+
+end

data/spec/timeliness/format_set_spec.rb

@@ -88,6 +88,11 @@ describe Timeliness::FormatSet do
       set.match('2000-01-02', 'yyyy-mm-dd').should be_kind_of(Array)
       set.match('2000-01-02', 'dd/mm/yyyy').should be_nil
     end
+
+    it 'should compile unknown format for one off match' do
+      set.match('20001011').should be_nil
+      set.match('20001011', 'yyyymmdd').should be_kind_of(Array)
+    end
   end
 
   def compile_regexp(format)

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: timeliness
 version: !ruby/object:Gem::Version 
-  hash: 23
   prerelease: false
   segments: 
   - 0
   - 3
-  - 2
-  version: 0.3.2
+  - 3
+  version: 0.3.3
 platform: ruby
 authors: 
 - Adam Meehan
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-28 00:00:00 +11:00
+date: 2011-01-02 00:00:00 +11:00
 default_executable: 
 dependencies: []
 
@@ -37,6 +36,8 @@ files:
 - Rakefile
 - benchmark.rb
 - lib/timeliness.rb
+- lib/timeliness/core_ext.rb
+- lib/timeliness/core_ext/string.rb
 - lib/timeliness/definitions.rb
 - lib/timeliness/format.rb
 - lib/timeliness/format_set.rb
@@ -44,6 +45,7 @@ files:
 - lib/timeliness/parser.rb
 - lib/timeliness/version.rb
 - spec/spec_helper.rb
+- spec/timeliness/core_ext/string_spec.rb
 - spec/timeliness/definitions_spec.rb
 - spec/timeliness/format_set_spec.rb
 - spec/timeliness/format_spec.rb
@@ -63,7 +65,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -72,7 +73,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -85,6 +85,7 @@ specification_version: 3
 summary: Date/time parsing for the control freak.
 test_files: 
 - spec/spec_helper.rb
+- spec/timeliness/core_ext/string_spec.rb
 - spec/timeliness/definitions_spec.rb
 - spec/timeliness/format_set_spec.rb
 - spec/timeliness/format_spec.rb