partial-date 1.0.0 → 1.1.0

data/ChangeLog.textile

@@ -1,3 +1,9 @@
+h3. 1.1.0 / 2012-05-27
+
+* Implemented a 23bit bit store as backing store for date,
+reducing the storage requirements and increasing performance 
+of date objects. 
+
 h3. 1.0.0 / 2012-05-27
 
 * Refactored to use array backing store for element and computed date

data/README.textile

@@ -11,6 +11,7 @@ A simple date class that can be used to store partial date values in a single co
 h2. Features
 
 PartialDate::Date uses an 8 digit integer to store year, month and day values. Values for month and day are optional.
+Use @date.value@ to set or persist the date to a persistance store. 
 
 h2. Examples
 
@@ -51,8 +52,6 @@ h2. Install
 h2. TODO
 
 # @PartialDate::Date.parse@ method for construction from strings.
-# A Hash or Array backing store for date components for better performance.
-# Include Comparable
 
 h2. Copyright
 

data/lib/partial-date.rb

@@ -1,4 +1,5 @@
 require 'partial-date/version'
 require 'partial-date/error'
+require 'partial-date/bits'
 require 'partial-date/date'
 require 'date'

data/lib/partial-date/bits.rb

@@ -0,0 +1,52 @@
+module PartialDate
+
+  class Bits
+
+    # Key:
+    #   The firt 5 bits are the day (max 31)
+    #   The next 4 bits are the month (max 12)
+    #   The topmost/leftmost 14 bits are the year (max 9999)
+
+    DAY_MASK = 0b00000000000000000011111
+    MONTH_MASK = 0b00000000000000111100000
+    YEAR_MASK = 0b11111111111111000000000
+
+    ZERO_YEAR_MASK = 0b00000000000000111111111
+    ZERO_MONTH_MASK = 0b11111111111111000011111
+    ZERO_DAY_MASK = 0b111111111111111111000000
+
+    def self.get_date(register)
+        (get_year(register) * 10000) + (get_month(register) * 100) + get_day(register)
+    end
+
+    def self.set_date(register, value)
+        register = set_year(register, (value / 10000).abs)
+        register = set_month(register, ((value - (value / 10000).abs * 10000) / 100).abs)
+        register = set_day(register, value - (value / 100).abs * 100)
+    end
+
+    def self.get_year(register)
+      (register & YEAR_MASK) >> 9
+    end
+
+    def self.set_year(register, value)
+      register = (register & ZERO_YEAR_MASK) | (value << 9)
+    end
+
+    def self.get_month(register)
+      (register & MONTH_MASK) >> 5
+    end
+
+    def self.set_month(register, value)
+      register = (register & ZERO_MONTH_MASK) | (value << 5)
+    end
+
+    def self.get_day(register)
+      register & DAY_MASK
+    end
+
+    def self.set_day(register, value)
+      register = (register & ZERO_DAY_MASK) | value
+    end
+  end
+end

data/lib/partial-date/date.rb

@@ -36,10 +36,33 @@ module PartialDate
     #
     # Returns a date object.
     def initialize
-      @data = [0,0,0,0]
+      @bits = 0
       yield self if block_given?
     end
 
+    # Public: Loads an 8 digit date value into a date object. Can be used 
+    # when rehydrating a date object from a persisted partial date value.
+    #
+    # value - an 8 digit value in partial date format.
+    #
+    # Examples
+    #
+    #   date = PartialDate::Date.load 201212201
+    #   date.value
+    #   # => 20120000
+    #   date.year
+    #   # => 2012
+    #   date.month
+    #   # => 12
+    #   date.day
+    #   # => 0
+    #
+    # Returns date object
+    def self.load(value)
+      PartialDate::Date.new {|d| d.value = value}
+    end
+
+
     # Public: Get the integer date value in partial date format.
     #
     # Examples
@@ -50,7 +73,7 @@ module PartialDate
     #
     # Returns an integer representation of a partial date.
     def value
-      get_value(0)
+      Bits.get_date(@bits)
     end
 
     # Public: Set a date value using an interger in partial date format.
@@ -62,34 +85,12 @@ module PartialDate
     # Returns nothing  
     def value=(value)
       if value.is_a?(Integer) && (value >= 10000 && value <= 99991231)
-        set_value(0, value)
+        @bits = Bits.set_date(@bits, value)
       else
         raise PartialDateError, "Date value must be an integer betwen 10000 and 99991231"
       end
     end
 
-    # Public: Loads an 8 digit date value into a date object. Can be used 
-    # when rehydrating a date object from a persisted partial date value.
-    #
-    # value - an 8 digit value in partial date format.
-    #
-    # Examples
-    #
-    #   date = PartialDate::Date.load 201212201
-    #   date.value
-    #   # => 20120000
-    #   date.year
-    #   # => 2012
-    #   date.month
-    #   # => 12
-    #   date.day
-    #   # => 0
-    #
-    # Returns date object
-    def self.load(value)
-      PartialDate::Date.new {|d| d.value = value}
-    end
-
 
     # Public: Sets the year portion of a partial date.
     #
@@ -116,7 +117,7 @@ module PartialDate
       end
 
       if value.is_a?(Integer) && (value <= 9999 && value > 0) 
-        set_value(1, value)
+        @bits = Bits.set_year(@bits, value)
       else
         raise PartialDateError, "Year must be an integer between 1 and 9999"
       end
@@ -124,7 +125,7 @@ module PartialDate
 
     # Public: Get the year from a partial date.
     def year
-      get_value(1)
+      Bits.get_year(@bits)
     end
 
     # Public: Set the month of a partial date.
@@ -143,7 +144,7 @@ module PartialDate
       end
 
       if value.is_a?(Integer) && (value <= 12 && value >= 0)
-        set_value(2, value)
+        @bits = Bits.set_month(@bits, value)
       else
         raise PartialDateError, "Month must an be integer between 1 and 12"
       end
@@ -151,7 +152,7 @@ module PartialDate
 
     # Public: Get the month from a partial date.
     def month
-      get_value(2)
+      Bits.get_month(@bits)
     end
 
 
@@ -174,8 +175,7 @@ module PartialDate
       if value.is_a?(Integer) && (value >= 0 && value <= 31)
         begin
           date = ::Date.civil(self.year, self.month, value) if value > 0
-          #@value  = (self.value - self.day + value)
-          set_value(3, value)
+          @bits = Bits.set_day(@bits, value)
         rescue 
           raise PartialDateError, "Day must be a valid day for the given month"
         end
@@ -186,8 +186,7 @@ module PartialDate
 
     # Public: Get the day from a partial date.
     def day
-      #self.value > 0 ? self.value - (self.value / 100).abs * 100 : 0
-      get_value(3)
+      Bits.get_day(@bits)
     end
 
     # Public: Returns a formatted string representation of the partial date.
@@ -216,39 +215,5 @@ module PartialDate
     def <=>(other_date)
       self.value <=> other_date.value
     end
-
-
-    private
-
-    # Internal: Retreive a value from the array backing store.
-    #
-    # Returns an integer value for partial date, year, month or day.
-    def get_value(element)
-      @data[element]
-    end
-
-    # Internal: Set a value in the array backing store - either the
-    # complete date value (from load or value accessors), or a year, 
-    # month, or day value after which the partial date will be recomputed.
-    #
-    # Returns nothing
-    def set_value(element, value)
-      case element
-      when 0
-        @data[1] = (value / 10000).abs 
-        @data[2] = ((value - (value / 10000).abs * 10000) / 100).abs
-        @data[3] = value - (value / 100).abs * 100 
-      when 1
-        @data[0] = @data[0] - (self.year * 10000) + (value * 10000)
-      when 2
-        @data[0] = @data[0] - (self.month * 100) + (value * 100)
-      when 3
-        @data[0] = @data[0] - self.day + value
-      end 
-
-      # Important - update the old element value _after_ @data[0] 
-      # has been recalculated above.
-      @data[element] = value
-    end
   end
 end

data/lib/partial-date/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: partial-date
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -78,6 +78,7 @@ files:
 - README.textile
 - Rakefile
 - lib/partial-date.rb
+- lib/partial-date/bits.rb
 - lib/partial-date/date.rb
 - lib/partial-date/error.rb
 - lib/partial-date/version.rb