did_you_mean 1.3.1 → 1.4.0

data/lib/did_you_mean/spell_checkers/method_name_checker.rb

@@ -1,4 +1,4 @@
-require "did_you_mean/spell_checker"
+require_relative "../spell_checker"
 
 module DidYouMean
   class MethodNameChecker
@@ -43,14 +43,22 @@ module DidYouMean
     end
 
     def corrections
-      @corrections ||= SpellChecker.new(dictionary: RB_RESERVED_WORDS + method_names).correct(method_name) - NAMES_TO_EXCLUDE[@receiver.class]
+      @corrections ||= SpellChecker.new(dictionary: RB_RESERVED_WORDS + method_names).correct(method_name) - names_to_exclude
     end
 
     def method_names
-      method_names = receiver.methods + receiver.singleton_methods
-      method_names += receiver.private_methods if @private_call
-      method_names.uniq!
-      method_names
+      if Object === receiver
+        method_names = receiver.methods + receiver.singleton_methods
+        method_names += receiver.private_methods if @private_call
+        method_names.uniq!
+        method_names
+      else
+        []
+      end
+    end
+
+    def names_to_exclude
+      Object === receiver ? NAMES_TO_EXCLUDE[receiver.class] : []
     end
   end
 end

data/lib/did_you_mean/spell_checkers/name_error_checkers.rb

@@ -1,5 +1,5 @@
-require 'did_you_mean/spell_checkers/name_error_checkers/class_name_checker'
-require 'did_you_mean/spell_checkers/name_error_checkers/variable_name_checker'
+require_relative 'name_error_checkers/class_name_checker'
+require_relative 'name_error_checkers/variable_name_checker'
 
 module DidYouMean
   class << (NameErrorCheckers = Object.new)

data/lib/did_you_mean/spell_checkers/name_error_checkers/class_name_checker.rb

@@ -1,6 +1,6 @@
 # frozen-string-literal: true
-require 'delegate'
-require "did_you_mean/spell_checker"
+
+require_relative "../../spell_checker"
 
 module DidYouMean
   class ClassNameChecker
@@ -31,16 +31,16 @@ module DidYouMean
       end.uniq
     end
 
-    class ClassName < SimpleDelegator
+    class ClassName < String
       attr :namespace
 
       def initialize(name, namespace = '')
-        super(name)
+        super(name.to_s)
         @namespace = namespace
       end
 
       def full_name
-        self.class.new("#{namespace}#{__getobj__}")
+        self.class.new("#{namespace}#{self}")
       end
     end
 

data/lib/did_you_mean/spell_checkers/name_error_checkers/variable_name_checker.rb

@@ -1,6 +1,6 @@
 # frozen-string-literal: true
 
-require "did_you_mean/spell_checker"
+require_relative "../../spell_checker"
 
 module DidYouMean
   class VariableNameChecker

data/lib/did_you_mean/tree_spell_checker.rb

@@ -0,0 +1,137 @@
+module DidYouMean
+  # spell checker for a dictionary that has a tree
+  # structure, see doc/tree_spell_checker_api.md
+  class TreeSpellChecker
+    attr_reader :dictionary, :dimensions, :separator, :augment
+
+    def initialize(dictionary:, separator: '/', augment: nil)
+      @dictionary = dictionary
+      @separator = separator
+      @augment = augment
+      @dimensions = parse_dimensions
+    end
+
+    def correct(input)
+      plausibles = plausible_dimensions input
+      return no_idea(input) if plausibles.empty?
+      suggestions = find_suggestions input, plausibles
+      return no_idea(input) if suggestions.empty?
+      suggestions
+    end
+
+    private
+
+    def parse_dimensions
+      ParseDimensions.new(dictionary, separator).call
+    end
+
+    def find_suggestions(input, plausibles)
+      states = plausibles[0].product(*plausibles[1..-1])
+      paths = possible_paths states
+      leaf = input.split(separator).last
+      ideas = find_ideas(paths, leaf)
+      ideas.compact.flatten
+    end
+
+    def no_idea(input)
+      return [] unless augment
+      ::DidYouMean::SpellChecker.new(dictionary: dictionary).correct(input)
+    end
+
+    def find_ideas(paths, leaf)
+      paths.map do |path|
+        names = find_leaves(path)
+        ideas = CorrectElement.new.call names, leaf
+        ideas_to_paths ideas, leaf, names, path
+      end
+    end
+
+    def ideas_to_paths(ideas, leaf, names, path)
+      return nil if ideas.empty?
+      return [path + separator + leaf] if names.include? leaf
+      ideas.map { |str| path + separator + str }
+    end
+
+    def find_leaves(path)
+      dictionary.map do |str|
+        next unless str.include? "#{path}#{separator}"
+        str.gsub("#{path}#{separator}", '')
+      end.compact
+    end
+
+    def possible_paths(states)
+      states.map do |state|
+        state.join separator
+      end
+    end
+
+    def plausible_dimensions(input)
+      elements = input.split(separator)[0..-2]
+      elements.each_with_index.map do |element, i|
+        next if dimensions[i].nil?
+        CorrectElement.new.call dimensions[i], element
+      end.compact
+    end
+  end
+
+  # parses the elements in each dimension
+  class ParseDimensions
+    def initialize(dictionary, separator)
+      @dictionary = dictionary
+      @separator = separator
+    end
+
+    def call
+      leafless = remove_leaves
+      dimensions = find_elements leafless
+      dimensions.map do |elements|
+        elements.to_set.to_a
+      end
+    end
+
+    private
+
+    def remove_leaves
+      dictionary.map do |a|
+        elements = a.split(separator)
+        elements[0..-2]
+      end.to_set.to_a
+    end
+
+    def find_elements(leafless)
+      max_elements = leafless.map(&:size).max
+      dimensions = Array.new(max_elements) { [] }
+      (0...max_elements).each do |i|
+        leafless.each do |elements|
+          dimensions[i] << elements[i] unless elements[i].nil?
+        end
+      end
+      dimensions
+    end
+
+    attr_reader :dictionary, :separator
+  end
+
+  # identifies the elements close to element
+  class CorrectElement
+    def initialize
+    end
+
+    def call(names, element)
+      return names if names.size == 1
+      str = normalize element
+      return [str] if names.include? str
+      checker = ::DidYouMean::SpellChecker.new(dictionary: names)
+      checker.correct(str)
+    end
+
+    private
+
+    def normalize(leaf)
+      str = leaf.dup
+      str.downcase!
+      return str unless str.include? '@'
+      str.tr!('@', '  ')
+    end
+  end
+end

data/lib/did_you_mean/verbose.rb

@@ -1,4 +1,4 @@
-require 'did_you_mean'
-require 'did_you_mean/formatters/verbose_formatter'
+require_relative '../did_you_mean'
+require_relative 'formatters/verbose_formatter'
 
 DidYouMean.formatter = DidYouMean::VerboseFormatter.new

data/lib/did_you_mean/version.rb

@@ -1,3 +1,3 @@
 module DidYouMean
-  VERSION = "1.3.1"
+  VERSION = "1.4.0"
 end

data/test/core_ext/test_name_error_extension.rb

@@ -0,0 +1,48 @@
+require_relative '../helper'
+
+class NameErrorExtensionTest < Test::Unit::TestCase
+  SPELL_CHECKERS = DidYouMean::SPELL_CHECKERS
+
+  class TestSpellChecker
+    def initialize(*); end
+    def corrections; ["does_exist"]; end
+  end
+
+  def setup
+    @org, SPELL_CHECKERS['NameError'] = SPELL_CHECKERS['NameError'], TestSpellChecker
+
+    @error = assert_raise(NameError){ doesnt_exist }
+  end
+
+  def teardown
+    SPELL_CHECKERS['NameError'] = @org
+  end
+
+  def test_message
+    assert_match(/Did you mean\?  does_exist/, @error.to_s)
+    assert_match(/Did you mean\?  does_exist/, @error.message)
+  end
+
+  def test_to_s_does_not_make_disruptive_changes_to_error_message
+    error = assert_raise(NameError) do
+      raise NameError, "uninitialized constant Object"
+    end
+
+    error.to_s
+    assert_equal 1, error.to_s.scan("Did you mean?").count
+  end
+
+  def test_correctable_error_objects_are_dumpable
+    error =
+      begin
+        Dir.chdir(__dir__) { File.open('test_name_error_extension.rb') { |f| f.sizee } }
+      rescue NoMethodError => e
+        e
+      end
+
+    error.to_s
+
+    assert_equal "undefined method `sizee' for #<File:test_name_error_extension.rb (closed)>",
+                 Marshal.load(Marshal.dump(error)).original_message
+  end
+end

data/test/edit_distance/{jaro_winkler_test.rb → test_jaro_winkler.rb}

@@ -1,4 +1,4 @@
-require 'test_helper'
+require_relative '../helper'
 
 # These tests were originally written by Jian Weihang (簡煒航) as part of his work
 # on the jaro_winkler gem. The original code could be found here:
@@ -6,7 +6,7 @@ require 'test_helper'
 #
 # Copyright (c) 2014 Jian Weihang
 
-class JaroWinklerTest < Minitest::Test
+class JaroWinklerTest < Test::Unit::TestCase
   def test_jaro_winkler_distance
     assert_distance 0.9667, 'henka',      'henkan'
     assert_distance 1.0,    'al',         'al'

data/test/fixtures/mini_dir.yml

@@ -0,0 +1,15 @@
+---
+- test/core_ext/name_error_extension_test.rb
+- test/edit_distance/jaro_winkler_test.rb
+- test/fixtures/book.rb
+- test/spell_checker_test.rb
+- test/spell_checking/class_name_check_test.rb
+- test/spell_checking/key_name_check_test.rb
+- test/spell_checking/method_name_check_test.rb
+- test/spell_checking/uncorrectable_name_check_test.rb
+- test/spell_checking/variable_name_check_test.rb
+- test/test_helper.rb
+- test/tree_spell_checker_test.rb
+- test/tree_spell_explore_test.rb
+- test/tree_spell_human_typo_test.rb
+- test/verbose_formatter_test.rb

data/test/fixtures/rspec_dir.yml

@@ -0,0 +1,112 @@
+---
+- spec/spec_helper.rb
+- spec/integration/suite_hooks_errors_spec.rb
+- spec/integration/filtering_spec.rb
+- spec/integration/spec_file_load_errors_spec.rb
+- spec/integration/failed_line_detection_spec.rb
+- spec/integration/persistence_failures_spec.rb
+- spec/integration/bisect_runners_spec.rb
+- spec/integration/order_spec.rb
+- spec/integration/fail_if_no_examples_spec.rb
+- spec/integration/bisect_spec.rb
+- spec/integration/output_stream_spec.rb
+- spec/support/sandboxing.rb
+- spec/support/spec_files.rb
+- spec/support/fake_libs/json.rb
+- spec/support/fake_libs/open3.rb
+- spec/support/fake_libs/drb/acl.rb
+- spec/support/fake_libs/drb/drb.rb
+- spec/support/fake_libs/mocha/api.rb
+- spec/support/fake_libs/test/unit/assertions.rb
+- spec/support/fake_libs/flexmock/rspec.rb
+- spec/support/fake_libs/rake/tasklib.rb
+- spec/support/fake_libs/coderay.rb
+- spec/support/fake_libs/rr.rb
+- spec/support/fake_libs/rake.rb
+- spec/support/fake_libs/erb.rb
+- spec/support/fake_libs/rspec/mocks.rb
+- spec/support/fake_libs/rspec/expectations.rb
+- spec/support/fake_libs/minitest/assertions.rb
+- spec/support/fake_libs/minitest.rb
+- spec/support/matchers.rb
+- spec/support/runner_support.rb
+- spec/support/isolated_home_directory.rb
+- spec/support/config_options_helper.rb
+- spec/support/mathn_integration_support.rb
+- spec/support/helper_methods.rb
+- spec/support/formatter_support.rb
+- spec/support/fake_bisect_runner.rb
+- spec/support/shared_example_groups.rb
+- spec/support/aruba_support.rb
+- spec/rspec/core/runner_spec.rb
+- spec/rspec/core/did_you_mean_spec.rb
+- spec/rspec/core/drb_spec.rb
+- spec/rspec/core/metadata_spec.rb
+- spec/rspec/core/example_group_spec.rb
+- spec/rspec/core/configuration/only_failures_support_spec.rb
+- spec/rspec/core/rake_task_spec.rb
+- spec/rspec/core/memoized_helpers_spec.rb
+- spec/rspec/core/ordering_spec.rb
+- spec/rspec/core/option_parser_spec.rb
+- spec/rspec/core/example_execution_result_spec.rb
+- spec/rspec/core/suite_hooks_spec.rb
+- spec/rspec/core/set_spec.rb
+- spec/rspec/core/configuration_spec.rb
+- spec/rspec/core/rspec_matchers_spec.rb
+- spec/rspec/core/hooks_filtering_spec.rb
+- spec/rspec/core/bisect/shell_command_spec.rb
+- spec/rspec/core/bisect/server_spec.rb
+- spec/rspec/core/bisect/example_minimizer_spec.rb
+- spec/rspec/core/bisect/shell_runner_spec.rb
+- spec/rspec/core/bisect/utilities_spec.rb
+- spec/rspec/core/bisect/coordinator_spec.rb
+- spec/rspec/core/resources/a_foo.rb
+- spec/rspec/core/resources/formatter_specs.rb
+- spec/rspec/core/resources/inconsistently_ordered_specs.rb
+- spec/rspec/core/resources/a_bar.rb
+- spec/rspec/core/resources/utf8_encoded.rb
+- spec/rspec/core/resources/a_spec.rb
+- spec/rspec/core/resources/acceptance/bar.rb
+- spec/rspec/core/resources/acceptance/foo_spec.rb
+- spec/rspec/core/resources/custom_example_group_runner.rb
+- spec/rspec/core/failed_example_notification_spec.rb
+- spec/rspec/core/hooks_spec.rb
+- spec/rspec/core/formatters/profile_formatter_spec.rb
+- spec/rspec/core/formatters/deprecation_formatter_spec.rb
+- spec/rspec/core/formatters/syntax_highlighter_spec.rb
+- spec/rspec/core/formatters/base_text_formatter_spec.rb
+- spec/rspec/core/formatters/snippet_extractor_spec.rb
+- spec/rspec/core/formatters/progress_formatter_spec.rb
+- spec/rspec/core/formatters/html_snippet_extractor_spec.rb
+- spec/rspec/core/formatters/helpers_spec.rb
+- spec/rspec/core/formatters/html_formatter_spec.rb
+- spec/rspec/core/formatters/json_formatter_spec.rb
+- spec/rspec/core/formatters/documentation_formatter_spec.rb
+- spec/rspec/core/formatters/exception_presenter_spec.rb
+- spec/rspec/core/formatters/console_codes_spec.rb
+- spec/rspec/core/formatters/fallback_message_formatter_spec.rb
+- spec/rspec/core/invocations_spec.rb
+- spec/rspec/core/configuration_options_spec.rb
+- spec/rspec/core/pending_spec.rb
+- spec/rspec/core/profiler_spec.rb
+- spec/rspec/core/project_initializer_spec.rb
+- spec/rspec/core/aggregate_failures_spec.rb
+- spec/rspec/core/dsl_spec.rb
+- spec/rspec/core/ruby_project_spec.rb
+- spec/rspec/core/formatters_spec.rb
+- spec/rspec/core/metadata_filter_spec.rb
+- spec/rspec/core/example_group_constants_spec.rb
+- spec/rspec/core/world_spec.rb
+- spec/rspec/core/shared_context_spec.rb
+- spec/rspec/core/pending_example_spec.rb
+- spec/rspec/core/filter_manager_spec.rb
+- spec/rspec/core/shared_example_group_spec.rb
+- spec/rspec/core/example_status_persister_spec.rb
+- spec/rspec/core/backtrace_formatter_spec.rb
+- spec/rspec/core/output_wrapper_spec.rb
+- spec/rspec/core/example_spec.rb
+- spec/rspec/core/reporter_spec.rb
+- spec/rspec/core/filterable_item_repository_spec.rb
+- spec/rspec/core/notifications_spec.rb
+- spec/rspec/core/warnings_spec.rb
+- spec/rspec/core_spec.rb

data/test/helper.rb

@@ -0,0 +1,29 @@
+require 'test/unit'
+
+module DidYouMean
+  module TestHelper
+    class << self
+      attr_reader :root
+    end
+
+    if File.file?(File.expand_path('../lib/did_you_mean.rb', __dir__))
+      # In this case we're being run from inside the gem, so we just want to
+      # require the root of the library
+
+      @root = File.expand_path('../lib/did_you_mean', __dir__)
+      require_relative @root
+    else
+      # In this case we're being run from inside ruby core, and we want to
+      # include the experimental features in the test suite
+
+      @root = File.expand_path('../../lib/did_you_mean', __dir__)
+      require_relative @root
+      # We are excluding experimental features for now.
+      # require_relative File.join(@root, 'experimental')
+    end
+
+    def assert_correction(expected, array)
+      assert_equal Array(expected), array, "Expected #{array.inspect} to only include #{expected.inspect}"
+    end
+  end
+end