timeliness 0.1.0

data/spec/timeliness/formats_spec.rb

@@ -0,0 +1,93 @@
+require 'spec_helper'
+
+describe Timeliness::Formats do
+
+  context "add_formats" do
+    before do
+      @default_formats = formats.time_formats.dup
+    end
+
+    it "should add format to format array" do
+      formats.add_formats(:time, "h o'clock")
+      formats.time_formats.should include("h o'clock")
+    end
+
+    it "should parse new format after its added" do
+      should_not_parse("12 o'clock", :time)
+      formats.add_formats(:time, "h o'clock")
+      should_parse("12 o'clock", :time)
+    end
+
+    it "should raise error if format exists" do
+      lambda { formats.add_formats(:time, "hh:nn:ss") }.should raise_error
+    end
+
+    context "with :before option" do
+      it "should add new format with higher precedence" do
+        formats.add_formats(:time, "ss:hh:nn", :before => 'hh:nn:ss')
+        time_array = parser._parse('59:23:58', :time)
+        time_array.should == [nil,nil,nil,23,58,59,nil]
+      end
+
+      it "should raise error if :before format does not exist" do
+        lambda { formats.add_formats(:time, "ss:hh:nn", :before => 'nn:hh:ss') }.should raise_error
+      end
+    end
+
+    after do
+      formats.time_formats = @default_formats
+      formats.compile_formats
+    end
+  end
+
+  context "remove_formats" do
+    before do
+      @default_formats = formats.time_formats.dup
+    end
+
+    it "should remove format from format array" do
+      formats.remove_formats(:time, 'h.nn_ampm')
+      formats.time_formats.should_not include("h o'clock")
+    end
+
+    it "should remove multiple formats from format array" do
+      formats.remove_formats(:time, 'h.nn_ampm')
+      formats.time_formats.should_not include("h o'clock")
+    end
+
+    it "should not allow format to be parsed" do
+      should_parse('2.12am', :time)
+      formats.remove_formats(:time, 'h.nn_ampm')
+      should_not_parse('2.12am', :time)
+    end
+
+    it "should raise error if format does not exist" do
+      lambda { formats.remove_formats(:time, "ss:hh:nn") }.should raise_error()
+    end
+
+    after do
+      formats.time_formats = @default_formats
+      formats.compile_formats
+    end
+  end
+
+  context "use_euro_formats" do
+    it "should allow ambiguous date to be parsed as European format" do
+      parser._parse('01/02/2000', :date).should == [2000,1,2,nil,nil,nil,nil]
+      formats.use_euro_formats
+      parser._parse('01/02/2000', :date).should == [2000,2,1,nil,nil,nil,nil]
+    end
+  end
+
+  context "use_use_formats" do
+    before do
+      formats.use_euro_formats
+    end
+
+    it "should allow ambiguous date to be parsed as European format" do
+      parser._parse('01/02/2000', :date).should == [2000,2,1,nil,nil,nil,nil]
+      formats.use_us_formats
+      parser._parse('01/02/2000', :date).should == [2000,1,2,nil,nil,nil,nil]
+    end
+  end
+end

data/spec/timeliness/parser_spec.rb

@@ -0,0 +1,354 @@
+require 'spec_helper'
+
+describe Timeliness::Parser do
+  context "parse" do
+    it "should return time object for valid time string" do
+      parse("2000-01-01 12:13:14", :datetime).should be_kind_of(Time)
+    end
+
+    it "should return nil for datetime string with invalid date part" do
+      should_not_parse("2000-02-30 12:13:14", :datetime)
+    end
+
+    it "should return nil for datetime string with invalid time part" do
+      should_not_parse("2000-02-01 25:13:14", :datetime)
+    end
+
+    it "should return nil for invalid date string" do
+      should_not_parse("2000-02-30", :date)
+    end
+
+    it "should return nil for invalid time string" do
+      should_not_parse("25:00:00", :time)
+    end
+
+    it "should ignore time in datetime string for date type" do
+      parse('2000-02-01 12:13', :date).should == Time.local(2000,2,1)
+    end
+
+    it "should ignore date in datetime string for time type" do
+      parse('2010-02-01 12:13', :time).should == Time.local(2000,1,1,12,13)
+    end
+
+    it "should return return same value if value not a string" do
+      value = Time.now
+      parse(value, :datetime).should == value
+    end
+
+    context "with :now option" do
+      it 'should use date parts if string does not specify' do
+        time = parse("12:13:14", :now => 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
+      end
+
+      context ":local" do
+        it "should return time object in local system timezone" do
+          time = parse("2000-06-01 12:13:14", :datetime, :zone => :local)
+          time.utc_offset.should == 10.hours
+        end
+      end
+
+      context ":current" do
+        it "should return time object in current timezone" do
+          Time.zone = 'Adelaide'
+          time = parse("2000-06-01 12:13:14", :datetime, :zone => :current)
+          time.utc_offset.should == 9.5.hours
+        end
+      end
+
+      context "named zone" do
+        it "should return time object in the timezone" do
+          time = parse("2000-06-01 12:13:14", :datetime, :zone => 'London')
+          time.utc_offset.should == 1.hour
+        end
+      end
+    end
+
+    describe "for time type" do
+      it 'should use date from date_for_time_type' do
+        parse('12:13:14', :time).should == Time.local(2000,1,1,12,13,14)
+      end
+
+      context "with :now option" do
+        it 'should use date from :now' do
+          parse('12:13:14', :time, :now => Time.local(2010, 6, 1)).should == Time.local(2010,6,1,12,13,14)
+        end
+      end
+
+      context "with :zone option" do
+        before(:all) do
+          Timecop.freeze(2010,1,1,0,0,0)
+        end
+
+        it "should use date from the specified zone" do
+          time = parse("12:13:14", :time, :zone => :utc)
+          time.year.should == 2009
+          time.month.should == 12
+          time.day.should == 31
+        end
+
+        after(:all) do
+          Timecop.return
+        end
+      end
+    end
+  end
+
+  context "_parse" do
+    context "with type" do
+      it "should return date array from date string" do
+        time_array = parser._parse('2000-02-01', :date)
+        time_array.should == [2000,2,1,nil,nil,nil,nil]
+      end
+
+      it "should return time array from time string" do
+        time_array = parser._parse('12:13:14', :time)
+        time_array.should == [nil,nil,nil,12,13,14,nil]
+      end
+
+      it "should return datetime array from datetime string" do
+        time_array = parser._parse('2000-02-01 12:13:14', :datetime)
+        time_array.should == [2000,2,1,12,13,14,nil]
+      end
+
+      it "should return date array from date string when type is datetime" do
+        time_array = parser._parse('2000-02-01', :datetime)
+        time_array.should == [2000,2,1,nil,nil,nil,nil]
+      end
+
+      it "should return datetime array from datetime string when type is date" do
+        time_array = parser._parse('2000-02-01 12:13:14', :date)
+        time_array.should == [2000,2,1,12,13,14,nil]
+      end
+    end
+
+    context "with no type" do
+      it "should return date array from date string" do
+        time_array = parser._parse('2000-02-01')
+        time_array.should == [2000,2,1,nil,nil,nil,nil]
+      end
+
+      it "should return time array from time string" do
+        time_array = parser._parse('12:13:14', :time)
+        time_array.should == [nil,nil,nil,12,13,14,nil]
+      end
+
+      it "should return datetime array from datetime string" do
+        time_array = parser._parse('2000-02-01 12:13:14')
+        time_array.should == [2000,2,1,12,13,14,nil]
+      end
+
+      it "should return date array from date string when type is datetime" do
+        time_array = parser._parse('2000-02-01')
+        time_array.should == [2000,2,1,nil,nil,nil,nil]
+      end
+
+      it "should return datetime array from datetime string when type is date" do
+        time_array = parser._parse('2000-02-01 12:13:14')
+        time_array.should == [2000,2,1,12,13,14,nil]
+      end
+    end
+
+    context "with :strict => true" do
+      it "should return nil from date string when type is datetime" do
+        time_array = parser._parse('2000-02-01', :datetime, :strict => true)
+        time_array.should be_nil
+      end
+
+      it "should return nil from datetime string when type is date" do
+        time_array = parser._parse('2000-02-01 12:13:14', :date, :strict => true)
+        time_array.should be_nil
+      end
+
+      it "should return nil from datetime string when type is time" do
+        time_array = parser._parse('2000-02-01 12:13:14', :time, :strict => true)
+        time_array.should be_nil
+      end
+
+      it "should parse date string when type is date" do
+        time_array = parser._parse('2000-02-01', :date, :strict => true)
+        time_array.should_not be_nil
+      end
+
+      it "should parse time string when type is time" do
+        time_array = parser._parse('12:13:14', :time, :strict => true)
+        time_array.should_not be_nil
+      end
+
+      it "should parse datetime string when type is datetime" do
+        time_array = parser._parse('2000-02-01 12:13:14', :datetime, :strict => true)
+        time_array.should_not be_nil
+      end
+
+      it "should ignore strict parsing if no type specified" do
+        time_array = parser._parse('2000-02-01', :strict => true)
+        time_array.should_not be_nil
+      end
+    end
+
+    it "should return nil if time hour is out of range for AM meridian" do
+      time_array = parser._parse('13:14 am', :time)
+      time_array.should == nil
+      time_array = parser._parse('00:14 am', :time)
+      time_array.should == nil
+    end
+
+    context "with :format option" do
+      it "should return values if string matches specified format" do
+        time_array = parser._parse('2000-02-01 12:13:14', :datetime, :format => 'yyyy-mm-dd hh:nn:ss')
+        time_array.should == [2000,2,1,12,13,14,nil]
+      end
+
+      it "should return nil if string does not match specified format" do
+        time_array = parser._parse('2000-02-01 12:13', :datetime, :format => 'yyyy-mm-dd hh:nn:ss')
+        time_array.should be_nil
+      end
+    end
+
+    context "date with ambiguous year" do
+      it "should return year in current century if year below threshold" do
+        time_array = parser._parse('01-02-29', :date)
+        time_array.should == [2029,2,1,nil,nil,nil,nil]
+      end
+
+      it "should return year in last century if year at or above threshold" do
+        time_array = parser._parse('01-02-30', :date)
+        time_array.should == [1930,2,1,nil,nil,nil,nil]
+      end
+
+      it "should allow custom threshold" do
+        default = Timeliness.ambiguous_year_threshold
+        Timeliness.ambiguous_year_threshold = 40
+        time_array = parser._parse('01-02-39', :date)
+        time_array.should == [2039,2,1,nil,nil,nil,nil]
+        time_array = parser._parse('01-02-40', :date)
+        time_array.should == [1940,2,1,nil,nil,nil,nil]
+        Timeliness.ambiguous_year_threshold = default
+      end
+    end
+  end
+
+  describe "make_time" do
+    it "should return time object for valid time array" do
+      time = parser.make_time([2010,9,8,12,13,14])
+      time.should == Time.local(2010,9,8,12,13,14)
+    end
+
+    it "should return nil for invalid date in array" do
+      time = parser.make_time([2010,13,8,12,13,14])
+      time.should be_nil
+    end
+
+    it "should return nil for invalid time in array" do
+      time = parser.make_time([2010,9,8,25,13,14])
+      time.should be_nil
+    end
+
+    context "default timezone" do
+      before do
+        @default_timezone = Timeliness.default_timezone
+      end
+
+      it "should be used if no zone value" do
+        Timeliness.default_timezone = :utc
+        time = parser.make_time([2000,6,1,12,0,0])
+        time.utc_offset.should == 0
+      end
+
+      after do
+       Timeliness.default_timezone = @default_timezone
+      end
+    end
+
+    context "with zone value" do
+      context ":utc" do
+        it "should return time object in utc timezone" do
+          time = parser.make_time([2000,6,1,12,0,0], :utc)
+          time.utc_offset.should == 0
+        end
+      end
+
+      context ":local" do
+        it "should return time object in local system timezone" do
+          time = parser.make_time([2000,6,1,12,0,0], :local)
+          time.utc_offset.should == 10.hours
+        end
+      end
+
+      context ":current" do
+        it "should return time object in current timezone" do
+          Time.zone = 'Adelaide'
+          time = parser.make_time([2000,6,1,12,0,0], :current)
+          time.utc_offset.should == 9.5.hours
+        end
+      end
+
+      context "named zone" do
+        it "should return time object in the timezone" do
+          time = parser.make_time([2000,6,1,12,0,0], 'London')
+          time.utc_offset.should == 1.hour
+        end
+      end
+    end
+  end
+
+  describe "current_date" do
+    before(:all) do
+      Timecop.freeze(2010,1,1,0,0,0)
+    end
+
+    context "with no options" do
+      it 'should return date_for_time_type values with no options' do
+        current_date.should == Timeliness.date_for_time_type
+      end
+    end
+
+    context "with :now option" do
+      it 'should return date array from Time value' do
+        time = Time.now
+        date_array = [time.year, time.month, time.day]
+        current_date(:now => time).should == date_array
+      end
+    end
+
+    context "with :zone option" do
+      it 'should return date array for utc zone' do
+        time = Time.now.getutc
+        date_array = [time.year, time.month, time.day]
+        current_date(:zone => :utc).should == date_array
+      end
+
+      it 'should return date array for local zone' do
+        time = Time.now
+        date_array = [time.year, time.month, time.day]
+        current_date(:zone => :local).should == date_array
+      end
+
+      it 'should return date array for current zone' do
+        Time.zone = 'London'
+        time = Time.current
+        date_array = [time.year, time.month, time.day]
+        current_date(:zone => :current).should == date_array
+      end
+
+      it 'should return date array for named zone' do
+        time = Time.use_zone('London') { Time.current }
+        date_array = [time.year, time.month, time.day]
+        current_date(:zone => 'London').should == date_array
+      end
+    end
+
+    after(:all) do
+      Timecop.return
+    end
+  end
+end

data/timeliness.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{timeliness}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Adam Meehan"]
+  s.date = %q{2010-10-14}
+  s.description = %q{Fast date/time parser with customisable formats and I18n support.}
+  s.email = %q{adam.meehan@gmail.com}
+  s.extra_rdoc_files = ["README.rdoc", "CHANGELOG.rdoc"]
+  s.files = ["timeliness.gemspec", "LICENSE", "CHANGELOG.rdoc", "README.rdoc", "Rakefile", "lib/timeliness", "lib/timeliness/format_set.rb", "lib/timeliness/formats.rb", "lib/timeliness/helpers.rb", "lib/timeliness/parser.rb", "lib/timeliness/version.rb", "lib/timeliness.rb", "spec/spec_helper.rb", "spec/timeliness", "spec/timeliness/format_set_spec.rb", "spec/timeliness/formats_spec.rb", "spec/timeliness/parser_spec.rb"]
+  s.homepage = %q{http://github.com/adzap/timeliness}
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{timeliness}
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Control time (parsing), quickly.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end