did_you_mean 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b69ea3a675f27d9da3419e086c21bd5930f16f90
-  data.tar.gz: 56d723b6a3ab08a92e07412bc0efa2051920626f
+  metadata.gz: 28e1952e8b23b15341dd32e2b069ff5a1095c214
+  data.tar.gz: ab42a54b71d2ea36821f135af2182dbc42671abf
 SHA512:
-  metadata.gz: 1aaf379cad209d36b9df5ed695a42a97bde164cb52619b6c47f1a2c1163ee3ebe1d040c906a46ba89cb3f6e78570f994cf357c08bb87044f7a46aadfbac70810
-  data.tar.gz: 374348aefc081447d3e27f86feb1628ce6914140931e35738e3b230e66e077d245591671dc6c787798c8f4a06edad083051f92e4babfd882e386e051044006d3
+  metadata.gz: d91287f29b78c81341da7c6154272f25f8d9ca28b1d71599079746f24182830d1833493a270705fa3bdc20e003fb1566307772974b88fc6c7b904a7fe3b7a923
+  data.tar.gz: 36a5296b2b247ff3a8791623108e3518571f2d8ad4864bc3eddfb9e17cb648726ba7af9ab4f5dc26d1ad5b4fc47e66044a41e62e066ef4d68727fb64ad8bec59

data/CHANGELOG.md

@@ -5,7 +5,7 @@ _<sup>released on 2015-12-25 05:13:04 UTC</sup>_
 #### Features
 
 - Introduced a [verbose formatter](https://github.com/yuki24/did_you_mean#verbose-formatter)
-- Introduced an easy way to enabling [extra features](https://github.com/yuki24/did_you_mean#extra-features)
+- Introduced an easy way to enabling [experimental features](https://github.com/yuki24/did_you_mean#experimental-features)
 
 #### Bug Fixes
 

data/README.md

@@ -52,16 +52,16 @@ full_name.starts_with?("Y")
 #    Did you mean?  start_with?
 ```
 
-## Extra Features
+## Experimental Features
 
-Aside from the basic features above, the `did_you_mean` gem comes with 2 extra features. They can be enabled by calling `require 'did_you_mean/extra_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 extra features should never be enabled in production as they impact Ruby's performance and uses an unstable Ruby API.**
+**Keep in mind that these experimental features should never be enabled in production as they would impact Ruby's performance and uses an unstable Ruby API.**
 
 ### Correcting an Instance Variable When It's Incorrectly Typed
 
 ```ruby
-require 'did_you_mean/extra_features'
+require 'did_you_mean/experimental'
 
 @full_name = "Yuki Nishijima"
 @full_anme.split(" ")
@@ -71,7 +71,7 @@ require 'did_you_mean/extra_features'
 
 ### Displaying a Warning When `initialize` is Incorrectly Typed
 ```ruby
-require 'did_you_mean/extra_features'
+require 'did_you_mean/experimental'
 
 class Person
   def intialize

data/Rakefile

@@ -5,7 +5,7 @@ Rake::TestTask.new do |task|
   task.libs << "test"
 
   task.test_files = Dir['test/**/*_test.rb'].reject do |path|
-    /(verbose_formatter|extra_features)/ =~ path
+    /(verbose_formatter|experimental)/ =~ path
   end
 
   task.verbose = true
@@ -20,16 +20,16 @@ Rake::TestTask.new("test:verbose_formatter") do |task|
   task.ruby_opts << "-rdid_you_mean/verbose_formatter"
 end
 
-Rake::TestTask.new("test:extra_features") do |task|
+Rake::TestTask.new("test:experimental") do |task|
   task.libs << "test"
-  task.pattern = 'test/extra_features/**/*_test.rb'
+  task.pattern = 'test/experimental/**/*_test.rb'
   task.verbose = true
   task.warning = true
-  task.ruby_opts << "-rdid_you_mean/extra_features"
+  task.ruby_opts << "-rdid_you_mean/experimental"
 end
 
 if RUBY_ENGINE != 'jruby'
-  task default: %i(test test:verbose_formatter test:extra_features)
+  task default: %i(test test:verbose_formatter test:experimental)
 else
   task default: %i(test test:verbose_formatter)
 end

data/benchmark/memory_usage.rb

@@ -7,26 +7,9 @@ require 'did_you_mean'
 # error      = (self.fooo rescue $!)
 # executable = -> { error.to_s }
 
-class SpellChecker
-  include DidYouMean::SpellCheckable
-
-  def initialize(words)
-    @words = words
-  end
-
-  def correct(input)
-    @corrections, @input = nil, input
-    corrections
-  end
-
-  def candidates
-    { @input => @words }
-  end
-end
-
 METHODS    = ''.methods
 INPUT      = 'start_with?'
-collection = SpellChecker.new(METHODS)
+collection = DidYouMean::SpellChecker.new(dictionary: METHODS)
 executable = proc { collection.correct(INPUT) }
 
 GC.disable

data/evaluation/calculator.rb

@@ -1,6 +1,7 @@
 # -*- frozen-string-literal: true -*-
 
 require 'benchmark'
+require 'did_you_mean'
 
 def report(message, &block)
   time = 1000 * Benchmark.realtime(&block)
@@ -21,7 +22,7 @@ def report(message, &block)
   time
 end
 
-puts "\n"
+puts "did_you_mean version: #{DidYouMean::VERSION}\n\n"
 
 report "loading program" do
   require 'yaml'
@@ -37,25 +38,6 @@ report "loading program" do
     end
   rescue LoadError, NameError
   end
-
-  class SpellChecker
-    include DidYouMean::SpellCheckable
-
-    def initialize(words)
-      @words = words
-    end
-
-    def correct(input)
-      @corrections, @input = nil, input
-      corrections
-    end
-
-    def candidates
-      { @input => @words }
-    end
-
-    private def normalize(str); str; end
-  end
 end
 
 report "loading dictionary" do
@@ -66,7 +48,7 @@ report "loading dictionary" do
 end
 
 report "loading corrent/incorrect words" do
-  SPELL_CHECKER   = SpellChecker.new(DICTIONARY)
+  SPELL_CHECKER   = DidYouMean::SpellChecker.new(dictionary: DICTIONARY)
   INCORRECT_WORDS = YAML.load(open("evaluation/incorrect_words.yaml").read)
 end
 
@@ -78,7 +60,6 @@ filename            = "log/words_not_corrected_#{Time.now.to_i}.yml"
 puts <<-MSG
 
  Total number of test data: #{INCORRECT_WORDS.size}
-      did_you_mean version: #{DidYouMean::VERSION}
 
 MSG
 

data/lib/did_you_mean.rb

@@ -1,7 +1,7 @@
 require "did_you_mean/version"
 require "did_you_mean/core_ext/name_error"
 
-require "did_you_mean/spell_checkable"
+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/null_checker'

data/lib/did_you_mean/experimental.rb

@@ -0,0 +1,17 @@
+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/{extra_features → experimental}/initializer_name_correction.rb

@@ -1,7 +1,7 @@
 # -*- frozen-string-literal: true -*-
 
 module DidYouMean
-  module ExtraFeatures
+  module Experimental
     module InitializerNameCorrection
       def method_added(name)
         super

data/lib/did_you_mean/{extra_features → experimental}/ivar_name_correction.rb

@@ -1,5 +1,5 @@
 module DidYouMean
-  module ExtraFeatures
+  module Experimental
     module IvarNameCorrection
       REPLS = {
         "(irb)" => -> { Readline::HISTORY.to_a.last }
@@ -12,8 +12,12 @@ module DidYouMean
         @ivar_names = no_method_error.frame_binding.receiver.instance_variables
       end
 
-      def candidates
-        super.merge(receiver_name.to_s => @ivar_names)
+      def corrections
+        super + ivar_name_corrections
+      end
+
+      def ivar_name_corrections
+        @ivar_name_corrections ||= SpellChecker.new(dictionary: @ivar_names).correct(receiver_name.to_s)
       end
 
       private

data/lib/did_you_mean/experimental/key_error_name_correction.rb

@@ -0,0 +1,32 @@
+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/extra_features.rb

@@ -1,16 +1,3 @@
-require 'did_you_mean'
+warn "The file 'did_you_mean/extra_features.rb' has been moved to 'did_you_mean/experimental.rb'. Please `require 'did_you_mean/experimental'` instead."
 
-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/extra_features/initializer_name_correction'
-require 'did_you_mean/extra_features/ivar_name_correction'
+require 'did_you_mean/experimental'

data/lib/did_you_mean/spell_checker.rb

@@ -0,0 +1,54 @@
+# -*- frozen-string-literal: true -*-
+
+require "did_you_mean/levenshtein"
+require "did_you_mean/jaro_winkler"
+
+module DidYouMean
+  class SpellChecker
+    def initialize(dictionary: )
+      @dictionary = dictionary
+    end
+
+    def correct(input)
+      input     = normalize(input)
+      threshold = input.length > 3 ? 0.834 : 0.77
+
+      seed = @dictionary.select {|candidate| JaroWinkler.distance(normalize(candidate), input) >= threshold }
+      seed.reject! {|candidate| input == candidate.to_s }
+      seed.sort_by! {|candidate| JaroWinkler.distance(candidate.to_s, input) }
+      seed.reverse!
+
+      # Correct mistypes
+      threshold   = (input.length * 0.25).ceil
+      has_mistype = seed.rindex {|c| Levenshtein.distance(normalize(c), input) <= threshold }
+
+      corrections = if has_mistype
+        seed.take(has_mistype + 1)
+      else
+        # Correct misspells
+        seed.select do |candidate|
+          candidate = normalize(candidate)
+          length    = input.length < candidate.length ? input.length : candidate.length
+
+          Levenshtein.distance(candidate, input) < length
+        end.first(1)
+      end
+
+      corrections
+    end
+
+    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.tr!("@", "")
+      str
+    end
+  end
+end

data/lib/did_you_mean/spell_checkers/method_name_checker.rb

@@ -1,6 +1,5 @@
 module DidYouMean
   class MethodNameChecker
-    include SpellCheckable
     attr_reader :method_name, :receiver
 
     def initialize(exception)
@@ -9,8 +8,8 @@ module DidYouMean
       @has_args    = !exception.args&.empty?
     end
 
-    def candidates
-      { method_name => method_names }
+    def corrections
+      @corrections ||= SpellChecker.new(dictionary: method_names).correct(method_name)
     end
 
     def method_names

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

@@ -3,15 +3,14 @@ require 'delegate'
 
 module DidYouMean
   class ClassNameChecker
-    include SpellCheckable
     attr_reader :class_name
 
     def initialize(exception)
       @class_name, @receiver = exception.name, exception.receiver
     end
 
-    def candidates
-      {class_name => class_names}
+    def corrections
+      @corrections ||= SpellChecker.new(dictionary: class_names).correct(class_name).map(&:full_name)
     end
 
     def class_names
@@ -22,10 +21,6 @@ module DidYouMean
       end
     end
 
-    def corrections
-      super.map(&:full_name)
-    end
-
     def scopes
       @scopes ||= @receiver.to_s.split("::").inject([Object]) do |_scopes, scope|
         _scopes << _scopes.last.const_get(scope)

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

@@ -2,7 +2,6 @@
 
 module DidYouMean
   class VariableNameChecker
-    include SpellCheckable
     attr_reader :name, :method_names, :lvar_names, :ivar_names, :cvar_names
 
     def initialize(exception)
@@ -16,8 +15,10 @@ module DidYouMean
       @cvar_names  += receiver.class_variables if receiver.kind_of?(Module)
     end
 
-    def candidates
-      { name => (lvar_names + method_names + ivar_names + cvar_names) }
+    def corrections
+      @corrections ||= SpellChecker
+                     .new(dictionary: (lvar_names + method_names + ivar_names + cvar_names))
+                     .correct(name)
     end
   end
 end

data/lib/did_you_mean/version.rb

@@ -1,3 +1,3 @@
 module DidYouMean
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

data/test/experimental/deprecated_features_test.rb

@@ -0,0 +1,13 @@
+require 'test_helper'
+
+class DeprecatedExtraFeaturesTest < Minitest::Test
+  def test_message
+    message = "The file 'did_you_mean/extra_features.rb' has been moved to " \
+              "'did_you_mean/experimental.rb'. Please `require 'did_you_mean/experimental'` " \
+              "instead.\n"
+
+    assert_output nil, message do
+      require 'did_you_mean/extra_features'
+    end
+  end
+end

data/test/experimental/key_error_test.rb

@@ -0,0 +1,15 @@
+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/{extra_features → experimental}/method_name_checker_test.rb

@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class MethodNameWithExtraFeaturesTest < Minitest::Test
+class ExperimentalMethodNameCorrectionTest < Minitest::Test
   def test_corrects_incorrect_ivar_name
     @number = 1
     @nubmer = nil

data/test/spell_checker_test.rb

@@ -1,14 +1,6 @@
 require 'test_helper'
 
 class SpellCheckerTest < Minitest::Test
-  SpellChecker = Struct.new(:input, :words) do
-    include DidYouMean::SpellCheckable
-
-    def candidates
-      { input => words }
-    end
-  end
-
   def test_spell_checker_corrects_mistypes
     assert_spell 'foo',   input: 'doo',   dictionary: ['foo', 'fork']
     assert_spell 'email', input: 'meail', dictionary: ['email', 'fail', 'eval']
@@ -43,8 +35,8 @@ class SpellCheckerTest < Minitest::Test
     names = %w(first_name_change first_name_changed? first_name_will_change!)
     assert_spell names, input: 'first_name_change!', dictionary: names
 
-    assert_empty SpellChecker.new('product_path', ['proc']).corrections
-    assert_empty SpellChecker.new('fooo',         ['fork']).corrections
+    assert_empty DidYouMean::SpellChecker.new(dictionary: ['proc']).correct('product_path')
+    assert_empty DidYouMean::SpellChecker.new(dictionary: ['fork']).correct('fooo')
   end
 
   def test_spell_checker_corrects_misspells
@@ -60,27 +52,27 @@ class SpellCheckerTest < Minitest::Test
       name123
     )
 
-    actual = SpellChecker.new("name123456", %w(
+    actual = DidYouMean::SpellChecker.new(dictionary: %w(
       name12
       name123
       name1234
       name12345
       name123456
-    )).corrections
+    )).correct('name123456')
 
     assert_equal expected, actual
   end
 
   def test_spell_checker_excludes_input_from_dictionary
-    assert_empty SpellChecker.new('input', ['input']).corrections
-    assert_empty SpellChecker.new('input', [:input]).corrections
-    assert_empty SpellChecker.new(:input, ['input']).corrections
+    assert_empty DidYouMean::SpellChecker.new(dictionary: ['input']).correct('input')
+    assert_empty DidYouMean::SpellChecker.new(dictionary: [:input]).correct('input')
+    assert_empty DidYouMean::SpellChecker.new(dictionary: ['input']).correct(:input)
   end
 
   private
 
   def assert_spell(expected, input: , dictionary: )
-    corrections = SpellChecker.new(input, dictionary).corrections
+    corrections = DidYouMean::SpellChecker.new(dictionary: dictionary).correct(input)
     assert_equal Array(expected), corrections, "Expected to suggest #{expected}, but got #{corrections.inspect}"
   end
 end

data/test/verbose_formatter_test.rb

@@ -2,7 +2,7 @@ require 'test_helper'
 
 class VerboseFormatterTest < Minitest::Test
   def setup
-    @error = assert_raises(NameError){ self.inspectt }
+    @error = assert_raises(NoMethodError){ self.inspectt }
   end
 
   def test_message

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: did_you_mean
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Yuki Nishijima
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-15 00:00:00.000000000 Z
+date: 2016-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,13 +80,15 @@ files:
 - evaluation/incorrect_words.yaml
 - lib/did_you_mean.rb
 - lib/did_you_mean/core_ext/name_error.rb
+- 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/extra_features.rb
-- lib/did_you_mean/extra_features/initializer_name_correction.rb
-- lib/did_you_mean/extra_features/ivar_name_correction.rb
 - lib/did_you_mean/formatter.rb
 - lib/did_you_mean/jaro_winkler.rb
 - lib/did_you_mean/levenshtein.rb
-- lib/did_you_mean/spell_checkable.rb
+- lib/did_you_mean/spell_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
@@ -95,14 +97,16 @@ files:
 - lib/did_you_mean/verbose_formatter.rb
 - lib/did_you_mean/version.rb
 - test/core_ext/name_error_extension_test.rb
-- test/correctable/class_name_test.rb
-- test/correctable/method_name_test.rb
-- test/correctable/uncorrectable_name_test.rb
-- test/correctable/variable_name_test.rb
 - test/edit_distance/jaro_winkler_test.rb
-- test/extra_features/initializer_name_correction_test.rb
-- test/extra_features/method_name_checker_test.rb
+- test/experimental/deprecated_features_test.rb
+- test/experimental/initializer_name_correction_test.rb
+- test/experimental/key_error_test.rb
+- test/experimental/method_name_checker_test.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/test_helper.rb
 - test/verbose_formatter_test.rb
 homepage: https://github.com/yuki24/did_you_mean
@@ -131,13 +135,15 @@ specification_version: 4
 summary: '"Did you mean?" experience in Ruby'
 test_files:
 - test/core_ext/name_error_extension_test.rb
-- test/correctable/class_name_test.rb
-- test/correctable/method_name_test.rb
-- test/correctable/uncorrectable_name_test.rb
-- test/correctable/variable_name_test.rb
 - test/edit_distance/jaro_winkler_test.rb
-- test/extra_features/initializer_name_correction_test.rb
-- test/extra_features/method_name_checker_test.rb
+- test/experimental/deprecated_features_test.rb
+- test/experimental/initializer_name_correction_test.rb
+- test/experimental/key_error_test.rb
+- test/experimental/method_name_checker_test.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/test_helper.rb
 - test/verbose_formatter_test.rb

data/lib/did_you_mean/spell_checkable.rb

@@ -1,56 +0,0 @@
-# -*- frozen-string-literal: true -*-
-
-require "did_you_mean/levenshtein"
-require "did_you_mean/jaro_winkler"
-
-module DidYouMean
-  module SpellCheckable
-    def corrections
-      @corrections ||= candidates.flat_map do |input, candidates|
-        input     = normalize(input)
-        threshold = input.length > 3 ? 0.834 : 0.77
-
-        seed = candidates.select {|candidate| JaroWinkler.distance(normalize(candidate), input) >= threshold }
-        seed.reject! {|candidate| input == candidate.to_s }
-        seed.sort_by! {|candidate| JaroWinkler.distance(candidate.to_s, input) }
-        seed.reverse!
-
-        # Correct mistypes
-        threshold   = (input.length * 0.25).ceil
-        has_mistype = seed.rindex {|c| Levenshtein.distance(normalize(c), input) <= threshold }
-
-        corrections = if has_mistype
-          seed.take(has_mistype + 1)
-        else
-          # Correct misspells
-          seed.select do |candidate|
-            candidate = normalize(candidate)
-            length    = input.length < candidate.length ? input.length : candidate.length
-
-            Levenshtein.distance(candidate, input) < length
-          end.first(1)
-        end
-
-        corrections
-      end
-    end
-
-    def candidates
-      raise NotImplementedError
-    end
-
-    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.tr!("@", "")
-      str
-    end
-  end
-end