did_you_mean 1.0.0.rc1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 60c129eec72ca04e09a5f0514c53156b27f309e2
-  data.tar.gz: c0f1132a91404efafe5919a9144eda26a779d7be
+  metadata.gz: 4765e62fea49eb8f8863c01825a7ec89b1be951e
+  data.tar.gz: 4c993cb9c366008086539cf047ba7a81eddf7450
 SHA512:
-  metadata.gz: 34f6395d7a241ab9bc18aac2292ea59a4677bfffc44d6ed57db26b0c72cb91f5abfe9945a8bc86c89de29144e6d571218fa249c0de51a5a264069a2fd63b622f
-  data.tar.gz: 8732e1821ba7d7834b90e58f77d094ba3caf36093a21f9aba37bf64e4c0c14fabab01eff7be5c1325a59bf3b29a79a3aa252556789763975bb4e4602b00ae52b
+  metadata.gz: e68859b53e91e551e698168bdb06a1ad0034e5a12457ca974a2d2147504f2627344af672de248c156d4a8df64afb0e298bf523b6242c1192f84f5cea94a9bcb2
+  data.tar.gz: 16f2eb958b3494439251ae0c33fb5f924370f7fab9632bbddaa062b8d6023214247bd98af7b0c806f1b0a17aa3e059a986a048bba1b93141dcfb658b1c96d84d

data/.travis.yml

@@ -1,5 +1,5 @@
 language: ruby
-script:   bundle exec rake test
+script:   bundle exec rake
 cache:    bundler
 sudo:     false
 

data/Rakefile

@@ -3,12 +3,32 @@ require 'rake/testtask'
 
 Rake::TestTask.new do |task|
   task.libs << "test"
-  task.pattern = 'test/**/*_test.rb'
+
+  task.test_files = Dir['test/**/*_test.rb'].reject do |path|
+    /(verbose_formatter|extra_features)/ =~ 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"
+end
+
+Rake::TestTask.new("test:extra_features") do |task|
+  task.libs << "test"
+  task.pattern = 'test/extra_features/**/*_test.rb'
   task.verbose = true
   task.warning = true
+  task.ruby_opts << "-rdid_you_mean/extra_features"
 end
 
-task default: :test
+task default: %i(test test:verbose_formatter test:extra_features)
 
 namespace :test do
   namespace :accuracy do

data/lib/did_you_mean.rb

@@ -9,14 +9,6 @@ require 'did_you_mean/spell_checkers/null_checker'
 require "did_you_mean/formatter"
 
 module DidYouMean
-  TRACE = TracePoint.new(: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
-
   IGNORED_CALLERS = []
 
   SPELL_CHECKERS = Hash.new(NullChecker)

data/lib/did_you_mean/extra_features.rb

@@ -0,0 +1,16 @@
+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/extra_features/initializer_name_correction'
+require 'did_you_mean/extra_features/ivar_name_correction'

data/lib/did_you_mean/extra_features/initializer_name_correction.rb

@@ -0,0 +1,18 @@
+# -*- frozen-string-literal: true -*-
+
+module DidYouMean
+  module ExtraFeatures
+    module InitializerNameCorrection
+      def method_added(name)
+        super
+
+        distance = Levenshtein.distance(name.to_s, 'initialize')
+        if distance != 0 && distance <= 2
+          warn "warning: #{name} might be misspelled, perhaps you meant initialize?"
+        end
+      end
+    end
+
+    ::Class.prepend(InitializerNameCorrection)
+  end
+end

data/lib/did_you_mean/extra_features/ivar_name_correction.rb

@@ -0,0 +1,43 @@
+module DidYouMean
+  module ExtraFeatures
+    module IvarNameCorrectable
+      REPLS = {
+        "(irb)" => -> { Readline::HISTORY.to_a.last }
+      }
+
+      def initialize(no_method_error)
+        super
+
+        @location   = no_method_error.backtrace_locations.first
+        @ivar_names = no_method_error.frame_binding.receiver.instance_variables
+      end
+
+      def candidates
+        super.merge(receiver_name.to_s => @ivar_names)
+      end
+
+      private
+
+      def receiver_name
+        return unless receiver.nil?
+
+        abs_path = @location.absolute_path
+        lineno   = @location.lineno
+
+        /@(\w+)*\.#{method_name}/ =~ line(abs_path, lineno).to_s && $1
+      end
+
+      def line(abs_path, lineno)
+        if REPLS[abs_path]
+          REPLS[abs_path].call
+        elsif File.exist?(abs_path)
+          File.open(abs_path) do |file|
+            file.detect { file.lineno == lineno }
+          end
+        end
+      end
+    end
+
+    SPELL_CHECKERS['NoMethodError'].prepend(IvarNameCorrectable)
+  end
+end

data/lib/did_you_mean/jaro_winkler.rb

@@ -9,6 +9,7 @@ module DidYouMean
       m          = 0.0
       t          = 0.0
       range      = (length2 / 2).floor - 1
+      range      = 0 if range < 0
       flags1     = 0
       flags2     = 0
 

data/lib/did_you_mean/spell_checkable.rb

@@ -16,11 +16,13 @@ module DidYouMean
 
         # Correct mistypes
         threshold   = (input.length * 0.25).ceil
-        corrections = seed.select {|c| Levenshtein.distance(normalize(c), input) <= threshold }
+        has_mistype = seed.rindex {|c| Levenshtein.distance(normalize(c), input) <= threshold }
 
-        # Correct misspells
-        if corrections.empty?
-          corrections = seed.select do |candidate|
+        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
 

data/lib/did_you_mean/spell_checkers/method_name_checker.rb

@@ -6,6 +6,7 @@ module DidYouMean
     def initialize(exception)
       @method_name = exception.name
       @receiver    = exception.receiver
+      @has_args    = !exception.args&.empty?
     end
 
     def candidates
@@ -13,48 +14,11 @@ module DidYouMean
     end
 
     def method_names
-      method_names = receiver.methods + receiver.singleton_methods + receiver.private_methods
+      method_names = receiver.methods + receiver.singleton_methods
+      method_names += receiver.private_methods if @has_args
       method_names.delete(method_name)
       method_names.uniq!
       method_names
     end
-
-    module IvarNameCorrectable
-      REPLS = {
-        "(irb)" => -> { Readline::HISTORY.to_a.last }
-      }
-
-      def initialize(exception)
-        super
-
-        @location   = exception.backtrace_locations.first
-        @ivar_names = exception.instance_variable_get(:@frame_binding).receiver.instance_variables
-      end
-
-      def candidates
-        super.merge(receiver_name.to_s => @ivar_names)
-      end
-
-      private
-
-      def receiver_name
-        return unless receiver.nil?
-
-        abs_path = @location.absolute_path
-        lineno   = @location.lineno
-
-        /@(\w+)*\.#{method_name}/ =~ line(abs_path, lineno).to_s && $1
-      end
-
-      def line(abs_path, lineno)
-        if REPLS[abs_path]
-          REPLS[abs_path].call
-        elsif File.exist?(abs_path)
-          File.open(abs_path) do |file|
-            file.detect { file.lineno == lineno }
-          end
-        end
-      end
-    end
   end
 end

data/lib/did_you_mean/verbose_formatter.rb

@@ -0,0 +1,16 @@
+# -*- frozen-string-literal: true -*-
+require 'did_you_mean/formatter'
+
+module DidYouMean
+  module VerboseFormatter
+    prepend_features DidYouMean::Formatter
+
+    def to_s
+      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/version.rb

@@ -1,3 +1,3 @@
 module DidYouMean
-  VERSION = "1.0.0.rc1"
+  VERSION = "1.0.0"
 end

data/test/correctable/method_name_test.rb

@@ -71,23 +71,4 @@ class MethodNameTest < Minitest::Test
     assert_correction :raise, error.corrections
     assert_match "Did you mean?  raise", error.to_s
   end
-
-  D = DidYouMean
-  M = D::MethodNameChecker
-
-  def test_corrects_incorrect_ivar_name
-    D::TRACE.enable
-    D::SPELL_CHECKERS['NoMethodError'] = M.dup.prepend(M::IvarNameCorrectable)
-
-    @number = 1
-    @nubmer = nil
-    error = assert_raises(NoMethodError) { @nubmer.zero? }
-    remove_instance_variable :@nubmer
-
-    assert_correction :@number, error.corrections
-    assert_match "Did you mean?  @number", error.to_s
-  ensure
-    D::TRACE.disable
-    D::SPELL_CHECKERS['NoMethodError'] = M
-  end
 end

data/test/edit_distance/jaro_winkler_test.rb

@@ -13,6 +13,7 @@ class JaroWinklerTest < Minitest::Test
     assert_distance 0.8133, 'dixon',      'dicksonx'
     assert_distance 0.0,    'fvie',       'ten'
     assert_distance 0.9067, 'does_exist', 'doesnt_exist'
+    assert_distance 1.0, 'x', 'x'
   end
 
   def test_jarowinkler_distance_with_utf8_strings

data/test/extra_features/initializer_name_correction_test.rb

@@ -0,0 +1,15 @@
+require 'test_helper'
+
+class InitializerNameCorrectionTest < Minitest::Test
+  def test_corrects_wrong_initializer_name
+    assert_output nil, "warning: intialize might be misspelled, perhaps you meant initialize?\n" do
+      Class.new { def intialize; end }
+    end
+  end
+
+  def test_does_not_correct_correct_initializer_name
+    assert_output nil, "" do
+      Class.new { def initialize; end }
+    end
+  end
+end

data/test/extra_features/method_name_checker_test.rb

@@ -0,0 +1,13 @@
+require 'test_helper'
+
+class MethodNameWithExtraFeaturesTest < Minitest::Test
+  def test_corrects_incorrect_ivar_name
+    @number = 1
+    @nubmer = nil
+    error = assert_raises(NoMethodError) { @nubmer.zero? }
+    remove_instance_variable :@nubmer
+
+    assert_correction :@number, error.corrections
+    assert_match "Did you mean?  @number", error.to_s
+  end
+end

data/test/spell_checker_test.rb

@@ -9,7 +9,7 @@ class SpellCheckerTest < Minitest::Test
     end
   end
 
-  def test_similar_to_corrects_mistypes
+  def test_spell_checker_corrects_mistypes
     assert_spell 'foo',   input: 'doo',   dictionary: ['foo', 'fork']
     assert_spell 'email', input: 'meail', dictionary: ['email', 'fail', 'eval']
     assert_spell 'fail',  input: 'fial',  dictionary: ['email', 'fail', 'eval']
@@ -19,8 +19,9 @@ class SpellCheckerTest < Minitest::Test
     assert_spell 'sub!',  input: 'suv!',  dictionary: ['sub', 'gsub', 'sub!']
     assert_spell 'sub',   input: 'suv',   dictionary: ['sub', 'gsub', 'sub!']
 
-    assert_equal %w(gsub! gsub),     SpellChecker.new('gsuv!', %w(sub gsub gsub!)).corrections
-    assert_equal %w(sub! sub gsub!), SpellChecker.new('ssub!', %w(sub sub! gsub gsub!)).corrections
+    assert_spell %w(gsub! gsub),     input: 'gsuv!', dictionary: %w(sub gsub gsub!)
+    assert_spell %w(sub! sub gsub!), input: 'ssub!', dictionary: %w(sub sub! gsub gsub!)
+    assert_spell %i(read rand),      input: 'raed',  dictionary: File.methods + File.private_methods
 
     group_methods = %w(groups group_url groups_url group_path)
     assert_spell 'groups', input: 'group',  dictionary: group_methods
@@ -40,19 +41,19 @@ class SpellCheckerTest < Minitest::Test
     assert_spell 'GroupMembershipDecorator', dictionary: group_classes, input: 'GroupMemberhipDecorator'
 
     names = %w(first_name_change first_name_changed? first_name_will_change!)
-    assert_equal names, SpellChecker.new('first_name_change!', names).corrections
+    assert_spell names, input: 'first_name_change!', dictionary: names
 
     assert_empty SpellChecker.new('product_path', ['proc']).corrections
     assert_empty SpellChecker.new('fooo',         ['fork']).corrections
   end
 
-  def test_similar_to_corrects_misspells
+  def test_spell_checker_corrects_misspells
     assert_spell 'descendants',      input: 'dependents', dictionary: ['descendants']
     assert_spell 'drag_to',          input: 'drag',       dictionary: ['drag_to']
     assert_spell 'set_result_count', input: 'set_result', dictionary: ['set_result_count']
   end
 
-  def test_similar_to_sorts_results_by_simiarity
+  def test_spell_checker_sorts_results_by_simiarity
     expected = %w(
       name123456
       name12345
@@ -75,6 +76,6 @@ class SpellCheckerTest < Minitest::Test
 
   def assert_spell(expected, input: , dictionary: )
     corrections = SpellChecker.new(input, dictionary).corrections
-    assert_equal [expected], corrections, "Expected to suggest #{expected}, but got #{corrections.inspect}"
+    assert_equal Array(expected), corrections, "Expected to suggest #{expected}, but got #{corrections.inspect}"
   end
 end

data/test/verbose_formatter_test.rb

@@ -0,0 +1,17 @@
+require 'test_helper'
+
+class VerboseFormatterTest < Minitest::Test
+  def setup
+    does_exist = does_exist = nil
+    @error = assert_raises(NameError){ doesnt_exist }
+  end
+
+  def test_message
+    assert_equal <<~MESSAGE.chomp, @error.message
+      undefined local variable or method `doesnt_exist' for #{method(:to_s).super_method.call}
+
+          Did you mean? does_exist
+       
+    MESSAGE
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: did_you_mean
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc1
+  version: 1.0.0
 platform: ruby
 authors:
 - Yuki Nishijima
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-08 00:00:00.000000000 Z
+date: 2015-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -81,6 +81,9 @@ files:
 - evaluation/incorrect_words.yaml
 - lib/did_you_mean.rb
 - lib/did_you_mean/core_ext/name_error.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
@@ -90,6 +93,7 @@ files:
 - 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_formatter.rb
 - lib/did_you_mean/version.rb
 - test/core_ext/name_error_extension_test.rb
 - test/correctable/class_name_test.rb
@@ -97,8 +101,11 @@ files:
 - 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/spell_checker_test.rb
 - test/test_helper.rb
+- test/verbose_formatter_test.rb
 homepage: https://github.com/yuki24/did_you_mean
 licenses:
 - MIT
@@ -114,12 +121,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.3.0dev
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.0
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: '"Did you mean?" experience in Ruby'
@@ -130,5 +137,8 @@ test_files:
 - 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/spell_checker_test.rb
 - test/test_helper.rb
+- test/verbose_formatter_test.rb