match_arrays 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3750a65b4fc6889ec619f3a626c43d3b57575127
+  data.tar.gz: 589f315e5610264cbfb958d6b2c8c57984e1136d
+SHA512:
+  metadata.gz: 89ff40c70b0553edb79f2ba06bf9a510908ff2c1785f6432844bffa908203fe52cdda6bd3f95fe165782a2d42c94a654431aa90049c8db0b652dfcba4a192c75
+  data.tar.gz: c036739fa1fe54f4d21c094a9cdab983ff18e0a4716d3a3c75063325ddb5133b984ee5867d5e0a02f2e255413d6bc29bfdffe7baadbbc37d99eb48d46b4f42c0

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+/vendor/bundle

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in match_arrays.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    match_arrays (1.0.0)
+      activerecord
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.2.4.4)
+      activesupport (= 5.2.4.4)
+    activerecord (5.2.4.4)
+      activemodel (= 5.2.4.4)
+      activesupport (= 5.2.4.4)
+      arel (>= 9.0)
+    activesupport (5.2.4.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    concurrent-ruby (1.1.7)
+    diff-lcs (1.4.4)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.2)
+    rake (12.3.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.9)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  match_arrays!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 s-saku
+
+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,102 @@
+# MatchArrays
+
+A ruby gem that matches two arrays and executes a callback based on the match result.
+
+This gem is especially useful in the process of DB updating with values posted via API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'match_arrays'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install match_arrays
+
+## Usage
+
+### Prepare two arrays (masters, transactions) with elements of Hash or Rails ActiveRecord.
+
+```Ruby
+masters = [{ k: "a", v: 1 }, { k: "b", v:2 }]
+transactions = [{ k: "b", v: 3 }, { k: "c", v:4 }]
+```
+
+masters means the base array and transactions means the dependent array.
+For example, in the context of updating the DB via the API, masters means the DB values and transactions means the values sent from the API.
+
+In this gem, the element of masters is represented as MA, and the element of transactions as TR.
+
+### Define a Proc that specifies the matching key for each array element.
+
+```Ruby
+p_m_key = proc { |ma| ma[:k] }
+p_t_key = proc { |tr| tr[:k] }
+```
+
+### Define the Proc you want to call in each case: Matching, TR only, MA only.
+
+```Ruby
+p_match = proc do |ma, tr|
+  # something to do when matching
+  # e.g. fetch MA data from DB, and update DB by TR value.
+end
+
+p_tr_only = proc do |t|
+  # something to do when TR only
+  # e.g. create a new record by TR value
+end
+
+p_ma_only = proc do |m|
+  # something to do when MA only
+  # e.g. delete MA record
+end
+```
+
+### Call the Match method to execute the specified Proc while matching two arrays.
+
+```Ruby
+MatchArrays.match(
+  masters: masters,
+  transactions: transactions,
+  p_m_key: p_m_key,
+  p_t_key: p_t_key,
+  p_match: p_match,
+  p_tr_only: p_tr_only,
+  p_ma_only: p_ma_only
+)
+```
+
+### (Optional) You can give freely available arguments.
+
+```
+tr_only_records = []
+
+p_tr_only = proc do |t, tr_only_records|
+  tr_only_records.push(t)
+end
+
+MatchArrays.match(
+  (the same as above),
+  attr_obj: tr_only_records )
+
+puts tr_only_records
+#=> [{ k: "c", v:4 }]
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/s-saku/match_arrays.
+
+## Change Log
+
+### v1.0.0
+
+First release

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "match_arrays"
+
+# 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(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/match_arrays.rb

@@ -0,0 +1,59 @@
+require "match_arrays/version"
+require "active_record"
+
+module MatchArrays
+  class Error < StandardError; end
+
+  # A function that matches two arrays (masters, transactions) containing hash or ActiveRecord with the specified key.
+  # It judges "matching", "master only", or "transaction only", and then calls the callback Proc specified for each.
+  #
+  # * In this gem, the elements of the masters and transactions arrays are called "MA" and "TR" respectively.
+  # * Callbacks are accepted only for Proc, not for lambda, because lambda does not fit the strict error checking of block arguments.
+  # * Masters and transactions are replaced with an empty array only when nil is input.
+  #   This is because it is expected to work as intended in many cases.
+  def self.match(masters:, transactions:, p_m_key:, p_t_key:, p_match:, p_tr_only:, p_ma_only:, attr_obj: nil)
+    nil_to_array_masters = masters.nil? ? [] : masters
+    nil_to_array_transactions = transactions.nil? ? [] : transactions
+    raise ArgumentError, "Only an Array is accepted as the :masters argument." unless nil_to_array_masters.is_a?(Array) || nil_to_array_masters.is_a?(ActiveRecord::Associations::CollectionProxy)
+    raise ArgumentError, "Only an Array is accepted as the :transactions argument." unless nil_to_array_transactions.is_a?(Array) || nil_to_array_transactions.is_a?(ActiveRecord::Associations::CollectionProxy)
+    raise ArgumentError, "Only an Proc is accepted as the :p_m_key argument." unless p_m_key.is_a?(Proc)
+    raise ArgumentError, "Only an Proc is accepted as the :p_t_key argument." unless p_t_key.is_a?(Proc)
+    raise ArgumentError, "Only an Proc is accepted as the :p_match argument." unless p_match.is_a?(Proc)
+    raise ArgumentError, "Only an Proc is accepted as the :p_tr_only argument." unless p_tr_only.is_a?(Proc)
+    raise ArgumentError, "Only an Proc is accepted as the :p_ma_only argument." unless p_ma_only.is_a?(Proc)
+
+    # Generate a hash that can access MA with the key defined in p_m_key
+    ma_hash = nil_to_array_masters.each_with_object({}) do |ma, hash|
+      key = p_m_key.call(ma).to_s # Force to_s to avoid matching type errors
+      hash[key] = ma
+    end
+
+    # Create a hash with the same content as ma_hash.
+    # Deleting a MA that matches a TR from this hash, and determine that the remaining elements are "MA only"
+    ma_only_hash = nil_to_array_masters.each_with_object({}) do |ma, hash|
+      key = p_m_key.call(ma).to_s # Force to_s to avoid matching type errors
+      hash[key] = ma
+    end
+
+    # Create a hash that can access TR with the key defined in p_t_key
+    tr_hash = nil_to_array_transactions.each_with_object({}) do |tr, hash|
+      key = p_t_key.call(tr).to_s # Force to_s to avoid matching type errors
+      hash[key] = tr
+    end
+
+    # Read TRs one at a time and determine whether it is "matching" or "TR only"
+    tr_hash.each do |key, tr|
+      if ma_hash[key].present?
+        p_match.call(ma_hash[key], tr, attr_obj, nil_to_array_masters, nil_to_array_transactions)
+        ma_only_hash.delete(key)
+      else
+        p_tr_only.call(tr, attr_obj, nil_to_array_masters, nil_to_array_transactions)
+      end
+    end
+
+    # Call the "MA only" callback.
+    ma_only_hash.each_value do |ma|
+      p_ma_only.call(ma, attr_obj, nil_to_array_masters, nil_to_array_transactions)
+    end
+  end
+end

data/lib/match_arrays/version.rb

@@ -0,0 +1,3 @@
+module MatchArrays
+  VERSION = "1.0.0"
+end

data/match_arrays.gemspec

@@ -0,0 +1,29 @@
+require_relative 'lib/match_arrays/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "match_arrays"
+  spec.version       = MatchArrays::VERSION
+  spec.authors       = ["s-saku"]
+  spec.email         = ["t.nishi7@gmail.com"]
+
+  spec.summary       = %q{A ruby gem that matches two arrays and executes a callback based on the match result.}
+  spec.homepage      = "https://github.com/s-saku/match_arrays"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/s-saku/match_arrays"
+  spec.metadata["changelog_uri"] = "https://github.com/s-saku/match_arrays/blob/main/README.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 2.4.4'
+  spec.add_dependency "activerecord"
+  spec.add_development_dependency "bundler", "~> 2.0"
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: match_arrays
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- s-saku
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-12-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: 
+email:
+- t.nishi7@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/match_arrays.rb
+- lib/match_arrays/version.rb
+- match_arrays.gemspec
+homepage: https://github.com/s-saku/match_arrays
+licenses: []
+metadata:
+  homepage_uri: https://github.com/s-saku/match_arrays
+  source_code_uri: https://github.com/s-saku/match_arrays
+  changelog_uri: https://github.com/s-saku/match_arrays/blob/main/README.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.4
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14.1
+signing_key: 
+specification_version: 4
+summary: A ruby gem that matches two arrays and executes a callback based on the match
+  result.
+test_files: []