In Files

  • did_you_mean/tree_spell_checker.rb

DidYouMean::TreeSpellChecker

spell checker for a dictionary that has a tree structure, see doc/tree_spell_checker_api.md

Attributes

augment[R]
dictionary[R]
separator[R]

Public Class Methods

new(dictionary:, separator: '/', augment: nil) click to toggle source
 
               # File did_you_mean/tree_spell_checker.rb, line 8
def initialize(dictionary,, separator: '/', augment: nil)
  @dictionary = dictionary
  @separator = separator
  @augment = augment
end
            

Public Instance Methods

correct(input) click to toggle source
 
               # File did_you_mean/tree_spell_checker.rb, line 14
def correct(input)
  plausibles = plausible_dimensions(input)
  return fall_back_to_normal_spell_check(input) if plausibles.empty?

  suggestions = find_suggestions(input, plausibles)
  return fall_back_to_normal_spell_check(input) if suggestions.empty?

  suggestions
end
            
dictionary_without_leaves() click to toggle source
 
               # File did_you_mean/tree_spell_checker.rb, line 24
def dictionary_without_leaves
  @dictionary_without_leaves ||= dictionary.map { |word| word.split(separator)[0..-2] }.uniq
end
            
dimensions() click to toggle source
 
               # File did_you_mean/tree_spell_checker.rb, line 32
def dimensions
  @dimensions ||= tree_depth.times.map do |index|
                    dictionary_without_leaves.map { |element| element[index] }.compact.uniq
                  end
end
            
find_leaves(path) click to toggle source
 
               # File did_you_mean/tree_spell_checker.rb, line 38
def find_leaves(path)
  path_with_separator = "#{path}#{separator}"

  dictionary
    .select {|str| str.include?(path_with_separator) }
    .map {|str| str.gsub(path_with_separator, '') }
end
            
plausible_dimensions(input) click to toggle source
 
               # File did_you_mean/tree_spell_checker.rb, line 46
def plausible_dimensions(input)
  input.split(separator)[0..-2]
    .map
    .with_index { |element, index| correct_element(dimensions[index], element) if dimensions[index] }
    .compact
end
            
possible_paths(states) click to toggle source
 
               # File did_you_mean/tree_spell_checker.rb, line 53
def possible_paths(states)
  states.map { |state| state.join(separator) }
end
            
tree_depth() click to toggle source
 
               # File did_you_mean/tree_spell_checker.rb, line 28
def tree_depth
  @tree_depth ||= dictionary_without_leaves.max { |a, b| a.size <=> b.size }.size
end