differential 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8056552239b827530db049760009cb2e98458599
+  data.tar.gz: b27b320eb9fe5c3345d5ef537481314a947845c4
+SHA512:
+  metadata.gz: 3c917a846233ba35dee29e3f09de018c1e964103999cc93ae99b313fe4186e1196c5d03f52d5c9c3a1f5ee40da42681fd10b49554ddb1a742a3f1c41e476d499
+  data.tar.gz: 3e3ff548564c27080426c905ebb234fb557e82fd29a0704e09ad8b4169e2ead965a0fba155f812c821575a06b1367a9fe2fd8df9dda4d167f8d838e4694838a9

data/.editorconfig

@@ -0,0 +1,8 @@
+# See http://editorconfig.org/
+
+[*]
+trim_trailing_whitespace = true
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+end_of_line = lf

data/.gitignore

@@ -0,0 +1,2 @@
+.DS_Store
+*.gem

data/.rubocop.yml

@@ -0,0 +1,5 @@
+Metrics/LineLength:
+  Max: 100
+
+Metrics/BlockLength:
+  ExcludedMethods: ['it', 'describe', 'context']

data/.ruby-version

@@ -0,0 +1 @@
+2.3.7

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+- 2.3.1
+- 2.3.7
+cache: bundler
+script:
+- bundle exec rubocop
+- bundle exec rspec
+notifications:
+  hipchat:
+    rooms:
+      secure: OpIo19mre1zR5gJlr1T7BD/jVBYadikM49ueC4HWPt3Wln6LlNM3G1gcXVw4A5Ppd7p+6251aOhLHA44HdjXSo+VrhfgiFO9tfkyNuVIrLxeZr/eQwEnv1JJlPJdL/y2sGsBS5WRIgo+txIkLflQ0zoDpvnR6zkWRaRYZcRWo+X9Q890VHRR0emHURX5Kqsi5sJjHac69uIRbEAtlvdd1KnfNXF6+2udMnH6Kb4BxrSUp6voQ+VTyTGM4f2uMInxvjTVNzCCLgb4zBa5KwZNjjLRXWwIsWC0jVia0IRNskaeoFkFQxsVb33kq55t8XxR/ZuHUr5exFUazPnEc3ht9L/GOCYX4qFwbVPyxwyVZ64hHLx3E5g4ozlVCvBH3MDqkoasep7x+Ml8RuA6lSM2hIM88Eo5g98wpXW2WPiHUTxbtIc/2qKTmMKPZI+J23tuR7kza/5kGyPlqKA5OXr++0MFIUtFhWs1iSSQnq0Anssfxd1EhXPKqR/vqpQVgNSpv/cJOMQInPHSkvcq7kMRQWxka9uXHFT1+YH3kYCsAB30bdp8IPMNKQuemGhqS7GZXke9M32Yx9TKykGyAkzv6NGSc1pUAEViGHuydm6mTdvXYBfTQ3ZE6SIP+Rx5/WCyAyPerADPMI26enlFzzSPucdVU8wErceH1Uq7AleVNFw=

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,87 @@
+PATH
+  remote: .
+  specs:
+    differential (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    ffi (1.9.25)
+    formatador (0.2.5)
+    guard (2.15.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    jaro_winkler (1.5.1)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    lumberjack (1.0.13)
+    method_source (0.9.2)
+    nenv (0.3.0)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    parallel (1.12.1)
+    parser (2.5.3.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rainbow (3.0.0)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.9.10)
+      ffi (>= 0.5.0, < 2)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.59.2)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.10.0)
+    ruby_dep (1.5.0)
+    shellany (0.0.1)
+    thor (0.20.3)
+    unicode-display_width (1.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  differential!
+  guard-rspec (~> 4.7)
+  rspec (~> 3.8)
+  rubocop (~> 0.59)
+
+BUNDLED WITH
+   1.17.1

data/Guardfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2018 Blue Marble Payroll, LLC
+
+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

@@ -0,0 +1,223 @@
+# Differential
+
+[![Build Status](https://travis-ci.org/bluemarblepayroll/differential.svg?branch=master)](https://travis-ci.org/bluemarblepayroll/differential)
+
+Have you ever had two numerical-based data sets of mostly the same data and you wanted to see the summations and deltas of each data set at the report, group, and line level?  Look no further!  Differential allows you to pass in two data sets and it will calculate all that for you.
+
+Consider the following two data sets showing commute times for employees:
+
+**Week 1 Commute Times:**
+
+| Name  | Transport | Minutes
+| ----- | --------- | -------
+| Matt  | Car       | 50
+| Nick  | Car       | 75
+| Sam   | Train     | 48
+| Katie | Bike      | 12
+
+**Week 2 Commute Times:**
+
+| Name  | Transport | Minutes
+| ----- | --------- | -------
+| Matt  | Car       | 30
+| Nick  | Car       | 50
+| Sam   | Train     | 60
+| Nate  | Walk      | 12
+
+You could use Differential to compute the following reports:
+
+**By Employee:**
+
+| Name      | Wk. 1 Minutes | Wk. 2 Minutes | Difference
+| --------- | ------------- | ------------- | ----------
+| Matt      | 50            | 30            | -20
+| Nick      | 75            | 50            | -25
+| Sam       | 48            | 60            | 12
+| Katie     | 12            | 0             | -12
+| Nate      | 0             | 12            | 12
+| **TOTAL** | **185**       | **152**       | **-33**
+
+**By Transport Type:**
+
+| Transport | Wk. 1 Minutes | Wk. 2 Minutes | Difference
+| --------- | ------------- | ------------- | ----------
+| Car       | 125           | 80            | -20
+| Train     | 48            | 60            | -25
+| Bike      | 12            | 0             | 12
+| Walk      | 0             | 12            | -12
+| **TOTAL** | **185**       | **152**       | **-33**
+
+**By Employee, Grouped By Transport Type**
+
+| Transport    | Employee      | Wk. 1 Minutes | Wk. 2 Minutes | Difference
+| ------------ | ------------- | ------------- | ------------- | ----------
+| Car          | Matt          | 50            | 30            | -20
+| Car          | Nick          | 75            | 50            | -25
+| **SUBTOTAL** |               | **125**       | **80**        | **-45**
+| Train        | Sam           | 48            | 60            | 12
+| **SUBTOTAL** |               | **48**        | **60**        | **12**
+| Bike         | Katie         | 12            | 0             | -12
+| **SUBTOTAL** |               | **12**        | **0**         | **-12**
+| Walk         | Nate          | 0             | 12            | 12
+| **SUBTOTAL** |               | **0**         | **12**        | **12**
+| **TOTAL**    |               | **185**       | **152**       | **-33**
+
+## Installation
+
+To install through Rubygems:
+
+````
+gem install install differential
+````
+
+You can also add this to your Gemfile:
+
+````
+bundle add differential
+````
+
+## Examples
+
+In the above example the data sets could be represented as:
+
+```
+week1_data = [
+  { name: 'Matt',   transport: 'Car',   minutes: 50 },
+  { name: 'Nick',   transport: 'Car',   minutes: 75 },
+  { name: 'Sam',    transport: 'Train', minutes: 48 },
+  { name: 'Katie',  transport: 'Bike',  minutes: 12 }
+]
+
+week2_data = [
+  { name: 'Matt',   transport: 'Car',   minutes: 30 },
+  { name: 'Nick',   transport: 'Car',   minutes: 50 },
+  { name: 'Sam',    transport: 'Train', minutes: 60 },
+  { name: 'Nate',   transport: 'Walk',  minutes: 12 }
+]
+```
+
+### By Employee Report
+
+There is a couple key pieces of configuration you need to establish.  Below is the configuration necessary for the 'By Employee' report:
+
+```
+reader_config = {
+  record_id_key:  :name,
+  value_key:      :minutes
+}
+```
+
+To run the report, run:
+
+```
+report = Differential.calculate(week1_data, week2_data, reader_config)
+```
+
+The report variable will now hold a Report object with the following methods:
+
+* a_sigma: sum of all A record values
+* b_sigma: sum of all B record values
+* delta: difference of B - A
+* groups: all groups and their respective items
+
+You can further iterate over groups.  Similar to Report, each group provides the following methods:
+
+* a_sigma: sum of all items in the group for dataset A
+* b_sigma: sum of all items in the group for dataset B
+* delta: difference of all the items in the group: B - A
+* items: all items belonging to the group
+
+Finally, you can iterate over the items array and access the following:
+
+* a_sigma: sum of items in dataset A
+* b_sigma: sum of items in dataset B
+* delta: difference of items B - A
+* a_records: all dataset A records that were aggregated together to produce this item
+* b_records: all dataset B records that were aggregated together to produce this item
+
+### By Transport Report
+
+Change the options like so:
+
+```
+reader_config = {
+  record_id_key:  :transport,
+  value_key:      :minutes
+}
+```
+
+Then execute:
+
+```
+report = Differential.calculate(week1_data, week2_data, reader_config)
+```
+
+### By Employee, Grouped By Transport Type Report
+
+Change the options like so:
+
+```
+reader_config = {
+  record_id_key:  :name,
+  value_key:      :minutes,
+  group_id_key:   :transport
+}
+```
+
+Then execute:
+
+```
+report = Differential.calculate(week1_data, week2_data, reader_config)
+```
+
+Now, this will output a report with two groups instead of one which will allow you to present this with sub-totals.
+
+### Compound ID Keys
+
+You are not restricted to automatically derive a unique ID per record, the library can also handle this like so:
+
+```
+reader_config = {
+  record_id_key:  [:company_id, :employee_id],
+  value_key:      :minutes,
+  group_id_key:   [:transport, :direction]
+}
+```
+
+In this example we are showing that a unique identifier for an employee is not just the employee's ID, but also the companies ID.  The above configuration would output a dataset that is grouped by transport type and direction (i.e. Outbound Train, Inbound Train, Outbound Car, etc...) and lists each unique employee per company in each group.  
+
+## Contributing
+
+### Development Environment Configuration
+
+Basic steps to take to get this repository compiling:
+
+1. Install [Ruby](https://www.ruby-lang.org/en/documentation/installation/) (check differential.gemspec for versions supported)
+2. Install bundler (gem install bundler)
+3. Clone the repository (git clone git@github.com:bluemarblepayroll/differential.git)
+4. Navigate to the root folder (cd differential)
+5. Install dependencies (bundle)
+
+### Running Tests
+
+To execute the test suite run:
+
+````
+bundle exec rspec spec --format documentation
+````
+
+Alternatively, you can have Guard watch for changes:
+
+````
+bundle exec guard
+````
+
+Also, do not forget to run Rubocop:
+
+````
+bundle exec rubocop
+````
+
+## License
+
+This project is MIT Licensed.

data/differential.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require './lib/differential/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'differential'
+  s.version     = Differential::VERSION
+  s.summary     = 'Dataset Differential Engine'
+
+  s.description = <<-DESCRIPTION
+    Differential is a numeric-based library will compare two datasets and give you three
+    levels of comparison: report, group, and item level.
+    Each level provides the sum of each dataset and the difference.
+  DESCRIPTION
+
+  s.authors     = ['Matthew Ruggio']
+  s.email       = ['mruggio@bluemarblepayroll.com']
+  s.files       = `git ls-files`.split("\n")
+  s.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.homepage    = 'https://github.com/bluemarblepayroll/differential'
+  s.license     = 'MIT'
+
+  s.required_ruby_version = '>= 2.3.1'
+
+  s.add_development_dependency('guard-rspec', '~>4.7')
+  s.add_development_dependency('rspec', '~> 3.8')
+  s.add_development_dependency('rubocop', '~> 0.59')
+end

data/lib/differential.rb

@@ -0,0 +1,10 @@
+# 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_relative 'differential/differential'

data/lib/differential/calculator/calculator.rb

@@ -0,0 +1,15 @@
+# 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_relative 'side'
+require_relative 'has_totals'
+require_relative 'item'
+require_relative 'group'
+require_relative 'report'
+require_relative 'totals'