rmoriz-smartmonth 1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Panoctagon, inc. (Derek Perez | www.derekperez.com)
+
+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

@@ -0,0 +1,30 @@
+SmartMonth is a "bodysnatcher" plugin that takes boring Date month fixnums and replaces them with a rich toolkit of functionality. You can use SmartMonth to:
+
+- Determine the first tuesday of any month in any year.
+- Determine all of the fridays of any month in any year.
+- Iterate through all the days of a month.
+- Determine how many days of the month there are.
+- Determine the first and last days of the month.
+- And other fun date/month related things!
+
+This is designed to be an extension of not only Time.now.month, but adds a new Month class to the ruby object model.
+
+Keep in mind, this is 1.0, and may break things that rely on Time.now.month being a Fixnum. I've tried to fix this by making sure #to_i works as expected, but it may be an issue, handle with care.
+
+Examples:
+
+	Time.now.month.every_tuesday #=> [array of tuesdays for the current month]
+	Month.april.first_wednesday #=> Date object corresponding to the first wednesday of april.
+	Month.may.every_monday_and_friday #=> {:monday=>[...],:friday=>[...]}
+	Month.june(2012).last_monday #=> Date object corresponding to the last monday in june 2012.
+	
+	# iterator:
+	Month.june(2004).each do |day|
+		day.to_s #=> name of day (Saturday, Sunday, etc.)
+		day.to_i #=> value between 1 and the last day of the month corresponding.
+	end
+
+Check the included documentation (rdoc) or our documentation site (http://code.panoctagon.com/projects/smartmonth) 
+for more info on usage!
+
+Copyright (c) 2008 Panoctagon, inc (Derek Perez | www.derekperez.com), released under the MIT license

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the smart_month plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the smart_month plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SmartMonth'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/init.rb

@@ -0,0 +1,5 @@
+class ::Time
+  def month
+    return Month.new(self.mon,self.year)
+  end
+end

data/lib/month.rb

@@ -0,0 +1,19 @@
+require 'date'
+
+class Month
+  # gather the modules
+  include SmartMonth::Calculations
+  include SmartMonth::Collection
+  include SmartMonth::Math
+  include SmartMonth::Util
+  include SmartMonth::Magic
+  # abstraction that returns an array of months.
+  NAMES = Date::MONTHNAMES
+  # abstraction that returns an array of day names.
+  DAYS = Date::DAYNAMES  
+  # constructor, takes 2 optional arguments, if you don't provide them, it will default to
+  # the current month and year.
+  def initialize(month = Time.now.mon, year = Time.now.year)
+    @date = Date.new(year,( month.is_a?(Integer) ? month : Month::NAMES.index(month.to_s.capitalize) ) ,1) 
+  end
+end

data/lib/smart_month/calculations.rb

@@ -0,0 +1,80 @@
+module SmartMonth
+  # Responsible for all core month/week calculations.
+  module Calculations  
+    # returns the first date of the day requested. 
+    # if no day is defined, it returns the very first day of the month.
+    def first(day = nil)
+     (day.nil?) ? @date : nth_weekday(day,1)
+    end
+
+    # returns the second date of the day requested.
+    def second(day)
+     nth_weekday(day,2)
+    end
+
+    # returns the third date of the day requested.
+    def third(day)
+     nth_weekday(day,3)
+    end
+    
+    # returns the fourth (or potentially last), date of the day requested.
+    def fourth(day)
+      nth_weekday(day,4) || self.last(day)
+    end
+
+    # returns last date of the day requested.
+    # if no day is defined, it returns the very last day of the month.
+    def last(day = nil)
+     (day.nil?) ? Date.new(@date.year,@date.month,-1) : every(day).last
+    end
+
+    # returns an array of dates of the day requested.
+    # if an array of dates are passed in, a hash of day names containing
+    # the corresponding date are returned.
+    def every(*days)
+     days = [days].flatten
+     if days.size == 1
+       dates = []
+       (1..5).each do |week|
+          dates << nth_weekday(days.first,week)
+       end
+       dates.compact!
+     else
+       dates = {}
+       days.each do |day|
+         day = day.to_sym
+         dates[day] = []
+         (1..5).each do |week|
+            dates[day] << nth_weekday(day,week)
+         end
+         dates[day].compact!
+       end
+     end
+     dates
+    end
+    
+    # returns the total number of days in month.
+    def size
+      self.last.day.to_i
+    end
+    alias_method :length, :size
+    
+    private
+
+    # this is the heart of the calculations module.
+    def nth_weekday(day,limit = 0)
+      raise RuntimeError, "#{day} is not a valid day of the week" unless Month::DAYS.collect{|d| d.downcase}.include?(day.to_s)
+      limit -= 1 # make more sense to humans
+      requested_weekday = Month::DAYS.collect{|d| d.downcase}.index(day.to_s)
+      iter_date = Date.new(@date.year,@date.month,1)
+      # find the first day that works
+      until iter_date.wday == requested_weekday
+        iter_date +=1
+      end
+      # then add a multipler based on the limit
+      iter_date = iter_date + (limit*7)
+      # if the date we've iterated to doesn't exist in this month, send out a nil.
+      return iter_date unless iter_date.month != @date.month
+    end  
+  end
+end

data/lib/smart_month/collection.rb

@@ -0,0 +1,67 @@
+module SmartMonth
+  # Responsible for all collection-based functionality.
+  module Collection
+    # this is a helper class that is used primarily by Month#each.
+    # should not be used standalone for any reason, really.
+    class Day
+      def initialize(date)
+        @date = date
+      end
+      # returns the date numeric of the day (in regards to the month it resides in).
+      def to_i
+        @date.day
+      end
+      # returns the string value of the weekday.
+      def to_s
+        Month::DAYS[@date.wday]
+      end
+    end
+    
+    # allows for increment by copy
+    def next
+      if @date.month + 1 > 12
+        Month.new(1,@date.year+1)
+      else
+        Month.new(@date.month+1,@date.year)
+      end
+    end
+
+    # allows for in place incrementing by 1
+    def next!
+      if @date.month + 1 > 12
+        @date = Date.new(@date.year+1,@date.month,1)
+      else
+        @date = Date.new(@date.year,@date.month+1,1)
+      end
+    end
+
+    # allows for deincrement by copy
+    def previous
+      if @date.month - 1 == 0
+        Month.new(12,@date.year-1)
+      else
+        Month.new(@date.month-1,@date.year)
+      end
+    end
+    alias_method :prev, :previous
+
+    # allows for in place deincrementing by 1
+    def previous!
+      if @date.month - 1 == 0
+        @date = Date.new(@date.year-1,12,1)
+      else
+        @date = Date.new(@date.year,@date.month-1,1)
+      end
+    end
+    alias_method :prev!, :previous!
+    
+    # allows us to iterate internally on the days of a given month.
+    # It also uses the helpful Day class that provides some fun methods. (see SmartMonth::Collection::Day)
+    def each(&block)
+     (1..self.last.day).each do |e|
+       block.call(Day.new(Date.new(@date.year,@date.month,e)))
+     end
+     return self
+    end
+  end
+end

data/lib/smart_month/magic.rb

@@ -0,0 +1,35 @@
+module SmartMonth
+  # Magic is responsible for the rails-like dynamic "magic finders".
+  module Magic
+    
+    # extends the Month class with the Month factory
+    def self.included(base)
+      base.extend MonthFactory
+    end
+    
+    # This module allows your code to ignore the class instantiation, simply do Month.june!
+    module MonthFactory
+      # singleton month factory
+      def method_missing(meth,*args)
+        return new(meth.to_s.capitalize, (args.first || Time.now.year)) if Month::NAMES.include? meth.to_s.capitalize
+      end
+      
+      # this allows you to essentially treat the month as a hash or array object to construct new months.
+      def [](month)
+         new(month)
+      end
+    end
+    
+    # nice catchall to allow rails-esque APIs if you choose to.
+    def method_missing(meth)
+      raw = meth.to_s.split("_")
+      func = raw.slice!(0)
+      if func == "every"
+        args = raw.select { |a| a != "and" }
+        self.send(func,args)
+      else
+        self.send(func,raw) if %w(first second third fourth last).include? func
+      end
+    end
+  end
+end

data/lib/smart_month/math.rb

@@ -0,0 +1,39 @@
+module SmartMonth
+  # Responsible for all math related functionality.
+  module Math
+    # adds a number to the month value and returns a Fixnum.
+    def +(int)
+      self.to_i + int
+    end
+
+    # subtracts a number to the month value and returns a Fixnum.
+    def -(int)
+      self.to_i - int
+    end
+    
+    # multiplies a number to the month value and returns a Fixnum.
+    def *(int)
+      self.to_i * int
+    end
+
+    # divides a number to the month value and returns a Fixnum.
+    def /(int)
+      self.to_i / int
+    end
+    
+    # exponents a number to the month value and returns a Fixnum.
+    def **(int)
+      self.to_i ** int
+    end
+    
+    # modulos a number to the month value and returns a Fixnum.
+    def %(int)
+      self.to_i % int
+    end
+    
+    # compares the current month to another month.
+    def ==(month)
+      self.inspect! == month.inspect! 
+    end
+  end
+end

data/lib/smart_month/util.rb

@@ -0,0 +1,29 @@
+module SmartMonth
+  # Responsible for odds and ends.
+  module Util
+    # returns the month as a string.
+    def inspect
+     "#{self.to_s}"
+    end
+    
+    # returns the year of the current month.
+    def year
+      @date.year
+    end
+    
+    # returns the month and the year as a string.
+    def inspect!
+      "#{self.to_s} #{@date.year}"
+    end
+
+    # returns the month as a string.
+    def to_s
+       Month::NAMES[@date.month]
+    end
+
+    # returns the month as a fixnum.
+    def to_i
+      Month::NAMES.index(self.to_s)
+    end
+  end
+end

data/smartmonth.gemspec

@@ -0,0 +1,60 @@
+Gem::Specification.new do |s|
+  s.name = "smartmonth"
+  s.version = "1.0"
+  s.date = "2008-08-21"
+  s.summary = "Making months smarter in Ruby (and Rails)."
+  s.email = "roland@moriz.de"
+  s.homepage = "http://github.com/rmoriz/smartmonth/tree/master"
+  s.has_rdoc = true
+  s.authors = ['Derek Perez']
+  s.files = [  
+    "init.rb",
+    "lib/month.rb",
+    "lib/smart_month",
+    "lib/smart_month/calculations.rb",
+    "lib/smart_month/collection.rb",
+    "lib/smart_month/magic.rb",
+    "lib/smart_month/math.rb",
+    "lib/smart_month/util.rb",
+    "MIT-LICENSE",
+    "Rakefile",
+#    "rdoc/classes/Month.html",
+#    "rdoc/classes/SmartMonth",
+#    "rdoc/classes/SmartMonth/Calculations.html",
+#    "rdoc/classes/SmartMonth/Collection",
+#    "rdoc/classes/SmartMonth/Collection/Day.html",
+#    "rdoc/classes/SmartMonth/Collection.html",
+#    "rdoc/classes/SmartMonth/Magic",
+#    "rdoc/classes/SmartMonth/Magic/MonthFactory.html",
+#    "rdoc/classes/SmartMonth/Magic.html",
+#    "rdoc/classes/SmartMonth/Math.html",
+#    "rdoc/classes/SmartMonth/Util.html",
+#    "rdoc/classes/SmartMonth.html",
+#    "rdoc/created.rid",
+#    "rdoc/files/lib/month_rb.html",
+#    "rdoc/files/lib/smart_month",
+#    "rdoc/files/lib/smart_month/calculations_rb.html",
+#    "rdoc/files/lib/smart_month/collection_rb.html",
+#    "rdoc/files/lib/smart_month/magic_rb.html",
+#    "rdoc/files/lib/smart_month/math_rb.html",
+#    "rdoc/files/lib/smart_month/util_rb.html",
+#    "rdoc/files/README.html",
+#    "rdoc/fr_class_index.html",
+#    "rdoc/fr_file_index.html",
+#    "rdoc/fr_method_index.html",
+#    "rdoc/index.html",
+#    "rdoc/rdoc-style.css",
+    "README",
+    "smartmonth.gemspec",
+    "tasks/smart_month_tasks.rake",
+    "test/test_helper.rb",
+    "test/unit/smart_month_test.rb",
+  ]
+  s.test_files = [
+    "test/test_helper.rb",
+    "test/unit/smart_month_test.rb",
+  ]
+  s.rdoc_options = ["--main", "README"]
+  s.extra_rdoc_files = ["README", "MIT-LICENSE"]
+end
+

data/test/test_helper.rb

@@ -0,0 +1,26 @@
+ENV['RAILS_ENV'] ||= 'development'
+require File.dirname(__FILE__) + '/../../../../config/environment.rb' # this sucks
+ 
+# Load the testing framework
+require 'test_help'
+silence_warnings { RAILS_ENV = ENV['RAILS_ENV'] }
+ 
+# Run the migrations
+ActiveRecord::Migrator.migrate("#{RAILS_ROOT}/db/migrate")
+ 
+# Setup the fixtures path
+Test::Unit::TestCase.fixture_path = File.dirname(__FILE__) + "/fixtures/"
+$LOAD_PATH.unshift(Test::Unit::TestCase.fixture_path)
+ 
+class Test::Unit::TestCase #:nodoc:
+  def create_fixtures(*table_names)
+    if block_given?
+      Fixtures.create_fixtures(Test::Unit::TestCase.fixture_path, table_names) { yield }
+    else
+      Fixtures.create_fixtures(Test::Unit::TestCase.fixture_path, table_names)
+    end
+  end
+                                 
+  self.use_transactional_fixtures = true
+  self.use_instantiated_fixtures  = false
+end

data/test/unit/smart_month_test.rb

@@ -0,0 +1,189 @@
+require "test/unit"
+require File.dirname(__FILE__) + '/../test_helper'
+require "date"
+
+class SmartMonthTest < Test::Unit::TestCase
+  
+  # SmartMonth::Calcuations
+  
+  # Tested By: Derek Perez
+  def test_should_return_first_day_of_month
+    # test an ambiguous first, no weekday defined.
+    assert_equal Month.april(2008).first, Date.new(2008,4,1)
+    # test a specific first weekday.
+    assert_equal Month.march(2002).first(:tuesday), Date.new(2002,3,5)
+  end
+  
+  # Tested By: Derek Perez
+  def test_should_return_second_day_of_month
+    assert_equal Month.june(2007).second(:friday), Date.new(2007,6,8)
+  end
+  
+  # Tested By: Derek Perez
+  def test_should_return_third_day_of_month
+    assert_equal Month.august(2008).third(:wednesday), Date.new(2008,8,20)
+  end
+  
+  # Tested By: Derek Perez
+  def test_should_return_last_day_of_month
+    # test an ambiguous last, no weekday defined.
+    assert_equal Month.december.last, Date.new(2008,12,31)
+    # test a specific last weekday.
+    assert_equal Month.september(2004).last(:friday), Date.new(2004,9,24)
+    # test a specific ambiguous, fourth, no weekday defined.
+    assert_equal Month.june(2004).fourth(:friday), Date.new(2004,6,25)
+  end
+  
+  # Tested By: Derek Perez
+  def test_should_return_fourth_and_last_day_of_month
+    assert_equal Month.june(2004).fourth(:friday), Month.june(2004).last(:friday)
+  end
+  
+  # Tested By: Derek Perez
+  def test_should_return_every_day_of_month
+    assertion = Month.april(2003).every(:tuesday)
+    assert_equal assertion.size, 5
+    assert_equal assertion, [Date.new(2003,4,1),Date.new(2003,4,8),Date.new(2003,4,15),Date.new(2003,4,22),Date.new(2003,4,29)]
+  end
+  
+  # Tested By: Derek Perez
+  def test_should_retun_every_set_of_days_of_month
+    assertion = Month.august(2006).every(:monday,:wednesday)
+    # verify
+    assert assertion.is_a?(Hash)
+    # monday assertions
+    assert_equal assertion[:monday].size, 4
+    assert_equal assertion[:monday], [Date.new(2006,8,7),Date.new(2006,8,14),Date.new(2006,8,21),Date.new(2006,8,28)]
+    # wednesday assertions
+    assert_equal assertion[:wednesday].size, 5
+    assert_equal assertion[:wednesday],
+     [Date.new(2006,8,2),Date.new(2006,8,9),Date.new(2006,8,16),Date.new(2006,8,23),Date.new(2006,8,30)]
+    
+  end
+  
+  # Tested By: Derek Perez
+  def test_should_return_total_days_of_month
+    assert_equal Month.april(2004).size, 30
+    assert_equal Month.april(2004).length, 30 # alternate access
+  end
+  
+  # SmartMonth::Collection
+  
+  # Tested By: Derek Perez
+  def test_should_return_next_month
+    # default by copy
+    assert_equal Month.april.next, Month.may
+    # alternate approach
+    month = Month.april
+    month.next!
+    assert month, Month.may
+  end
+  
+  # Tested By: Derek Perez
+  def test_should_return_previous_month
+    # default by copy
+    assert_equal Month.may.previous, Month.april
+    # alternate approach (by copy)
+    assert_equal Month.june.prev, Month.may
+    # alternate approach (by ref)
+    month = Month.august
+    month.previous!
+    assert_equal month, Month.july
+    # alternate approach (by copy)
+    month = Month.july
+    month.prev!
+    assert_equal month, Month.june
+  end
+  
+  # Tested By: Derek Perez
+  def test_should_iterate_through_each_day_of_month
+    counter = 0
+    Month.april(2009).each do |day|
+      counter += 1
+      assert Month::DAYS.include?(day.to_s)
+      assert (1..31).include?(day.to_i)
+    end
+    assert_equal counter, Month.april.size
+  end
+  
+  # SmartMonth::Magic
+  
+  # Tested By: Derek Perez
+  def test_should_create_month_through_class_factory
+    assert_equal Month.april, Month.new("April")
+    assert_equal Month.march, Month.new(3)
+    assert_equal Month.june(2010), Month.new("June",2010)
+  end
+  
+  # Tested By: Derek Perez
+  def test_should_magically_determine_function_execution
+    assert_equal Month.march.first(:tuesday), Month.march.first_tuesday
+    assert_equal Month.may.every_thursday, Month.may.every(:thursday)
+    assert_equal Month.june.every_tuesday_and_friday, Month.june.every(:tuesday,:friday)
+  end
+  
+  # Tested By: Derek Perez
+  def test_should_return_month_as_array_index
+    assert_equal Month[3], Month.march
+  end
+  
+  # Tested By: Derek Perez
+  def test_should_return_month_as_hash_key
+    assert_equal Month[:june], Month.june
+    assert_equal Month["april"], Month.april # alternate
+  end
+  
+  # SmartMonth::Math
+  
+  # Tested By: Derek Perez
+  def test_should_add_month_and_fixnum
+    assert_equal (Month.march + 2), 5
+  end
+  
+  # Tested By: Derek Perez
+  def text_should_subtract_month_and_fixnum
+    assert_equal (Month.june - 4), 2
+  end
+  
+  # Tested By: Derek Perez
+  def test_should_divide_month_and_fixnum
+    assert_equal (Month.december / 2), 6
+  end
+  
+  # Tested By: Derek Perez
+  def test_should_exponent_month_and_fixnum
+    assert_equal (Month.may ** 2), 25
+  end
+  
+  # Tested By: Derek Perez
+  def test_should_modulo_month_and_fixnum
+    assert_equal (Month.june % 7), 6
+  end
+  
+  #SmartMonth::Util
+  
+  def test_should_return_year_of_month
+    assert_equal Month.march(2004).year, 2004 
+  end
+  
+  # Tested By: Derek Perez
+  def test_should_inspect_month_as_string
+    assert_equal Month.march.inspect, "March"
+  end
+  
+  # Tested By: Derek Perez
+  def test_should_inspect_month_and_year_as_string
+    assert_equal Month.july(2012).inspect!, "July 2012"
+  end
+  
+  # Tested By: Derek Perez
+  def test_should_convert_month_to_string
+    assert_equal Month.march.to_s, "March"
+  end
+  
+  # Tested By: Derek Perez
+  def test_should_convert_month_to_fixnum
+    assert_equal Month.june.to_i, 6
+  end
+  
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: rmoriz-smartmonth
+version: !ruby/object:Gem::Version 
+  version: "1.0"
+platform: ruby
+authors: 
+- Derek Perez
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-08-21 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: roland@moriz.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- MIT-LICENSE
+files: 
+- init.rb
+- lib/month.rb
+- lib/smart_month
+- lib/smart_month/calculations.rb
+- lib/smart_month/collection.rb
+- lib/smart_month/magic.rb
+- lib/smart_month/math.rb
+- lib/smart_month/util.rb
+- MIT-LICENSE
+- Rakefile
+- README
+- smartmonth.gemspec
+- tasks/smart_month_tasks.rake
+- test/test_helper.rb
+- test/unit/smart_month_test.rb
+has_rdoc: true
+homepage: http://github.com/rmoriz/smartmonth/tree/master
+post_install_message: 
+rdoc_options: 
+- --main
+- README
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Making months smarter in Ruby (and Rails).
+test_files: 
+- test/test_helper.rb
+- test/unit/smart_month_test.rb