Contents

# frozen_string_literal: true

module RuboCop
  # Common functionality for finding names that are similar to a given name.
  module NameSimilarity
    module_function

    def find_similar_name(target_name, names)
      similar_names = find_similar_names(target_name, names)

      similar_names.first
    end

    def find_similar_names(target_name, names)
      # DidYouMean::SpellChecker is not available in all versions of Ruby, and
      # even on versions where it *is* available (>= 2.3), it is not always
      # required correctly. So we do a feature check first.
      # See: https://github.com/rubocop-hq/rubocop/issues/7979
      return [] unless defined?(DidYouMean::SpellChecker)

      names = names.dup
      names.delete(target_name)

      spell_checker = DidYouMean::SpellChecker.new(dictionary: names)
      spell_checker.correct(target_name)
    end
  end
end

Version data entries

6 entries across 6 versions & 2 rubygems

Version	Path
rubocop-0.89.1	lib/rubocop/name_similarity.rb
rubocop-0.89.0	lib/rubocop/name_similarity.rb
rubocop-0.88.0	lib/rubocop/name_similarity.rb
rbhint-0.87.1.rc1	lib/rubocop/name_similarity.rb
rubocop-0.87.1	lib/rubocop/name_similarity.rb
rubocop-0.87.0	lib/rubocop/name_similarity.rb