identity_parade 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b6fe64eaee5917d1f7f7863c91e3bc52c66db275f5c12d528a95a813fd499e7
-  data.tar.gz: c965c706a93b5f372c57c540a43d45f13c0d835da4a81ddafd24c8ebc81d3bf1
+  metadata.gz: 7380c519639022df0efa2b685bab2d9572c9f3acbf9e86a27cb2cd49a35df75c
+  data.tar.gz: 9aaf25c04855146be3e8c5776e3cfd100699202b3ad7bcdafa87b500ca6a628e
 SHA512:
-  metadata.gz: 5203135418469da69bb62cdaeeb0bd951b2485a8e1f0828cef21ff18fa0304bc1607c160a043f7c52b558c65273edf106241d9b737786b4732ae1b85d1bc5f03
-  data.tar.gz: c9792595e20de8b7c84b7397951c9a95237f063b85a797edeaf23a652a71a82112d7083f2c784dbadbd163330f5cafe63be9dc1dd047ec74875a2c5182ab1fa7
+  metadata.gz: c0a55315ad2c80c0858d829bbb8df5c82f34dcd66f418e0e98ef9dca4a8fc8ba31c36e65166cca11078ddeb0503b658a0481995e6e98e47de9faeafc269f61de
+  data.tar.gz: a1577e814ddaecd0829e5bce5d81d688883e8570cae39d63a139256f9ae27efef4e515251c99c9fb9c055a64fcf67bdcfe6c574886fabfab71f37423f00a5bc9

data/README.md

@@ -20,25 +20,51 @@ Or install it yourself as:
 
 ## Usage
 
+IdentityParade has a very simple API. There are basically only two methods:
+
 ``` ruby
-IdentityParade.match(original, possible_duplicate)
+# Checks the similarity between to arguments. Returns a number between
+# 0 and 1. 0 is no similarity and 1 is a complete duplicate.
+IdentityParade.match(arg1, arg2)
 # => 0.95
 
-IdentityParade.match?(original, possible_duplicate)
+# When matching score is equal or greater than the global +matching_score+
+# it returns true - otherwise false.
+IdentityParade.match?(arg1, arg2)
 # => true
 ```
 
+## Configuration
+
+IdentityParade can be configured by the `configure` method:
+
+``` ruby
+IdentityParade.configure do |config|
+  # Blacklist some keys in a hash that should not be compared.
+  config.blacklisted_keys = %w[id created_at updated_at]
+  # Set the global match score to 80%
+  config.match_score = 0.80
+end
+```
 
 ## 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.
+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).
+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.
+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).
+The gem is available as open source under the terms of the [MIT
+License](https://opensource.org/licenses/MIT).

data/identity_parade.gemspec

@@ -9,8 +9,10 @@ Gem::Specification.new do |spec|
   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.summary       = 'Checks basic data types for similarity.'
+  spec.description   = 'IdentityParade allows you to compare two basic data ' \
+                       'types, e.g. hashes, arrays, numbers and strings.' \
+                       'It returns a matching score or a boolean.'
   spec.homepage      = 'https://github.com/henvo/identity_parade'
   spec.license       = 'MIT'
 
@@ -37,4 +39,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'reek', '~> 4.8'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'simplecov', '~> 0.16'
 end

data/lib/identity_parade/match.rb

@@ -8,16 +8,19 @@ module IdentityParade
       @right = right
     end
 
+    # @return [Float] the matching score
     def score
       return unless Kernel.const_defined?(matcher_class_name)
 
       matcher.new(@left, @right).score
     end
 
+    # @return [Class] The matcher class
     def matcher
       matcher_class_name.constantize
     end
 
+    # @return [String] the matcher class name
     def matcher_class_name
       "identity_parade/matchers/#{@left.class.name.underscore}_matcher".classify
     end

data/lib/identity_parade/matcher.rb

@@ -1,5 +1,8 @@
 module IdentityParade
-  # The base class for all matchers
+  # The base class for all matchers implements the basic interface for all
+  # matchers.
+  #
+  # Every matcher MUST implement a score method that returns a Number.
   class Matcher
     attr_reader :left, :right
 

data/lib/identity_parade/matchers/boolean_matcher.rb

@@ -3,9 +3,7 @@ module IdentityParade
     # This matcher checks the similarity of booleans
     class BooleanMatcher < Matcher
       def score
-        return 0 unless [TrueClass, FalseClass].include?(@right.class)
-
-        @left == @right ? 1 : 0
+        @left.class == @right.class ? 1 : 0
       end
     end
   end

data/lib/identity_parade/version.rb

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

data/lib/identity_parade.rb

@@ -14,15 +14,15 @@ require 'identity_parade/matchers/boolean_matcher'
 require 'identity_parade/matchers/true_class_matcher'
 require 'identity_parade/matchers/false_class_matcher'
 
-
 # This gem allows to compare two types.
 module IdentityParade
   class << self
-    # :reek;Attribute because we want to share the config
+    # :reek:Attribute because we want to share the config
     def config
       @config ||= RecursiveOpenStruct.new
     end
 
+    # Allows to configure the global configuration
     def configure
       yield(config)
     end
@@ -30,10 +30,23 @@ module IdentityParade
 
   module_function
 
+  # Get the matching score of two basic data types
+  #
+  # @param left [Number, String, Array, TrueClass, FalseClass] left
+  # @param right [Number, String, Array, TrueClass, FalseClass] right
+  #
+  # @return [Float] the matching score
   def match(left, right)
     IdentityParade::Match.new(left, right).score
   end
 
+  # Checks if a matching score is higher than the globally configure
+  # match_score.
+  #
+  # @param left [Number, String, Array, TrueClass, FalseClass] left
+  # @param right [Number, String, Array, TrueClass, FalseClass] right
+  #
+  # @return [TrueClass, FalseClass] the result
   def match?(left, right)
     match(left, right) >= IdentityParade.config.match_score
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: identity_parade
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Henning Vogt
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-25 00:00:00.000000000 Z
+date: 2018-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -128,7 +128,22 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: This gem allows to compare two hashes.
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+description: IdentityParade allows you to compare two basic data types, e.g. hashes,
+  arrays, numbers and strings.It returns a matching score or a boolean.
 email:
 - git@henvo.de
 executables: []
@@ -185,5 +200,5 @@ rubyforge_project:
 rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: Find duplicates or near-duplicates of.
+summary: Checks basic data types for similarity.
 test_files: []