differential 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1136ffec0d1dc398e717e21e7c51d18082132f8f
-  data.tar.gz: 0a409d39334fc6d0b20a5a1e4a56de89f707e246
+  metadata.gz: bda5fdf9228dd29ab49df6ed4af24492f3f56ee7
+  data.tar.gz: 3c17dd8906111c400f111264d93483a5fa43c6df
 SHA512:
-  metadata.gz: fa1be441c56ccfc332c48015179d697dd8d071e4a6c98f44fd7e7490d4ece2840e417f5b0c4c7a08979ec7314bd33bccff3fab0b1ef526e46a5166795d9bc08f
-  data.tar.gz: 94d1f323017db63dd6a155f43912c23f404fa6b67cf90f1e87e9e95645d7f56325b6cb12b2ccf456bca19095a27d26189c9e14539560424f162e8c9b116dc43b
+  metadata.gz: b1aaa8b0917eb018a6d1cc0506a66af739432c108241f91b1486b8181a55617a7ab736119e5c486652569b96f9effd27f4120be792c32ff9bb407edf7a571f89
+  data.tar.gz: 6b1abb55a1383f7d43ebb5cd15bd582ce2def298fa84e3a45134f72ed7a27a5ec1ac70b22fd6b9b796cdc0149a727e9b2c3719e2e0e7d1b3670052652139c266

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+## 1.0.3 (December 19, 2018)
+
+- Added a_size and b_size for totals.  This allows you to see how many items contributed to a calculation.
+- Changed ID to be a first-class object instead of a string.  Now groups and items can have their respective ID parts consumed using: ```id.data```.  The string representation is still accessible via  ```id.value```.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    differential (1.0.2)
+    differential (1.0.3)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -110,7 +110,7 @@ reader_config = {
 To run the report, run:
 
 ```
-report = Differential.calculate(week1_data, week2_data, reader_config)
+report = Differential.calculate(dataset_a: week1_data, dataset_b: week2_data, reader_config: reader_config)
 ```
 
 The report variable will now hold a Report object with the following methods:
@@ -149,7 +149,7 @@ reader_config = {
 Then execute:
 
 ```
-report = Differential.calculate(week1_data, week2_data, reader_config)
+report = Differential.calculate(dataset_a: week1_data, dataset_b: week2_data, reader_config: reader_config)
 ```
 
 ### By Employee, Grouped By Transport Type Report
@@ -167,7 +167,7 @@ reader_config = {
 Then execute:
 
 ```
-report = Differential.calculate(week1_data, week2_data, reader_config)
+report = Differential.calculate(dataset_a: week1_data, dataset_b: week2_data, reader_config: reader_config)
 ```
 
 Now, this will output a report with two groups instead of one which will allow you to present this with sub-totals.
@@ -218,6 +218,22 @@ Also, do not forget to run Rubocop:
 bundle exec rubocop
 ````
 
+### Publishing
+
+Note: ensure you have proper authorization before trying to publish new versions.
+
+After code changes have successfully gone through the Pull Request review process then the following steps should be followed for publishing new versions:
+
+1. Merge Pull Request into master
+2. Update [lib/differential/version.rb](https://github.com/bluemarblepayroll/differential/blob/master/lib/differential/version.rb) [version number](https://semver.org/)
+3. Bundle
+4. Update CHANGELOG.md
+5. Commit & Push master to remote and ensure CI builds master successfully
+6. Build the project locally: `gem build differential`
+7. Publish package to NPM: `gem push differential-X.gem` where X is the version to push
+8. Tag master with new version: `git tag <version>`
+9. Push tags remotely: `git push origin --tags`
+
 ## License
 
 This project is MIT Licensed.

data/lib/differential/calculator/group.rb

@@ -44,12 +44,13 @@ module Differential
       private
 
       def upsert_item(record, side)
-        item_id = record.id
+        item_id_key = record.id.value
+        item_id     = record.id
 
         # Create a new item if one does not exist
-        items_by_id[item_id] = Item.new(item_id) unless items_by_id.key?(item_id)
+        items_by_id[item_id_key] = Item.new(item_id) unless items_by_id.key?(item_id_key)
 
-        items_by_id[item_id].add(record, side)
+        items_by_id[item_id_key].add(record, side)
 
         nil
       end

data/lib/differential/calculator/item.rb

@@ -16,14 +16,16 @@ module Differential
       include ::Differential::Calculator::HasTotals
       include ::Differential::Calculator::Side
 
-      attr_reader :id, :a_records, :b_records
+      attr_reader :a_records,
+                  :b_records,
+                  :id
 
       def initialize(id)
         raise ArgumentError, 'id is required' unless id
 
-        @id         = id
         @a_records  = []
         @b_records  = []
+        @id         = id
       end
 
       def add(record, side)

data/lib/differential/calculator/report.rb

@@ -36,12 +36,13 @@ module Differential
       private
 
       def upsert_group(record, side)
-        group_id = record.group_id
+        group_id_key  = record.group_id.value
+        group_id      = record.group_id
 
         # Create a new group if one does not exist
-        groups_by_id[group_id] = Group.new(group_id) unless groups_by_id.key?(group_id)
+        groups_by_id[group_id_key] = Group.new(group_id) unless groups_by_id.key?(group_id_key)
 
-        groups_by_id[group_id].add(record, side)
+        groups_by_id[group_id_key].add(record, side)
 
         nil
       end

data/lib/differential/calculator/totals.rb

@@ -16,11 +16,16 @@ module Differential
     class Totals
       include ::Differential::Calculator::Side
 
-      attr_reader :a_sigma, :b_sigma
+      attr_reader :a_sigma,
+                  :a_size,
+                  :b_sigma,
+                  :b_size
 
       def initialize
         @a_sigma = 0
+        @a_size  = 0
         @b_sigma = 0
+        @b_size  = 0
       end
 
       def delta
@@ -28,6 +33,13 @@ module Differential
       end
 
       def add(value, side)
+        increment_sigma(value, side)
+        increment_size(side)
+      end
+
+      private
+
+      def increment_sigma(value, side)
         case side
         when A
           @a_sigma += value
@@ -37,7 +49,20 @@ module Differential
           raise ArgumentError, "unknown side: #{side}"
         end
 
-        self
+        nil
+      end
+
+      def increment_size(side)
+        case side
+        when A
+          @a_size += 1.0
+        when B
+          @b_size += 1.0
+        else
+          raise ArgumentError, "unknown side: #{side}"
+        end
+
+        nil
       end
     end
   end

data/lib/differential/parser/id.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2018-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 Differential
+  module Parser
+    # TODO
+    class Id
+      attr_reader :data, :value
+
+      def initialize(data)
+        @data   = Array(data)
+        @value  = make_value(data)
+      end
+
+      def to_s
+        value
+      end
+
+      def eql?(other)
+        if other.is_a?(self.class)
+          value == other.value
+        else
+          make_value(other) == value
+        end
+      end
+
+      def ==(other)
+        eql?(other)
+      end
+
+      private
+
+      def make_value(val)
+        Array(val).join(':')
+      end
+    end
+  end
+end

data/lib/differential/parser/parser.rb

@@ -7,5 +7,6 @@
 # LICENSE file in the root directory of this source tree.
 #
 
+require_relative 'id'
 require_relative 'reader'
 require_relative 'record'

data/lib/differential/parser/reader.rb

@@ -34,7 +34,9 @@ module Differential
       def each(hashes)
         return enum_for(:each) unless block_given?
 
-        hashes.each do |hash|
+        array(hashes).each do |hash|
+          next unless hash
+
           record = read(hash)
           yield record
         end
@@ -68,6 +70,14 @@ module Differential
       def group_id_key_array
         @group_id_key_array ||= Array(group_id_key)
       end
+
+      def array(hashes)
+        if hashes.is_a?(Hash)
+          [hashes]
+        else
+          Array(hashes)
+        end
+      end
     end
   end
 end

data/lib/differential/parser/record.rb

@@ -15,8 +15,8 @@ module Differential
       attr_reader :id, :group_id, :value, :data
 
       def initialize(id:, group_id:, value:, data:)
-        @id       = id
-        @group_id = group_id
+        @id       = ::Differential::Parser::Id.new(id)
+        @group_id = ::Differential::Parser::Id.new(group_id)
         @value    = value
         @data     = data
       end

data/lib/differential/version.rb

@@ -8,5 +8,5 @@
 #
 
 module Differential
-  VERSION = '1.0.2'
+  VERSION = '1.0.3'
 end

data/spec/differential/calculator/group_spec.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2018-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/spec_helper'
+
+describe ::Differential::Calculator::Group do
+  let(:id) { 'matt' }
+
+  let(:group) { ::Differential::Calculator::Group.new(id) }
+
+  it 'should initialize correctly' do
+    expect(group.id).to eq(id)
+  end
+end

data/spec/differential/calculator/item_spec.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2018-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/spec_helper'
+
+describe ::Differential::Calculator::Item do
+  let(:id) { 'matt' }
+
+  let(:item) { ::Differential::Calculator::Item.new(id) }
+
+  it 'should initialize correctly' do
+    expect(item.id).to eq(id)
+  end
+end

data/spec/differential/calculator/totals_spec.rb

@@ -15,26 +15,34 @@ describe ::Differential::Calculator::Totals do
 
     totals.add(300, ::Differential::Calculator::Side::A)
 
-    expect(totals.a_sigma).to eq(300)
-    expect(totals.b_sigma).to eq(0)
-    expect(totals.delta).to   eq(-300)
+    expect(totals.a_sigma).to     eq(300)
+    expect(totals.a_size).to      eq(1)
+    expect(totals.b_sigma).to     eq(0)
+    expect(totals.b_size).to      eq(0)
+    expect(totals.delta).to       eq(-300)
 
     totals.add(400, ::Differential::Calculator::Side::B)
 
     expect(totals.a_sigma).to eq(300)
+    expect(totals.a_size).to  eq(1)
     expect(totals.b_sigma).to eq(400)
+    expect(totals.b_size).to  eq(1)
     expect(totals.delta).to   eq(100)
 
     totals.add(2.5, ::Differential::Calculator::Side::A)
 
     expect(totals.a_sigma).to eq(302.5)
+    expect(totals.a_size).to  eq(2)
     expect(totals.b_sigma).to eq(400)
+    expect(totals.b_size).to  eq(1)
     expect(totals.delta).to   eq(97.5)
 
     totals.add(2.50, ::Differential::Calculator::Side::B)
 
     expect(totals.a_sigma).to eq(302.5)
+    expect(totals.a_size).to  eq(2)
     expect(totals.b_sigma).to eq(402.5)
+    expect(totals.b_size).to  eq(2)
     expect(totals.delta).to   eq(100)
   end
 end

data/spec/differential/parser/reader_spec.rb

@@ -49,6 +49,51 @@ describe ::Differential::Parser::Reader do
       expect(record.value).to     eq(hash[:minutes])
       expect(record.data).to      eq(hash)
     end
+
+    it 'should skip null records' do
+      reader = ::Differential::Parser::Reader.new(record_id_key:  :name,
+                                                  value_key:      :minutes)
+
+      hashes = [nil]
+
+      records = []
+      reader.each(hashes) do |record|
+        records << record
+      end
+
+      expect(records.length).to eq(0)
+    end
+  end
+
+  it 'should read non-array input' do
+    reader = ::Differential::Parser::Reader.new(record_id_key:  :name,
+                                                value_key:      :minutes)
+
+    hashes = {
+      name: 'Matt',
+      minutes: 34
+    }
+
+    records = []
+    reader.each(hashes) do |record|
+      records << record
+    end
+
+    expect(records.length).to eq(1)
+  end
+
+  it 'should read null input' do
+    reader = ::Differential::Parser::Reader.new(record_id_key:  :name,
+                                                value_key:      :minutes)
+
+    hashes = nil
+
+    records = []
+    reader.each(hashes) do |record|
+      records << record
+    end
+
+    expect(records.length).to eq(0)
   end
 
   context 'When reading singular keys' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: differential
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Matthew Ruggio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-19 00:00:00.000000000 Z
+date: 2018-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard-rspec
@@ -67,6 +67,7 @@ files:
 - ".rubocop.yml"
 - ".ruby-version"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - Guardfile
@@ -82,10 +83,13 @@ files:
 - lib/differential/calculator/side.rb
 - lib/differential/calculator/totals.rb
 - lib/differential/differential.rb
+- lib/differential/parser/id.rb
 - lib/differential/parser/parser.rb
 - lib/differential/parser/reader.rb
 - lib/differential/parser/record.rb
 - lib/differential/version.rb
+- spec/differential/calculator/group_spec.rb
+- spec/differential/calculator/item_spec.rb
 - spec/differential/calculator/report_spec.rb
 - spec/differential/calculator/side_spec.rb
 - spec/differential/calculator/totals_spec.rb
@@ -118,6 +122,8 @@ signing_key:
 specification_version: 4
 summary: Dataset Differential Engine
 test_files:
+- spec/differential/calculator/group_spec.rb
+- spec/differential/calculator/item_spec.rb
 - spec/differential/calculator/report_spec.rb
 - spec/differential/calculator/side_spec.rb
 - spec/differential/calculator/totals_spec.rb