require 'active_support'
require 'active_support/version'
if ::ActiveSupport::VERSION::MAJOR >= 3
require 'active_support/core_ext'
end
require 'to_regexp'
require 'fuzzy_match/normalizer'
require 'fuzzy_match/stop_word'
require 'fuzzy_match/blocking'
require 'fuzzy_match/identity'
require 'fuzzy_match/result'
require 'fuzzy_match/wrapper'
require 'fuzzy_match/similarity'
require 'fuzzy_match/score'
if defined?(::ActiveRecord)
require 'fuzzy_match/cached_result'
end
# See the README for more information.
class FuzzyMatch
DEFAULT_OPTIONS = {
:first_blocking_decides => false,
:must_match_blocking => false,
:must_match_at_least_one_word => false,
:gather_last_result => false,
:find_all => false
}
attr_reader :haystack
attr_reader :blockings
attr_reader :identities
attr_reader :normalizers
attr_reader :stop_words
attr_reader :read
attr_reader :default_options
# haystack - a bunch of records that will compete to see who best matches the needle
#
# Rules (can only be specified at initialization or by using a setter)
# * :normalizers - regexps (see README)
# * :identities - regexps
# * :blockings - regexps
# * :stop_words - regexps
#
# Options (can be specified at initialization or when calling #find)
# * :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_at_least_one_word - don't return a match unless the needle shares at least one word with the match
# * :first_blocking_decides - force records into the first blocking they match, rather than choosing a blocking that will give them a higher score
# * :gather_last_result - enable last_result
def initialize(competitors, options_and_rules = {})
options_and_rules = options_and_rules.symbolize_keys
# rules
self.blockings = 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
@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 }
end
def identities=(ary)
@identities = ary.map { |regexp_or_str| Identity.new regexp_or_str }
end
def normalizers=(ary)
@normalizers = ary.map { |regexp_or_str| Normalizer.new regexp_or_str }
end
def stop_words=(ary)
@stop_words = ary.map { |regexp_or_str| StopWord.new regexp_or_str }
end
def haystack=(ary)
@haystack = ary.map { |competitor| Wrapper.new self, competitor }
end
def last_result
@last_result || raise(::RuntimeError, "[fuzzy_match] You can't access the last result until you've run a find with :gather_last_result => true")
end
def find_all(needle, options = {})
options = options.symbolize_keys.merge(:find_all => true)
find needle, options
end
def find(needle, options = {})
options = options.symbolize_keys.reverse_merge default_options
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]
must_match_at_least_one_word = options[:must_match_at_least_one_word]
if gather_last_result
@last_result = Result.new
last_result.read = read
last_result.haystack = haystack
last_result.options = options
last_result.timeline << <<-EOS
Options were set, either by you or by falling back to defaults.
\tOptions: #{options.inspect}
EOS
end
if gather_last_result
last_result.normalizers = normalizers
last_result.identities = identities
last_result.blockings = blockings
last_result.stop_words = stop_words
end
needle = Wrapper.new self, needle, true
if gather_last_result
last_result.needle = needle
last_result.timeline << <<-EOS
The needle's #{needle.variants.length} variants were enumerated.
\tVariants: #{needle.variants.map(&:inspect).join(', ')}
EOS
end
if must_match_blocking and blockings.any? and blockings.none? { |blocking| blocking.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(', ')}
EOS
end
if is_find_all
return []
else
return nil
end
end
if must_match_at_least_one_word
passed_word_requirement = haystack.select do |straw|
(needle.words & straw.words).any?
end
if gather_last_result
last_result.timeline << <<-EOS
Since :must_match_at_least_one_word => true, the competition was reduced to records sharing at least one word with the needle.
\tNeedle words: #{needle.words.map(&:inspect).join(', ')}
\tPassed (first 3): #{passed_word_requirement[0,3].map(&:render).map(&:inspect).join(', ')}
\tFailed (first 3): #{(haystack-passed_word_requirement)[0,3].map(&:render).map(&:inspect).join(', ')}
EOS
end
else
passed_word_requirement = haystack
end
if blockings.any?
joint = passed_word_requirement.select do |straw|
if first_blocking_decides
blockings.detect { |blocking| blocking.match? needle }.try :join?, needle, straw
else
blockings.any? { |blocking| blocking.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(', ')}
\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
end
else
joint = passed_word_requirement.dup
end
if joint.none?
if must_match_blocking
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.
EOS
end
if is_find_all
return []
else
return nil
end
else
joint = passed_word_requirement.dup
end
end
if identities.any?
possibly_identical = joint.select do |straw|
identities.all? do |identity|
answer = identity.identical? needle, straw
answer.nil? or answer == true
end
end
if gather_last_result
last_result.timeline << <<-EOS
Since there were identities, the competition was reduced to records that might be identical to the needle (in other words, are not certainly different)
\Identities (first 3): #{identities[0,3].map(&:inspect).join(', ')}
\tPassed (first 3): #{possibly_identical[0,3].map(&:render).map(&:inspect).join(', ')}
\tFailed (first 3): #{(joint-possibly_identical)[0,3].map(&:render).map(&:inspect).join(', ')}
EOS
end
else
possibly_identical = joint.dup
end
similarities = possibly_identical.map { |straw| needle.similarity straw }.sort.reverse
if gather_last_result
last_result.timeline << <<-EOS
The competition was sorted in order of similarity to the needle.
\tSimilar (first 3): #{(similarities)[0,3].map(&:wrapper2).map(&:render).map(&:inspect).join(', ')}
EOS
end
if is_find_all
return similarities.map { |similarity| similarity.wrapper2.record }
end
winner = nil
if best_similarity = similarities.first and best_similarity.best_score.dices_coefficient_similar > 0
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.
EOS
end
elsif gather_last_result
last_result.timeline << <<-EOS
No winner assigned because similarity score was zero.
EOS
end
winner
end
# Explain is like mysql's EXPLAIN command. You give it a needle and it tells you about how it was located (successfully or not) in the haystack.
#
# d = FuzzyMatch.new ['737', '747', '757' ]
# d.explain 'boeing 737-100'
def explain(needle, options = {})
find needle, options.merge(:gather_last_result => true)
last_result.explain
end
# DEPRECATED - doesn't do anything
def free
end
end