timeliness 0.3.3 → 0.3.4

data/CHANGELOG.rdoc

@@ -1,3 +1,6 @@
+= 0.3.4 - 2011-05-26
+* Compact time array when creating time in zone so that invalid time handling works properly. Fixes issue#3.
+
 = 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.

data/Rakefile

@@ -1,16 +1,11 @@
-require 'rubygems'
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
 require 'rake/rdoctask'
 require 'rspec/core/rake_task'
 
-GEM_NAME = "timeliness"
-
-desc 'Default: run specs.'
-task :default => :spec
-
 desc "Run specs"
-RSpec::Core::RakeTask.new do |t|
-  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
-end
+RSpec::Core::RakeTask.new(:spec)
 
 desc "Generate code coverage"
 RSpec::Core::RakeTask.new(:coverage) do |t|
@@ -27,7 +22,5 @@ Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-desc "Create a gemspec file"
-task :build do
-  `gem build #{GEM_NAME}.gemspec`
-end
+desc 'Default: run specs.'
+task :default => :spec

data/lib/timeliness/definitions.rb

@@ -85,7 +85,7 @@ module Timeliness
     # regexp and key for format component mapping, if any.
     #
     @format_tokens = {
-      'ddd'  => [ '\w{3,9}', :wday ],
+      'ddd'  => [ '\w{3,9}' ],
       'dd'   => [ '\d{2}',   :day ],
       'd'    => [ '\d{1,2}', :day ],
       'mmm'  => [ '\w{3,9}', :month ],

data/lib/timeliness/format.rb

@@ -1,4 +1,6 @@
 module Timeliness
+  class CompilationError < StandardError; end
+
   class Format
     include Helpers
 
@@ -39,7 +41,7 @@ module Timeliness
       @regexp = Regexp.new("^(#{format})$")
       self
     rescue => ex
-      raise "The format '#{format_string}' failed to compile using regexp string #{format}. Error: #{ex.inspect}"
+      raise CompilationError, "The format '#{format_string}' failed to compile using regexp string #{format}. Error message: #{ex.inspect}"
     end
 
     # Redefined on compile

data/lib/timeliness/helpers.rb

@@ -27,11 +27,11 @@ module Timeliness
     end
 
     def month_names
-      defined?(I18n) ? I18n.t('date.month_names') : Date::MONTHNAMES
+      i18n_loaded? ? I18n.t('date.month_names') : Date::MONTHNAMES
     end
 
     def abbr_month_names
-      defined?(I18n) ? I18n.t('date.abbr_month_names') : Date::ABBR_MONTHNAMES
+      i18n_loaded? ? I18n.t('date.abbr_month_names') : Date::ABBR_MONTHNAMES
     end
 
     def microseconds(usec)
@@ -45,5 +45,9 @@ module Timeliness
       (parts[0] + parts[1]) * sign * 3600
     end
 
+    def i18n_loaded?
+      defined?(I18n)
+    end
+
   end
 end

data/lib/timeliness/parser.rb

@@ -23,11 +23,10 @@ module Timeliness
       def make_time(time_array, zone_option=nil)
         return nil unless fast_date_valid_with_fallback(*time_array[0..2])
 
-        zone_or_offset = time_array.delete_at(7)
-        zone, offset   = zone_and_offset(zone_or_offset) if zone_or_offset
+        zone, offset = zone_and_offset(time_array[7]) if time_array[7]
 
-        value = create_time_in_zone(time_array, zone || zone_option)
-        value = time_in_zone(value, zone_option) if zone
+        value = create_time_in_zone(time_array[0..6].compact, zone || zone_option)
+        value = shift_time_to_zone(value, zone_option) if zone
 
         offset ? value + (value.utc_offset - offset) : value
       rescue ArgumentError, TypeError
@@ -36,8 +35,7 @@ module Timeliness
 
       def _parse(string, type=nil, options={})
         if options[:strict] && type
-          set = Definitions.send("#{type}_format_set")
-          set.match(string, options[:format])
+          Definitions.send("#{type}_format_set").match(string, options[:format])
         else
           values = nil
           Definitions.format_sets(type, string).find {|set| values = set.match(string, options[:format]) }
@@ -96,7 +94,7 @@ module Timeliness
         end
       end
 
-      def time_in_zone(time, zone=nil)
+      def shift_time_to_zone(time, zone=nil)
         zone ||= Timeliness.default_timezone
         case zone
         when :utc, :local
@@ -112,7 +110,7 @@ module Timeliness
         zone ||= Timeliness.default_timezone
         case zone
         when :utc, :local
-          time_with_datetime_fallback(zone, *time_array.compact)
+          time_with_datetime_fallback(zone, *time_array)
         when :current
           Time.zone.local(*time_array)
         else

data/lib/timeliness/version.rb

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

data/spec/spec_helper.rb

@@ -31,7 +31,7 @@ module TimelinessHelpers
   end
 end
 
-Rspec.configure do |c|
+RSpec.configure do |c|
   c.mock_with :rspec
   c.include TimelinessHelpers
 end

data/spec/timeliness/format_spec.rb

@@ -1,7 +1,26 @@
 require 'spec_helper'
 
 describe Timeliness::Format do
-  context "#process" do
+  describe "#compile!" do
+    it 'should compile valid string format' do
+      expect { 
+        Timeliness::Format.new('yyyy-mm-dd hh:nn:ss.u zo').compile!
+      }.should_not raise_error
+    end
+
+    it 'should return self' do
+      format = Timeliness::Format.new('yyyy-mm-dd hh:nn:ss.u zo')
+      format.compile!.should == format
+    end
+
+    it 'should raise compilation error for bad format' do
+      expect { 
+        Timeliness::Format.new('|--[)').compile!
+      }.should raise_error(Timeliness::CompilationError)
+    end
+  end
+
+  describe "#process" do
     it "should define method which outputs date array with values in correct order" do
       format_for('yyyy-mm-dd').process('2000', '1', '2').should == [2000,1,2,nil,nil,nil,nil,nil]
     end
@@ -33,6 +52,45 @@ describe Timeliness::Format do
     it "should define method which outputs datetime array with timezone string" do
       format_for('yyyy-mm-dd hh:nn:ss.u tz').process('2001', '02', '03', '04', '05', '06', '99', 'EST').should == [2001,2,3,4,5,6,990000,'EST']
     end
+
+    context "with long month" do
+      let(:format) { format_for('dd mmm yyyy') }
+
+      context "with I18n loaded" do
+        before(:all) do
+          I18n.locale = :es
+          I18n.backend.store_translations :es, :date => { :month_names => %w{ ~ Enero Febrero Marzo } }
+          I18n.backend.store_translations :es, :date => { :abbr_month_names => %w{ ~ Ene Feb Mar } }
+        end
+
+        it 'should parse abbreviated month for current locale to correct value' do
+          format.process('2', 'Ene', '2000').should == [2000,1,2,nil,nil,nil,nil,nil]
+        end
+
+        it 'should parse full month for current locale to correct value' do
+          format.process('2', 'Enero', '2000').should == [2000,1,2,nil,nil,nil,nil,nil]
+        end
+
+        after(:all) do
+          I18n.locale = :en
+        end
+      end
+
+      context "without I18n loaded" do
+        before do
+          format.stub(:i18n_loaded?).and_return(false)
+          I18n.should_not_receive(:t)
+        end
+
+        it 'should parse abbreviated month to correct value' do
+          format.process('2', 'Jan', '2000').should == [2000,1,2,nil,nil,nil,nil,nil]
+        end
+
+        it 'should parse full month to correct value' do
+          format.process('2', 'January', '2000').should == [2000,1,2,nil,nil,nil,nil,nil]
+        end
+      end
+    end
   end
 
   def format_for(format)

data/spec/timeliness/parser_spec.rb

@@ -6,7 +6,7 @@ describe Timeliness::Parser do
   end
 
   describe "parse" do
-    it "should return time object for valid datetime string" do
+    it "should return Time object for valid datetime string" do
       parse("2000-01-01 12:13:14").should be_kind_of(Time)
     end
 
@@ -88,11 +88,35 @@ describe Timeliness::Parser do
     end
 
     context "string with zone abbreviation" do
-      it 'should return value using string zone in default timezone' do
+      before do
+        Time.zone = 'Melbourne'
+      end
+
+      it 'should return value using string zone adjusted to default :local timezone' do
+        Timeliness.default_timezone = :local
         value = parse("Thu, 01 Jun 2000 03:00:00 MST")
         value.should == Time.local(2000,6,1,20,0,0)
         value.utc_offset.should == 10.hours
       end
+
+      it 'should return value using string zone adjusted to default :current timezone' do
+        Timeliness.default_timezone = :current
+        Time.zone = 'Adelaide'
+        value = parse("Thu, 01 Jun 2000 03:00:00 MST")
+        value.should == Time.zone.local(2000,6,1,19,30,0)
+        value.utc_offset.should == 9.5.hours
+      end
+
+      it 'should return value using string zone adjusted to :zone option string timezone' do
+        Timeliness.default_timezone = :local
+        value = parse("Thu, 01 Jun 2000 03:00:00 MST", :zone => 'Perth')
+        value.should == Time.use_zone('Perth') { Time.zone.local(2000,6,1,18,0,0) }
+        value.utc_offset.should == 8.hours
+      end
+
+      after do
+        Time.zone = nil
+      end
     end
 
     context "with :datetime type" do
@@ -132,12 +156,23 @@ describe Timeliness::Parser do
       end
     end
 
+    context "with time value argument" do
+      it 'should use argument as :now option value' do
+        time = parse("12:13:14", Time.local(2010,1,1))
+        time.should == Time.local(2010,1,1,12,13,14)
+      end
+    end
+
     context "with :zone option" do
       context ":utc" do
         it "should return time object in utc timezone" do
           time = parse("2000-06-01 12:13:14", :datetime, :zone => :utc)
           time.utc_offset.should == 0
         end
+
+        it 'should return nil for partial invalid time component' do
+          parse("2000-06-01 12:60", :datetime, :zone => :utc).should be_nil
+        end
       end
 
       context ":local" do
@@ -145,6 +180,10 @@ describe Timeliness::Parser do
           time = parse("2000-06-01 12:13:14", :datetime, :zone => :local)
           time.utc_offset.should == 10.hours
         end
+
+        it 'should return nil for partial invalid time component' do
+          parse("2000-06-01 12:60", :datetime, :zone => :local).should be_nil
+        end
       end
 
       context ":current" do
@@ -153,6 +192,10 @@ describe Timeliness::Parser do
           time = parse("2000-06-01 12:13:14", :datetime, :zone => :current)
           time.utc_offset.should == 9.5.hours
         end
+
+        it 'should return nil for partial invalid time component' do
+          parse("2000-06-01 12:60", :datetime, :zone => :current).should be_nil
+        end
       end
 
       context "named zone" do
@@ -160,6 +203,10 @@ describe Timeliness::Parser do
           time = parse("2000-06-01 12:13:14", :datetime, :zone => 'London')
           time.utc_offset.should == 1.hour
         end
+
+        it 'should return nil for partial invalid time component' do
+          parse("2000-06-01 12:60", :datetime, :zone => 'London').should be_nil
+        end
       end
 
       context "without ActiveSupport loaded" do

data/timeliness.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
   s.rubyforge_project = %q{timeliness}
 
   s.files            = `git ls-files`.split("\n")
-  s.test_files       = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.files            = `git ls-files`.split("\n") - %w{ .gitignore .rspec Gemfile Gemfile.lock }
   s.extra_rdoc_files = ["README.rdoc", "CHANGELOG.rdoc"]
   s.require_paths    = ["lib"]
 end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: timeliness
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  hash: 27
+  prerelease: 
   segments: 
   - 0
   - 3
-  - 3
-  version: 0.3.3
+  - 4
+  version: 0.3.4
 platform: ruby
 authors: 
 - Adam Meehan
@@ -14,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-02 00:00:00 +11:00
+date: 2011-05-26 00:00:00 +10:00
 default_executable: 
 dependencies: []
 
@@ -28,8 +29,6 @@ extra_rdoc_files:
 - README.rdoc
 - CHANGELOG.rdoc
 files: 
-- .gitignore
-- .rspec
 - CHANGELOG.rdoc
 - LICENSE
 - README.rdoc
@@ -65,6 +64,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -73,20 +73,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: timeliness
-rubygems_version: 1.3.7
+rubygems_version: 1.5.2
 signing_key: 
 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
-- spec/timeliness/parser_spec.rb
+test_files: []
+

data/.gitignore

@@ -1 +0,0 @@
-pkg/*

data/.rspec

@@ -1 +0,0 @@
---color