identity_parade 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 511f89370f34b95f2bbbf67fcd8b4108f152f81dcb2cdee25dea9faa3f4d0dfa
+  data.tar.gz: c5c719d640fffee1a63bd29561141879ddd2a7ec9697b61befa0b9d4f18bf5dc
+SHA512:
+  metadata.gz: 52b3957c97a9d951600674773443e7befd39563cbd53a8dc87c5ff38db035904195b8c05c499e31073de29ac5ca7eae2d02a0817937bec6b53d77e314649d622
+  data.tar.gz: 68b33f2f09aa840d0ba47966850d865c6d1f11d1212ca08c38108674337c42693be97273863fe6eff4ca3a431753103da463a2752465debd70ed2360f3523656

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in identity_parade.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+(directories %w[lib spec]).select do |d|
+  if Dir.exist?(d)
+    d
+  else
+    UI.warning("Directory #{d} does not exist")
+  end
+end
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch('spec/spec_helper.rb') { 'spec' }
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^app/(.+)\.rb$}) do |m|
+    "spec/#{m[1]}_spec.rb"
+  end
+  watch(%r{^app/(.*)(\.erb|\.haml|\.slim)$}) do |m|
+    "spec/#{m[1]}#{m[2]}_spec.rb"
+  end
+  watch(%r{^lib/(.+)\.rb$}) do |m|
+    "spec/lib/#{m[1]}_spec.rb"
+  end
+  watch(%r{^app/api/(.+)\.rb$}) do |m|
+    "spec/api/#{m[1]}_spec.rb"
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Henning Vogt
+
+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,43 @@
+# IdentityParade
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'identity_parade'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install identity_parade
+
+## Usage
+
+``` ruby
+IdentityParade.match(original, possible_duplicate)
+# => 0.95
+
+IdentityParade.match?(original, possible_duplicate)
+# => true
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/henvo/identity_parade.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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 "identity_parade"
+
+# 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/identity_parade.gemspec

@@ -0,0 +1,40 @@
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'identity_parade/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'identity_parade'
+  spec.version       = IdentityParade::VERSION
+  spec.authors       = ['Henning Vogt']
+  spec.email         = ['git@henvo.de']
+
+  spec.summary       = 'Find duplicates or near-duplicates of.'
+  spec.description   = 'This gem allows to compare two hashes.'
+  spec.homepage      = 'https://github.com/henvo/identity_parade'
+  spec.license       = 'MIT'
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |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.add_dependency 'activesupport', '~> 5.1'
+  spec.add_dependency 'fuzzy-string-match', '~> 1.0', '>= 1.0.1'
+  spec.add_dependency 'recursive-open-struct', '~> 1.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'pry', '~> 0.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'reek', '~> 4.8'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/identity_parade/initializer.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Set some basic configuration settings. This can be overwritten in the
+# application in the same fashion.
+IdentityParade.configure do |config|
+  config.blacklisted_keys = []
+  config.match_score = 0.5
+end

data/lib/identity_parade/match.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module IdentityParade
+  # The initial starting point for a matching.
+  class Match
+    def initialize(left, right)
+      @left = left
+      @right = right
+    end
+
+    def score
+      return unless Kernel.const_defined?(matcher_class_name)
+
+      matcher.new(@left, @right).score
+    end
+
+    def matcher
+      matcher_class_name.constantize
+    end
+
+    def matcher_class_name
+      "identity_parade/matchers/#{@left.class}_matcher".classify
+    end
+  end
+end

data/lib/identity_parade/matcher.rb

@@ -0,0 +1,15 @@
+module IdentityParade
+  # The base class for all matchers
+  class Matcher
+    attr_reader :left, :right
+
+    def initialize(left, right)
+      @left = left
+      @right = right
+    end
+
+    def score
+      raise NotImplementedError
+    end
+  end
+end

data/lib/identity_parade/matchers/array_matcher.rb

@@ -0,0 +1,14 @@
+module IdentityParade
+  module Matchers
+    # This matcher checks the similarity of two arrays. For this purpose, it
+    # iterates over all elements and creates a new matcher for every type.
+    class ArrayMatcher < Matcher
+      def score
+        return if left.empty?
+        return 0 unless right.is_a? Array
+
+        1 - ((left - right).size / left.size.to_f)
+      end
+    end
+  end
+end

data/lib/identity_parade/matchers/float_matcher.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module IdentityParade
+  module Matchers
+    # This matcher checks the similarity of two numerics.
+    class FloatMatcher < Matchers::NumericMatcher; end
+  end
+end

data/lib/identity_parade/matchers/hash_matcher.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module IdentityParade
+  module Matchers
+    # This matcher checks the similarity of two hashes. For this purpose, it
+    # iterates over all elements and creates a new matcher for every type.
+    class HashMatcher < Matcher
+      def score
+        sub_scores.sum / sub_scores.size.to_f
+      end
+
+      # @return [Float] The sum of all sub scores
+      def sub_scores
+        left.map do |key, value|
+          next nil if blacklisted_keys.include?(key.to_s)
+
+          next 0 unless right.key?(key)
+
+          IdentityParade::Match.new(value, right[key]).score
+        end.compact
+      end
+
+      # @return [Array<String>] the list of blacklisted keys
+      # :reek:UtilityFunction because it's a shorthand
+      def blacklisted_keys
+        IdentityParade.config.blacklisted_keys
+      end
+
+      # @return [Array<String>] the list of permitted keys
+      def permitted_keys
+        left.keys.map(&:to_s) - blacklisted_keys
+      end
+    end
+  end
+end

data/lib/identity_parade/matchers/integer_matcher.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module IdentityParade
+  module Matchers
+    # This matcher checks the similarity of two numerics.
+    class IntegerMatcher < Matchers::NumericMatcher; end
+  end
+end

data/lib/identity_parade/matchers/numeric_matcher.rb

@@ -0,0 +1,25 @@
+module IdentityParade
+  module Matchers
+    # This matcher checks the similarity of two numerics.
+    class NumericMatcher < Matcher
+      def score
+        return 1 if max == min
+        return 0 if max.zero?
+
+        min / max
+      end
+
+      def max
+        floats.max
+      end
+
+      def min
+        floats.min
+      end
+
+      def floats
+        [left.to_f, right.to_f]
+      end
+    end
+  end
+end

data/lib/identity_parade/matchers/string_matcher.rb

@@ -0,0 +1,16 @@
+require 'fuzzystringmatch'
+
+module IdentityParade
+  module Matchers
+    # This matcher checks the similarity of two strings.
+    class StringMatcher < Matcher
+      def score
+        jarow.getDistance(left.to_s, right.to_s)
+      end
+
+      def jarow
+        FuzzyStringMatch::JaroWinkler.create(:native)
+      end
+    end
+  end
+end

data/lib/identity_parade/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module IdentityParade
+  VERSION = '0.1.0'.freeze
+end

data/lib/identity_parade.rb

@@ -0,0 +1,38 @@
+require 'recursive-open-struct'
+require 'active_support/all'
+
+require 'identity_parade/version'
+require 'identity_parade/match'
+require 'identity_parade/matcher'
+require 'identity_parade/matchers/hash_matcher'
+require 'identity_parade/matchers/string_matcher'
+require 'identity_parade/matchers/array_matcher'
+require 'identity_parade/matchers/numeric_matcher'
+require 'identity_parade/matchers/integer_matcher'
+require 'identity_parade/matchers/float_matcher'
+
+# This gem allows to compare two types.
+module IdentityParade
+  class << self
+    # :reek;Attribute because we want to share the config
+    def config
+      @config ||= RecursiveOpenStruct.new
+    end
+
+    def configure
+      yield(config)
+    end
+  end
+
+  module_function
+
+  def match(left, right)
+    IdentityParade::Match.new(left, right).score
+  end
+
+  def match?(left, right)
+    match(left, right) >= IdentityParade.config.match_score
+  end
+end
+
+require 'identity_parade/initializer'

metadata

@@ -0,0 +1,185 @@
+--- !ruby/object:Gem::Specification
+name: identity_parade
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Henning Vogt
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: fuzzy-string-match
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: recursive-open-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.8'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: This gem allows to compare two hashes.
+email:
+- git@henvo.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- identity_parade.gemspec
+- lib/identity_parade.rb
+- lib/identity_parade/initializer.rb
+- lib/identity_parade/match.rb
+- lib/identity_parade/matcher.rb
+- lib/identity_parade/matchers/array_matcher.rb
+- lib/identity_parade/matchers/float_matcher.rb
+- lib/identity_parade/matchers/hash_matcher.rb
+- lib/identity_parade/matchers/integer_matcher.rb
+- lib/identity_parade/matchers/numeric_matcher.rb
+- lib/identity_parade/matchers/string_matcher.rb
+- lib/identity_parade/version.rb
+homepage: https://github.com/henvo/identity_parade
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Find duplicates or near-duplicates of.
+test_files: []