Class: Autosuggest

Inherits:
Object
  • Object
show all
Defined in:
lib/autosuggest.rb,
lib/autosuggest/version.rb

Constant Summary collapse

VERSION = 
"0.1.1"

Instance Method Summary collapse

Constructor Details

#initialize(top_queries) ⇒ Autosuggest

Returns a new instance of Autosuggest.



13
14
15
16
17
18
19
20
21
22
 
# File 'lib/autosuggest.rb', line 13

def initialize(top_queries)
  @top_queries = top_queries
  @concepts = {}
  @words = Set.new
  @non_duplicates = Set.new
  @blocked_words = Set.new
  @blacklisted_words = Set.new
  @preferred_queries = {}
  @profane_words = Set.new(Obscenity::Base.blacklist)
end

Instance Method Details

#add_concept(name, values) ⇒ Object 



24
25
26
 
# File 'lib/autosuggest.rb', line 24

def add_concept(name, values)
  @concepts[name] = Set.new(values.compact.uniq.map(&:downcase))
end

#blacklist_words(words) ⇒ Object 



58
59
60
61
62
63
 
# File 'lib/autosuggest.rb', line 58

def blacklist_words(words)
  warn "[autosuggest] blacklist_words is deprecated. Use block_words instead."
  words.each do |word|
    @blacklisted_words << word.downcase
  end
end

#block_words(words) ⇒ Object 



52
53
54
55
56
 
# File 'lib/autosuggest.rb', line 52

def block_words(words)
  words.each do |word|
    @blocked_words << word.downcase
  end
end

#not_duplicates(pairs) ⇒ Object 



46
47
48
49
50
 
# File 'lib/autosuggest.rb', line 46

def not_duplicates(pairs)
  pairs.each do |pair|
    @non_duplicates << pair.map(&:downcase).sort
  end
end

#parse_words(phrases, options = {}) ⇒ Object 



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/autosuggest.rb', line 28

def parse_words(phrases, options = {})
  min = options[:min] || 1

  word_counts = Hash.new(0)
  phrases.each do |phrase|
    words = tokenize(phrase)
    words.each do |word|
      word_counts[word] += 1
    end
  end

  word_counts.select { |_, c| c >= min }.each do |word, _|
    @words << word
  end

  word_counts
end

#prefer(queries) ⇒ Object 



65
66
67
68
69
 
# File 'lib/autosuggest.rb', line 65

def prefer(queries)
  queries.each do |query|
    @preferred_queries[normalize_query(query)] ||= query
  end
end

#pretty_suggestions ⇒ Object 



145
146
147
148
149
150
151
 
# File 'lib/autosuggest.rb', line 145

def pretty_suggestions
  str = "%-30s   %5s   %s\n" % %w(Query Score Notes)
  suggestions.each do |suggestion|
    str << "%-30s   %5d   %s\n" % [suggestion[:query], suggestion[:score], suggestion[:notes].join(", ")]
  end
  str
end

#suggestions ⇒ Object 



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/autosuggest.rb', line 71

def suggestions
  stemmed_queries = {}
  added_queries = Set.new
  @top_queries.sort_by { |_query, count| -count }.map do |query, count|
    query = query.to_s

    # TODO do not ignore silently
    next if query.length < 2

    stemmed_query = normalize_query(query)

    # get preferred term
    preferred_query = @preferred_queries[stemmed_query]
    if preferred_query && preferred_query != query
      original_query, query = query, preferred_query
    end

    # exclude duplicates
    duplicate = stemmed_queries[stemmed_query]
    stemmed_queries[stemmed_query] ||= query

    # also detect possibly misspelled duplicates
    # TODO use top query as duplicate
    if !duplicate && query.length > 4
      edits(query).each do |edited_query|
        if added_queries.include?(edited_query)
          duplicate = edited_query
          break
        end
      end
    end
    if duplicate && @non_duplicates.include?([duplicate, query].sort)
      duplicate = nil
    end
    added_queries << query unless duplicate

    # find concepts
    concepts = []
    @concepts.each do |name, values|
      concepts << name if values.include?(query)
    end

    # exclude misspellings that are not brands
    misspelling = @words.any? && misspellings?(query)

    profane = blocked?(query, @profane_words)
    blocked = blocked?(query, @blocked_words)
    blacklisted = blocked?(query, @blacklisted_words)

    notes = []
    notes << "duplicate of #{duplicate}" if duplicate
    notes.concat(concepts)
    notes << "misspelling" if misspelling
    notes << "profane" if profane
    notes << "blocked" if blocked
    notes << "blacklisted" if blacklisted
    notes << "originally #{original_query}" if original_query

    result = {
      query: query,
      original_query: original_query,
      score: count,
      duplicate: duplicate,
      concepts: concepts,
      misspelling: misspelling,
      profane: profane,
      blocked: blocked
    }
    result[:blacklisted] = blacklisted if @blacklisted_words.any?
    result[:notes] = notes
    result
  end
end