smart_month 1.0.0

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'test/unit'
+require 'date'
+require 'smart_month'
+

data/test/unit/calculations_test.rb

@@ -0,0 +1,82 @@
+require 'test_helper'
+
+class CalculationsTest < Test::Unit::TestCase
+
+   # 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(2008).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_every_day_of_month_as_array
+     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_as_array
+     assertion = Month.august(2006).every(:monday,:wednesday)
+     # verify
+     assert assertion.is_a?(Array)
+     # check for data integrity
+     assert_equal assertion.size, 9
+     assert_equal assertion, [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),Date.new(2006,8,7),Date.new(2006,8,14),Date.new(2006,8,21),Date.new(2006,8,28)]
+   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
+
+end

data/test/unit/collection_test.rb

@@ -0,0 +1,42 @@
+require 'test_helper'
+
+class CollectionTest < Test::Unit::TestCase
+    
+  # 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_day)
+      assert (1..31).include?(day.to_i)
+    end
+    assert_equal counter, Month.april.size
+  end
+  
+end

data/test/unit/magic_test.rb

@@ -0,0 +1,37 @@
+require 'test_helper'
+
+class MagicTest < Test::Unit::TestCase
+    
+  # 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
+  
+  # Tested By: Derek Perez
+  def test_should_return_days_week_control
+    assert_equal Month.march.first_and_third_tuesday, [Month.march.first(:tuesday), Month.march.third(:tuesday)]
+    assert_equal Month.march.first_and_last_friday, [Month.march.first(:friday), Month.march.last(:friday)]
+    assert_equal Month.march.first_and_second_last_friday, [Month.march.first(:friday), Month.march.second(:friday), Month.march.last(:friday)]
+  end
+  
+end

data/test/unit/math_test.rb

@@ -0,0 +1,30 @@
+require 'test_helper'
+
+class MathTest < Test::Unit::TestCase
+    
+  # 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
+  
+end

data/test/unit/rulesets_test.rb

@@ -0,0 +1,94 @@
+require 'test_helper'
+
+class RulesetsTest < Test::Unit::TestCase
+  
+  # load up the test ruleset yaml file
+  def setup
+    SmartMonth::Rulesets.load_file(File.dirname(__FILE__)+'/samples/test_ruleset.yml')
+  end
+  
+  # tested by: Derek Perez
+  def test_should_return_date_from_string_with_floating_year
+    floating_year = {:year => Time.now.year, :month => 12, :day => 25}
+    assert_equal [:date,floating_year], SmartMonth::Rulesets.new.send(:parse_string_as_date,{'when' => "December 25th"})
+  end
+
+  # tested by: Derek Perez
+  def test_should_return_date_from_string_with_fixed_year
+    fixed_year = {:year => 2010, :month => 12, :day => 25}
+    assert_equal [:date,fixed_year], SmartMonth::Rulesets.new.send(:parse_string_as_date,{'when' => "December 25th, 2010"})
+  end
+  
+  # tested by: Derek Perez
+  def test_should_insert_rule_manually    
+    SmartMonth::Rulesets.add_rule('My Manual Rule', 'March 25th 2009')
+    assert_equal Month[3].my_manual_rule, Date.new(2009,3,25)
+  end
+  
+  # tested by: Derek Perez
+  def test_should_override_rule_definition_manually
+    initial = Month.december.christmas
+    SmartMonth::Rulesets.add_rule('Christmas', 'December 12th, 2009')
+    assert initial != Month.december.christmas
+    assert_equal Month.december.christmas, Date.new(2009,12,12)
+  end
+  
+  # tested by: Derek Perez
+  def test_should_return_frequency_from_string
+    # parsed values
+    expected_every =  [:freq, 'every_friday_and_saturday',nil,0]
+    expected_first_second = [:freq,'first_and_second_wednesday',nil,0]
+    expected_monday = [:freq, 'first_monday',nil,0]
+    # test
+    assert_equal expected_every, SmartMonth::Rulesets.new.send(:parse_string_as_frequency,{'when' => "every friday and saturday"})
+    assert_equal expected_first_second, SmartMonth::Rulesets.new.send(:parse_string_as_frequency,{'when' => "first and second wednesday"})
+    assert_equal expected_monday, SmartMonth::Rulesets.new.send(:parse_string_as_frequency,{'when' => "first monday"})    
+  end
+  
+  # tested by: Derek Perez
+  def test_should_return_context_of_months
+    # parsed values
+    expected_march = [:freq, 'every_monday',['march'], 0]
+    expected_march_june = [:freq, 'first_tuesday',['march','june'],0]
+    expected_march_june_april = [:freq, 'second_tuesday',['march','june','april'],0]
+    # test
+    assert_equal expected_march, SmartMonth::Rulesets.new.send(:parse_string_as_frequency,{'when' => "every monday in march"})
+    assert_equal expected_march_june, SmartMonth::Rulesets.new.send(:parse_string_as_frequency,{'when' => "first tuesday in march and june"})
+    assert_equal expected_march_june_april, SmartMonth::Rulesets.new.send(:parse_string_as_frequency,{'when' => "second tuesday in march, june, and april"})
+  end
+
+  # tested by: Derek Perez
+  def test_should_return_context_of_month_with_year
+    expected_2010 = [:freq, 'every_monday',['november'],2010]
+    assert_equal expected_2010, SmartMonth::Rulesets.new.send(:parse_string_as_frequency,{'when' => 'every monday in november', 'year' => '2010'})
+  end
+  
+  # tested by: Derek Perez
+  def test_should_parse_rules
+    # parsed values
+    rule_with_date = [:date, {:year => 2009, :day => 5, :month => 12}]
+    rule_with_freq = [:freq, "every_monday", ["march"], 0]
+    rule_with_freq_and_year = [:freq, "first_and_second_tuesday",["april"],2009]
+    # test
+    assert_equal rule_with_date, SmartMonth::Rulesets.new.send(:parse,{'when'=>'December 5th, 2009'})
+    assert_equal rule_with_freq, SmartMonth::Rulesets.new.send(:parse,{'when'=>'every monday in march'})
+    assert_equal rule_with_freq_and_year, SmartMonth::Rulesets.new.send(:parse,{'when'=>'first and second tuesday in april','year'=>'2009'})
+  end
+  
+  
+  def test_should_not_apply_alias_if_root_undefined
+  end
+  
+  # tested by: Derek Perez
+  def test_should_not_remove_undefined_rule
+    assert !SmartMonth::Rulesets.remove_rule("Rule fake")
+  end
+  
+  # tested by: Derek Perez
+  def test_should_remove_defined_rule
+    assert SmartMonth::Rulesets.remove_rule("Christmas")
+    assert !Month.december.respond_to?(:christmas)
+    assert !Month.december.first.respond_to?(:is_christmas?)
+  end
+  
+end

data/test/unit/samples/test_ruleset.yml

@@ -0,0 +1,6 @@
+Christmas:
+    when: "December 25th"
+    
+"My Meeting":
+    when: "June 16th, 2010"
+    

data/test/unit/util_test.rb

@@ -0,0 +1,29 @@
+require 'test_helper'
+
+class UtilTest < Test::Unit::TestCase
+  
+   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,196 @@
+--- !ruby/object:Gem::Specification 
+name: smart_month
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Derek Perez
+- Jonathan Silverman
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-06 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: |-
+  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!
+email: derek@derekperez.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- MIT-LICENSE
+- README
+- Rakefile
+- VERSION
+- lib/month.rb
+- lib/smart_month.rb
+- lib/smart_month/calculations.rb
+- lib/smart_month/collection.rb
+- lib/smart_month/extensions/date.rb
+- lib/smart_month/magic.rb
+- lib/smart_month/math.rb
+- lib/smart_month/rulesets.rb
+- lib/smart_month/util.rb
+- pkg/smart_month-1.0.0.gem
+- rdoc/classes/Date.html
+- rdoc/classes/Month.html
+- rdoc/classes/SmartMonth.html
+- rdoc/classes/SmartMonth/Calculations.html
+- rdoc/classes/SmartMonth/Collection.html
+- rdoc/classes/SmartMonth/Magic.html
+- rdoc/classes/SmartMonth/Magic/MonthFactory.html
+- rdoc/classes/SmartMonth/Math.html
+- rdoc/classes/SmartMonth/Rulesets.html
+- rdoc/classes/SmartMonth/Util.html
+- rdoc/classes/Time.html
+- rdoc/created.rid
+- rdoc/files/README.html
+- rdoc/files/lib/month_rb.html
+- rdoc/files/lib/smart_month/calculations_rb.html
+- rdoc/files/lib/smart_month/collection_rb.html
+- rdoc/files/lib/smart_month/extensions/date_rb.html
+- rdoc/files/lib/smart_month/magic_rb.html
+- rdoc/files/lib/smart_month/math_rb.html
+- rdoc/files/lib/smart_month/rulesets_rb.html
+- rdoc/files/lib/smart_month/util_rb.html
+- rdoc/files/lib/smart_month_rb.html
+- rdoc/fr_class_index.html
+- rdoc/fr_file_index.html
+- rdoc/fr_method_index.html
+- rdoc/index.html
+- rdoc/rdoc-style.css
+- smart_month.gemspec
+- test/spec/date/accessor_spec.rb
+- test/spec/date/add_month_spec.rb
+- test/spec/date/add_spec.rb
+- test/spec/date/boat_spec.rb
+- test/spec/date/civil_spec.rb
+- test/spec/date/commercial_spec.rb
+- test/spec/date/constants_spec.rb
+- test/spec/date/conversions_spec.rb
+- test/spec/date/downto_spec.rb
+- test/spec/date/eql_spec.rb
+- test/spec/date/gregorian_spec.rb
+- test/spec/date/hash_spec.rb
+- test/spec/date/infinity_spec.rb
+- test/spec/date/julian_spec.rb
+- test/spec/date/minus_month_spec.rb
+- test/spec/date/minus_spec.rb
+- test/spec/date/new_spec.rb
+- test/spec/date/neww_spec.rb
+- test/spec/date/ordinal_spec.rb
+- test/spec/date/parse_spec.rb
+- test/spec/date/relationship_spec.rb
+- test/spec/date/shared/civil.rb
+- test/spec/date/shared/commercial.rb
+- test/spec/date/shared/parse.rb
+- test/spec/date/shared/parse_eu.rb
+- test/spec/date/shared/parse_us.rb
+- test/spec/date/step_spec.rb
+- test/spec/date/strftime_spec.rb
+- test/spec/date/strptime_spec.rb
+- test/spec/date/upto_spec.rb
+- test/spec/parsedate/parsedate.rb
+- test/spec/time/httpdate_spec.rb
+- test/spec/time/iso8601_spec.rb
+- test/spec/time/rfc2822_spec.rb
+- test/spec/time/rfc822_spec.rb
+- test/spec/time/shared/rfc2822.rb
+- test/spec/time/shared/xmlschema.rb
+- test/spec/time/xmlschema_spec.rb
+- test/spec_helper.rb
+- test/test_helper.rb
+- test/unit/calculations_test.rb
+- test/unit/collection_test.rb
+- test/unit/magic_test.rb
+- test/unit/math_test.rb
+- test/unit/rulesets_test.rb
+- test/unit/samples/test_ruleset.yml
+- test/unit/util_test.rb
+has_rdoc: true
+homepage: http://github.com/perezd/smart_month
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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.3.5
+signing_key: 
+specification_version: 3
+summary: SmartMonth is a "bodysnatcher" plugin that takes boring Date month fixnums and replaces them with a rich toolkit of functionality.
+test_files: 
+- test/test_helper.rb
+- test/spec/date/strftime_spec.rb
+- test/spec/date/ordinal_spec.rb
+- test/spec/date/step_spec.rb
+- test/spec/date/hash_spec.rb
+- test/spec/date/new_spec.rb
+- test/spec/date/relationship_spec.rb
+- test/spec/date/julian_spec.rb
+- test/spec/date/shared/parse.rb
+- test/spec/date/shared/civil.rb
+- test/spec/date/shared/parse_eu.rb
+- test/spec/date/shared/parse_us.rb
+- test/spec/date/shared/commercial.rb
+- test/spec/date/strptime_spec.rb
+- test/spec/date/neww_spec.rb
+- test/spec/date/add_month_spec.rb
+- test/spec/date/add_spec.rb
+- test/spec/date/minus_spec.rb
+- test/spec/date/civil_spec.rb
+- test/spec/date/minus_month_spec.rb
+- test/spec/date/commercial_spec.rb
+- test/spec/date/parse_spec.rb
+- test/spec/date/gregorian_spec.rb
+- test/spec/date/downto_spec.rb
+- test/spec/date/accessor_spec.rb
+- test/spec/date/upto_spec.rb
+- test/spec/date/infinity_spec.rb
+- test/spec/date/boat_spec.rb
+- test/spec/date/eql_spec.rb
+- test/spec/date/constants_spec.rb
+- test/spec/date/conversions_spec.rb
+- test/spec/parsedate/parsedate.rb
+- test/spec/time/shared/rfc2822.rb
+- test/spec/time/shared/xmlschema.rb
+- test/spec/time/httpdate_spec.rb
+- test/spec/time/rfc2822_spec.rb
+- test/spec/time/iso8601_spec.rb
+- test/spec/time/xmlschema_spec.rb
+- test/spec/time/rfc822_spec.rb
+- test/unit/util_test.rb
+- test/unit/calculations_test.rb
+- test/unit/collection_test.rb
+- test/unit/math_test.rb
+- test/unit/rulesets_test.rb
+- test/unit/magic_test.rb
+- test/spec_helper.rb