fuzzy_strings 1.0.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.1.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.1"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,28 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    jeweler (1.5.1)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rcov (0.9.9)
+    rspec (2.1.0)
+      rspec-core (~> 2.1.0)
+      rspec-expectations (~> 2.1.0)
+      rspec-mocks (~> 2.1.0)
+    rspec-core (2.1.0)
+    rspec-expectations (2.1.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.1)
+  rcov
+  rspec (~> 2.1.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Hartog C. de Mik
+
+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.rdoc

@@ -0,0 +1,19 @@
+= fuzzy_strings
+
+Description goes here.
+
+== Contributing to fuzzy_strings
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Hartog C. de Mik. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,50 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "fuzzy_strings"
+  gem.homepage = "http://simplic.it/tools/fuzzy_strings"
+  gem.license = "MIT"
+  gem.summary = %Q{Fuzzy String Matching POC}
+  gem.description = %Q{Fuzzy String Matching based on Cost Of Operation}
+  gem.email = "hartog.de.mik@gmail.com"
+  gem.authors = ["Hartog C. de Mik"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "fuzzy_strings #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/fuzzy_strings.rb

@@ -0,0 +1,207 @@
+# Match words based on the operations needed to get 2 similar words bt
+# insertion, deletion, substitution or transposition operations.
+#
+# cot   => coat  (a must be inserted to get the same word)
+# coat  => cot   (a must be deleted to get the same word)
+# cost  => coat  (a must be substituted with s to get the same word)
+# foo   => floor (l and r must be inserted)
+# floor => foo   (l and r must be deleted)
+# cost  => cots  (t and s must substituted (cost=2) or transpositioned (cost=1))
+#
+# the cost is the amount of operations needed to make 2 words the same
+#
+# == Usage
+#   fs = FuzzyStrings.new("pattern")
+#   match = fs.compare("pattren")
+#   puts match.match?
+#   # true
+#   puts match.score
+#   # 2
+#   puts match
+#
+# == Unicode?
+# It is assumed that all strings are utf-8
+#
+class FuzzyStrings
+  def initialize(string1)
+    @string1 = string1.to_s rescue ""
+  end
+
+  # compare a given string to the base pattern, the compared strings is
+  # operated upon (soo cot as the pattern and coat in compare leads to deletion)
+  #
+  # returns a FuzzyStrings::Match object
+  #
+  def compare(string2, no_transpositions = false)
+    @string2 = string2.to_s rescue ""
+    @match   = Match.new
+
+    return @match if @string1 == @string2
+
+    rule = 'U*'
+
+    sequence1 = @string1.unpack rule
+    sequence2 = @string2.unpack rule
+
+    if (sequence1 + sequence2).include?(0)
+      raise ArgumentError.new(
+        "Strings cannot contain NULL-bytes due to internal semantics"
+      )
+    end
+
+    @short, @long = if sequence1.length < sequence2.length
+      [sequence1, sequence2]
+    else
+      [sequence2, sequence1]
+    end
+
+    find_insertions
+    find_substitutions
+    find_transpositions unless no_transpositions == true
+
+    return @match
+  end
+
+  # find insertions  (if string2 is shorter we are finding deletions)
+  #
+  # place null-bytes on the insert positions
+  def find_insertions
+    # when both are equal in length no insertions can happen
+    return if @short.length == @long.length
+
+    mode = @short.pack('U*') == @string2 ? :insertions : :deletions
+
+    ## # don't destroy the object short'
+    ## short = @short
+
+    @long.each_with_index do |long_chr, i|
+      short_chr = @short[i]
+      if long_chr != short_chr
+        next if @long[i+1].nil? or @long[i+1] != short_chr
+
+        # there is an insertion
+     	  @short = @short[0,i] + [ 0 ] + @short[i, @short.length-1]
+        @match.send(:"#{mode}=", @match.send(mode) + 1)
+      end
+    end
+
+    # pad the short with 0 until equal in length (these are not insertions)
+    while @long.length > @short.length
+      @short << 0
+      @match.send(:"#{mode}=", @match.send(mode) + 1)
+    end
+  end
+
+  # compare characters, dont compare if 1 character is a null byte
+  def find_substitutions
+    @short.each_with_index do |char1, i|  # .select { |c| c != 0 }
+      char2 = @long[i]
+      next if [ char1, char2 ].include? 0
+      @match.substitutions += 1 if char1 != char2
+    end
+  end
+
+  # compare characters by 2 and find transposed characters
+  # (when given cost, cots, ts is transposed)
+  #
+  def find_transpositions
+    short = @short.select { |c| c != 0 }
+    short.each_index do |i|
+      break if i == (short.length - 1)
+
+      one = short[i..i+1]
+      two = @long[i..i+1]
+      next if one == two
+
+      @match.transpositions += 1 if (one & two).length == 2
+    end
+  end
+
+  private :find_transpositions, :find_substitutions, :find_insertions
+
+  # A Match object holds all the costs of operations for a comparison and can
+  # define a match for you
+  #
+  class Match
+    attr_accessor :insertions, :deletions, :substitutions, :transpositions
+
+    def initialize
+      @insertions     = 0
+      @deletions      = 0
+      @substitutions  = 0
+      @transpositions = 0
+    end
+
+    # Is it a match?
+    #
+    # By default checks if the cost of all the operations is no greater then 3
+    #
+    # == Options
+    # [:score]          * Total cost of operations is no greater then X.
+    #                   * If specified, doesn't check any other criterium
+    # [:max]            * All of the operations must be no greater then X. So
+    #                     the score may be 3, but there cant be 2 deletions if
+    #                     X = 1.
+    #                   * If specified, checks no other criterium.
+    #                   * It checks substitutions OR transpositions
+    # [:deletions]      * The amount of deletions is no greater then X
+    # [:insertions]     * The amount of insertions is no greater then X
+    # [:substitutions]  * The amount of substitutions is no greater then X
+    #
+    def match?(opts = { :score => 3 })
+      if opts[:score]
+        # combined operations
+        self.score <= opts[:score]
+
+      elsif opts[:max]
+        !(self.deletions > opts[:max]) and !(self.insertions > opts[:max]) \
+          and !(self.substitutions > opts[:max]) \
+          and !(self.transpositions > opts[:max])
+
+      else
+        plausable = true
+
+        if opts[:deletions]
+          plausable &= self.deletions <= opts[:deletions]
+        end
+        if opts[:insertions]
+          plausable &= self.insertions <= opts[:insertions]
+        end
+        if opts[:substitutions]
+          plausable &= self.substitutions <= opts[:substitutions]
+        end
+        if opts[:transpositions]
+          plausable &= self.transpositions <= opts[:transpositions]
+        end
+
+        plausable
+      end
+    end
+
+    # the total cost of the operations
+    #
+    # Normaly uses substitutions (which is more expensive).
+    #
+    # Specify use_transpositions as true to get transposition cost instead of
+    # substitutions cost
+    #
+    def score(use_transpositions=false)
+      (use_transpositions ? transpositions : substitutions) + insertions + deletions
+    end
+    alias_method :cost, :score
+
+    def to_s # :nodoc:
+      "{ d: #{@deletions}, i: #{@insertions}, s: #{@substitutions}, t: #{@transpositions} }"
+    end
+  end
+
+  private :find_insertions, :find_substitutions
+end
+
+# extend String
+class String
+  def fuzzy_match(other)
+    fs = FuzzyStrings.new(self)
+    fs.compare other
+  end
+end

data/spec/fuzzy_strings_spec.rb

@@ -0,0 +1,80 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "FuzzyStrings" do
+  before(:all) do
+    @fs = FuzzyStrings.new("pattern")
+  end
+
+  it "matches equal strings with 0 costs" do
+    match = @fs.compare("pattern")
+    match.cost.should == 0
+  end
+
+  it "matches 1 transposition and 2 substitutions on 'pattren'" do
+    match = @fs.compare("pattren")
+    match.substitutions.should == 2
+    match.transpositions.should == 1
+    match.insertions.should == 0
+    match.deletions.should == 0
+  end
+
+  it "matches 2 deletions on 'patterned'" do
+    match = @fs.compare("patterned")
+    match.substitutions.should == 0
+    match.transpositions.should == 0
+    match.insertions.should == 0
+    match.deletions.should == 2
+  end
+
+  it "matches 1 insertions on 'patten'" do
+    match = @fs.compare("patten")
+    match.substitutions.should == 0
+    match.transpositions.should == 0
+    match.insertions.should == 1
+    match.deletions.should == 0
+  end
+
+  # 1 del, 1 sub
+  it "matches on 'patterer' with a max of 2" do
+    match = @fs.compare('patterer')
+    match.match?(:max => 2).should == true
+    match.match?(:max => 0).should == false
+  end
+
+  # 4 del
+  it "does not match 'patternless' with a max of 3" do
+    match = @fs.compare("patternless")
+    match.match?(:max => 3).should == false
+  end
+
+  # 1 del, 5 subst
+  it "does not match 'pappadums' with a max of 2" do
+    match = @fs.compare("papadums")
+    match.match?(:max => 2).should == false
+  end
+
+  # :-)
+  it "does go well with the chicken!" do
+    match = @fs.compare("chicken")
+    match.match?.should == false
+  end
+
+  it "does extended matching 1" do
+    match = @fs.compare('papadums')
+    match.match?(:deletions => 1, :substitutions => 5).should == true
+    match.match?(:deletions => 0).should == false
+  end
+
+  it "does extended matching 2" do
+    match = @fs.compare('ptatenr')
+    match.match?(:substitutions => 4, :transpositions => 1).should == false
+    match.match?(:substitutions => 2, :transpositions => 2).should == false
+    match.match?(:substitutions => 4, :transpositions => 2).should == true
+  end
+
+  it "does extended matching 2" do
+    match = @fs.compare('patat')
+    match.match?(:insertions => 2, :substitutions => 2).should == true
+    match.match?(:insertions => 1).should == false
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'fuzzy_strings'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification 
+name: fuzzy_strings
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Hartog C. de Mik
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-04 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 2
+        - 1
+        - 0
+        version: 2.1.0
+  requirement: *id001
+  prerelease: false
+  type: :development
+  name: rspec
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id002
+  prerelease: false
+  type: :development
+  name: bundler
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 1
+        - 5
+        - 1
+        version: 1.5.1
+  requirement: *id003
+  prerelease: false
+  type: :development
+  name: jeweler
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id004
+  prerelease: false
+  type: :development
+  name: rcov
+description: Fuzzy String Matching based on Cost Of Operation
+email: hartog.de.mik@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/fuzzy_strings.rb
+- spec/fuzzy_strings_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://simplic.it/tools/fuzzy_strings
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Fuzzy String Matching POC
+test_files: 
+- spec/fuzzy_strings_spec.rb
+- spec/spec_helper.rb