quarter_time 0.2.3

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 evizitei
+
+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,79 @@
+= quarter_time
+
+A simple gem for dealing with quarter logic.  I happen to have a project where half the models in the database recur every three months as part of a "quarter" of the year.  Within the code, we constantly are asking "what quarter is this for?", or "show me all the records for this quarter".  Well, now I need the same power on another application, so say hello to "quarter_time".
+
+(etymology: it's colloquial in some musical circles to use the phrase "quarter time" to represent the 4/4 time signature, or "three-quarter time" to mean 3/4.  Also, it's a short name for a gem that no one has used yet, I have to admit that did factor into the equation)
+
+== Usage
+
+1) Install! (or require with whatever dependancy manager you use)
+
+    sudo gem install quarter_time
+    
+2) Require!
+   
+   require 'quarter_time'
+   
+3) Use!
+
+  * find out what quarter a day belongs to:
+  
+    Date.parse("3/15/2010").quarter 
+    # => 1
+    Date.parse("12/12/2010").quarter
+    # => 4
+
+  * Use an object to represent quarters
+  
+    >> quarter = Quarter.new(2010,3)
+    => #<Quarter: @quarter=3, @year=2010>
+  
+  *calculate the next or previous quarter in the logical sequence
+  
+    >> quarter.next
+    => #<Quarter: @quarter=4, @year=2010>
+    >> quarter.next.next
+    => #<Quarter: @quarter=1, @year=2011>
+    >> quarter.previous
+    => #<Quarter: @quarter=2, @year=2010>
+    
+  *get the boundary dates of any given quarter
+  
+    >> quarter.start_date.to_s
+    => "2010-07-01"
+    >> quarter.end_date.to_s
+    => "2010-09-30"
+    
+  *get a string representation of the quarter, good for interpolating into emails and such
+  
+    >> quarter.quarter_stamp
+    => "Q3, 2010"
+    
+  *include a scope for easy finding, plus several quarter methods into your ActiveRecord models that have year and quarter fields!
+  
+    class SomeModel < ActiveRecord::Base
+      include QuarterTime::QuarterDriven
+    end
+    
+    q = Quarter.new(2010,2)
+    model = SomeModel.for_quarter(q).first
+    model.quarter_obj
+      =>  #<Quarter: @quarter=2, @year=2010>
+    model.start_date.to_s
+      => "2010-03-01"
+    model.quarter_stamp
+      => "Q2, 2010"
+      
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 evizitei. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "quarter_time"
+    gem.summary = %Q{ library for measuring time in quarters (three month periods) and interacting with models that are tied to a specific quarter.}
+    gem.description = %Q{A simple gem for dealing with quarter logic.  I happen to have a project where half the models in the database recur every three months as part of a "quarter" of the year.  Within the code, we constantly are asking "what quarter is this for?", or "show me all the records for this quarter".  Well, now I need the same power on another application, so say hello to "quarter_time".}
+    gem.email = "ethan.vizitei@gmail.com"
+    gem.homepage = "http://github.com/evizitei/quarter_time"
+    gem.authors = ["evizitei"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # 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 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "quarter_time #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.3

data/lib/extensions/date_extension.rb

@@ -0,0 +1,3 @@
+class Date
+  include QuarterTime::QuarterKnowledge
+end

data/lib/extensions/time_extension.rb

@@ -0,0 +1,3 @@
+class Time
+  include QuarterTime::QuarterKnowledge
+end

data/lib/quarter_time/quarter.rb

@@ -0,0 +1,64 @@
+class Quarter
+  attr_accessor :year
+  attr_accessor :quarter
+  
+  def initialize(year,quarter)
+    @year = year
+    @quarter = quarter
+  end
+  
+  def next
+    @next ||= build_next
+  end
+  
+  def previous
+    @previous ||= build_previous
+  end
+  
+  def start_date
+    Date.parse("#{(@quarter * 3) - 2}/01/#{@year}")
+  end
+
+  def end_date
+    start_date + 3.months - 1.day
+  end
+  
+  def yq_hash   
+    {:year=>self.year,:quarter=>self.quarter}
+  end
+  
+  def date_hash 
+    {:start_date=>self.start_date,:end_date=>self.end_date}
+  end
+  
+  def date_strings_hash
+    {:start_date=>self.start_date.strftime("%m/%d/%Y"),:end_date=>self.end_date.strftime("%m/%d/%Y")}
+  end
+  
+  def quarter_stamp
+    "Q#{self.quarter}, #{self.year}"
+  end
+  
+  def eql?(other_quarter)
+    other_quarter.class.eql?(self.class) and other_quarter.year == year and other_quarter.quarter == self.quarter
+  end
+  
+  alias_method :==,:eql?
+  
+protected
+  def build_next
+    if @quarter < 4
+      Quarter.new(@year,@quarter + 1)
+    else
+      Quarter.new(@year + 1,1)
+    end
+  end
+  
+  def build_previous
+    if @quarter > 1
+      Quarter.new(@year,@quarter - 1)
+    else
+      Quarter.new(@year - 1,4)
+    end
+  end
+end

data/lib/quarter_time/quarter_driven.rb

@@ -0,0 +1,17 @@
+module QuarterTime
+  module QuarterDriven
+    def self.included(base)
+      base.class_eval do
+        named_scope :for_quarter, lambda{|quarter_obj|{:conditions=>{:year=>quarter_obj.year, :quarter=>quarter_obj.quarter}}}
+   
+        [:start_date,:end_date,:quarter_stamp].each do |delegated_method|
+          define_method(delegated_method){ self.quarter_obj.send(delegated_method) }
+        end
+      end
+    end
+    #   
+    def quarter_obj
+      @quarter_obj ||= Quarter.new(self.year,self.quarter)
+    end
+  end
+end

data/lib/quarter_time/quarter_knowledge.rb

@@ -0,0 +1,11 @@
+module QuarterTime
+  module QuarterKnowledge
+    def quarter
+      month_number = self.month
+      while((month_number % 3) != 0) do
+         month_number += 1
+      end
+      quarter = month_number/3
+    end
+  end
+end

data/lib/quarter_time.rb

@@ -0,0 +1,14 @@
+if RUBY_VERSION >= '1.9'
+  require 'time'
+  require 'date'
+  require 'active_support/time'
+else
+  require 'active_support'
+  require 'active_support/core_ext'
+end
+
+require 'quarter_time/quarter_knowledge'
+require 'extensions/date_extension'
+require 'extensions/time_extension'
+require 'quarter_time/quarter'
+require 'quarter_time/quarter_driven'

data/quarter_time.gemspec

@@ -0,0 +1,65 @@
+# 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{quarter_time}
+  s.version = "0.2.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["evizitei"]
+  s.date = %q{2010-06-09}
+  s.description = %q{A simple gem for dealing with quarter logic.  I happen to have a project where half the models in the database recur every three months as part of a "quarter" of the year.  Within the code, we constantly are asking "what quarter is this for?", or "show me all the records for this quarter".  Well, now I need the same power on another application, so say hello to "quarter_time".}
+  s.email = %q{ethan.vizitei@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/extensions/date_extension.rb",
+     "lib/extensions/time_extension.rb",
+     "lib/quarter_time.rb",
+     "lib/quarter_time/quarter.rb",
+     "lib/quarter_time/quarter_driven.rb",
+     "lib/quarter_time/quarter_knowledge.rb",
+     "quarter_time.gemspec",
+     "test/helper.rb",
+     "test/test_date_extensions.rb",
+     "test/test_quarter.rb",
+     "test/test_quarter_driven.rb",
+     "test/test_time_extensions.rb"
+  ]
+  s.homepage = %q{http://github.com/evizitei/quarter_time}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{library for measuring time in quarters (three month periods) and interacting with models that are tied to a specific quarter.}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_date_extensions.rb",
+     "test/test_quarter.rb",
+     "test/test_quarter_driven.rb",
+     "test/test_time_extensions.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<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,20 @@
+require 'rubygems'
+
+if RUBY_VERSION >= '1.9'
+  require 'time'
+  require 'date'
+  require 'active_support/time'
+else
+  require 'active_support'
+  require 'active_support/core_ext'
+end
+
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'quarter_time'
+
+class Test::Unit::TestCase
+end

data/test/test_date_extensions.rb

@@ -0,0 +1,14 @@
+require 'helper'
+
+class TestDateExtension < Test::Unit::TestCase
+  context "Date" do
+    should "know what quarter it is in March" do
+      assert_equal 1,Date.parse("03/15/2010").quarter
+    end
+    
+    should "know what quarter it is in November" do
+      assert_equal 4,Date.parse("11/15/2010").quarter
+    end
+  end
+  
+end

data/test/test_quarter.rb

@@ -0,0 +1,61 @@
+require 'helper'
+
+class TestQuarter < Test::Unit::TestCase
+  context "Quarter" do
+    should "calculate start date for first quarter" do
+      assert_equal Date.parse("01/01/2009"),Quarter.new(2009,1).start_date
+    end
+    
+    should "calculate start date for second quarter" do
+      assert_equal Date.parse("04/01/2009"),Quarter.new(2009,2).start_date
+    end
+    
+    should "calculate start date for third quarter" do
+      assert_equal Date.parse("07/01/2009"),Quarter.new(2009,3).start_date
+    end
+    
+    should "calculate start date for fourth quarter" do
+      assert_equal Date.parse("10/01/2009"),Quarter.new(2009,4).start_date
+    end
+    
+    should "calculate end date for first quarter" do
+      assert_equal Date.parse("03/31/2009"),Quarter.new(2009,1).end_date
+    end
+    
+    should "calculate end date for second quarter" do
+      assert_equal Date.parse("06/30/2009"),Quarter.new(2009,2).end_date
+    end
+    
+    should "calculate end date for third quarter" do
+      assert_equal Date.parse("09/30/2009"),Quarter.new(2009,3).end_date
+    end
+    
+    should "calculate end date for fourth quarter" do
+      assert_equal Date.parse("12/31/2009"),Quarter.new(2009,4).end_date
+    end 
+    
+    should "be equal to other quarter made from same year and quarter" do
+      assert Quarter.new(2010,3).eql?(Quarter.new(2010,3))
+    end  
+    
+    should "be equal to other quarter made from same year and quarter with double equals as well" do
+      assert Quarter.new(2010,3) == Quarter.new(2010,3)
+    end
+  end     
+  
+  context "Prebuilt Quarter" do
+    setup { @quarter = Quarter.new(2009,4)}
+    
+    should "produce a hash for parameters with year and month" do
+      assert_equal({:year=>2009,:quarter=>4},@quarter.yq_hash)
+    end
+    
+    should "produce a hash for parameters with start_date and end_date" do
+      assert_equal({:start_date=>Date.parse("10/01/2009"),:end_date=>Date.parse("12/31/2009")},@quarter.date_hash)
+    end    
+    
+    should "produce a params hash with strings for dates" do
+      assert_equal({:start_date=>"10/01/2009",:end_date=>"12/31/2009"},@quarter.date_strings_hash)
+    end
+  end
+end

data/test/test_quarter_driven.rb

@@ -0,0 +1,51 @@
+require 'helper'
+
+class TestQuarterDriven < Test::Unit::TestCase
+  context "When Included in a class" do
+    setup do
+      @model = QuarterDrivenModel.new
+    end
+    
+    should "produce quarter object from year and quarter attributes" do
+      assert_equal Quarter.new(2010,2),@model.quarter_obj
+    end
+    
+    should "delegate start date to quarter object" do
+      assert_equal Date.parse("4/1/2010"),@model.start_date
+    end
+    
+    should "delegate end date to quarter object" do
+      assert_equal Date.parse("6/30/2010"),@model.end_date
+    end
+    
+    should "delegate quarter stamp to quarter object" do
+      assert_equal "Q2, 2010",@model.quarter_stamp
+    end
+    
+    should "create a named scope to find by a quarter object" do
+      expected_map = {:conditions=>{:year=>2010,:quarter=>4}}
+      assert_equal expected_map,QuarterDrivenModel.scopes[:for_quarter].call(Quarter.new(2010,4))
+    end
+  end
+
+end
+
+class QuarterDrivenModel
+  attr_accessor :year,:quarter
+  
+  def self.scopes
+    @@scopes
+  end
+  
+  def self.named_scope(name,func = nil)
+    @@scopes ||= {}
+    @@scopes[name] = func
+  end
+  
+  def initialize(year = 2010,quarter = 2)
+    @year = year
+    @quarter = quarter
+  end
+
+  include QuarterTime::QuarterDriven
+end

data/test/test_time_extensions.rb

@@ -0,0 +1,14 @@
+require 'helper'
+
+class TestTimeExtension < Test::Unit::TestCase
+  context "Time" do
+    should "know what quarter it is in March" do
+      assert_equal 1,Time.parse("03/15/2010 9:30 AM").quarter
+    end
+    
+    should "know what quarter it is in November" do
+      assert_equal 4,Time.parse("11/15/2010 4:45 PM").quarter
+    end
+  end
+  
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification 
+name: quarter_time
+version: !ruby/object:Gem::Version 
+  hash: 17
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 3
+  version: 0.2.3
+platform: ruby
+authors: 
+- evizitei
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-09 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: A simple gem for dealing with quarter logic.  I happen to have a project where half the models in the database recur every three months as part of a "quarter" of the year.  Within the code, we constantly are asking "what quarter is this for?", or "show me all the records for this quarter".  Well, now I need the same power on another application, so say hello to "quarter_time".
+email: ethan.vizitei@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/extensions/date_extension.rb
+- lib/extensions/time_extension.rb
+- lib/quarter_time.rb
+- lib/quarter_time/quarter.rb
+- lib/quarter_time/quarter_driven.rb
+- lib/quarter_time/quarter_knowledge.rb
+- quarter_time.gemspec
+- test/helper.rb
+- test/test_date_extensions.rb
+- test/test_quarter.rb
+- test/test_quarter_driven.rb
+- test/test_time_extensions.rb
+has_rdoc: true
+homepage: http://github.com/evizitei/quarter_time
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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.7
+signing_key: 
+specification_version: 3
+summary: library for measuring time in quarters (three month periods) and interacting with models that are tied to a specific quarter.
+test_files: 
+- test/helper.rb
+- test/test_date_extensions.rb
+- test/test_quarter.rb
+- test/test_quarter_driven.rb
+- test/test_time_extensions.rb