did_you_mean 1.3.0 → 1.6.1

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,33 @@
+require 'test/unit'
+
+module DidYouMean
+  module TestHelper
+    class << self
+      attr_reader :root
+
+      def ractor_compatible?
+        defined?(Ractor) && RUBY_VERSION >= "3.1.0"
+      end
+    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

data/test/spell_checking/{class_name_check_test.rb → test_class_name_check.rb}

@@ -1,4 +1,4 @@
-require 'test_helper'
+require_relative '../helper'
 
 module ACRONYM
 end
@@ -27,48 +27,52 @@ class Book
   end
 end
 
-class ClassNameCheckTest < Minitest::Test
+class ClassNameCheckTest < Test::Unit::TestCase
+  include DidYouMean::TestHelper
+
   def test_corrections
-    error = assert_raises(NameError) { ::Bo0k }
+    error = assert_raise(NameError) { ::Bo0k }
     assert_correction "Book", error.corrections
   end
 
   def test_corrections_include_case_specific_class_name
-    error = assert_raises(NameError) { ::Acronym }
+    error = assert_raise(NameError) { ::Acronym }
     assert_correction "ACRONYM", error.corrections
   end
 
   def test_corrections_include_top_level_class_name
-    error = assert_raises(NameError) { Project.bo0k }
+    error = assert_raise(NameError) { Project.bo0k }
     assert_correction "Book", error.corrections
   end
 
   def test_names_in_corrections_have_namespaces
-    error = assert_raises(NameError) { ::Book::TableofContents }
+    error = assert_raise(NameError) { ::Book::TableofContents }
     assert_correction "Book::TableOfContents", error.corrections
   end
 
   def test_corrections_candidates_for_names_in_upper_level_scopes
-    error = assert_raises(NameError) { Book::Page.tableof_contents }
+    error = assert_raise(NameError) { Book::Page.tableof_contents }
     assert_correction "Book::TableOfContents", error.corrections
   end
 
   def test_corrections_should_work_from_within_instance_method
-    error = assert_raises(NameError) { ::Book.new.tableof_contents }
+    error = assert_raise(NameError) { ::Book.new.tableof_contents }
     assert_correction "Book::TableOfContents", error.corrections
   end
 
   def test_corrections_should_work_from_within_instance_method_on_nested_class
-    error = assert_raises(NameError) { ::Book::Page.new.tableof_contents }
+    error = assert_raise(NameError) { ::Book::Page.new.tableof_contents }
     assert_correction "Book::TableOfContents", error.corrections
   end
 
   def test_does_not_suggest_user_input
-    error = assert_raises(NameError) { ::Book::Cover }
+    Book.send(:remove_const, :Spine) if Book.constants.include?(:Spine)
+
+    error = assert_raise(NameError) { ::Book::Spine }
 
     # This is a weird require, but in a multi-threaded condition, a constant may
     # be loaded between when a NameError occurred and when the spell checker
-    # attemps to find a possible suggestion. The manual require here simulates
+    # attempts to find a possible suggestion. The manual require here simulates
     # a race condition a single test.
     require_relative '../fixtures/book'
 

data/test/spell_checking/{key_name_check_test.rb → test_key_name_check.rb}

@@ -1,14 +1,16 @@
-require "test_helper"
+require_relative '../helper'
+
+class KeyNameCheckTest < Test::Unit::TestCase
+  include DidYouMean::TestHelper
 
-class KeyNameCheckTest < Minitest::Test
   def test_corrects_hash_key_name_with_fetch
     hash = { "foo" => 1, bar: 2 }
 
-    error = assert_raises(KeyError) { hash.fetch(:bax) }
+    error = assert_raise(KeyError) { hash.fetch(:bax) }
     assert_correction ":bar", error.corrections
     assert_match "Did you mean?  :bar", error.to_s
 
-    error = assert_raises(KeyError) { hash.fetch("fooo") }
+    error = assert_raise(KeyError) { hash.fetch("fooo") }
     assert_correction %("foo"), error.corrections
     assert_match %(Did you mean?  "foo"), error.to_s
   end
@@ -16,17 +18,25 @@ class KeyNameCheckTest < Minitest::Test
   def test_corrects_hash_key_name_with_fetch_values
     hash = { "foo" => 1, bar: 2 }
 
-    error = assert_raises(KeyError) { hash.fetch_values("foo", :bar, :bax) }
+    error = assert_raise(KeyError) { hash.fetch_values("foo", :bar, :bax) }
     assert_correction ":bar", error.corrections
     assert_match "Did you mean?  :bar", error.to_s
 
-    error = assert_raises(KeyError) { hash.fetch_values("foo", :bar, "fooo") }
+    error = assert_raise(KeyError) { hash.fetch_values("foo", :bar, "fooo") }
     assert_correction %("foo"), error.corrections
     assert_match %(Did you mean?  "foo"), error.to_s
   end
 
+  def test_correct_symbolized_hash_keys_with_string_value
+    hash = { foo_1: 1, bar_2: 2 }
+
+    error = assert_raise(KeyError) { hash.fetch('foo_1') }
+    assert_correction %(:foo_1), error.corrections
+    assert_match %(Did you mean?  :foo_1), error.to_s
+  end
+
   def test_corrects_sprintf_key_name
-    error = assert_raises(KeyError) { sprintf("%<foo>d", {fooo: 1}) }
+    error = assert_raise(KeyError) { sprintf("%<foo>d", {fooo: 1}) }
     assert_correction ":fooo", error.corrections
     assert_match "Did you mean?  :fooo", error.to_s
   end
@@ -34,7 +44,7 @@ class KeyNameCheckTest < Minitest::Test
   def test_corrects_env_key_name
     ENV["FOO"] = "1"
     ENV["BAR"] = "2"
-    error = assert_raises(KeyError) { ENV.fetch("BAX") }
+    error = assert_raise(KeyError) { ENV.fetch("BAX") }
     assert_correction %("BAR"), error.corrections
     assert_match %(Did you mean?  "BAR"), error.to_s
   ensure

data/test/spell_checking/{method_name_check_test.rb → test_method_name_check.rb}

@@ -1,6 +1,8 @@
-require 'test_helper'
+require_relative '../helper'
+
+class MethodNameCheckTest < Test::Unit::TestCase
+  include DidYouMean::TestHelper
 
-class MethodNameCheckTest < Minitest::Test
   class User
     def friends; end
     def first_name; end
@@ -36,50 +38,50 @@ class MethodNameCheckTest < Minitest::Test
   end
 
   def test_corrections_include_instance_method
-    error = assert_raises(NoMethodError){ @user.flrst_name }
+    error = assert_raise(NoMethodError){ @user.flrst_name }
 
     assert_correction :first_name, error.corrections
     assert_match "Did you mean?  first_name",  error.to_s
   end
 
   def test_corrections_include_private_method
-    error = assert_raises(NoMethodError){ @user.friend }
+    error = assert_raise(NoMethodError){ @user.friend }
 
     assert_correction :friends, error.corrections
     assert_match "Did you mean?  friends", error.to_s
   end
 
   def test_corrections_include_method_from_module
-    error = assert_raises(NoMethodError){ @user.fr0m_module }
+    error = assert_raise(NoMethodError){ @user.fr0m_module }
 
     assert_correction :from_module, error.corrections
     assert_match "Did you mean?  from_module", error.to_s
   end
 
   def test_corrections_include_class_method
-    error = assert_raises(NoMethodError){ User.l0ad }
+    error = assert_raise(NoMethodError){ User.l0ad }
 
     assert_correction :load, error.corrections
     assert_match "Did you mean?  load", error.to_s
   end
 
   def test_private_methods_should_not_be_suggested
-    error = assert_raises(NoMethodError){ User.new.the_protected_method }
+    error = assert_raise(NoMethodError){ User.new.the_protected_method }
     refute_includes error.corrections, :the_protected_method
 
-    error = assert_raises(NoMethodError){ User.new.the_private_method }
+    error = assert_raise(NoMethodError){ User.new.the_private_method }
     refute_includes error.corrections, :the_private_method
   end
 
   def test_corrections_when_private_method_is_called_with_args
-    error = assert_raises(NoMethodError){ @user.call_incorrect_private_method }
+    error = assert_raise(NoMethodError){ @user.call_incorrect_private_method }
 
     assert_correction :raise, error.corrections
     assert_match "Did you mean?  raise", error.to_s
   end
 
   def test_exclude_methods_on_nil
-    error = assert_raises(NoMethodError){ nil.map }
+    error = assert_raise(NoMethodError){ nil.map }
     assert_empty error.corrections
   end
 
@@ -87,14 +89,14 @@ class MethodNameCheckTest < Minitest::Test
     def nil.empty?
     end
 
-    error = assert_raises(NoMethodError){ nil.empty }
+    error = assert_raise(NoMethodError){ nil.empty }
     assert_correction :empty?, error.corrections
   ensure
     NilClass.class_eval { undef empty? }
   end
 
   def test_does_not_append_suggestions_twice
-    error = assert_raises NoMethodError do
+    error = assert_raise NoMethodError do
       begin
         @user.firstname
       rescue NoMethodError => e
@@ -106,7 +108,7 @@ class MethodNameCheckTest < Minitest::Test
   end
 
   def test_does_not_append_suggestions_three_times
-    error = assert_raises NoMethodError do
+    error = assert_raise NoMethodError do
       begin
         @user.raise_no_method_error
       rescue NoMethodError => e
@@ -117,10 +119,29 @@ class MethodNameCheckTest < Minitest::Test
     assert_equal 1, error.to_s.scan(/Did you mean/).count
   end
 
+  def test_suggests_corrections_on_nested_error
+    error = assert_raise NoMethodError do
+      begin
+        @user.firstname
+      rescue NoMethodError
+        @user.firstname
+      end
+    end
+
+    assert_equal 1, error.to_s.scan(/Did you mean/).count
+  end
+
   def test_suggests_yield
-    error = assert_raises(NoMethodError) { yeild(1) }
+    error = assert_raise(NoMethodError) { yeild(1) }
 
     assert_correction :yield, error.corrections
     assert_match "Did you mean?  yield", error.to_s
   end
+
+  def test_does_not_suggest_yield
+    error = assert_raise(NoMethodError) { 1.yeild }
+
+    assert_correction [], error.corrections
+    assert_not_match(/Did you mean\? +yield/, error.to_s)
+  end if RUBY_ENGINE != "jruby"
 end

data/test/spell_checking/test_pattern_key_name_check.rb

@@ -0,0 +1,20 @@
+require_relative '../helper'
+
+return if !defined?(::NoMatchingPatternKeyError)
+
+class PatternKeyNameCheckTest < Test::Unit::TestCase
+  include DidYouMean::TestHelper
+
+  def test_corrects_hash_key_name_with_single_pattern_match
+    error = assert_raise(NoMatchingPatternKeyError) do
+      eval(<<~RUBY, binding, __FILE__, __LINE__)
+        hash = {foo: 1, bar: 2, baz: 3}
+        hash => {fooo:}
+        fooo = 1 # suppress "unused variable: fooo" warning
+      RUBY
+    end
+
+    assert_correction ":foo", error.corrections
+    assert_match "Did you mean?  :foo", error.to_s
+  end
+end

data/test/spell_checking/test_require_path_check.rb

@@ -0,0 +1,32 @@
+require_relative '../helper'
+
+return if !(RUBY_VERSION >= '2.8.0')
+
+class RequirePathCheckTest < Test::Unit::TestCase
+  include DidYouMean::TestHelper
+
+  def test_load_error_from_require_has_suggestions
+    error = assert_raise LoadError do
+              require 'open_struct'
+            end
+
+    assert_correction 'ostruct', error.corrections
+    assert_match "Did you mean?  ostruct", error.to_s
+  end
+
+  def test_load_error_from_require_for_nested_files_has_suggestions
+    error = assert_raise LoadError do
+              require 'net/htt'
+            end
+
+    assert_correction 'net/http', error.corrections
+    assert_match "Did you mean?  net/http", error.to_s
+
+    error = assert_raise LoadError do
+              require 'net-http'
+            end
+
+    assert_correction ['net/http', 'net/https'], error.corrections
+    assert_match "Did you mean?  net/http", error.to_s
+  end
+end

data/test/spell_checking/test_uncorrectable_name_check.rb

@@ -0,0 +1,15 @@
+require_relative '../helper'
+
+class UncorrectableNameCheckTest < Test::Unit::TestCase
+  class FirstNameError < NameError; end
+
+  def setup
+    @error = assert_raise(FirstNameError) do
+      raise FirstNameError, "Other name error"
+    end
+  end
+
+  def test_message
+    assert_not_match(/Did you mean\?/, @error.message)
+  end
+end

data/test/spell_checking/{variable_name_check_test.rb → test_variable_name_check.rb}

@@ -1,6 +1,8 @@
-require 'test_helper'
+require_relative '../helper'
+
+class VariableNameCheckTest < Test::Unit::TestCase
+  include DidYouMean::TestHelper
 
-class VariableNameCheckTest < Minitest::Test
   class User
     def initialize
       @email_address = 'email_address@address.net'
@@ -27,7 +29,7 @@ class VariableNameCheckTest < Minitest::Test
   end
 
   def test_corrections_include_instance_method
-    error = assert_raises(NameError) do
+    error = assert_raise(NameError) do
       @user.instance_eval { flrst_name }
     end
 
@@ -41,7 +43,7 @@ class VariableNameCheckTest < Minitest::Test
   end
 
   def test_corrections_include_method_from_module
-    error = assert_raises(NameError) do
+    error = assert_raise(NameError) do
       @user.instance_eval { fr0m_module }
     end
 
@@ -50,29 +52,31 @@ class VariableNameCheckTest < Minitest::Test
   end
 
   def test_corrections_include_local_variable_name
-    person = person = nil
-    error = (eprson rescue $!) # Do not use @assert_raises here as it changes a scope.
+    if RUBY_ENGINE != "jruby"
+      person = person = nil
+      error = (eprson rescue $!) # Do not use @assert_raise here as it changes a scope.
 
-    assert_correction :person, error.corrections
-    assert_match "Did you mean?  person", error.to_s
+      assert_correction :person, error.corrections
+      assert_match "Did you mean?  person", error.to_s
+    end
   end
 
   def test_corrections_include_ruby_predefined_objects
-    some_var = nil
+    some_var = some_var = nil
 
-    false_error = assert_raises(NameError) do
+    false_error = assert_raise(NameError) do
       some_var = fals
     end
 
-    true_error = assert_raises(NameError) do
+    true_error = assert_raise(NameError) do
       some_var = treu
     end
 
-    nil_error = assert_raises(NameError) do
+    nil_error = assert_raise(NameError) do
       some_var = nul
     end
 
-    file_error = assert_raises(NameError) do
+    file_error = assert_raise(NameError) do
       __FIEL__
     end
 
@@ -90,21 +94,21 @@ class VariableNameCheckTest < Minitest::Test
   end
 
   def test_suggests_yield
-    error = assert_raises(NameError) { yeild }
+    error = assert_raise(NameError) { yeild }
 
     assert_correction :yield, error.corrections
     assert_match "Did you mean?  yield", error.to_s
   end
 
   def test_corrections_include_instance_variable_name
-    error = assert_raises(NameError){ @user.to_s }
+    error = assert_raise(NameError){ @user.to_s }
 
     assert_correction :@email_address, error.corrections
     assert_match "Did you mean?  @email_address", error.to_s
   end
 
   def test_corrections_include_private_method
-    error = assert_raises(NameError) do
+    error = assert_raise(NameError) do
       @user.instance_eval { cia_code_name }
     end
 
@@ -115,7 +119,7 @@ class VariableNameCheckTest < Minitest::Test
   @@does_exist = true
 
   def test_corrections_include_class_variable_name
-    error = assert_raises(NameError){ @@doesnt_exist }
+    error = assert_raise(NameError){ @@doesnt_exist }
 
     assert_correction :@@does_exist, error.corrections
     assert_match "Did you mean?  @@does_exist", error.to_s
@@ -123,14 +127,14 @@ class VariableNameCheckTest < Minitest::Test
 
   def test_struct_name_error
     value = Struct.new(:does_exist).new
-    error = assert_raises(NameError){ value[:doesnt_exist] }
+    error = assert_raise(NameError){ value[:doesnt_exist] }
 
     assert_correction [:does_exist, :does_exist=], error.corrections
     assert_match "Did you mean?  does_exist", error.to_s
   end
 
   def test_exclude_typical_incorrect_suggestions
-    error = assert_raises(NameError){ foo }
+    error = assert_raise(NameError){ foo }
     assert_empty error.corrections
   end
 end