jaro_winkler 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a9890ac64633ae4e8b9c89c252fb13cfc6e855c1
+  data.tar.gz: c3732dec15dd6e499bf5450a9d355f5c965ba8bf
+SHA512:
+  metadata.gz: d7618f1b877df22b450d121084d0405c9c019312f4453ba2df9053383dc50e1d8621abfec4372414f9e742f660b61307c52c80ea2a5fbf810fb6594c93eac1d8
+  data.tar.gz: b31ad35c86848d86107b536cb05fc14e14ee0d3b2da44b33289e98eed3158d631cd92f00698072c03abf2bcd336674928b0354d8aca9069c1eb207696c6dc0bd

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jaro_winkler.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jian Weihang
+
+MIT License
+
+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,29 @@
+# About
+
+It's a pure Ruby implementation of [Jaro-Winkler distance](http://en.wikipedia.org/wiki/Jaro%E2%80%93Winkler_distance) algorithm.
+
+## Installation
+
+```
+gem install jaro_winkler
+```
+
+## Usage
+
+```ruby
+require 'jaro_winkler'
+JaroWinkler.jaro_winkler_distance "MARTHA", "MARHTA"
+# => 0.9611
+JaroWinkler.jaro_winkler_distance "MARTHA", "marhta", case_match: true
+# => 0.9611
+JaroWinkler.jaro_winkler_distance "MARTHA", "marhta", weight: 0.2
+# => 0.9778
+```
+
+## Options
+
+Name        | Type    | Default | Note
+----------- | ------  | ------- | ------------------------------------------------------------------------------------------------------------
+case_match  | boolean | false   | All upper case characters are converted to lower case prior to the comparison.
+weight      | number  | 0.1     | A constant scaling factor for how much the score is adjusted upwards for having common prefixes.
+threshold   | number  | 0.7     | The prefix bonus is only added when the compared strings have a Jaro distance above a this.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/jaro_winkler.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jaro_winkler/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jaro_winkler"
+  spec.version       = JaroWinkler::VERSION
+  spec.authors       = ["Jian Weihang"]
+  spec.email         = ["tonytonyjan@gmail.com"]
+  spec.summary       = %q{Pure Ruby implementation of Jaro-Winkler distance algorithm.}
+  spec.description   = %q{Pure Ruby implementation of Jaro-Winkler distance algorithm.}
+  spec.homepage      = "https://github.com/tonytonyjan/jaro_winkler"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/jaro_winkler.rb

@@ -0,0 +1,50 @@
+module JaroWinkler
+  module_function
+  def jaro_distance s1, s2
+    return 0.0 if s1.empty? || s2.empty?
+    length1, length2 = s1.length, s2.length
+    window_size      = ([length1, length2].max / 2) - 1
+    matches          = 0.0
+    transpositions   = 0
+    previous_index   = -1
+    s1.chars.each_with_index do |c1, i|
+      max_index = length2 - 1
+      left      = i - window_size
+      right     = i + window_size
+      left      = 0         if left  < 0
+      right     = max_index if right > max_index
+      matched   = false
+      found     = false
+      s2[left..right].chars.each_with_index do |c2, j|
+        if c1 == c2
+          matched  = true
+          s2_index = left + j
+          unless found
+            if s2_index > previous_index
+              previous_index = s2_index
+              found          = true
+            end
+          end
+        end
+      end
+      if matched
+        matches += 1
+        transpositions += 1 unless found
+      end
+    end
+    # Don't divide transpositions by 2 since it's been counted directly by above code.
+    matches == 0 ? 0 : 1.0 / 3.0 * (matches / length1 + matches / length2 + (matches - transpositions) / matches)
+  end
+
+  def jaro_winkler_distance s1, s2, weight: 0.1, threshold: 0.7, case_match: false
+    raise 'Scaling factor should not exceed 0.25, otherwise the distance can become larger than 1' if weight > 0.25
+    s1, s2 = s1.downcase, s2.downcase if case_match
+    distance = jaro_distance(s1, s2)
+    prefix = 0
+    max_length = [4, s1.length, s2.length].min
+    s1[0, max_length].chars.each_with_index do |c1, i|
+      c1 == s2[i] ? prefix += 1 : break
+    end
+    distance < threshold ? distance : distance + ((prefix * weight) * (1 - distance))
+  end
+end

data/lib/jaro_winkler/version.rb

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

data/spec/jaro_winkler_spec.rb

@@ -0,0 +1,24 @@
+require 'jaro_winkler'
+
+describe JaroWinkler do
+  it 'works' do
+    expect(JaroWinkler.jaro_winkler_distance("MARTHA", "MARHTA")).to  be_within(0.0001).of(0.9611)
+    expect(JaroWinkler.jaro_winkler_distance("DIXON", "DICKSONX")).to be_within(0.0001).of(0.8133)
+    expect(JaroWinkler.jaro_winkler_distance("abcvwxyz", "cabvwxyz")).to be_within(0.0001).of(0.9583)
+    expect(JaroWinkler.jaro_winkler_distance("DWAYNE", "DUANE")).to   eq 0.84
+    expect(JaroWinkler.jaro_winkler_distance("tony", "tony")).to eq 1.0
+    expect(JaroWinkler.jaro_winkler_distance("tonytonyjan", "tonytonyjan")).to eq 1.0
+    expect(JaroWinkler.jaro_winkler_distance("", "")).to eq 0.0
+    expect(JaroWinkler.jaro_winkler_distance("tony", "")).to eq 0.0
+    expect(JaroWinkler.jaro_winkler_distance("", "tony")).to eq 0.0
+  end
+
+  it 'can ignore case' do
+    expect(JaroWinkler.jaro_winkler_distance("MARTHA", "marhta", case_match: true)).to  be_within(0.0001).of(0.9611)
+  end
+
+  it 'can set weight' do
+    expect(JaroWinkler.jaro_winkler_distance("MARTHA", "MARHTA", weight: 0.2)).to  be_within(0.0001).of(0.9778)
+    expect{ JaroWinkler.jaro_winkler_distance("MARTHA", "MARHTA", weight: 0.26) }.to  raise_error
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,89 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: jaro_winkler
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jian Weihang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+description: Pure Ruby implementation of Jaro-Winkler distance algorithm.
+email:
+- tonytonyjan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- jaro_winkler.gemspec
+- lib/jaro_winkler.rb
+- lib/jaro_winkler/version.rb
+- spec/jaro_winkler_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/tonytonyjan/jaro_winkler
+licenses:
+- MIT
+metadata: {}
+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.4.1
+signing_key: 
+specification_version: 4
+summary: Pure Ruby implementation of Jaro-Winkler distance algorithm.
+test_files:
+- spec/jaro_winkler_spec.rb
+- spec/spec_helper.rb