damerau-levenshtein 0.5.1

data/Gemfile

@@ -0,0 +1,19 @@
+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 "rake-compiler"
+  gem "rspec", "~> 2.3.0"
+  gem "cucumber", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.0"
+  gem "rcov", ">= 0"
+  gem "ruby-debug19"
+  gem "ruby-prof"
+  gem "shoulda"
+  gem "mocha"
+end

data/Gemfile.lock

@@ -0,0 +1,64 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    archive-tar-minitar (0.5.2)
+    builder (3.0.0)
+    columnize (0.3.3)
+    cucumber (1.0.2)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.2)
+      gherkin (~> 2.4.5)
+      json (>= 1.4.6)
+      term-ansicolor (>= 1.0.5)
+    diff-lcs (1.1.2)
+    gherkin (2.4.5)
+      json (>= 1.4.6)
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    json (1.5.3)
+    linecache19 (0.5.12)
+      ruby_core_source (>= 0.1.4)
+    mocha (0.9.12)
+    rake (0.9.2)
+    rake-compiler (0.7.9)
+      rake
+    rcov (0.9.9)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    ruby-debug-base19 (0.11.25)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby_core_source (>= 0.1.4)
+    ruby-debug19 (0.11.6)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby-debug-base19 (>= 0.11.19)
+    ruby-prof (0.10.7)
+    ruby_core_source (0.1.5)
+      archive-tar-minitar (>= 0.5.2)
+    shoulda (2.11.3)
+    term-ansicolor (1.0.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  cucumber
+  jeweler (~> 1.6.0)
+  mocha
+  rake-compiler
+  rcov
+  rspec (~> 2.3.0)
+  ruby-debug19
+  ruby-prof
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Dmitry Mozzherin
+
+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,20 @@
+= damerau-levenshtein
+
+
+Description goes here.
+
+== Contributing to damerau-levenshtein
+ 
+* 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 Marine Biological Laboratory. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,51 @@
+# encoding: utf-8
+
+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 'rake/extensiontask'
+
+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 = "damerau-levenshtein"
+  gem.homepage = "http://github.com/dimus/damerau-levenshtein"
+  gem.license = "MIT"
+  gem.summary = %Q{Calculation of editing distance for 2 strings using Levenshtein or Damerau-Levenshtein algorithms}
+  gem.description = %Q{Calculation of editing distance for 2 strings using Levenshtein or Damerau-Levenshtein algorithms}
+  gem.email = "dmozzherin@gmail.com"
+  gem.authors = ["Dmitry Mozzherin"]
+  gem.files = FileList["[A-Z]*", "*.gemspec", "{bin,generators,lib,spec}/**/*"]
+  gem.files -= FileList['lib/**/*.bundle', 'lib/**/*.dll', 'lib/**/*.so']
+  gem.files += FileList['ext/**/*.c']
+  gem.extensions = FileList['ext/**/extconf.rb']
+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
+
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new(:features)
+
+Rake::ExtensionTask.new("damerau_levenshtein_binding") do |extension|
+    extension.lib_dir = "lib"
+end
+
+Rake::Task[:spec].prerequisites << :compile
+task :default => :spec

data/VERSION

@@ -0,0 +1 @@
+0.5.1

data/ext/damerau_levenshtein_binding/damerau_levenshtein_binding.c

@@ -0,0 +1,112 @@
+#include "ruby.h"
+
+VALUE DamerauLevenshteinBinding = Qnil;
+
+void Init_damerau_levenshtein_binding();
+
+VALUE method_distance_utf(VALUE self, VALUE _s, VALUE _t, VALUE _block_size, VALUE _max_distance);
+
+void Init_damerau_levenshtein_binding() {
+	DamerauLevenshteinBinding = rb_define_module("DamerauLevenshteinBinding");
+	rb_define_method(DamerauLevenshteinBinding, "distance_utf", method_distance_utf, 4);
+}
+
+VALUE method_distance_utf(VALUE self, VALUE _s, VALUE _t, VALUE _block_size, VALUE _max_distance){
+  int i, i1, j, j1, k, half_tl, cost, *d, distance, del, ins, subs, transp, block;
+  int sl, tl, half_sl;
+  int stop_execution = 0;
+  int min = 0;
+  int current_distance = 0;
+
+  int block_size = NUM2INT(_block_size);
+  int max_distance = NUM2INT(_max_distance);
+
+  VALUE *sv = RARRAY_PTR(_s);
+  VALUE *tv = RARRAY_PTR(_t);
+
+  sl = (int) RARRAY_LEN(_s);
+  tl = (int) RARRAY_LEN(_t);
+
+  if (sl == 0) return INT2NUM(tl);
+  if (tl == 0) return INT2NUM(sl);
+  //case of lengths 1 must present or it will break further in the code
+  if (sl == 1 && tl == 1 && sv[0] != tv[0]) return INT2NUM(1);
+
+  int s[sl];
+  int t[tl];
+
+  for (i=0; i < sl; i++) s[i] = NUM2INT(sv[i]);
+  for (i=0; i < tl; i++) t[i] = NUM2INT(tv[i]);
+
+  sl++;
+  tl++;
+
+  //one-dimentional representation of 2 dimentional array len(s)+1 * len(t)+1
+  d = malloc((sizeof(int))*(sl)*(tl));
+  //populate 'vertical' row starting from the 2nd position (first one is filled already)
+  for(i = 0; i < tl; i++){
+    d[i*sl] = i;
+  }
+
+  //fill up array with scores
+  for(i = 1; i<sl; i++){
+    d[i] = i;
+    if (stop_execution == 1) break;
+    current_distance = 10000;
+    for(j = 1; j<tl; j++){
+
+      cost = 1;
+      if(s[i-1] == t[j-1]) cost = 0;
+
+      half_sl = (sl - 1)/2;
+      half_tl = (tl - 1)/2;
+
+      block = block_size < half_sl ? block_size : half_sl;
+      block = block < half_tl ? block : half_tl;
+
+      while (block >= 1){
+        int swap1 = 1;
+        int swap2 = 1;
+        i1 = i - (block * 2);
+        j1 = j - (block * 2);
+        for (k = i1; k < i1 + block; k++) {
+          if (s[k] != t[k + block]){
+            swap1 = 0;
+            break;
+          }
+        }
+        for (k = j1; k < j1 + block; k++) {
+          if (t[k] != s[k + block]){
+            swap2 = 0;
+            break;
+          }
+        }
+
+        del = d[j*sl + i - 1] + 1;
+        ins = d[(j-1)*sl + i] + 1;
+        min = del;
+        if (ins < min) min = ins;
+        //if (i == 2 && j==2) return INT2NUM(swap2+5);
+        if (block_size > 1 && i >= block && j >= block && swap1 == 1 && swap2 == 1){
+          transp = d[(j - block * 2) * sl + i - block * 2] + cost + block -1;
+          if (transp < min) min = transp;
+          block = 0;
+        } else if (block == 1) {
+          subs = d[(j-1)*sl + i - 1] + cost;
+          if (subs < min) min = subs;
+        }
+        block--;
+      }
+      d[j*sl+i]=min;
+      if (current_distance > d[j*sl+i]) current_distance = d[j*sl+i];
+    }
+    if (current_distance > max_distance) {
+      stop_execution = 1;
+    }
+  }
+  distance=d[sl * tl - 1];
+  if (stop_execution == 1) distance = current_distance;
+
+  free(d);
+  return INT2NUM(distance);
+}

data/ext/damerau_levenshtein_binding/extconf.rb

@@ -0,0 +1,11 @@
+# Loads mkmf which is used to make makefiles for Ruby extensions
+require 'mkmf'
+
+# Give it a name
+extension_name = 'damerau_levenshtein_binding'
+
+# The destination
+dir_config(extension_name)
+
+# Do the work
+create_makefile(extension_name)

data/lib/damerau-levenshtein.rb

@@ -0,0 +1,11 @@
+# encoding: UTF-8
+
+require 'damerau_levenshtein_binding'
+
+class DamerauLevenshtein
+  include DamerauLevenshteinBinding
+
+  def distance(str1, str2, block_size = 2, max_distance = 10)
+    distance_utf(str1.unpack("U*"), str2.unpack("U*"), block_size, max_distance)
+  end
+end

data/spec/damerau-levenshtein_spec.rb

@@ -0,0 +1,15 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "DamerauLevenshtein" do
+  it 'should get tests' do
+    read_test_file(File.expand_path(File.dirname(__FILE__)) + '/damerau_levenshtein_test.txt', 5) do |y|
+      dl = DamerauLevenshtein.new
+      if y
+        res = dl.distance(y[0], y[1], y[3].to_i, y[2].to_i)
+        puts y if res != y[4].to_i
+        puts y
+        res.should == y[4].to_i
+      end
+    end
+  end
+end

data/spec/damerau_levenshtein_test.txt

@@ -0,0 +1,83 @@
+######################
+# Tests for modified Damerau Levenshtein Distance algorithm (UTF-8 compatible)
+#
+# * B. Boehmer, T. Rees, Modified Damerau-Levenshtein Distance, Boehmer & Rees 2008
+# * F.J. Damerau. A technique for computer detection and correction of spelling errors, Communications of the ACM, 1964
+#
+# Fields:
+# String1|String2|maximum distance|transposition block size|expected distance
+#  - String1, String2
+#     compared strings
+#  - maximum distance
+#     stops execution of the algorithm when calculated distance exceeds the maximum distance number
+#  - transosition block size
+#     determines how many characters can be transposed. Block size 1 returns score according to Damerau-Levenshtein algorithm
+#  - expected distance
+#     resulting distance that has to be achieved by the algorithm
+#  Note: algorithm does not try to normalize or interpret strings in any way.
+######################
+
+#it whould recognize the exact match
+Pomatomus|Pomatomus|10|1|0
+
+#it should not try to normalize incoming strings
+ Pomatomus|Pomatomus|10|1|1
+Pomatomus|pomatomus|10|1|1
+
+#it should calculate special cases
+Pomatomus||10|1|9
+|Pomatomus|10|1|9
+P|p|10|1|1
+#TODO: one letter vs longer string generates a big negative number
+#L|Linneaus|10|1|7
+
+
+#it should calculate Damerau Levenshtein distance with 1 character transpositions, insertions, deletions, substitutions (block size 1)
+# 1 substitution
+Pomatomus|Pomatomux|10|1|1
+# 1 deletion
+Pmatomus|Pomatomus|10|1|1
+# 1 deletion 
+Pomatomus|Pmatomus|10|1|1
+# 1 substitution 
+Rpmatomus|Pomatomus|10|1|2
+# 1 substitution
+Pommtomus|Pomatomus|10|1|1
+# 2 substitutions
+Potamomus|Pomatomus|10|1|2
+# 1 utf-8 substitution
+Cedarinia scabra Sjöstedt 1921|Cedarinia scabra Sjostedt 1921|10|1|1
+# transposition (Levenshtein takes it as 2 substitutions)
+Pomatomus|oPmatomus|10|1|2
+Pomatomus|oPmatomus|10|2|1
+# transposition (Levenshtein takes it as 2 substitutions)
+Pomatomus|Pomatomsu|10|1|2
+Pomatomus|Pomatomsu|10|2|1
+# transposition
+Pomtaomus|Pomatomus|10|1|2
+Pomtaomus|Pomatomus|10|2|1
+# transposition
+Pomatoums|Pomatomus|10|1|2
+Pomatoums|Pomatomus|10|2|1
+# transposition + substitution
+PoamtosusPomatomus|10|1|3
+PoamtosusPomatomus|10|2|2
+
+# transposition with utf-8 char
+Cedarinia scabra Sjöstedt 1921|Cedarinia scabra Söjstedt 1921|10|1|2
+Cedarinia scabra Sjöstedt 1921|Cedarinia scabra Söjstedt 1921|10|2|1
+
+#it should calculate Modified Damerau Levenshtein distance with 2 or more characters transposition (block size > 2)
+serrulatus|serratulus|10|2|2
+Pomatomus|Poomumats|10|3|3
+vesiculosus|vecusilosus|10|1|4
+vesiculosus|vecusilosus|10|2|2
+trimerophyton|mertriophyton|10|1|6
+trimerophyton|mertriophyton|10|3|3
+
+#it should stop trying if distance exceeds maximum allowed distance
+Pxxxxomus|Pomatomus|10|1|4
+Pxxxxomus|Pomatomus|2|1|3
+
+#
+PUNCTATA|PUNCTATA|10|1|0

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'damerau-levenshtein'
+
+# 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
+
+def read_test_file(file, fields_num)
+  f = open(file)
+  f.each do |line|
+    fields = line.split("|")
+    if line.match(/^\s*#/) == nil && fields.size == fields_num
+      fields[-1] = fields[-1].split('#')[0].strip
+      yield(fields)
+    else
+      yield(nil)
+    end
+  end
+end

metadata

@@ -0,0 +1,212 @@
+--- !ruby/object:Gem::Specification 
+name: damerau-levenshtein
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 5
+  - 1
+  version: 0.5.1
+platform: ruby
+authors: 
+- Dmitry Mozzherin
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-23 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake-compiler
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 6
+        - 0
+        version: 1.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: ruby-debug19
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: ruby-prof
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id009
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  requirement: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id010
+description: Calculation of editing distance for 2 strings using Levenshtein or Damerau-Levenshtein algorithms
+email: dmozzherin@gmail.com
+executables: []
+
+extensions: 
+- ext/damerau_levenshtein_binding/extconf.rb
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- ext/damerau_levenshtein_binding/damerau_levenshtein_binding.c
+- lib/damerau-levenshtein.rb
+- spec/damerau-levenshtein_spec.rb
+- spec/damerau_levenshtein_test.txt
+- spec/spec_helper.rb
+- ext/damerau_levenshtein_binding/extconf.rb
+has_rdoc: true
+homepage: http://github.com/dimus/damerau-levenshtein
+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: 1891520829373669839
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Calculation of editing distance for 2 strings using Levenshtein or Damerau-Levenshtein algorithms
+test_files: []
+