did_you_mean 1.6.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8872d94ffdf1a826aa542768069af9a51087bc5156e54c277ccad671088724f
-  data.tar.gz: cd6c5001ef84b6618b488995b7c707dd88e9586df229067b25c6e4fb77c43882
+  metadata.gz: b4bab700f00029060d2483f4e158b67d5cc27bc76ead15422904bbfff21cdf59
+  data.tar.gz: 8826dd9596cdaf03dfb13a0dc044ceff7a4d774cd240d3a4b45d76cea3b0800f
 SHA512:
-  metadata.gz: 5c18bc93c847891f6061325c0a2f1f6b067af698adbd49a6b96172c1a7cda5f4fd96fbf7e9d5b1aeb1d0851caf702c28351239edc4c62f76b2ba919e6e686f2d
-  data.tar.gz: 9c6f42e8c30a6a803c42409192757ecf13f03398771e682d2cf98976a391e7a5976af38a8d5eea972fcc3560ff16e8dffbfa5e3cc2eef96228c2a2fbd8bea030
+  metadata.gz: bee82c9926dacf6600c08b16f1b7d0e0d58872a28e9dde55581c491a2abb3d3725a2fd6f3990a2bb0b6ded3936cde87806ab1c0db7f2f03f5612ff8c15c0518b
+  data.tar.gz: f56276fa0af2412ca6d86259b1f21e0654122ece7dd70200981594aa1d045b2fe3c115ed0495cb96ee2c7aaf25fc5daf6948be788f5f63b258691c2e5396407e

data/.github/workflows/ruby.yml

@@ -9,28 +9,35 @@ on:
       - 'master'
 
 jobs:
+  ruby-versions:
+    uses: ruby/actions/.github/workflows/ruby_versions.yml@master
+    with:
+      engine: cruby-jruby
+      min_version: 2.5
+
   build:
+    needs: ruby-versions
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby: [ '2.5', '2.6', '2.7', '3.0', 'ruby-head', 'jruby-9.2', 'jruby-head' ]
+        ruby: ${{ fromJson(needs.ruby-versions.outputs.versions) }}
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby }}
     - name: Build and test with Rake
       run: |
-        gem i test-unit
+        gem i test-unit test-unit-ruby-core
         RUBYOPT='--disable-did_you_mean' rake
 
   benchmark:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.7.1
+        ruby-version: 3.3.6
     - name: Test performance and accuracy
       run: |
         gem install bundler

data/CHANGELOG.md

@@ -1,3 +1,32 @@
+## v2.0.0
+
+_unreleased_
+
+#### 🚨 Breaking Changes
+
+- Removed deprecated constants for Ruby 3.4 (#194)
+
+#### ⭐️ New Features
+
+- Do not include a backtick in error messages and backtraces (#192, https://bugs.ruby-lang.org/issues/16495)
+
+#### 🐞 Bug Fixes
+
+- Do not use #inspect to avoid unexpected performance degradation (bd11eefd6cc724919dd645965856966744a554c6)
+
+## 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>_

data/Gemfile

@@ -8,3 +8,8 @@ gem 'benchmark_driver'
 gem 'memory_profiler'
 gem 'jaro_winkler', '>= 1.4.0'
 gem 'test-unit'
+gem "test-unit-ruby-core"
+
+group :development do
+  gem "rake"
+end

data/Rakefile

@@ -21,13 +21,6 @@ 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/appveyor.yml

@@ -20,6 +20,7 @@ before_test:
   - gem -v
   - bundle -v
   - gem uni did_you_mean
+  - gem i test-unit-ruby-core
 
 test_script:
   - rake

data/did_you_mean.gemspec

@@ -22,6 +22,4 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.required_ruby_version = '>= 2.5.0'
-
-  spec.add_development_dependency "rake"
 end

data/lib/did_you_mean/jaro_winkler.rb

@@ -8,8 +8,7 @@ module DidYouMean
 
       m          = 0.0
       t          = 0.0
-      range      = (length2 / 2).floor - 1
-      range      = 0 if range < 0
+      range      = length2 > 3 ? length2 / 2 - 1 : 0
       flags1     = 0
       flags2     = 0
 
@@ -72,10 +71,8 @@ module DidYouMean
         codepoints2  = str2.codepoints
         prefix_bonus = 0
 
-        i = 0
         str1.each_codepoint do |char1|
-          char1 == codepoints2[i] && i < 4 ? prefix_bonus += 1 : break
-          i += 1
+          char1 == codepoints2[prefix_bonus] && prefix_bonus < 4 ? prefix_bonus += 1 : break
         end
 
         jaro_distance + (prefix_bonus * WEIGHT * (1 - jaro_distance))

data/lib/did_you_mean/spell_checkers/key_error_checker.rb

@@ -14,7 +14,15 @@ module DidYouMean
     private
 
     def exact_matches
-      @exact_matches ||= @keys.select { |word| @key == word.to_s }.map(&:inspect)
+      @exact_matches ||= @keys.select { |word| @key == word.to_s }.map { |obj| format_object(obj) }
+    end
+
+    def format_object(symbol_or_object)
+      if symbol_or_object.is_a?(Symbol)
+        ":#{symbol_or_object}"
+      else
+        symbol_or_object.to_s
+      end
     end
   end
 end

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/pattern_key_name_checker.rb

@@ -14,7 +14,15 @@ module DidYouMean
     private
 
     def exact_matches
-      @exact_matches ||= @keys.select { |word| @key == word.to_s }.map(&:inspect)
+      @exact_matches ||= @keys.select { |word| @key == word.to_s }.map { |obj| format_object(obj) }
+    end
+
+    def format_object(symbol_or_object)
+      if symbol_or_object.is_a?(Symbol)
+        ":#{symbol_or_object}"
+      else
+        symbol_or_object.to_s
+      end
     end
   end
 end

data/lib/did_you_mean/version.rb

@@ -1,3 +1,3 @@
 module DidYouMean
-  VERSION = "1.6.2".freeze
+  VERSION = "2.0.0".freeze
 end

data/lib/did_you_mean.rb

@@ -113,30 +113,6 @@ module DidYouMean
   correct_error LoadError, RequirePathChecker if RUBY_VERSION >= '2.8.0'
   correct_error NoMatchingPatternKeyError, PatternKeyNameChecker if defined?(::NoMatchingPatternKeyError)
 
-  # TODO: Remove on 3.3:
-  class DeprecatedMapping # :nodoc:
-    def []=(key, value)
-      warn "Calling `DidYouMean::SPELL_CHECKERS[#{key.to_s}] = #{value.to_s}' has been deprecated. " \
-           "Please call `DidYouMean.correct_error(#{key.to_s}, #{value.to_s})' instead."
-
-      DidYouMean.correct_error(key, value)
-    end
-
-    def merge!(hash)
-      warn "Calling `DidYouMean::SPELL_CHECKERS.merge!(error_name => spell_checker)' has been deprecated. " \
-           "Please call `DidYouMean.correct_error(error_name, spell_checker)' instead."
-
-      hash.each do |error_class, spell_checker|
-        DidYouMean.correct_error(error_class, spell_checker)
-      end
-    end
-  end
-
-  # TODO: Remove on 3.3:
-  SPELL_CHECKERS = DeprecatedMapping.new
-  deprecate_constant :SPELL_CHECKERS
-  private_constant :DeprecatedMapping
-
   # Returns the currently set formatter. By default, it is set to +DidYouMean::Formatter+.
   def self.formatter
     if defined?(Ractor)

data/test/core_ext/test_name_error_extension.rb

@@ -49,7 +49,7 @@ class NameErrorExtensionTest < Test::Unit::TestCase
 
     get_message(error)
 
-    assert_equal "undefined method `sizee' for #<File:test_name_error_extension.rb (closed)>",
-                 Marshal.load(Marshal.dump(error)).original_message
+    assert_match(/^undefined method [`']sizee' for /,
+                 Marshal.load(Marshal.dump(error)).original_message)
   end
 end

data/test/lib/helper.rb

@@ -1,3 +1,3 @@
 require "test/unit"
-require_relative "core_assertions"
+require "core_assertions"
 Test::Unit::TestCase.include Test::Unit::CoreAssertions

data/test/spell_checking/test_method_name_check.rb

@@ -4,6 +4,8 @@ class MethodNameCheckTest < Test::Unit::TestCase
   include DidYouMean::TestHelper
 
   class User
+    attr_writer :writer
+    attr_reader :reader
     def friends; end
     def first_name; end
     def descendants; end
@@ -144,4 +146,20 @@ class MethodNameCheckTest < Test::Unit::TestCase
     assert_correction [], error.corrections
     assert_not_match(/Did you mean\? +yield/, get_message(error))
   end if RUBY_ENGINE != "jruby"
+
+  # Do not suggest `name=` for `name`
+  def test_does_not_suggest_writer
+    error = assert_raise(NoMethodError) { @user.writer }
+
+    assert_correction [], error.corrections
+    assert_not_match(/Did you mean\?  writer=/, get_message(error))
+  end
+
+  # Do not suggest `name` for `name=`
+  def test_does_not_suggest_reader
+    error = assert_raise(NoMethodError) { @user.reader = 1 }
+
+    assert_correction [], error.corrections
+    assert_not_match(/Did you mean\?  reader/, get_message(error))
+  end
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: did_you_mean
 version: !ruby/object:Gem::Version
-  version: 1.6.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Yuki Nishijima
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-05 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+date: 2024-12-04 00:00:00.000000000 Z
+dependencies: []
 description: The gem that has been saving people from typos since 2014.
 email:
 - mail@yukinishijima.net
@@ -79,9 +65,6 @@ files:
 - test/fixtures/mini_dir.yml
 - test/fixtures/rspec_dir.yml
 - test/helper.rb
-- test/lib/core_assertions.rb
-- test/lib/envutil.rb
-- test/lib/find_executable.rb
 - test/lib/helper.rb
 - test/spell_checking/test_class_name_check.rb
 - test/spell_checking/test_key_name_check.rb
@@ -117,7 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.0.dev
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: '"Did you mean?" experience in Ruby'
@@ -128,9 +111,6 @@ test_files:
 - test/fixtures/mini_dir.yml
 - test/fixtures/rspec_dir.yml
 - test/helper.rb
-- test/lib/core_assertions.rb
-- test/lib/envutil.rb
-- test/lib/find_executable.rb
 - test/lib/helper.rb
 - test/spell_checking/test_class_name_check.rb
 - test/spell_checking/test_key_name_check.rb