workpattern 0.2.0

data/.gitignore

@@ -0,0 +1,2 @@
+doc
+pkg

data/CHANGELOG

@@ -0,0 +1,4 @@
+## Workpattern v0.2.0 (May 31, 2012)  ##
+
+*   Rewritten from scratch effectively first version * Barrie Callender *
+* Please discard any version of Workpattern before this - some poor souls may have come across v0.1.0. - sorry! * Barrie Callender *

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in workpattern.gemspec
+gemspec

data/README.md

@@ -0,0 +1,71 @@
+## What?
+
+Simple addition and subtraction of minutes on dates taking account of real-life working and resting periods.
+
+This gem has the potential to serve as the engine for scheduling algorithms that are the core of products such as Microsoft Project and Oracle Primavera P6 as well as other applications that need to know when they can perform work and when they can’t.
+
+## Install
+
+  `sudo gem install workpattern`
+
+## Getting Started
+
+The first step is to create a **Workpattern** to hold all the working and resting times.  I'll start in 2011 and let it run for 10 years.
+
+``` ruby
+mywp=Workpattern.new('My Workpattern',2011,10)
+```
+
+My **Workpattern** will be created as a 24 hour a day full working time.  Now it has to be told about the resting periods.  First the weekends.
+
+``` ruby
+mywp.resting(:days => :weekend)
+```
+
+then the days in the week have specific working and resting times using the *Workpattern.clock* method, although anything that responds to **hour** and **min** methods will do ...
+
+``` ruby
+mywp.resting(:days =>:weekday, :from_time=>Workpattern.clock(0,0),:to_time=>Workpattern.clock(8,59))
+mywp.resting(:days =>:weekday, :from_time=>Workpattern.clock(12,0),:to_time=>Workpattern.clock(12,59))
+mywp.resting(:days =>:weekday, :from_time=>Workpattern.clock(18,0),:to_time=>Workpattern.clock(23,59))
+```
+
+Now we have the working and resting periods setup we can just add 32 hours as minutes (1920) to our date.
+
+``` ruby
+mydate=DateTime.civil(2011,9,1,9,0)
+result_date = mywp.calc(mydate,1920) # => 6/9/11@18:00
+```
+
+## Development
+
+* Source hosted on [GitHub](http://github.com/callenb/workpattern).
+* Direct questions and discussions to the [mailing list](http://groups.google.com/group/workpattern).
+* Report issues on [GitHub Issues](http://github.com/callenb/workpattern/issues).
+* Pull requests are very welcome, however I have never participated in Open Source so will be a bit slow as I am learning. Please be patient with me.  Please include spec and/or feature coverage for every patch,  and create a topic branch for every separate change you make.
+* Advice, such as pointing out how I should really code in Ruby will be gratefully received.
+
+## License
+
+(The MIT License)
+
+Copyright (c) 2012 
+
+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/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+task :default => [:test]
+
+desc "Run basic tests"
+Rake::TestTask.new do |test|
+  test.libs << "test"
+  test.test_files = Dir["test/test_*.rb"]
+  test.verbose = true
+end

data/config/website.yml

@@ -0,0 +1,2 @@
+host: callenb@rubyforge.org
+remote_dir: /var/www/gforge-projects/workpattern

data/lib/workpattern/clock.rb

@@ -0,0 +1,63 @@
+module Workpattern
+  # Represents time on a clock in hours and minutes.
+  #
+  # myClock=Clock.new(3,32)
+  # myClock.minutes #=> 212
+  # myClock.hour #=> 3
+  # myClock.min  #=> 32
+  # myClock.time #=> Time.new(1963,6,10,3,32)
+  # 
+  #
+  # aClock=Clock.new(27,80)
+  # aClock.minutes #=> 1700
+  # aClock.hour #=> 4
+  # aClock.min #=> 20
+  # aClock.time #=> Time.new(1963,6,10,4,20)
+  #
+  class Clock
+  
+    # :call-seq: new(hour,min) => Clock
+    # initialises <tt>Clock</tt> using the hours and minutes supplied
+    # or 0 if they are absent.  Although there are 24 hours in a day
+    # (0-23) and 60 minutes in an hour (0-59), <tt>Clock</tt> calculates
+    # the full hours and remaining minutes of whatever is supplied.
+    #
+    def initialize(hour=0,min=0)
+      @hour=hour
+      @min=min
+      total_minutes = minutes
+      @hour=total_minutes.div(60)
+      @min=total_minutes % 60
+    end
+    
+    # :call-seq: minutes => Integer
+    # returns the total number of minutes
+    #
+    def minutes
+      return (@hour*60)+@min
+    end
+    
+    # :call-seq: hour => Integer
+    # returns the hour of the clock (0-23)
+    #
+    def hour
+      return @hour % 24
+    end
+    
+    # :call-seq: min => Integer
+    # returns the minute of the clock (0-59)
+    #
+    def min
+      return @min % 60
+    end
+    
+    # :call-seq: time => DateTime
+    # returns a <tt>Time</tt> object with the correct
+    # <tt>hour</tt> and <tt>min</tt> values.  The date
+    # is 10th June 1963
+    # 
+    def time
+      return DateTime.new(1963,6,10,hour,min)
+    end      
+  end
+end

data/lib/workpattern/day.rb

@@ -0,0 +1,259 @@
+module Workpattern
+  # Represents the 24 hours of a day using module <tt>hour</tt>
+  #
+  class Day
+    include Workpattern::Utility
+    attr_accessor :values, :hours, :first_hour, :first_min, :last_hour, :last_min, :total
+    
+    # :call-seq: new(type=1) => Day
+    # Creates a 24 hour day defaulting to a working day.
+    # Pass 0 to create a non-working day.
+    #
+    def initialize(type=1)
+      @hours=24
+      hour=WORKING_HOUR if type==1
+      hour=RESTING_HOUR if type==0
+      @values=Array.new(@hours) {|index| hour }
+
+      set_attributes
+    end
+    
+    # :call-seq: duplicate => Day
+    # Creates a duplicate of the current <tt>Day</tt> instance.
+    #
+    def duplicate
+      duplicate_day = Day.new()
+      duplicate_values=Array.new(@values.size)
+      @values.each_index {|index|
+        duplicate_values[index]=@values[index]
+        }
+      duplicate_day.values=duplicate_values
+      duplicate_day.hours = @hours
+      duplicate_day.first_hour=@first_hour
+      duplicate_day.first_min=@first_min
+      duplicate_day.last_hour=@last_hour
+      duplicate_day.last_min=@last_min
+      duplicate_day.total = @total
+      duplicate_day.refresh
+      return duplicate_day
+    end
+    
+    # :call-seq: refresh
+    # Recalculates characteristics for this day
+    #
+    def refresh
+      set_attributes
+    end
+    
+    # :call-seq: workpattern(start_time,finish_time,type)
+    # Sets all minutes in a date range to be working or resting.
+    # The <tt>start_time</tt> and <tt>finish_time</tt> need to have 
+    # <tt>#hour</tt> and <tt>#min</tt> methods to return the time 
+    # in hours and minutes respectively.
+    #
+    # Pass 1 as the <tt>type</tt> for working and 0 for resting.
+    # 
+    def workpattern(start_time,finish_time,type)
+    
+      if start_time.hour==finish_time.hour
+        @values[start_time.hour]=@values[start_time.hour].workpattern(start_time.min,finish_time.min,type)
+      else
+        test_hour=start_time.hour
+        @values[test_hour]=@values[test_hour].workpattern(start_time.min,59,type)
+        
+        while ((test_hour+1)<finish_time.hour)
+          test_hour+=1
+          @values[test_hour]=@values[test_hour].workpattern(0,59,type)     
+        end
+        
+        @values[finish_time.hour]=@values[finish_time.hour].workpattern(0,finish_time.min,type)
+      end
+      set_attributes
+    end
+    
+    # :call-seq: calc(time,duration) => time, duration
+    #
+    # 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 having 60 as the value in <tt>min</tt>. 
+    # 
+    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
+    
+    # :call-seq: working?(start) => Boolean
+    # Returns true if the given minute is working and false if it isn't
+    #
+    def working?(start)
+      return true if minutes(start.hour,start.min,start.hour,start.min)==1
+      return false
+    end
+    
+    # :call-seq: diff(start,finish) => Duration, Date
+    # Returns the difference in minutes between two times. if the given 
+    # minute is working and false if it isn't
+    #
+    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
+    
+    # :call-seq: minutes(start_hour,start_min,finish_hour,finish_min) => duration    
+    # Returns the total number of minutes between and including two minutes.
+    # 
+    def minutes(start_hour,start_min,finish_hour,finish_min)
+      return 0 if (start_hour==finish_hour && start_hour==0 && start_min==finish_min && start_min==0)
+      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=@values[start_hour].minutes(start_min,finish_min)
+      else
+    
+        retval=@values[start_hour].minutes(start_min,59)
+        while (start_hour+1<finish_hour)        
+          retval+=@values[start_hour+1].total     
+          start_hour+=1
+        end
+        retval+=@values[finish_hour].minutes(0,finish_min)
+      end
+        
+      return retval
+    end
+
+    private
+    
+    def set_attributes
+      @first_hour=nil
+      @first_min=nil
+      @last_hour=nil
+      @last_min=nil
+      @total=0
+      0.upto(@hours-1) {|index|
+        @first_hour=index if ((@first_hour.nil?) && (@values[index].total!=0))
+        @first_min=@values[index].first if ((@first_min.nil?) && (!@values[index].first.nil?))        
+        @last_hour=index if (@values[index].total!=0)
+        @last_min=@values[index].last if (@values[index].total!=0)
+        @total+=@values[index].total
+      }
+    end
+    
+    def first_working_minute(time)
+      if @first_hour.nil?
+        return time - (HOUR*time.hour) - (MINUTE*time.min)
+      else  
+        time = time - HOUR * (time.hour - @first_hour)
+        time = time - MINUTE * (time.min - @first_min )
+        return time
+      end  
+    end
+    
+    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==@first_hour && time.min==@first_min)
+        time=time-(HOUR*@first_hour) - (MINUTE*@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=@values[time.hour].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=@values[this_hour].total
+          else
+            next_hour=(time.min==0)
+            time,duration=@values[this_hour].calc(time,duration, next_hour)
+          end
+        end
+      end  
+      return time,duration, false
+    end
+    
+    # 
+    # Returns the result of adding #duration to the specified time
+    # When there are not enough minutes in the day it returns the date
+    # for the start of the following
+    #
+    def add(time,duration)
+      available_minutes=minutes(time.hour,time.min,@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=@values[time.hour].minutes(time.min,59)
+        if (total==duration) # this hour satisfies
+          result_date=time + HOUR - (MINUTE*time.min)
+          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=@values[result_date.hour].calc(result_date,duration)     
+            end
+            total=@values[result_date.hour].total
+          end
+        end
+      end    
+      return result_date,duration, false
+    end
+    
+    def next_hour(start)
+      return start+HOUR-(start.min*MINUTE) 
+    end
+    
+    def minutes_left_in_hour(start)
+      return @values[start.hour].diff(start.min,60)
+    end
+    
+    def minutes_left_in_day(start)
+      start.hour
+    end  
+  end
+end

data/lib/workpattern/hour.rb

@@ -0,0 +1,166 @@
+module Workpattern
+  
+  # Represents the 60 minutes of an hour using a <tt>Fixnum</tt> or <tt>Bignum</tt>
+  #
+  module Hour
+ 
+    # :call-seq: total => Integer
+    # Returns the total working minutes in the hour
+    # 
+    def total
+      return minutes(0,59)
+    end  
+    
+    # :call-seq: workpattern(start,finish,type) => Fixnum
+    # Sets the minutes to either working (type=1) or resting (type=0)
+    #
+    def workpattern(start,finish,type)
+      return working(start,finish) if type==1
+      return resting(start,finish) if type==0
+    end
+    
+    # :call-seq: first => Integer
+    # Returns the first working minute in the hour or 60 if there are none
+    #
+    def first
+      0.upto(59) {|minute| return minute if self.minutes(minute,minute)==1}
+      return nil
+    end
+    
+    # :call-seq: last => Integer
+    # Returns the last working minute in the hour or -1 if there are none
+    #
+    def last
+      59.downto(0) {|minute| return minute if self.minutes(minute,minute)==1}
+      return nil
+    end
+    
+    # :call-seq: working?(start) => Boolean
+    # Returns true if the given minute is working and false if it isn't
+    #
+    def working?(start)
+      return true if minutes(start,start)==1
+      return false
+    end
+    
+    # :call-seq: minutes(start,finish) => Integer
+    # Returns the total number of minutes between and including two minutes
+    #
+    def minutes(start,finish)
+      start,finish=finish,start if start > finish
+      return (self & mask(start,finish)).to_s(2).count('1')
+    end
+    
+    # :call-seq: calc(datetime,duration) => DateTime, Integer
+    # Returns the DateTime and remainding minutes when adding or subtracting duration 
+    # to/from a minute in an hour.
+    # Subtraction with a remainder returns the time of the current date as 00:00.
+    #
+    def calc(time,duration,next_hour=false)
+    
+      if (duration<0)
+        return subtract(time,duration, next_hour)  
+      elsif (duration>0)
+        return add(time,duration)                
+      else
+        return time,duration
+      end 
+    end
+    
+    # :call-seq: diff(start,finish) => Integer
+    # returns the number of minutes between two minutes
+    #
+    def diff(start,finish)
+      start,finish=finish,start if start > finish
+      return 0 if start==finish
+      return (self & mask(start,finish-1)).to_s(2).count('1')
+    end
+    
+    private
+
+    # sets working pattern
+    def working(start,finish)
+      return self | mask(start,finish)
+    end
+    
+    # sets resting pattern
+    def resting(start,finish)
+      return self & ((2**60-1)-mask(start,finish))
+    end
+    
+    # creates a mask over the specified bits
+    def mask(start,finish)
+      return ((2**(finish+1)-1)-(2**start-1))
+    end
+    
+    # adds a duration to a time
+    def add(time,duration)
+      start = time.min
+      available_minutes=minutes(start,59)
+
+      if ((duration-available_minutes)>=0)
+        result_date = time + HOUR - (MINUTE*start)
+        result_remainder = duration-available_minutes
+      elsif ((duration-available_minutes)==0)
+        result_date = time - (MINUTE*start) + last + 1 
+        result_remainder = 0
+      elsif (minutes(start,start+duration-1)==duration)
+        result_date = time + (MINUTE*duration)
+        result_remainder = 0
+      else
+        step = start + duration
+        duration-=minutes(start,step)
+        until (duration==0)
+          step+=1
+          duration-=minutes(step,step)
+        end
+        step+=1
+        result_date = time + (MINUTE*step)
+        result_remainder = 0
+      end  
+      return result_date, result_remainder  
+    end
+    
+    # subtracts a duration from a time
+    def subtract(time,duration,next_hour)
+      if next_hour
+        if working?(59)
+          duration+=1
+          time=time+(MINUTE*59)
+          return calc(time,duration)
+        end  
+      else  
+        start=time.min  
+        available_minutes=0
+        available_minutes = minutes(0,start-1) if start > 0
+      end
+      
+      if ((duration + available_minutes)<=0)
+        result_date = time - (MINUTE*start)
+        result_remainder = duration+available_minutes
+      elsif (minutes(start+duration,start-1)==duration.abs)
+        result_date = time + (MINUTE*duration)
+        result_remainder = 0
+      else     
+        step = start + duration
+        duration+=minutes(step,start-1)
+        until (duration==0)
+          step-=1
+          duration+=minutes(step,step)
+        end
+        result_date = time - (MINUTE * (start-step))
+        result_remainder = 0
+      end  
+      return result_date, result_remainder  
+      
+    end
+  end
+end
+
+class Fixnum
+  include Workpattern::Hour
+end
+class Bignum
+  include Workpattern::Hour
+end
+  

data/lib/workpattern/utility/base.rb

@@ -0,0 +1,14 @@
+module Workpattern
+  
+  module Utility
+  
+    def midnight_before(adate)
+      return adate -(HOUR * adate.hour) - (MINUTE * adate.min)
+    end
+    
+    def midnight_after(adate)
+      return midnight_before(adate.next_day)
+    end
+    
+  end
+end  

data/lib/workpattern/version.rb

@@ -0,0 +1,3 @@
+module Workpattern
+  VERSION = '0.2.0'
+end