fuzzy_match 1.4.1 → 1.5.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YTlmMmE3MDI3MWQ0NzY0NGE5N2Q4ZDY4MmI5NjUzZTg5YWU1OWE5OQ==
+  data.tar.gz: !binary |-
+    MzU3MDc3NjQ1NDczNWFhNWE0ZDdlZGRmYjlhYWQ3Y2YyZTNiMjRhMQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MDcyZDk5OGY5MTQwNTEyMDA1YmQ1MzdiYzYyZTczMWExNzI0NjhlYWNkYzcx
+    Y2UwNzgwN2I5YmI3MjVhMzIwMDljZmVmMTFkODQ2MjY2NDdkNzViZjlhNTcy
+    NjliMmU5NTAwOTBiYTYxNjk4ZDkwZWM0OWMzMTdjZTU4ZjQ4NDk=
+  data.tar.gz: !binary |-
+    MTg0MGVlYTc3NTY0NjMxZWMwNWFmZTdhYmRhOWM4MGJmN2QwYjc3NmNiYzQz
+    MzU3ODc2NDRjNDJjNzhiYmQwMmNkNmQ3MTdjYzMyNjM2YzBjMDEwOGYzNzgy
+    NmFkZTM0M2E2YzkwZjY1YjM4ZTEzY2Y1YmU5MmY3MDZjNTJhMzg=

data/CHANGELOG

@@ -1,3 +1,14 @@
+1.5.0 / 2013-04-03
+
+* Breaking changes
+
+  * No longer automatically calls to_regexp on rules - you must pass Regexps to normalizers, groupings, etc.
+
+* Enhancements
+
+  * FuzzyMatch#find_best returns all top results with the same score - thanks @ihough !
+  * Doesn't require to_regexp gem for you - you can still use it if you want to convert strings into regexps safely, if you want, tho
+
 1.4.1 / 2013-01-17
 
 * Bug fixes

data/fuzzy_match.gemspec

@@ -17,8 +17,6 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_runtime_dependency 'to_regexp', '>=0.0.3'
-  
   # needed if you use FuzzyMatch::CachedResult
   s.add_development_dependency 'active_record_inline_schema', '>=0.4.0'
 

data/lib/fuzzy_match/rule.rb

@@ -3,8 +3,11 @@ class FuzzyMatch
   class Rule
     attr_reader :regexp
     
-    def initialize(regexp_or_str)
-      @regexp = regexp_or_str.to_regexp
+    def initialize(regexp)
+      unless regexp.is_a?(::Regexp)
+        raise ArgumentError, "[FuzzyMatch] Rules must be set with Regexp objects, but got #{regexp.inspect} (#{regexp.class.name})"
+      end
+      @regexp = regexp
     end
     
     def ==(other)

data/lib/fuzzy_match/score.rb

@@ -3,6 +3,8 @@ require 'fuzzy_match/score/amatch'
 
 class FuzzyMatch
   class Score
+    include Comparable
+    
     attr_reader :str1
     attr_reader :str2
 

data/lib/fuzzy_match/version.rb

@@ -1,3 +1,3 @@
 class FuzzyMatch
-  VERSION = '1.4.1'
+  VERSION = '1.5.0'
 end

data/lib/fuzzy_match.rb

@@ -1,5 +1,3 @@
-require 'to_regexp'
-
 require 'fuzzy_match/rule'
 require 'fuzzy_match/rule/normalizer'
 require 'fuzzy_match/rule/stop_word'
@@ -42,7 +40,8 @@ class FuzzyMatch
     :gather_last_result => false,
     :find_all => false,
     :find_all_with_score => false,
-    :threshold => 0
+    :threshold => 0,
+    :find_best => false,
   }
 
   self.engine = DEFAULT_ENGINE
@@ -94,19 +93,19 @@ class FuzzyMatch
   end
   
   def groupings=(ary)
-    @groupings = ary.map { |regexp_or_str| Rule::Grouping.new regexp_or_str }
+    @groupings = ary.map { |regexp| Rule::Grouping.new regexp }
   end
   
   def identities=(ary)
-    @identities = ary.map { |regexp_or_str| Rule::Identity.new regexp_or_str }
+    @identities = ary.map { |regexp| Rule::Identity.new regexp }
   end
   
   def normalizers=(ary)
-    @normalizers = ary.map { |regexp_or_str| Rule::Normalizer.new regexp_or_str }
+    @normalizers = ary.map { |regexp| Rule::Normalizer.new regexp }
   end
   
   def stop_words=(ary)
-    @stop_words = ary.map { |regexp_or_str| Rule::StopWord.new regexp_or_str }
+    @stop_words = ary.map { |regexp| Rule::StopWord.new regexp }
   end
   
   def haystack=(ary)
@@ -122,6 +121,11 @@ class FuzzyMatch
     find needle, options
   end
 
+  def find_best(needle, options = {})
+    options = options.merge(:find_best => true)
+    find needle, options
+  end
+
   def find_all_with_score(needle, options = {})
     options = options.merge(:find_all_with_score => true)
     find needle, options
@@ -133,7 +137,8 @@ class FuzzyMatch
     threshold = options[:threshold]
     gather_last_result = options[:gather_last_result]
     is_find_all_with_score = options[:find_all_with_score]
-    is_find_all = options[:find_all] || is_find_all_with_score
+    is_find_best = options[:find_best]
+    is_find_all = options[:find_all] || is_find_all_with_score || is_find_best
     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]
@@ -275,6 +280,23 @@ EOS
       return memo
     end
 
+    if is_find_best
+      memo = []
+      best_bs = nil
+      similarities.each do |similarity|
+        if similarity.satisfy?(needle, threshold)
+          bs = similarity.best_score
+          best_bs ||= bs
+          if bs >= best_bs
+            memo << similarity.wrapper2.record
+          else
+            break
+          end
+        end
+      end
+      return memo
+    end
+
     if is_find_all
       memo = []
       similarities.each do |similarity|

data/test/test_fuzzy_match.rb

@@ -26,6 +26,14 @@ describe FuzzyMatch do
     end
   end
 
+  describe '#find_best' do
+    it %{returns one or more records with the best score} do
+      d = FuzzyMatch.new [ 'X', 'X', 'X22', 'Y', 'Y', 'Y4' ], :groupings => [ /X/, /Y/ ], :must_match_grouping => true
+      d.find_best('X').must_equal ['X', 'X' ]
+      d.find_best('A').must_equal []
+    end
+  end
+
   describe '#find_all_with_score' do
     it %{return records with 2 scores} do
       d = FuzzyMatch.new [ 'X', 'X22', 'Y', 'Y4' ], :groupings => [ /X/, /Y/ ], :must_match_grouping => true

data/test/test_identity.rb

@@ -21,12 +21,10 @@ describe FuzzyMatch::Rule::Identity do
     i.regexp.must_equal %r{\A\\?/(.*)etc/mysql\$$}
   end
   
-  it %{can be initialized from a string (via to_regexp gem)} do
-    i = FuzzyMatch::Rule::Identity.new '%r{\A\\\?/(.*)etc/mysql\$$}'
-    i.regexp.must_equal %r{\A\\?/(.*)etc/mysql\$$}
-
-    i = FuzzyMatch::Rule::Identity.new '/\A\\\?\/(.*)etc\/mysql\$$/'
-    i.regexp.must_equal %r{\A\\?/(.*)etc/mysql\$$}
+  it %{does not automatically convert strings to regexps} do
+    lambda do
+      FuzzyMatch::Rule::Identity.new '%r{\A\\\?/(.*)etc/mysql\$$}'
+    end.must_raise ArgumentError, /regexp/i
   end
   
   it %{embraces case insensitivity} do

metadata

@@ -1,36 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: fuzzy_match
 version: !ruby/object:Gem::Version
-  version: 1.4.1
-  prerelease: 
+  version: 1.5.0
 platform: ruby
 authors:
 - Seamus Abshere
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-18 00:00:00.000000000 Z
+date: 2013-04-03 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: to_regexp
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 0.0.3
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 0.0.3
 - !ruby/object:Gem::Dependency
   name: active_record_inline_schema
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -38,7 +20,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -46,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -54,7 +34,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -62,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -70,7 +48,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -78,7 +55,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -86,7 +62,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -94,7 +69,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: cohort_analysis
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -102,7 +76,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -110,7 +83,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: weighted_average
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -118,7 +90,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -126,7 +97,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -134,7 +104,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -142,7 +111,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: amatch
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -150,7 +118,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -158,7 +125,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest-reporters
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -166,7 +132,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -232,27 +197,26 @@ files:
 - test/test_wrapper.rb
 homepage: https://github.com/seamusabshere/fuzzy_match
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: fuzzy_match
-rubygems_version: 1.8.24
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Find a needle in a haystack using string similarity and (optionally) regexp
   rules. Replaces loose_tight_dictionary.
 test_files: