timeframe 0.0.1 → 0.0.2

data/.document

@@ -1,5 +1,5 @@
-README.rdoc
-lib/**/*.rb
-bin/*
-features/**/*.feature
-LICENSE
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -1,21 +1,21 @@
-## MAC OS
-.DS_Store
-
-## TEXTMATE
-*.tmproj
-tmtags
-
-## EMACS
-*~
-\#*
-.\#*
-
-## VIM
-*.swp
-
-## PROJECT::GENERAL
-coverage
-rdoc
-pkg
-
-## PROJECT::SPECIFIC
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -1,20 +1,20 @@
-Copyright (c) 2009 Andy Rossmeissl
-
-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.
+Copyright (c) 2009 Andy Rossmeissl
+
+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.rdoc

@@ -1,13 +1,15 @@
-= timeframe
-
-A Ruby class for describing and interacting with timeframes.
-
-== Documentation
-
-== Acknoweldgements
-
-The good parts of Timeframe all came from the gentlemen at Fingertips[http://fngtps.com].
-
-== Copyright
-
-Copyright (c) 2010 Andy Rossmeissl.
+= timeframe
+
+A Ruby class for describing and interacting with timeframes.
+
+== Documentation
+
+http://rdoc.info/projects/rossmeissl/timeframe
+
+== Acknowledgements
+
+The good parts of Timeframe all came from the gentlemen at Fingertips[http://fngtps.com].
+
+== Copyright
+
+Copyright (c) 2010 Andy Rossmeissl.

data/Rakefile

@@ -1,46 +1,46 @@
-require 'rubygems'
-require 'rake'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "timeframe"
-    gem.summary = %Q{Date intervals}
-    gem.description = %Q{A Ruby class for describing and interacting with timeframes.}
-    gem.email = "andy@rossmeissl.net"
-    gem.homepage = "http://github.com/rossmeissl/timeframe"
-    gem.authors = ["Andy Rossmeissl"]
-    gem.add_development_dependency "rspec", ">= 1.2.9"
-    gem.add_dependency 'activesupport', '= 3.0.0.beta4'
-    gem.add_dependency 'andand'
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
-end
-
-require 'spec/rake/spectask'
-Spec::Rake::SpecTask.new(:spec) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.spec_files = FileList['spec/**/*_spec.rb']
-end
-
-Spec::Rake::SpecTask.new(:rcov) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
-end
-
-task :spec => :check_dependencies
-
-task :default => :spec
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "timeframe #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "timeframe"
+    gem.summary = %Q{Date intervals}
+    gem.description = %Q{A Ruby class for describing and interacting with timeframes.}
+    gem.email = "andy@rossmeissl.net"
+    gem.homepage = "http://github.com/rossmeissl/timeframe"
+    gem.authors = ["Andy Rossmeissl", "Seamus Abshere", "Derek Kastner"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_dependency 'activesupport', '= 3.0.0.beta4'
+    gem.add_dependency 'andand'
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "timeframe #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/lib/timeframe/date_to_json.rb

@@ -0,0 +1,5 @@
+class Date
+  def to_json(*)
+    super nil
+  end
+end

data/lib/timeframe/ykk.rb

@@ -1,4 +1,4 @@
-module Ykk
+module Ykk # :nodoc: all
   def ykk(*arys, &blk) # YKK: a better zipper
     return zip(*arys) unless block_given?
     zip(*arys).collect { |a| yield a }

data/lib/timeframe.rb

@@ -6,11 +6,13 @@ require 'active_support/version'
   active_support/core_ext/date/conversions
   active_support/core_ext/integer/time
   active_support/core_ext/numeric/time
+  active_support/json/encoding
 }.each do |active_support_3_requirement|
   require active_support_3_requirement
 end if ActiveSupport::VERSION::MAJOR == 3
 require 'andand'
 require 'timeframe/ykk'
+require 'timeframe/date_to_json'
 
 # Encapsulates a timeframe between two dates. The dates provided to the class are always until the last date. That means
 # that the last date is excluded.
@@ -77,9 +79,9 @@ class Timeframe
   
   # Returns a string representation of the timeframe
   def to_s
-    if [from.day, from.month, to.day, to.month].uniq == [1]
+    if (from.year == to.year - 1) and [from.day, from.month, to.day, to.month].uniq == [1]
       from.year.to_s
-    elsif from.day == 1 and to.day == 1 and to.month - from.month == 1
+    elsif from.year == to.year and from.day == 1 and to.day == 1 and to.month - from.month == 1
       "#{Date::MONTHNAMES[from.month]} #{from.year}"
     else
       "the period from #{from.strftime('%d %B')} to #{to.yesterday.strftime('%d %B %Y')}"
@@ -120,7 +122,6 @@ class Timeframe
   def hash
     from.hash + to.hash
   end
-  alias :to_param :hash
   
   # Returns an array of month-long subtimeframes
   #--
@@ -250,6 +251,11 @@ class Timeframe
     { :from => from, :to => to }.to_json
   end
   
+  # URL-friendly like "2008-10-25/2009-11-12"
+  def to_param
+    "#{from}/#{to}"
+  end
+  
   class << self
     # Shortcut method to return the Timeframe representing the current year (as defined by Time.now)
     def this_year

data/spec/spec.opts

@@ -1 +1 @@
---color
+--color

data/spec/spec_helper.rb

@@ -1,10 +1,10 @@
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-require 'timeframe'
-require 'spec'
-require 'spec/autorun'
-require 'date'
-
-Spec::Runner.configure do |config|
-  
-end
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'timeframe'
+require 'spec'
+require 'spec/autorun'
+require 'date'
+
+Spec::Runner.configure do |config|
+  
+end

data/spec/timeframe_spec.rb

@@ -1,248 +1,270 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
-require 'date'
-
-describe Timeframe do
-  describe 'initialization' do
-    it 'should create a timeframe using date strings' do
-      tf = Timeframe.new('2008-02-14', '2008-05-10')
-      tf.from.should == Date.parse('2008-02-14')
-      tf.to.should == Date.parse('2008-05-10')
-    end
-    it 'should create a timeframe using date objects' do
-      start = Date.parse('2008-02-14')
-      finish = Date.parse('2008-05-10')
-      tf = Timeframe.new(start, finish)
-      tf.from.should == start
-      tf.to.should == finish
-    end
-    it "should accept months" do
-      timeframe = Timeframe.new(:month => 1)
-      timeframe.from.should == Date.today.change(:month => 1, :day => 1)
-      timeframe.to.should == Date.today.change(:month => 2, :day => 1)
-    end
-    it "should accept month names" do
-      timeframe = Timeframe.new(:month => 'february')
-      timeframe.from.should == Date.today.change(:month => 2, :day => 1)
-      timeframe.to.should == Date.today.change(:month => 3, :day => 1)
-    end
-    it "should accept years" do
-      timeframe = Timeframe.new(:year => 2004)
-      timeframe.from.should == Date.new(2004, 1, 1)
-      timeframe.to.should == Date.new(2005, 1, 1)
-    end
-    it "should accept years and months" do
-      timeframe = Timeframe.new(:year => 2005, :month => 5)
-      timeframe.from.should == Date.new(2005, 5, 1)
-      timeframe.to.should == Date.new(2005, 6, 1)
-    end
-    it "should not accept just one date argument" do
-      lambda {
-        Timeframe.new Date.new(2007, 2, 1)
-      }.should raise_error(ArgumentError, /supply/)
-    end
-    it "should not accept end date that is earlier than start date" do
-      lambda {
-        timeframe = Timeframe.new Date.new(2008, 1, 1), Date.new(2007, 1, 1)
-      }.should raise_error(ArgumentError, /earlier/)
-    end
-    it "should not accept timeframes that cross year boundaries" do
-      lambda {
-        timeframe = Timeframe.new Date.new(2007, 1, 1), Date.new(2008, 1, 2)
-      }.should raise_error(ArgumentError, /cross/)
-    end
-    it "should optionally accept timeframes that cross year boundaries" do
-      lambda {
-        timeframe = Timeframe.new Date.new(2007, 1, 1), Date.new(2008, 1, 2), :skip_year_boundary_crossing_check => true
-      }.should_not raise_error
-    end
-  end
-
-  describe '#inspect' do
-    it 'should return the time frame in readable text' do
-      start = Date.parse('2008-02-14')
-      finish = Date.parse('2008-05-10')
-      tf = Timeframe.new(start, finish)
-      tf.inspect.should =~ /<Timeframe\(-?\d+\) 86 days starting 2008-02-14 ending 2008-05-10>/
-    end
-  end
-
-  describe '.constrained_new' do
-    let(:start) { Date.parse('2008-02-14') }
-    let(:finish) { Date.parse('2008-05-10') }
-    let(:constraint_start) { Date.parse('2008-01-01') }
-    let(:constraint_finish) { Date.parse('2008-12-01') }
-    let(:constraint) { Timeframe.new(constraint_start, constraint_finish) }
-
-    it "should allow for constrained creation" do
-      constraint = Timeframe.new :year => 2008
-      may = Timeframe.new Date.new(2008,5,1), Date.new(2008,6,1)
-      january = Timeframe.new Date.new(2008,1,1), Date.new(2008,2,1)
-      Timeframe.constrained_new(may.from, may.to, constraint).should == may
-      Timeframe.constrained_new(Date.new(2007,1,1), Date.new(2010,1,1), constraint).should == constraint
-      Timeframe.constrained_new(Date.new(2007,11,1), Date.new(2008,2,1), constraint).should == january
-    end
-    it 'should return a timeframe spanning start and end date if within constraint' do
-      tf = Timeframe.constrained_new(start, finish, constraint)
-      tf.from.should == start
-      tf.to.should == finish
-    end
-    it 'should return a timeframe spanning constraint start and end date if outside constraint' do
-      constraint = Timeframe.new(start, finish)
-      tf = Timeframe.constrained_new(constraint_start, constraint_finish, constraint)
-      tf.from.should == start
-      tf.to.should == finish
-    end
-    it 'should return a timeframe starting at constraint start' do
-      start = Date.parse('2008-01-01')
-      constraint_start = Date.parse('2008-01-14')
-      constraint = Timeframe.new(constraint_start, constraint_finish)
-      tf = Timeframe.constrained_new(start, finish, constraint)
-      tf.from.should == constraint_start
-      tf.to.should == finish
-    end
-    it 'should return a timeframe ending at constraint end' do
-      constraint_finish = Date.parse('2008-04-14')
-      constraint = Timeframe.new(constraint_start, constraint_finish)
-      tf = Timeframe.constrained_new(start, finish, constraint)
-      tf.from.should == start
-      tf.to.should == constraint_finish
-    end
-    it "should return a 0-length timeframe when constraining a timeframe by a disjoint timeframe" do
-      constraint = Timeframe.new :year => 2010
-      timeframe = Timeframe.constrained_new(
-        Date.new(2009,1,1), Date.new(2010,1,1), constraint)
-      timeframe.days.should == 0
-    end
-  end
-
-  describe '.this_year' do
-    it "should return the current year" do
-      Timeframe.this_year.should == Timeframe.new(:year => Time.now.year)
-    end
-  end
-
-  describe '#days' do
-    it "should return them number of days included" do
-      #TODO: make these separate "it" blocks, per best practices
-      Timeframe.new(Date.new(2007, 1, 1), Date.new(2008, 1, 1)).days.should == 365
-      Timeframe.new(Date.new(2008, 1, 1), Date.new(2009, 1, 1)).days.should == 366 #leap year
-      Timeframe.new(Date.new(2007, 11, 1), Date.new(2007, 12, 1)).days.should == 30
-      Timeframe.new(Date.new(2007, 11, 1), Date.new(2008, 1, 1)).days.should == 61
-      Timeframe.new(Date.new(2007, 2, 1), Date.new(2007, 3, 1)).days.should == 28
-      Timeframe.new(Date.new(2008, 2, 1), Date.new(2008, 3, 1)).days.should == 29
-      Timeframe.new(Date.new(2008, 2, 1), Date.new(2008, 2, 1)).days.should == 0
-    end
-  end
-
-  describe '#include?' do
-    it "should know if a certain date is included in the Timeframe" do
-      #TODO: make these separate "it" blocks, per best practices
-      timeframe = Timeframe.new :year => 2008, :month => 2
-      [
-        Date.new(2008, 2, 1),
-        Date.new(2008, 2, 5),
-        Date.new(2008, 2, 29)
-      ].each do |date|
-        timeframe.include?(date).should == true
-      end
-      [
-        Date.new(2008, 1, 1),
-        Date.new(2007, 2, 1),
-        Date.new(2008, 3, 1)
-      ].each do |date|
-        timeframe.include?(date).should == false
-      end
-    end
-  end
-
-  describe '#==' do
-    it "should be able to know if it's equal to another Timeframe object" do
-      Timeframe.new(:year => 2007).should == Timeframe.new(:year => 2007)
-      Timeframe.new(:year => 2004, :month => 1).should == Timeframe.new(:year => 2004, :month => 1)
-    end
-    
-    it "should hash equal hash values when the timeframe is equal" do
-      Timeframe.new(:year => 2007).hash.should == Timeframe.new(:year => 2007).hash
-      Timeframe.new(:year => 2004, :month => 1).hash.should == Timeframe.new(:year => 2004, :month => 1).hash
-    end
-  end
-
-  describe '#months' do
-    it "should return an array of month-long subtimeframes" do
-      Timeframe.new(:year => 2009).months.length.should == 12
-    end
-    it "should not return an array of month-long subtimeframes if provided an inappropriate range" do
-      lambda { 
-        Timeframe.new(Date.new(2009, 3, 2), Date.new(2009, 3, 5)).months
-      }.should raise_error(ArgumentError, /whole/)
-      lambda {
-        Timeframe.new(Date.new(2009, 1, 1), Date.new(2012, 1, 1), :skip_year_boundary_crossing_check => true).months
-      }.should raise_error(ArgumentError, /dangerous during/)
-    end
-  end
-
-  describe '#year' do
-    it "should return the relevant year of a timeframe" do
-      Timeframe.new(Date.new(2009, 2, 1), Date.new(2009, 4, 1)).year.should == Timeframe.new(:year => 2009)
-    end
-    it "should not return the relevant year of a timeframe if provided an inappropriate range" do
-      lambda {
-        Timeframe.new(Date.new(2009, 1, 1), Date.new(2012, 1, 1), :skip_year_boundary_crossing_check => true).year
-      }.should raise_error(ArgumentError, /dangerous during/)
-    end
-  end
-
-  describe '#&' do
-    it "should return its intersection with another timeframe" do
-      #TODO: make these separate "it" blocks, per best practices
-      (Timeframe.new(:month => 4) & Timeframe.new(:month => 6)).should be_nil
-      (Timeframe.new(:month => 4) & Timeframe.new(:month => 5)).should be_nil
-      (Timeframe.new(:month => 4) & Timeframe.new(:month => 4)).should == Timeframe.new(:month => 4)
-      (Timeframe.new(:year => Time.now.year) & Timeframe.new(:month => 4)).should == Timeframe.new(:month => 4)
-      (Timeframe.new(Date.new(2009, 2, 1), Date.new(2009, 6, 1)) & Timeframe.new(Date.new(2009, 4, 1), Date.new(2009, 8, 1))).should == Timeframe.new(Date.new(2009, 4, 1), Date.new(2009, 6, 1))
-    end
-  end
-
-  describe '#/' do
-    it "should return a fraction of another timeframe" do 
-      (Timeframe.new(:month => 4, :year => 2009) / Timeframe.new(:year => 2009)).should == (30.0 / 365.0)
-    end
-  end
-
-  describe '#gaps_left_by' do
-    it "should be able to ascertain gaps left by a list of other Timeframes" do
-      Timeframe.new(:year => 2009).gaps_left_by(
-        Timeframe.new(:year => 2009, :month => 3),
-        Timeframe.new(:year => 2009, :month => 5),
-        Timeframe.new(Date.new(2009, 8, 1), Date.new(2009, 11, 1)),
-        Timeframe.new(Date.new(2009, 9, 1), Date.new(2009, 10, 1))
-      ).should == 
-        [ Timeframe.new(Date.new(2009, 1, 1), Date.new(2009, 3, 1)),
-          Timeframe.new(Date.new(2009, 4, 1), Date.new(2009, 5, 1)),
-          Timeframe.new(Date.new(2009, 6, 1), Date.new(2009, 8, 1)),
-          Timeframe.new(Date.new(2009, 11, 1), Date.new(2010, 1, 1)) ]
-    end
-  end
-
-  describe '#covered_by?' do
-    it "should be able to ascertain gaps left by a list of other Timeframes" do
-      Timeframe.new(:year => 2009).covered_by?(
-        Timeframe.new(:month => 1, :year => 2009), 
-        Timeframe.new(Date.new(2009, 2, 1), Date.new(2010, 1, 1))
-      ).should be_true
-    end
-  end
-
-  describe '#last_year' do
-    it "should return its predecessor in a previous year" do
-      Timeframe.this_year.last_year.should ==
-        Timeframe.new(Date.new(Date.today.year - 1, 1, 1), Date.new(Date.today.year, 1, 1))
-    end
-  end
-  
-  describe 'Timeframe:class#interval' do
-    it 'should parse ISO 8601 interval format' do
-      Timeframe.interval('2009-01-01/2010-01-01').should == Timeframe.new(:year => 2009)
-    end
-  end
-end
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'date'
+
+describe Timeframe do
+  describe 'initialization' do
+    it 'should create a timeframe using date strings' do
+      tf = Timeframe.new('2008-02-14', '2008-05-10')
+      tf.from.should == Date.parse('2008-02-14')
+      tf.to.should == Date.parse('2008-05-10')
+    end
+    it 'should create a timeframe using date objects' do
+      start = Date.parse('2008-02-14')
+      finish = Date.parse('2008-05-10')
+      tf = Timeframe.new(start, finish)
+      tf.from.should == start
+      tf.to.should == finish
+    end
+    it "should accept months" do
+      timeframe = Timeframe.new(:month => 1)
+      timeframe.from.should == Date.today.change(:month => 1, :day => 1)
+      timeframe.to.should == Date.today.change(:month => 2, :day => 1)
+    end
+    it "should accept month names" do
+      timeframe = Timeframe.new(:month => 'february')
+      timeframe.from.should == Date.today.change(:month => 2, :day => 1)
+      timeframe.to.should == Date.today.change(:month => 3, :day => 1)
+    end
+    it "should accept years" do
+      timeframe = Timeframe.new(:year => 2004)
+      timeframe.from.should == Date.new(2004, 1, 1)
+      timeframe.to.should == Date.new(2005, 1, 1)
+    end
+    it "should accept years and months" do
+      timeframe = Timeframe.new(:year => 2005, :month => 5)
+      timeframe.from.should == Date.new(2005, 5, 1)
+      timeframe.to.should == Date.new(2005, 6, 1)
+    end
+    it "should not accept just one date argument" do
+      lambda {
+        Timeframe.new Date.new(2007, 2, 1)
+      }.should raise_error(ArgumentError, /supply/)
+    end
+    it "should not accept end date that is earlier than start date" do
+      lambda {
+        timeframe = Timeframe.new Date.new(2008, 1, 1), Date.new(2007, 1, 1)
+      }.should raise_error(ArgumentError, /earlier/)
+    end
+    it "should not accept timeframes that cross year boundaries" do
+      lambda {
+        timeframe = Timeframe.new Date.new(2007, 1, 1), Date.new(2008, 1, 2)
+      }.should raise_error(ArgumentError, /cross/)
+    end
+    it "should optionally accept timeframes that cross year boundaries" do
+      lambda {
+        timeframe = Timeframe.new Date.new(2007, 1, 1), Date.new(2008, 1, 2), :skip_year_boundary_crossing_check => true
+      }.should_not raise_error
+    end
+  end
+
+  describe '#inspect' do
+    it 'should return the time frame in readable text' do
+      start = Date.parse('2008-02-14')
+      finish = Date.parse('2008-05-10')
+      tf = Timeframe.new(start, finish)
+      tf.inspect.should =~ /<Timeframe\(-?\d+\) 86 days starting 2008-02-14 ending 2008-05-10>/
+    end
+  end
+
+  describe '.constrained_new' do
+    let(:start) { Date.parse('2008-02-14') }
+    let(:finish) { Date.parse('2008-05-10') }
+    let(:constraint_start) { Date.parse('2008-01-01') }
+    let(:constraint_finish) { Date.parse('2008-12-01') }
+    let(:constraint) { Timeframe.new(constraint_start, constraint_finish) }
+
+    it "should allow for constrained creation" do
+      constraint = Timeframe.new :year => 2008
+      may = Timeframe.new Date.new(2008,5,1), Date.new(2008,6,1)
+      january = Timeframe.new Date.new(2008,1,1), Date.new(2008,2,1)
+      Timeframe.constrained_new(may.from, may.to, constraint).should == may
+      Timeframe.constrained_new(Date.new(2007,1,1), Date.new(2010,1,1), constraint).should == constraint
+      Timeframe.constrained_new(Date.new(2007,11,1), Date.new(2008,2,1), constraint).should == january
+    end
+    it 'should return a timeframe spanning start and end date if within constraint' do
+      tf = Timeframe.constrained_new(start, finish, constraint)
+      tf.from.should == start
+      tf.to.should == finish
+    end
+    it 'should return a timeframe spanning constraint start and end date if outside constraint' do
+      constraint = Timeframe.new(start, finish)
+      tf = Timeframe.constrained_new(constraint_start, constraint_finish, constraint)
+      tf.from.should == start
+      tf.to.should == finish
+    end
+    it 'should return a timeframe starting at constraint start' do
+      start = Date.parse('2008-01-01')
+      constraint_start = Date.parse('2008-01-14')
+      constraint = Timeframe.new(constraint_start, constraint_finish)
+      tf = Timeframe.constrained_new(start, finish, constraint)
+      tf.from.should == constraint_start
+      tf.to.should == finish
+    end
+    it 'should return a timeframe ending at constraint end' do
+      constraint_finish = Date.parse('2008-04-14')
+      constraint = Timeframe.new(constraint_start, constraint_finish)
+      tf = Timeframe.constrained_new(start, finish, constraint)
+      tf.from.should == start
+      tf.to.should == constraint_finish
+    end
+    it "should return a 0-length timeframe when constraining a timeframe by a disjoint timeframe" do
+      constraint = Timeframe.new :year => 2010
+      timeframe = Timeframe.constrained_new(
+        Date.new(2009,1,1), Date.new(2010,1,1), constraint)
+      timeframe.days.should == 0
+    end
+  end
+
+  describe '.this_year' do
+    it "should return the current year" do
+      Timeframe.this_year.should == Timeframe.new(:year => Time.now.year)
+    end
+  end
+
+  describe '#days' do
+    it "should return them number of days included" do
+      #TODO: make these separate "it" blocks, per best practices
+      Timeframe.new(Date.new(2007, 1, 1), Date.new(2008, 1, 1)).days.should == 365
+      Timeframe.new(Date.new(2008, 1, 1), Date.new(2009, 1, 1)).days.should == 366 #leap year
+      Timeframe.new(Date.new(2007, 11, 1), Date.new(2007, 12, 1)).days.should == 30
+      Timeframe.new(Date.new(2007, 11, 1), Date.new(2008, 1, 1)).days.should == 61
+      Timeframe.new(Date.new(2007, 2, 1), Date.new(2007, 3, 1)).days.should == 28
+      Timeframe.new(Date.new(2008, 2, 1), Date.new(2008, 3, 1)).days.should == 29
+      Timeframe.new(Date.new(2008, 2, 1), Date.new(2008, 2, 1)).days.should == 0
+    end
+  end
+
+  describe '#include?' do
+    it "should know if a certain date is included in the Timeframe" do
+      #TODO: make these separate "it" blocks, per best practices
+      timeframe = Timeframe.new :year => 2008, :month => 2
+      [
+        Date.new(2008, 2, 1),
+        Date.new(2008, 2, 5),
+        Date.new(2008, 2, 29)
+      ].each do |date|
+        timeframe.include?(date).should == true
+      end
+      [
+        Date.new(2008, 1, 1),
+        Date.new(2007, 2, 1),
+        Date.new(2008, 3, 1)
+      ].each do |date|
+        timeframe.include?(date).should == false
+      end
+    end
+  end
+
+  describe '#==' do
+    it "should be able to know if it's equal to another Timeframe object" do
+      Timeframe.new(:year => 2007).should == Timeframe.new(:year => 2007)
+      Timeframe.new(:year => 2004, :month => 1).should == Timeframe.new(:year => 2004, :month => 1)
+    end
+    
+    it "should hash equal hash values when the timeframe is equal" do
+      Timeframe.new(:year => 2007).hash.should == Timeframe.new(:year => 2007).hash
+      Timeframe.new(:year => 2004, :month => 1).hash.should == Timeframe.new(:year => 2004, :month => 1).hash
+    end
+  end
+
+  describe '#months' do
+    it "should return an array of month-long subtimeframes" do
+      Timeframe.new(:year => 2009).months.length.should == 12
+    end
+    it "should not return an array of month-long subtimeframes if provided an inappropriate range" do
+      lambda { 
+        Timeframe.new(Date.new(2009, 3, 2), Date.new(2009, 3, 5)).months
+      }.should raise_error(ArgumentError, /whole/)
+      lambda {
+        Timeframe.new(Date.new(2009, 1, 1), Date.new(2012, 1, 1), :skip_year_boundary_crossing_check => true).months
+      }.should raise_error(ArgumentError, /dangerous during/)
+    end
+  end
+
+  describe '#year' do
+    it "should return the relevant year of a timeframe" do
+      Timeframe.new(Date.new(2009, 2, 1), Date.new(2009, 4, 1)).year.should == Timeframe.new(:year => 2009)
+    end
+    it "should not return the relevant year of a timeframe if provided an inappropriate range" do
+      lambda {
+        Timeframe.new(Date.new(2009, 1, 1), Date.new(2012, 1, 1), :skip_year_boundary_crossing_check => true).year
+      }.should raise_error(ArgumentError, /dangerous during/)
+    end
+  end
+
+  describe '#&' do
+    it "should return its intersection with another timeframe" do
+      #TODO: make these separate "it" blocks, per best practices
+      (Timeframe.new(:month => 4) & Timeframe.new(:month => 6)).should be_nil
+      (Timeframe.new(:month => 4) & Timeframe.new(:month => 5)).should be_nil
+      (Timeframe.new(:month => 4) & Timeframe.new(:month => 4)).should == Timeframe.new(:month => 4)
+      (Timeframe.new(:year => Time.now.year) & Timeframe.new(:month => 4)).should == Timeframe.new(:month => 4)
+      (Timeframe.new(Date.new(2009, 2, 1), Date.new(2009, 6, 1)) & Timeframe.new(Date.new(2009, 4, 1), Date.new(2009, 8, 1))).should == Timeframe.new(Date.new(2009, 4, 1), Date.new(2009, 6, 1))
+    end
+  end
+
+  describe '#/' do
+    it "should return a fraction of another timeframe" do 
+      (Timeframe.new(:month => 4, :year => 2009) / Timeframe.new(:year => 2009)).should == (30.0 / 365.0)
+    end
+  end
+
+  describe '#gaps_left_by' do
+    it "should be able to ascertain gaps left by a list of other Timeframes" do
+      Timeframe.new(:year => 2009).gaps_left_by(
+        Timeframe.new(:year => 2009, :month => 3),
+        Timeframe.new(:year => 2009, :month => 5),
+        Timeframe.new(Date.new(2009, 8, 1), Date.new(2009, 11, 1)),
+        Timeframe.new(Date.new(2009, 9, 1), Date.new(2009, 10, 1))
+      ).should == 
+        [ Timeframe.new(Date.new(2009, 1, 1), Date.new(2009, 3, 1)),
+          Timeframe.new(Date.new(2009, 4, 1), Date.new(2009, 5, 1)),
+          Timeframe.new(Date.new(2009, 6, 1), Date.new(2009, 8, 1)),
+          Timeframe.new(Date.new(2009, 11, 1), Date.new(2010, 1, 1)) ]
+    end
+  end
+
+  describe '#covered_by?' do
+    it "should be able to ascertain gaps left by a list of other Timeframes" do
+      Timeframe.new(:year => 2009).covered_by?(
+        Timeframe.new(:month => 1, :year => 2009), 
+        Timeframe.new(Date.new(2009, 2, 1), Date.new(2010, 1, 1))
+      ).should be_true
+    end
+  end
+
+  describe '#last_year' do
+    it "should return its predecessor in a previous year" do
+      Timeframe.this_year.last_year.should ==
+        Timeframe.new(Date.new(Date.today.year - 1, 1, 1), Date.new(Date.today.year, 1, 1))
+    end
+  end
+  
+  describe 'Timeframe:class#interval' do
+    it 'should parse ISO 8601 interval format' do
+      Timeframe.interval('2009-01-01/2010-01-01').should == Timeframe.new(:year => 2009)
+    end
+    it 'should understand its own #to_param' do
+      t = Timeframe.new(:year => 2009)
+      Timeframe.interval(t.to_param).should == t
+    end
+  end
+  
+  describe '#to_json' do
+    it 'should generate JSON' do
+      Timeframe.new(:year => 2009).to_json.should == "{\"from\":\"2009-01-01\",\"to\":\"2010-01-01\"}"
+    end
+  end
+  
+  describe '#to_param' do
+    it 'should generate a URL-friendly parameter' do
+      Timeframe.new(:year => 2009).to_param.should == "2009-01-01/2010-01-01"
+    end
+  end
+  
+  describe '#to_s' do
+    it 'should not only look at month numbers when describing multi-year timeframes' do
+      Timeframe.multiyear(Date.parse('2008-01-01'), Date.parse('2010-01-01')).to_s.should == "the period from 01 January to 31 December 2009"
+    end
+  end
+end

data/timeframe.gemspec

@@ -0,0 +1,63 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{timeframe}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Andy Rossmeissl", "Seamus Abshere", "Derek Kastner"]
+  s.date = %q{2010-07-16}
+  s.description = %q{A Ruby class for describing and interacting with timeframes.}
+  s.email = %q{andy@rossmeissl.net}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/timeframe.rb",
+     "lib/timeframe/date_to_json.rb",
+     "lib/timeframe/ykk.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "spec/timeframe_spec.rb",
+     "timeframe.gemspec"
+  ]
+  s.homepage = %q{http://github.com/rossmeissl/timeframe}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Date intervals}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/timeframe_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_runtime_dependency(%q<activesupport>, ["= 3.0.0.beta4"])
+      s.add_runtime_dependency(%q<andand>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<activesupport>, ["= 3.0.0.beta4"])
+      s.add_dependency(%q<andand>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<activesupport>, ["= 3.0.0.beta4"])
+    s.add_dependency(%q<andand>, [">= 0"])
+  end
+end
+

metadata

@@ -1,29 +1,34 @@
 --- !ruby/object:Gem::Specification 
 name: timeframe
 version: !ruby/object:Gem::Version 
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Andy Rossmeissl
+- Seamus Abshere
+- Derek Kastner
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-07-15 00:00:00 -04:00
+date: 2010-07-16 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 13
         segments: 
         - 1
         - 2
@@ -35,9 +40,11 @@ dependencies:
   name: activesupport
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
+        hash: 299253624
         segments: 
         - 3
         - 0
@@ -50,9 +57,11 @@ dependencies:
   name: andand
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -75,10 +84,12 @@ files:
 - Rakefile
 - VERSION
 - lib/timeframe.rb
+- lib/timeframe/date_to_json.rb
 - lib/timeframe/ykk.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 - spec/timeframe_spec.rb
+- timeframe.gemspec
 has_rdoc: true
 homepage: http://github.com/rossmeissl/timeframe
 licenses: []
@@ -89,23 +100,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Date intervals