funtimes 0.1.0

data/.document

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

data/.gitignore

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Len Smith
+
+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

@@ -0,0 +1,12 @@
+= funtimes
+
+Library for working with months, quarters and date ranges in Ruby.
+
+include DateRange in any class with a start_date and end_date and be able to iterate over months and days.
+
+Look in the specs for the, uhm, specs.
+
+== Copyright
+
+Copyright (c) 2010 Len Smith. 
+

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "funtimes"
+    gem.summary = %Q{Manage date ranges, months and quarters}
+    gem.description = %Q{Manage date ranges, months and quarters}
+    gem.email = "ignu.smith@gmail.com"
+    gem.homepage = "http://github.com/ignu/fun-times"
+    gem.authors = ["Len Smith"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  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 = "funtimes #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/funtimes.gemspec

@@ -0,0 +1,62 @@
+# 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{funtimes}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Len Smith"]
+  s.date = %q{2010-07-02}
+  s.description = %q{Manage date ranges, months and quarters}
+  s.email = %q{ignu.smith@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "funtimes.gemspec",
+     "lib/date_range.rb",
+     "lib/funtimes.rb",
+     "lib/month.rb",
+     "lib/quarter.rb",
+     "spec/date_range_spec.rb",
+     "spec/month_spec.rb",
+     "spec/quarter_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/ignu/fun-times}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Manage date ranges, months and quarters}
+  s.test_files = [
+    "spec/date_range_spec.rb",
+     "spec/month_spec.rb",
+     "spec/quarter_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

data/lib/date_range.rb

@@ -0,0 +1,78 @@
+module DateRange 
+ 
+  def days
+    (_start)..(_end)
+  end
+
+  def months
+    return [] unless _start && _end
+    (Month.from(_start)..Month.from(_end))
+  end
+
+  def quarters
+    return [] unless _start && _end
+    (Quarter.from(_start)..Quarter.from(_end))
+  end
+
+  def encompasses(other)
+    _start <= other.start_date && _end >= other.end_date 
+  end
+
+  def intersects(other) 
+    other.encompasses(self) || encompasses(other) || overlaps(other)
+  end
+
+  def & (other)
+    return [] unless intersects other
+    return other if encompasses(other)
+    return self if other.encompasses(self)
+    return SimpleRange.new(other.start_date, _end) if overlaps_left_side(other)
+    SimpleRange.new(_start, other.end_date)
+  end
+
+  def same_range_as(other) 
+    other.start_date == _start && other.end_date == _end
+  end
+
+  def number_of_days_in(other)
+    intersection = (self & other)
+    return 0 if intersection == []
+    intersection.days.to_a.length
+  end
+
+  private
+   
+  def overlaps(other)
+    overlaps_left_side(other) || overlaps_right_side(other)
+  end
+
+  def overlaps_right_side(other)
+    other.start_date <= _start && other.end_date >= _start
+  end
+
+  def overlaps_left_side(other)
+    other.start_date <= _end && other.end_date >= _end
+  end
+
+  def _start
+    @start_date ||= start_date
+    return @start_date.to_datetime if @start_date.respond_to? :to_datetime
+    @start_date
+  end
+
+  def _end 
+    @end_date ||= end_date
+    return @end_date.to_datetime if @end_date.respond_to? :to_datetime
+    @end_date
+  end
+end
+
+class SimpleRange
+  include DateRange
+
+  attr_accessor :start_date, :end_date
+
+  def initialize(date1, date2)
+    @start_date, @end_date = date1, date2
+  end
+end

data/lib/funtimes.rb

@@ -0,0 +1,3 @@
+require 'month'
+require 'date_range'
+require 'quarter'

data/lib/month.rb

@@ -0,0 +1,59 @@
+require 'date'
+require 'date_range'
+class Month
+  include Comparable
+  include DateRange
+  attr_accessor :year, :number, :start_date, :end_date
+ 
+  def self.from(date)
+    Month.new(date.month, date.year)
+  end
+
+  def initialize(month, year)
+    @number, @year = month, year
+    @start_date = DateTime.new(@year, @number, 1)
+    @end_date = DateTime.new(next_months_start.year, next_months_start.month, 1) - 1
+  end
+
+  def to_s
+    "#{name} #{@year}"
+  end
+
+  def name
+    @start_date.strftime("%B")
+  end 
+
+  def <=> (other)
+    return @year <=> other.year unless @year == other.year
+    @number <=> other.number
+  end
+
+  def succ 
+    Month.from next_months_start
+  end
+
+  def prev 
+    return Month.new(12, @year-1) if (@number == 1)
+    Month.new @number-1, @year
+  end
+  
+  def + (amount)
+    rv = self
+    amount.times {rv = rv.succ}
+    rv 
+  end
+
+  def -(amount)
+    rv = self
+    amount.times {rv = rv.prev}
+    rv 
+  end
+
+  private
+
+  def next_months_start
+    return DateTime.new(@year+1, 1, 1) if (@number == 12)
+    DateTime.new(@year, @number+1, 1) 
+  end
+end
+

data/lib/quarter.rb

@@ -0,0 +1,29 @@
+class Quarter
+  include DateRange
+  attr_accessor :number, :year, :start_date, :end_date
+
+  def initialize(q,y) 
+    months = [1, 4, 7, 10]
+    @number, @year = q, y
+    @start_date = DateTime.new(y, months[q-1], 1)
+    @end_date = DateTime.new(y, months[q], 1) - 1 unless q == 4
+    @end_date = DateTime.new(y+1, 1, 1) - 1 if q == 4
+  end
+
+  def self.from(date)
+    new(date.month/4+1, date.year)
+  end
+
+  def succ
+    return Quarter.new(@number+1, @year) unless @number == 4
+    Quarter.new(1, @year+1)
+  end
+
+  def <=> (other)
+    @start_date <=> other.start_date 
+  end
+
+  def to_s
+    "Q#{@number}, #{@year}"
+  end 
+end

data/spec/date_range_spec.rb

@@ -0,0 +1,78 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "DateRange" do
+
+  let(:firstOfYear)  { DateTime.new(2001,1,1) }
+  let(:endOfYear)    { DateTime.new(2001,12,31) }
+  let(:firstOfMarch) { DateTime.new(2001,3,1) }
+  let(:endOfMarch)   { DateTime.new(2001,3,30) }
+  let(:firstOfJuly)  { DateTime.new(2001,7,1) }
+  let(:endOfJuly)    { DateTime.new(2001,7,31) }
+  let(:range)        { SimpleRange.new(DateTime.new(2001,1,1), DateTime.new(2001,7,5))}
+  let(:year)         { SimpleRange.new(firstOfYear, endOfYear)}
+  let(:march)        { SimpleRange.new(firstOfMarch, endOfMarch)}
+  let(:july)         { SimpleRange.new(firstOfJuly, endOfJuly)}
+
+  it "should be equal if start and end dates are the same" do 
+    year.same_range_as(year).should == true 
+  end
+
+  it "should have the quarters in a range" do 
+    year.quarters.first.number.should == 1
+    year.quarters.to_a.length.should == 4
+  end
+
+  it "should count the days in the range" do
+    range.days.to_a.length.should == 31+28+31+30+31+30+5
+  end
+ 
+  it "should be able to get the number of months in a range" do
+    range.months.to_a.length.should == 7
+  end
+
+  describe DateRange, "intersecting dates" do 
+
+    it "should tell if one date range encompasses another" do  
+      year.encompasses(march).should == true 
+      march.encompasses(year).should == false
+      march.encompasses(july).should == false
+    end 
+
+    it "should be able to tell if one date range intersects another" do 
+      year.intersects(march).should == true
+      year.intersects(year).should == true
+      march.intersects(year).should == true
+      march.intersects(july).should == false
+      range.intersects(july).should == true
+      july.intersects(range).should == true
+    end
+
+    it "can return the intersection" do 
+      (year & march).should == march
+      (march & year).should == march
+      (march & march).should == march
+      
+      left = (range & july)
+      left.start_date.should == firstOfJuly
+      left.end_date.should == range.end_date
+      left = (july & range)
+      left.start_date.should == firstOfJuly
+      left.end_date.should == range.end_date
+      
+      (march & july).should == []
+    end
+
+
+    it "can figure out the number of days in" do
+      year.number_of_days_in(march).should == 30
+      march.number_of_days_in(july).should == 0
+    end
+
+    it "returns null collections when start or end date is not set" do 
+      r = SimpleRange.new(nil, DateTime.new)
+      r.months.length.should == 0
+      r = SimpleRange.new(DateTime.new, nil)
+      r.months.length.should == 0
+    end
+  end
+end

data/spec/month_spec.rb

@@ -0,0 +1,41 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Month" do
+  let(:july) {Month.from DateTime.new(1977, 7, 31)}
+  let(:sept) {Month.new 9, 1977}
+
+  it "can initialize the month of a date" do
+    july.to_s.should == "July 1977"
+    july.name.should == "July"
+    july.year.should == 1977 
+    july.number.should == 7
+    july.start_date.should == Date.new(1977, 7, 1) 
+    july.end_date.should == Date.new(1977, 7, 31) 
+  end
+
+  it "can use the less than operator" do
+    july.should be < sept
+  end
+
+  it "can iterate over months" do
+    range = (july..sept)
+    range.first.should == july
+    range.to_a.length.should == 3
+    range.end.should == sept
+  end
+
+  it "can iterate over months when crossing a year barrier" do
+    range = (july..(Month.new(1, 1978)))
+    range.to_a.length.should == 7
+  end
+
+  it "can add and subtract months" do 
+    (july+1).to_s.should == "August 1977"
+    (july-1).to_s.should == "June 1977"
+  end
+
+  it "is a daterange" do 
+    july.days.to_a.length.should == 31
+  end
+
+end

data/spec/quarter_spec.rb

@@ -0,0 +1,45 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Quarter" do
+
+  let (:q1) {Quarter.new(1, 2009)}
+  let (:q2) {Quarter.new(2, 2009)}
+  let (:q3) {Quarter.new(3, 2009)}
+  let (:q4) {Quarter.new(4, 2009)}
+
+  it "can be newed up" do 
+    quarter = Quarter.new(1, 2009)
+    quarter.number.should == 1
+    quarter.year.should == 2009
+  end
+
+  it "can initialize from any date" do 
+    quarter = Quarter.from(DateTime.new(2009, 2, 1))
+    quarter.year.should == 2009
+  end
+
+  it "sets the start date correctly" do 
+    q1.start_date.should == DateTime.new(2009, 1, 1)
+    q2.start_date.should == DateTime.new(2009, 4, 1)
+    q3.start_date.should == DateTime.new(2009, 7, 1)
+    q4.start_date.should == DateTime.new(2009, 10, 1)
+  end
+
+  it "sets the end date correctly" do 
+    q1.end_date.should == DateTime.new(2009, 3, 31)
+    q2.end_date.should == DateTime.new(2009, 6, 30)
+    q3.end_date.should == DateTime.new(2009, 9, 30)
+    q4.end_date.should == DateTime.new(2009, 12, 31)
+  end
+
+  it "can iterate over quarters" do
+    range = (q1..q3)
+    range.first.should == q1
+    range.to_a.length.should == 3
+    range.end.should == q3
+  end
+
+  it "is a daterange" do 
+    q1.months.to_a.length.should == 3
+  end 
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

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

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification 
+name: funtimes
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Len Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-02 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+description: Manage date ranges, months and quarters
+email: ignu.smith@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- funtimes.gemspec
+- lib/date_range.rb
+- lib/funtimes.rb
+- lib/month.rb
+- lib/quarter.rb
+- spec/date_range_spec.rb
+- spec/month_spec.rb
+- spec/quarter_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/ignu/fun-times
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Manage date ranges, months and quarters
+test_files: 
+- spec/date_range_spec.rb
+- spec/month_spec.rb
+- spec/quarter_spec.rb
+- spec/spec_helper.rb