did_you_mean 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b5f579d6e5e2ef666475d3d06c97d5b7d63c30a3
-  data.tar.gz: ace6e5be8e4d7c9b62c66e4f8a49ff312ca1332c
+  metadata.gz: d9eea98979aeabd698ae78189646cefa0314cec5
+  data.tar.gz: ace02ada986efdff6a6a533ae0b5d99b199fb3b5
 SHA512:
-  metadata.gz: 47db0656a551476e4da2660ea2cf96ae3fbf2453e382f03d25bbb94a99ca7a873aca61f45886cca87b21cf4712138f8a38eaa08952ee4cf4267f70d20e6e3d4c
-  data.tar.gz: f08a8fa9bc6f57b78bd6e9b3478f112c2e96fbb70bd2f9f04ca61b6fb1735af9e8d85fd02d38c61006ebcd0797965993148924d730358504d5aab74fae2cd8b6
+  metadata.gz: 42e54d2533c9ac9d507c0490538cf3020e40f9a0fde864ebdfa7ca728549953d4527e0e7310c31fb62e7e56375d257db54c23137929b3d25e0fa80e0d87907bf
+  data.tar.gz: cde32b820adfee6dfc0efce16a6653dab84fcb9ffc7bef07e495e44d3b9c5629bbe5bf2acd10512b40e92befded13793980b2ce1e7d2cb1cd5056953a85e1a54

data/README.md

@@ -1,4 +1,4 @@
-# Did You Mean!??
+# Did You Mean!?? [![Build Status](https://travis-ci.org/yuki24/did_you_mean.png?branch=master)](https://travis-ci.org/yuki24/did_you_mean)
 
 Google tells you the right keyword if you made a typo. This gem gives similar experience when you get `NoMethodError` or `NameError` in Ruby.
 

data/did_you_mean.gemspec

@@ -27,6 +27,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake-compiler"
 
   if RUBY_VERSION == "2.2.0"
-    spec.add_development_dependency "minitest"
+    spec.add_development_dependency "minitest", '< 5.0.0'
   end
 end

data/lib/did_you_mean.rb

@@ -1,7 +1,6 @@
-require "text"
 require "did_you_mean/version"
-
 require "did_you_mean/method_missing"
+require "did_you_mean/method_finder"
+
 require "did_you_mean/core_ext/name_error"
-require "did_you_mean/name_error_extension"
-require "did_you_mean/no_method_error_extension"
+require "did_you_mean/core_ext/no_method_error"

data/lib/did_you_mean/core_ext/name_error.rb

@@ -1,28 +1,87 @@
 begin
   require "binding_of_caller"
-  binding_of_caller_available = true
 rescue LoadError => e
-  binding_of_caller_available = false
+  puts "could not load binding_of_caller. please make sure it is included in the Gemfile."
+  raise e
 end
 
-if binding_of_caller_available
-  class NameError
-    original_set_backtrace = instance_method(:set_backtrace)
-
-    define_method :set_backtrace do |*args|
-      unless Thread.current[:__did_you_mean_exception_lock]
-        Thread.current[:__did_you_mean_exception_lock] = true
-        begin
-          @__did_you_mean_bindings_stack = binding.callers.drop(1)
-        ensure
-          Thread.current[:__did_you_mean_exception_lock] = false
+class NameError
+  begin
+    require "active_support/core_ext/name_error"
+
+    if method_defined?(:missing_name)
+      def missing_name_without_did_you_mean
+        if /undefined local variable or method/ !~ original_message
+          $1 if /((::)?([A-Z]\w*)(::[A-Z]\w*)*)$/ =~ original_message
         end
       end
-      original_set_backtrace.bind(self).call(*args)
+
+      alias missing_name_with_did_you_mean missing_name
+      alias missing_name missing_name_without_did_you_mean
+    end
+  rescue LoadError
+  end
+
+  original_set_backtrace = instance_method(:set_backtrace)
+
+  define_method :set_backtrace do |*args|
+    unless Thread.current[:__did_you_mean_exception_lock]
+      Thread.current[:__did_you_mean_exception_lock] = true
+      begin
+        @__did_you_mean_bindings_stack = binding.callers.drop(1)
+      ensure
+        Thread.current[:__did_you_mean_exception_lock] = false
+      end
     end
+    original_set_backtrace.bind(self).call(*args)
+  end
   
-    def __did_you_mean_bindings_stack
-      @__did_you_mean_bindings_stack || []
+  def __did_you_mean_bindings_stack
+    @__did_you_mean_bindings_stack || []
+  end
+
+  def to_s_with_did_you_mean
+    original_to_s + did_you_mean?.to_s
+  end
+
+  alias original_to_s to_s
+  alias          to_s to_s_with_did_you_mean
+  alias original_message original_to_s
+
+  def did_you_mean?
+    return if !undefined_local_variable_or_method? || (similar_methods.empty? && similar_local_variables.empty?)
+
+    output = "\n\n"
+    output << "   Did you mean?\n"
+
+    unless similar_methods.empty?
+      output << "     instance methods: ##{similar_methods.first}\n"
+      output << similar_methods[1..-1].map{|word| "#{' ' * 23}##{word}\n" }.join
+    end
+
+    output << "\n" if !similar_methods.empty? && !similar_local_variables.empty?
+
+    unless similar_local_variables.empty?
+      output << "      local variables: #{similar_local_variables.map.first}\n"
+      output << similar_local_variables[1..-1].map{|word| "#{' ' * 23}##{word}\n" }.join
     end
+
+    output
+  end
+
+  def similar_methods
+    @similar_methods ||= DidYouMean::MethodFinder.new(frame_binding.eval("methods"), name).similar_methods
+  end
+
+  def similar_local_variables
+    @similar_local_variables ||= DidYouMean::MethodFinder.new(frame_binding.eval("local_variables"), name).similar_methods
+  end
+
+  def undefined_local_variable_or_method?
+    original_to_s.include?("undefined local variable or method")
+  end
+
+  def frame_binding
+    @frame_binding ||= __did_you_mean_bindings_stack.first
   end
 end

data/lib/did_you_mean/core_ext/no_method_error.rb

@@ -0,0 +1,29 @@
+class NoMethodError
+  def receiver
+    args.first
+  end
+
+  def did_you_mean?
+    return if similar_methods.empty?
+
+    output = "\n\n"
+    output << "   Did you mean? #{separator}#{similar_methods.first}\n"
+    output << similar_methods[1..-1].map{|word| "#{' ' * 17}#{separator}#{word}\n" }.join
+  end
+
+  def similar_methods
+    @similar_methods ||= DidYouMean::MethodFinder.new(receiver.methods + receiver.singleton_methods, name).similar_methods
+  end
+
+  def receiver_name
+    class_method? ? receiver.name : receiver.class.name
+  end
+
+  def separator
+    class_method? ? "." : "#"
+  end
+
+  def class_method?
+    receiver.is_a? Class
+  end
+end

data/lib/did_you_mean/method_finder.rb

@@ -0,0 +1,24 @@
+require "text"
+
+module DidYouMean
+  class MethodFinder
+    def initialize(method_collection, target_method)
+      @method_collection = method_collection.uniq
+      @target_method     = target_method
+    end
+
+    def similar_methods
+      @similar_methods ||= method_collection.select do |method|
+        ::Text::Levenshtein.distance(method.to_s, target_method.to_s) <= sensitiveness
+      end
+    end
+
+    private
+
+    attr_reader :method_collection, :target_method
+
+    def sensitiveness
+      (target_method.size * 0.3).ceil
+    end
+  end
+end

data/lib/did_you_mean/version.rb

@@ -1,3 +1,3 @@
 module DidYouMean
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

data/test/name_error_extension_test.rb

@@ -36,9 +36,14 @@ class NameErrorExtensionTest < Test::Unit::TestCase
   end
 
   def test_did_you_mean?
-    assert_equal "\n\nDid you mean?\n    instance methods:\n\t#first_name\n\n", @errors[:from_instance_method].did_you_mean?
-    assert_equal "\n\nDid you mean?\n    instance methods:\n\t#from_module\n\n", @errors[:from_module_method].did_you_mean?
-    assert_equal "\n\nDid you mean?\n    local variables:\n\tuser\n\n", @instance_variable_error.did_you_mean?
+    assert_match "Did you mean?", @errors[:from_instance_method].did_you_mean?
+    assert_match "instance methods: #first_name", @errors[:from_instance_method].did_you_mean?
+
+    assert_match "Did you mean?", @errors[:from_module_method].did_you_mean?
+    assert_match "instance methods: #from_module", @errors[:from_module_method].did_you_mean?
+
+    assert_match "Did you mean?", @instance_variable_error.did_you_mean?
+    assert_match "local variables: user", @instance_variable_error.did_you_mean?
   end
 
   def test_message

data/test/no_method_error_extension_test.rb

@@ -4,6 +4,7 @@ class NoMethodErrorExtensionTest < Test::Unit::TestCase
   class User
     def friends; end
     def first_name; end
+    def descendants; end
 
     private
 
@@ -31,22 +32,27 @@ class NoMethodErrorExtensionTest < Test::Unit::TestCase
 
   def test_similar_methods
     assert @errors[:from_instance_method].similar_methods.include?(:first_name)
-    assert @errors[:from_private_method].similar_methods.include?(:friends)
-    assert @errors[:from_module_method].similar_methods.include?(:from_module)
-    assert @errors[:from_class_method].similar_methods.include?(:load)
+    assert  @errors[:from_private_method].similar_methods.include?(:friends)
+    assert   @errors[:from_module_method].similar_methods.include?(:from_module)
+    assert    @errors[:from_class_method].similar_methods.include?(:load)
+  end
+
+  def test_similar_methods_for_long_method_name
+    error = assert_raise(NoMethodError){ User.new.dependents }
+    assert error.similar_methods.include?(:descendants)
   end
 
   def test_did_you_mean?
-    assert_equal "\n\nDid you mean?\n\tNoMethodErrorExtensionTest::User#first_name\n\n", @errors[:from_instance_method].did_you_mean?
-    assert_equal "\n\nDid you mean?\n\tNoMethodErrorExtensionTest::User#friends\n\n", @errors[:from_private_method].did_you_mean?
-    assert_equal "\n\nDid you mean?\n\tNoMethodErrorExtensionTest::User#from_module\n\n", @errors[:from_module_method].did_you_mean?
-    assert_equal "\n\nDid you mean?\n\tNoMethodErrorExtensionTest::User.load\n\n", @errors[:from_class_method].did_you_mean?
+    assert_match "Did you mean? #first_name",  @errors[:from_instance_method].did_you_mean?
+    assert_match "Did you mean? #friends",     @errors[:from_private_method].did_you_mean?
+    assert_match "Did you mean? #from_module", @errors[:from_module_method].did_you_mean?
+    assert_match "Did you mean? .load",        @errors[:from_class_method].did_you_mean?
   end
 
   def test_message
     assert_match @errors[:from_instance_method].did_you_mean?, @errors[:from_instance_method].message
-    assert_match @errors[:from_private_method].did_you_mean?, @errors[:from_private_method].message
-    assert_match @errors[:from_module_method].did_you_mean?, @errors[:from_module_method].message
-    assert_match @errors[:from_class_method].did_you_mean?, @errors[:from_class_method].message
+    assert_match  @errors[:from_private_method].did_you_mean?,  @errors[:from_private_method].message
+    assert_match   @errors[:from_module_method].did_you_mean?,   @errors[:from_module_method].message
+    assert_match    @errors[:from_class_method].did_you_mean?,    @errors[:from_class_method].message
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: did_you_mean
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Yuki Nishijima
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-25 00:00:00.000000000 Z
+date: 2014-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: text
@@ -80,20 +80,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: It adds "did you mean?" experience on NoMethodError and NameError because
   of a typo.
 email:
@@ -247,8 +233,8 @@ files:
 - ext/did_you_mean/vm_method.c
 - lib/did_you_mean.rb
 - lib/did_you_mean/core_ext/name_error.rb
-- lib/did_you_mean/name_error_extension.rb
-- lib/did_you_mean/no_method_error_extension.rb
+- lib/did_you_mean/core_ext/no_method_error.rb
+- lib/did_you_mean/method_finder.rb
 - lib/did_you_mean/version.rb
 - test/all_test.rb
 - test/name_error_extension_test.rb

data/lib/did_you_mean/name_error_extension.rb

@@ -1,85 +0,0 @@
-module DidYouMean
-  module NameErrorExtension
-    def self.included(base)
-      base.class_eval do
-        alias original_to_s to_s
-        alias          to_s to_s_with_did_you_mean
-
-        alias original_message original_to_s
-
-        begin
-          require "active_support/core_ext/name_error"
-          if method_defined?(:missing_name)
-            alias missing_name_with_did_you_mean missing_name
-            alias missing_name missing_name_without_did_you_mean
-          end
-        rescue LoadError; end
-      end
-    end
-
-    def missing_name_without_did_you_mean
-      if /undefined local variable or method/ !~ original_message
-        $1 if /((::)?([A-Z]\w*)(::[A-Z]\w*)*)$/ =~ original_message
-      end
-    end
-
-    def to_s_with_did_you_mean
-      original_to_s + did_you_mean?.to_s
-    end
-
-    def did_you_mean?
-      return if !undefined_local_variable_or_method? || (similar_methods.empty? && similar_local_variables.empty?)
-
-      output = "\n\n"
-      output << "Did you mean?" << "\n"
-
-      unless similar_methods.empty?
-        output << "    instance methods:" << "\n"
-        output << similar_methods.map{|word| "\t##{word}" }.join("\n") << "\n"
-        output << "\n"
-      end
-
-      unless similar_local_variables.empty?
-        output << "    local variables:" << "\n"
-        output << similar_local_variables.map{|word| "\t#{word}" }.join("\n") << "\n"
-        output << "\n"
-      end
-
-      output
-    end
-
-    def similar_methods
-      @similar_methods ||= _methods.uniq.select do |method|
-        ::Text::Levenshtein.distance(method.to_s, name.to_s) <= 2
-      end
-    end
-
-    def similar_local_variables
-      @similar_local_variables ||= _local_variables.uniq.select do |method|
-        ::Text::Levenshtein.distance(method.to_s, name.to_s) <= 2
-      end
-    end
-
-    private
-
-    def undefined_local_variable_or_method?
-      original_to_s.include?("undefined local variable or method")
-    end
-
-    def _methods
-      @_methods ||= frame_binding.eval("methods")
-    end
-
-    def _local_variables
-      @_local_variables ||= frame_binding.eval("local_variables")
-    end
-
-    def frame_binding
-      @frame_binding ||= __did_you_mean_bindings_stack.detect do |binding|
-        !binding.eval("__FILE__").include?("lib/did_you_mean/core_ext/object.rb")
-      end
-    end
-  end
-end
-
-NameError.send :include, DidYouMean::NameErrorExtension

data/lib/did_you_mean/no_method_error_extension.rb

@@ -1,51 +0,0 @@
-module DidYouMean
-  module NoMethodErrorExtension
-    def receiver
-      args.first
-    end
-
-    def self.included(base)
-      base.class_eval do
-        alias all_backtrace backtrace
-        alias backtrace backtrace_without_unneeded_lines
-      end
-    end
-
-    def backtrace_without_unneeded_lines
-      all_backtrace.reject do |line|
-        line.include?("lib/did_you_mean/core_ext/object.rb")
-      end if all_backtrace.is_a?(Array)
-    end
-
-    def did_you_mean?
-      return if similar_methods.empty?
-
-      output = "\n\n"
-      output << "Did you mean?" << "\n"
-      output << similar_methods.map{|word| "\t#{receiver_name}#{separator}#{word}" }.join("\n") << "\n"
-      output << "\n"
-    end
-
-    def similar_methods
-      @similar_methods ||= (receiver.methods + receiver.singleton_methods).uniq.select do |method|
-        ::Text::Levenshtein.distance(method.to_s, name.to_s) <= 2
-      end
-    end
-
-    private
-
-    def receiver_name
-      class_method? ? receiver.name : receiver.class.name
-    end
-
-    def separator
-      class_method? ? "." : "#"
-    end
-
-    def class_method?
-      receiver.is_a? Class
-    end
-  end
-end
-
-NoMethodError.send :include, DidYouMean::NoMethodErrorExtension