did_you_mean 1.2.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78b9260bb8347fa60cb3077dd23f25c7ea514af2fc2673616e778e510afee84d
-  data.tar.gz: 69961a2b8c93e69cbbbc9782de9951257b2811ba107bcf74c3cd0fbb6308194d
+  metadata.gz: 50bf04523f12cc4556ea28643d05f957a6ed95288d022716bbd32b325ea10feb
+  data.tar.gz: eeb093d01d27dae887f7ecbc5e4c530db5230743de2c7280b19f139f56e11638
 SHA512:
-  metadata.gz: 783d8d7aa3147693008c88050c7b867104f3f669638f42f5e6d8418b193b927859294af95767edcc8cc155b01ed3adacd4fc19ae9ac4fb7604031e26f1aaaeca
-  data.tar.gz: 5f4f128667972ce3b3c52680b760519931ff579b8232c3cf34672475d5cbe2f8b7ed346d8f8685cb2b2883c0ed775cab1b80dea79c85f749c3c1c65b1ba11d25
+  metadata.gz: '0941cfdae93b66e3485c0850f2763c869971a1d7cff386fe66d51739d8869155d8ae868016210a0d2935f81aa8185477c9db162029d5a754240f210a2f3b9df8'
+  data.tar.gz: fc53dbc6ae27025325d36084b5be82f0b462addc83a3fa7a0b0b780b6aed2b2dc5f40cc3a3ad7213eeb2a03476723f0ae36681a534d27b9991c95d5ab2197b66

data/.ruby-version

@@ -1 +1 @@
-2.5.1
+2.5.0

data/.travis.yml

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

data/CHANGELOG.md

@@ -1,8 +1,33 @@
+## [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>_
+
+#### Bug Fixes
+
+- 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))
+- Fixed a bug where the deprecated `DidYouMean::Formatter` has been removed unexpectedly ([#103](https://github.com/yuki24/did_you_mean/issues/103), [<tt>4b5ba32</tt>](https://github.com/yuki24/did_you_mean/commit/4b5ba3215975df1dd8e9c7eacffcf02abfffa92e))
+
+#### Other Changes
+
+- Non-production code that has a non-commercial lisence has been removed from gem releases ([#105](https://github.com/yuki24/did_you_mean/issues/105), [@jbotelho2-bb](https://github.com/jbotelho2-bb))
+
+## [v1.2.0](https://github.com/yuki24/did_you_mean/tree/v1.2.0)
+
+_<sup>released at 2018-01-02 20:49:35 UTC</sup>_
+
+**This version&nbsp;1.2.0&nbsp;only has support for Ruby 2.5.0 and later as it uses new features that are only available in 2.5. All future patch releases under&nbsp;1.2.\*&nbsp;will only be compatible with Ruby 2.5.0 and later as well. Versions earlier than&nbsp;1.1.\*&nbsp;will still be maintained until Ruby 2.4 is deprecated. Any other versions below&nbsp;1.0&nbsp;will no longer be maintained.**
+
+#### New features
+
+- The `KeyError` name suggestion feature has been promoted to a stable feature and is available by default ([<tt>acf5945</tt>](https://github.com/yuki24/did_you_mean/commit/acf59450dfb67eefae9b465ccc8029af46ae7dd0),&nbsp;[https://bugs.ruby-lang.org/issues/12063](https://bugs.ruby-lang.org/issues/12063))
+- 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.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**
+**This version is only compatible with Ruby 2.4 and later.**
 
 #### Bug Fixes
 
@@ -18,7 +43,7 @@ _<sup>released at 2017-09-24 07:24:02 UTC</sup>_
 
 _<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.
+The version `1.1.0` only has support for Ruby 2.4.0 and later. Also, all patch releases 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
 
@@ -102,7 +127,7 @@ _<sup>released at 2015-12-25 05:13:04 UTC</sup>_
 
 _<sup>released at 2015-12-25 05:02:25 UTC</sup>_
 
-#### Internal Chagens
+#### Internal Changes
 
 - No longer uses `TracePoint` API by default. fixes [#55](https://github.com/yuki24/did_you_mean/issues/55) and [#56](https://github.com/yuki24/did_you_mean/issues/56)
 

data/README.md

@@ -108,6 +108,45 @@ OBject
 #
 ```
 
+## 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
+can disable it entirely by specifying `--disable-did_you_mean` option to the `ruby` command:
+
+```bash
+$ ruby --disable-did_you_mean -e "1.zeor?"
+-e:1:in `<main>': undefined method `zeor?' for 1:Integer (NameError)
+```
+
+When you do not have direct access to the `ruby` command (e.g. `rails console`, `irb`), you could applyoptions using the
+`RUBYOPT` environment variable:
+
+```bash
+$ RUBYOPT='--disable-did_you_mean' irb
+irb:0> 1.zeor?
+# => NoMethodError (undefined method `zeor?' for 1:Integer)
+```
+
+### Getting the original error message
+
+Sometimes, you do not want to disable the gem entirely, but need to get the original error message without suggestions
+(e.g. testing). In this case, you could use the `#original_message` method on the error object:
+
+```ruby
+no_method_error = begin
+                    1.zeor?
+                  rescue NoMethodError => error
+                    error
+                  end
+
+no_method_error.message
+# => NoMethodError (undefined method `zeor?' for 1:Integer)
+#    Did you mean?  zero?
+
+no_method_error.original_message
+# => NoMethodError (undefined method `zeor?' for 1:Integer)
+```
+
 ## Contributing
 
 1. Fork it (http://github.com/yuki24/did_you_mean/fork)

data/lib/did_you_mean.rb

@@ -9,29 +9,83 @@ require 'did_you_mean/spell_checkers/null_checker'
 
 require "did_you_mean/formatters/plain_formatter"
 
+# The +DidYouMean+ gem adds functionality to suggest possible method/class
+# names upon errors such as +NameError+ and +NoMethodError+. In Ruby 2.3 or
+# later, it is automatically activated during startup.
+#
+# @example
+#
+#   methosd
+#   # => NameError: undefined local variable or method `methosd' for main:Object
+#   #   Did you mean?  methods
+#   #                  method
+#
+#   OBject
+#   # => NameError: uninitialized constant OBject
+#   #    Did you mean?  Object
+#
+#   @full_name = "Yuki Nishijima"
+#   first_name, last_name = full_name.split(" ")
+#   # => NameError: undefined local variable or method `full_name' for main:Object
+#   #    Did you mean?  @full_name
+#
+#   @@full_name = "Yuki Nishijima"
+#   @@full_anme
+#   # => NameError: uninitialized class variable @@full_anme in Object
+#   #    Did you mean?  @@full_name
+#
+#   full_name = "Yuki Nishijima"
+#   full_name.starts_with?("Y")
+#   # => NoMethodError: undefined method `starts_with?' for "Yuki Nishijima":String
+#   #    Did you mean?  start_with?
+#
+#   hash = {foo: 1, bar: 2, baz: 3}
+#   hash.fetch(:fooo)
+#   # => KeyError: key not found: :fooo
+#   #    Did you mean?  :foo
+#
+#
+# == 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 can disable it entirely by
+# specifying +--disable-did_you_mean+ option to the +ruby+ command:
+#
+#   $ ruby --disable-did_you_mean -e "1.zeor?"
+#   -e:1:in `<main>': undefined method `zeor?' for 1:Integer (NameError)
+#
+# When you do not have direct access to the +ruby+ command (e.g.
+# +rails console+, +irb+), you could applyoptions using the +RUBYOPT+
+# environment variable:
+#
+#   $ RUBYOPT='--disable-did_you_mean' irb
+#   irb:0> 1.zeor?
+#   # => NoMethodError (undefined method `zeor?' for 1:Integer)
+#
+#
+# == Getting the original error message
+#
+# Sometimes, you do not want to disable the gem entirely, but need to get the
+# original error message without suggestions (e.g. testing). In this case, you
+# could use the +#original_message+ method on the error object:
+#
+#   no_method_error = begin
+#                       1.zeor?
+#                     rescue NoMethodError => error
+#                       error
+#                     end
+#
+#   no_method_error.message
+#   # => NoMethodError (undefined method `zeor?' for 1:Integer)
+#   #    Did you mean?  zero?
+#
+#   no_method_error.original_message
+#   # => NoMethodError (undefined method `zeor?' for 1:Integer)
+#
 module DidYouMean
-  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
-
+  # Map of error types and spell checker objects.
   SPELL_CHECKERS = Hash.new(NullChecker)
+
   SPELL_CHECKERS.merge!({
     "NameError"     => NameErrorCheckers,
     "NoMethodError" => MethodNameChecker,
@@ -41,29 +95,15 @@ module DidYouMean
   NameError.prepend DidYouMean::Correctable
   KeyError.prepend DidYouMean::Correctable
 
+  # Returns the currenctly set formatter. By default, it is set to +DidYouMean::Formatter+.
   def self.formatter
     @@formatter
   end
 
+  # Updates the primary formatter used to format the suggestions.
   def self.formatter=(formatter)
     @@formatter = formatter
   end
 
   self.formatter = PlainFormatter.new
-
-  # Deprecated formatter
-  class Formatter #:nodoc:
-    def initialize(corrections = [])
-      @corrections = corrections
-    end
-
-    def to_s
-      return "" if @corrections.empty?
-
-      output = "\nDid you mean?  ".dup
-      output << @corrections.join("\n               ")
-    end
-  end
-
-  deprecate_constant :Formatter
 end

data/lib/did_you_mean/formatters/plain_formatter.rb

@@ -1,7 +1,31 @@
 # frozen-string-literal: true
 
 module DidYouMean
+  # The +DidYouMean::PlainFormatter+ is the basic, default formatter for the
+  # gem. The formatter responds to the +message_for+ method and it returns a
+  # human readable string.
   class PlainFormatter
+
+    # Returns a human readable string that contains +corrections+. This
+    # formatter is designed to be less verbose to not take too much screen
+    # space while being helpful enough to the user.
+    #
+    # @example
+    #
+    #   formatter = DidYouMean::PlainFormatter.new
+    #
+    #   # displays suggestions in two lines with the leading empty line
+    #   puts formatter.message_for(["methods", "method"])
+    #
+    #   Did you mean?  methods
+    #                   method
+    #   # => nil
+    #
+    #   # displays an empty line
+    #   puts formatter.message_for([])
+    #
+    #   # => nil
+    #
     def message_for(corrections)
       corrections.empty? ? "" : "\nDid you mean?  #{corrections.join("\n               ")}"
     end

data/lib/did_you_mean/formatters/verbose_formatter.rb

@@ -1,7 +1,43 @@
 # frozen-string-literal: true
 
 module DidYouMean
+  # The +DidYouMean::VerboseFormatter+ uses extra empty lines to make the
+  # suggestion stand out more in the error message.
+  #
+  # In order to activate the verbose formatter,
+  #
+  # @example
+  #
+  #   OBject
+  #   # => NameError: uninitialized constant OBject
+  #   #    Did you mean?  Object
+  #
+  #   require 'did_you_mean/verbose'
+  #
+  #   OBject
+  #   # => NameError: uninitialized constant OBject
+  #   #
+  #   #        Did you mean? Object
+  #   #
+  #
   class VerboseFormatter
+
+    # Returns a human readable string that contains +corrections+. This
+    # formatter is designed to be less verbose to not take too much screen
+    # space while being helpful enough to the user.
+    #
+    # @example
+    #
+    #   formatter = DidYouMean::PlainFormatter.new
+    #
+    #   puts formatter.message_for(["methods", "method"])
+    #
+    #
+    #       Did you mean? methods
+    #                     method
+    #
+    #   # => nil
+    #
     def message_for(corrections)
       return "" if corrections.empty?
 

data/lib/did_you_mean/spell_checkers/method_name_checker.rb

@@ -7,6 +7,35 @@ module DidYouMean
     NAMES_TO_EXCLUDE = { NilClass => nil.methods }
     NAMES_TO_EXCLUDE.default = []
 
+    # +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
+    # an argument, and a +NoMethodError+ is raised due to the presence of the
+    # argument.
+    #
+    # The +MethodNameChecker+ will use this list to suggest a reversed word if
+    # a +NoMethodError+ is raised and found closest matches.
+    #
+    # Also see +VariableNameChecker::RB_RESERVED_WORDS+.
+    RB_RESERVED_WORDS = %i(
+      alias
+      case
+      def
+      defined?
+      elsif
+      end
+      ensure
+      for
+      rescue
+      super
+      undef
+      unless
+      until
+      when
+      while
+      yield
+    )
+
     def initialize(exception)
       @method_name  = exception.name
       @receiver     = exception.receiver
@@ -14,7 +43,7 @@ module DidYouMean
     end
 
     def corrections
-      @corrections ||= SpellChecker.new(dictionary: method_names).correct(method_name) - NAMES_TO_EXCLUDE[@receiver.class]
+      @corrections ||= SpellChecker.new(dictionary: RB_RESERVED_WORDS + method_names).correct(method_name) - NAMES_TO_EXCLUDE[@receiver.class]
     end
 
     def method_names

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

@@ -6,9 +6,61 @@ module DidYouMean
   class VariableNameChecker
     attr_reader :name, :method_names, :lvar_names, :ivar_names, :cvar_names
 
-    NAMES_TO_EXCLUDE = { 'foo' => [:fork] }
+    NAMES_TO_EXCLUDE = { 'foo' => [:fork, :for] }
     NAMES_TO_EXCLUDE.default = []
-    RB_PREDEFINED_OBJECTS = [:false, :true, :nil]
+
+    # +VariableNameChecker::RB_RESERVED_WORDS+ is the list of all reserved
+    # words in Ruby. They could be declared like methods are, and a typo would
+    # cause Ruby to raise a +NameError+ because of the way they are declared.
+    #
+    # The +:VariableNameChecker+ will use this list to suggest a reversed word
+    # if a +NameError+ is raised and found closest matches, excluding:
+    #
+    #   * +do+
+    #   * +if+
+    #   * +in+
+    #   * +or+
+    #
+    # Also see +MethodNameChecker::RB_RESERVED_WORDS+.
+    RB_RESERVED_WORDS = %i(
+      BEGIN
+      END
+      alias
+      and
+      begin
+      break
+      case
+      class
+      def
+      defined?
+      else
+      elsif
+      end
+      ensure
+      false
+      for
+      module
+      next
+      nil
+      not
+      redo
+      rescue
+      retry
+      return
+      self
+      super
+      then
+      true
+      undef
+      unless
+      until
+      when
+      while
+      yield
+      __LINE__
+      __FILE__
+      __ENCODING__
+    )
 
     def initialize(exception)
       @name       = exception.name.to_s.tr("@", "")
@@ -23,7 +75,7 @@ module DidYouMean
 
     def corrections
       @corrections ||= SpellChecker
-                     .new(dictionary: (RB_PREDEFINED_OBJECTS + lvar_names + method_names + ivar_names + cvar_names))
+                     .new(dictionary: (RB_RESERVED_WORDS + lvar_names + method_names + ivar_names + cvar_names))
                      .correct(name) - NAMES_TO_EXCLUDE[@name]
     end
   end

data/lib/did_you_mean/version.rb

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

data/test/core_ext/name_error_extension_test.rb

@@ -49,11 +49,3 @@ class NameErrorExtensionTest < Minitest::Test
    assert_equal "undefined method `sizee' for #<File:./tmp/.keep>", Marshal.load(Marshal.dump(error)).original_message
   end
 end
-
-class DeprecatedIgnoreCallersTest < Minitest::Test
-  def test_ignore
-    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/spell_checking/method_name_check_test.rb

@@ -116,4 +116,11 @@ class MethodNameCheckTest < Minitest::Test
 
     assert_equal 1, error.to_s.scan(/Did you mean/).count
   end
+
+  def test_suggests_yield
+    error = assert_raises(NoMethodError) { yeild(1) }
+
+    assert_correction :yield, error.corrections
+    assert_match "Did you mean?  yield", error.to_s
+  end
 end

data/test/spell_checking/variable_name_check_test.rb

@@ -69,7 +69,11 @@ class VariableNameCheckTest < Minitest::Test
     end
 
     nil_error = assert_raises(NameError) do
-      some_var = nol
+      some_var = nul
+    end
+
+    file_error = assert_raises(NameError) do
+      __FIEL__
     end
 
     assert_correction :false, false_error.corrections
@@ -80,6 +84,16 @@ class VariableNameCheckTest < Minitest::Test
 
     assert_correction :nil, nil_error.corrections
     assert_match "Did you mean?  nil", nil_error.to_s
+
+    assert_correction :__FILE__, file_error.corrections
+    assert_match "Did you mean?  __FILE__", file_error.to_s
+  end
+
+  def test_suggests_yield
+    error = assert_raises(NameError) { yeild }
+
+    assert_correction :yield, error.corrections
+    assert_match "Did you mean?  yield", error.to_s
   end
 
   def test_corrections_include_instance_variable_name

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: did_you_mean
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.3.0
 platform: ruby
 authors:
 - Yuki Nishijima
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-09 00:00:00.000000000 Z
+date: 2018-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -92,10 +92,8 @@ files:
 - 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/deprecated_formatter_test.rb
 - test/edit_distance/jaro_winkler_test.rb
 - test/experimental/initializer_name_correction_test.rb
 - test/experimental/method_name_checker_test.rb
@@ -129,13 +127,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.4
 signing_key: 
 specification_version: 4
 summary: '"Did you mean?" experience in Ruby'
 test_files:
 - test/core_ext/name_error_extension_test.rb
-- test/deprecated_formatter_test.rb
 - test/edit_distance/jaro_winkler_test.rb
 - test/experimental/initializer_name_correction_test.rb
 - test/experimental/method_name_checker_test.rb

data/lib/did_you_mean/verbose_formatter.rb

@@ -1,7 +0,0 @@
-require 'did_you_mean'
-require 'did_you_mean/formatters/verbose_formatter'
-
-DidYouMean.formatter = DidYouMean::VerboseFormatter.new
-
-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/test/deprecated_formatter_test.rb

@@ -1,9 +0,0 @@
-require 'test_helper'
-
-class DeprecatedFormatterTest < Minitest::Test
-  def test_deprecated_formatter
-    assert_output nil, /test\/deprecated_formatter_test.rb:6: warning: constant DidYouMean::Formatter is deprecated/ do
-      assert_equal "\nDid you mean?  does_exist", ::DidYouMean::Formatter.new(['does_exist']).to_s
-    end
-  end
-end