match_reduce 1.0.0.pre.alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1c3c23c5467e8d1b83480b9440ace8237b05e588a5ea8e0b34212c5130ec2e29
+  data.tar.gz: f7a93d0e34f59b842d1a52e9990f6be7d9901e8a22b55c7af024c52475229c8f
+SHA512:
+  metadata.gz: a0bb6158c5e8a48f279eaaa1c8c8fcaa36c6b48f5b7232a64f6ecba2949e46ea53fc6194c6095ae6fc6c39b8e45fc44b7689de1ca00e1589dbc88a580c0a330f
+  data.tar.gz: dfe1f78b5036761f777f978d0ee2075a06364b356722f14ca74c8a03b873cc2df227aa286cf69258146e2a0688ba6c875a84ed5b64b30286c06694300f287613

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,6 @@
+.DS_Store
+*.gem
+/tmp
+/coverage
+Gemfile.lock
+/pkg

data/.rubocop.yml

@@ -0,0 +1,23 @@
+Metrics/LineLength:
+  Max: 100
+
+Metrics/BlockLength:
+  ExcludedMethods:
+    - let
+    - it
+    - describe
+    - context
+    - specify
+    - define
+
+Metrics/MethodLength:
+  Max: 25
+
+AllCops:
+  TargetRubyVersion: 2.3
+
+Metrics/AbcSize:
+  Max: 16
+
+Metrics/ClassLength:
+  Max: 125

data/.ruby-version

@@ -0,0 +1 @@
+2.6.3

data/.travis.yml

@@ -0,0 +1,25 @@
+env:
+  global:
+    - CC_TEST_REPORTER_ID=3a2a656a2bfbb6accb5058cabf72d576b506eb2211f8dcc555a79cfcab27563b
+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
+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 spec --format documentation
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
+addons:
+  # https://docs.travis-ci.com/user/uploading-artifacts/
+  artifacts:
+    paths:
+      - Gemfile.lock

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 1.0.0-alpha (September 17th, 2019)
+
+* Initial implementation alpha release for testing.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at oss@bluemarblepayroll.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+guard :rspec, cmd: 'DISABLE_SIMPLECOV=true bundle exec rspec --format=documentation' 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)
+
+  watch(%r{^spec/fixtures/snapshots(.*)(\.yaml)$}) do |m|
+    spec_file = m[1].split('/')[0...-1].join('/')
+
+    File.join('spec', 'match_reduce', "#{spec_file}_spec.rb")
+  end
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2019 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,247 @@
+# MatchReduce
+
+[![Gem Version](https://badge.fury.io/rb/match_reduce.svg)](https://badge.fury.io/rb/match_reduce) [![Build Status](https://travis-ci.org/bluemarblepayroll/match_reduce.svg?branch=master)](https://travis-ci.org/bluemarblepayroll/match_reduce) [![Maintainability](https://api.codeclimate.com/v1/badges/a441f1405041cd7a0807/maintainability)](https://codeclimate.com/github/bluemarblepayroll/match_reduce/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/a441f1405041cd7a0807/test_coverage)](https://codeclimate.com/github/bluemarblepayroll/match_reduce/test_coverage) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+MatchReduce is a high-speed, in-memory data aggregation and reduction algorithm.  The lifecycle is:
+
+1. define aggregates
+2. pump records into algorithm
+3. grab results
+
+The dataset will only be processed once no matter how many aggregates you define.  An aggregate is expressed as:
+
+* patterns: an array of hashes, which are used to pattern match records
+* reducer: a function, which is used when a record matches
+* group_keys: key or keys to uniquely semantically identify records, so records do not get added multiple times.  This is extremely beneficial for denormalized datasets where data may exist at row and/or column-level.
+
+## Installation
+
+To install through Rubygems:
+
+````bash
+gem install install match_reduce
+````
+
+You can also add this to your Gemfile:
+
+````bash
+bundle add match_reduce
+````
+
+## Examples
+
+### Getting Started
+
+A very basic example of calling this library would be:
+
+````ruby
+require 'match_reduce'
+
+aggregates = [
+ {
+   name: :total_game_points
+   reducer: ->(memo, record, resolver) { memo.to_i + resolver.get(record, :game_points).to_i },
+   group_keys: :game
+ }
+]
+
+records = [
+  { game: 1, game_points: 199, team: 'Bulls', team_points: 100 },
+  { game: 1, game_points: 199, team: 'Celtics', team_points: 99 },
+  { game: 2, game_points: 240, team: 'Rockets', team_points: 130 },
+  { game: 2, game_points: 240, team: 'Bulls', team_points: 110 }
+]
+
+results = MatchReduce.process(aggregates, records)
+````
+
+`results` would be equal to:
+
+````ruby
+[
+  MatchReduce::Processor::Result.new(
+    name: :total_game_points,
+    records: [
+      { game: 1, game_points: 199, team: 'Bulls', team_points: 100 },
+      { game: 2, game_points: 240, team: 'Rockets', team_points: 130 }
+    ],
+    value: 439
+  )
+]
+````
+
+Notes:
+
+* Not specifying patterns means: "match on everything"
+* group_keys will limit the records matched on, per aggregator, to the first record only.  This is why only the first and third records matched.
+* keys are type-indifferent and will extracted using (the Objectable library)[https://github.com/bluemarblepayroll/objectable].  This means you can leverage dot-notation, non-hash record types, and indifference.  You can also customize the resolver used and pass it as a third argument to MatchReduce#process(aggregates, records, resolver).
+* Names of aggregates are type-sensitive, so: `:total_game_points` and `'total_game_points'` are two different aggregates and will produce two different results.
+
+### Adding Patterns
+
+Let's say we want to discretely know how many points the Bulls, Celtics, and Rockets have scored, we could do this:
+
+````ruby
+require 'match_reduce'
+
+aggregates = [
+ {
+   name: :bulls_points
+   patterns: { team: 'Bulls' },
+   reducer: ->(memo, record, resolver) { memo.to_i + resolver.get(record, :team_points).to_i },
+   group_keys: :game
+ },
+ {
+   name: :celtics_points
+   patterns: { team: 'Celtics' },
+   reducer: ->(memo, record, resolver) { memo.to_i + resolver.get(record, :team_points).to_i },
+   group_keys: :game
+ },
+ {
+   name: :rockets_points
+   patterns: { team: 'Rockets' },
+   reducer: ->(memo, record, resolver) { memo.to_i + resolver.get(record, :team_points).to_i },
+   group_keys: :game
+ }
+]
+
+records = [
+  { game: 1, game_points: 199, team: 'Bulls', team_points: 100 },
+  { game: 1, game_points: 199, team: 'Celtics', team_points: 99 },
+  { game: 2, game_points: 240, team: 'Rockets', team_points: 130 },
+  { game: 2, game_points: 240, team: 'Bulls', team_points: 110 }
+]
+
+results = MatchReduce.process(aggregates, records)
+````
+
+`results` would now be equal to:
+
+````ruby
+[
+  MatchReduce::Processor::Result.new(
+    name: :bulls_points,
+    records: [
+      { game: 1, game_points: 199, team: 'Bulls', team_points: 100 },
+      { game: 2, game_points: 240, team: 'Bulls', team_points: 110 }
+    ],
+    value: 210
+  ),
+  MatchReduce::Processor::Result.new(
+    name: :celtics_points,
+    records: [
+      { game: 1, game_points: 199, team: 'Celtics', team_points: 99 },
+    ],
+    value: 99
+  ),
+  MatchReduce::Processor::Result.new(
+    name: :rockets_points,
+    records: [
+      { game: 2, game_points: 240, team: 'Rockets', team_points: 130 },
+    ],
+    value: 130
+  ),
+]
+````
+
+We could also choose to aggregate multiple teams together by providing multiple patterns:
+
+````ruby
+require 'match_reduce'
+
+aggregates = [
+ {
+   name: :bulls_and_celtics_points
+   patterns: [
+     { team: 'Bulls' },
+     { team: 'Celtics' }
+   ],
+   reducer: ->(memo, record, resolver) { memo.to_i + resolver.get(record, :team_points).to_i },
+   group_keys: :game
+ },
+]
+
+records = [
+  { game: 1, game_points: 199, team: 'Bulls', team_points: 100 },
+  { game: 1, game_points: 199, team: 'Celtics', team_points: 99 },
+  { game: 2, game_points: 240, team: 'Rockets', team_points: 130 },
+  { game: 2, game_points: 240, team: 'Bulls', team_points: 110 }
+]
+
+results = MatchReduce.process(aggregates, records)
+````
+
+`results` would now be equal to:
+
+````ruby
+[
+  MatchReduce::Processor::Result.new(
+    name: :bulls_points,
+    records: [
+      { game: 1, game_points: 199, team: 'Bulls', team_points: 100 },
+      { game: 1, game_points: 199, team: 'Celtics', team_points: 99 },
+      { game: 2, game_points: 240, team: 'Bulls', team_points: 110 }
+    ],
+    value: 309
+  )
+]
+````
+
+## 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 match_reduce.gemspec for versions supported)
+2. Install bundler (gem install bundler)
+3. Clone the repository (git clone git@github.com:bluemarblepayroll/match_reduce.git)
+4. Navigate to the root folder (cd match_reduce)
+5. Install dependencies (bundle)
+
+### Running Tests
+
+To execute the test suite and code-coverage tool, run:
+
+````bash
+bundle exec rspec spec --format documentation
+````
+
+Alternatively, you can have Guard watch for changes:
+
+````bash
+bundle exec guard
+````
+
+Also, do not forget to run Rubocop:
+
+````bash
+bundle exec rubocop
+````
+
+or run all three in one command:
+
+````bash
+bundle exec rake
+````
+
+### 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/match_reduce/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. Run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Code of Conduct
+
+Everyone interacting in this codebase, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/bluemarblepayroll/match_reduce/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+This project is MIT Licensed.

data/Rakefile

@@ -0,0 +1,17 @@
+# 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 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task default: %i[rubocop spec]

data/bin/console

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# 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 'bundler/setup'
+require 'match_reduce'
+
+# 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.
+
+require 'pry'
+Pry.start

data/lib/match_reduce/aggregate.rb

@@ -0,0 +1,61 @@
+# 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 MatchReduce
+  # An aggregate is a group of patterns with a reducer that you wish to report on.
+  class Aggregate
+    acts_as_hashable
+
+    attr_reader :group_keys,
+                :name,
+                :patterns,
+                :reducer
+
+    def initialize(name:, group_keys: [], patterns: [], reducer: nil)
+      raise ArgumentError, 'name is required' if name.to_s.empty?
+
+      @name       = name
+      @group_keys = Array(group_keys)
+      @patterns   = stringed_keys(not_empty(array(patterns)))
+      @reducer    = reducer
+
+      freeze
+    end
+
+    def keys
+      patterns.flat_map(&:keys)
+    end
+
+    def reduce(memo, record, resolver)
+      reducer ? reducer.call(memo, record, resolver) : memo
+    end
+
+    def grouped?
+      !group_keys.empty?
+    end
+
+    private
+
+    attr_reader :resolver
+
+    def stringed_keys(hashes)
+      hashes.map do |hash|
+        hash.map { |k, v| [k.to_s, v] }.to_h
+      end
+    end
+
+    def array(val)
+      val.is_a?(Hash) ? [val] : Array(val)
+    end
+
+    def not_empty(val)
+      val.empty? ? [{}] : val
+    end
+  end
+end

data/lib/match_reduce/any.rb

@@ -0,0 +1,30 @@
+# 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 MatchReduce
+  # This class represents a wildcard.  Direct use of this class should be avoided, instead,
+  # use the MatchReduce top-level-declared helper ANY constant.
+  class Any
+    SPECIAL_VALUE = [name, :any].freeze
+
+    private_constant :SPECIAL_VALUE
+
+    # Just be something totally unique.  Matching values cannot actually be an array, therefore
+    # there should never be a chance of a collision if the hash of this object is based on
+    # an array structure.
+    def hash
+      SPECIAL_VALUE.hash
+    end
+
+    def ==(other)
+      other.instance_of?(self.class) && hash == other.hash
+    end
+    alias eql? ==
+  end
+end

data/lib/match_reduce/index.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.
+#
+
+module MatchReduce
+  # The Index holds all the aggregates, the reverse lookup data structure, and the ability
+  # to retrieve aggregates based on a pattern
+  class Index
+    extend Forwardable
+
+    attr_reader :aggregates,
+                :any_value,
+                :lookup
+
+    def_delegators :record, :keys
+
+    def initialize(aggregates = [], any_value = ANY)
+      @any_value  = any_value
+      @aggregates = Aggregate.array(aggregates).uniq(&:name)
+      @lookup     = {}
+
+      all_keys = @aggregates.flat_map(&:keys)
+      @record  = HashMath::Record.new(all_keys, any_value)
+
+      @aggregates.map do |aggregate|
+        aggregate.patterns.each do |pattern|
+          normalized_pattern = record.make!(pattern)
+
+          get(normalized_pattern) << aggregate
+        end
+      end
+
+      freeze
+    end
+
+    def find(pattern)
+      lookup.fetch(pattern, [])
+    end
+
+    private
+
+    attr_reader :record
+
+    def get(normalized_pattern)
+      lookup[normalized_pattern] ||= Set.new
+    end
+  end
+end

data/lib/match_reduce/processor/result.rb

@@ -0,0 +1,37 @@
+# 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 MatchReduce
+  class Processor
+    # This is the main resulting value object returned, one per aggregate.
+    class Result
+      attr_reader :name, :records, :value
+
+      def initialize(name, records, value)
+        @name     = name
+        @records  = records
+        @value    = value
+
+        freeze
+      end
+
+      def hash
+        [name, records, value].hash
+      end
+
+      def ==(other)
+        other.instance_of?(self.class) &&
+          name == other.name &&
+          records == other.records &&
+          value == other.value
+      end
+      alias eql? ==
+    end
+  end
+end