did_you_mean 1.6.1 → 1.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5179422bf1ff107c7189cb5e75e44f1cd8d44c2e305cbd46f1c262011fe46add
-  data.tar.gz: ea8103ee404f2bed7e002efb615b9a1c26b8080284fac57929276b72fa5cb0c5
+  metadata.gz: efe3eda9f13dc6e837711f29799ee6701771200e75f11017c1f18cc521de10ca
+  data.tar.gz: 96476669d502e64083fa91cbbb7c91c583228b86f34ea0b22929bf38c931ee6e
 SHA512:
-  metadata.gz: 45ee6a7e79a463743a5529f38b503c78266458b07fe2e8a85d8f4e0ece2c65dbc40baf0aaa96c4c6592bca868c4a99f9d6001f4b5b9c033bf504aedb34ba5340
-  data.tar.gz: f259d9fef544f4071733007277c672c16f95bbe0e7d303bc6bf52fa0d7fa7108dcf615d6502e7950d2b48e4ce720034cc2d23096d52bee6f03e7206eab02569b
+  metadata.gz: 2697751c0b6ba2afa9153b41c306118fddd7ce584cdb9de9f71974cf924d83208fdb47a307e1ee4ea6161b63641334ea7ff1ca58fff0e141116809d6690e254b
+  data.tar.gz: 1cd6e82755d1d66c9503fc5ff3f6c42931860edb3fbb11c94c1411317ddffaa1ba1f0e7020cc1ad553cb0ad26195e6ab897a0c88a8fad58cad779d008f38bbb1

data/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: 'github-actions'
+    directory: '/'
+    schedule:
+      interval: 'weekly'

data/.github/workflows/ruby.yml

@@ -13,9 +13,9 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby: [ '2.5', '2.6', '2.7', '3.0', 'ruby-head', 'jruby-9.2', 'jruby-head' ]
+        ruby: [ '2.5', '2.6', '2.7', '3.0', '3.1', 'ruby-head', 'jruby-9.2', 'jruby-9.3', 'jruby-head' ]
     steps:
-    - uses: actions/checkout@v1
+    - uses: actions/checkout@v3
     - uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby }}
@@ -27,10 +27,10 @@ jobs:
   benchmark:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v1
+    - uses: actions/checkout@v3
     - uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.7.1
+        ruby-version: 3.1.3
     - name: Test performance and accuracy
       run: |
         gem install bundler

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## v1.6.3
+
+_<sup>released at 2022-12-19 5:57:00 UTC</sup>_
+
+- Do not suggest #name= for #name.
+
+## v1.6.2
+
+_<sup>released at 2022-12-05 10:29:20 UTC</sup>_
+
+- Define Exception#detailed_message instead of clobbering #message
+- Fixed correction duplicates in VaribaleNameChecker
+
 ## v1.6.1
 
 _<sup>released at 2020-12-22 13:22:35 UTC</sup>_
@@ -5,7 +18,7 @@ _<sup>released at 2020-12-22 13:22:35 UTC</sup>_
 #### Deprecations
 
 - Deprecate custom formatters to reduce complexity for Ractor support.
-- Deprecate access to the `DidYouMean::SPELL_CHECEKRS` constant for Ractor support.
+- Deprecate access to the `DidYouMean::SPELL_CHECKERS` constant for Ractor support.
 
 #### Features
 

data/Rakefile

@@ -2,12 +2,12 @@ require 'bundler/gem_tasks'
 require 'rake/testtask'
 
 Rake::TestTask.new do |task|
-  task.libs << "test"
+  task.libs << "test/lib" << "test"
 
   task.test_files = Dir['test/**/test_*.rb'].reject {|path| path.end_with?("test_explore.rb") }
   task.verbose    = true
   task.warning    = true
-  task.ruby_opts  = %w[ --disable-did_you_mean ]
+  task.ruby_opts  = %w[ --disable-did_you_mean -rhelper ]
 end
 
 Rake::TestTask.new("test:explore") do |task|
@@ -21,6 +21,13 @@ end
 
 task default: %i(test)
 
+task :sync_tool do
+  require 'fileutils'
+  FileUtils.cp "../ruby/tool/lib/core_assertions.rb", "./test/lib"
+  FileUtils.cp "../ruby/tool/lib/envutil.rb", "./test/lib"
+  FileUtils.cp "../ruby/tool/lib/find_executable.rb", "./test/lib"
+end
+
 namespace :test do
   namespace :accuracy do
     desc "Download Wiktionary's Simple English data and save it as a dictionary"

data/lib/did_you_mean/core_ext/name_error.rb

@@ -1,24 +1,49 @@
 module DidYouMean
   module Correctable
-    SKIP_TO_S_FOR_SUPER_LOOKUP = true
-    private_constant :SKIP_TO_S_FOR_SUPER_LOOKUP
+    if Exception.method_defined?(:detailed_message)
+      # just for compatibility
+      def original_message
+        # we cannot use alias here because
+        to_s
+      end
+
+      def detailed_message(highlight: true, did_you_mean: true, **)
+        msg = super.dup
+
+        return msg unless did_you_mean
+
+        suggestion = DidYouMean.formatter.message_for(corrections)
+
+        if highlight
+          suggestion = suggestion.gsub(/.+/) { "\e[1m" + $& + "\e[m" }
+        end
 
-    def original_message
-      meth = method(:to_s)
-      while meth.owner.const_defined?(:SKIP_TO_S_FOR_SUPER_LOOKUP)
-        meth = meth.super_method
+        msg << suggestion
+        msg
+      rescue
+        super
+      end
+    else
+      SKIP_TO_S_FOR_SUPER_LOOKUP = true
+      private_constant :SKIP_TO_S_FOR_SUPER_LOOKUP
+
+      def original_message
+        meth = method(:to_s)
+        while meth.owner.const_defined?(:SKIP_TO_S_FOR_SUPER_LOOKUP)
+          meth = meth.super_method
+        end
+        meth.call
       end
-      meth.call
-    end
 
-    def to_s
-      msg = super.dup
-      suggestion = DidYouMean.formatter.message_for(corrections)
+      def to_s
+        msg = super.dup
+        suggestion = DidYouMean.formatter.message_for(corrections)
 
-      msg << suggestion if !msg.include?(suggestion)
-      msg
-    rescue
-      super
+        msg << suggestion if !msg.include?(suggestion)
+        msg
+      rescue
+        super
+      end
     end
 
     def corrections

data/lib/did_you_mean/formatters/verbose_formatter.rb

@@ -1,8 +1,9 @@
+# frozen-string-literal: true
+
 warn "`require 'did_you_mean/formatters/verbose_formatter'` is deprecated and falls back to the default formatter. "
 
 require_relative '../formatter'
 
-# frozen-string-literal: true
 module DidYouMean
   # For compatibility:
   VerboseFormatter = Formatter

data/lib/did_you_mean/spell_checkers/method_name_checker.rb

@@ -59,6 +59,13 @@ module DidYouMean
         method_names = receiver.methods + receiver.singleton_methods
         method_names += receiver.private_methods if @private_call
         method_names.uniq!
+        # Assume that people trying to use a writer are not interested in a reader
+        # and vice versa
+        if method_name.match?(/=\Z/)
+          method_names.select! { |name| name.match?(/=\Z/) }
+        else
+          method_names.reject! { |name| name.match?(/=\Z/) }
+        end
         method_names
       else
         []

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

@@ -79,7 +79,7 @@ module DidYouMean
     def corrections
       @corrections ||= SpellChecker
                      .new(dictionary: (RB_RESERVED_WORDS + lvar_names + method_names + ivar_names + cvar_names))
-                     .correct(name) - NAMES_TO_EXCLUDE[@name]
+                     .correct(name).uniq - NAMES_TO_EXCLUDE[@name]
     end
   end
 end

data/lib/did_you_mean/version.rb

@@ -1,3 +1,3 @@
 module DidYouMean
-  VERSION = "1.6.1".freeze
+  VERSION = "1.6.3".freeze
 end

data/test/core_ext/test_name_error_extension.rb

@@ -1,6 +1,8 @@
 require_relative '../helper'
 
 class NameErrorExtensionTest < Test::Unit::TestCase
+  include DidYouMean::TestHelper
+
   SPELL_CHECKERS = DidYouMean.spell_checkers
 
   class TestSpellChecker
@@ -20,8 +22,12 @@ class NameErrorExtensionTest < Test::Unit::TestCase
   end
 
   def test_message
-    assert_match(/Did you mean\?  does_exist/, @error.to_s)
-    assert_match(/Did you mean\?  does_exist/, @error.message)
+    if Exception.method_defined?(:detailed_message)
+      assert_match(/Did you mean\?  does_exist/, @error.detailed_message)
+    else
+      assert_match(/Did you mean\?  does_exist/, @error.to_s)
+      assert_match(/Did you mean\?  does_exist/, @error.message)
+    end
   end
 
   def test_to_s_does_not_make_disruptive_changes_to_error_message
@@ -29,8 +35,8 @@ class NameErrorExtensionTest < Test::Unit::TestCase
       raise NameError, "uninitialized constant Object"
     end
 
-    error.to_s
-    assert_equal 1, error.to_s.scan("Did you mean?").count
+    get_message(error)
+    assert_equal 1, get_message(error).scan("Did you mean?").count
   end
 
   def test_correctable_error_objects_are_dumpable
@@ -41,7 +47,7 @@ class NameErrorExtensionTest < Test::Unit::TestCase
         e
       end
 
-    error.to_s
+    get_message(error)
 
     assert_equal "undefined method `sizee' for #<File:test_name_error_extension.rb (closed)>",
                  Marshal.load(Marshal.dump(error)).original_message

data/test/helper.rb

@@ -29,5 +29,15 @@ module DidYouMean
     def assert_correction(expected, array)
       assert_equal Array(expected), array, "Expected #{array.inspect} to only include #{expected.inspect}"
     end
+
+    def get_message(err)
+      if err.respond_to?(:detailed_message)
+        err.detailed_message(highlight: false)
+      else
+        err.to_s
+      end
+    end
+
+    module_function :get_message
   end
 end