partial-date 1.1.9 → 1.1.10

data/.gitignore

@@ -1,3 +1,4 @@
+tmp/
 coverage/
 .yardoc/
 doc/

data/ChangeLog.markdown

@@ -1,5 +1,9 @@
 ### 1.1.9 / 2012-05-31
 
+* Implemented faster Date#.to_s method.
+
+### 1.1.9 / 2012-05-31
+
 * BugFix: to_s will preserve minus sign for negative year when formatter starts with %Y
 * BugFix: <=> correct for negative dates.
 

data/Rakefile

@@ -3,6 +3,13 @@
 require 'rubygems'
 require 'rake'
 
+# Benchmark setup inspired by https://github.com/stonean/slim
+# Call 'rake benchmark iterations=10000' to set iterations
+desc 'Run PartialDate benchmarks (default iterations=1000)'
+task :benchmark, :iterations do
+  ruby('benchmarks/run-benchmarks.rb')
+end
+
 begin
   gem 'rubygems-tasks', '~> 0.2'
   require 'rubygems/tasks'

data/benchmarks/run-benchmarks.rb

@@ -0,0 +1,78 @@
+#!/usr/bin/env ruby
+
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'), File.dirname(__FILE__))
+
+require 'partial-date'
+require 'benchmark'
+require 'date'
+
+class PartialDateBenchmarks
+  def initialize(iterations)
+    @iterations = (iterations || 10000).to_i
+    @benches    = []
+
+    stdlib_date = Date.new(2012,12,1)
+    partial_date = PartialDate::Date.new {|d| d.year = 2012; d.month = 12; d.day = 1}
+
+    bench('(1a) create empty stdlib date objects')  do |d|
+      Date.new
+    end
+
+    bench('(1b) create empty partial-date objects')  do |d|
+      PartialDate::Date.new
+    end
+
+    bench('(2a) create populated stdlib date objects')  do |d| 
+      Date.new(2012,12,1)
+    end
+
+    bench('(2b) create populated partial-date objects from block')  do |d| 
+      PartialDate::Date.new { |d| d.year = 2012; d.month = 12; d.day = 1 }
+    end
+
+    bench('(3) create partial-date objects from load method')  do |d| 
+      PartialDate::Date.load 20121201
+    end
+
+    bench('(4a) read stdlib date parts') do |d|
+      stdlib_date.year
+      stdlib_date.month
+      stdlib_date.day
+    end
+
+    bench('(4b) read partial-date date parts') do |d|
+      partial_date.year
+      partial_date.month
+      partial_date.day
+    end
+
+    bench('(5a) call stdlib date strftime') do |d|
+      stdlib_date.strftime('%Y-%m-%d')
+    end
+
+    bench('(5b) call partial-date to_s') do |d|
+      partial_date.to_s
+    end
+
+    bench('(5c) call partial-date old to_s') do |d|
+      partial_date.old_to_s
+    end
+  end
+
+  def run
+    puts "#{@iterations} Iterations"
+    Benchmark.bmbm do |x|
+      @benches.each do |name, block|
+        x.report name.to_s do
+          @iterations.to_i.times { block.call }
+        end
+      end
+    end
+  end
+
+  def bench(name, &block)
+    @benches.push([name, block])
+  end
+end
+
+PartialDateBenchmarks.new(ENV['iterations']).run

data/benchmarks/run-gcprof.rb

@@ -0,0 +1,52 @@
+#!/usr/bin/env ruby
+
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'), File.dirname(__FILE__))
+
+require 'partial-date'
+require 'date'
+
+
+class PartialDateMemoryProfile
+  def initialize(iterations)
+    @tmp_dir = File.expand_path('../tmp', __FILE__)
+    Dir.mkdir @tmp_dir unless Dir.exists? @tmp_dir
+
+    @iterations = (iterations || 100000).to_i
+    @profiles   = []
+    @memory = []
+
+    # profile('create_stdlib_date') do |d|
+    #   @memory << Date.new(2012,12,1)
+    # end
+
+    profile('create_partial_date') do |d|
+      @memory << PartialDate::Date.new { |d| d.year - 2012; d.month = 12; d.day = 1}
+    end
+
+    # profile('load_partial_date') do |d|
+    #   PartialDate::Date.load(20121201)
+    # end
+  end
+
+  def run
+    puts "#{@iterations} Iterations"
+    GC::Profiler.enable()
+    @profiles.each do |name, block| 
+      count = 1
+      @iterations.times do 
+        block.call 
+        if count % 1000 == 0
+          puts " GC Profile Report #{ count.to_s.rjust(5, '0') } for #{ name } and #{ @memory.length} objects." 
+          puts GC::Profiler.report()
+        end
+        count += 1
+      end
+    end    
+  end
+
+  def profile(name, &block)
+    @profiles.push([@tmp_dir + "/" + name, block])
+  end
+end
+
+PartialDateMemoryProfile.new(ENV['iterations']).run

data/benchmarks/run-perftools.rb

@@ -0,0 +1,46 @@
+#!/usr/bin/env ruby
+
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'), File.dirname(__FILE__))
+
+require 'perftools'
+require 'partial-date'
+require 'date'
+
+class PartialDateCPUProfile
+  def initialize(iterations)
+    @tmp_dir = File.expand_path('../tmp', __FILE__)
+    Dir.mkdir @tmp_dir unless Dir.exists? @tmp_dir
+
+    @iterations = (iterations || 100000).to_i
+    @profiles   = []
+
+    profile('create_stdlib_date') do |d|
+      Date.new(2012,12,1)
+    end
+
+    profile('create_partial_date') do |d|
+      PartialDate::Date.new { |d| d.year - 2012; d.month = 12; d.day = 1}
+    end
+
+    profile('load_partial_date') do |d|
+      PartialDate::Date.load(20121201)
+    end
+  end
+
+  def run
+    puts "#{@iterations} Iterations"
+    @profiles.each do |name, block| 
+      PerfTools::CpuProfiler.start(name) do
+        @iterations.times { block.call }
+        #@iterations.to_i.times { block.call }
+      end
+      system "pprof.rb --gif #{name} > #{name}.gif"
+    end    
+  end
+
+  def profile(name, &block)
+    @profiles.push([@tmp_dir + "/" + name, block])
+  end
+end
+
+PartialDateCPUProfile.new(ENV['iterations']).run

data/lib/partial-date/date.rb

@@ -22,6 +22,8 @@ module PartialDate
   YEAR_SHIFT = 9
   MONTH_SHIFT = 5
 
+  REMOVALS = /[\/\,\-\s]/
+
   # TODO: Implement i18n support detecting whether a load path has been set or not
   # and if not - setting it here to a default set of translations that match
   # the generally available tranlsations for localizing dates.
@@ -145,7 +147,7 @@ module PartialDate
       if value.is_a?(Integer) && (value >= -10485761231 && value <= 10485761231)
         @bits = self.class.set_date(@bits, value)
       else
-        raise PartialDateError, "Date value must be an integer betwen -10485761231 and 10485761231"
+         raise PartialDateError, "Date value must be an integer betwen -10485761231 and 10485761231"
       end
     end
 
@@ -212,10 +214,10 @@ module PartialDate
     # Public: Set the day portion of a partial date. Day is optional so zero, 
     # nil and empty strings are allowed.
     def day=(value)
-      raise DayError, "A month must be set before a day" if month == 0
-
       value = 0 if value.nil?
 
+      raise DayError, "A month must be set before a day" if month == 0 && value !=0
+
       if value.is_a?(String) 
         if value =~ /\A\d{1,2}\z/
           value = value.to_i
@@ -246,8 +248,8 @@ module PartialDate
     # %Y - Year with century (can be negative, 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'')
-    # %b - The abbreviated month name (``Jan'')
+    # %B - The full month name ('January')
+    # %b - The abbreviated month name ('Jan')
     # %d - Day of the month, zero-padded (01..31)
     # %e - Day of the month, blank-padded ( 1..31)
     # 
@@ -261,6 +263,35 @@ module PartialDate
     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 t.length == 0  
+            if n >= 0 && n < s.length - 2
+              a = a + 1 if s[n+2] =~ REMOVALS
+            else
+              b = n - 1 if s[n-1] =~ REMOVALS
+            end
+          end
+          s.slice!(b..n+a)
+          s.insert(b, t)
+          n = b = b + t.length 
+          a = 1 
+        else
+          n = b += 1
+        end
+      end
+      s
+    end
+    
+    # Here for the moment for benchmark comparisons
+    def old_to_s(format = :default)
+      format = FORMATS[format] if format.is_a?(Symbol)
+
       result = format.dup
       FORMAT_METHODS.each_pair do |key, value|
         result.gsub!( key, value.call( self )) if result.include? key
@@ -272,9 +303,9 @@ module PartialDate
       # Remove any trailing "/-," chars.
       # Anything else - you're on your own ;-)
       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/, '')
+        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

data/lib/partial-date/version.rb

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

data/spec/to_s_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+require 'partial-date'
+
+describe PartialDate::Date do
+
+  let(:date) { PartialDate::Date.new }
+
+  describe "to string" do
+    it "should be fast" do
+      date.year = 2012; date.month = 12; date.day = 1
+      puts date.to_s 
+    end
+
+    it "should not have a dash at the end if day is missing" do
+      date.year = 2012; date.month = 12; date.day = 0
+      puts date.to_s 
+    end
+
+    it "it should not have a trailing dash if month and day are missing" do
+      date.year = 2012; date.month = 0; date.day = 0
+      puts date.to_s 
+    end
+
+    it "it should not have a leading dash if year is missing" do
+      date.year = 0; date.month = 12; date.day = 1
+      puts date.to_s 
+    end
+
+    it "it should preserve the minus sign if year is negative" do
+      date.year = -1000; date.month = 12; date.day = 1
+      puts date.to_s 
+    end
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: partial-date
 version: !ruby/object:Gem::Version
-  version: 1.1.9
+  version: 1.1.10
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-30 00:00:00.000000000 Z
+date: 2012-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubygems-tasks
@@ -77,6 +77,9 @@ files:
 - LICENSE.txt
 - README.markdown
 - Rakefile
+- benchmarks/run-benchmarks.rb
+- benchmarks/run-gcprof.rb
+- benchmarks/run-perftools.rb
 - lib/partial-date.rb
 - lib/partial-date/date.rb
 - lib/partial-date/error.rb
@@ -84,6 +87,7 @@ files:
 - partial-date.gemspec
 - spec/date_spec.rb
 - spec/spec_helper.rb
+- spec/to_s_spec.rb
 homepage: https://github.com/58bits/partial-date#readme
 licenses:
 - MIT
@@ -113,3 +117,4 @@ summary: A simple date class that can be used to store partial date values in a
 test_files:
 - spec/date_spec.rb
 - spec/spec_helper.rb
+- spec/to_s_spec.rb