fuzzy_match 1.3.1 → 1.3.2

data/Gemfile

@@ -1,4 +1,14 @@
-source "http://rubygems.org"
+source :rubygems
 
-# Specify your gem's dependencies in fuzzy_match.gemspec
 gemspec
+
+# development dependencies
+gem 'minitest-reporters'
+gem "minitest"
+gem 'activerecord', '>=3'
+gem 'mysql2'
+gem 'cohort_scope'
+gem 'weighted_average'
+gem 'rake'
+gem 'yard'
+gem 'amatch'

data/History.txt

@@ -0,0 +1,13 @@
+== 1.3.2 / 2012-02-24
+
+* Start keeping a changelog!
+
+* Enhancements
+
+  * renamed blockings to groupings
+  * cleaned up tests
+
+* Bug fixes
+
+  * better handling for one-letter similiarities like 'X foo' vs 'X bar' which couldn't be detected by pair distance
+  * take deprecated option :tighteners as :normalizers

data/README.markdown

@@ -32,20 +32,22 @@ You can improve the default matchings with rules. There are 4 different kinds of
 
 We suggest that you **first try without any rules** and only define them to improve matching, prevent false positives, etc.
 
-    >> matcher = FuzzyMatch.new(['Ford F-150', 'Ford F-250', 'GMC 1500', 'GMC 2500'], :blockings => [ /ford/i, /gmc/i ], :normalizers => [ /K(\d500)/i ], :identities => [ /(f)-?(\d50)/i ])
+    >> matcher = FuzzyMatch.new(['Ford F-150', 'Ford F-250', 'GMC 1500', 'GMC 2500'], :groupings => [ /ford/i, /gmc/i ], :normalizers => [ /K(\d500)/i ], :identities => [ /(f)-?(\d50)/i ])
     => #<FuzzyMatch: [...]> 
     >> matcher.find('fordf250')
     => "Ford F-250" 
     >> matcher.find('gmc truck k1500')
     => "GMC 1500" 
 
-For identities and normalizers (see below), **only the captures are used.** For example, `/(f)-?(\d50)/i` captures the "F" and the "250" but ignores the dash. So place your parentheses carefully! Blockings work the same way, except that if you don't have any captures, a simple match will pass.
+For identities and normalizers (see below), **only the captures are used.** For example, `/(f)-?(\d50)/i` captures the "F" and the "250" but ignores the dash. So place your parentheses carefully! Groupings work the same way, except that if you don't have any captures, a simple match will pass.
 
-### Blockings
+### Groupings
 
 Group records together.
 
-Setting a blocking of `/Airbus/` ensures that strings containing "Airbus" will only be scored against to other strings containing "Airbus". A better blocking in this case would probably be `/airbus/i`.
+Setting a grouping of `/Airbus/` ensures that strings containing "Airbus" will only be scored against to other strings containing "Airbus". A better grouping in this case would probably be `/airbus/i`.
+
+Formerly called "blockings," but that was jargon that confused people.
 
 ### Identities
 
@@ -53,6 +55,8 @@ Prevent impossible matches.
 
 Adding an identity like `/(f)-?(\d50)/i` ensures that "Ford F-150" and "Ford F-250" never match.
 
+Note that identities do not establish certainty. They just say whether two records **could** be identical... then string similarity takes over.
+
 ### Stop words
 
 Ignore common and/or meaningless words. Applied before normalizers.
@@ -68,9 +72,9 @@ Adding a normalizer like `/(boeing).*(7\d\d)/i` will cause "BOEING COMPANY 747"
 ## Find options
 
 * `read`: how to interpret each record in the 'haystack', either a Proc or a symbol
-* `must_match_blocking`: don't return a match unless the needle fits into one of the blockings you specified
+* `must_match_grouping`: don't return a match unless the needle fits into one of the groupings you specified
 * `must_match_at_least_one_word`: don't return a match unless the needle shares at least one word with the match. Note that "Foo's" is treated like one word (so that it won't match "'s") and "Bolivia," is treated as just "bolivia"
-* `first_blocking_decides`: force records into the first blocking they match, rather than choosing a blocking that will give them a higher score
+* `first_grouping_decides`: force records into the first grouping they match, rather than choosing a grouping that will give them a higher score
 * `gather_last_result`: enable `last_result`
 
 ## Case sensitivity

data/benchmark/before-with-free.txt

@@ -22,7 +22,7 @@
      28 ./benchmark/../lib/fuzzy_match/extract_regexp.rb:19:__node__
      22 ./benchmark/../lib/fuzzy_match/similarity.rb:57:__node__
      22 ./benchmark/../lib/fuzzy_match/extract_regexp.rb:20:__node__
-     21 ./benchmark/../lib/fuzzy_match.rb:199:FuzzyMatch::Blocking
+     21 ./benchmark/../lib/fuzzy_match.rb:199:FuzzyMatch::Grouping
      17 ./benchmark/../lib/fuzzy_match/similarity.rb:21:__node__
      16 /Users/seamus/.rvm/gems/ruby-1.8.7-p334/gems/amatch-0.2.5/lib/amatch.bundle:0:Class
      14 /Users/seamus/.rvm/gems/ruby-1.8.7-p334/gems/amatch-0.2.5/lib/amatch/version.rb:4:__node__
@@ -50,7 +50,7 @@
       8 ./benchmark/../lib/fuzzy_match/similarity.rb:38:__node__
       8 ./benchmark/../lib/fuzzy_match/score.rb:13:__node__
       8 ./benchmark/../lib/fuzzy_match/extract_regexp.rb:23:__node__
-      8 ./benchmark/../lib/fuzzy_match/blocking.rb:24:__node__
+      8 ./benchmark/../lib/fuzzy_match/grouping.rb:24:__node__
       7 /Users/seamus/.rvm/gems/ruby-1.8.7-p334/gems/amatch-0.2.5/lib/amatch/version.rb:7:__node__
       7 /Users/seamus/.rvm/gems/ruby-1.8.7-p334/gems/amatch-0.2.5/lib/amatch/version.rb:6:__node__
       7 /Users/seamus/.rvm/gems/ruby-1.8.7-p334/gems/amatch-0.2.5/lib/amatch/version.rb:5:__node__
@@ -59,7 +59,7 @@
       7 ./benchmark/../lib/fuzzy_match/similarity.rb:45:__node__
       7 ./benchmark/../lib/fuzzy_match/score.rb:17:__node__
       7 ./benchmark/../lib/fuzzy_match/identity.rb:19:__node__
-      7 ./benchmark/../lib/fuzzy_match/blocking.rb:27:__node__
+      7 ./benchmark/../lib/fuzzy_match/grouping.rb:27:__node__
       7 ./benchmark/../lib/fuzzy_match.rb:209:String
       6 ./benchmark/../lib/fuzzy_match/wrapper.rb:8:__node__
       6 ./benchmark/../lib/fuzzy_match/similarity.rb:44:__node__
@@ -68,7 +68,7 @@
       6 ./benchmark/../lib/fuzzy_match/score.rb:25:__node__
       6 ./benchmark/../lib/fuzzy_match/score.rb:21:__node__
       6 ./benchmark/../lib/fuzzy_match/extract_regexp.rb:10:__node__
-      6 ./benchmark/../lib/fuzzy_match/blocking.rb:22:__node__
+      6 ./benchmark/../lib/fuzzy_match/grouping.rb:22:__node__
       5 /Users/seamus/.rvm/gems/ruby-1.8.7-p334/gems/fastercsv-1.5.4/lib/faster_csv.rb:1640:String
       5 ./benchmark/../lib/fuzzy_match/wrapper.rb:34:__node__
       5 ./benchmark/../lib/fuzzy_match/normalizer.rb:9:__node__
@@ -80,9 +80,9 @@
       5 ./benchmark/../lib/fuzzy_match/score.rb:9:__node__
       5 ./benchmark/../lib/fuzzy_match/result.rb:16:__node__
       5 ./benchmark/../lib/fuzzy_match/identity.rb:10:__node__
-      5 ./benchmark/../lib/fuzzy_match/blocking.rb:26:__node__
-      5 ./benchmark/../lib/fuzzy_match/blocking.rb:25:__node__
-      5 ./benchmark/../lib/fuzzy_match/blocking.rb:15:__node__
+      5 ./benchmark/../lib/fuzzy_match/grouping.rb:26:__node__
+      5 ./benchmark/../lib/fuzzy_match/grouping.rb:25:__node__
+      5 ./benchmark/../lib/fuzzy_match/grouping.rb:15:__node__
       4 ./benchmark/../lib/fuzzy_match/wrapper.rb:33:__node__
       4 ./benchmark/../lib/fuzzy_match/wrapper.rb:30:__node__
       4 ./benchmark/../lib/fuzzy_match/normalizer.rb:20:__node__
@@ -142,8 +142,8 @@
       3 ./benchmark/../lib/fuzzy_match/extract_regexp.rb:18:__node__
       3 ./benchmark/../lib/fuzzy_match/extract_regexp.rb:16:String
       3 ./benchmark/../lib/fuzzy_match/extract_regexp.rb:15:String
-      3 ./benchmark/../lib/fuzzy_match/blocking.rb:33:__node__
-      3 ./benchmark/../lib/fuzzy_match/blocking.rb:14:__node__
+      3 ./benchmark/../lib/fuzzy_match/grouping.rb:33:__node__
+      3 ./benchmark/../lib/fuzzy_match/grouping.rb:14:__node__
       3 ./benchmark/../lib/fuzzy_match.rb:77:Array
       2 /Users/seamus/.rvm/rubies/ruby-1.8.7-p334/lib/ruby/1.8/uri/common.rb:387:String
       2 /Users/seamus/.rvm/gems/ruby-1.8.7-p334/gems/amatch-0.2.5/lib/amatch/version.rb:3:String
@@ -200,14 +200,14 @@
       2 ./benchmark/../lib/fuzzy_match/extract_regexp.rb:5:__node__
       2 ./benchmark/../lib/fuzzy_match/extract_regexp.rb:23:String
       2 ./benchmark/../lib/fuzzy_match/extract_regexp.rb:12:__node__
-      2 ./benchmark/../lib/fuzzy_match/blocking.rb:9:Class
-      2 ./benchmark/../lib/fuzzy_match/blocking.rb:34:__node__
-      2 ./benchmark/../lib/fuzzy_match/blocking.rb:32:__node__
-      2 ./benchmark/../lib/fuzzy_match/blocking.rb:30:__node__
-      2 ./benchmark/../lib/fuzzy_match/blocking.rb:29:__node__
-      2 ./benchmark/../lib/fuzzy_match/blocking.rb:23:__node__
-      2 ./benchmark/../lib/fuzzy_match/blocking.rb:16:__node__
-      2 ./benchmark/../lib/fuzzy_match/blocking.rb:12:__node__
+      2 ./benchmark/../lib/fuzzy_match/grouping.rb:9:Class
+      2 ./benchmark/../lib/fuzzy_match/grouping.rb:34:__node__
+      2 ./benchmark/../lib/fuzzy_match/grouping.rb:32:__node__
+      2 ./benchmark/../lib/fuzzy_match/grouping.rb:30:__node__
+      2 ./benchmark/../lib/fuzzy_match/grouping.rb:29:__node__
+      2 ./benchmark/../lib/fuzzy_match/grouping.rb:23:__node__
+      2 ./benchmark/../lib/fuzzy_match/grouping.rb:16:__node__
+      2 ./benchmark/../lib/fuzzy_match/grouping.rb:12:__node__
       2 ./benchmark/../lib/fuzzy_match.rb:86:Array
       1 benchmark/memory.rb:50:String
       1 benchmark/memory.rb:49:FuzzyMatch
@@ -265,10 +265,10 @@
       1 ./benchmark/../lib/fuzzy_match/extract_regexp.rb:1:__node__
       1 ./benchmark/../lib/fuzzy_match/extract_regexp.rb:17:Hash
       1 ./benchmark/../lib/fuzzy_match/extract_regexp.rb:10:String
-      1 ./benchmark/../lib/fuzzy_match/blocking.rb:9:__node__
-      1 ./benchmark/../lib/fuzzy_match/blocking.rb:9:String
-      1 ./benchmark/../lib/fuzzy_match/blocking.rb:1:__node__
-      1 ./benchmark/../lib/fuzzy_match/blocking.rb:10:FuzzyMatch::ExtractRegexp
+      1 ./benchmark/../lib/fuzzy_match/grouping.rb:9:__node__
+      1 ./benchmark/../lib/fuzzy_match/grouping.rb:9:String
+      1 ./benchmark/../lib/fuzzy_match/grouping.rb:1:__node__
+      1 ./benchmark/../lib/fuzzy_match/grouping.rb:10:FuzzyMatch::ExtractRegexp
       1 ./benchmark/../lib/fuzzy_match.rb:62:FuzzyMatch::Wrapper
       1 ./benchmark/../lib/fuzzy_match.rb:39:String
       1 ./benchmark/../lib/fuzzy_match.rb:39:FuzzyMatch::Result

data/benchmark/before.txt

@@ -46,7 +46,7 @@
      26 ./benchmark/../lib/fuzzy_match.rb:187:FuzzyMatch::Normalizer
      22 ./benchmark/../lib/fuzzy_match/similarity.rb:57:__node__
      22 ./benchmark/../lib/fuzzy_match/extract_regexp.rb:20:__node__
-     21 ./benchmark/../lib/fuzzy_match.rb:199:FuzzyMatch::Blocking
+     21 ./benchmark/../lib/fuzzy_match.rb:199:FuzzyMatch::Grouping
      17 ./benchmark/../lib/fuzzy_match/similarity.rb:21:__node__
      16 /Users/seamus/.rvm/gems/ruby-1.8.7-p334/gems/amatch-0.2.5/lib/amatch.bundle:0:Class
      14 /Users/seamus/.rvm/gems/ruby-1.8.7-p334/gems/amatch-0.2.5/lib/amatch/version.rb:4:__node__
@@ -72,7 +72,7 @@
       8 ./benchmark/../lib/fuzzy_match/similarity.rb:38:__node__
       8 ./benchmark/../lib/fuzzy_match/score.rb:13:__node__
       8 ./benchmark/../lib/fuzzy_match/extract_regexp.rb:23:__node__
-      8 ./benchmark/../lib/fuzzy_match/blocking.rb:24:__node__
+      8 ./benchmark/../lib/fuzzy_match/grouping.rb:24:__node__
       7 /Users/seamus/.rvm/gems/ruby-1.8.7-p334/gems/amatch-0.2.5/lib/amatch/version.rb:7:__node__
       7 /Users/seamus/.rvm/gems/ruby-1.8.7-p334/gems/amatch-0.2.5/lib/amatch/version.rb:6:__node__
       7 /Users/seamus/.rvm/gems/ruby-1.8.7-p334/gems/amatch-0.2.5/lib/amatch/version.rb:5:__node__
@@ -81,7 +81,7 @@
       7 ./benchmark/../lib/fuzzy_match/similarity.rb:45:__node__
       7 ./benchmark/../lib/fuzzy_match/score.rb:17:__node__
       7 ./benchmark/../lib/fuzzy_match/identity.rb:19:__node__
-      7 ./benchmark/../lib/fuzzy_match/blocking.rb:27:__node__
+      7 ./benchmark/../lib/fuzzy_match/grouping.rb:27:__node__
       6 ./benchmark/../lib/fuzzy_match/wrapper.rb:8:__node__
       6 ./benchmark/../lib/fuzzy_match/similarity.rb:44:__node__
       6 ./benchmark/../lib/fuzzy_match/similarity.rb:15:__node__
@@ -89,7 +89,7 @@
       6 ./benchmark/../lib/fuzzy_match/score.rb:25:__node__
       6 ./benchmark/../lib/fuzzy_match/score.rb:21:__node__
       6 ./benchmark/../lib/fuzzy_match/extract_regexp.rb:10:__node__
-      6 ./benchmark/../lib/fuzzy_match/blocking.rb:22:__node__
+      6 ./benchmark/../lib/fuzzy_match/grouping.rb:22:__node__
       5 /Users/seamus/.rvm/gems/ruby-1.8.7-p334/gems/fastercsv-1.5.4/lib/faster_csv.rb:1640:String
       5 ./benchmark/../lib/fuzzy_match/wrapper.rb:34:__node__
       5 ./benchmark/../lib/fuzzy_match/normalizer.rb:9:__node__
@@ -101,9 +101,9 @@
       5 ./benchmark/../lib/fuzzy_match/score.rb:9:__node__
       5 ./benchmark/../lib/fuzzy_match/result.rb:16:__node__
       5 ./benchmark/../lib/fuzzy_match/identity.rb:10:__node__
-      5 ./benchmark/../lib/fuzzy_match/blocking.rb:26:__node__
-      5 ./benchmark/../lib/fuzzy_match/blocking.rb:25:__node__
-      5 ./benchmark/../lib/fuzzy_match/blocking.rb:15:__node__
+      5 ./benchmark/../lib/fuzzy_match/grouping.rb:26:__node__
+      5 ./benchmark/../lib/fuzzy_match/grouping.rb:25:__node__
+      5 ./benchmark/../lib/fuzzy_match/grouping.rb:15:__node__
       4 ./benchmark/../lib/fuzzy_match/wrapper.rb:33:__node__
       4 ./benchmark/../lib/fuzzy_match/wrapper.rb:30:__node__
       4 ./benchmark/../lib/fuzzy_match/normalizer.rb:20:__node__
@@ -163,8 +163,8 @@
       3 ./benchmark/../lib/fuzzy_match/extract_regexp.rb:18:__node__
       3 ./benchmark/../lib/fuzzy_match/extract_regexp.rb:16:String
       3 ./benchmark/../lib/fuzzy_match/extract_regexp.rb:15:String
-      3 ./benchmark/../lib/fuzzy_match/blocking.rb:33:__node__
-      3 ./benchmark/../lib/fuzzy_match/blocking.rb:14:__node__
+      3 ./benchmark/../lib/fuzzy_match/grouping.rb:33:__node__
+      3 ./benchmark/../lib/fuzzy_match/grouping.rb:14:__node__
       3 ./benchmark/../lib/fuzzy_match.rb:86:Array
       3 ./benchmark/../lib/fuzzy_match.rb:77:Array
       2 /Users/seamus/.rvm/rubies/ruby-1.8.7-p334/lib/ruby/1.8/uri/common.rb:387:String
@@ -222,14 +222,14 @@
       2 ./benchmark/../lib/fuzzy_match/extract_regexp.rb:5:__node__
       2 ./benchmark/../lib/fuzzy_match/extract_regexp.rb:23:String
       2 ./benchmark/../lib/fuzzy_match/extract_regexp.rb:12:__node__
-      2 ./benchmark/../lib/fuzzy_match/blocking.rb:9:Class
-      2 ./benchmark/../lib/fuzzy_match/blocking.rb:34:__node__
-      2 ./benchmark/../lib/fuzzy_match/blocking.rb:32:__node__
-      2 ./benchmark/../lib/fuzzy_match/blocking.rb:30:__node__
-      2 ./benchmark/../lib/fuzzy_match/blocking.rb:29:__node__
-      2 ./benchmark/../lib/fuzzy_match/blocking.rb:23:__node__
-      2 ./benchmark/../lib/fuzzy_match/blocking.rb:16:__node__
-      2 ./benchmark/../lib/fuzzy_match/blocking.rb:12:__node__
+      2 ./benchmark/../lib/fuzzy_match/grouping.rb:9:Class
+      2 ./benchmark/../lib/fuzzy_match/grouping.rb:34:__node__
+      2 ./benchmark/../lib/fuzzy_match/grouping.rb:32:__node__
+      2 ./benchmark/../lib/fuzzy_match/grouping.rb:30:__node__
+      2 ./benchmark/../lib/fuzzy_match/grouping.rb:29:__node__
+      2 ./benchmark/../lib/fuzzy_match/grouping.rb:23:__node__
+      2 ./benchmark/../lib/fuzzy_match/grouping.rb:16:__node__
+      2 ./benchmark/../lib/fuzzy_match/grouping.rb:12:__node__
       2 ./benchmark/../lib/fuzzy_match.rb:101:Array
       1 benchmark/memory.rb:50:__scope__
       1 benchmark/memory.rb:50:String
@@ -287,10 +287,10 @@
       1 ./benchmark/../lib/fuzzy_match/extract_regexp.rb:1:__node__
       1 ./benchmark/../lib/fuzzy_match/extract_regexp.rb:17:Hash
       1 ./benchmark/../lib/fuzzy_match/extract_regexp.rb:10:String
-      1 ./benchmark/../lib/fuzzy_match/blocking.rb:9:__node__
-      1 ./benchmark/../lib/fuzzy_match/blocking.rb:9:String
-      1 ./benchmark/../lib/fuzzy_match/blocking.rb:1:__node__
-      1 ./benchmark/../lib/fuzzy_match/blocking.rb:10:FuzzyMatch::ExtractRegexp
+      1 ./benchmark/../lib/fuzzy_match/grouping.rb:9:__node__
+      1 ./benchmark/../lib/fuzzy_match/grouping.rb:9:String
+      1 ./benchmark/../lib/fuzzy_match/grouping.rb:1:__node__
+      1 ./benchmark/../lib/fuzzy_match/grouping.rb:10:FuzzyMatch::ExtractRegexp
       1 ./benchmark/../lib/fuzzy_match.rb:62:FuzzyMatch::Wrapper
       1 ./benchmark/../lib/fuzzy_match.rb:39:String
       1 ./benchmark/../lib/fuzzy_match.rb:39:FuzzyMatch::Result

data/benchmark/memory.rb

@@ -20,13 +20,13 @@ HAYSTACK = RemoteTable.new :url => "file://#{File.expand_path('../../examples/bt
 # Note the downcase!
 HAYSTACK_READER = lambda { |record| "#{record['Manufacturer']} #{record['Long Name']}".downcase }
 
-# Whether to even bother trying to find a match for something without an explicit block
+# Whether to even bother trying to find a match for something without an explicit group
 # (Example) False, which is the default, which means we have more work to do
-MUST_MATCH_BLOCKING = false
+MUST_MATCH_GROUPING = false
 
-# Blockings
+# Groupings
 # (Example) We made these by trial and error
-BLOCKINGS = RemoteTable.new(:url => "file://#{File.expand_path("../../examples/bts_aircraft/blockings.csv", __FILE__)}", :headers => :first_row).map { |row| row['regexp'] }
+GROUPINGS = RemoteTable.new(:url => "file://#{File.expand_path("../../examples/bts_aircraft/groupings.csv", __FILE__)}", :headers => :first_row).map { |row| row['regexp'] }
 
 # Normalizers
 # (Example) We made these by trial and error
@@ -38,10 +38,10 @@ IDENTITIES = RemoteTable.new(:url => "file://#{File.expand_path("../../examples/
 
 FINAL_OPTIONS = {
   :read => HAYSTACK_READER,
-  :must_match_blocking => MUST_MATCH_BLOCKING,
+  :must_match_grouping => MUST_MATCH_GROUPING,
   :normalizers => NORMALIZERS,
   :identities => IDENTITIES,
-  :blockings => BLOCKINGS
+  :groupings => GROUPINGS
 }
 
 Memprof.start

data/examples/bts_aircraft/test_bts_aircraft.rb

@@ -16,13 +16,13 @@ HAYSTACK = RemoteTable.new :url => "file://#{File.expand_path('../number_260.csv
 # Note the downcase!
 HAYSTACK_READER = lambda { |record| "#{record['Manufacturer']} #{record['Long Name']}".downcase }
 
-# Whether to even bother trying to find a match for something without an explicit block
+# Whether to even bother trying to find a match for something without an explicit group
 # (Example) False, which is the default, which means we have more work to do
-MUST_MATCH_BLOCKING = false
+MUST_MATCH_GROUPING = false
 
-# Blockings
+# Groupings
 # (Example) We made these by trial and error
-BLOCKINGS = RemoteTable.new(:url => "file://#{File.expand_path("../blockings.csv", __FILE__)}", :headers => :first_row).map { |row| row['regexp'] }
+GROUPINGS = RemoteTable.new(:url => "file://#{File.expand_path("../groupings.csv", __FILE__)}", :headers => :first_row).map { |row| row['regexp'] }
 
 # Normalizers
 # (Example) We made these by trial and error
@@ -62,10 +62,10 @@ NEGATIVES = RemoteTable.new :url => "file://#{File.expand_path("../negatives.csv
 
 FINAL_OPTIONS = {
   :read => HAYSTACK_READER,
-  :must_match_blocking => MUST_MATCH_BLOCKING,
+  :must_match_grouping => MUST_MATCH_GROUPING,
   :normalizers => NORMALIZERS,
   :identities => IDENTITIES,
-  :blockings => BLOCKINGS
+  :groupings => GROUPINGS
 }
 
 class TestBtsAircraft < MiniTest::Spec

data/fuzzy_match.gemspec

@@ -15,19 +15,10 @@ Gem::Specification.new do |s|
   s.rubyforge_project = "fuzzy_match"
 
   s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,ffuzzy_matchures}/*`.split("\n")
+  s.test_files    = `git ls-files -- test/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_development_dependency "minitest"
-  s.add_development_dependency 'activerecord', '>=3'
-  s.add_development_dependency 'mysql2'
-  s.add_development_dependency 'cohort_scope'
-  s.add_development_dependency 'weighted_average'
-  s.add_development_dependency 'rake'
-  s.add_development_dependency 'yard'
-  s.add_development_dependency 'amatch'
-
   s.add_runtime_dependency 'activesupport', '>=3'
   s.add_runtime_dependency 'to_regexp', '>=0.0.3'
 end

data/lib/fuzzy_match.rb

@@ -5,10 +5,11 @@ if ::ActiveSupport::VERSION::MAJOR >= 3
 end
 require 'to_regexp'
 
-require 'fuzzy_match/normalizer'
-require 'fuzzy_match/stop_word'
-require 'fuzzy_match/blocking'
-require 'fuzzy_match/identity'
+require 'fuzzy_match/rule'
+require 'fuzzy_match/rule/normalizer'
+require 'fuzzy_match/rule/stop_word'
+require 'fuzzy_match/rule/grouping'
+require 'fuzzy_match/rule/identity'
 require 'fuzzy_match/result'
 require 'fuzzy_match/wrapper'
 require 'fuzzy_match/similarity'
@@ -44,15 +45,15 @@ class FuzzyMatch
   DEFAULT_ENGINE = :pure_ruby
   
   DEFAULT_OPTIONS = {
-    :first_blocking_decides => false,
-    :must_match_blocking => false,
+    :first_grouping_decides => false,
+    :must_match_grouping => false,
     :must_match_at_least_one_word => false,
     :gather_last_result => false,
     :find_all => false
   }
   
   attr_reader :haystack
-  attr_reader :blockings
+  attr_reader :groupings
   attr_reader :identities
   attr_reader :normalizers
   attr_reader :stop_words
@@ -64,46 +65,52 @@ class FuzzyMatch
   # Rules (can only be specified at initialization or by using a setter)
   # * :<tt>normalizers</tt> - regexps (see README)
   # * :<tt>identities</tt> - regexps
-  # * :<tt>blockings</tt> - regexps
+  # * :<tt>groupings</tt> - regexps
   # * :<tt>stop_words</tt> - regexps
   #
   # Options (can be specified at initialization or when calling #find)
   # * :<tt>read</tt> - how to interpret each record in the 'haystack', either a Proc or a symbol
-  # * :<tt>must_match_blocking</tt> - don't return a match unless the needle fits into one of the blockings you specified
+  # * :<tt>must_match_grouping</tt> - don't return a match unless the needle fits into one of the groupings you specified
   # * :<tt>must_match_at_least_one_word</tt> - don't return a match unless the needle shares at least one word with the match
-  # * :<tt>first_blocking_decides</tt> - force records into the first blocking they match, rather than choosing a blocking that will give them a higher score
+  # * :<tt>first_grouping_decides</tt> - force records into the first grouping they match, rather than choosing a grouping that will give them a higher score
   # * :<tt>gather_last_result</tt> - enable <tt>last_result</tt>
   def initialize(competitors, options_and_rules = {})
     options_and_rules = options_and_rules.symbolize_keys
 
     # rules
-    self.blockings = options_and_rules.delete(:blockings) || []
+    self.groupings = options_and_rules.delete(:groupings) || options_and_rules.delete(:blockings) || []
     self.identities = options_and_rules.delete(:identities) || []
     self.normalizers = options_and_rules.delete(:normalizers) || options_and_rules.delete(:tighteners) || []
     self.stop_words = options_and_rules.delete(:stop_words) || []
     @read = options_and_rules.delete(:read) || options_and_rules.delete(:haystack_reader)
 
     # options
+    if deprecated = options_and_rules.delete(:first_blocking_decides)
+      options_and_rules[:first_grouping_decides] = deprecated
+    end
+    if deprecated = options_and_rules.delete(:must_match_blocking)
+      options_and_rules[:must_match_grouping] = deprecated
+    end
     @default_options = options_and_rules.reverse_merge(DEFAULT_OPTIONS).freeze
 
     # do this last
     self.haystack = competitors
   end
   
-  def blockings=(ary)
-    @blockings = ary.map { |regexp_or_str| Blocking.new regexp_or_str }
+  def groupings=(ary)
+    @groupings = ary.map { |regexp_or_str| Rule::Grouping.new regexp_or_str }
   end
   
   def identities=(ary)
-    @identities = ary.map { |regexp_or_str| Identity.new regexp_or_str }
+    @identities = ary.map { |regexp_or_str| Rule::Identity.new regexp_or_str }
   end
   
   def normalizers=(ary)
-    @normalizers = ary.map { |regexp_or_str| Normalizer.new regexp_or_str }
+    @normalizers = ary.map { |regexp_or_str| Rule::Normalizer.new regexp_or_str }
   end
   
   def stop_words=(ary)
-    @stop_words = ary.map { |regexp_or_str| StopWord.new regexp_or_str }
+    @stop_words = ary.map { |regexp_or_str| Rule::StopWord.new regexp_or_str }
   end
   
   def haystack=(ary)
@@ -124,8 +131,8 @@ class FuzzyMatch
     
     gather_last_result = options[:gather_last_result]
     is_find_all = options[:find_all]
-    first_blocking_decides = options[:first_blocking_decides]
-    must_match_blocking = options[:must_match_blocking]
+    first_grouping_decides = options[:first_grouping_decides]
+    must_match_grouping = options[:must_match_grouping]
     must_match_at_least_one_word = options[:must_match_at_least_one_word]
     
     if gather_last_result
@@ -142,7 +149,7 @@ EOS
     if gather_last_result
       last_result.normalizers = normalizers
       last_result.identities = identities
-      last_result.blockings = blockings
+      last_result.groupings = groupings
       last_result.stop_words = stop_words
     end
     
@@ -156,11 +163,11 @@ The needle's #{needle.variants.length} variants were enumerated.
 EOS
     end
     
-    if must_match_blocking and blockings.any? and blockings.none? { |blocking| blocking.match? needle }
+    if must_match_grouping and groupings.any? and groupings.none? { |grouping| grouping.match? needle }
       if gather_last_result
         last_result.timeline << <<-EOS
-The needle didn't match any of the #{blockings.length} blocking, which was a requirement.
-\tBlockings (first 3): #{blockings[0,3].map(&:inspect).join(', ')}
+The needle didn't match any of the #{groupings.length} grouping, which was a requirement.
+\tGroupings (first 3): #{groupings[0,3].map(&:inspect).join(', ')}
 EOS
       end
       
@@ -187,18 +194,18 @@ EOS
       passed_word_requirement = haystack
     end
     
-    if blockings.any?
+    if groupings.any?
       joint = passed_word_requirement.select do |straw|
-        if first_blocking_decides
-          blockings.detect { |blocking| blocking.match? needle }.try :join?, needle, straw
+        if first_grouping_decides
+          groupings.detect { |grouping| grouping.match? needle }.try :join?, needle, straw
         else
-          blockings.any? { |blocking| blocking.join? needle, straw }
+          groupings.any? { |grouping| grouping.join? needle, straw }
         end
       end
       if gather_last_result
         last_result.timeline << <<-EOS
-Since there were blockings, the competition was reduced to records in the same block as the needle.
-\tBlockings (first 3): #{blockings[0,3].map(&:inspect).join(', ')}
+Since there were groupings, the competition was reduced to records in the same group as the needle.
+\tGroupings (first 3): #{groupings[0,3].map(&:inspect).join(', ')}
 \tPassed (first 3): #{joint[0,3].map(&:render).map(&:inspect).join(', ')}
 \tFailed (first 3): #{(passed_word_requirement-joint)[0,3].map(&:render).map(&:inspect).join(', ')}
 EOS
@@ -208,10 +215,10 @@ EOS
     end
     
     if joint.none?
-      if must_match_blocking
+      if must_match_grouping
         if gather_last_result
           last_result.timeline << <<-EOS
-Since :must_match_at_least_one_word => true and none of the competition was in the same block as the needle, the search stopped.
+Since :must_match_at_least_one_word => true and none of the competition was in the same group as the needle, the search stopped.
 EOS
         end
         if is_find_all
@@ -256,20 +263,21 @@ EOS
       return similarities.map { |similarity| similarity.wrapper2.record }
     end
     
+    best_similarity = similarities.first
     winner = nil
 
-    if best_similarity = similarities.first and best_similarity.best_score.dices_coefficient_similar > 0
+    if best_similarity and (best_similarity.best_score.dices_coefficient_similar > 0 or (needle.words & best_similarity.wrapper2.words).any?)
       winner = best_similarity.wrapper2.record
       if gather_last_result
         last_result.winner = winner
         last_result.score = best_similarity.best_score.dices_coefficient_similar
         last_result.timeline << <<-EOS
-A winner was determined because the similarity score #{best_similarity.best_score.dices_coefficient_similar} is greater than zero.
+A winner was determined because the Dice's Coefficient similarity (#{best_similarity.best_score.dices_coefficient_similar}) is greater than zero or because it shared a word with the needle.
 EOS
       end
     elsif gather_last_result
         last_result.timeline << <<-EOS
-No winner assigned because similarity score was zero.
+No winner assigned because the score of the best similarity (#{best_similarity.try(:wrapper2).try(:record).try(:inspect)}) was zero and it didn't match any words with the needle (#{needle.inspect}).
 EOS
     end