third_base 1.0.1 → 1.1.0

data/README

@@ -168,12 +168,29 @@ To add a parser to a parser type:
     t = Time.now
     {:civil=>[t.year, t.mon, t.day]}
   end
+
   DateTime.add_parser(:mine, /\Anow\z/i) do |m|
     t = Time.now
     {:civil=>[t.year, t.mon, t.day], :parts=>[t.hour, t.min, t.sec, t.usec] \
       :offset=>t.utc_offset}
   end
 
+If you add a DateTime parser that may guess at certain values instead of
+parsing them out of the string, you should include a :not_parsed entry which
+is an array of symbols indicating items that were not parsed directly out
+of the string.  This is only necessary if you are using the compatibility
+mode and want better compatibility for Date._parse (which ruby's Time.parse
+method uses internally):
+
+  DateTime.add_parser(:mine, /\A(\d\d)_(\d\d)_(\d{4})\z/i) do |m|
+    {:civil=>[m[3].to_i, m[2].to_i, m[1].to_i], :parts=>[0,0,0,0], :offset=>0, \
+     :not_parsed=>[:hour, :min, :sec, :sec_fraction, :offset, :zone]}
+  end
+
+The entries in :not_parsed should match keys that can be returned by
+Date._parse, so in addition to the ones listed above, you can also use
+:year, :mon, and :mday.
+
 Adding a parser to a parser type adds it to the front of the array of parsers 
 for that type, so it will be tried before other parsers for that type.  It is
 an error to add a parser to a parser type that doesn't exist.

data/lib/third_base/compat.rb

@@ -42,7 +42,7 @@ module ThirdBase
     # * :zone : time zone offset as string
     def _parse(str, comp=false)
       d = DateTime.parse(str)
-      {:mon=>d.mon, :zone=>d.zone, :sec=>d.sec, :year=>d.year, :hour=>d.hour, :offset=>d.offset, :mday=>d.day, :min=>d.min, :sec_fraction=>d.usec/1000000.0}
+      {:mon=>d.mon, :zone=>d.zone, :sec=>d.sec, :year=>d.year, :hour=>d.hour, :offset=>d.offset, :mday=>d.day, :min=>d.min, :sec_fraction=>d.usec/1000000.0}.reject{|k, v| d.not_parsed.include?(k)}
     end
     
     # Converts an Astronomical Julian Date to an Astronomical Modified Julian Date (substracts an integer from ajd)

data/lib/third_base/datetime.rb

@@ -12,13 +12,13 @@ module ThirdBase
     DEFAULT_PARSERS[:time] = [[%r{\A#{TIME_RE_STRING}\z}io, proc do |m|
         unless m[0] == ''
           t = Time.now
-          add_parsed_time_parts(m, {:civil=>[t.year, t.mon, t.day]}, 1)
+          add_parsed_time_parts(m, {:civil=>[t.year, t.mon, t.day], :not_parsed=>[:year, :mon, :mday]}, 1)
         end
       end]]
     DEFAULT_PARSERS[:iso] = [[%r{\A(-?\d{4})[-./ ](\d\d)[-./ ](\d\d)#{TIME_RE_STRING}\z}io, proc{|m| add_parsed_time_parts(m, :civil=>[m[1].to_i, m[2].to_i, m[3].to_i])}]]
     DEFAULT_PARSERS[:us] = [[%r{\A(\d\d?)[-./ ](\d\d?)[-./ ](\d\d(?:\d\d)?)#{TIME_RE_STRING}\z}io, proc{|m| add_parsed_time_parts(m, :civil=>[two_digit_year(m[3]), m[1].to_i, m[2].to_i])}],
-      [%r{\A(\d\d?)/(\d?\d)#{TIME_RE_STRING}\z}o, proc{|m| add_parsed_time_parts(m, {:civil=>[Time.now.year, m[1].to_i, m[2].to_i]}, 3)}],
-      [%r{\A#{MONTHNAME_RE_PATTERN}[-./ ](\d\d?)(?:st|nd|rd|th)?,?(?:[-./ ](-?(?:\d\d(?:\d\d)?)))?#{TIME_RE_STRING}\z}io, proc{|m| add_parsed_time_parts(m, :civil=>[m[3] ? two_digit_year(m[3]) : Time.now.year, MONTH_NUM_MAP[m[1].downcase], m[2].to_i])}],
+      [%r{\A(\d\d?)/(\d?\d)#{TIME_RE_STRING}\z}o, proc{|m| add_parsed_time_parts(m, {:civil=>[Time.now.year, m[1].to_i, m[2].to_i], :not_parsed=>:year}, 3)}],
+      [%r{\A#{MONTHNAME_RE_PATTERN}[-./ ](\d\d?)(?:st|nd|rd|th)?,?(?:[-./ ](-?(?:\d\d(?:\d\d)?)))?#{TIME_RE_STRING}\z}io, proc{|m| add_parsed_time_parts(m, :civil=>[m[3] ? two_digit_year(m[3]) : Time.now.year, MONTH_NUM_MAP[m[1].downcase], m[2].to_i], :not_parsed=>m[3] ? [] : [:year])}],
       [%r{\A(\d\d?)(?:st|nd|rd|th)?[-./ ]#{MONTHNAME_RE_PATTERN}[-./ ](-?\d{4})#{TIME_RE_STRING}\z}io, proc{|m| add_parsed_time_parts(m, :civil=>[m[3].to_i, MONTH_NUM_MAP[m[2].downcase], m[1].to_i])}],
       [%r{\A(-?\d{4})[-./ ]#{MONTHNAME_RE_PATTERN}[-./ ](\d\d?)(?:st|nd|rd|th)?#{TIME_RE_STRING}\z}io, proc{|m| add_parsed_time_parts(m, :civil=>[m[1].to_i, MONTH_NUM_MAP[m[2].downcase], m[3].to_i])}],
       [%r{\A#{MONTHNAME_RE_PATTERN}[-./ ](-?\d{4})#{TIME_RE_STRING}\z}io, proc{|m| add_parsed_time_parts(m, {:civil=>[m[2].to_i, MONTH_NUM_MAP[m[1].downcase], 1]}, 3)}]]
@@ -30,11 +30,11 @@ module ThirdBase
         case m.length
         when 2
           t = Time.now
-          {:civil=>[t.year, t.mon, m.to_i]}
+          {:civil=>[t.year, t.mon, m.to_i], :not_parsed=>[:year, :mon, :mday]}
         when 3
-          {:ordinal=>[Time.now.year, m.to_i]}
+          {:ordinal=>[Time.now.year, m.to_i], :not_parsed=>[:year, :mon, :mday]}
         when 4
-          {:civil=>[Time.now.year, m[0..1].to_i, m[2..3].to_i]}
+          {:civil=>[Time.now.year, m[0..1].to_i, m[2..3].to_i], :not_parsed=>[:year]}
         when 5
           {:ordinal=>[two_digit_year(m[0..1]), m[2..4].to_i]}
         when 6
@@ -128,16 +128,25 @@ module ThirdBase
     # * i + 4 : meridian indicator
     # * i + 5 : time zone
     def self.add_parsed_time_parts(m, h, i=4)
+      not_parsed = h[:not_parsed] || []
       hour = m[i].to_i
       meridian = m[i+4]
       hour = hour_with_meridian(hour, /a/io.match(meridian) ? :am : :pm) if meridian
-      offset = if m[i+5]
-        x = m[i+5].gsub(':','')
-        x == 'Z' ? 0 : x[0..2].to_i*3600 + x[3..4].to_i*60
+      offset = if of = m[i+5]
+        x = of.gsub(':','')
+        offset = x == 'Z' ? 0 : x[0..2].to_i*3600 + x[3..4].to_i*60
       else
+        not_parsed.concat([:zone, :offset])
         Time.now.utc_offset
       end
-      h.merge!(:parts=>[hour, m[i+1].to_i, m[i+2].to_i, (m[i+3].to_f/0.000001).to_i], :offset=>offset)
+      min = m[i+1].to_i
+      sec = m[i+2].to_i
+      sec_fraction = m[i+3].to_f 
+      not_parsed << :hour unless m[i]
+      not_parsed << :min unless m[i+1]
+      not_parsed << :sec unless m[i+2]
+      not_parsed << :sec_fraction unless m[i+3]
+      h.merge!(:parts=>[hour, min, sec, (sec_fraction/0.000001).to_i], :offset=>offset, :not_parsed=>not_parsed)
       h
     end
     
@@ -212,6 +221,9 @@ module ThirdBase
     attr_reader :offset
     alias utc_offset offset
     
+    # Which parts of this datetime were guessed instead of being parsed from the input.
+    attr_reader :not_parsed
+
     # Called by DateTime.new!, should be a hash with the following possible keys:
     #
     # * :civil, :commericial, :jd, :ordinal : See ThirdBase::Date#initialize
@@ -221,6 +233,7 @@ module ThirdBase
     #
     # Raises an ArgumentError if an invalid date is used.  DateTime objects are immutable once created.
     def initialize(opts)
+      @not_parsed = opts[:not_parsed] || []
       @offset = opts[:offset]
       raise(ArgumentError, 'invalid datetime') unless @offset.is_a?(Integer) and @offset <= 43200 and @offset >= -43200
       if opts[:parts]

data/spec/compat/compat_class_methods_spec.rb

@@ -22,8 +22,13 @@ describe ThirdBase::CompatClassMethods do
   end
 
   it "#_parse should parse the date string and return a hash" do
-    Date._parse('2008-10-20 11:12:13-08:00').should == {:mon=>10, :zone=>'-08:00', :sec=>13, :sec_fraction=>0.0, :year=>2008, :hour=>11, :offset=>-28800, :mday=>20, :min=>12}
-    Date._parse('2008-10-20 11:12:13-08:00', true).should == {:mon=>10, :zone=>'-08:00', :sec=>13, :sec_fraction=>0.0, :year=>2008, :hour=>11, :offset=>-28800, :mday=>20, :min=>12}
+    Date._parse('2008-10-20 11:12:13.0-08:00').should == {:mon=>10, :zone=>'-08:00', :sec=>13, :sec_fraction=>0.0, :year=>2008, :hour=>11, :offset=>-28800, :mday=>20, :min=>12}
+    Date._parse('2008-10-20 11:12:13.0-08:00', true).should == {:mon=>10, :zone=>'-08:00', :sec=>13, :sec_fraction=>0.0, :year=>2008, :hour=>11, :offset=>-28800, :mday=>20, :min=>12}
+  end
+
+  it "#_parse should not contain fields in the hash that were guessed" do
+    Date._parse('2008-10-20').should == {:year=>2008, :mday=>20, :mon=>10}
+    Date._parse('11:12:13').should == {:sec=>13, :hour=>11, :min=>12}
   end
 
   it "#ajd_to_amjd should convert a astronomical julian date to a astronomical modified julian date" do

data/spec/datetime/add_spec.rb

@@ -33,4 +33,4 @@ describe "DateTime#+" do
     lambda { DateTime.civil(2007,2,27) + Object.new }.should raise_error(TypeError)
   end
   
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: third_base
 version: !ruby/object:Gem::Version 
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors: 
 - Jeremy Evans
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-09 00:00:00 -08:00
+date: 2009-06-01 00:00:00 -07:00
 default_executable: 
 dependencies: []