shifty_week 0.1.0 → 0.1.1

data/README.rdoc

@@ -2,6 +2,22 @@
 
 Description in ShiftyWeek[link:classes/ShiftyWeek.html]
 
+== Quick Intro
+
+n = DateTime.now
+n.week_day_start = 'Wednesday'
+n.week_days # => [2009-11-04T00:16:27-08:00, 2009-11-05T00:16:27-08:00, 2009-11-06T00:16:27-08:00, 2009-11-07T00:16:27-08:00, 2009-11-08T00:16:27-08:00, 2009-11-09T00:16:27-08:00, 2009-11-10T00:16:27-08:00]
+
+
+== Installation
+
+1. Require the gem
+2. Require the libs:
+
+   shifty_week
+   shifty_week/time
+   shifty_week/date
+
 == Note on Patches/Pull Requests
  
 * Fork the project.

data/Rakefile

@@ -6,15 +6,22 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "shifty_week"
-    gem.summary = ShiftyWeek::Constants::SUMMARY
-    gem.description = ShiftyWeek::Constants::DESCRIPTION
+    gem.summary = %q{Calculate dates based on a configurable first day of the week.}
+    gem.description = %q{Calculate dates based on a configurable first day of the week. If you want
+    the first day of the week to be Wednesday and the current calendar Year-Month are 2009-10,
+    DateTime#week_days will return an array of DateTime objects which when formatted with "%Y-%m-%d %a" look like 
+    ["2009-10-14 Wed", "2009-10-15 Thu", "2009-10-16 Fri", "2009-10-17 Sat", "2009-10-18 Sun", "2009-10-19 Mon", "2009-10-20 Tue"] }
     gem.email = "frogstarr78@gmail.com"
     gem.homepage = "http://github.com/frogstarr78/shifty_week"
     gem.authors = ["Scott Noel-Hemming"]
     gem.rdoc_options << '--main' << 'ShiftyWeek' << '--line-numbers'
+    gem.rubyforge_project = "shifty-week"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new
+  Jeweler::RubyforgeTasks.new do |rubyforge|
+    rubyforge.doc_task = "rdoc"
+  end
 rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
 end
@@ -42,7 +49,7 @@ end
 task :test => :check_dependencies
 
 begin
-  require 'reek/rake_task'
+  require 'reek/adapters/rake_task'
   Reek::RakeTask.new do |t|
     t.fail_on_error = true
     t.verbose = false

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/init.rb

@@ -3,7 +3,7 @@
 require 'time'
 require 'date'
 
-root_dir = File.dirname(__FILE__)
+root_dir = File.expand_path(File.dirname(__FILE__))
 require File.join(root_dir, 'lib', 'shifty_week')
 require File.join(root_dir, 'lib', 'shifty_week', 'time')
 require File.join(root_dir, 'lib', 'shifty_week', 'date')

data/lib/shifty_week.rb

@@ -30,6 +30,7 @@
 #    28 29 30 31
 
 module ShiftyWeek
+  WORKER_FORMAT = "%Y-%m-%d %H:%M:%S"
   class Constants # :nodoc:
     SUMMARY     = %q{Calculate dates based on a configurable first day of the week.}
     DESCRIPTION = %q{Calculate dates based on a configurable first day of the week. If you want
@@ -58,9 +59,9 @@ module ShiftyWeek
     Time.send("month_days", self.year, self.month)
   end
 
-  #  alculate the number of weeks in a year taking into account "shifted" weeks
+  #  Calculate the number of weeks in a year taking into account "shifted" weeks
   def weeks_in_year
-    return (self-(self.yday-1)).wday == 6 ? 54 : 53
+    return (self-(self.yday-1)).wday == 6 && self.leap? ? 54 : 53
   end
 
   # Get the offset of this object's date, to the first day of the week.
@@ -84,8 +85,8 @@ module ShiftyWeek
     working_date.week_day_start = self.week_day_start
     working_date = (working_date-working_date.send("wday_offset"))
     week_num = 0
-    working_date.step(self) { |d| 
-      if d.wday == _week_day_numbers.first
+    working_date.step(self) { |a_day| 
+      if a_day.wday == _week_day_numbers.first
         week_num += 1
       end
     }
@@ -108,12 +109,12 @@ module ShiftyWeek
   def week_days(options={}, &block)
     start_date = self
     result = []
-    (start_date-wday_offset).step 7 do |d|
-      d.week_day_start = self.week_day_start
+    (start_date-wday_offset).step 7 do |a_day|
+      a_day.week_day_start = self.week_day_start
       if block_given?
-        yield d
+        yield a_day
       else
-      result.push(d)
+        result.push(a_day)
       end
     end
     result
@@ -135,7 +136,7 @@ module ShiftyWeek
   # Hopefully the name explains what this method does
   def step_to_month_end step = 1
     days_in_month = self.days_in_month
-    days_in_month += self.wday_offset if self.days_in_month%(7*4) >= 0
+    days_in_month += self.wday_offset if days_in_month%(7*4) >= 0
     self.step(days_in_month, step) do |date| 
       date.week_day_start = self.week_day_start
       yield date

data/lib/shifty_week/date.rb

@@ -2,13 +2,6 @@ class Date
   include ShiftyWeek
 	attr_writer :week_day_start
 
-  alias_method :'weekless_>>', :'>>'
-  def >> int
-    new_day = send(:'weekless_>>', int)
-    new_day.week_day_start = self.week_day_start
-    new_day
-  end
-
   alias_method :step_to_date, :step #:nodoc:
 #   Seemed to make more sense to me to have step accept an integer number 
 #   see step_to_date for previous behavior. Although, you can still pass
@@ -19,9 +12,9 @@ class Date
       limit = (self + limit)-1
       method = 'step'
     end
-    send(method, limit, step) {|d| 
-      d.week_day_start = self.week_day_start
-      yield d 
+    send(method, limit, step) {|a_day| 
+      a_day.week_day_start = self.week_day_start
+      yield a_day 
     }
   end
 end

data/test/date_test.rb

@@ -1,6 +1,7 @@
 require 'test/test_helper'
 
 class DateTest < Test::Unit::TestCase
+  FORMAT = 
 	def test_step
 		date = Date.strptime Time.now.strftime("%Y-%m-%d")
 		future_date = date+6

data/test/shifty_week_test.rb

@@ -1,63 +1,7 @@
 require 'test_helper'
 
 class ShiftyWeekTest < Test::Unit::TestCase
-  def test_week_starting_sunday
-      month_starts = [
-   %w(Su Mo Tu We Th Fr Sa
-      \  \   1  2  3  4  5
-       6  7  8  9 10 11 12
-      13 14 15 16 17 18 19
-      20 21 22 23 24 25 26
-      27 28 29 30 31),
-
-   %w(Mo Tu We Th Fr Sa Su
-      \   1  2  3  4  5  6
-       7  8  9 10 11 12 13
-      14 15 16 17 18 19 20
-      21 22 23 24 25 26 27
-      28 29 30 31),
-
-   %w(Tu We Th Fr Sa Su Mo
-       1  2  3  4  5  6  7
-       8  9 10 11 12 13 14
-      15 16 17 18 19 20 21
-      22 23 24 25 26 27 28
-      29 30 31),
-
-   %w(We Th Fr Sa Su Mo Tu
-      \  \  \  \  \  \   1
-       2  3  4  5  6  7  8
-       9 10 11 12 13 14 15
-      16 17 18 19 20 21 22
-      23 24 25 26 27 28 29
-      30 31),
-
-   %w(Th Fr Sa Su Mo Tu We
-      \  \  \  \  \   1  2
-       3  4  5  6  7  8  9
-      10 11 12 13 14 15 16
-      17 18 19 20 21 22 23
-      24 25 26 27 28 29 30
-      31),
-
-   %w(Fr Sa Su Mo Tu We Th
-      \  \  \  \   1  2  3
-       4  5  6  7  8  9 10
-      11 12 13 14 15 16 17
-      18 19 20 21 22 23 24
-      25 26 27 28 29 30 31),
-
-   %w(Sa Su Mo Tu We Th Fr
-      \  \  \   1  2  3  4
-       5  6  7  8  9 10 11
-      12 13 14 15 16 17 18
-      19 20 21 22 23 24 25
-      26 27 28 29 30 31)
-     ]
-  end
-
-	def test_week
-
+	def test_week_control
     date = DateTime.new(2008, 1, 6)
     assert_equal(0, date.send("wday_offset"))
     assert_equal(2, date.week, "week #{date.week} on date #{date.to_s} != 2")
@@ -65,7 +9,9 @@ class ShiftyWeekTest < Test::Unit::TestCase
     date = date-1
     assert_equal(6, date.send("wday_offset"))
     assert_equal(1, date.week, "week #{date.week} on date #{date.to_s} != 2")
+  end
 
+  def test_week_expected_for_a_few_years
     years_days = {
         2000 => 2,
         2001 => 7,	
@@ -81,7 +27,9 @@ class ShiftyWeekTest < Test::Unit::TestCase
         date = DateTime.new(year, 1, day)
         assert_equal(2, date.week, "week #{date.week} on date #{date.to_s} != 1")
     }
+  end
 
+  def test_week_changes_calculate_correctly
 		date = DateTime.new(2008, 1, 3)
 		date.week_day_start = 'Wed'
 		assert_equal(1, date.send("wday_offset"))
@@ -98,7 +46,9 @@ class ShiftyWeekTest < Test::Unit::TestCase
 		assert_equal(6, date.send("wday_offset"))
 		assert_equal("2008-01-01", date.strftime("%Y-%m-%d"))
 		assert_equal(1, date.week, "week #{date.week} on date #{date.to_s} != 1 with wday_start #{date.week_day_start}")
+  end
 
+  def test_week
 		date = DateTime.new(2007)
 		date.week_day_start = 'Sunday'
 		assert_equal(1, date.week, "week #{date.week} on date #{date.to_s} != 1")
@@ -108,74 +58,21 @@ class ShiftyWeekTest < Test::Unit::TestCase
 		date = (date+7)
 #		date = DateTime.new(2007, 9, 1)
 		assert_equal(35, date.week, "week #{date.week} on date #{date.to_s} != 35")
+  end
 
-		years_days = {
-			1998 => 53,
-			1999 => 53,
-			2000 => 54,
-			2001 => 53,	
-			2002 => 53,	
-			2003 => 53,	
-			2004 => 53,	
-			2005 => 53,	
-			2006 => 53,	
-			2007 => 53,	
-			2008 => 53,	
-			2009 => 53,	
-			2010 => 53,	
-			2011 => 53,	
-			2012 => 53,	
-			2013 => 53,	
-			2014 => 53,	
-			2015 => 53,	
-			2016 => 53,	
-		}.each { |year, weeks|
+  def test_week_gets_correct_last_week_number
+    years_days_to_test.each { |year, weeks|
 			date = DateTime.new(year, 12, 31)
-			assert_equal(weeks, date.week, "week #{date.week} in year #{year} != 1")
+			assert_equal(date.weeks_in_year, date.week, "week #{date.week} in year #{year} != 1")
 		}
+  end
 
-		for year in (2000..2006)
+  def test_expected_week_one_regardless_of_year
+		(2000..2006).each do |year|
 			day = 1
-				date = DateTime.new(year, 1, day)
-				assert_equal(1, date.week, "week #{date.week} on date #{date.to_s} != 1")
-#			end
+      date = DateTime.new(year, 1, day)
+      assert_equal(1, date.week, "week #{date.week} on date #{date.to_s} != 1")
 		end
-
-#		date = DateTime.new(2003, 1, 1)
-#		week = date.week(4)
-#		assert_equal(week, 1, "week #{week} on date #{date.to_s} != 1")
-#		date = DateTime.new(2003, 1, 2)
-#		week = date.week(4)
-#		assert_equal(week, 2, "week #{week} on date #{date.to_s} != 2")
-#		week = date.week(10)
-#		assert_equal(week, 2, "week #{week} on date #{date.to_s} != 2")
-#		date = DateTime.new(2003, 1, 3)
-#		week = date.week(4)
-#		assert_equal(week, 2, "week #{week} on date #{date.to_s} != 2")
-	end
-
-	def test_weeks_in_year
-		years_days = {
-			2000 => 54,
-			2001 => 53,	
-			2002 => 53,	
-			2003 => 53,	
-			2004 => 53,	
-			2005 => 54,	
-			2006 => 53,	
-			2007 => 53,	
-			2008 => 53,	
-			2009 => 53,	
-			2010 => 53,	
-			2011 => 54,	
-			2012 => 53,	
-			2013 => 53,	
-			2014 => 53,	
-			2015 => 53,	
-		}.each { |year, weeks|
-			date = DateTime.new(year, 12, 31)
-			assert_equal weeks, date.weeks_in_year, "week #{date.week} on date #{date.to_s} != 1"
-		}
 	end
 
 	def test_wday_offset
@@ -187,7 +84,7 @@ class ShiftyWeekTest < Test::Unit::TestCase
 		}
 	end
 
-	def test_week_days
+	def test_week_days_control
 		date = DateTime.new(2007)
 		assert_equal([
 				DateTime.new(2006, 12, 31).to_s, 
@@ -200,6 +97,9 @@ class ShiftyWeekTest < Test::Unit::TestCase
 			], 
 			date.week_days.collect {|date| date.to_s}
 		)
+  end
+
+  def test_week_days_span_month_and_year_boundary_with_configured_week_day_start
 		date = DateTime.new(2007)
 		date.week_day_start = 'Saturday'
 		assert_equal([
@@ -212,7 +112,9 @@ class ShiftyWeekTest < Test::Unit::TestCase
 				DateTime.new(2007, 1, 5).to_s,
 			], date.week_days.collect {|date| date.to_s}
 		)
+  end
 
+  def test_week_days_dont_span_month_and_year_boundary_and_leap_year_because_of_configured_week_day_start
 		date = DateTime.new(2008)
 		date.week_day_start = 'Tue'
 		assert_equal([
@@ -225,6 +127,9 @@ class ShiftyWeekTest < Test::Unit::TestCase
 				DateTime.new(2008, 1, 7).to_s, 
 			], date.week_days.collect {|date| date.to_s}
 		)
+  end
+
+  def test_week_days_span_month_and_year_boundary_and_leap_year_because_of_configured_week_day_start
 		date = DateTime.new(2008)
 		date.week_day_start = 'Wed'
 		assert_equal([
@@ -237,9 +142,10 @@ class ShiftyWeekTest < Test::Unit::TestCase
 				DateTime.new(2008, 1, 1).to_s,
 			], date.week_days.collect {|date| date.to_s}
 		)
+  end
 
-
-		date = DateTime.new(2003)
+  def test_week_days_span_month_and_year_boundary_non_leap_year_with_non_configured_week_day_start
+    date = DateTime.new(2003)
 		assert_equal([
 				DateTime.new(2002, 12, 29).to_s, 
 				DateTime.new(2002, 12, 30).to_s, 
@@ -251,57 +157,59 @@ class ShiftyWeekTest < Test::Unit::TestCase
 			], 
 			date.week_days.collect {|date| date.to_s}
 		)
+  end
+
+  def unshifted_week_spanning_month_and_year
+    [
+      DateTime.new(2007, 12, 30).to_s, 
+      DateTime.new(2007, 12, 31).to_s, 
+      DateTime.new(2008, 1, 1).to_s,
+      DateTime.new(2008, 1, 2).to_s,
+      DateTime.new(2008, 1, 3).to_s,
+      DateTime.new(2008, 1, 4).to_s,
+      DateTime.new(2008, 1, 5).to_s,
+    ]
+  end
+
+  def shifted_week_after_spanning_month_and_year_unshifted
+    [
+      DateTime.new(2008, 1, 1).to_s,
+      DateTime.new(2008, 1, 2).to_s,
+      DateTime.new(2008, 1, 3).to_s,
+      DateTime.new(2008, 1, 4).to_s,
+      DateTime.new(2008, 1, 5).to_s,
+      DateTime.new(2008, 1, 6).to_s,
+      DateTime.new(2008, 1, 7).to_s,
+    ]
+  end
+
+  def re_shifted_week_after_spanning_month_and_year_unshifted
+    [
+      DateTime.new(2008, 1, 2).to_s,
+      DateTime.new(2008, 1, 3).to_s,
+      DateTime.new(2008, 1, 4).to_s,
+      DateTime.new(2008, 1, 5).to_s,
+      DateTime.new(2008, 1, 6).to_s,
+      DateTime.new(2008, 1, 7).to_s,
+      DateTime.new(2008, 1, 8).to_s,
+    ]
+  end
+  private :unshifted_week_spanning_month_and_year, :shifted_week_after_spanning_month_and_year_unshifted, :re_shifted_week_after_spanning_month_and_year_unshifted
+
+  def test_week_days_span_month_and_year_boundary_non_leap_year_changing_the_week_day_start
 		date = DateTime.new(2007, 12, 31)
-		assert_equal([
-				DateTime.new(2007, 12, 30).to_s, 
-				DateTime.new(2007, 12, 31).to_s, 
-				DateTime.new(2008, 1, 1).to_s,
-				DateTime.new(2008, 1, 2).to_s,
-				DateTime.new(2008, 1, 3).to_s,
-				DateTime.new(2008, 1, 4).to_s,
-				DateTime.new(2008, 1, 5).to_s,
-			], 
-			date.week_days.collect {|date| date.to_s}
-		)
+		assert_equal(unshifted_week_spanning_month_and_year, date.week_days.collect {|date| date.to_s})
 		assert_equal('2008-01-05', date.strftime("%Y-%m-%d"))
-		date.week_day_start = 2
-		assert_equal([
-				DateTime.new(2008, 1, 1).to_s,
-				DateTime.new(2008, 1, 2).to_s,
-				DateTime.new(2008, 1, 3).to_s,
-				DateTime.new(2008, 1, 4).to_s,
-				DateTime.new(2008, 1, 5).to_s,
-				DateTime.new(2008, 1, 6).to_s,
-				DateTime.new(2008, 1, 7).to_s,
-			],
-			date.week_days.collect {|date| date.to_s }
-		)
 
+		date.week_day_start = 2
+		assert_equal(shifted_week_after_spanning_month_and_year_unshifted, date.week_days.collect {|date| date.to_s })
 		assert_equal('2008-01-07', date.strftime("%Y-%m-%d"))
+
 		date.week_day_start = 'We'
-		assert_equal([
-				DateTime.new(2008, 1, 2).to_s,
-				DateTime.new(2008, 1, 3).to_s,
-				DateTime.new(2008, 1, 4).to_s,
-				DateTime.new(2008, 1, 5).to_s,
-				DateTime.new(2008, 1, 6).to_s,
-				DateTime.new(2008, 1, 7).to_s,
-				DateTime.new(2008, 1, 8).to_s,
-			],
-			date.week_days.collect {|date| date.to_s }
-		)
+		assert_equal(re_shifted_week_after_spanning_month_and_year_unshifted, date.week_days.collect {|date| date.to_s })
 	end
 
   def test_step_to_month_end
-#    expected_display = {
-#    %w(January 2009) => 
-#    %w(Su Mo Tu We Th Fr Sa
-#       28 29 30 31  1  2  3
-#        4  5  6  7  8  9 10
-#       11 12 13 14 15 16 17
-#       18 19 20 21 22 23 24
-#       25 26 27 28 29 30 31)
-#    }
     expected_display = {
     %w(January 2009) => 
     %w(
@@ -354,4 +262,28 @@ class ShiftyWeekTest < Test::Unit::TestCase
 		assert_equal(DateTime.new(2007, 11).last_week_day, 5);
 		assert_equal(DateTime.new(2007, 12).last_week_day, 1);
 	end
+
+  private
+    
+		def years_days_to_test
+      { 1998 => 53,
+        1999 => 53,
+        2000 => 54,
+        2001 => 53,	
+        2002 => 53,	
+        2003 => 53,	
+        2004 => 53,	
+        2005 => 53,	
+        2006 => 53,	
+        2007 => 53,	
+        2008 => 53,	
+        2009 => 53,	
+        2010 => 53,	
+        2011 => 53,	
+        2012 => 53,	
+        2013 => 53,	
+        2014 => 53,	
+        2015 => 53,	
+        2016 => 53	}
+    end
 end

data/test/test_helper.rb

@@ -4,4 +4,5 @@ require 'test/unit'
 require 'shifty_week'
 
 class Test::Unit::TestCase
+  DATE_AND_TIME_FORMAT = "%a %Y-%m-%d %X %p"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: shifty_week
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Scott Noel-Hemming
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-19 00:00:00 -07:00
+date: 2009-11-08 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
@@ -68,7 +68,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: shifty-week
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3