workpattern 0.3.4 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 369fff3d813c83a9202c4593c93222f0683a3bc5
-  data.tar.gz: e8c724250a725fecffbea9232e14e70422339e39
+SHA256:
+  metadata.gz: 32e6c1903732854fa9a9ae45a5c02ebb408391ce931e2b8b20b9c7f3f349bae0
+  data.tar.gz: 1a99b95b71dda679fe674a7ff83595cac0922afb39b1012cc0239aafbf57c486
 SHA512:
-  metadata.gz: ecf42d51cce8b9f68f29c0ba7009f88450fb510f028b7e246f5fa144c72cb1369e79e7502f021e2a09a49de2bfd637d8cf42aa4a10902427de808186f3079c8b
-  data.tar.gz: bad7c4fdfe5e04b9804742197ebdc91147130ce687b3b3558056c6736ddf70631ffdcb1d1a7e70fe7c36e670002f5883985f5290d87fef5392680fc423efe183
+  metadata.gz: 5c19219fa8b5f49ecb48e8072bc92143f688f4e2ed3edf32a11415e3d7e3b886e29d222818309ca2df570f95be68ed4d9c341d01fc43548b8302faa6a1a30052
+  data.tar.gz: 0247b415ada6052c16041a4ed18f3cbe28bc6af1d2dae3bc11f625fd50a77ca912ef52df46b98a3bb44858e6e50ec1a34799096821806de939e79e8c36765b4d

data/.gitignore

@@ -1,4 +1,8 @@
-doc
-pkg
-.yardoc
-./Gemfile.lock
+/.bundle/
+/.yardoc/
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -1,5 +1,20 @@
 language: ruby
 rvm:
-  - 1.9.3
-  - jruby-19mode # JRuby in 1.9 mode
-  - 2.0.0
+- 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.md

@@ -0,0 +1,88 @@
+## 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
+* Removed Day class and associated tests as it is no longer used * Barrie Callender
+* Reviewed the README and removed a lot of cruft and also updated it a little to demonstrate features * Barrie Callender
+* Hid documentation unless it was part of the public api * Barrie Callender
+* Used Rubocop to help me be more consistent.  I ignored some of the offences to do with long lines/methods and classes * Barrie Callender
+* Code makes use of Time objects where it use to use DateTime.  Time comes with a Timezone * Barrie Callender
+* Rewrote/refactored methods in the Week class - which needs refactoring into new classes * Barrie Callender
+* Removed rubyforge_project from workpattern.gemspec * Barrie Callender
+* Added homepage & required_ruby_version to workpattern.gemspec * Barrie Callender
+* Added versions to test in Travis CI to include 1.9.3, 2.0.0, 2.1.0, 2.1.9, 2.2.0, 2.2.5, 2.3.0 & 2.3.1 * Barrie Callender
+* Dealt with Travis CI issue with version of bundler * Barrie Callender
+* Removed config directory & contents * Barrie Callender
+* Changed Description * barrie Callender
+* Specified minitest ~> 5.4.3 due to an issue I no longer recall * Barrie Callender
+* Hid all the documentation apart from public api * Barrie Callender
+* improved the README.md (IMHO) * Barrie Callender
+
+## Workpattern v0.4.0 ( May 23, 2014)  ##
+
+* Updated Week class to use bits and removed Day and Hour class as a consequence * Barrie Callender *
+* This resulted in a performance improvement and some new tests
+
+## Workpattern v0.3.6 (Mar 25, 2014)  ##
+
+* total minutes of week is zero when short week starting after Sunday (#17) * Barrie Callender *
+* Subtracting starting from top of the hour and last minute is non working (#18) * Barrie Callender *
+* Refactorings intended to make the code easier to read and easier to change - still more to do * Barrie Callender *
+
+## Workpattern v0.3.5 (Sep 30, 2013)  ##
+
+* License missing from gemspec (#16) * Barrie Callender *
+* Removed Gemfile.lock from git and updated .gitignore to the bundler defaults * Barrie Callender *
+
+## 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/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

@@ -1,16 +1,31 @@
 PATH
   remote: .
   specs:
-    workpattern (0.3.3)
+    workpattern (0.6.0)
+      sorted_set
+      tzinfo
 
 GEM
   remote: http://rubygems.org/
   specs:
-    rake (0.9.6)
+    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
-  ruby
+  x86_64-linux
 
 DEPENDENCIES
-  rake (~> 0.9.2)
+  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

@@ -1,118 +1,94 @@
 # Workpattern [![Build Status](https://secure.travis-ci.org/callenb/workpattern.png)](https://secure.travis-ci.org/callenb/workpattern.png)
 
-## What?
+Calculates dates and durations whilst taking into account working and non-working times.  It creates calendars similar to what you can find in project scheduling software like Microsoft project and Primavera P6.
 
-Simple addition and subtraction of minutes on dates taking account of real-life working and resting periods.
+Please use [Github Issues] to report bugs.  If you have a question about the library, please use the `workpattern` tag on [Stack Overflow].  This tag is monitored by contributors.
 
-## So What?
+[Github Issues]: http://github.com/callenb/workpattern/issues
+[Stack Overflow]: http://stackoverflow.com/questions/tagged/workpattern
 
-The core Ruby classes that represent date and time allow calculations by adding a duration such as days or 
-minutes to a date and returning the new `Date` or `DateTime` as the result.  Although there 
-are 60 seconds in every minute and 60 minutes in every hour, there aren't always 24 hours in every day, and 
-if there was, we still wouldn't be working during all of them.  We would be doing other things like eating,
-sleeping, travelling and having a bit of leisure time.  Workpattern refers to this time as Resting time.
-It refers to the time when we're busy doing stuff as Working time.
+## Getting Started
 
-When it comes to scheduling work, whether part of a project, teachers in a classroom or even bed availability
-in a hospital, the working day can have anything from 0 hours to the full 24 hours.  Most office based work
-is something like 7.5 or 8 hours a day except weekends, public holidays and vacations when no work takes 
-place.
+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)`.
 
-The `Workpattern` library was born to allow date related calculations to take  into account real life 
-working and resting times.  It gets told about working and resting periods and can then perform calculations
-on a given date.  It can add and subtract a number of minutes, calculate the working minutes between two dates 
-and say whether a specific minute is working or resting.
+You can install it using:
+```sh
+gem install workpattern
+```
 
-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.
+Or you can add it to your Gemfile with:
 
-## Install
+```sh
+gem "workpattern"
+```
 
-  `sudo gem install workpattern`
+Then run the bundle command to install it.
 
-## Getting Started
+## Use
+
+## Configure and Calculate
 
-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.
+First create a `Workpattern` to hold all the working and resting times.
 
 ``` ruby
-mywp=Workpattern.new('My Workpattern',2011,10)
+mywp=Workpattern.new 'My Workpattern',2011,10 
 ```
+That line created a `Workpattern` called `My Workpattern` starting on 1-Jan-2011 and continuing for `10` years until `2020`.
 
-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.
+`mywp` is created with a 24 hour a day working time.  Next step is to tell it to ignore weekends by making every Saturday and Sunday non-working.
 
 ``` ruby
-mywp.resting(:days => :weekend)
+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 ...
+The `Workpattern.clock` method can be used to specify the non-working times for each weekday.  Any class that responds to `#hour` and `#min` methods such as `Time` or `DateTime` can be used instead of `Workpattern.clock`.
 
 ``` 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))
+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) 
 ```
+As well as `:weekend` and `:weekday` it is possible to use `:mon`, `:tue`, `:wed`, `:thu`, `:fri`, `:sat`, `:sun` or `all`.
 
-Now we have the working and resting periods setup we can just add 32 hours as minutes (1920) to our date.
+With `mywp` setup, the `#calc` method is used to add 32 hours which must be supplied as the number of whole minutes (1920) to a date.
 
 ``` ruby
-mydate=DateTime.civil(2011,9,1,9,0)
-result_date = mywp.calc(mydate,1920) # => 6/9/11@18:00
+my_date=Time.gm 2011,9,1,9,0 
+result_date = mywp.calc my_date,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.
-
-## Things To Do
-
-In its current form this library is being made available to see if there is any interest in using 
-it. At the moment it can perform the following:
-
-* define the working and resting minutes for any 24 hour day
-* given a date it can return the resulting date after adding or subtracting a number of minutes
-* calculate the number of working minutes between two dates
-* report whether a specific minute in time is working or resting
+The result takes into account the non-working or resting times.
 
-This is what I consider to be the basics, but there are a number of functional and non-functial areas I 
-would like to address in a future version.
+Subtracting a date is just as easy by using a negative number of minutes in `#calc`.
 
-## Functional
+Finding the duration between two dates is also easy using the `#diff` method.
 
-* Merge two Workpatterns together to create a new one allowing either resting or working to take precedence
-* Given a date, find the next working or resting minute either before or after it.
-* Handle both 23 and 25 hour days that occur when the clocks change.
-* Extract patterns from the workpattern so they can be persisted in a database.
-* Decide how to handle different Timezones apart from UTC.
-
-## Non-Functional
+``` ruby
+diff_result = mywp.diff my_date, result_date  # => 1920
+```
 
-* Improve the documentation and introduce real world use as an example
-* Improve my ability to write Ruby code
+Vacations can be added to the `Workpattern` using the `#resting` method:
 
-## License
+``` ruby
+mywp.resting :days => :all, :start => DateTime.civil(2011,5,1), :finish => DateTime.civil(2011,5,7)
+```
+Find out if a specific date and time is working or not.
 
-(The MIT License)
+``` ruby
+mydate = DateTime.civil 2011,5,2,9,10
+mywp.resting? mydate  # => true
+mywp.working? mydate  # => false
+```
 
-Copyright (c) 2012 
+### Manage
 
-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:
+``` ruby
+# Fetch a specific Workpattern
+Workpattern.get "My Workpattern"
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+# Delete a specific Workpattern
+Workpattern.delete "My Workpattern"
 
-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.
+# Delete all Workpatterns
+Workpattern.clear
+```