differential 1.0.1

data/spec/differential/calculator/side_spec.rb

@@ -0,0 +1,30 @@
+# 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::Side do
+  it 'should contain the correct number of constants' do
+    constants = ::Differential::Calculator::Side.constants
+
+    expect(constants.length).to eq(2)
+  end
+
+  it 'should contain the correct constant for side a' do
+    value = ::Differential::Calculator::Side.const_get(:A)
+
+    expect(value).to eq(:a)
+  end
+
+  it 'should contain the correct constant for side a' do
+    value = ::Differential::Calculator::Side.const_get(:B)
+
+    expect(value).to eq(:b)
+  end
+end

data/spec/differential/calculator/totals_spec.rb

@@ -0,0 +1,40 @@
+# 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::Totals do
+  it 'should properly calculate sigmas and delta' do
+    totals = ::Differential::Calculator::Totals.new
+
+    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)
+
+    totals.add(400, ::Differential::Calculator::Side::B)
+
+    expect(totals.a_sigma).to eq(300)
+    expect(totals.b_sigma).to eq(400)
+    expect(totals.delta).to   eq(100)
+
+    totals.add(2.5, ::Differential::Calculator::Side::A)
+
+    expect(totals.a_sigma).to eq(302.5)
+    expect(totals.b_sigma).to eq(400)
+    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.b_sigma).to eq(402.5)
+    expect(totals.delta).to   eq(100)
+  end
+end

data/spec/differential/differential_spec.rb

@@ -0,0 +1,34 @@
+# 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 do
+  it 'should calculate a report' do
+    dataset_a = [
+      { name: 'Matt', minutes: 100, transport: 'Bike' }
+    ]
+
+    dataset_b = [
+      { name: 'Matt', minutes: 20, transport: 'Car' }
+    ]
+
+    reader_config = {
+      record_id_key:  :name,
+      value_key:      :minutes,
+      group_id_key:   :transport
+    }
+
+    report = ::Differential.calculate(dataset_a:      dataset_a,
+                                      dataset_b:      dataset_b,
+                                      reader_config:  reader_config)
+
+    expect(report.groups.length).to eq(2)
+  end
+end

data/spec/differential/parser/reader_spec.rb

@@ -0,0 +1,113 @@
+# 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::Parser::Reader do
+  it 'should initialize correctly' do
+    hash = {
+      record_id_key:  :name,
+      value_key:      :minutes,
+      group_id_key:   :transport
+    }
+
+    reader = ::Differential::Parser::Reader.new(hash)
+
+    expect(reader.record_id_key).to   eq(hash[:record_id_key])
+    expect(reader.value_key).to       eq(hash[:value_key])
+    expect(reader.group_id_key).to    eq(hash[:group_id_key])
+  end
+
+  context 'When reading just id and value' do
+    it 'should properly create a record from a hash' 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
+
+      record = records.first
+      hash = hashes.first
+
+      expect(record.id).to        eq(hash[:name])
+      expect(record.group_id).to  eq('')
+      expect(record.value).to     eq(hash[:minutes])
+      expect(record.data).to      eq(hash)
+    end
+  end
+
+  context 'When reading singular keys' do
+    it 'should properly create a record from a hash' do
+      reader = ::Differential::Parser::Reader.new(record_id_key:  :name,
+                                                  value_key:      :minutes,
+                                                  group_id_key: :transport)
+
+      hashes = [
+        {
+          name: 'Matt',
+          minutes: 34,
+          transport: 'Train'
+        }
+      ]
+
+      records = []
+      reader.each(hashes) do |record|
+        records << record
+      end
+
+      record = records.first
+      hash = hashes.first
+
+      expect(record.id).to        eq(hash[:name])
+      expect(record.group_id).to  eq(hash[:transport])
+      expect(record.value).to     eq(hash[:minutes])
+      expect(record.data).to      eq(hash)
+    end
+  end
+
+  context 'When reading multiple id keys' do
+    it 'should properly create a record from a hash' do
+      reader = ::Differential::Parser::Reader.new(record_id_key:  %i[first last],
+                                                  value_key:      :minutes,
+                                                  group_id_key:   %i[transport direction])
+
+      hashes = [
+        {
+          first: 'Matt',
+          last: 'Smith',
+          minutes: 34,
+          transport: 'Train',
+          direction: 'Outbound'
+        }
+      ]
+
+      records = []
+      reader.each(hashes) do |record|
+        records << record
+      end
+
+      record = records.first
+      hash = hashes.first
+
+      expect(record.id).to        eq("#{hash[:first]}:#{hash[:last]}")
+      expect(record.group_id).to  eq("#{hash[:transport]}:#{hash[:direction]}")
+      expect(record.value).to     eq(hash[:minutes])
+      expect(record.data).to      eq(hash)
+    end
+  end
+end

data/spec/differential/parser/record_spec.rb

@@ -0,0 +1,28 @@
+# 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::Parser::Record do
+  it 'should initialize correctly' do
+    hash = {
+      id: '1',
+      group_id: '2',
+      value: 3,
+      data: { id: '1' }
+    }
+
+    record = ::Differential::Parser::Record.new(hash)
+
+    expect(record.id).to        eq(hash[:id])
+    expect(record.group_id).to  eq(hash[:group_id])
+    expect(record.value).to     eq(hash[:value])
+    expect(record.data).to      eq(hash[:data])
+  end
+end

data/spec/spec_helper.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 './lib/differential'

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: differential
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Matthew Ruggio
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-12-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.59'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.59'
+description: |2
+      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.
+email:
+- mruggio@bluemarblepayroll.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE
+- README.md
+- differential.gemspec
+- lib/differential.rb
+- lib/differential/calculator/calculator.rb
+- lib/differential/calculator/group.rb
+- lib/differential/calculator/has_totals.rb
+- lib/differential/calculator/item.rb
+- lib/differential/calculator/report.rb
+- lib/differential/calculator/side.rb
+- lib/differential/calculator/totals.rb
+- lib/differential/differential.rb
+- lib/differential/parser/parser.rb
+- lib/differential/parser/reader.rb
+- lib/differential/parser/record.rb
+- lib/differential/version.rb
+- spec/differential/calculator/report_spec.rb
+- spec/differential/calculator/side_spec.rb
+- spec/differential/calculator/totals_spec.rb
+- spec/differential/differential_spec.rb
+- spec/differential/parser/reader_spec.rb
+- spec/differential/parser/record_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/bluemarblepayroll/differential
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.3
+signing_key: 
+specification_version: 4
+summary: Dataset Differential Engine
+test_files:
+- spec/differential/calculator/report_spec.rb
+- spec/differential/calculator/side_spec.rb
+- spec/differential/calculator/totals_spec.rb
+- spec/differential/differential_spec.rb
+- spec/differential/parser/reader_spec.rb
+- spec/differential/parser/record_spec.rb
+- spec/spec_helper.rb