did_you_mean 1.1.3 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 412c345b8350b7d64bcbcf09ea72178bce0fdb02
-  data.tar.gz: 4918c2d1c307b4d30d9b00178d5e62e932b0b042
+  metadata.gz: 79a0131dfb1348a1f49293ca29cbfa12eab5f896
+  data.tar.gz: 274dd39aacc7583c0877cb3313cd938390d11003
 SHA512:
-  metadata.gz: ab04de77990d06fe206dbc98424e812d8cdf94df29ec472c30624e3738a2ea9eb9e5b67f931c09a70baf05fb84854ceefbf4d00d03ada0e05cdefa47aa73a5ad
-  data.tar.gz: db122760d256332aac2626d3b438e0ed25a33833e9390bfc06ce6fee4ca5623027485315521da541eebafd193c25b251962b92c7a95a0799f5d8925de2010a1b
+  metadata.gz: 31fc5df24553e10482afff9bd425c055f4b0ffbf4d4267927979b3c314a589ff40e13b6597a1e22f5415a221a6e6e0853e0a608d6aab7dafd2b6f71551d23490
+  data.tar.gz: 5739306a3ddbed14ffe321a114ce5eda17513303d3e6d887da1978c781e694994addb383faf5c178bf46405fa49cc7e5630ad281b33caccdc66ba455eae297ff

data/.ruby-version

@@ -1 +1 @@
-2.4.1
+2.5.0-dev

data/.travis.yml

@@ -11,5 +11,4 @@ after_success:
   - bundle exec rake benchmark:memory
 
 rvm:
-  - 2.4.0
   - ruby-head

data/CHANGELOG.md

@@ -1,6 +1,64 @@
+## [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>_
+
+**This version is compatible with Ruby 2.4 and older**
+
+#### Bug Fixes
+
+- Fixed a bug where `did_you_mean` shows duplicate suggestions when the exception is raised multiple times ([#84](https://github.com/yuki24/did_you_mean/pull/84), [<tt>c2e4008</tt>](https://github.com/yuki24/did_you_mean/commit/c2e40083cef604c00ccd10efc6d7a5036ad9eb5b))
+
+## [v1.1.1](https://github.com/yuki24/did_you_mean/tree/v1.1.1)
+
+_<sup>released at 2017-09-24 07:24:02 UTC</sup>_
+
+### This version has been yanked from Rubygems.org and is not available.
+
+## [v1.1.0](https://github.com/yuki24/did_you_mean/tree/v1.1.0)
+
+_<sup>released at 2016-12-19 23:19:06 UTC</sup>_
+
+The version `1.1.0` only has support for Ruby 2.4.0 and later. Also, all patch releasess under `1.1.*` will only be compatible with Ruby 2.4.0 and later as well. Versions under `1.0.*` will still be maintained until Ruby 2.3 is deprecated. Any other versions below `1.0` will no longer be maintained.
+
+#### New Features
+
+- Suggest a method name on a NameError from the `Struct#[]` or `Struct#[]=` method ([#73](https://github.com/yuki24/did_you_mean/pull/73)):
+
+    ```ruby
+    Struct.new(:foo).new[:fooo]
+    # => NameError: no member 'fooo' in struct
+    # Did you mean? foo
+    # foo=
+    ```
+
+- Added a public interface for the gem's spell checker:
+
+    ```ruby
+    DidYouMean::SpellChecker.new(dictionary: ['email', 'fail', 'eval']).correct('meail')
+    # => ['email']
+    ```
+
+- Methods defined on `nil` by default are no longer suggested. Note that methods, defined after the gem is loaded, will still be suggested (e.g. ActiveSupport).
+
+#### Bug Fixes
+
+- 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.3](https://github.com/yuki24/did_you_mean/tree/v1.0.3)
+
+_<sup>released at 2017-09-24 07:22:07 UTC</sup>_
+
+**This version is compatible with Ruby 2.3 and older**
+
+#### Bug Fixes
+
+- Fixed a bug where `did_you_mean` shows duplicate suggestions when the exception is raised multiple times ([#84](https://github.com/yuki24/did_you_mean/pull/84), [<tt>c2e4008</tt>](https://github.com/yuki24/did_you_mean/commit/c2e40083cef604c00ccd10efc6d7a5036ad9eb5b))
+
 ## [v1.0.2](https://github.com/yuki24/did_you_mean/tree/v1.0.2)
 
-_<sup>released on 2016-06-20 18:03:07 UTC</sup>_
+_<sup>released at 2016-11-20 18:03:07 UTC</sup>_
+
+**This version is compatible with Ruby 2.3 and older**
 
 #### Features
 
@@ -16,17 +74,16 @@ _<sup>released on 2016-06-20 18:03:07 UTC</sup>_
 
 ## [v1.0.1](https://github.com/yuki24/did_you_mean/tree/v1.0.1)
 
-_<sup>released on 2016-05-15 05:17:22 UTC</sup>_
+_<sup>released at 2016-05-15 05:17:22 UTC</sup>_
 
 #### Bug Fixes
 
 - Fixed a bug where the gem suggests what is actually typed by the user: [<tt>1c52c88</tt>](https://github.com/yuki24/did_you_mean/commit/1c52c887c62b0921e799f94bcc4a846dc7cbc057)
 - Fixed features that didn't work on JRuby 9.1.0.0: [<tt>dc48dde</tt>](https://github.com/yuki24/did_you_mean/commit/dc48dde1b2a8f05aab1fcf897e1cb3075a206f53), [<tt>4de23f8</tt>](https://github.com/yuki24/did_you_mean/commit/4de23f880502c80c5f321371d39c08bb0fa34040), [<tt>00e3059</tt>](https://github.com/yuki24/did_you_mean/commit/00e305971060d150fae4817b5e895d6478b37579). The local variable name correction is still disabled. Also see: [jruby/jruby#3480](https://github.com/jruby/jruby/issues/3480)
 
-
 ## [v1.0.0](https://github.com/yuki24/did_you_mean/tree/v1.0.0)
 
-_<sup>released on 2015-12-25 05:13:04 UTC</sup>_
+_<sup>released at 2015-12-25 05:13:04 UTC</sup>_
 
 #### Features
 
@@ -43,7 +100,7 @@ _<sup>released on 2015-12-25 05:13:04 UTC</sup>_
 
 ## [v1.0.0.rc1](https://github.com/yuki24/did_you_mean/tree/v1.0.0.rc1)
 
-_<sup>released on 2015-12-25 05:02:25 UTC</sup>_
+_<sup>released at 2015-12-25 05:02:25 UTC</sup>_
 
 #### Internal Chagens
 
@@ -51,7 +108,7 @@ _<sup>released on 2015-12-25 05:02:25 UTC</sup>_
 
 ## [v1.0.0.beta3](https://github.com/yuki24/did_you_mean/tree/v1.0.0.beta3)
 
-_<sup>released on 2015-12-25 04:56:13 UTC</sup>_
+_<sup>released at 2015-12-25 04:56:13 UTC</sup>_
 
 #### Internal Changes
 
@@ -61,7 +118,7 @@ _<sup>released on 2015-12-25 04:56:13 UTC</sup>_
 
 ## [v1.0.0.beta2](https://github.com/yuki24/did_you_mean/tree/v1.0.0.beta2)
 
-_<sup>released on 2015-12-25 04:50:36 UTC</sup>_
+_<sup>released at 2015-12-25 04:50:36 UTC</sup>_
 
 #### Bug Fixes
 
@@ -69,7 +126,7 @@ _<sup>released on 2015-12-25 04:50:36 UTC</sup>_
 
 ## [v1.0.0.beta1](https://github.com/yuki24/did_you_mean/tree/v1.0.0.beta1)
 
-_<sup>released on 2015-12-25 05:27:53 UTC</sup>_
+_<sup>released at 2015-12-25 05:27:53 UTC</sup>_
 
 #### Breaking Changes
 
@@ -83,7 +140,7 @@ _<sup>released on 2015-12-25 05:27:53 UTC</sup>_
 
 ## [v0.10.0](https://github.com/yuki24/did_you_mean/tree/v0.10.0)
 
-_<sup>released on 2015-08-21 06:44:11 UTC</sup>_
+_<sup>released at 2015-08-21 06:44:11 UTC</sup>_
 
 #### Features
 
@@ -108,7 +165,7 @@ _<sup>released on 2015-08-21 06:44:11 UTC</sup>_
 
 ## [v0.9.10](https://github.com/yuki24/did_you_mean/tree/v0.9.10)
 
-_<sup>released on 2015-05-14 03:04:47 UTC</sup>_
+_<sup>released at 2015-05-14 03:04:47 UTC</sup>_
 
 #### Bug Fixes
 
@@ -116,7 +173,7 @@ _<sup>released on 2015-05-14 03:04:47 UTC</sup>_
 
 ## [v0.9.9](https://github.com/yuki24/did_you_mean/tree/v0.9.9)
 
-_<sup>released on 2015-05-13 03:48:19 UTC</sup>_
+_<sup>released at 2015-05-13 03:48:19 UTC</sup>_
 
 #### Features
 
@@ -130,7 +187,7 @@ _<sup>released on 2015-05-13 03:48:19 UTC</sup>_
 
 ## [v0.9.8](https://github.com/yuki24/did_you_mean/tree/v0.9.8)
 
-_<sup>released on 2015-04-12 01:55:27 UTC</sup>_
+_<sup>released at 2015-04-12 01:55:27 UTC</sup>_
 
 #### Internal Changes
 
@@ -138,7 +195,7 @@ _<sup>released on 2015-04-12 01:55:27 UTC</sup>_
 
 ## [v0.9.7](https://github.com/yuki24/did_you_mean/tree/v0.9.7)
 
-_<sup>released on 2015-04-02 04:20:26 UTC</sup>_
+_<sup>released at 2015-04-02 04:20:26 UTC</sup>_
 
 #### Bug Fixes
 
@@ -146,7 +203,7 @@ _<sup>released on 2015-04-02 04:20:26 UTC</sup>_
 
 ## [v0.9.6](https://github.com/yuki24/did_you_mean/tree/v0.9.6)
 
-_<sup>released on 2015-01-24 23:19:27 UTC</sup>_
+_<sup>released at 2015-01-24 23:19:27 UTC</sup>_
 
 #### Bug Fixes
 
@@ -154,7 +211,7 @@ _<sup>released on 2015-01-24 23:19:27 UTC</sup>_
 
 ## [v0.9.5](https://github.com/yuki24/did_you_mean/tree/v0.9.5)
 
-_<sup>released on 2015-01-07 12:41:23 UTC</sup>_
+_<sup>released at 2015-01-07 12:41:23 UTC</sup>_
 
 #### Bug Fixes
 
@@ -162,7 +219,7 @@ _<sup>released on 2015-01-07 12:41:23 UTC</sup>_
 
 ## [v0.9.4](https://github.com/yuki24/did_you_mean/tree/v0.9.4)
 
-_<sup>released on 2014-11-19 20:00:00 UTC</sup>_
+_<sup>released at 2014-11-19 20:00:00 UTC</sup>_
 
 #### Bug Fixes
 
@@ -170,7 +227,7 @@ _<sup>released on 2014-11-19 20:00:00 UTC</sup>_
 
 ## [v0.9.3](https://github.com/yuki24/did_you_mean/tree/v0.9.3)
 
-_<sup>released on 2014-11-18 03:50:11 UTC</sup>_
+_<sup>released at 2014-11-18 03:50:11 UTC</sup>_
 
 **This version has been yanked from rubygems.org as it doesn't work with jRuby at all. Please upgrade to 0.9.4 or higher as soon as possible.**
 
@@ -180,7 +237,7 @@ _<sup>released on 2014-11-18 03:50:11 UTC</sup>_
 
 ## [v0.9.2](https://github.com/yuki24/did_you_mean/tree/v0.9.2)
 
-_<sup>released on 2014-11-17 15:32:33 UTC</sup>_
+_<sup>released at 2014-11-17 15:32:33 UTC</sup>_
 
 #### Bug Fixes
 
@@ -188,7 +245,7 @@ _<sup>released on 2014-11-17 15:32:33 UTC</sup>_
 
 ## [v0.9.1](https://github.com/yuki24/did_you_mean/tree/v0.9.1)
 
-_<sup>released on 2014-11-16 18:54:24 UTC</sup>_
+_<sup>released at 2014-11-16 18:54:24 UTC</sup>_
 
 **This version has been yanked from rubygems.org as it doesn't compile on Ruby 2.1.2 and 2.1.5. Please upgrade to 0.9.4 or higher as soon as possible.**
 
@@ -199,7 +256,7 @@ _<sup>released on 2014-11-16 18:54:24 UTC</sup>_
 
 ## [v0.9.0](https://github.com/yuki24/did_you_mean/tree/v0.9.0)
 
-_<sup>released on 2014-11-09 01:26:31 UTC</sup>_
+_<sup>released at 2014-11-09 01:26:31 UTC</sup>_
 
 #### Features
 
@@ -221,7 +278,7 @@ first_name, last_name = full_name.split(" ")
 
 ## [v0.8.0](https://github.com/yuki24/did_you_mean/tree/v0.8.0)
 
-_<sup>released on 2014-10-27 02:03:13 UTC</sup>_
+_<sup>released at 2014-10-27 02:03:13 UTC</sup>_
 
 **This version has been yanked from rubygems.org as it has a serious bug with Ruby 2.1.3 and 2.1.4 installed on Max OS X. Please upgrade to 0.9.4 or higher as soon as possible.**
 
@@ -237,7 +294,7 @@ _<sup>released on 2014-10-27 02:03:13 UTC</sup>_
 
 ## [v0.7.0](https://github.com/yuki24/did_you_mean/tree/v0.7.0)
 
-_<sup>released on 2014-09-26 03:37:18 UTC</sup>_
+_<sup>released at 2014-09-26 03:37:18 UTC</sup>_
 
 **This version has been yanked from rubygems.org as it has a serious bug with Ruby 2.1.3 and 2.1.4 installed on Max OS X. Please upgrade to 0.9.4 or higher as soon as possible.**
 
@@ -255,7 +312,7 @@ _<sup>released on 2014-09-26 03:37:18 UTC</sup>_
 
 ## [v0.6.0](https://github.com/yuki24/did_you_mean/tree/v0.6.0)
 
-_<sup>released on 2014-05-18 00:23:24 UTC</sup>_
+_<sup>released at 2014-05-18 00:23:24 UTC</sup>_
 
 **This version has been yanked from rubygems.org as it has a serious bug with Ruby 2.1.3 and 2.1.4 installed on Max OS X. Please upgrade to 0.9.4 or higher as soon as possible.**
 
@@ -277,7 +334,7 @@ _<sup>released on 2014-05-18 00:23:24 UTC</sup>_
 
 ## [v0.5.0](https://github.com/yuki24/did_you_mean/tree/v0.5.0)
 
-_<sup>released on 2014-05-10 17:59:54 UTC</sup>_
+_<sup>released at 2014-05-10 17:59:54 UTC</sup>_
 
 #### Features
 
@@ -285,7 +342,7 @@ _<sup>released on 2014-05-10 17:59:54 UTC</sup>_
 
 ## [v0.4.0](https://github.com/yuki24/did_you_mean/tree/v0.4.0)
 
-_<sup>released on 2014-04-20 02:10:31 UTC</sup>_
+_<sup>released at 2014-04-20 02:10:31 UTC</sup>_
 
 #### Features
 
@@ -305,7 +362,7 @@ User.new(flrst_name: "wrong flrst name")
 
 ## [v0.3.1](https://github.com/yuki24/did_you_mean/tree/v0.3.1)
 
-_<sup>released on 2014-03-20 23:16:20 UTC</sup>_
+_<sup>released at 2014-03-20 23:16:20 UTC</sup>_
 
 #### Features
 
@@ -314,7 +371,7 @@ _<sup>released on 2014-03-20 23:16:20 UTC</sup>_
 
 ## [v0.3.0](https://github.com/yuki24/did_you_mean/tree/v0.3.0)
 
-_<sup>released on 2014-03-20 23:13:13 UTC</sup>_
+_<sup>released at 2014-03-20 23:13:13 UTC</sup>_
 
 #### Features
 

data/README.md

@@ -52,13 +52,22 @@ full_name.starts_with?("Y")
 #    Did you mean?  start_with?
 ```
 
+### KeyError
+
+```ruby
+hash = {foo: 1, bar: 2, baz: 3}
+hash.fetch(:fooo)
+# => KeyError: key not found: :fooo
+#    Did you mean?  :foo
+```
+
 ## Experimental Features
 
 Aside from the basic features above, the `did_you_mean` gem comes with experimental features. They can be enabled by calling `require 'did_you_mean/experimental'`.
 
-**Keep in mind that these experimental features should never be enabled in production as they would impact Ruby's performance and use some unstable Ruby APIs.**
+Note that **these experimental features should never be enabled in production as they would impact Ruby's performance and use some unstable Ruby APIs.**
 
-### Correcting an Instance Variable When It's Incorrectly Typed
+### Correcting an Instance Variable When It's Incorrectly Spelled
 
 ```ruby
 require 'did_you_mean/experimental'
@@ -69,16 +78,7 @@ require 'did_you_mean/experimental'
 #    Did you mean?  @full_name
 ```
 
-### Correcting a Hash Key Name
-
-```ruby
-hash = {foo: 1, bar: 2, baz: 3}
-hash.fetch(:fooo)
-# KeyError: key not found: :fooo
-# Did you mean?  :foo
-```
-
-### Displaying a Warning When `initialize` is Incorrectly Typed
+### Displaying a Warning When `initialize` is Incorrectly Spelled
 
 ```ruby
 require 'did_you_mean/experimental'
@@ -100,7 +100,7 @@ OBject
 # => NameError: uninitialized constant OBject
 #    Did you mean?  Object
 
-require 'did_you_mean/verbose_formatter'
+require 'did_you_mean/verbose'
 OBject
 # => NameError: uninitialized constant OBject
 #

data/Rakefile

@@ -4,20 +4,9 @@ require 'rake/testtask'
 Rake::TestTask.new do |task|
   task.libs << "test"
 
-  task.test_files = Dir['test/**/*_test.rb'].reject do |path|
-    /(verbose_formatter|experimental)/ =~ path
-  end
-
-  task.verbose = true
-  task.warning = true
-end
-
-Rake::TestTask.new("test:verbose_formatter") do |task|
-  task.libs << "test"
-  task.pattern = 'test/verbose_formatter_test.rb'
-  task.verbose = true
-  task.warning = true
-  task.ruby_opts << "-rdid_you_mean/verbose_formatter"
+  task.test_files = Dir['test/**/*_test.rb'].reject {|path| /(experimental)/ =~ path }
+  task.verbose    = true
+  task.warning    = true
 end
 
 Rake::TestTask.new("test:experimental") do |task|
@@ -28,7 +17,7 @@ Rake::TestTask.new("test:experimental") do |task|
   task.ruby_opts << "-rdid_you_mean/experimental"
 end
 
-task default: %i(test test:verbose_formatter test:experimental)
+task default: %i(test test:experimental)
 
 namespace :test do
   namespace :accuracy do

data/did_you_mean.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test)/})
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = '>= 2.4.0'
+  spec.required_ruby_version = '>= 2.5.0dev'
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"

data/evaluation/incorrect_words.yaml

@@ -1,5 +1,7 @@
 # This data is based on Birkbeck Spelling Error Corpus: http://ota.ox.ac.uk/headers/0643.xml
 # More specifically, this is a yaml version of the data in FAWTHROP1DAT.643 and FAWTHROP2DAT.643.
+# released under the Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported License.
+# https://creativecommons.org/licenses/by-nc-sa/3.0/
 ---
 abattoir: abbatoir
 abhorrence: abhorence

data/lib/did_you_mean.rb

@@ -4,16 +4,50 @@ require "did_you_mean/core_ext/name_error"
 require "did_you_mean/spell_checker"
 require 'did_you_mean/spell_checkers/name_error_checkers'
 require 'did_you_mean/spell_checkers/method_name_checker'
+require 'did_you_mean/spell_checkers/key_error_checker'
 require 'did_you_mean/spell_checkers/null_checker'
 
-require "did_you_mean/formatter"
+require "did_you_mean/formatters/plain_formatter"
 
 module DidYouMean
-  IGNORED_CALLERS = []
+  class DeprecatedIgnoredCallers < Array
+    %i(
+      +
+      <<
+      []=
+      insert
+      unshift
+      push
+    ).each do |method_name|
+      eval <<-RUBY, nil, __FILE__, __LINE__ + 1
+        def #{method_name}(*)
+          warn "IGNORED_CALLERS has been deprecated and has no effect."
+
+          super
+        end
+      RUBY
+    end
+  end
+
+  IGNORED_CALLERS = DeprecatedIgnoredCallers.new
 
   SPELL_CHECKERS = Hash.new(NullChecker)
   SPELL_CHECKERS.merge!({
     "NameError"     => NameErrorCheckers,
-    "NoMethodError" => MethodNameChecker
+    "NoMethodError" => MethodNameChecker,
+    "KeyError"      => KeyErrorChecker
   })
+
+  NameError.prepend DidYouMean::Correctable
+  KeyError.prepend DidYouMean::Correctable
+
+  def self.formatter
+    @@formatter
+  end
+
+  def self.formatter=(formatter)
+    @@formatter = formatter
+  end
+
+  self.formatter = PlainFormatter.new
 end

data/lib/did_you_mean/core_ext/name_error.rb

@@ -1,17 +1,14 @@
 module DidYouMean
   module Correctable
-    prepend_features NameError
-
     def original_message
       method(:to_s).super_method.call
     end
 
     def to_s
       msg = super.dup
-      bt  = caller(1, 6)
 
-      if IGNORED_CALLERS.all? {|ignored| bt.grep(ignored).empty? } && (!cause.respond_to?(:corrections) || cause.corrections.empty?)
-        msg << Formatter.new(corrections).to_s
+      if !cause.respond_to?(:corrections) || cause.corrections.empty?
+        msg << DidYouMean.formatter.message_for(corrections)
       end
 
       msg
@@ -20,11 +17,11 @@ module DidYouMean
     end
 
     def corrections
-      @corrections ||= spell_checker.corrections
+      spell_checker.corrections
     end
 
     def spell_checker
-      SPELL_CHECKERS[self.class.to_s].new(self)
+      @spell_checker ||= SPELL_CHECKERS[self.class.to_s].new(self)
     end
   end
 end

data/lib/did_you_mean/experimental.rb

@@ -1,17 +1,2 @@
-require 'did_you_mean'
-
-module DidYouMean
-  TRACE = TracePoint.trace(:raise) do |tp|
-    e = tp.raised_exception
-
-    if SPELL_CHECKERS.include?(e.class.to_s) && !e.instance_variable_defined?(:@frame_binding)
-      e.instance_variable_set(:@frame_binding, tp.binding)
-    end
-  end
-
-  NameError.send(:attr, :frame_binding)
-end
-
 require 'did_you_mean/experimental/initializer_name_correction'
 require 'did_you_mean/experimental/ivar_name_correction'
-require 'did_you_mean/experimental/key_error_name_correction'

data/lib/did_you_mean/experimental/initializer_name_correction.rb

@@ -1,5 +1,7 @@
 # frozen-string-literal: true
 
+require 'did_you_mean/levenshtein'
+
 module DidYouMean
   module Experimental
     module InitializerNameCorrection

data/lib/did_you_mean/experimental/ivar_name_correction.rb

@@ -1,19 +1,45 @@
+# frozen-string-literal: true
+
+require 'did_you_mean'
+
 module DidYouMean
-  module Experimental
-    module IvarNameCorrection
+  module Experimental #:nodoc:
+    class IvarNameCheckerBuilder #:nodoc:
+      attr_reader :original_checker
+
+      def initialize(original_checker) #:nodoc:
+        @original_checker = original_checker
+      end
+
+      def new(no_method_error) #:nodoc:
+        IvarNameChecker.new(no_method_error, original_checker: @original_checker)
+      end
+    end
+
+    class IvarNameChecker #:nodoc:
       REPLS = {
         "(irb)" => -> { Readline::HISTORY.to_a.last }
       }
 
-      def initialize(no_method_error)
-        super
+      TRACE = TracePoint.trace(:raise) do |tp|
+        e = tp.raised_exception
+
+        if SPELL_CHECKERS.include?(e.class.to_s) && !e.instance_variable_defined?(:@frame_binding)
+          e.instance_variable_set(:@frame_binding, tp.binding)
+        end
+      end
+
+      attr_reader :original_checker
+
+      def initialize(no_method_error, original_checker: )
+        @original_checker = original_checker.new(no_method_error)
 
         @location   = no_method_error.backtrace_locations.first
         @ivar_names = no_method_error.frame_binding.receiver.instance_variables
       end
 
       def corrections
-        super + ivar_name_corrections
+        original_checker.corrections + ivar_name_corrections
       end
 
       def ivar_name_corrections
@@ -23,12 +49,12 @@ module DidYouMean
       private
 
       def receiver_name
-        return unless receiver.nil?
+        return unless @original_checker.receiver.nil?
 
         abs_path = @location.absolute_path
         lineno   = @location.lineno
 
-        /@(\w+)*\.#{method_name}/ =~ line(abs_path, lineno).to_s && $1
+        /@(\w+)*\.#{@original_checker.method_name}/ =~ line(abs_path, lineno).to_s && $1
       end
 
       def line(abs_path, lineno)
@@ -41,7 +67,8 @@ module DidYouMean
         end
       end
     end
-
-    SPELL_CHECKERS['NoMethodError'].prepend(IvarNameCorrection)
   end
+
+  NameError.send(:attr, :frame_binding)
+  SPELL_CHECKERS['NoMethodError'] = Experimental::IvarNameCheckerBuilder.new(SPELL_CHECKERS['NoMethodError'])
 end

data/lib/did_you_mean/formatters/plain_formatter.rb

@@ -0,0 +1,9 @@
+# frozen-string-literal: true
+
+module DidYouMean
+  class PlainFormatter
+    def message_for(corrections)
+      corrections.empty? ? "" : "\nDid you mean?  #{corrections.join("\n               ")}"
+    end
+  end
+end

data/lib/did_you_mean/formatters/verbose_formatter.rb

@@ -0,0 +1,13 @@
+# frozen-string-literal: true
+
+module DidYouMean
+  class VerboseFormatter
+    def message_for(corrections)
+      return "" if corrections.empty?
+
+      output = "\n\n    Did you mean? ".dup
+      output << corrections.join("\n                  ")
+      output << "\n "
+    end
+  end
+end

data/lib/did_you_mean/spell_checkers/key_error_checker.rb

@@ -0,0 +1,14 @@
+require "did_you_mean/spell_checker"
+
+module DidYouMean
+  class KeyErrorChecker
+    def initialize(key_error)
+      @key = key_error.key
+      @keys = key_error.receiver.keys
+    end
+
+    def corrections
+      @corrections ||= SpellChecker.new(dictionary: @keys).correct(@key).map(&:inspect)
+    end
+  end
+end

data/lib/did_you_mean/spell_checkers/method_name_checker.rb

@@ -1,3 +1,5 @@
+require "did_you_mean/spell_checker"
+
 module DidYouMean
   class MethodNameChecker
     attr_reader :method_name, :receiver

data/lib/did_you_mean/spell_checkers/name_error_checkers.rb

@@ -2,12 +2,8 @@ require 'did_you_mean/spell_checkers/name_error_checkers/class_name_checker'
 require 'did_you_mean/spell_checkers/name_error_checkers/variable_name_checker'
 
 module DidYouMean
-  module NameErrorCheckers
-    def self.included(*)
-      raise "Do not include this module since it overrides Class.new method."
-    end
-
-    def self.new(exception)
+  class << (NameErrorCheckers = Object.new)
+    def new(exception)
       case exception.original_message
       when /uninitialized constant/
         ClassNameChecker

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

@@ -1,19 +1,17 @@
 # frozen-string-literal: true
 require 'delegate'
+require "did_you_mean/spell_checker"
 
 module DidYouMean
   class ClassNameChecker
     attr_reader :class_name
 
     def initialize(exception)
-      @class_name, @receiver, @original_message = exception.name, exception.receiver, exception.original_message
+      @class_name, @receiver = exception.name, exception.receiver
     end
 
     def corrections
-      @corrections ||= SpellChecker.new(dictionary: class_names)
-                         .correct(class_name)
-                         .map(&:full_name)
-                         .reject {|qualified_name| @original_message.include?(qualified_name) }
+      @corrections ||= SpellChecker.new(dictionary: class_names).correct(class_name).map(&:full_name)
     end
 
     def class_names

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

@@ -1,11 +1,14 @@
 # frozen-string-literal: true
 
+require "did_you_mean/spell_checker"
+
 module DidYouMean
   class VariableNameChecker
     attr_reader :name, :method_names, :lvar_names, :ivar_names, :cvar_names
 
     NAMES_TO_EXCLUDE = { 'foo' => [:fork] }
     NAMES_TO_EXCLUDE.default = []
+    RB_PREDEFINED_OBJECTS = [:false, :true, :nil]
 
     def initialize(exception)
       @name       = exception.name.to_s.tr("@", "")
@@ -20,7 +23,7 @@ module DidYouMean
 
     def corrections
       @corrections ||= SpellChecker
-                     .new(dictionary: (lvar_names + method_names + ivar_names + cvar_names))
+                     .new(dictionary: (RB_PREDEFINED_OBJECTS + lvar_names + method_names + ivar_names + cvar_names))
                      .correct(name) - NAMES_TO_EXCLUDE[@name]
     end
   end

data/lib/did_you_mean/verbose.rb

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

data/lib/did_you_mean/verbose_formatter.rb

@@ -1,16 +1,7 @@
-# frozen-string-literal: true
-require 'did_you_mean/formatter'
+require 'did_you_mean'
+require 'did_you_mean/formatters/verbose_formatter'
 
-module DidYouMean
-  module VerboseFormatter
-    prepend_features DidYouMean::Formatter
+DidYouMean.formatter = DidYouMean::VerboseFormatter.new
 
-    def to_s
-      return "" if @corrections.empty?
-
-      output = "\n\n    Did you mean? ".dup
-      output << @corrections.join("\n                  ")
-      output << "\n "
-    end
-  end
-end
+warn '`require "did_you_mean/verbose_formatter"\' has been deprecated and will be removed' \
+     " in the next major Ruby version. Please require 'did_you_mean/verbose' instead."

data/lib/did_you_mean/version.rb

@@ -1,3 +1,3 @@
 module DidYouMean
-  VERSION = "1.1.3"
+  VERSION = "1.2.0"
 end

data/test/core_ext/name_error_extension_test.rb

@@ -20,7 +20,7 @@ class NameErrorExtensionTest < Minitest::Test
 
   def test_message
     message = <<~MESSAGE.chomp
-      undefined local variable or method `doesnt_exist' for #{to_s}
+      undefined local variable or method `doesnt_exist' for #{method(:to_s).super_method.call}
       Did you mean?  does_exist
     MESSAGE
 
@@ -36,50 +36,12 @@ class NameErrorExtensionTest < Minitest::Test
     error.to_s
     assert_equal 1, error.to_s.scan("Did you mean?").count
   end
-
-  def test_correctable_error_objects_are_dumpable
-   error = begin
-             File.open('./tmp/.keep').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
-  end
 end
 
-class IgnoreCallersTest < Minitest::Test
-  SPELL_CHECKERS = DidYouMean::SPELL_CHECKERS
-
-  class Boomer
-    def initialize(*)
-      raise Exception, "spell checker was created when it shouldn't!"
-    end
-  end
-
-  def setup
-    @org, SPELL_CHECKERS['NameError'] = SPELL_CHECKERS['NameError'], Boomer
-    DidYouMean::IGNORED_CALLERS << /( |`)do_not_correct_typo'/
-
-    @error = assert_raises(NameError){ doesnt_exist }
-  end
-
-  def teardown
-    SPELL_CHECKERS['NameError'] = @org
-    DidYouMean::IGNORED_CALLERS.clear
-  end
-
+class DeprecatedIgnoreCallersTest < Minitest::Test
   def test_ignore
-    assert_nothing_raised { do_not_correct_typo }
-  end
-
-  private
-
-  def do_not_correct_typo; @error.message end
-
-  def assert_nothing_raised
-    yield
+    assert_output nil, "IGNORED_CALLERS has been deprecated and has no effect.\n" do
+      DidYouMean::IGNORED_CALLERS << /( |`)do_not_correct_typo'/
+    end
   end
 end

data/test/edit_distance/jaro_winkler_test.rb

@@ -1,5 +1,12 @@
+# -*- coding: utf-8 -*-
 require 'test_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:
+#   https://github.com/tonytonyjan/jaro_winkler/blob/9bd12421/spec/jaro_winkler_spec.rb
+#
+# Copyright (c) 2014 Jian Weihang
+
 class JaroWinklerTest < Minitest::Test
   def test_jaro_winkler_distance
     assert_distance 0.9667, 'henka',      'henkan'

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

@@ -27,7 +27,7 @@ class Book
   end
 end
 
-class ClassNameTest < Minitest::Test
+class ClassNameCheckTest < Minitest::Test
   def test_corrections
     error = assert_raises(NameError) { ::Bo0k }
     assert_correction "Book", error.corrections
@@ -62,16 +62,4 @@ class ClassNameTest < Minitest::Test
     error = assert_raises(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 }
-
-    # 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
-    # a race condition a single test.
-    require_relative '../fixtures/book'
-
-    assert_empty error.corrections
-  end
 end

data/test/spell_checking/key_name_check_test.rb

@@ -0,0 +1,44 @@
+require "test_helper"
+
+class KeyNameCheckTest < Minitest::Test
+  def test_corrects_hash_key_name_with_fetch
+    hash = { "foo" => 1, bar: 2 }
+
+    error = assert_raises(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") }
+    assert_correction %("foo"), error.corrections
+    assert_match %(Did you mean?  "foo"), error.to_s
+  end
+
+  def test_corrects_hash_key_name_with_fetch_values
+    hash = { "foo" => 1, bar: 2 }
+
+    error = assert_raises(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") }
+    assert_correction %("foo"), error.corrections
+    assert_match %(Did you mean?  "foo"), error.to_s
+  end
+
+  def test_corrects_sprintf_key_name
+    error = assert_raises(KeyError) { sprintf("%<foo>d", {fooo: 1}) }
+    assert_correction ":fooo", error.corrections
+    assert_match "Did you mean?  :fooo", error.to_s
+  end
+
+  def test_corrects_env_key_name
+    ENV["FOO"] = "1"
+    ENV["BAR"] = "2"
+    error = assert_raises(KeyError) { ENV.fetch("BAX") }
+    assert_correction %("BAR"), error.corrections
+    assert_match %(Did you mean?  "BAR"), error.to_s
+  ensure
+    ENV.delete("FOO")
+    ENV.delete("BAR")
+  end
+end

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

@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class MethodNameTest < Minitest::Test
+class MethodNameCheckTest < Minitest::Test
   class User
     def friends; end
     def first_name; end

data/test/spell_checking/{uncorrectable_name_test.rb → uncorrectable_name_check_test.rb}

@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class UncorrectableNameTest < Minitest::Test
+class UncorrectableNameCheckTest < Minitest::Test
   class FirstNameError < NameError; end
 
   def setup

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

@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class VariableNameTest < Minitest::Test
+class VariableNameCheckTest < Minitest::Test
   class User
     def initialize
       @email_address = 'email_address@address.net'
@@ -57,6 +57,31 @@ class VariableNameTest < Minitest::Test
     assert_match "Did you mean?  person", error.to_s
   end
 
+  def test_corrections_include_ruby_predefined_objects
+    some_var = nil
+
+    false_error = assert_raises(NameError) do
+      some_var = fals
+    end
+
+    true_error = assert_raises(NameError) do
+      some_var = treu
+    end
+
+    nil_error = assert_raises(NameError) do
+      some_var = nol
+    end
+
+    assert_correction :false, false_error.corrections
+    assert_match "Did you mean?  false", false_error.to_s
+
+    assert_correction :true, true_error.corrections
+    assert_match "Did you mean?  true", true_error.to_s
+
+    assert_correction :nil, nil_error.corrections
+    assert_match "Did you mean?  nil", nil_error.to_s
+  end
+
   def test_corrections_include_instance_variable_name
     error = assert_raises(NameError){ @user.to_s }
 

data/test/verbose_formatter_test.rb

@@ -2,13 +2,19 @@ require 'test_helper'
 
 class VerboseFormatterTest < Minitest::Test
   def setup
+    require 'did_you_mean/verbose'
+
     does_exist = does_exist = nil
     @error = assert_raises(NameError){ doesnt_exist }
   end
 
+  def teardown
+    DidYouMean.formatter = DidYouMean::PlainFormatter.new
+  end
+
   def test_message
     assert_equal <<~MESSAGE.chomp, @error.message
-      undefined local variable or method `doesnt_exist' for #{to_s}
+      undefined local variable or method `doesnt_exist' for #{method(:to_s).super_method.call}
 
           Did you mean? does_exist
        

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: did_you_mean
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.2.0
 platform: ruby
 authors:
 - Yuki Nishijima
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-09 00:00:00.000000000 Z
+date: 2017-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -83,32 +83,32 @@ files:
 - lib/did_you_mean/experimental.rb
 - lib/did_you_mean/experimental/initializer_name_correction.rb
 - lib/did_you_mean/experimental/ivar_name_correction.rb
-- lib/did_you_mean/experimental/key_error_name_correction.rb
-- lib/did_you_mean/formatter.rb
+- lib/did_you_mean/formatters/plain_formatter.rb
+- lib/did_you_mean/formatters/verbose_formatter.rb
 - lib/did_you_mean/jaro_winkler.rb
 - lib/did_you_mean/levenshtein.rb
 - lib/did_you_mean/spell_checker.rb
+- lib/did_you_mean/spell_checkers/key_error_checker.rb
 - lib/did_you_mean/spell_checkers/method_name_checker.rb
 - lib/did_you_mean/spell_checkers/name_error_checkers.rb
 - lib/did_you_mean/spell_checkers/name_error_checkers/class_name_checker.rb
 - lib/did_you_mean/spell_checkers/name_error_checkers/variable_name_checker.rb
 - lib/did_you_mean/spell_checkers/null_checker.rb
+- lib/did_you_mean/verbose.rb
 - lib/did_you_mean/verbose_formatter.rb
 - lib/did_you_mean/version.rb
 - test/core_ext/name_error_extension_test.rb
 - test/edit_distance/jaro_winkler_test.rb
 - test/experimental/initializer_name_correction_test.rb
-- test/experimental/key_error_test.rb
 - test/experimental/method_name_checker_test.rb
-- test/fixtures/book.rb
 - test/spell_checker_test.rb
-- test/spell_checking/class_name_test.rb
-- test/spell_checking/method_name_test.rb
-- test/spell_checking/uncorrectable_name_test.rb
-- test/spell_checking/variable_name_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/verbose_formatter_test.rb
-- tmp/.keep
 homepage: https://github.com/yuki24/did_you_mean
 licenses:
 - MIT
@@ -121,7 +121,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.5.0dev
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -129,7 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: '"Did you mean?" experience in Ruby'
@@ -137,13 +137,12 @@ test_files:
 - test/core_ext/name_error_extension_test.rb
 - test/edit_distance/jaro_winkler_test.rb
 - test/experimental/initializer_name_correction_test.rb
-- test/experimental/key_error_test.rb
 - test/experimental/method_name_checker_test.rb
-- test/fixtures/book.rb
 - test/spell_checker_test.rb
-- test/spell_checking/class_name_test.rb
-- test/spell_checking/method_name_test.rb
-- test/spell_checking/uncorrectable_name_test.rb
-- test/spell_checking/variable_name_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/verbose_formatter_test.rb

data/lib/did_you_mean/experimental/key_error_name_correction.rb

@@ -1,32 +0,0 @@
-module DidYouMean
-  module Experimental
-    module KeyErrorWithNameAndKeys
-      FILE_REGEXP = %r"#{Regexp.quote(__FILE__)}"
-
-      def fetch(name, *)
-        super
-      rescue KeyError => e
-        e.instance_variable_set(:@name, name)
-        e.instance_variable_set(:@keys, keys)
-        $@.delete_if { |s| FILE_REGEXP =~ s } if $@
-
-        raise e
-      end
-    end
-    Hash.prepend KeyErrorWithNameAndKeys
-
-    class KeyNameChecker
-      def initialize(key_error)
-        @name = key_error.instance_variable_get(:@name)
-        @keys = key_error.instance_variable_get(:@keys)
-      end
-
-      def corrections
-        @corrections ||= SpellChecker.new(dictionary: @keys).correct(@name).map(&:inspect)
-      end
-    end
-
-    SPELL_CHECKERS["KeyError"] = KeyNameChecker
-    KeyError.prepend DidYouMean::Correctable
-  end
-end

data/lib/did_you_mean/formatter.rb

@@ -1,16 +0,0 @@
-# frozen-string-literal: true
-
-module DidYouMean
-  class Formatter
-    def initialize(corrections = [])
-      @corrections = corrections
-    end
-
-    def to_s
-      return "" if @corrections.empty?
-
-      output = "\nDid you mean?  ".dup
-      output << @corrections.join("\n               ")
-    end
-  end
-end

data/test/experimental/key_error_test.rb

@@ -1,15 +0,0 @@
-require "test_helper"
-
-class ExperimentalKeyErrorNameCorrectionTest < Minitest::Test
-  def test_corrects_hash_key_name
-    hash = { "foo" => 1, bar: 2 }
-
-    error = assert_raises(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") }
-    assert_correction %("foo"), error.corrections
-    assert_match %(Did you mean?  "foo"), error.to_s
-  end
-end

data/test/fixtures/book.rb

@@ -1,4 +0,0 @@
-class Book
-  class Cover
-  end
-end