did_you_mean 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a2019c6ac910b2da3d762dc857da433d6fe5eeed
+  data.tar.gz: fb22eb4265c9c6824036a4ffd4195d42168ee2fb
+SHA512:
+  metadata.gz: f113cdda3082ce04d30c67a15b3608c60a330d7f9440bb603bfa8a7300a130b2411df8673475dd76dc46c284980516c31ebd612d4a4aa244d3b0726ca7b3bb81
+  data.tar.gz: e05fff9b45e6b98e9ca26f0e5ae993707fd780b8633ca325dd5e946017f0966dc9431b4b3cde73c1bc65fc0fe9b2350b9bc08ff872cf11686c58bb348bf477a6

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in did_you_mean.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Yuki Nishijima
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# 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.
+
+## Examples
+
+On irb:
+
+![Did you mean? on BetterErrors](https://raw2.github.com/yuki24/did_you_mean/master/docs/irb_example.png)
+
+On rspec:
+
+![Did you mean? on BetterErrors](https://raw2.github.com/yuki24/did_you_mean/master/docs/rspec_example.png)
+
+On BetterErrors:
+
+![Did you mean? on BetterErrors](https://raw2.github.com/yuki24/did_you_mean/master/docs/better_errors_example.png)
+
+**Note that this gem makes Ruby nearly 5 times slower.** But patches are always welcome!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```
+gem 'did_you_mean', :group => :development
+```
+
+## Contributing
+
+1. Fork it (http://github.com/yuki24/did_you_mean/fork)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+Copyright (c) 2014 Yuki Nishijima. See MIT-LICENSE for further details.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/did_you_mean.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'did_you_mean/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "did_you_mean"
+  spec.version       = DidYouMean::VERSION
+  spec.authors       = ["Yuki Nishijima"]
+  spec.email         = ["mail@yukinishijima.net"]
+  spec.summary       = %q{Did you mean? in your ruby app}
+  spec.description   = %q{When you made a typo or forgot the correct spelling and got NoMethodError and NameError, this gem tells you the right one you are looking for.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "text"
+  spec.add_dependency "binding_of_caller"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+end

data/lib/did_you_mean.rb

@@ -0,0 +1,8 @@
+require "text"
+require "did_you_mean/version"
+
+require "did_you_mean/core_ext/object"
+require "did_you_mean/core_ext/name_error"
+
+require "did_you_mean/name_error_extension"
+require "did_you_mean/no_method_error_extension"

data/lib/did_you_mean/core_ext/name_error.rb

@@ -0,0 +1,28 @@
+begin
+  require "binding_of_caller"
+  binding_of_caller_available = true
+rescue LoadError => e
+  binding_of_caller_available = false
+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
+        end
+      end
+      original_set_backtrace.bind(self).call(*args)
+    end
+  
+    def __did_you_mean_bindings_stack
+      @__did_you_mean_bindings_stack || []
+    end
+  end
+end

data/lib/did_you_mean/core_ext/object.rb

@@ -0,0 +1,8 @@
+class Object
+  def method_missing(method_name, *args, &block)
+    super
+  rescue NoMethodError => error
+    error.instance_variable_set(:@receiver, self)
+    raise error
+  end
+end

data/lib/did_you_mean/name_error_extension.rb

@@ -0,0 +1,85 @@
+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

@@ -0,0 +1,49 @@
+module DidYouMean
+  module NoMethodErrorExtension
+    attr_reader :receiver
+
+    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

data/lib/did_you_mean/version.rb

@@ -0,0 +1,3 @@
+module DidYouMean
+  VERSION = "0.1.0"
+end

data/test/all_test.rb

@@ -0,0 +1,2 @@
+require_relative 'name_error_extension_test'
+require_relative 'no_method_error_extension_test'

data/test/name_error_extension_test.rb

@@ -0,0 +1,49 @@
+require_relative 'test_helper'
+
+class NameErrorExtensionTest < Test::Unit::TestCase
+  class User
+    def call_flrst_name;  f1rst_name; end
+    def call_fr0m_module; fr0m_module; end
+    def first_name; end
+  end
+
+  module UserModule
+    def from_module; end
+  end
+
+  def setup
+    user = User.new.extend(UserModule)
+
+    @errors = {
+      from_instance_method: assert_raise(NameError){ user.call_flrst_name },
+      from_module_method:   assert_raise(NameError){ user.call_fr0m_module }
+    }
+
+    begin
+      userr
+    rescue NameError => e
+      @instance_variable_error = e
+    end
+  end
+
+  def test_similar_methods
+    assert @errors[:from_instance_method].similar_methods.include?(:first_name)
+    assert @errors[:from_module_method].similar_methods.include?(:from_module)
+  end
+
+  def test_similar_local_variables
+    assert @instance_variable_error.similar_local_variables.include?(:user)
+  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?
+  end
+
+  def test_message
+    assert_match @errors[:from_instance_method].did_you_mean?, @errors[:from_instance_method].message
+    assert_match @errors[:from_module_method].did_you_mean?, @errors[:from_module_method].message
+    assert_match @instance_variable_error.did_you_mean?, @instance_variable_error.message
+  end
+end

data/test/no_method_error_extension_test.rb

@@ -0,0 +1,52 @@
+require_relative 'test_helper'
+
+class NoMethodErrorExtensionTest < Test::Unit::TestCase
+  class User
+    def friends; end
+    def first_name; end
+
+    private
+
+    def friend; end
+
+    class << self
+      def load; end
+    end
+  end
+
+  module UserModule
+    def from_module; end
+  end
+
+  def setup
+    user = User.new.extend(UserModule)
+
+    @errors = {
+      from_instance_method: assert_raise(NoMethodError){ user.flrst_name },
+      from_private_method:  assert_raise(NoMethodError){ user.friend },
+      from_module_method:   assert_raise(NoMethodError){ user.fr0m_module },
+      from_class_method:    assert_raise(NoMethodError){ User.l0ad }
+    }
+  end
+
+  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)
+  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?
+  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
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require 'test/unit'
+require 'did_you_mean'

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: did_you_mean
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yuki Nishijima
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: text
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: binding_of_caller
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: When you made a typo or forgot the correct spelling and got NoMethodError
+  and NameError, this gem tells you the right one you are looking for.
+email:
+- mail@yukinishijima.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- did_you_mean.gemspec
+- docs/better_errors_example.png
+- docs/irb_example.png
+- docs/rspec_example.png
+- lib/did_you_mean.rb
+- lib/did_you_mean/core_ext/name_error.rb
+- lib/did_you_mean/core_ext/object.rb
+- lib/did_you_mean/name_error_extension.rb
+- lib/did_you_mean/no_method_error_extension.rb
+- lib/did_you_mean/version.rb
+- test/all_test.rb
+- test/name_error_extension_test.rb
+- test/no_method_error_extension_test.rb
+- test/test_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: Did you mean? in your ruby app
+test_files:
+- test/all_test.rb
+- test/name_error_extension_test.rb
+- test/no_method_error_extension_test.rb
+- test/test_helper.rb