scheduling 0.1.1 → 0.1.2

data/ChangeLog.rdoc

@@ -1,4 +1,8 @@
-=== 0.1.0 / 2013-08-16
+=== 0.1.1 / 2013-08-19
 
 * Initial release:
 
+=== 0.1.2 / 2013-08-19
+
+Add Quarterly regularity class, which brings Date.quarterly, Date.q1, Date.q2, Date.q3, Date.q4, Date#qday, Date#quarter, and Date#next_quarter.
+

data/README.rdoc

@@ -6,7 +6,7 @@
 
 == Description
 
-Plan and keep track of project/activity scheduling, including budgeting and accounting.
+Classes for making schedules, that are regular (yearly, monthly, quarterly, etc.), irregular, or both (compound). Once a schedule is made, and given a target date range, the date of all occurances can be determined.
 
 == Features
 

data/lib/scheduling.rb

@@ -2,6 +2,7 @@ require 'scheduling/version'
 require 'scheduling/intersection'
 
 require 'scheduling/regularity/monthly'
+require 'scheduling/regularity/quarterly'
 require 'scheduling/regularity/yearly'
 
 require 'scheduling/schedule/regular_schedule'

data/lib/scheduling/regularity/quarterly.rb

@@ -0,0 +1,82 @@
+class Date
+  def self.q1(year)
+    Date.new(year,1)
+  end
+
+  def self.q2(year)
+    Date.new(year,4)
+  end
+
+  def self.q3(year)
+    Date.new(year,7)
+  end
+
+  def self.q4(year)
+    Date.new(year,10)
+  end
+
+  def quarter
+    1 + ((month - 1) / 3)
+  end
+
+  def self.quarterly year, quarter = 1, qday = 1
+    case quarter
+    when 1
+      self.q1(year) + (qday - 1)
+    when 2
+      self.q2(year) + (qday - 1)
+    when 3
+      self.q3(year) + (qday - 1)
+    when 4
+      self.q4(year) + (qday - 1)
+    else
+      raise ArgumentError, "quarter #{quarter} is not 1-4"
+    end 
+  end
+
+  def qday
+    1 + (self - Date.quarterly(self.year, quarter)).to_i
+  end
+
+  def next_quarter count = 1
+    raise ArgumentError, "count #{count} is < 1" if count < 1
+    
+    quarter = self.quarter + count % 4
+    year = self.year + count / 4
+    
+    if quarter > 4
+      year += 1
+      quarter = (quarter - 4)
+    end
+
+    Date.quarterly(year, quarter, self.qday)
+  end
+end
+
+module Scheduling
+class Quarterly < Struct.new(:qday)
+  def occurances time_range
+    raise RangeDecreasingError if time_range.decreasing?
+    cur = Date.quarterly(time_range.min.year, time_range.min.quarter, qday)
+
+    start = time_range.min
+    if cur < start
+      cur = cur.next_quarter
+    end
+
+    occurances = []
+
+    stop = time_range.last
+    if time_range.exclude_end?
+      stop -= 1
+    end
+
+    while cur <= stop
+      occurances.push cur
+      cur = cur.next_quarter
+    end
+
+    return occurances
+  end
+end
+end

data/lib/scheduling/version.rb

@@ -1,4 +1,4 @@
 module Scheduling
   # scheduling version
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/spec/regularity/quarterly_spec.rb

@@ -0,0 +1,164 @@
+ require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+ describe Date do
+
+  describe '.q1' do
+    it 'should produce a date starting Jan 1 of the given year' do
+      [1910, 2000, 2111].each do |year|
+        date = Date.q1(year)
+        date.month.should eq(1)
+        date.day.should eq(1)
+      end
+    end
+  end
+
+  describe '.q2' do
+    it 'should produce a date starting Apr 1 of the given year' do
+      [1910, 2000, 2111].each do |year|
+        date = Date.q2(year)
+        date.month.should eq(4)
+        date.day.should eq(1)
+      end
+    end
+  end
+
+  describe '.q3' do
+    it 'should produce a date starting July 1 of the given year' do
+      [1910, 2000, 2111].each do |year|
+        date = Date.q3(year)
+        date.month.should eq(7)
+        date.day.should eq(1)
+      end
+    end
+  end
+
+  describe '.q4' do
+    it 'should produce a date starting Oct 1 of the given year' do
+      [1910, 2000, 2111].each do |year|
+        date = Date.q4(year)
+        date.month.should eq(10)
+        date.day.should eq(1)
+      end
+    end
+  end
+
+  describe '#quarter' do
+    it 'should return 1 for quarters 1-3' do
+      [1,2,3].each do |quarter|
+        Date.new(2000,quarter).quarter.should eq(1)
+      end
+    end
+
+    it 'should return 2 for quarters 4-6' do
+      [4,5,6].each do |quarter|
+        Date.new(2000,quarter).quarter.should eq(2)
+      end
+    end
+    
+    it 'should return 3 for quarters 7-9' do
+      [7,8,9].each do |quarter|
+        Date.new(2000,quarter).quarter.should eq(3)
+      end
+    end
+    
+    it 'should return 4 for quarters 10-12' do
+      [10,11,12].each do |quarter|
+        Date.new(2000,quarter).quarter.should eq(4)
+      end
+    end
+  end
+
+  describe '.quarterly' do  
+    it 'should produce a Date instance' do
+      Date.quarterly(2000).should be_a Date
+    end
+
+    it 'should produce a date with given qday' do
+      [1,10,20,70,89].each do |qday|
+        Date.quarterly(1995,2,qday).qday.should eq(qday)
+      end
+    end
+  end
+
+  describe '#qday' do
+    it 'should return the number of days since the start of the last quarter' do
+      [
+        Date.new(2000,3,28),
+        Date.new(1999,10,15),
+        Date.new(2006,8,11),
+        Date.new(2045,12,31)
+      ].each do |date|
+        date.qday.should eq(1 + (date - Date.quarterly(date.year, date.quarter)))
+      end
+    end
+  end
+
+  describe '#next_quarter' do
+    it 'should return the a date that is  number of quarters in the future' do
+      [
+        #{ :start => Date.quarterly(2000,3,28), :q_incr => 2, :expected => Date.quarterly(2001, 1, 28) },
+        #{ :start => Date.quarterly(2012,1), :q_incr => 5, :expected => Date.quarterly(2013, 2) },
+        #{ :start => Date.quarterly(2030,4,45), :q_incr => 11, :expected => Date.quarterly(2033, 3, 45) },
+      ].each do |hash|
+        hash[:start].next_quarter(hash[:q_incr]).should eq(hash[:expected])
+      end
+    end
+  end
+end
+
+describe Quarterly do
+  describe '#occurances' do
+    context 'time range spans less than 1 quarter' do
+      context 'original time not in qday range' do
+        it 'should return empty array' do
+          [
+           {:qday => 15, :range => Date.quarterly(2003,1,16)..Date.quarterly(2003,2,14)},
+           {:qday => 15, :range => Date.quarterly(2003,1,16)...Date.quarterly(2003,2,15)},
+           {:qday => 2, :range => Date.new(2021,1,3)...Date.new(2021,2,1)},
+          ].each do |hash|
+            Quarterly.new(hash[:qday]).occurances(hash[:range]).should be_empty
+          end
+        end
+      end
+
+      context 'original time is in qday range' do
+        it 'should return array with 1 element' do
+          [
+           {:qday => 15, :range => Date.quarterly(2003,1,16)...Date.quarterly(2003,2,16)},
+           {:qday => 15, :range => Date.quarterly(2003,1,14)...Date.quarterly(2003,2,15)},
+           {:qday => 10, :range => Date.quarterly(2003,3,88)..Date.quarterly(2003,4,22)},
+           {:qday => 22, :range => Date.quarterly(2003,3)...Date.quarterly(2003,4)},
+          ].each do |hash|
+            Quarterly.new(hash[:qday]).occurances(hash[:range]).count.should eq(1)
+          end
+        end
+      end
+    end
+
+    context 'time range spans more than 1 quarter but less than 2' do
+      context 'original time not in qday range' do
+        it 'should return array with 1 element' do
+          [
+           {:qday => 15, :range => Date.quarterly(2003,1,16)..Date.quarterly(2003,3,14)},
+           {:qday => 15, :range => Date.quarterly(2003,1,14)...Date.quarterly(2003,2,15)},
+           {:qday => 2, :range => Date.quarterly(2020,4,3)...Date.quarterly(2021,1,5)},
+          ].each do |hash|
+            Quarterly.new(hash[:qday]).occurances(hash[:range]).count.should eq(1)
+          end
+        end
+      end
+
+      context 'original time is in qday range' do
+        it 'should return array with 2 elements' do
+          [
+           {:qday => 15, :range => Date.quarterly(2003,1,15)...Date.quarterly(2003,3,15)},
+           {:qday => 15, :range => Date.quarterly(2003,1,16)...Date.quarterly(2003,3,16)},
+           {:qday => 22, :range => Date.quarterly(2003,3,1)...Date.quarterly(2004)},
+          ].each do |hash|
+            Quarterly.new(hash[:qday]).occurances(hash[:range]).count.should eq(2)
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scheduling
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-19 00:00:00.000000000 Z
+date: 2013-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -111,6 +111,7 @@ files:
 - lib/scheduling.rb
 - lib/scheduling/intersection.rb
 - lib/scheduling/regularity/monthly.rb
+- lib/scheduling/regularity/quarterly.rb
 - lib/scheduling/regularity/yearly.rb
 - lib/scheduling/schedule/compound_schedule.rb
 - lib/scheduling/schedule/irregular_schedule.rb
@@ -119,6 +120,7 @@ files:
 - scheduling.gemspec
 - spec/intersection_spec.rb
 - spec/regularity/monthly_spec.rb
+- spec/regularity/quarterly_spec.rb
 - spec/regularity/yearly_spec.rb
 - spec/schedule/compound_schedule_spec.rb
 - spec/schedule/irregular_schedule_spec.rb
@@ -140,7 +142,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3343969679380982067
+      hash: -1329761715509626376
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -149,7 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3343969679380982067
+      hash: -1329761715509626376
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -159,6 +161,7 @@ summary: Make schedules, regular (yearly, monthly, etc.) or otherwise.
 test_files:
 - spec/intersection_spec.rb
 - spec/regularity/monthly_spec.rb
+- spec/regularity/quarterly_spec.rb
 - spec/regularity/yearly_spec.rb
 - spec/schedule/compound_schedule_spec.rb
 - spec/schedule/irregular_schedule_spec.rb