partial-date 0.1.0

data/.document

@@ -0,0 +1,3 @@
+- 
+ChangeLog.textile
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,4 @@
+coverage/
+.yardoc/
+doc/
+pkg/

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/.yardopts

@@ -0,0 +1 @@
+--plugin yard-tomdoc --markup textile --title "PartialDate Documentation" --protected 

data/ChangeLog.textile

@@ -0,0 +1,4 @@
+h3. 0.1.0 / 2012-05-26
+
+* Initial release:
+

data/Guardfile

@@ -0,0 +1,8 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Anthony Bouch
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.textile

@@ -0,0 +1,59 @@
+h1. partial-date
+
+* "Homepage":https://github.com/58bits/partial-date#readme
+* "Issues":https://github.com/58bits/partial-date/issues
+* "Documentation":http://rubydoc.info/gems/partial-date/frames
+
+h2. Description
+
+A simple date class that can be used to store partial date values in a single column/attribute. An example use case would include an archive, or catalogue entry where the complete date is unknown.
+
+h2. Features
+
+PartialDate::Date uses an 8 digit integer to store year, month and day values. Values for month and day are optional.
+
+h2. Examples
+
+bc.. require 'partial-date' 
+
+#Default initializer 
+date = PartialDate::Date.new
+# => 
+date.value
+# => 0
+
+# Initialize from a block of integers
+date = PartialDate::Date.new {|d| d.year = 2012, d.month = 01}
+# => 2012-01
+date.value
+# => 20120100
+
+# Initialize from a block of strings
+date = PartialDate::Date.new {|d| d.year = "2012", d.month = "01"}
+# => 2012-01
+date.value
+# => 20120100
+
+# Initialize from the class load method - for rehydrating a date instance from a stored integer date value.
+date = PartialDate::Date.load 20121201
+# => 2012-12-01
+date.year
+# => 2012
+date.month
+# => 12
+date.day
+# => 1
+
+h2. Install
+
+@$ gem install partial-date@
+
+h2. TODO
+
+Implement @PartialDate::Date.parse@ method for construction from strings.
+
+h2. Copyright
+
+Copyright (c) 2012 Anthony Bouch
+
+See {file:LICENSE.txt} for details.

data/Rakefile

@@ -0,0 +1,40 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'rake'
+
+begin
+  gem 'rubygems-tasks', '~> 0.2'
+  require 'rubygems/tasks'
+
+  Gem::Tasks.new
+rescue LoadError => e
+  warn e.message
+  warn "Run `gem install rubygems-tasks` to install 'rubygems/tasks'."
+end
+
+begin
+  gem 'rspec', '~> 2.4'
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new
+rescue LoadError => e
+  task :spec do
+    abort "Please run `gem install rspec` to install RSpec."
+  end
+end
+
+task :test    => :spec
+task :default => :spec
+
+begin
+  gem 'yard', '~> 0.7'
+  require 'yard'
+
+  YARD::Rake::YardocTask.new  
+rescue LoadError => e
+  task :yard do
+    abort "Please run `gem install yard` to install YARD."
+  end
+end
+task :doc => :yard

data/lib/partial-date.rb

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

data/lib/partial-date/date.rb

@@ -0,0 +1,209 @@
+
+# Public module containing Date, Error and Version types.
+module PartialDate
+
+  # Public: A class for handling partial date storage. Partial dates are stored
+  # as an 8 digit integer with optional month and day values.
+  #
+  # Examples
+  #   
+  #   date = PartialDate::Date.new
+  #   date.year = 2012
+  #   date.month = 12
+  #   date.day = 1
+  #
+  #   date = PartialDate::Date.new {|d| d.year = 2012; d.month = 12; d.day = 1}
+  #
+  #   date = PartialDate::Date.new {|d| d.year = 2012 }
+  #
+  class Date
+
+    # Public: Create a new partial date class from a block of integers
+    # or strings.
+    #
+    # Examples
+    #
+    #   # From integers
+    #   date = PartialDate::Date.new {|d| d.year = 2012; d.month = 12; d.day = 1}
+    #   date.value
+    #   # => 20121201
+    #
+    #   # From strings
+    #   date = PartialDate::Date.new {|d| d.year = "2012"; d.month = "12"; d.day = "1"}
+    #   date.value
+    #   # => 20121201
+    #
+    # Returns a date object.
+    def initialize
+      yield self if block_given?
+    end
+
+
+    # Public: Get the integer date value in partial date format.
+    #
+    # Examples
+    #
+    #   date.year = "2012"
+    #   date.value
+    #   # => 20120000
+    #
+    # Returns an integer representation of a partial date.
+    def value
+      @value ||= 0
+    end
+
+    # Public: Set a date value using an interger in partial date format.
+    #
+    # Examples
+    #
+    #   date.value = 20121200
+    #
+    # Returns nothing  
+    def value=(value)
+      if value.is_a?(Integer) && (value >= 10000 && value <= 99991231)
+        @value = 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.
+    #
+    # 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.
+    #
+    # value - The string or integer value for a year.
+    #
+    # Examples
+    #   date.year = "2000"
+    #   date.value
+    #   # => 20000000
+    #
+    # Returns nothing  
+    def year=(value)
+
+      if value.nil?
+        raise PartialDateError, "Year cannot be nil"
+      end
+
+      if value.is_a?(String) 
+        if value =~ /\A\d{4}\z/
+          value = value.to_i
+        else
+          raise PartialDateError, "Year must be a valid four digit string or integer between 1 and 9999"
+        end
+      end
+
+      if value.is_a?(Integer) && (value <= 9999 && value > 0) 
+        @value = (self.value - self.year) * 10000 + (value * 10000) 
+      else
+        raise PartialDateError, "Year must be an integer between 1 and 9999"
+      end
+    end
+
+    # Public: Get the year from a partial date.
+    def year
+      self.value > 9999 ? (self.value / 10000).abs : 0
+    end
+
+    # Public: Set the month of a partial date.
+    def month=(value)
+
+      raise PartialDateError, "A year must be set before a month" if year == 0
+
+      value = 0 if value.nil?
+
+      if value.is_a?(String) 
+        if value =~ /\A\d{1,2}\z/ 
+          value = value.to_i
+        else
+          raise PartialDateError, "Month must be a valid one or two digit string or integer between 1 and 12"
+        end
+      end
+
+      if value.is_a?(Integer) && (value <= 12 && value >= 0)
+        @value  = self.value - (self.month * 100) + (value * 100)
+      else
+        raise PartialDateError, "Month must an be integer between 1 and 12"
+      end
+    end
+
+    # Public: Get the month from a partial date.
+    def month
+      self.value > 99 ? ((self.value - (self.value / 10000).abs * 10000) / 100).abs : 0
+    end
+
+
+    # Public: Set the day portion of a partial date. Day is optional so zero, 
+    # nil and empty strings are allowed.
+    def day=(value)
+
+      raise PartialDateError, "A year and month must be set before a day" if year == 0 && month == 0
+
+      value = 0 if value.nil?
+
+      if value.is_a?(String) 
+        if value =~ /\A\d{1,2}\z/
+          value = value.to_i
+        else
+          raise PartialDateError, "Day must be a valid one or two digit string or integer between 1 and 31"
+        end
+      end
+
+      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)
+        rescue 
+          raise PartialDateError, "Day must be a valid day for the given month"
+        end
+      else
+        raise PartialDateError, "Day must be an integer between 1 and 31"
+      end
+    end
+
+    # Public: Get the day from a partial date.
+    def day
+      self.value > 0 ? self.value - (self.value / 100).abs * 100 : 0
+    end
+
+    # Public: Returns a formatted string representation of the partial date.
+    #
+    # Examples
+    #   
+    #   date = PartialDate::Date.new {|d| d.year = 2012, d.month = 12, d.day = 31}
+    #   date.to_s
+    #   # => "2012-12-31"
+    #
+    # Returns string representation of date.
+    def to_s
+      if self.year > 0
+        result = self.year.to_s 
+        result = result + "-" + self.month.to_s if self.month > 0
+        result = result + "-" + self.day.to_s if self.day > 0
+        return result
+      else
+        return ""
+      end
+    end
+  end
+end

data/lib/partial-date/error.rb

@@ -0,0 +1,4 @@
+module PartialDate
+  class PartialDateError < StandardError
+  end
+end

data/lib/partial-date/version.rb

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

data/partial-date.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+
+require File.expand_path('../lib/partial-date/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "partial-date"
+  gem.version       = PartialDate::VERSION
+  gem.summary       = "A simple date class that can be used to store partial date values in a single column/attribute." 
+  gem.description   = "A simple date class that can be used to store partial date values in a single column/attribute. An example use case would include an archive, or catalogue entry where the complete date is unknown."
+  gem.license       = "MIT"
+  gem.authors       = ["Anthony Bouch"]
+  gem.email         = ["tony@58bits.com"]
+  gem.homepage      = "https://github.com/58bits/partial-date#readme"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency "rubygems-tasks", "~> 0.2"
+  gem.add_development_dependency "rspec", "~> 2.4"
+  gem.add_development_dependency "yard", "~> 0.7"
+end

data/spec/partial-date_spec.rb

@@ -0,0 +1,167 @@
+require 'spec_helper'
+require 'partial-date'
+
+describe PartialDate::Date do
+
+  let(:date) { PartialDate::Date.new }
+
+  it "should have a VERSION constant" do
+    PartialDate.const_get('VERSION').should_not be_empty
+  end
+
+  it "should have a readable value attribute" do
+    date.year = 2000
+    date.value.should == 20000000
+  end
+
+  it "should allow construction from a block of integers" do
+    new_date = PartialDate::Date.new {|d| d.year = 2010; d.month = 12; d.day = 1}
+    new_date.value.should == 20101201
+  end
+
+  it "should allow construction from a block of strings" do
+    new_date = PartialDate::Date.new {|d| d.year = "2010"; d.month = "12"; d.day = "1"}
+    new_date.value.should == 20101201
+  end
+
+  it "should allow construction from the class load method" do
+    new_date = PartialDate::Date.load(20120000)
+    new_date.year.should == 2012
+    new_date.month.should == 0
+    new_date.day.should == 0
+  end
+
+  it "should allow a date value in partial date format to be set in a date instance" do
+    new_date = PartialDate::Date.new {|d| d.value = 20120000}
+    new_date.year.should == 2012
+    new_date.month.should == 0
+    new_date.day.should == 0
+    new_date.value.should == 20120000
+  end
+
+  it "should not allow an invalid date value to be set in a date instance" do
+    expect {new_date = PartialDate::Date.new {|d| d.value = 100000000}}.to raise_error(PartialDate::PartialDateError, "Date value must be an integer betwen 10000 and 99991231")
+  end
+
+  it "should return a string represntation of date in the correct format" do
+    new_date = PartialDate::Date.new {|d| d.year = 2012; d.month = 12; d.day = 31}
+    new_date.to_s.should match(/\A\d{4}-\d{2}-\d{2}\z/)
+  end
+
+  it "should return a string represntation of a partial date in the correct format" do
+    new_date = PartialDate::Date.new {|d| d.year = 2012; d.month = 12}
+    new_date.to_s.should match(/\A\d{4}-\d{2}\z/)
+  end
+
+  it "should return a string represntation of a partial date in the correct format" do
+    new_date = PartialDate::Date.new {|d| d.year = 2012}
+    new_date.to_s.should match(/\A\d{4}\z/)
+  end
+
+  describe "Year" do
+    it "should raise an error if year is set to nil" do
+      expect {date.year = nil}.to raise_error(PartialDate::PartialDateError)
+    end
+
+    it "should raise an error if year is set to an invalid string" do
+      expect {date.year = "ABCD" }.to raise_error(PartialDate::PartialDateError, "Year must be a valid four digit string or integer between 1 and 9999")
+    end
+
+    it "should raise an error if year is set to a five digit string" do
+      expect {date.year = "10000" }.to raise_error(PartialDate::PartialDateError, "Year must be a valid four digit string or integer between 1 and 9999")
+    end
+
+    it "should raise an error if year is set to a value greater than 9999" do
+      expect {date.year = 10000 }.to raise_error(PartialDate::PartialDateError, "Year must be an integer between 1 and 9999")
+    end
+
+    it "should raise an error if year is set to zero" do
+      expect {date.year = 0 }.to raise_error(PartialDate::PartialDateError, "Year must be an integer between 1 and 9999")
+    end
+
+    it "should raise an error if year is set to a value less than zero" do
+      expect {date.year = -1 }.to raise_error(PartialDate::PartialDateError, "Year must be an integer between 1 and 9999")
+    end
+
+    it "should return a year when a year is set" do
+      date.year = 2050
+      date.year.should == 2050
+    end
+  end
+
+  describe "Month" do
+    before(:each) { date.year = 2000 }
+
+    it "should raise an error if a month is set before a year" do
+      no_year = PartialDate::Date.new
+      expect {no_year.month = 10}.to raise_error(PartialDate::PartialDateError, "A year must be set before a month")
+    end
+
+    it "should raise an error if month is set to an invalid string" do
+      expect {date.month = "AB"}.to raise_error(PartialDate::PartialDateError, "Month must be a valid one or two digit string or integer between 1 and 12")
+    end
+
+    it "should raise an error if month is set to a value greater than 12" do
+      expect {date.month = 13}.to raise_error(PartialDate::PartialDateError, "Month must an be integer between 1 and 12")
+    end
+
+    it "should raise an error if month is set to a value less than zero" do
+      expect {date.month = -1}.to raise_error(PartialDate::PartialDateError, "Month must an be integer between 1 and 12")
+    end
+
+    it "should allow the month to be set to zero" do
+      date.month = 0
+      date.month.should == 0
+    end
+
+    it "should return zero if month is set to nil" do
+      date.month = nil
+      date.month.should == 0
+    end
+
+    it "should return a month when a month is set" do
+      date.month = 10
+      date.month.should == 10
+    end
+  end
+
+  describe "Day" do
+    before(:each) { date.year = 2000; date.month = 6 }
+
+    it "should raise an error if a day is set before a year and month" do
+      no_month = PartialDate::Date.new
+      expect {no_month.day = 10}.to raise_error(PartialDate::PartialDateError, "A year and month must be set before a day")
+    end
+
+    it "should raise an error if day is set to an invalid string" do
+      expect {date.day = "AB"}.to raise_error(PartialDate::PartialDateError, "Day must be a valid one or two digit string or integer between 1 and 31")
+    end
+
+    it "should raise an error if day is set to a value less than zero" do
+      expect {date.day = -1}.to raise_error(PartialDate::PartialDateError, "Day must be an integer between 1 and 31")
+    end
+
+    it "should raise an error if day is set to a value greater than 31" do
+      expect {date.day = 32}.to raise_error(PartialDate::PartialDateError, "Day must be an integer between 1 and 31")
+    end
+
+    it "should raise an error if the day is an invalid day for the given month" do
+      expect {date.day = 31}.to raise_error(PartialDate::PartialDateError, "Day must be a valid day for the given month")
+    end
+
+    it "should return zero when set to nil" do
+      date.day = nil
+      date.day.should == 0
+    end
+
+    it "should allow the day to be set to zero" do
+      date.day = 0
+      date.day.should == 0
+    end
+
+    it "should return a day when a day is set" do
+      date.day = 10
+      date.day.should == 10
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+gem 'rspec', '~> 2.4'
+require 'rspec'
+require 'partial-date/version'
+

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: partial-date
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Anthony Bouch
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubygems-tasks
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+description: A simple date class that can be used to store partial date values in
+  a single column/attribute. An example use case would include an archive, or catalogue
+  entry where the complete date is unknown.
+email:
+- tony@58bits.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .document
+- .gitignore
+- .rspec
+- .yardopts
+- ChangeLog.textile
+- Guardfile
+- LICENSE.txt
+- README.textile
+- Rakefile
+- lib/partial-date.rb
+- lib/partial-date/date.rb
+- lib/partial-date/error.rb
+- lib/partial-date/version.rb
+- partial-date.gemspec
+- spec/partial-date_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/58bits/partial-date#readme
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A simple date class that can be used to store partial date values in a single
+  column/attribute.
+test_files:
+- spec/partial-date_spec.rb
+- spec/spec_helper.rb