workpattern 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32e6c1903732854fa9a9ae45a5c02ebb408391ce931e2b8b20b9c7f3f349bae0
-  data.tar.gz: 1a99b95b71dda679fe674a7ff83595cac0922afb39b1012cc0239aafbf57c486
+  metadata.gz: b4784e020f63bed8a312b50553d245f54fe9ebf5c003555f706bc6d4b74ca447
+  data.tar.gz: f401a880126a8dea9113037a7b20d50ba123ec66727d8e1d35d74bf5d7539f32
 SHA512:
-  metadata.gz: 5c19219fa8b5f49ecb48e8072bc92143f688f4e2ed3edf32a11415e3d7e3b886e29d222818309ca2df570f95be68ed4d9c341d01fc43548b8302faa6a1a30052
-  data.tar.gz: 0247b415ada6052c16041a4ed18f3cbe28bc6af1d2dae3bc11f625fd50a77ca912ef52df46b98a3bb44858e6e50ec1a34799096821806de939e79e8c36765b4d
+  metadata.gz: a2d348d3aa2a2ecfd1174f1446176b26f7f481af8eafcecdcbf68be8d9594d1e1dac253d93c8d31389a5ba62b23503c80b9ae5b9159df19021fd2bd3f41a9f08
+  data.tar.gz: b132fd4596abf3df95b7a955a376e34b7b8796fae5c848014145e91e2565aaeab2c146ce8beb4881852b5d1de989bd98724f352c8cd86a0a68c3fb013c8f7133

data/.gitignore

@@ -6,3 +6,5 @@
 /pkg/
 /spec/reports/
 /tmp/
+Gemfile.lock
+.compound-engineering/*.local.yaml

data/.travis.yml

@@ -1,6 +1,5 @@
 language: ruby
 rvm:
-- 1.9.3
 - 2.1
 - 2.2
 - 2.3

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## Workpattern v0.7.0 (unreleased) ##
+
+* Added `Workpattern#to_h` — serialises a workpattern to a plain Ruby hash (JSON-safe; pattern bitmaps are hex-encoded strings).
+* Added `Workpattern.from_h(hash, overwrite: false)` — reconstructs a workpattern from a hash produced by `to_h`. Requires symbol keys; when deserialising from JSON use `JSON.parse(json, symbolize_names: true)`.
+* Removed `Workpattern.persistence_class=` and `Workpattern.persistence?` — both were silently non-functional in all prior releases due to a `@@persist`/`@@persistence` naming bug; no working integration exists.
+* Fixed `DEFAULT_NAME` undefined constant in `Workpattern::Workpattern.initialize` (pre-existing; only triggered when calling the inner class constructor directly with no arguments).
+* Fixed `Array.new(LAST_DAY_OF_WEEK)` → `Array.new(LAST_DAY_OF_WEEK + 1)` in `Week.initialize` for consistency (pre-existing; Ruby auto-extends arrays so no runtime difference).
+
 ## 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.

data/Gemfile

@@ -3,6 +3,6 @@ source "http://rubygems.org"
 # Specify your gem's dependencies in workpattern.gemspec
 gemspec
 
-gem "rake", "~> 13.0"
-
+gem "rake", "~> 0.9.2.2" if RUBY_VERSION < "2.4"
+gem "rake", "~> 13.0" if RUBY_VERSION >= "2.4"
 gem "minitest", "~> 5.0"

data/README.md

@@ -91,4 +91,26 @@ Workpattern.delete "My Workpattern"
 
 # Delete all Workpatterns
 Workpattern.clear
+```
+
+### Serialisation
+
+A `Workpattern` can be serialised to a plain Ruby hash and restored later.  The hash is JSON-safe — pattern bitmaps are stored as hex strings.
+
+``` ruby
+# Serialise
+h = mywp.to_h
+
+# Persist however you like (file, database, Redis, …)
+json = JSON.generate(h)
+
+# Restore — JSON.parse must use symbolize_names: true
+h2 = JSON.parse(json, symbolize_names: true)
+mywp2 = Workpattern.from_h(h2)
+```
+
+If a workpattern with the same name already exists, `from_h` raises `NameError`.  Pass `overwrite: true` to replace it:
+
+``` ruby
+Workpattern.from_h(h, overwrite: true)
 ```

data/lib/workpattern/day.rb

@@ -2,7 +2,30 @@ module Workpattern
   
   class Day
     
-    attr_accessor  :pattern, :hours_per_day, :first_working_minute, :last_working_minute
+    attr_accessor :hours_per_day, :first_working_minute, :last_working_minute
+    attr_reader :pattern
+
+    def pattern=(value)
+      @pattern = value
+      set_first_and_last_minutes
+    end
+
+    def to_h
+      { pattern: @pattern.to_s(16), hours_per_day: @hours_per_day }
+    end
+
+    def self.from_h(h)
+      unless h[:hours_per_day].is_a?(Integer) && h[:hours_per_day] > 0 && h[:hours_per_day] <= HOURS_IN_DAY
+        raise ArgumentError, "from_h: hours_per_day must be an Integer between 1 and #{HOURS_IN_DAY}"
+      end
+      unless h[:pattern].is_a?(String) && h[:pattern].length <= 400
+        raise ArgumentError, "from_h: pattern must be a hex String of at most 400 characters"
+      end
+      day = allocate
+      day.hours_per_day = h[:hours_per_day]
+      day.pattern = h[:pattern].to_i(16)
+      day
+    end
 
     def initialize(hours_per_day = HOURS_IN_DAY, type = WORK_TYPE)
       @hours_per_day = hours_per_day

data/lib/workpattern/version.rb

@@ -1,3 +1,3 @@
 module Workpattern
-  VERSION = '0.6.0'
+  VERSION = '0.7.0'
 end

data/lib/workpattern/week.rb

@@ -9,18 +9,35 @@ module Workpattern
   # @private
   class Week
     attr_accessor :hours_per_day, :start, :finish, :days
-    attr_writer :week_total, :total
 
     def initialize(start, finish, type = WORK_TYPE, hours_per_day = HOURS_IN_DAY)
       @hours_per_day = hours_per_day
       @start = Time.gm(start.year, start.month, start.day)
       @finish = Time.gm(finish.year, finish.month, finish.day)
-      @days = Array.new(LAST_DAY_OF_WEEK)
+      @days = Array.new(LAST_DAY_OF_WEEK + 1)
       FIRST_DAY_OF_WEEK.upto(LAST_DAY_OF_WEEK) do |i|
         @days[i] = Day.new(hours_per_day, type)
       end
     end
 
+    def to_h
+      { start:  { year: @start.year,  month: @start.month,  day: @start.day },
+        finish: { year: @finish.year, month: @finish.month, day: @finish.day },
+        days:   (FIRST_DAY_OF_WEEK..LAST_DAY_OF_WEEK).map { |i| @days[i].to_h } }
+    end
+
+    def self.from_h(h)
+      s = h[:start]
+      f = h[:finish]
+      week = allocate
+      week.hours_per_day = HOURS_IN_DAY
+      week.start  = Time.gm(s[:year], s[:month], s[:day])
+      week.finish = Time.gm(f[:year], f[:month], f[:day])
+      week.days   = Array.new(LAST_DAY_OF_WEEK + 1)
+      h[:days].each_with_index { |dh, i| week.days[i] = Day.from_h(dh) }
+      week
+    end
+
     def <=>(other)
       return -1 if start < other.start
       return 0 if start == other.start
@@ -270,9 +287,6 @@ module Workpattern
       time + DAY
     end
 
-    def prev_day(time)
-      time - DAY
-    end
 
     def jd(time)
       Time.gm(time.year, time.month, time.day)

data/lib/workpattern/week_pattern.rb

@@ -40,11 +40,9 @@ module Workpattern
     # @see #working
     # @see #resting
     #
-    def workpattern(opts = {}, persist = nil)
+    def workpattern(opts = {})
       args = all_workpattern_options(opts)
 
-      persist.store(name: @name, workpattern: args) if !persist.nil?
-
       args = standardise_args(args)
 
       upd_start = work_pattern.to_utc(args[:start])

data/lib/workpattern/workpattern.rb

@@ -19,10 +19,6 @@ module Workpattern
       @@workpatterns
     end
 
-    def workpatterns
-      @@workpatterns
-    end
-
     # @!attribute [r] name
     #   Name given to the <tt>Workpattern</tt>
     # @!attribute [r] base
@@ -38,16 +34,6 @@ module Workpattern
     #
     attr_reader :name, :base, :span, :from, :to, :weeks
 
-    # Class for handling persistence in user's own way
-    #
-    def self.persistence_class=(klass)
-      @@persist = klass
-    end
-
-    def self.persistence?
-      @@persist ||= nil
-    end
-
     # Holds local timezone info
     @@tz = nil
 
@@ -75,7 +61,7 @@ module Workpattern
     # 31st December.
     # @raise [NameError] if the given name already exists
     #
-    def initialize(name = DEFAULT_NAME, base = DEFAULT_BASE_YEAR, span = DEFAULT_SPAN)
+    def initialize(name = DEFAULT_WORKPATTERN_NAME, base = DEFAULT_BASE_YEAR, span = DEFAULT_SPAN)
       if workpatterns.key?(name)
         raise(NameError, "Workpattern '#{name}' already exists and can't be created again")
       end
@@ -97,6 +83,11 @@ module Workpattern
       @week_pattern
     end
 
+    private def workpatterns
+      @@workpatterns
+    end
+    public
+
     # Deletes all <tt>Workpattern</tt> objects
     #
     def self.clear
@@ -151,11 +142,7 @@ module Workpattern
     # @see #resting
     #
     def workpattern(opts = {})
-      if self.class.persistence?
-        week_pattern.workpattern(opts, @@persistence)
-      else
-        week_pattern.workpattern(opts)
-      end
+      week_pattern.workpattern(opts)
     end
 
     # Convenience method that calls <tt>#workpattern</tt> with the
@@ -178,6 +165,63 @@ module Workpattern
       workpattern(args)
     end
 
+    def to_h
+      { version: 1,
+        name:    @name,
+        base:    @base,
+        span:    @span,
+        weeks:   @weeks.map(&:to_h) }
+    end
+
+    def self.from_h(hash, overwrite: false)
+      unless hash.key?(:version)
+        raise ArgumentError, "from_h: hash is missing a :version key " \
+                             "(if deserialising from JSON, use symbolize_names: true)"
+      end
+      unless hash[:version] == 1
+        raise ArgumentError, "from_h: unsupported version #{hash[:version].inspect} " \
+                             "(supported: 1)"
+      end
+      unless hash[:name].is_a?(String) && !hash[:name].empty?
+        raise ArgumentError, "from_h: :name must be a non-empty String"
+      end
+      unless hash[:base].is_a?(Integer)
+        raise ArgumentError, "from_h: :base must be an Integer"
+      end
+      unless hash[:span].is_a?(Integer) && hash[:span] != 0
+        raise ArgumentError, "from_h: :span must be a non-zero Integer"
+      end
+      unless hash[:weeks].is_a?(Array)
+        raise ArgumentError, "from_h: :weeks must be an Array"
+      end
+
+      name = hash[:name]
+      if workpatterns.key?(name) && !overwrite
+        raise NameError, "Workpattern '#{name}' already exists and can't be created again"
+      end
+
+      wp = allocate
+      wp.instance_variable_set(:@name, name)
+      wp.instance_variable_set(:@base, hash[:base])
+      wp.instance_variable_set(:@span, hash[:span])
+
+      offset    = hash[:span] < 0 ? hash[:span].abs - 1 : 0
+      from_time = Time.gm(hash[:base].abs - offset)
+      to_time   = Time.gm(from_time.year + hash[:span].abs - 1, 12, 31, 23, 59)
+      wp.instance_variable_set(:@from, from_time)
+      wp.instance_variable_set(:@to,   to_time)
+
+      weeks = SortedSet.new
+      hash[:weeks].each { |wh| weeks << Week.from_h(wh) }
+      raise ArgumentError, "from_h: :weeks must not be empty" if weeks.empty?
+      wp.instance_variable_set(:@weeks, weeks)
+      wp.instance_variable_set(:@week_pattern, WeekPattern.new(wp))
+
+      workpatterns.delete(name) if overwrite
+      workpatterns[name] = wp
+      wp
+    end
+
     # Calculates the resulting date when the <tt>duration</tt> in minutes
     # is added to the <tt>start</tt> date.
     # The <tt>duration</tt> is always in whole minutes and subtracts from

data/lib/workpattern.rb

@@ -75,6 +75,26 @@ module Workpattern
     Workpattern.clear
   end
 
+  # Convenience method to deserialise a Workpattern from a plain hash.
+  #
+  # @param [Hash] hash produced by Workpattern#to_h
+  # @param [Boolean] overwrite replace an existing same-named workpattern
+  # @return [Workpattern]
+  # @raise [ArgumentError] if the hash is missing or has an unsupported version
+  # @raise [NameError] if a same-named workpattern already exists and overwrite is false
+  #
+  def self.from_h(hash, overwrite: false)
+    Workpattern.from_h(hash, overwrite: overwrite)
+  end
+
+  # Convenience method to access the registry of all known Workpattern objects.
+  #
+  # @return [Hash]
+  #
+  def self.workpatterns
+    Workpattern.workpatterns
+  end
+
   # Convenience method to create a Clock object.  This can be used for
   # specifying times if you don't want to create a <tt>DateTime</tt> object
   #

data/workpattern.gemspec

@@ -1,7 +1,11 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
 
-require_relative "lib/workpattern/version"
+if RUBY_VERSION >= "2.4"
+  require_relative "lib/workpattern/version"
+else
+  require "workpattern/version"
+end
 
 Gem::Specification.new do |spec|
   spec.name          = "workpattern"
@@ -14,16 +18,20 @@ Gem::Specification.new do |spec|
   spec.homepage      = "http://workpattern.org"
   spec.license       = "MIT"  
   spec.required_ruby_version = Gem::Requirement.new(">= 1.9.3")
-
-  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"
-
+  if RUBY_VERSION >= "2.4"
+    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"
+  end
   # 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
+  if RUBY_VERSION >= "2.4"
+    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
+  else
+    spec.files = `git ls-files`.split("\n")
+  end  
   spec.require_paths = ["lib"]
 
   # Uncomment to register a new dependency of your gem
@@ -33,6 +41,7 @@ Gem::Specification.new do |spec|
   # 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"]
   

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: workpattern
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Barrie Callender
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-25 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tzinfo
@@ -51,7 +50,6 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -75,7 +73,6 @@ 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:
 - lib
@@ -90,8 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.9
-signing_key: 
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Calculates dates and durations whilst taking into account working and non-working
   periods down to a minute

data/Gemfile.lock

@@ -1,31 +0,0 @@
-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