workpattern 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8e19f40a13975d2a07d505bce513b1d48dc25ca6
-  data.tar.gz: 8a974a014e365222029c333b8fee0835e91bd125
+SHA256:
+  metadata.gz: 32e6c1903732854fa9a9ae45a5c02ebb408391ce931e2b8b20b9c7f3f349bae0
+  data.tar.gz: 1a99b95b71dda679fe674a7ff83595cac0922afb39b1012cc0239aafbf57c486
 SHA512:
-  metadata.gz: 8bc16dcdae0b21a90952c15fde3bdcc51a7ad0dea8d28afa9e26f3afb78e76b16738690227a668e01878eb56009460f9b82f698f72ed5198d6a6156cfc375818
-  data.tar.gz: 757f7bc54c5247c09ca12533ed349a1aef37d47056ac4e12d98820a4ea7a94958f6d5c4256fb935278c4152159a100f10aa7a4cba54c4468ab89ea4625e73b69
+  metadata.gz: 5c19219fa8b5f49ecb48e8072bc92143f688f4e2ed3edf32a11415e3d7e3b886e29d222818309ca2df570f95be68ed4d9c341d01fc43548b8302faa6a1a30052
+  data.tar.gz: 0247b415ada6052c16041a4ed18f3cbe28bc6af1d2dae3bc11f625fd50a77ca912ef52df46b98a3bb44858e6e50ec1a34799096821806de939e79e8c36765b4d

data/.gitignore

@@ -1,20 +1,8 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-\#*
-.#*
-*.swp
+/.bundle/
+/.yardoc/
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -1,14 +1,20 @@
 language: ruby
 rvm:
-  - 1.9.3
-  - jruby-19mode # JRuby in 1.9 mode
-  - 2.1.0
-  - 2.1.9
-  - 2.2.0
-  - 2.2.5
-  - 2.3.0
-  - 2.3.1
-  - jruby-head
-before_install:
-  - gem install bundler
-  - gem update bundler
+- 1.9.3
+- 2.1
+- 2.2
+- 2.3
+- 2.4
+- 2.5
+- 2.6
+- ruby-head
+- jruby-19mode
+- jruby-head
+deploy:
+  provider: rubygems
+  api_key:
+    secure: IXKBqbRf+2aDOpH+g0LpTtIzyagDqjHy6Bo/UYtLqR42CHZUnzre8AvCTvobB+BlHF9W+Igdaf3tzzY+A+XrTf38Iut+zsFI6KnkP7pN8pSMfcpuxZrLi0vd24QAHlHLCHIwsl4WfHj/swIRQGtlhvAV5mcTLW2rhE9/M6pGvRo=
+  gem: workpattern
+  on:
+    tags: true
+    repo: callenb/workpattern

data/{CHANGELOG → CHANGELOG.md}

@@ -1,3 +1,22 @@
+## Workpattern v0.6.0 ( 25 Feb, 2021) ##
+
+I stopped keeping this Changelog file update back when v0.5.0 was realeased on 19 Oct 2016 and now it is 10Feb 2021 and I'm playing catch-up.
+I have created the following set of bullet point changes by going through my commit messages, the quality of which varies greatly.  
+A lot of the effort has been on making the code easier to read as it was a real mess.
+Here is a chronological take on what I have been doing.
+
+* removed test warnings by surrounding ambiguous negatives with parenthesis
+* I think a bug was fixed by changing #wee_total and #total to just an attr_writer
+* removed some duplicated code
+* replaced a number of literals with constants which I put in their own file
+* made a lot of the code easier to read, such as extracting to a method with a sensible name or renaming existing ones
+* Workpattern is now tested on Ruby 1.9.3, 2.1, 2.2, 2.3, 2.4, 2.5, 2.6, ruby-head, jruby-19mode & jruby-head
+* Created a Day class to remove the complexity from Week so Week deals with weeks and Day with a day
+* My Clock class was replaced by Time or Date objects in all tests.  Clock only used for internal stuff now.
+* Switched to sorted_set rubygem after the SortedSet class was removed from Ruby in v3.x.
+* Workpattern now works with ruby 3.0.1dev
+* added Contributor Covenant Code of Conduct
+
 ## Workpattern v0.5.0 ( Oct 19, 2016) ##
 
 * Workpattern now handles Timezones.  It changes the date into UTC, does the calculation and then changes it back * Barrie Callender

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at barrie@callenb.org. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -2,3 +2,7 @@ source "http://rubygems.org"
 
 # Specify your gem's dependencies in workpattern.gemspec
 gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"

data/Gemfile.lock

@@ -0,0 +1,31 @@
+PATH
+  remote: .
+  specs:
+    workpattern (0.6.0)
+      sorted_set
+      tzinfo
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    concurrent-ruby (1.1.8)
+    minitest (5.14.4)
+    rake (13.0.3)
+    rbtree (0.4.4)
+    set (1.0.1)
+    sorted_set (1.0.3)
+      rbtree
+      set (~> 1.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  workpattern!
+
+BUNDLED WITH
+   2.2.9

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Barrie Callender
+
+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/README.md

@@ -9,7 +9,7 @@ Please use [Github Issues] to report bugs.  If you have a question about the lib
 
 ## Getting Started
 
-Workpattern is a library with no monkey-patching and is tested against Ruby `>= 1.9.2`.
+Workpattern is a library with no monkey-patching and was tested using [Travis](https://travis-ci.org) against the following Ruby versions `1.9.3`, `2.1`, `2.2`, `2.3`, `2.4`, `2.5`, `2.6`, `ruby-head (3.1.0dev)`, `jruby-19mode (9.2.9.0 (2.5.7)` and `jruby-head (9.3.0.0-SNAPSHOT (2.6.5)`.
 
 You can install it using:
 ```sh
@@ -91,29 +91,4 @@ Workpattern.delete "My Workpattern"
 
 # Delete all Workpatterns
 Workpattern.clear
-```
-
-## License
-
-(The MIT License)
-
-Copyright (c) 2012 - 2016
-
-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/lib/workpattern.rb

@@ -7,12 +7,14 @@ $LOAD_PATH.unshift(File.dirname(__FILE__)) unless
   $LOAD_PATH.include?(File.dirname(__FILE__)) || $LOAD_PATH.include?(File.expand_path(File.dirname(__FILE__)))
 
 require 'rubygems'
+require 'sorted_set' if RUBY_VERSION >= "2.4"
 require 'date'
-require 'workpattern/utility/base.rb'
 require 'workpattern/clock'
-#require 'workpattern/day'
+require 'workpattern/constants'
+require 'workpattern/day'
 require 'workpattern/week'
 require 'workpattern/workpattern'
+require 'workpattern/week_pattern'
 
 #
 # workpattern.rb - date calculation library that takes into account patterns of
@@ -24,67 +26,7 @@ require 'workpattern/workpattern'
 # Documentation: Barrie Callender <barrie@callenb.org>
 #
 module Workpattern
-  # Represents a full working hour
-  # @since 0.2.0
-  WORKING_HOUR = 2**60 - 1
 
-  # Represents a full resting hour
-  # @since 0.2.0
-  RESTING_HOUR = 0
-
-  # The default workpattern name
-  # @since 0.2.0
-  DEFAULT_WORKPATTERN_NAME = 'default'.freeze
-
-  # The default base year
-  # @since 0.2.0
-  DEFAULT_BASE_YEAR = 2000
-
-  # The default span in years
-  # @since 0.2.0
-  DEFAULT_SPAN = 100
-
-  # Minute in terms of seconds
-  #
-  MINUTE = 60
-
-  # Hour interms od seconds
-  #
-  HOUR = MINUTE * 60
-
-  # Day in terms of seconds
-  #
-  DAY = HOUR * 24
-
-  # Earliest or first time in the day
-  # @since 0.0.1
-  FIRST_TIME_IN_DAY = Clock.new(0, 0)
-
-  # Latest or last time in the day
-  # @since 0.0.1
-  LAST_TIME_IN_DAY = Clock.new(23, 59)
-
-  # Specifies a working pattern
-  # @since 0.0.1
-  WORK = 1
-
-  # Specifies a resting pattern
-  # @since 0.0.1
-  REST = 0
-
-  # Represents the days of the week to be used in applying working
-  # and resting patterns.
-  # Values exist for each day of the week as well as for the weekend
-  # (Saturday and Sunday), 
-  # the week (Monday to Friday) and all days in the week.
-  #
-  # @since 0.0.1
-  daynames = { sun: [0], mon: [1], tue: [2], wed: [3],
-               thu: [4], fri: [5], sat: [6], 
-               weekday: [1, 2, 3, 4, 5], 
-               weekend: [0, 6], 
-               all: [0, 1, 2, 3, 4, 5, 6] }
-  DAYNAMES = daynames.freeze
   # Covenience method to obtain a new <tt>Workpattern</tt>
   #
   # A negative <tt>span</tt> counts back from the <tt>base</tt> year
@@ -94,7 +36,6 @@ module Workpattern
   # @param [Integer] number of years ending on 31st December.
   # @return [Workpattern]
   # @raise [NameError] creating a Workpattern with a name that already exists
-  # @since 0.2.0
   #
   def self.new(name = DEFAULT_WORKPATTERN_NAME,
                base = DEFAULT_BASE_YEAR,
@@ -107,8 +48,6 @@ module Workpattern
   #
   # @return [Array] all <tt>Workpattern</tt> objects
   #
-  # @since 0.2.0
-  #
   def self.to_a
     Workpattern.to_a
   end
@@ -118,8 +57,6 @@ module Workpattern
   # @param [String] name The name of the Workpattern to retrieve.
   # @return [Workpattern]
   #
-  # @since 0.2.0
-  #
   def self.get(name)
     Workpattern.get(name)
   end
@@ -128,16 +65,12 @@ module Workpattern
   #
   # @param [String] name The name of the Workpattern to be deleted.
   #
-  # @since 0.2.0
-  #
   def self.delete(name)
     Workpattern.delete(name)
   end
 
   # Convenience method to delete all Workpatterns.
   #
-  # @since 0.2.0
-  #
   def self.clear
     Workpattern.clear
   end
@@ -150,9 +83,8 @@ module Workpattern
   # @return [Clock]
   # @see Clock
   #
-  # @since 0.2.0
-  #
   def self.clock(hour, min)
     Clock.new(hour, min)
   end
+
 end

data/lib/workpattern/constants.rb

@@ -0,0 +1,72 @@
+module Workpattern
+
+  # default name of a new Workpattern
+  DEFAULT_WORKPATTERN_NAME = 'default'.freeze
+  
+  # default base year for a new workpattern
+  DEFAULT_BASE_YEAR = 2000
+
+  # default span of years for a new Workpattern
+  DEFAULT_SPAN = 100
+
+  # 60 seconds in a minute
+  MINUTE = 60
+
+  # 60 minutes in an hour
+  HOUR = MINUTE * 60
+
+  # 24 hours in a day
+  HOURS_IN_DAY = 24
+
+  # Seconds in a day
+  DAY = HOUR * HOURS_IN_DAY
+
+  # 60 minutes in a working hour as binary bit per minute
+  WORKING_HOUR = 2**MINUTE - 1
+
+  # 0 minutes in a working hour as binary bits per minute
+  RESTING_HOUR = 0
+
+  # Earliest or first time in the day
+  FIRST_TIME_IN_DAY = Clock.new(0, 0)
+
+  # Latest or last time in the day
+  LAST_TIME_IN_DAY = Clock.new(23, 59)
+
+  # Flags for calculations
+  PREVIOUS_DAY = -1
+  SAME_DAY = 0
+  NEXT_DAY = 1
+
+  # Specifies a working pattern
+  WORK_TYPE = 1
+
+  # Specifies a resting pattern
+  REST_TYPE = 0
+
+  # All the days of the week
+  SUNDAY=0
+  MONDAY=1
+  TUESDAY=2
+  WEDNESDAY=3
+  THURSDAY=4
+  FRIDAY=5
+  SATURDAY=6
+  
+  # first and last day of week
+  FIRST_DAY_OF_WEEK = SUNDAY
+  LAST_DAY_OF_WEEK = SATURDAY
+
+  # Represents the days of the week to be used in applying working
+  # and resting patterns.
+  # Values exist for each day of the week as well as for the weekend
+  # (Saturday and Sunday), 
+  # the week (Monday to Friday) and all days in the week.
+  #
+  daynames = { sun: [0], mon: [1], tue: [2], wed: [3],
+               thu: [4], fri: [5], sat: [6], 
+               weekday: [1, 2, 3, 4, 5], 
+               weekend: [0, 6], 
+               all: [0, 1, 2, 3, 4, 5, 6] }
+  DAYNAMES = daynames.freeze
+end