hash_math 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7a08cd91f3734e6acb87f0bc2904be2501b6aa0e8ca07ee8d90e5dd8fe8bd17
-  data.tar.gz: 065d4819ce940caa4e7f7a9fb5132a8643bccdc363985292aa0fed5b5e68bf77
+  metadata.gz: 7df04a330a0de007fb2dba40e7deb6b835ad5aebdf0be39dd596c4af6ee52715
+  data.tar.gz: b0277b0818de7dcb5f59a82e46e761bc6afb16c7f74ed3fc5390b9cd6addd6bc
 SHA512:
-  metadata.gz: 9943d5a576a015330cbc315ae84b804f32ad2d24981c6e555e3fd4728000b2731ceedf40075a17de883cefce025e837f3b94e7224f3ac671232b98596d43e044
-  data.tar.gz: 4364b9f176d404f6e0538420c3786a36adb0af260e55ba735e3b4a8aaaa1884dc4e64fc1590b529883278e07c7cebf1a6694047c72b333e79e52df58b0854b03
+  metadata.gz: 73f27b9a0746d605e7471aa14f4b1203894c72064555ed19303acc2e2c4e18169e8365daf20aeb299afc5b3faef9ec0552af04bab8b73fdc59bf9beb8baa2bd8
+  data.tar.gz: bc0eb13e08c690f7506ad413ad4fe1a3d22698cbe8f313efc1af8d62546ca1c0ab2cea4b0ba55f44758661688d9da6e3ff11931aca88a775226bcfb26758315b

data/.rubocop.yml

@@ -1,4 +1,8 @@
-Metrics/LineLength:
+AllCops:
+  TargetRubyVersion: 2.5
+  NewCops: enable
+
+Layout/LineLength:
   Max: 100
 
 Metrics/BlockLength:
@@ -13,9 +17,6 @@ Metrics/BlockLength:
 Metrics/MethodLength:
   Max: 25
 
-AllCops:
-  TargetRubyVersion: 2.3
-
 Metrics/AbcSize:
   Max: 16
 

data/.ruby-version

@@ -1 +1 @@
-2.6.3
+2.6.6

data/.travis.yml

@@ -4,10 +4,9 @@ env:
 language: ruby
 rvm:
   # Build on the latest stable of all supported Rubies (https://www.ruby-lang.org/en/downloads/):
-  - 2.3.8
-  - 2.4.6
-  - 2.5.5
-  - 2.6.3
+  - 2.5.8
+  - 2.6.6
+  - 2.7.1
 cache: bundler
 before_script:
   - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+# 1.1.0 (August 13t, 2020)
+
+Adding:
+
+* HashMath#Unpivot class and implementation.
+
+Removing:
+
+* Support for Ruby < 2.5
+
+# 1.0.0 (September 18th, 2019)
+
+Initial release.
+
 # 1.0.0-alpha (September 16th, 2019)
 
 Added initial implementation of:

data/README.md

@@ -179,6 +179,57 @@ Notes:
 * `#add` will throw a KeyOutOfBoundsError if the key is not found.
 * key is type-sensitive and works just like Hash keys work.
 
+### Unpivot: Hash Key Coalescence and Row Extrapolation
+
+Sometimes the expected interface is column-based, but the actual data store is row-based.  This causes an impedance between the input set and the persistable data set.  HashMath::Unpivot has the ability to extrapolate one hash (row) into multiple hashes (rows) while unpivoting specific keys into key-value pairs.
+
+For example: say we have a database table persisting key-value pairs of patient attributes:
+
+patient_id | field           | value
+---------- | --------------- | ----------
+2          | first_exam_date | 2020-01-03
+2          | last_exam_date  | 2020-04-05
+2          | consent_date    | 2020-01-02
+
+But our input data looks like this:
+
+````ruby
+patient = {
+  patient_id: 2,
+  first_exam_date: '2020-01-03',
+  last_exam_date: '2020-04-05',
+  consent_date: '2020-01-02'
+}
+````
+
+We could use a HashMath::Unpivot to go from one hash to three hashes:
+
+````ruby
+pivot_set = {
+  pivots: [
+    {
+      keys: %i[first_exam_date last_exam_date consent_date],
+      coalesce_key: :field,
+      coalesce_key_value: :value
+    }
+  ]
+}
+
+rows = HashMath::Unpivot.new(pivot_set).perform(patient)
+````
+
+The `rows` variable should now be equivalent to:
+
+````ruby
+[
+  { patient_id: 2, field: :first_exam_date, value: '2020-01-03' },
+  { patient_id: 2, field: :last_exam_date,  value: '2020-04-05' },
+  { patient_id: 2, field: :consent_date,    value: '2020-01-02' }
+]
+````
+
+Note: `HashMath::Unpivot#add` also exists to update an already instantiated object with new pivot_sets.
+
 ## Contributing
 
 ### Development Environment Configuration

data/hash_math.gemspec

@@ -19,13 +19,16 @@ Gem::Specification.new do |s|
   s.homepage    = 'https://github.com/bluemarblepayroll/hash_math'
   s.license     = 'MIT'
 
-  s.required_ruby_version = '>= 2.3.8'
+  s.required_ruby_version = '>= 2.5'
+
+  s.add_dependency('acts_as_hashable', '~>1')
 
   s.add_development_dependency('guard-rspec', '~>4.7')
   s.add_development_dependency('pry', '~>0')
-  s.add_development_dependency('rake', '~> 12')
+  s.add_development_dependency('pry-byebug', '~>3')
+  s.add_development_dependency('rake', '~>13.0')
   s.add_development_dependency('rspec')
-  s.add_development_dependency('rubocop', '~>0.74.0')
-  s.add_development_dependency('simplecov', '~>0.17.0')
-  s.add_development_dependency('simplecov-console', '~>0.5.0')
+  s.add_development_dependency('rubocop', '~>0.88.0')
+  s.add_development_dependency('simplecov', '~>0.18.5')
+  s.add_development_dependency('simplecov-console', '~>0.7.0')
 end

data/lib/hash_math.rb

@@ -7,9 +7,12 @@
 # LICENSE file in the root directory of this source tree.
 #
 
+require 'acts_as_hashable'
+
 require_relative 'hash_math/matrix'
 require_relative 'hash_math/record'
 require_relative 'hash_math/table'
+require_relative 'hash_math/unpivot'
 
 # Top-level namespace
 module HashMath

data/lib/hash_math/matrix.rb

@@ -40,8 +40,12 @@ module HashMath
       pairs_by_key[key] ||= KeyValuePair.new(key)
     end
 
+    def make_pair_groups
+      pairs_by_key.values.map(&:pairs)
+    end
+
     def pair_products
-      pair_groups = pairs_by_key.values.map(&:pairs)
+      pair_groups = make_pair_groups
 
       products = pair_groups.inject(pair_groups.shift) { |memo, f| memo.product(f) }
                             &.map { |f| f.is_a?(KeyValuePair::Pair) ? [f] : f.flatten } || []

data/lib/hash_math/unpivot.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+require_relative 'unpivot/pivot_set'
+
+module HashMath
+  # This class has the ability to extrapolate one hash (row) into multiple hashes (rows) while
+  # unpivoting specific keys into key-value pairs.
+  class Unpivot
+    acts_as_hashable
+    extend Forwardable
+
+    attr_reader :pivot_set
+
+    def_delegators :pivot_set, :add
+
+    def initialize(pivot_set = PivotSet.new)
+      @pivot_set = PivotSet.make(pivot_set, nullable: false)
+
+      freeze
+    end
+
+    # The main method for this class that performs the un-pivoting and hash expansion.
+    # Pass in a hash and it will return an array of hashes.
+    def expand(hash)
+      return [hash] unless pivot_set.any?
+
+      all_combinations = pivot_set.expand(hash)
+
+      products = all_combinations.inject(all_combinations.shift) do |memo, array|
+        memo.product(array)
+      end
+
+      recombine(products)
+    end
+
+    private
+
+    def recombine(products)
+      products.map do |pairs|
+        if pairs.is_a?(Array)
+          pairs.inject(pairs.shift) { |memo, p| memo.merge(p) }
+        else
+          pairs
+        end
+      end
+    end
+  end
+end

data/lib/hash_math/unpivot/pivot.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+module HashMath
+  class Unpivot
+    # A single pivot definition consists of which columns to coalesce and to where.
+    class Pivot
+      acts_as_hashable
+
+      attr_reader :coalesce_key,
+                  :coalesce_key_value,
+                  :keys
+
+      # keys is an array of keys to include in the un-pivoting.
+      # coalesce_key is the new key to use.
+      # coalesce_key_value is the new key to use for its corresponding values.
+      def initialize(keys:, coalesce_key:, coalesce_key_value:)
+        @keys               = Array(keys)
+        @coalesce_key       = coalesce_key
+        @coalesce_key_value = coalesce_key_value
+
+        freeze
+      end
+
+      # The most rudimentary portion of the Unpivoting algorithm, this method works on
+      # just one pivot and returns the extrapolated, un-pivoted rows.
+      # Takes two hashes as input:
+      # the first will serve as the prototype for each returned hash
+      # the second will be one to use for value extraction.
+      # Returns an array of hashes.
+      def expand(base_hash, value_hash)
+        keys.map do |key|
+          base_hash.merge(
+            coalesce_key => key,
+            coalesce_key_value => value_hash[key]
+          )
+        end
+      end
+    end
+  end
+end

data/lib/hash_math/unpivot/pivot_set.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+require_relative 'pivot'
+
+module HashMath
+  class Unpivot
+    # A set of pivots for an Unpivot class to perform.
+    class PivotSet
+      acts_as_hashable
+      extend Forwardable
+
+      attr_reader :pivots
+
+      def_delegators :pivots, :any?
+
+      def initialize(pivots: [])
+        @pivots = Pivot.array(pivots)
+      end
+
+      # Adds another Pivot configuration object to this objects list of pivots.
+      # Returns self.
+      def add(pivot)
+        tap { pivots << Pivot.make(pivot) }
+      end
+
+      # An aggregation of Pivot#expand.  This method will iterate over all pivots
+      # and expand them all out.
+      def expand(hash)
+        base_hash = make_base_hash(hash)
+
+        pivots.map { |pivot| pivot.expand(base_hash, hash) }
+      end
+
+      private
+
+      def make_base_hash(hash)
+        keys_to_remove = key_set
+
+        hash.reject { |k, _v| keys_to_remove.include?(k) }
+      end
+
+      def key_set
+        pivots.flat_map(&:keys).to_set
+      end
+    end
+  end
+end

data/lib/hash_math/version.rb

@@ -8,5 +8,5 @@
 #
 
 module HashMath
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/spec/hash_math/unpivot/pivot_spec.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+require 'spec_helper'
+
+describe HashMath::Unpivot::Pivot do
+  let(:config) do
+    {
+      keys: %i[first_exam_date last_exam_date consent_date],
+      coalesce_key: :field,
+      coalesce_key_value: :value
+    }
+  end
+
+  let(:patient) do
+    {
+      patient_id: 2,
+      first_exam_date: '2020-01-03',
+      last_exam_date: '2020-04-05',
+      consent_date: '2020-01-02'
+    }
+  end
+
+  subject { described_class.make(config) }
+
+  describe '#expand' do
+    it 'performs a single un-pivoting' do
+      actual = subject.expand({}, patient)
+
+      expected = [
+        {
+          field: :first_exam_date,
+          value: '2020-01-03'
+        },
+        {
+          field: :last_exam_date,
+          value: '2020-04-05'
+        },
+        {
+          field: :consent_date, value: '2020-01-02'
+        }
+      ]
+
+      expect(actual).to match_array(expected)
+    end
+  end
+end

data/spec/hash_math/unpivot_spec.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+require 'spec_helper'
+
+describe HashMath::Unpivot do
+  let(:a_and_b_pivot) do
+    {
+      keys: %i[a b],
+      coalesce_key: :ab_key,
+      coalesce_key_value: :ab_value
+    }
+  end
+
+  let(:cd_and_e_pivot) do
+    {
+      keys: %i[c d e],
+      coalesce_key: :cde_key,
+      coalesce_key_value: :cde_value
+    }
+  end
+
+  let(:hash) do
+    { a: 1, b: 2, c: 3, d: 4, e: 5 }
+  end
+
+  context 'with no pivots' do
+    it 'returns the inputted hash only' do
+      actual = subject.expand(hash)
+
+      expect(actual).to match_array([hash])
+    end
+  end
+
+  context 'with nil inputted' do
+    it 'returns array with nil' do
+      actual = subject.expand(nil)
+
+      expect(actual).to match_array([nil])
+    end
+  end
+
+  context 'with one pivot' do
+    it 'coalesces two columns into two rows' do
+      subject.add(**a_and_b_pivot)
+
+      expected = [
+        { ab_key: :a, ab_value: 1, c: 3, d: 4, e: 5 },
+        { ab_key: :b, ab_value: 2, c: 3, d: 4, e: 5 }
+      ]
+
+      actual = subject.expand(hash)
+
+      expect(actual).to eq(expected)
+    end
+  end
+
+  context 'with two pivots' do
+    it 'coalesces five columns into six rows' do
+      subject.add(**a_and_b_pivot).add(**cd_and_e_pivot)
+
+      expected = [
+        { ab_key: :a, ab_value: 1, cde_key: :c, cde_value: 3 },
+        { ab_key: :b, ab_value: 2, cde_key: :c, cde_value: 3 },
+        { ab_key: :a, ab_value: 1, cde_key: :d, cde_value: 4 },
+        { ab_key: :b, ab_value: 2, cde_key: :d, cde_value: 4 },
+        { ab_key: :a, ab_value: 1, cde_key: :e, cde_value: 5 },
+        { ab_key: :b, ab_value: 2, cde_key: :e, cde_value: 5 }
+      ]
+
+      actual = subject.expand(hash)
+
+      expect(actual).to match_array expected
+    end
+  end
+
+  describe 'README examples' do
+    context 'single patient row and one pivot example' do
+      let(:patient) do
+        {
+          patient_id: 2,
+          first_exam_date: '2020-01-03',
+          last_exam_date: '2020-04-05',
+          consent_date: '2020-01-02'
+        }
+      end
+
+      let(:pivot_set) do
+        {
+          pivots: [
+            {
+              keys: %i[first_exam_date last_exam_date consent_date],
+              coalesce_key: :field,
+              coalesce_key_value: :value
+            }
+          ]
+        }
+      end
+
+      subject { HashMath::Unpivot.new(pivot_set) }
+
+      it 'extrapolates one row into N rows (one per column key)' do
+        expected = [
+          { patient_id: 2, field: :first_exam_date, value: '2020-01-03' },
+          { patient_id: 2, field: :last_exam_date,  value: '2020-04-05' },
+          { patient_id: 2, field: :consent_date,    value: '2020-01-02' }
+        ]
+
+        actual = subject.expand(patient)
+
+        expect(actual).to match_array(expected)
+      end
+    end
+  end
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: hash_math
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Matthew Ruggio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-18 00:00:00.000000000 Z
+date: 2020-08-13 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: acts_as_hashable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -38,20 +52,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -72,42 +100,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.74.0
+        version: 0.88.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.74.0
+        version: 0.88.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: 0.18.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: 0.18.5
 - !ruby/object:Gem::Dependency
   name: simplecov-console
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.7.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.7.0
 description: "    This library offers general purpose higher-level data structures
   that focus on Hash manipulation.\n"
 email:
@@ -136,10 +164,15 @@ files:
 - lib/hash_math/matrix/key_value_pair.rb
 - lib/hash_math/record.rb
 - lib/hash_math/table.rb
+- lib/hash_math/unpivot.rb
+- lib/hash_math/unpivot/pivot.rb
+- lib/hash_math/unpivot/pivot_set.rb
 - lib/hash_math/version.rb
 - spec/hash_math/matrix_spec.rb
 - spec/hash_math/record_spec.rb
 - spec/hash_math/table_spec.rb
+- spec/hash_math/unpivot/pivot_spec.rb
+- spec/hash_math/unpivot_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/bluemarblepayroll/hash_math
 licenses:
@@ -153,7 +186,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.8
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -168,4 +201,6 @@ test_files:
 - spec/hash_math/matrix_spec.rb
 - spec/hash_math/record_spec.rb
 - spec/hash_math/table_spec.rb
+- spec/hash_math/unpivot/pivot_spec.rb
+- spec/hash_math/unpivot_spec.rb
 - spec/spec_helper.rb