workpattern 0.3.4 → 0.6.0

data/workpattern.gemspec

@@ -1,25 +1,39 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
-require "workpattern/version"
 
-Gem::Specification.new do |s|
-  s.name        = "workpattern"
-  s.version     = Workpattern::VERSION
-  s.authors     = ["Barrie Callender"]
-  s.email       = ["barrie@callenb.org"]
-  s.homepage    = ""
-  s.summary     = %q{temporal calculations}
-  s.description = %q{Workpattern performs date calculations that take into account working and resting periods.}
+require_relative "lib/workpattern/version"
 
-  s.rubyforge_project = "workpattern"
+Gem::Specification.new do |spec|
+  spec.name          = "workpattern"
+  spec.version       = Workpattern::VERSION
+  spec.authors       = ["Barrie Callender"]
+  spec.email         = ["barrie@callenb.org"]
 
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
+  spec.summary       = "Calculates dates and durations whilst taking into account working and non-working periods down to a minute"
+  spec.description   = "Calculates dates and durations whilst taking into account working and non-working times down to a minute.  Business working time with holidays are a breeze."
+  spec.homepage      = "http://workpattern.org"
+  spec.license       = "MIT"  
+  spec.required_ruby_version = Gem::Requirement.new(">= 1.9.3")
 
-  # specify any dependencies here; for example:
-  # s.add_development_dependency "rspec"
-  # s.add_runtime_dependency "rest-client"
-  s.add_development_dependency('rake', ['~> 0.9.2'])
+  spec.metadata["homepage_url"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/callenb/workpattern"
+  spec.metadata["changelog_uri"] = "https://workpattern.org/2021/02/25/changelog.html"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.add_runtime_dependency 'tzinfo'
+  spec.add_runtime_dependency 'sorted_set' if RUBY_VERSION >= "2.4"
+  spec.test_files            = `git ls-files -- {test,spec,features}/*`.split("\n")
+  spec.require_paths         = ["lib"]
+  
 end

metadata

@@ -1,31 +1,45 @@
 --- !ruby/object:Gem::Specification
 name: workpattern
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.6.0
 platform: ruby
 authors:
 - Barrie Callender
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-27 00:00:00.000000000 Z
+date: 2021-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: tzinfo
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.2
-  type: :development
+        version: '0'
+  type: :runtime
   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
-  and resting periods.
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sorted_set
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Calculates dates and durations whilst taking into account working and
+  non-working times down to a minute.  Business working time with holidays are a breeze.
 email:
 - barrie@callenb.org
 executables: []
@@ -34,35 +48,33 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
-- CHANGELOG
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
+- LICENSE.txt
 - README.md
 - Rakefile
-- config/website.yml
 - lib/workpattern.rb
 - lib/workpattern/clock.rb
+- lib/workpattern/constants.rb
 - lib/workpattern/day.rb
-- lib/workpattern/hour.rb
-- lib/workpattern/utility/base.rb
 - lib/workpattern/version.rb
 - lib/workpattern/week.rb
+- lib/workpattern/week_pattern.rb
 - lib/workpattern/workpattern.rb
 - script/console
 - script/destroy
 - 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
 - workpattern.gemspec
-homepage: ''
-licenses: []
-metadata: {}
+homepage: http://workpattern.org
+licenses:
+- MIT
+metadata:
+  homepage_url: http://workpattern.org
+  source_code_uri: https://github.com/callenb/workpattern
+  changelog_uri: https://workpattern.org/2021/02/25/changelog.html
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -71,16 +83,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: workpattern
-rubygems_version: 2.1.4
+rubygems_version: 3.0.9
 signing_key: 
 specification_version: 4
-summary: temporal calculations
+summary: Calculates dates and durations whilst taking into account working and non-working
+  periods down to a minute
 test_files: []

data/CHANGELOG

@@ -1,35 +0,0 @@
-## Workpattern v0.3.4 (Sep 27, 2013)  ##
-
-* diff doesn't calculate properly from working to resting day (#15) * Barrie Callender *
-
-	
-## Workpattern v0.3.3 (Sep 23, 2013)  ##
-
-* Failed to subtract 1 minute from end of resting hour (#12) * Barrie Callender *
-* Failed to add minutes starting from a resting period in a patterned hour (#13) * Barrie Callender *
-* Failed to subtract the exact amount of minutes from a patterned hour (#14) * Barrie Callender *
-* The two tests no longer fail with Ruby 2.0 (#11) * Barrie Callender *
-
-
-## Workpattern v0.3.2 (Mar 14, 2013)  ##
-
-* Changed methods on Hour module so as to not clash with Rails (#10) * Barrie Callender *
-* Applied DRY principle to workpattern method in Workpattern class * Barrie Callender *
-* Removed file from emacs backup * Barrie Callender *
-
-## Workpattern v0.3.1 (Oct 14, 2012)  ##
-
-* RDOC documentation not right on rubydoc.info (#5) * Barrie Callender *
-
-## Workpattern v0.3.0 (Jul 19, 2012)  ##
-
-* incomplete tests for week (#2) * Barrie Callender *
-* getting wrong time when hour had exactly the right number of minutes (#9) * Barrie Callender *
-* jruby-19mode failed with SystemStackError: stack level too deep  (#8) * Barrie Callender *
-* midnight flag should override hour and minutes  (#7) * Barrie Callender *
-* available minutes not calculating correctly for a time of 00:01 (#6) * Barrie Callender *
-
-## 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/config/website.yml

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

data/lib/workpattern/hour.rb

@@ -1,209 +0,0 @@
-module Workpattern
-  
-  # Represents the 60 minutes of an hour using an <tt>Integer</tt>
-  #
-  # @since 0.2.0
-  #
-  module Hour
- 
-    # Returns the total working minutes in the hour
-    #
-    # @return [Integer] working minutes in the hour 
-    #
-    def wp_total
-      return wp_minutes(0,59)
-    end  
-    
-    # Sets the minutes to either working (type=1) or resting (type=0)
-    # 
-    # @param [Integer] start minute at start of range
-    # @param [Integer] finish minute at end of range
-    # @param [Integer] type defines whether working (1) or resting (0)
-    #
-    def wp_workpattern(start,finish,type=1)
-      return wp_working(start,finish) if type==1
-      return wp_resting(start,finish) if type==0
-    end
-    
-    # Returns the first working minute in the hour or 60 if there are no working minutes
-    #
-    # @return [Integer] first working minute or 60 if none found
-    #
-    def wp_first
-      0.upto(59) {|minute| return minute if self.wp_minutes(minute,minute)==1}
-      return nil
-    end
-    
-    # Returns the last working minute in the hour or nil if there are no working minutes
-    #
-    # @return [Integer] last working minute or nil if none found
-    #
-    def wp_last
-      59.downto(0) {|minute| return minute if self.wp_minutes(minute,minute)==1}
-      return nil
-    end
-    
-    # Returns true if the given minute is working and false if it isn't
-    # 
-    # @param [Integer] start is the minute being tested
-    # @return [Boolean] true if minute is working, otherwise false
-    #
-    def wp_working?(start)
-      return true if wp_minutes(start,start)==1
-      return false
-    end
-    
-    # Returns the total number of minutes between and including two minutes
-    #
-    # @param [Integer] start first minute in range
-    # @param [Integer] finish last minute in range
-    # @return [Integer] number of minutes from <tt>start</tt> to <tt>finish</tt> inclusive
-    #
-    def wp_minutes(start,finish)
-      return (self & wp_mask(start,finish)).to_s(2).count('1')
-    end
-    
-    # Returns the DateTime and remainding minutes when adding a duration to a minute in the hour. 
-    # A negative duration will subtract the minutes.
-    #
-    # @param [DateTime] time is the full date but only the minute element is used
-    # @param [Integer] duration is the number of minutes to add and can be negative (subtraction)
-    # @param [Boolean] next_hour used in subtraction to specify the starting point as midnight (00:00 the next day)
-    # @return [DateTime,Integer,Boolean] The <tt>DateTime</tt> calculated along with remaining minutes and a flag indicating if starting point is next hour
-    #
-    def wp_calc(time,duration,next_hour=false)
-      return wp_subtract(time,duration, next_hour) if duration < 0
-      return wp_add(time,duration) if duration > 0
-      return time,duration 
-    end
-    
-    # Returns the number of minutes between two minutes
-    # @param [Integer] start first minute in range
-    # @param [Integer] finish last minute in range
-    # @return [Integer] number of working minutes in the range
-    #
-    def wp_diff(start,finish)
-      start,finish=finish,start if start > finish
-      return 0 if start==finish
-      return (self & wp_mask(start,finish-1)).to_s(2).count('1')
-    end
-    
-    private
-
-    # Sets a working pattern
-    #
-    # @param [Integer] start is first minute in the range
-    # @param [Integer] finish is last minute in the range
-    #
-    def wp_working(start,finish)
-      return self | wp_mask(start,finish)
-    end
-    
-    # sets a resting pattern
-    #
-    # @param [Integer] start is first minute in the range
-    # @param [Integer] finish is last minute in the range
-    #
-    def wp_resting(start,finish)
-      return self & ((2**60-1)-wp_mask(start,finish))
-    end
-    
-    # Creates a bit mask of 1's over the specified range
-    #
-    # @param [Integer] start is first minute in the range
-    # @param [Integer] finish is the last minute in the range
-    #
-    def wp_mask(start,finish)
-      return ((2**(finish+1)-1)-(2**start-1))
-    end
-    
-    # Handles the addition of minutes to a time
-    #
-    # @param [DateTime] time is the full date but only the minute element is used
-    # @param [Integer] duration is the number of minutes to add and can be negative (subtraction)
-    # @return [DateTime, Integer] The resulting DateTime and any remaining minutes
-    #
-    def wp_add(time,duration)
-      start = time.min
-      available_minutes=wp_minutes(start,59)
-
-      if not_enough_minutes duration, available_minutes
-        result_date = time + HOUR - (MINUTE*start)
-        result_remainder = duration-available_minutes
-      elsif exact_amount_of_minutes(start,duration)
-        result_date = time + (MINUTE*duration)
-        result_remainder = 0
-      else # more than enough minutes
-        step = start + duration
-        duration-=wp_minutes(start,step)
-        until (duration==0)
-          step+=1
-          duration-=wp_minutes(step,step)
-        end
-        step+=1
-        result_date = time - (MINUTE*time.min) + (MINUTE*step)
-        result_remainder = 0
-      end  
-      return result_date, result_remainder  
-    end
-    
-    # Handles the subtraction of minutes from a time.
-    # @param [DateTime] time is the full date but only the minute element is used
-    # @param [Integer] duration is the number of minutes to add and can be negative (subtraction)
-    # @param [Boolean] next_hour indicates if the 59th second is the first one to be included
-    # @return [DateTime, Integer] The resulting DateTime and any remaining minutes
-    #
-    def wp_subtract(time,duration,next_hour)
-      if next_hour
-        if wp_working?(59)
-          duration+=1
-          time=time+(MINUTE*59)
-          return wp_calc(time,duration)
-        end  
-        return time, duration if wp_total==0
-      else  
-        start=time.min  
-        available_minutes=0
-        available_minutes = wp_minutes(0,start-1) if start > 0
-      end
-      
-      if not_enough_minutes duration,available_minutes
-        result_date = time - (MINUTE*start)
-        result_remainder = duration+available_minutes
-      elsif duration.abs==available_minutes
-        result_date = time - (MINUTE*(start-wp_first))
-        result_remainder = 0
-      else     
-        step = start + duration
-        duration+=wp_minutes(step,start-1)
-        until (duration==0)
-          step-=1
-          duration+=wp_minutes(step,step)
-        end
-        result_date = time - (MINUTE * (start-step))
-        result_remainder = 0
-      end  
-      return result_date, result_remainder  
-      
-    end
-
-    private
- 
-    def not_enough_minutes(duration,available_minutes)
-      return true if (duration.abs-available_minutes)>0
-      return false
-    end
-
-    def exact_amount_of_minutes(start,duration)
-      return true if wp_minutes(start,start+duration-1)==duration
-      false
-    end
-  end
-end
-
-# Hours are represented by a bitwise <tt>Integer</tt> class so the code is mixed in to that class
-# @ since 0.3.0
-#
-class Integer
-  include Workpattern::Hour
-end

data/lib/workpattern/utility/base.rb

@@ -1,32 +0,0 @@
-module Workpattern
-
-  # Mixins expected to be used in more than one class
-  #
-  # @since 0.2.0
-  #
-  module Utility
-
-    # Returns the supplied <tt>DateTime</tt> at the very start of the day.
-    #
-    # @param [DateTime] adate is the <tt>DateTime</tt> to be changed
-    # @return [DateTime] 
-    # 
-    # @todo Consider mixin for DateTime class 
-    #
-    def midnight_before(adate)
-      return adate -(HOUR * adate.hour) - (MINUTE * adate.min)
-    end
-    
-    # Returns the supplied <tt>DateTime</tt> at the very start of the next day.
-    #
-    # @param [DateTime] adate is the <tt>DateTime</tt> to be changed
-    # @return [DateTime] 
-    # 
-    # @todo Consider mixin for DateTime class  
-    #
-    def midnight_after(adate)
-      return midnight_before(adate.next_day)
-    end
-    
-  end
-end