workpattern 0.3.6 → 0.4.0

data/lib/workpattern/workpattern.rb

@@ -277,8 +277,8 @@ module Workpattern
     # 
     def clone_and_adjust_current_wp(current_wp, current_start,current_finish,clone_start,clone_finish=nil)
       clone_wp=current_wp.duplicate
-      current_wp.adjust(current_start,current_finish)
-      clone_finish.nil? ? clone_wp.adjust(clone_start,clone_wp.finish) : clone_wp.adjust(clone_start,clone_finish)
+      adjust_date_range(current_wp,current_start,current_finish)
+      clone_finish.nil? ? adjust_date_range(clone_wp,clone_start,clone_wp.finish) : adjust_date_range(clone_wp, clone_start,clone_finish)
       return clone_wp
     end
 
@@ -286,6 +286,11 @@ module Workpattern
       new_wp.workpattern(args[:days],args[:from_time],args[:to_time],args[:work_type])
       weeks<< new_wp
     end
+
+    def adjust_date_range(week_pattern,start_date,finish_date)
+      week_pattern.start = start_date
+      week_pattern.finish = finish_date
+    end
   end
 end
     

data/test/test_week.rb

@@ -5,6 +5,7 @@ class TestWeek < MiniTest::Unit::TestCase #:nodoc:
   def setup
     start=DateTime.new(2000,1,3)
     finish=DateTime.new(2000,1,9)
+
     @working_week=Workpattern::Week.new(start,finish,1)
 
     @resting_week=Workpattern::Week.new(start,finish,0)
@@ -14,33 +15,46 @@ class TestWeek < MiniTest::Unit::TestCase #:nodoc:
     @pattern_week.workpattern(:weekday,Workpattern.clock(0,0),Workpattern.clock(8,59),0)
     @pattern_week.workpattern(:weekday,Workpattern.clock(12,30),Workpattern.clock(13,0),0)
     @pattern_week.workpattern(:weekday,Workpattern.clock(17,0),Workpattern.clock(23,59),0)
-    
+
   end
 
-  def test_must_diff_from_last_day_of_patterned_week
-    #issue 15
-    start=DateTime.new(2013,9,23,0,0)
-    finish=DateTime.new(2013,9,26,23,59)
-    working_week=week(start,finish,1)
-    working_week.workpattern :all, Workpattern.clock(0,0),Workpattern.clock(8,59),0
-    working_week.workpattern :all, Workpattern.clock(12,0),Workpattern.clock(12,59),0
-    working_week.workpattern :all, Workpattern.clock(18,0),Workpattern.clock(23,59),0
 
-    duration, start =working_week.diff(DateTime.civil(2013,9,26,17,0),DateTime.civil(2013,9,27,10,0))
-
-    assert_equal 60, duration
-    assert_equal DateTime.civil(2013,9,27,0,0), start
-  end
-  
   def test_must_create_a_working_week
     start=DateTime.new(2000,1,1,11,3)
     finish=DateTime.new(2005,12,31,16,41)
     working_week=week(start,finish,1)
     assert_equal DateTime.new(start.year,start.month,start.day), working_week.start
     assert_equal DateTime.new(finish.year,finish.month,finish.day), working_week.finish
-    assert_equal 3156480, working_week.total#2192
+    assert_equal 3156480, working_week.total #2192 days
+  end
+
+  def test_create_working_week_of_3_concecutive_days
+    start=DateTime.new(2000,1,2,11,3) # Sunday
+    finish=DateTime.new(2000,1,4,16,41) # Tuesday
+    working_week=week(start,finish,1)
+    assert_equal DateTime.new(start.year,start.month,start.day), working_week.start
+    assert_equal DateTime.new(finish.year,finish.month,finish.day), working_week.finish
+    assert_equal 1440 * 3, working_week.total #3 days
   end
-    
+
+  def test_create_working_week_f_to_Su
+    start=DateTime.new(2000,1,7,11,3) # Friday
+    finish=DateTime.new(2000,1,9,16,41) # Sunday
+    working_week=week(start,finish,1)
+    assert_equal DateTime.new(start.year,start.month,start.day), working_week.start
+    assert_equal DateTime.new(finish.year,finish.month,finish.day), working_week.finish
+    assert_equal 1440 * 3, working_week.total #3 days
+  end
+
+  def test_create_working_week_Th_to_Su
+    start=DateTime.new(2000,1,6,11,3) # Thursday
+    finish=DateTime.new(2000,1,8,16,41) # Sunday
+    working_week=week(start,finish,1)
+    assert_equal DateTime.new(start.year,start.month,start.day), working_week.start
+    assert_equal DateTime.new(finish.year,finish.month,finish.day), working_week.finish
+    assert_equal 1440 * 3, working_week.total #3 days
+  end
+
   def test_must_create_a_resting_week
     start=DateTime.new(2000,1,1,11,3)
     finish=DateTime.new(2005,12,31,16,41)
@@ -50,7 +64,7 @@ class TestWeek < MiniTest::Unit::TestCase #:nodoc:
     assert_equal 0, resting_week.total#2192
     assert_equal 0,resting_week.week_total
   end
-  
+
   def test_must_duplicate_all_of_a_week
     start=DateTime.new(2000,1,1,11,3)
     finish=DateTime.new(2005,12,31,16,41)
@@ -59,7 +73,8 @@ class TestWeek < MiniTest::Unit::TestCase #:nodoc:
     assert_equal DateTime.new(start.year,start.month,start.day), new_week.start
     assert_equal DateTime.new(finish.year,finish.month,finish.day), new_week.finish
     assert_equal 3156480, new_week.total#2192
-    
+    week.workpattern(:weekend,Workpattern.clock(0,0),Workpattern.clock(23,59),0)
+    assert_equal 3156480, new_week.total#2192
   end
 
   def test_must_set_week_pattern_correctly
@@ -79,7 +94,7 @@ class TestWeek < MiniTest::Unit::TestCase #:nodoc:
     pattern_week.workpattern(:weekday,Workpattern.clock(17,0),Workpattern.clock(23,59),0)
     assert_equal 2245, pattern_week.week_total
   end
-  
+
   def test_must_set_patterns_correctly
     start=DateTime.new(2000,1,1,0,0)
     finish=DateTime.new(2005,12,31,8,59)
@@ -203,7 +218,7 @@ class TestWeek < MiniTest::Unit::TestCase #:nodoc:
     assert_equal 0, result_duration
   end
 
-  def test_must_add_minutes_from_working_in_a_working_week_result_in_later_day
+  def test_must_add_minutes_from_working_in_a_pattern_week_result_in_later_day
     result_date, result_duration, midnight_flag = @pattern_week.calc(DateTime.new(2000,1,3,10,11),828)
     assert_equal DateTime.new(2000,1,5,9,1), result_date
     refute midnight_flag
@@ -397,7 +412,20 @@ class TestWeek < MiniTest::Unit::TestCase #:nodoc:
 
 ### @pattern_week centric
 
-  
+  def must_diff_day_week_day_in_patterned_week
+    start=DateTime.new(2013,9,23,0,0)
+    finish=DateTime.new(2013,10,20,23,59)
+    working_week=week(start,finish,1)
+    working_week.workpattern :all, Workpattern.clock(0,0),Workpattern.clock(8,59),0
+    working_week.workpattern :all, Workpattern.clock(12,0),Workpattern.clock(12,59),0
+    working_week.workpattern :all, Workpattern.clock(18,0),Workpattern.clock(23,59),0
+
+    duration, start =working_week.diff(DateTime.civil(2013,10,3,16,0),DateTime.civil(2013,10,15,12,30))
+
+    assert_equal 5640, duration
+    assert_equal DateTime.civil(2013,10,15,12,30), start
+ 
+  end  
   def test_must_calculate_difference_between_dates_in_working_week
     late_date=DateTime.new(2000,1,6,9,32)
     early_date=DateTime.new(2000,1,6,8,20)
@@ -421,6 +449,51 @@ class TestWeek < MiniTest::Unit::TestCase #:nodoc:
     assert_equal 1, result_dur
     assert_equal late_date, result_date
   end
+
+  def test_must_diff_from_last_day_of_patterned_week
+    #issue 15
+    start=DateTime.new(2013,9,23,0,0)
+    finish=DateTime.new(2013,9,26,23,59)
+    working_week=week(start,finish,1)
+    working_week.workpattern :all, Workpattern.clock(0,0),Workpattern.clock(8,59),0
+    working_week.workpattern :all, Workpattern.clock(12,0),Workpattern.clock(12,59),0
+    working_week.workpattern :all, Workpattern.clock(18,0),Workpattern.clock(23,59),0
+
+    duration, start =working_week.diff(DateTime.civil(2013,9,26,17,0),DateTime.civil(2013,9,27,10,0))
+
+    assert_equal 60, duration
+    assert_equal DateTime.civil(2013,9,27,0,0), start
+  end
+
+  def test_must_diff_long_distances_beyond_end_of_patterned_week
+    start=DateTime.new(2013,9,23,0,0)
+    finish=DateTime.new(2013,10,20,23,59)
+    working_week=week(start,finish,1)
+    working_week.workpattern :all, Workpattern.clock(0,0),Workpattern.clock(8,59),0
+    working_week.workpattern :all, Workpattern.clock(12,0),Workpattern.clock(12,59),0
+    working_week.workpattern :all, Workpattern.clock(18,0),Workpattern.clock(23,59),0
+
+    duration, start =working_week.diff(DateTime.civil(2013,9,26,17,0),DateTime.civil(2018,9,27,10,0))
+
+    assert_equal 11580, duration
+    assert_equal DateTime.civil(2013,10,21,0,0), start
+
+  end
+
+  def test_must_diff_long_distances_within_patterned_week
+    start=DateTime.new(2013,9,23,0,0)
+    finish=DateTime.new(2013,10,20,23,59)
+    working_week=week(start,finish,1)
+    working_week.workpattern :all, Workpattern.clock(0,0),Workpattern.clock(8,59),0
+    working_week.workpattern :all, Workpattern.clock(12,0),Workpattern.clock(12,59),0
+    working_week.workpattern :all, Workpattern.clock(18,0),Workpattern.clock(23,59),0
+
+    duration, start =working_week.diff(DateTime.civil(2013,9,26,17,0),DateTime.civil(2013,10,15,10,0))
+
+    assert_equal 8760, duration
+    assert_equal DateTime.civil(2013,10,15,10,0), start
+
+  end
   
   private
   
@@ -432,4 +505,3 @@ class TestWeek < MiniTest::Unit::TestCase #:nodoc:
     return Workpattern.clock(hour,min)
   end 
 end
-

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: workpattern
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.4.0
 platform: ruby
 authors:
 - Barrie Callender
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-25 00:00:00.000000000 Z
+date: 2014-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.9.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.9.2
 description: Workpattern performs date calculations that take into account working
@@ -32,8 +32,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
+- .gitignore
+- .travis.yml
 - CHANGELOG
 - Gemfile
 - README.md
@@ -41,8 +41,6 @@ files:
 - config/website.yml
 - lib/workpattern.rb
 - lib/workpattern/clock.rb
-- lib/workpattern/day.rb
-- lib/workpattern/hour.rb
 - lib/workpattern/utility/base.rb
 - lib/workpattern/version.rb
 - lib/workpattern/week.rb
@@ -52,9 +50,7 @@ files:
 - script/generate
 - script/txt2html
 - test/test_clock.rb
-- test/test_day.rb
 - test/test_helper.rb
-- test/test_hour.rb
 - test/test_week.rb
 - test/test_workpattern.rb
 - test/test_workpattern_module.rb
@@ -69,12 +65,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []

data/lib/workpattern/day.rb

@@ -1,343 +0,0 @@
-module Workpattern
-  
-  # @author Barrie Callender
-  # @!attribute values
-  #   @return [Array] each hour of the day
-  # @!attribute hours
-  #   @return [Integer] number of hours in the day
-  # @!attribute first_hour
-  #   @return [Integer] first working hour in the day
-  # @!attribute first_min
-  #   @return [Integer] first working minute in first working hour in the day
-  # @!attribute last_hour
-  #   @return [Integer] last working hour in the day
-  # @!attribute last_min
-  #   @return [Integer] last working minute in last working hour in the day
-  # @!attribute total
-  #   @return [Integer] total number of minutes in the day
-  #  
-  # Represents the 24 hours of a day.
-  #
-  # @since 0.2.0
-  # @todo implement a day with different number of hours in it to support daylight saving
-  #
-  class Day
-    include Workpattern::Utility
-    attr_accessor :values, :hours, :first_hour, :first_min, :last_hour, :last_min, :total
-    
-    # The new <tt>Day</tt> object can be created as either working or resting.
-    #
-    # @param [Integer] type is working (1) or resting (0)
-    #
-    def initialize(type=1)
-      @hours=24
-      hour=WORKING_HOUR if type==1
-      hour=RESTING_HOUR if type==0
-      @values=Array.new(@hours) {|index| hour }
-    end
-    
-    # Creates a duplicate of the current <tt>Day</tt> instance.
-    #
-    # @return [Day] 
-    #
-    def duplicate
-      duplicate_day = Day.new()
-      duplicate_values=Array.new(self.values.size)
-      self.values.each_index {|index|
-        duplicate_values[index]=self.values[index]
-        }
-      duplicate_day.values=duplicate_values
-      duplicate_day.hours = self.hours
-      duplicate_day.first_hour=self.first_hour
-      duplicate_day.first_min=self.first_min
-      duplicate_day.last_hour=self.last_hour
-      duplicate_day.last_min=self.last_min
-      duplicate_day.total = self.total
-      duplicate_day.refresh
-      return duplicate_day
-    end
-    
-    # Recalculates characteristics for this day
-    # no longer required as calculating individually is faster
-    #
-    def refresh
-      
-    end
-    
-    # Sets all minutes in a date range to be working or resting.
-    #
-    # @param [(#hour,#min)] start_time is the start of the range to set
-    # @param [(#hour, #min)] finish_time is the finish of the range to be set
-    # @param [Integer] type is either working (1) or resting (0)
-    #
-    def workpattern(start_time,finish_time,type)
-    
-      if start_time.hour==finish_time.hour
-        self.values[start_time.hour]=self.values[start_time.hour].wp_workpattern(start_time.min,finish_time.min,type)
-      else
-        test_hour=start_time.hour
-        self.values[test_hour]=self.values[test_hour].wp_workpattern(start_time.min,59,type)
-        
-        while ((test_hour+1)<finish_time.hour)
-          test_hour+=1
-          self.values[test_hour]=self.values[test_hour].wp_workpattern(0,59,type)     
-        end
-        
-        self.values[finish_time.hour]=self.values[finish_time.hour].wp_workpattern(0,finish_time.min,type)
-      end
-      
-    end
-    
-    # Calculates the result of adding <tt>duration</tt> to
-    # <tt>time</tt>.  The <tt>duration</tt> can be negative in
-    # which case it subtracts from <tt>time</tt>.
-    #
-    # An addition where there are less working minutes left in 
-    # the day than are being added will result in the time 
-    # returned being 00:00 on the following day.
-    #
-    # A subtraction where there are less working minutes left in
-    # the day than are being added will result in the time 
-    # returned being the previous day with the <tt>midnight</tt> flag set to true.
-    #
-    # @param [DateTime] time when the calculation starts from
-    # @param [Integer] duration is the number of minutes to add or subtract if it is negative
-    # @param [Boolean] midnight is a flag used in subtraction to pretend the time is actually midnight
-    # @return [DateTime,Integer,Boolean] Calculated time along with any remaining duration and the midnight flag
-    # 
-    def calc(time,duration,midnight=false)
-    
-      if (duration<0)
-        return subtract(time,duration, midnight)  
-      elsif (duration>0)
-        return add(time,duration)                
-      else
-        return time,duration, false
-      end
-    
-    end
-    
-    # Returns true if the given minute is working and false if it is resting
-    #
-    # @param [(#hour, #min)] start is the time in the day to inspect
-    # @return [Boolean] true if the time is working and false if it is resting
-    #
-    def working?(start)
-      return true if minutes(start.hour,start.min,start.hour,start.min)==1
-      return false
-    end
-    
-    # Returns the difference in working minutes between two times.
-    #
-    # @param [(#hour, #min)] start start time in the range
-    # @param [(#hour, #min)] finish finish time in the range
-    # @return [Integer] number of working minutes
-    #
-    def diff(start,finish)
-      start,finish=finish,start if ((start <=> finish))==1
-      # calculate to end of hour
-      #
-      if (start.jd==finish.jd) # same day
-        duration=minutes(start.hour,start.min,finish.hour, finish.min)
-        duration -=1 if working?(finish)
-        start=finish
-      else
-        duration=minutes(start.hour,start.min,23, 59)
-        start=start+((23-start.hour)*HOUR) +((60-start.min)*MINUTE)
-      end
-      return duration, start
-    end
-    
-    # Returns the total number of minutes between two times.
-    #
-    # @param [Integer] start_hour first hour in range
-    # @param [Integer] start_min first minute of first hour in range
-    # @param [Integer] finish_hour last hour in range
-    # @param [Integer] finish_min last minute of last hour in range
-    # @return [Integer] minutes between supplied hours and minutes
-    #
-    # @todo can this method and #diff method be combined?
-    #
-    def minutes(start_hour,start_min,finish_hour,finish_min)
-      
-      if (start_hour > finish_hour) || ((finish_hour==start_hour) && (start_min > finish_min))
-        start_hour,start_min,finish_hour,finish_min=finish_hour,finish_min,start_hour,finish_min 
-      end
-      
-      if (start_hour==finish_hour)     
-        retval=self.values[start_hour].wp_minutes(start_min,finish_min)
-      else
-    
-        retval=self.values[start_hour].wp_minutes(start_min,59)
-        while (start_hour+1<finish_hour)        
-          retval+=self.values[start_hour+1].wp_total     
-          start_hour+=1
-        end
-        retval+=self.values[finish_hour].wp_minutes(0,finish_min)
-      end
-        
-      return retval
-    end
-
-    
-    def first_hour
-      0.upto(self.hours-1) do |index|
-        return index if self.values[index].wp_total!=0
-      end
-      return nil
-    end
-    
-    def first_min
-      0.upto(self.hours-1) do |index|
-       return self.values[index].wp_first if !self.values[index].wp_first.nil?
-      end
-      return nil
-    end
-    
-    def last_hour
-      (self.hours-1).downto(0) do |index|
-        return index if self.values[index].wp_total!=0
-      end
-      return nil
-    end
-
-    def last_min
-      (self.hours-1).downto(0) do |index|
-        return self.values[index].wp_last if self.values[index].wp_total!=0
-      end
-      return nil
-    end
-
-    def total
-      total_minutes=0
-      0.upto(self.hours-1) do |index|
-        total_minutes+=self.values[index].wp_total
-      end
-      return total_minutes
-    end
-    private
-    
-    
-    # Returns the first working minute as a <tt>DateTime</tt> or <tt>oo:oo</tt>
-    # when there is no working minutes in the day.  Used by the <tt>#subtract</tt> method
-    #
-    # @param [DateTime] time day for which the first working time is sought.
-    # @return [DateTime] the first working time of the day
-    #
-    def first_working_minute(time)
-      if self.first_hour.nil?
-        return time - (HOUR*time.hour) - (MINUTE*time.min)
-      else  
-        time = time - HOUR * (time.hour - self.first_hour)
-        time = time - MINUTE * (time.min - self.first_min )
-        return time
-      end  
-    end
-    
-    # Handles the subtraction of a duration from a time in the day.
-    # 
-    # @param [DateTime] time when the subtraction starts from
-    # @param [Integer] duration is the number of minutes to subtract from the <tt>time</tt>
-    # @param [Boolean] midnight is a flag used in subtraction to pretend the time is actually midnight
-    # @return [DateTime,Integer,Boolean] Calculated time along with any remaining duration and the midnight flag
-    #
-    def subtract(time,duration,midnight=false)    
-      if (time.hour==0 && time.min==0)
-        if midnight      
-          duration+=minutes(23,59,23,59)
-          time=time+(HOUR*23)+(MINUTE*59)
-          return calc(time,duration)
-        else
-          return time.prev_day, duration,true  
-        end
-      elsif (time.hour==self.first_hour && time.min==self.first_min)
-        time=time-(HOUR*self.first_hour) - (MINUTE*self.first_min)
-        return time.prev_day, duration, true  
-      elsif (time.min>0)
-        available_minutes=minutes(0,0,time.hour,time.min-1) 
-      else  
-        available_minutes=minutes(0,0,time.hour-1,59)
-      end  
-      if ((duration+available_minutes)<0) # not enough minutes in the day  
-        time = midnight_before(time.prev_day) 
-        duration = duration + available_minutes
-        return time, duration, true
-      elsif ((duration+available_minutes)==0)
-        duration=0
-        time=first_working_minute(time)  
-      else
-        minutes_this_hour=self.values[time.hour].wp_minutes(0,time.min-1)
-        this_hour=time.hour
-        until (duration==0)
-          if (minutes_this_hour<duration.abs)     
-            duration+=minutes_this_hour
-            time = time - (MINUTE*time.min) - HOUR
-            this_hour-=1
-            minutes_this_hour=self.values[this_hour].wp_total
-          else
-            next_hour=(time.min==0)
-            time,duration=self.values[this_hour].wp_calc(time,duration, next_hour)
-          end
-        end
-      end  
-      return time,duration, false
-    end
-    
-    # Returns the result of adding <tt>duration</tt> to the given <tt>time</tt>
-    # When there are not enough minutes in the day it returns the date
-    # for the start of the following day.
-    #
-    # @param [DateTime] time when the calculation starts from
-    # @param [Integer] duration is the number of minutes to add
-    # @return [DateTime,Integer] Calculated time along with any remaining duration
-    #
-    def add(time,duration)
-      available_minutes=minutes(time.hour,time.min,self.hours-1,59)   
-      if ((duration-available_minutes)>0) # not enough minutes left in the day      
-
-        result_date= time.next_day - (HOUR*time.hour) - (MINUTE*time.min)
-        duration = duration - available_minutes      
-      else
-        total=self.values[time.hour].wp_minutes(time.min,59)
-        if (total==duration) # this hour satisfies              
-          result_date=time - (MINUTE*time.min) + (MINUTE*self.values[time.hour].wp_last) + MINUTE                   
-          duration = 0
-        else  
-          result_date = time
-          until (duration==0)
-            if (total<duration)
-              duration-=total
-              result_date=result_date + HOUR - (MINUTE*result_date.min)
-            else
-              result_date,duration=self.values[result_date.hour].wp_calc(result_date,duration)     
-            end
-            total=self.values[result_date.hour].wp_total
-          end
-        end
-      end    
-      return result_date,duration, false
-    end
-    
-    # Returns the start of the next hour.
-    #
-    # The next hour could be the start of the following day.
-    #
-    # @param [DateTime] start is the <tt>DateTime</tt> for which the following hour is required.
-    # @return [DateTime] the start of the next hour following the <tt>DateTime</tt> supplied
-    #
-    def next_hour(start)
-      return start+HOUR-(start.min*MINUTE) 
-    end
-    
-    # Returns the number of working minutes left in the current hour
-    #
-    # @param [DateTime] start is the <tt>DateTime</tt> for which the remaining working minutes 
-    #                   in the hour are required
-    # @return [Integer] number of remaining working minutes
-    #
-    def minutes_left_in_hour(start)
-      return self.values[start.hour].wp_diff(start.min,60)
-    end
-    
-  end
-end