partial-date 1.1.10 → 1.2.0

data/ChangeLog.markdown

@@ -1,4 +1,9 @@
-### 1.1.9 / 2012-05-31
+### 1.2.0 / 2012-06-03
+
+* Documentation and comment clean-up
+* Implemented guard on to_s for unknown % tokens.
+
+### 1.1.10 / 2012-06-01
 
 * Implemented faster Date#.to_s method.
 

data/lib/partial-date/date.rb

@@ -39,7 +39,14 @@ module PartialDate
   #   end
   # end
 
-  FORMATS = { :default => "%Y-%m-%d", :short => "%d %m %Y", :medium => "%d %b %Y", :long => "%d %B %Y", :number => "%Y%m%d",  }
+  FORMATS = { 
+              :default => "%Y-%m-%d", 
+              :short => "%d %m %Y", 
+              :medium => "%d %b %Y", 
+              :long => "%d %B %Y", 
+              :number => "%Y%m%d"  
+            }
+
   FORMAT_METHODS = { 
                       "%Y" => lambda { |d| (d.year != 0) ? d.year.to_s.rjust(4, '0') : ""},  
                       "%m" => lambda { |d| (d.month != 0) ? d.month.to_s.rjust(2, '0') : "" },
@@ -53,12 +60,28 @@ module PartialDate
   MONTH_NAMES = %w[January, February, March, April, May, June, July, August, September, October, November, December]
   ABBR_MONTH_NAMES = %w[Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec]
   
-  # Public: A class for handling partial date storage. Partial dates are stored
-  # as an 8 digit integer with optional month and day values.
+  # Public: A class for handling partial dates. Year (including negative 
+  # values), month and day are optional although month must be set before 
+  # day. Partial dates are stored internally in a single integer bit store
+  # using bitmask and bitwise operations to set and get year, month, and 
+  # day values.
+  #
+  # A numerical (human readable) date value can be retrieved via 
+  # the d.value accessor.
+  #
+  # Use d.value to get and set the numerical date value as well as for storing
+  # dates as a single value in a persistence store.
   #
   # Examples
   #   
   #   date = PartialDate::Date.new
+  #   date.value = 20121201
+  #   # => 2012-12-01
+  #
+  #   date = PartialDate::Date.load 20121201
+  #   # => 2012-12-01
+  #
+  #   date = PartialDate::Date.new
   #   date.year = 2012
   #   date.month = 12
   #   date.day = 1
@@ -71,9 +94,6 @@ module PartialDate
     include Comparable
 
     # Public: Readonly accessor for the raw bit integer date value.
-    # This allows us to perform our <=> comparions against this 
-    # value instead of comparing year, month and day, or date.value
-    # which requires multiplication to calculate.
     #
     # Returns the single Integer backing store with 'bits' flipped 
     # for year, month and day.
@@ -109,7 +129,7 @@ module PartialDate
     #
     #   date = PartialDate::Date.load 201212201
     #   date.value
-    #   # => 20120000
+    #   # => 20121200
     #   date.year
     #   # => 2012
     #   date.month
@@ -243,9 +263,10 @@ module PartialDate
       self.class.get_day(@bits)
     end
 
-    # Public: Returns a formatted string representation of the partial date. 
-    # A subset of date formatters have been implementes incuding:
-    # %Y - Year with century (can be negative, 4 digits at least)
+    # Public: Returns a formatted string representation of date. A subset of 
+    # date formatters have been implemented including: 
+    # %Y - Year with century
+    # (can be negative, and will be padded to 4 digits at least)
     #             -0001, 0000, 1995, 2009, 14292, etc.
     # %m - Month of the year, zero-padded (01..12)
     # %B - The full month name ('January')
@@ -262,14 +283,12 @@ module PartialDate
     # Returns string representation of date.
     def to_s(format = :default)
       format = FORMATS[format] if format.is_a?(Symbol)
-
       s = format.dup
-
       n = b = 0
       a = 1
       while n < s.length
-        if s[n] == "%"
-          t = FORMAT_METHODS[s[n..n+1]].call( self )
+        if s[n] == "%" && FORMAT_METHODS.include?(s[n..n+1])
+          t = FORMAT_METHODS[s[n..n+1]].call( self ) 
           if t.length == 0  
             if n >= 0 && n < s.length - 2
               a = a + 1 if s[n+2] =~ REMOVALS
@@ -287,7 +306,7 @@ module PartialDate
       end
       s
     end
-    
+
     # Here for the moment for benchmark comparisons
     def old_to_s(format = :default)
       format = FORMATS[format] if format.is_a?(Symbol)
@@ -305,12 +324,11 @@ module PartialDate
       lead_trim = (year != 0 && format.lstrip.start_with?("%Y")) ? /\A[\/\,\s]+/ : /\A[\/\,\-\s]+/ 
         result = result.gsub(lead_trim, '').gsub(/\s\s/, ' ').gsub(/[\/\-\,]([\/\-\,])/, '\1').gsub(/[\/\,\-\s]+\z/, '')
     end
-    
-    # Public: Spaceship operator for date comparisons. Comparisons 
-    # are made by cascading down from year, to month to day. This
-    # should be faster than passing to self.value <=> other_date.value
-    # since the integer value attribute requires multiplication to
-    # calculate.
+
+    # Public: Spaceship operator for date comparisons. Comparisons are made 
+    # by cascading down from year, to month to day. This should be faster 
+    # than passing to self.value <=> other_date.value since the integer value 
+    # attribute requires multiplication to calculate.
     #
     # Returns -1, 1, or 0
     def <=>(other_date)

data/lib/partial-date/version.rb

@@ -1,4 +1,4 @@
 module PartialDate
   # partial-date version
-    VERSION = "1.1.10"
+    VERSION = "1.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: partial-date
 version: !ruby/object:Gem::Version
-  version: 1.1.10
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-31 00:00:00.000000000 Z
+date: 2012-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubygems-tasks