record_linkage 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 287d2406379da16f1c2c6b31f15f041d8dd702db
+  data.tar.gz: c52cec061500568bae597814daf2da9931778aa6
+SHA512:
+  metadata.gz: 3cae10fbf8077fe9c8e8b2f360aab56bb33d180145478ef26d274b721e65dcd5671c8b8ceca8144ec13bef7b619f308802452e20f105cd0a648146f3d53b4bf8
+  data.tar.gz: 18be3cc9528c859746f68ecc3bd461efea5e28df5b52e86eb684f5cc89e344b1b6464fa1586af7ad8c9cb6f004100476716a4831b0efbc78672246fc9da2d6f4

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group 'test' do
+  gem 'coveralls', require: false
+  gem 'simplecov-html', require: false
+  gem 'rake'
+  gem 'rspec'
+  gem 'rspec-its'
+  gem 'guard-rspec', require: false
+end

data/README.md

@@ -0,0 +1,2 @@
+
+For doing record linkage, like with Master Data Management

data/lib/record_linkage/object_comparer.rb

@@ -0,0 +1,122 @@
+require 'fuzzystringmatch'
+
+module RecordLinkage
+  # Can be use to create an object with certian rules which can then
+  # be used to compare objects to each other
+  class ObjectComparer
+    # Matcher objects represent how to handle individual rules
+    # to compare one field to another
+    class Matcher
+      # A module to hold the various matcher logic which can be declared
+      # with a String or a Symbol
+      module Matchers
+        JAROW = ::FuzzyStringMatch::JaroWinkler.create(:native)
+
+        def self.fuzzy_string_matcher(value1, value2, options = {})
+          if value1.to_s.strip.size < 3 || value2.to_s.strip.size < 3
+            0.0
+          else
+            score = JAROW.getDistance(value1.downcase, value2.downcase)
+            score > options[:threshold] ? score : 0
+          end
+        end
+
+        def self.exact_string_matcher(value1, value2, _options = {})
+          value1 = value1.to_s.strip.downcase
+          value2 = value2.to_s.strip.downcase
+          (value1.size >= 1 && value1 == value2) ? 1.0 : 0.0
+        end
+
+        def self.array_fuzzy_string_matcher(array1, array2, options = {})
+          array_matcher(:fuzzy_string_matcher, array1, array2, options)
+        end
+
+        def self.array_exact_string_matcher(array1, array2, options = {})
+          array_matcher(:exact_string_matcher, array1, array2, options)
+        end
+
+        def self.array_matcher(single_matcher, array1, array2, options = {})
+          array1.map do |value1|
+            array2.map do |value2|
+              send(single_matcher, value1, value2, options)
+            end
+          end.flatten.sum
+        end
+      end
+
+      attr_reader :property1, :property2
+
+      def initialize(property1, property2, definition, options = {})
+        @property1 = property1
+        @property2 = property2
+        @block = self.class.match_block_from_definition(definition)
+        @options = options
+      end
+
+      def score_objects(object1, object2, default_threshold, default_weight)
+        value1 = object1.send(@property1)
+        value2 = object2.send(@property2)
+
+        threshold = @options[:threshold] || default_threshold
+        weight = @options[:weight] || default_weight
+
+        @block.call(value1, value2, threshold: threshold) * weight
+      end
+
+      def self.match_block_from_definition(definition)
+        case definition
+        when String, Symbol
+          if !Matchers.respond_to?("#{definition}_matcher")
+            fail ArgumentError, "Matcher `#{definition}` is not defined"
+          end
+
+          Matchers.method("#{definition}_matcher")
+        when Proc then definition
+        else
+          fail ArgumentError, "Invalid matcher definition: #{matcher.inspect}"
+        end
+      end
+    end
+
+    # Object given to `initialize` block to allow API
+    # for configuring matchers / values
+    class Config
+      attr_accessor :default_threshold, :default_weight
+      attr_reader :matchers
+
+      def add_matcher(property1, property2, definition, options = {})
+        matchers << Matcher.new(property1, property2, definition, options)
+      end
+
+      def matchers
+        @matchers ||= []
+      end
+    end
+
+    def initialize
+      yield config
+    end
+
+    def config
+      @config ||= Config.new
+    end
+
+    def classify_hash(object1, object2)
+      config.matchers.each_with_object({}) do |matcher, result|
+        result[[matcher.property1, matcher.property2]] =
+          matcher.score_objects(object1,
+                                object2,
+                                default_threshold,
+                                default_weight)
+      end
+    end
+
+    def default_threshold
+      config.default_threshold || 0.0
+    end
+
+    def default_weight
+      config.default_weight || 1.0
+    end
+  end
+end

data/lib/record_linkage/version.rb

@@ -0,0 +1,3 @@
+module RecordLinkage
+  VERSION = '0.0.1'
+end

data/record_linkage.gemspec

@@ -0,0 +1,46 @@
+lib = File.expand_path('../lib/', __FILE__)
+$LOAD_PATH.unshift lib unless $LOAD_PATH.include?(lib)
+
+require 'record_linkage/version'
+
+Gem::Specification.new do |s|
+  s.name     = 'record_linkage'
+  s.version  = RecordLinkage::VERSION
+  s.required_ruby_version = '>= 1.9.3'
+
+  s.authors  = 'Brian Underwood'
+  s.email    = 'public@brian-underwood.codes'
+  s.homepage = 'https://github.com/cheerfulstoic/record_linkage'
+  s.summary = <<SUMMARY
+A library to do record linkage
+SUMMARY
+
+  s.license = 'MIT'
+
+  s.description = <<DESCRIPTION
+A library to do record linkage
+
+Comparing objects to determine which are the same
+DESCRIPTION
+
+  s.require_path = 'lib'
+  s.files = Dir.glob('{bin,lib,config}/**/*') +
+    %w(README.md Gemfile record_linkage.gemspec)
+  s.has_rdoc = true
+  s.extra_rdoc_files = %w( README.md )
+  s.rdoc_options = [
+    '--quiet',
+    '--title',
+    '--line-numbers',
+    '--main',
+    'README.rdoc',
+    '--inline-source']
+
+  s.add_dependency('fuzzy-string-match')
+
+  s.add_development_dependency('pry')
+  s.add_development_dependency('simplecov')
+  s.add_development_dependency('guard')
+  s.add_development_dependency('guard-rubocop')
+  s.add_development_dependency('rubocop')
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: record_linkage
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Brian Underwood
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fuzzy-string-match
+  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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |
+  A library to do record linkage
+
+  Comparing objects to determine which are the same
+email: public@brian-underwood.codes
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- Gemfile
+- README.md
+- lib/record_linkage/object_comparer.rb
+- lib/record_linkage/version.rb
+- record_linkage.gemspec
+homepage: https://github.com/cheerfulstoic/record_linkage
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--quiet"
+- "--title"
+- "--line-numbers"
+- "--main"
+- README.rdoc
+- "--inline-source"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: A library to do record linkage
+test_files: []