fuzzy_string 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a09b2a05f14d665be1a6d1443ea8e8ba798e9c59
+  data.tar.gz: cb100eb7b5fa588455476e238a94df4595a14070
+SHA512:
+  metadata.gz: b129d6428e036ac065817ce60047b3d8e804cae6e5e8c23afdb4810cc43cff0427f3feebbcaa7ea089c31c08951aeda968b272dfb18af3309d206e6289f4231a
+  data.tar.gz: e88c3bc9cc796194c90e36193aeae75322b39e8e3abffdbd7b578899d75c1e997d9871083d07e38a595e1b8ec4d69361f74e7a9a8146b25b7c2209e70b8ddfb6

data/.gitignore

@@ -0,0 +1,52 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+# Ignore all test uploads
+/public/uploads/*
+# Ignore bundler config.
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-journal
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp
+.transcon.log
+
+.DS_Store
+Thumbs.db
+.*.swp
+.*.swo
+.bundle
+*~
+\#*
+.\#*
+.redcar
+*.rbc
+doc-pak
+description-pak
+/pkg/
+
+*.sassc
+.sass-cache
+capybara-*.html
+.rspec
+/public/system
+/coverage/
+/spec/tmp
+**.orig
+rerun.txt
+pickle-email-*.html
+
+## Environment normalisation:
+/vendor/bundle
+
+# these should all be checked in to normalise the environment:
+# Gemfile.lock, .ruby-version, .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,30 @@
+PATH
+  remote: .
+  specs:
+    fuzzy_string (0.0.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    awesome_print (1.6.1)
+    builder (3.2.2)
+    minitest (5.6.1)
+    minitest-reporters (1.0.14)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    rake (10.4.2)
+    ruby-progressbar (1.7.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  awesome_print
+  bundler (~> 1.7)
+  fuzzy_string!
+  minitest
+  minitest-reporters (>= 1.0.1)
+  rake (~> 10.0)

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Chris Moody
+
+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,54 @@
+# FuzzyString
+
+A ranking system for strings.  The rank by itself is arbitrary and only has context when compared to other ranks.
+The base score is the levenschtein distance which is modified by other basic matching criteria.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fuzzy_string'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fuzzy_string
+
+## Usage
+
+To use as a ranking system (the 'rank' a string has based on another):
+
+```ruby
+    $ 'test case 1'    ^ 'test case' #=>  2.5
+    $ 'test case 1'    ^ 'test'      #=>  8.75
+    $ 'tesla roadster' ^ 'test'      #=> 18.5
+```
+
+To access the levenshtein distance:
+
+```ruby
+    $ 'Test case' - 'case' #=> 5
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/fuzzy_string/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+Author
+-------
+
+* Chris Moody
+
+License
+-------
+
+This is free software released into the public domain.

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = "test/*_test.rb"
+end
+

data/fuzzy_string.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fuzzy_string/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fuzzy_string"
+  spec.version       = FuzzyString::VERSION
+  spec.authors       = ["Chris Moody"]
+  spec.email         = ["cmoody@transcon.com"]
+  spec.summary       = %q{Relative ranking system for strings.}
+  spec.description   = %q{A ranking system for strings.  The rank by itself is arbitrary and only has context
+                         when compared to other ranks.  The base score is the levenschtein distance which is
+                         modified by other basic matching criteria.}
+  spec.homepage      = "https://github.com/transcon/fuzzy_string"
+  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"
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'awesome_print'
+  spec.add_development_dependency 'minitest-reporters',  '>= 1.0.1'
+end

data/lib/fuzzy_string/adjusted_score.rb

@@ -0,0 +1,21 @@
+class FuzzyString::AdjustedScore
+  def self.rank(first,second) new(first,second).rank end
+  def initialize(first,second)
+    @first  = first
+    @second = second
+  end
+  def rank
+    return 0              if (@first == @second)
+    return @second.length if (@first.length == 0)
+    return @first.length  if (@second.length == 0)
+    adjusted_levenschtein_distance
+  end
+  def adjusted_levenschtein_distance
+    pieces = @first.split(/#{@second.chars.to_a.join('(.*?)')}/i)
+    score  = pieces[0][-1] == ' ' ? -1 : 0
+    score += cost(pieces.shift,0.5) + cost(pieces.pop,0.25) + cost(pieces.join,1)
+    score += FuzzyString::Levenshtein.distance(@first,@second)
+  end
+  private
+  def cost(piece,multiplier) piece.length * multiplier rescue(0) end
+end

data/lib/fuzzy_string/levenshtein.rb

@@ -0,0 +1,19 @@
+class FuzzyString::Levenshtein
+  def self.distance(first,second) new(first,second).distance end
+  def initialize(first,second)
+    @first = first
+    @second = second
+  end
+  def distance
+    v0 = (0..@second.length).map{|a| a}
+    @first.length.times {|i| v0 = new_row(v0,i) }
+    return v0[@second.length]
+  end
+  private
+  def new_row(old,i)
+    row = [i + 1]
+    @second.length.times {|j| row[j + 1] = [row[j] + 1, old[j + 1] + 1, old[j] + cost(old,i,j)].min}
+    return row
+  end
+  def cost(old,i,j) cost = @first[i] == @second[j] ? 0 : @first[i].downcase == @second[j].downcase ? 0.75 : 1 end
+end

data/lib/fuzzy_string/version.rb

@@ -0,0 +1,3 @@
+module FuzzyString
+  VERSION = "0.0.2"
+end

data/lib/fuzzy_string.rb

@@ -0,0 +1,9 @@
+require "fuzzy_string/version"
+require "fuzzy_string/levenshtein"
+require "fuzzy_string/adjusted_score"
+
+module FuzzyString
+  def ^(other) AdjustedScore.rank(self,other) end
+  def -(other) Levenshtein.distance(self,other) end
+end
+String.include(FuzzyString)

data/test/fuzzy_string_test.rb

@@ -0,0 +1,36 @@
+require 'minitest/autorun'
+require 'fuzzy_string'
+require 'minitest/reporters'
+Minitest::Reporters.use! Minitest::Reporters::SpecReporter.new
+
+class FuzzyStringTest < MiniTest::Unit::TestCase
+
+  def test_levenshtein_distance_calculates_known_quantities
+    assert_equal 3, 'kitten'   - 'sitting'
+    assert_equal 3, 'Saturday' - 'Sunday'
+    assert_equal 3, 'abc'      - ''
+    assert_equal 0, 'string'   - 'string'
+    assert_equal 2, 'Gumbo'    - 'Gambol'
+  end
+
+  def test_penalizes_gaps_between_string
+    assert 'ZZmonaZ'^'mona' < 'mZoZnZa'^'mona'
+  end
+
+  def test_penalizes_distance_from_beginning
+    assert 'ZmonaZ'^'mona' < 'ZZmona'^'mona'
+  end
+
+  def test_penalizes_excess_tailing_characters
+    assert 'ZZmonaZ'^'mona' < 'ZZmonaZZ' ^ 'mona'
+  end
+
+  def test_penalizes_string_not_being_the_start_of_a_word
+    assert 'ZZ mona' ^ 'mona' < 'Z Zmona' ^ 'mona'
+  end
+
+  def test_penalizes_unmatched_case
+    assert 'ZZmonaZ'^'mona' < 'ZZMonaZ'^'mona'
+  end
+
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: fuzzy_string
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Chris Moody
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-13 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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: awesome_print
+  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: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+description: |-
+  A ranking system for strings.  The rank by itself is arbitrary and only has context
+                           when compared to other ranks.  The base score is the levenschtein distance which is
+                           modified by other basic matching criteria.
+email:
+- cmoody@transcon.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- fuzzy_string.gemspec
+- lib/fuzzy_string.rb
+- lib/fuzzy_string/adjusted_score.rb
+- lib/fuzzy_string/levenshtein.rb
+- lib/fuzzy_string/version.rb
+- test/fuzzy_string_test.rb
+homepage: https://github.com/transcon/fuzzy_string
+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.3
+signing_key: 
+specification_version: 4
+summary: Relative ranking system for strings.
+test_files:
+- test/fuzzy_string_test.rb