differential 1.0.6 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fa747f8e377b675d626c4c49cd31f84a73ca9bf8
-  data.tar.gz: 4c3af655ca69988cffa9928a3debb84eaeb8206b
+SHA256:
+  metadata.gz: aff1c3bc13783c56a247f1b98cba64325353025acc9a6a7066faeafc0ed13648
+  data.tar.gz: 5f7ef17c708fd0aeb0d526e1b2730443aa3238ac911d3f2f991fd077d77631a1
 SHA512:
-  metadata.gz: 6758f520698fa56574aa43b44e52a798db2c116200abea0ecbae1f14df36171d8f407e4755522ff70b95ac6328fc6117511a2efa11c8552bea0ed59e7d167eb9
-  data.tar.gz: b9e7a247c19f542fdc06783b324612d4a1d7ee6f7f8c43ece8f2925a175be1b13b0ac113cd852138f1d412eb621b0f2951a85685cfa1b2f353a9bc5e54e9b4f3
+  metadata.gz: '02695fa3ae5f6a79832b20ab712686cfb8c73870b5db4b09a4401d5ea3ea17e7a1d4adf1196275d450584d78dcac82a3a78a48fe0db0bcf9a2e7b2a035b0d449'
+  data.tar.gz: dd6a57d4355e960d241f93b60c308244ae1e941cff08be46cc2cec3a73ce2dce573d75cdae356835d919da383ad92775addf99d3517c1abc4b77c102ebccd89e

data/.gitignore

@@ -1,3 +1,4 @@
 .DS_Store
 *.gem
 /tmp
+/coverage

data/.rubocop.yml

@@ -3,3 +3,6 @@ Metrics/LineLength:
 
 Metrics/BlockLength:
   ExcludedMethods: ['it', 'describe', 'context']
+
+AllCops:
+  TargetRubyVersion: 2.3

data/.ruby-version

@@ -1 +1 @@
-2.3.7
+2.6.0

data/.travis.yml

@@ -1,10 +1,20 @@
+env:
+  global:
+    - CC_TEST_REPORTER_ID=1d6125e1405ca3b6b88d283e48958d8996eda8f3ece262fd0714e3a0463df3c3
 language: ruby
 rvm:
-- 2.3.1
-- 2.3.7
-- 2.3.8
-- 2.6.0
+  # Build on the latest stable of all supported Rubies (https://www.ruby-lang.org/en/downloads/):
+  - 2.3.8
+  - 2.4.5
+  - 2.5.3
+  - 2.6.0
 cache: bundler
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
 script:
-- bundle exec rubocop
-- bundle exec rspec
+  - bundle exec rubocop
+  - bundle exec rspec
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 1.1.0 (January 31, 2019)
+
+Maintenance Update + 1 Enhancement
+
+* Ruby to min version 2.3.8
+* Updated Rubocop
+* Updated README
+* Minor performance optimization: Allow input to be a reader (responds to #each.)
+
 ## 1.0.6 (January 11, 2019)
 
 - Added Data Peeking for groups and items (group#data_peek, item#data_peek methods).

data/Gemfile.lock

@@ -1,14 +1,16 @@
 PATH
   remote: .
   specs:
-    differential (1.0.6)
+    differential (1.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ansi (1.5.0)
     ast (2.4.0)
     coderay (1.1.2)
     diff-lcs (1.3)
+    docile (1.3.1)
     ffi (1.9.25)
     formatador (0.2.5)
     guard (2.15.0)
@@ -25,7 +27,9 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    jaro_winkler (1.5.1)
+    hirb (0.7.3)
+    jaro_winkler (1.5.2)
+    json (2.1.0)
     listen (3.1.5)
       rb-fsevent (~> 0.9, >= 0.9.4)
       rb-inotify (~> 0.9, >= 0.9.7)
@@ -36,8 +40,8 @@ GEM
     notiffany (0.1.1)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    parallel (1.12.1)
-    parser (2.5.3.0)
+    parallel (1.13.0)
+    parser (2.6.0.0)
       ast (~> 2.4.0)
     powerpack (0.1.2)
     pry (0.12.2)
@@ -60,19 +64,28 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
-    rubocop (0.59.2)
+    rubocop (0.63.1)
       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)
+      unicode-display_width (~> 1.4.0)
     ruby-progressbar (1.10.0)
     ruby_dep (1.5.0)
     shellany (0.0.1)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-console (0.4.2)
+      ansi
+      hirb
+      simplecov
+    simplecov-html (0.10.2)
     thor (0.20.3)
-    unicode-display_width (1.4.0)
+    unicode-display_width (1.4.1)
 
 PLATFORMS
   ruby
@@ -81,7 +94,9 @@ DEPENDENCIES
   differential!
   guard-rspec (~> 4.7)
   rspec (~> 3.8)
-  rubocop (~> 0.59)
+  rubocop (~> 0.63.1)
+  simplecov (~> 0.16.1)
+  simplecov-console (~> 0.4.2)
 
 BUNDLED WITH
-   1.17.1
+   1.17.2

data/README.md

@@ -1,6 +1,6 @@
 # Differential
 
-[![Build Status](https://travis-ci.org/bluemarblepayroll/differential.svg?branch=master)](https://travis-ci.org/bluemarblepayroll/differential)
+[![Gem Version](https://badge.fury.io/rb/differential.svg)](https://badge.fury.io/rb/differential) [![Build Status](https://travis-ci.org/bluemarblepayroll/differential.svg?branch=master)](https://travis-ci.org/bluemarblepayroll/differential) [![Maintainability](https://api.codeclimate.com/v1/badges/6874556c14fe97ce898e/maintainability)](https://codeclimate.com/github/bluemarblepayroll/differential/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/6874556c14fe97ce898e/test_coverage)](https://codeclimate.com/github/bluemarblepayroll/differential/test_coverage)
 
 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.
 
@@ -251,12 +251,12 @@ 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
+2. Update ```lib/differential/version.rb``` using [semantic versioning](https://semver.org/)
+3. Install dependencies: ```bundle```
+4. Update ```CHANGELOG.md``` with release notes
+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
+7. Publish package to RubyGems: `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`
 

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'differential'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/differential.gemspec

@@ -21,9 +21,11 @@ Gem::Specification.new do |s|
   s.homepage    = 'https://github.com/bluemarblepayroll/differential'
   s.license     = 'MIT'
 
-  s.required_ruby_version = '>= 2.3.1'
+  s.required_ruby_version = '>= 2.3.8'
 
   s.add_development_dependency('guard-rspec', '~>4.7')
   s.add_development_dependency('rspec', '~> 3.8')
-  s.add_development_dependency('rubocop', '~> 0.59')
+  s.add_development_dependency('rubocop', '~>0.63.1')
+  s.add_development_dependency('simplecov', '~>0.16.1')
+  s.add_development_dependency('simplecov-console', '~>0.4.2')
 end

data/lib/differential/differential.rb

@@ -23,8 +23,8 @@ module Differential
       reader = ::Differential::Parser::Reader.new(reader_config)
       report = ::Differential::Calculator::Report.new
 
-      reader.each(dataset_a) { |record| report.add(record, A) }
-      reader.each(dataset_b) { |record| report.add(record, B) }
+      dataset_a.each { |hash| report.add(reader.read(hash), A) }
+      dataset_b.each { |hash| report.add(reader.read(hash), B) }
 
       report
     end

data/lib/differential/parser/reader.rb

@@ -31,30 +31,21 @@ module Differential
         @group_id_key   = group_id_key
       end
 
-      def each(hashes)
-        return enum_for(:each) unless block_given?
-
-        array(hashes).each do |hash|
-          next unless hash
-
-          record = read(hash)
-          yield record
-        end
-      end
-
-      private
-
       def read(hash)
         id        = make_record_id(hash)
         group_id  = make_group_id(hash)
         value     = hash[value_key]
 
-        ::Differential::Parser::Record.new(id:        id,
-                                           group_id:  group_id,
-                                           value:     value,
-                                           data:      hash)
+        ::Differential::Parser::Record.new(
+          id: id,
+          group_id: group_id,
+          value: value,
+          data: hash
+        )
       end
 
+      private
+
       def make_record_id(hash)
         record_id_key_array.map { |k| hash[k] }
       end
@@ -74,8 +65,12 @@ module Differential
       def array(hashes)
         if hashes.is_a?(Hash)
           [hashes]
-        else
+        # If the consumer passed in a value that responds to each (is enumerable-like) then
+        # we can accept that as is.
+        elsif !hashes.respond_to?(:each)
           Array(hashes)
+        else
+          hashes
         end
       end
     end

data/lib/differential/version.rb

@@ -8,5 +8,5 @@
 #
 
 module Differential
-  VERSION = '1.0.6'
+  VERSION = '1.1.0'
 end

data/spec/differential/calculator/group_spec.rb

@@ -27,10 +27,10 @@ describe ::Differential::Calculator::Group do
     ]
 
     unsorted_ids.each do |unsorted_id|
-      record = ::Differential::Parser::Record.new(id:       unsorted_id,
+      record = ::Differential::Parser::Record.new(id: unsorted_id,
                                                   group_id: group_id,
-                                                  value:    1,
-                                                  data:     {})
+                                                  value: 1,
+                                                  data: {})
 
       group.add(record, ::Differential::Calculator::Side::A)
     end
@@ -43,10 +43,10 @@ describe ::Differential::Calculator::Group do
   end
 
   it 'should peek at data based on first item it finds' do
-    record = ::Differential::Parser::Record.new(id:       '1',
+    record = ::Differential::Parser::Record.new(id: '1',
                                                 group_id: group_id,
-                                                value:    1,
-                                                data:     { name: 'Millie' })
+                                                value: 1,
+                                                data: { name: 'Millie' })
 
     group.add(record, ::Differential::Calculator::Side::A)
 

data/spec/differential/calculator/report_spec.rb

@@ -146,10 +146,10 @@ describe ::Differential::Calculator::Report do
     ]
 
     unsorted_ids.each do |unsorted_id|
-      record = ::Differential::Parser::Record.new(id:       '1',
+      record = ::Differential::Parser::Record.new(id: '1',
                                                   group_id: unsorted_id,
-                                                  value:    1,
-                                                  data:     {})
+                                                  value: 1,
+                                                  data: {})
 
       report.add(record, ::Differential::Calculator::Side::A)
     end

data/spec/differential/differential_spec.rb

@@ -20,14 +20,14 @@ describe ::Differential do
     ]
 
     reader_config = {
-      record_id_key:  :name,
-      value_key:      :minutes,
-      group_id_key:   :transport
+      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)
+    report = ::Differential.calculate(dataset_a: dataset_a,
+                                      dataset_b: dataset_b,
+                                      reader_config: reader_config)
 
     expect(report.groups.length).to eq(2)
   end

data/spec/differential/parser/reader_spec.rb

@@ -12,9 +12,9 @@ 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
+      record_id_key: :name,
+      value_key: :minutes,
+      group_id_key: :transport
     }
 
     reader = ::Differential::Parser::Reader.new(hash)
@@ -26,97 +26,36 @@ describe ::Differential::Parser::Reader do
 
   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)
+      reader = ::Differential::Parser::Reader.new(record_id_key: :name,
+                                                  value_key: :minutes)
 
-      hashes = [
-        {
-          name: 'Matt',
-          minutes: 34
-        }
-      ]
+      hash = {
+        name: 'Matt',
+        minutes: 34
+      }
 
-      records = []
-      reader.each(hashes) do |record|
-        records << record
-      end
-
-      record = records.first
-      hash = hashes.first
+      record = reader.read(hash)
 
       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
-
-    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
     it 'should properly create a record from a hash' do
-      reader = ::Differential::Parser::Reader.new(record_id_key:  :name,
-                                                  value_key:      :minutes,
+      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
+      hash = {
+        name: 'Matt',
+        minutes: 34,
+        transport: 'Train'
+      }
 
-      record = records.first
-      hash = hashes.first
+      record = reader.read(hash)
 
       expect(record.id).to        eq(hash[:name])
       expect(record.group_id).to  eq(hash[:transport])
@@ -127,27 +66,19 @@ describe ::Differential::Parser::Reader do
 
   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
+      reader = ::Differential::Parser::Reader.new(record_id_key: %i[first last],
+                                                  value_key: :minutes,
+                                                  group_id_key: %i[transport direction])
+
+      hash = {
+        first: 'Matt',
+        last: 'Smith',
+        minutes: 34,
+        transport: 'Train',
+        direction: 'Outbound'
+      }
+
+      record = reader.read(hash)
 
       expect(record.id).to        eq("#{hash[:first]}:#{hash[:last]}")
       expect(record.id.data).to   eq([hash[:first], hash[:last]])

data/spec/spec_helper.rb

@@ -10,3 +10,8 @@
 require 'ostruct'
 
 require './lib/differential'
+
+require 'simplecov'
+require 'simplecov-console'
+SimpleCov.formatter = SimpleCov::Formatter::Console
+SimpleCov.start

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: differential
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.1.0
 platform: ruby
 authors:
 - Matthew Ruggio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-11 00:00:00.000000000 Z
+date: 2019-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard-rspec
@@ -44,21 +44,50 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.59'
+        version: 0.63.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.59'
+        version: 0.63.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+- !ruby/object:Gem::Dependency
+  name: simplecov-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.2
 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: []
+executables:
+- console
 extensions: []
 extra_rdoc_files: []
 files:
@@ -73,6 +102,7 @@ files:
 - Guardfile
 - LICENSE
 - README.md
+- bin/console
 - differential.gemspec
 - lib/differential.rb
 - lib/differential/calculator/calculator.rb
@@ -109,15 +139,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.1
+      version: 2.3.8
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Dataset Differential Engine