did_you_mean 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50bf04523f12cc4556ea28643d05f957a6ed95288d022716bbd32b325ea10feb
-  data.tar.gz: eeb093d01d27dae887f7ecbc5e4c530db5230743de2c7280b19f139f56e11638
+  metadata.gz: '088f268582576b904e0d73ca3efc4d0f5b1f1b0502a215215e0d7a93d8e3fd27'
+  data.tar.gz: fa0582301402135a7ea58e974a9314ec4aeb0f4866d18233bbd8d68e2354d24b
 SHA512:
-  metadata.gz: '0941cfdae93b66e3485c0850f2763c869971a1d7cff386fe66d51739d8869155d8ae868016210a0d2935f81aa8185477c9db162029d5a754240f210a2f3b9df8'
-  data.tar.gz: fc53dbc6ae27025325d36084b5be82f0b462addc83a3fa7a0b0b780b6aed2b2dc5f40cc3a3ad7213eeb2a03476723f0ae36681a534d27b9991c95d5ab2197b66
+  metadata.gz: 176153acc0119212a3cff509cc5abefed1ae8ae0a99a92131882242b5a4f0dd7a5dcddf3da7aff492c0d00bfa3ea2c155f549c4430b36775ed7d66de0cf1dd9a
+  data.tar.gz: 24b2ae0af79e1a359e25174412a431d53a122a5cce658e02c1c511ebfeab17708b86e62fb8a9a66b79334d5ea6788ca3972ed2bc30a1b1a2092eb105d5fe6331

data/.travis.yml

@@ -12,4 +12,12 @@ after_success:
 
 rvm:
   - 2.5.3
+  - 2.6.0
   - ruby-head
+  - jruby-9.2.5.0
+  - jruby-head
+
+matrix:
+  allow_failures:
+    - rvm: jruby-9.2.5.0
+    - rvm: jruby-head

data/CHANGELOG.md

@@ -1,3 +1,41 @@
+## v1.4.0 (Next)
+
+- Remove the empty `tmp/` directory to comply with `rpmlint` ([#122](https://github.com/yuki24/did_you_mean/issues/122))
+- Fixes a bug where suggestions are not shown on subsequent errors ([#120](https://github.com/yuki24/did_you_mean/issues/120))
+
+## [v1.3.0](https://github.com/yuki24/did_you_mean/tree/v1.3.0)
+
+_<sup>released at 2018-12-18 15:37:10 UTC</sup>_
+
+**Starting version 1.3, the `did_you_mean` gem will be compatible with 2.6 and 2.5, and we will try to keep all subsequent versions compatible with Ruby 2.5 on an best-effort basis.**
+
+- Version 1.2.0 only has support for Ruby 2.5.0 and later as it uses new features that are only available in 2.5.
+- Versions earlier than 1.1.\* will still be maintained until Ruby 2.4 is deprecated.
+- Versions earlier than 1.0.\* is still maintained, but are likely to be deprecated as Ruby 2.3 will (probably) be deprecated in 2019.
+- Support for versions below 1.0 has already ended.
+
+#### New features
+
+- Suggest reserved words if there are close matches ([<tt>2a082a7</tt>](https://github.com/yuki24/did_you_mean/commit/2a082a71991f5afe2e27ce9538103eac4c428025))
+
+    ```ruby
+    results = yiedl
+    # NameError => undefined local variable or method `yiedl' for ...
+    # Did you mean? yield
+    ```
+
+#### Bug fixes
+
+- Fixes a bug where name errors can not be dumped ([#108](https://github.com/yuki24/did_you_mean/issues/108), [@jessebs](https://github.com/jessebs))
+
+## [v1.2.2](https://github.com/yuki24/did_you_mean/tree/v1.2.2)
+
+_<sup>released at 2019-03-09 23:17:22 UTC</sup>_
+
+#### Bug fixes
+
+- Fixes a bug where name errors can not be dumped ([#108](https://github.com/yuki24/did_you_mean/issues/108), [@jessebs](https://github.com/jessebs))
+
 ## [v1.2.1](https://github.com/yuki24/did_you_mean/tree/v1.2.1)
 
 _<sup>released at 2018-04-03 04:44:47 UTC</sup>_
@@ -23,6 +61,15 @@ _<sup>released at 2018-01-02 20:49:35 UTC</sup>_
 - Now suggests `true`, `false` or `nil` if a NameError occurs because of a typo in these names ([#94](https://github.com/yuki24/did_you_mean/pull/94), [@styd](https://github.com/styd))
 - New Formatter API: This provides a clean way to customize DidYouMean’s formatter without overriding the default formatter. Please refer to [the built-in verbose formatter](https://github.com/yuki24/did_you_mean/blob/671cdff/lib/did_you_mean/verbose.rb) for how to use it
 
+## [v1.1.3](https://github.com/yuki24/did_you_mean/tree/v1.1.3)
+
+_<sup>released at 2019-03-09 23:16:54 UTC</sup>_
+
+#### Bug fixes
+
+- Fixes a bug where name errors can not be dumped ([#108](https://github.com/yuki24/did_you_mean/issues/108), [@jessebs](https://github.com/jessebs))
+- Fixed a bug where DYM suggests the same class name in the error message ([#102](https://github.com/yuki24/did_you_mean/issues/102), [@schneems](https://github.com/schneems))
+
 ## [v1.1.2](https://github.com/yuki24/did_you_mean/tree/v1.1.2)
 
 _<sup>released at 2017-09-24 07:28:48 UTC</sup>_
@@ -69,6 +116,15 @@ The version `1.1.0` only has support for Ruby 2.4.0 and later. Also, all patch r
 
 - Fixed a bug where private method names were added to the dictionary when an argument was passed in to a public method. Use the `NoMethodError#private_call?` method instead ([<tt>0a1b761</tt>](https://github.com/yuki24/did_you_mean/commit/0a1b7612252055e583a373b473932f789381ca0f))
 
+## [v1.0.4](https://github.com/yuki24/did_you_mean/tree/v1.0.4)
+
+_<sup>released at 2019-03-09 23:16:38 UTC</sup>_
+
+#### Bug fixes
+
+- Fixes a bug where name errors can not be dumped ([#108](https://github.com/yuki24/did_you_mean/issues/108), [@jessebs](https://github.com/jessebs))
+- Fixed a bug where DYM suggests the same class name in the error message ([#102](https://github.com/yuki24/did_you_mean/issues/102), [@schneems](https://github.com/schneems))
+
 ## [v1.0.3](https://github.com/yuki24/did_you_mean/tree/v1.0.3)
 
 _<sup>released at 2017-09-24 07:22:07 UTC</sup>_

data/Gemfile

@@ -4,5 +4,6 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'benchmark-ips'
+gem 'benchmark-driver'
 gem 'memory_profiler'
 gem 'jaro_winkler', '>= 1.4.0'

data/README.md

@@ -108,6 +108,17 @@ OBject
 #
 ```
 
+## Using the `DidYouMean::SpellChecker`
+
+If you need to programmatically find the closest matches to the user input, you could do so by re-using the `DidYouMean::SpellChecker` object.
+
+```ruby
+spell_checker = DidYouMean::SpellChecker.new(dictionary: ['email', 'fail', 'eval'])
+
+spell_checker.correct('meail') # => ['email']
+spell_checker.correct('afil')  # => ['fail']
+```
+
 ## Disabling `did_you_mean`
 
 Occasionally, you may want to disable the `did_you_mean` gem for e.g. debugging issues in the error object itself. You
@@ -147,6 +158,29 @@ no_method_error.original_message
 # => NoMethodError (undefined method `zeor?' for 1:Integer)
 ```
 
+## Benchmarking
+
+Performance is very important as the `did_you_mean` gem attempts to find the closest matches on the fly right after an exception
+is thrown. You could use the following rake tasks to get insights into how the gem performs:
+
+```bash
+bundle exec rake benchmark:ips:jaro
+bundle exec rake benchmark:ips:levenshtein
+bundle exec rake benchmark:memory
+bundle exec rake benchmark:memory:jaro
+bundle exec rake benchmark:memory:levenshtein
+```
+
+**Be sure to always use `bundle exec` otherwise it will activate the pre-installed version of the `did_you_mean`
+ gem rather than using what's in the `lib/`.**
+
+You could also use the [`benchmark-driver`](https://github.com/benchmark-driver/benchmark-driver) gem to know how each
+Ruby performs differently.
+
+```bash
+bundle exec benchmark-driver benchmark/speed.yml --rbenv '2.6.0 --jit;2.6.0;2.5.3;truffleruby-1.0.0-rc10' --run-duration 30
+```
+
 ## Contributing
 
 1. Fork it (http://github.com/yuki24/did_you_mean/fork)

data/Rakefile

@@ -27,7 +27,7 @@ namespace :test do
     end
   end
 
-  desc "Calculate accuracy of the gems' spell checker"
+  desc "Calculate accuracy of the gem's spell checker"
   task :accuracy do
     if !File.exist?("evaluation/dictionary.yml")
       puts 'Generating dictionary for evaluation:'
@@ -40,8 +40,32 @@ namespace :test do
 end
 
 namespace :benchmark do
-  desc "Measure memory usage by the did_you_mean gem"
+  namespace :ips do
+    desc "Measure performance of the gem's Jaro distance implementation"
+    task :jaro do
+      sh "ruby benchmark/jaro_winkler/speed.rb"
+    end
+
+    desc "Benchmark performance of the gem's Levenshtein distance implementation"
+    task :levenshtein do
+      sh "ruby benchmark/levenshtein/speed.rb"
+    end
+  end
+
+  desc "Benchmark memory usage in the gem's spell checker"
   task :memory do
-    sh 'ruby benchmark/memory_usage.rb'
+    sh "ruby benchmark/memory_usage.rb"
+  end
+
+  namespace :memory do
+    desc "Benchmark memory usage in the gem's Jaro distance implementation"
+    task :jaro do
+      sh "ruby benchmark/jaro_winkler/memory_usage.rb"
+    end
+
+    desc "Benchmark memory usage in the gem's Levenshtein distance implementation"
+    task :levenshtein do
+      sh "ruby benchmark/levenshtein/memory_usage.rb"
+    end
   end
 end

data/benchmark/jaro_winkler/memory_usage.rb

@@ -1,11 +1,11 @@
+# frozen-string-literal: true
+
 require 'memory_profiler'
 require 'did_you_mean/jaro_winkler'
 
-str1, str2 = "user_signed_in?", "user_logged_in?"
-
 report = MemoryProfiler.report do
-  80.times do
-    DidYouMean::Jaro.distance str1, str2
+  1000.times do
+    DidYouMean::Jaro.distance "user_signed_in?", "user_logged_in?"
   end
 end
 

data/benchmark/jaro_winkler/speed.rb

@@ -1,14 +1,22 @@
+# frozen-string-literal: true
+
 require 'benchmark/ips'
-require 'did_you_mean'
+require 'did_you_mean/jaro_winkler'
 
 Benchmark.ips do |x|
-  x.report "before" do
-    DidYouMean::Jaro.before_distance "user_signed_in?", "user_logged_in?"
+  x.report "original" do
+    DidYouMean::Jaro.distance "user_signed_in?", "user_logged_in?"
   end
 
-  x.report "after" do
-    DidYouMean::Jaro.after_distance "user_signed_in?", "user_logged_in?"
-  end
+  # This #proposed method is not defined. Write your own method using this
+  # name so we can reliably run the benchmark and measure the difference.
+  #
+  # Alternatively, you could directly update the #distance method and remove
+  # this completely.
+  #
+  # x.report "proposed" do
+  #   DidYouMean::Jaro.proposed "user_signed_in?", "user_logged_in?"
+  # end
 
   x.compare!
 end

data/benchmark/levenshtein/memory_usage.rb

@@ -1,11 +1,11 @@
+# frozen-string-literal: true
+
 require 'memory_profiler'
 require 'did_you_mean/levenshtein'
 
-str1, str2 = "user_signed_in?", "user_logged_in?"
-
 report = MemoryProfiler.report do
-  80.times do
-    DidYouMean::Levenshtein.distance str1, str2
+  1000.times do
+    DidYouMean::Levenshtein.distance "user_signed_in?", "user_logged_in?"
   end
 end
 

data/benchmark/levenshtein/speed.rb

@@ -1,17 +1,22 @@
+# frozen-string-literal: true
+
 require 'benchmark/ips'
-require 'did_you_mean'
 require 'did_you_mean/levenshtein'
 
-STR1, STR2 = "user_signed_in?", "user_logged_in?"
-
 Benchmark.ips do |x|
-  x.report "enumerable" do
-    DidYouMean::Levenshtein.before_distance STR1, STR2
+  x.report "original" do
+    DidYouMean::Levenshtein.distance "user_signed_in?", "user_logged_in?"
   end
 
-  x.report "while" do
-    DidYouMean::Levenshtein.after_distance STR1, STR2
-  end
+  # This #proposed method is not defined. Write your own method using this
+  # name so we can reliably run the benchmark and measure the difference.
+  #
+  # Alternatively, you could directly update the #distance method and remove
+  # this completely.
+  #
+  # x.report "proposed" do
+  #   DidYouMean::Levenshtein.proposed "user_signed_in?", "user_logged_in?"
+  # end
 
   x.compare!
 end

data/benchmark/speed.yml

@@ -0,0 +1,13 @@
+prelude: |
+  require 'did_you_mean/spell_checker'
+
+  str1, str2 = "user_signed_in?", "user_logged_in?"
+  METHODS    = ''.methods
+  INPUT      = 'starts_with?'
+  collection = DidYouMean::SpellChecker.new(dictionary: METHODS)
+
+benchmark:
+  Jaro:          DidYouMean::Jaro.distance(str1, str2)
+  Jaro Winkler:  DidYouMean::JaroWinkler.distance(str1, str2)
+  Levenshtein:   DidYouMean::Levenshtein.distance(str1, str2)
+  Spell checker: collection.correct(INPUT)

data/lib/did_you_mean/core_ext/name_error.rb

@@ -6,11 +6,9 @@ module DidYouMean
 
     def to_s
       msg = super.dup
+      suggestion = DidYouMean.formatter.message_for(corrections)
 
-      if !cause.respond_to?(:corrections) || cause.corrections.empty?
-        msg << DidYouMean.formatter.message_for(corrections)
-      end
-
+      msg << suggestion if !msg.end_with?(suggestion)
       msg
     rescue
       super

data/lib/did_you_mean/spell_checker.rb

@@ -38,13 +38,7 @@ module DidYouMean
     private
 
     def normalize(str_or_symbol) #:nodoc:
-      str = if str_or_symbol.is_a?(String)
-              str_or_symbol.dup
-            else
-              str_or_symbol.to_s
-            end
-
-      str.downcase!
+      str = str_or_symbol.to_s.downcase
       str.tr!("@", "")
       str
     end

data/lib/did_you_mean/spell_checkers/method_name_checker.rb

@@ -9,7 +9,7 @@ module DidYouMean
 
     # +MethodNameChecker::RB_RESERVED_WORDS+ is the list of reserved words in
     # Ruby that take an argument. Unlike
-    # +VariableNameChecker::RB_RESERVED_WORDS+, those reserved words reqquires
+    # +VariableNameChecker::RB_RESERVED_WORDS+, these reserved words require
     # an argument, and a +NoMethodError+ is raised due to the presence of the
     # argument.
     #

data/lib/did_you_mean/version.rb

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

data/test/core_ext/name_error_extension_test.rb

@@ -39,13 +39,13 @@ class NameErrorExtensionTest < Minitest::Test
 
   def test_correctable_error_objects_are_dumpable
    error = begin
-             File.open('./tmp/.keep').sizee
+             File.open('did_you_mean.gemspec').sizee
            rescue NoMethodError => e
              e
            end
 
    error.to_s
 
-   assert_equal "undefined method `sizee' for #<File:./tmp/.keep>", Marshal.load(Marshal.dump(error)).original_message
+   assert_equal "undefined method `sizee' for #<File:did_you_mean.gemspec>", Marshal.load(Marshal.dump(error)).original_message
   end
 end

data/test/spell_checking/method_name_check_test.rb

@@ -117,6 +117,18 @@ 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_raises 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) }
 

data/test/spell_checking/variable_name_check_test.rb

@@ -50,11 +50,13 @@ 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_raises 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

data/test/verbose_formatter_test.rb

@@ -4,8 +4,7 @@ class VerboseFormatterTest < Minitest::Test
   def setup
     require 'did_you_mean/verbose'
 
-    does_exist = does_exist = nil
-    @error = assert_raises(NameError){ doesnt_exist }
+    @error = assert_raises(NameError){ 1.zeor? }
   end
 
   def teardown
@@ -14,9 +13,9 @@ class VerboseFormatterTest < Minitest::Test
 
   def test_message
     assert_equal <<~MESSAGE.chomp, @error.message
-      undefined local variable or method `doesnt_exist' for #{to_s}
+      undefined method `zeor?' for 1:Integer
 
-          Did you mean? does_exist
+          Did you mean? zero?
        
     MESSAGE
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: did_you_mean
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Yuki Nishijima
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-18 00:00:00.000000000 Z
+date: 2019-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -60,7 +60,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".ruby-version"
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
@@ -72,6 +71,7 @@ files:
 - benchmark/levenshtein/memory_usage.rb
 - benchmark/levenshtein/speed.rb
 - benchmark/memory_usage.rb
+- benchmark/speed.yml
 - did_you_mean.gemspec
 - doc/CHANGELOG.md.erb
 - doc/changelog_generator.rb
@@ -106,7 +106,6 @@ files:
 - test/spell_checking/variable_name_check_test.rb
 - test/test_helper.rb
 - test/verbose_formatter_test.rb
-- tmp/.keep
 homepage: https://github.com/yuki24/did_you_mean
 licenses:
 - MIT
@@ -126,8 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.4
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: '"Did you mean?" experience in Ruby'

data/.ruby-version

@@ -1 +0,0 @@
-2.5.0