did_you_mean 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d9eea98979aeabd698ae78189646cefa0314cec5
-  data.tar.gz: ace02ada986efdff6a6a533ae0b5d99b199fb3b5
+  metadata.gz: 7304160d0a724a77cd37f5c0ad3068f6469117ea
+  data.tar.gz: 398c18be7e4768cb7bab4a1e5c335a70d2b005dc
 SHA512:
-  metadata.gz: 42e54d2533c9ac9d507c0490538cf3020e40f9a0fde864ebdfa7ca728549953d4527e0e7310c31fb62e7e56375d257db54c23137929b3d25e0fa80e0d87907bf
-  data.tar.gz: cde32b820adfee6dfc0efce16a6653dab84fcb9ffc7bef07e495e44d3b9c5629bbe5bf2acd10512b40e92befded13793980b2ce1e7d2cb1cd5056953a85e1a54
+  metadata.gz: 0bc3de404cf9341f59d6068e9c768c6592735e7152b3c6e0698c34d73a6c2b72ea7e9c87a0b2de8b4f6bef84ea1b2eb3f5205af8e4e3d2d4ecbb3bc2824771e5
+  data.tar.gz: f48fc7b6ba5fbeb05f8994f0892eeeedf62b3270424e0001d9a232a03c1111bce626c77804ae3ebbc14fdc3e7c40a2f36700c6391d6701943b93d3a8f0f0ade0

data/.gitignore

@@ -5,6 +5,7 @@
 .yardoc
 .DS_Store
 Gemfile.lock
+gemfiles/*.lock
 InstalledFiles
 _yardoc
 coverage

data/.travis.yml

@@ -1,4 +1,4 @@
-script: "rake test"
+script: "bundle install && bundle exec rake test"
 
 rvm:
   - 1.9.3
@@ -6,3 +6,14 @@ rvm:
   - 2.1.0
   - 2.1.1
   - ruby-head
+
+gemfile:
+  - gemfiles/activerecord_30.gemfile
+  - gemfiles/activerecord_31.gemfile
+  - gemfiles/activerecord_32.gemfile
+  - gemfiles/activerecord_40.gemfile
+  - gemfiles/activerecord_41.gemfile
+  - gemfiles/activerecord_edge.gemfile
+
+matrix:
+  fast_finish: true

data/Appraisals

@@ -0,0 +1,25 @@
+appraise "activerecord_30" do
+  gem "activerecord", "~> 3.0.0"
+end
+
+appraise "activerecord_31" do
+  gem "activerecord", "~> 3.1.0"
+end
+
+appraise "activerecord_32" do
+  gem "activerecord", "~> 3.2.0"
+end
+
+appraise "activerecord_40" do
+  gem "activerecord", "~> 4.0.0"
+end
+
+appraise "activerecord_41" do
+  gem "activerecord", "~> 4.1.0"
+end
+
+appraise "activerecord_edge" do
+  git 'git://github.com/rails/rails.git' do
+    gem 'activerecord', require: 'activerecord'
+  end
+end

data/Rakefile

@@ -25,3 +25,12 @@ task :test do
 
   Rake::Task['clobber'].execute
 end
+
+namespace :test do
+  desc "Run tests without re-compiling extensions"
+  task :without_compile do
+    $stdout.puts("\033[33m")
+    sh "bundle exec ruby test/all_test.rb"
+    $stdout.puts("\033[0m")
+  end
+end

data/did_you_mean.gemspec

@@ -25,8 +25,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rake-compiler"
-
-  if RUBY_VERSION == "2.2.0"
-    spec.add_development_dependency "minitest", '< 5.0.0'
-  end
+  spec.add_development_dependency "appraisal"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "minitest"
 end

data/gemfiles/activerecord_30.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 3.0.0"
+
+gemspec :path => "../"

data/gemfiles/activerecord_31.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 3.1.0"
+
+gemspec :path => "../"

data/gemfiles/activerecord_32.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 3.2.0"
+
+gemspec :path => "../"

data/gemfiles/activerecord_40.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 4.0.0"
+
+gemspec :path => "../"

data/gemfiles/activerecord_41.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 4.1.0"
+
+gemspec :path => "../"

data/gemfiles/activerecord_edge.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+git "git://github.com/rails/rails.git" do
+  gem "activerecord", :require => "activerecord"
+end
+
+gemspec :path => "../"

data/lib/did_you_mean.rb

@@ -1,6 +1,6 @@
 require "did_you_mean/version"
 require "did_you_mean/method_missing"
 require "did_you_mean/method_finder"
+require "did_you_mean/strategies"
 
 require "did_you_mean/core_ext/name_error"
-require "did_you_mean/core_ext/no_method_error"

data/lib/did_you_mean/core_ext/name_error.rb

@@ -40,48 +40,22 @@ class NameError
     @__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
+  def frame_binding
+    @frame_binding ||= __did_you_mean_bindings_stack.first
   end
 
-  def similar_methods
-    @similar_methods ||= DidYouMean::MethodFinder.new(frame_binding.eval("methods"), name).similar_methods
+  def to_s_with_did_you_mean
+    original_message + did_you_mean?.to_s
   end
 
-  def similar_local_variables
-    @similar_local_variables ||= DidYouMean::MethodFinder.new(frame_binding.eval("local_variables"), name).similar_methods
-  end
+  alias original_message to_s
+  alias             to_s to_s_with_did_you_mean
 
-  def undefined_local_variable_or_method?
-    original_to_s.include?("undefined local variable or method")
+  def did_you_mean?
+    method_finder.did_you_mean? if not method_finder.empty?
   end
 
-  def frame_binding
-    @frame_binding ||= __did_you_mean_bindings_stack.first
+  def method_finder
+    @method_finder ||= DidYouMean.strategies[self.class.to_s].build(self)
   end
 end

data/lib/did_you_mean/method_finder.rb

@@ -1,7 +1,7 @@
 require "text"
 
 module DidYouMean
-  class MethodFinder
+  class MethodMatcher
     def initialize(method_collection, target_method)
       @method_collection = method_collection.uniq
       @target_method     = target_method

data/lib/did_you_mean/strategies.rb

@@ -0,0 +1,23 @@
+module DidYouMean
+  class NullFinder
+    def self.build(*)
+      new
+    end
+
+    def did_you_mean?; end
+
+    def empty?
+      true
+    end
+  end
+
+  @@strategies = Hash.new(NullFinder)
+
+  def self.strategies
+    @@strategies
+  end
+end
+
+require 'did_you_mean/strategies/similar_name_finder'
+require 'did_you_mean/strategies/similar_method_finder'
+require 'did_you_mean/strategies/similar_attribute_finder'

data/lib/did_you_mean/strategies/similar_attribute_finder.rb

@@ -0,0 +1,41 @@
+module DidYouMean
+  class SimilarAttributeFinder
+    attr_reader :columns, :attribute_name
+
+    def self.build(exception)
+      columns        = exception.frame_binding.eval("self.class").columns
+      attribute_name = exception.original_message.gsub("unknown attribute: ", "")
+
+      new(attribute_name, columns)
+    end
+
+    def initialize(attribute_name, columns)
+      @attribute_name, @columns = attribute_name, columns
+    end
+
+    def did_you_mean?
+      return if empty?
+
+      output = "\n\n"
+      output << "    Did you mean? #{format(similar_columns.first)}\n"
+      output << similar_columns[1..-1].map{|word| "#{' ' * 18}#{format(word)}\n" }.join
+      output
+    end
+
+    def empty?
+      similar_columns.empty?
+    end
+
+    def similar_columns
+      @similar_columns ||= MethodMatcher.new(columns.map(&:name), attribute_name).similar_methods
+    end
+
+    private
+
+    def format(name)
+      "%s: %s" % [name, columns.detect{|c| c.name == name }.type]
+    end
+  end
+
+  strategies["ActiveRecord::UnknownAttributeError"] = SimilarAttributeFinder
+end

data/lib/did_you_mean/strategies/similar_method_finder.rb

@@ -0,0 +1,46 @@
+module DidYouMean
+  class SimilarMethodFinder
+    attr_reader :name, :receiver
+
+    def self.build(exception)
+      new(exception.name, exception.args.first)
+    end
+
+    def initialize(name, receiver)
+      @name, @receiver = name, receiver
+    end
+
+    def did_you_mean?
+      return if 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
+      output
+    end
+
+    def empty?
+      similar_methods.empty?
+    end
+
+    def similar_methods
+      @similar_methods ||= MethodMatcher.new(receiver.methods + receiver.singleton_methods, name).similar_methods
+    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
+
+  strategies["NoMethodError"] = SimilarMethodFinder
+end

data/lib/did_you_mean/strategies/similar_name_finder.rb

@@ -0,0 +1,57 @@
+module DidYouMean
+  class SimilarNameFinder
+    attr_reader :name, :_methods, :_local_variables, :original_message
+
+    def self.build(exception)
+      methods          = exception.frame_binding.eval("methods")
+      local_variables  = exception.frame_binding.eval("local_variables")
+      original_message = exception.original_message
+
+      new(exception.name, methods, local_variables, original_message)
+    end
+
+    def initialize(name, methods, local_variables, original_message)
+      @name, @_methods, @_local_variables, @original_message =
+        name, methods, local_variables, original_message
+    end
+
+    def did_you_mean?
+      return if 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 empty?
+      !undefined_local_variable_or_method? || (similar_methods.empty? && similar_local_variables.empty?)
+    end
+
+    def similar_methods
+      @similar_methods ||= DidYouMean::MethodMatcher.new(_methods, name).similar_methods
+    end
+
+    def similar_local_variables
+      @similar_local_variables ||= DidYouMean::MethodMatcher.new(_local_variables, name).similar_methods
+    end
+
+    def undefined_local_variable_or_method?
+      original_message.include?("undefined local variable or method")
+    end
+  end
+
+  strategies["NameError"] = SimilarNameFinder
+end

data/lib/did_you_mean/version.rb

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

data/test.sh

@@ -0,0 +1,18 @@
+#!/usr/bin/env bash
+
+for ruby_version in 1.9.3-p545 2.0.0-p451 2.1.0 2.1.1 head
+do
+  echo -e "\e[32mTesting did_you_mean for Ruby $ruby_version\e[39m"
+
+  source ~/.rvm/environments/ruby-$ruby_version
+  ruby -v
+
+  bundle install
+  appraisal install
+
+  rake compile
+  appraisal rake test:without_compile
+  rake clobber
+
+  echo ""
+done

data/test/all_test.rb

@@ -1,2 +1,3 @@
-require_relative 'name_error_extension_test'
-require_relative 'no_method_error_extension_test'
+require_relative 'similar_name_finder_test'
+require_relative 'similar_method_finder_test'
+require_relative 'similar_attribute_finder_test'

data/test/similar_attribute_finder_test.rb

@@ -0,0 +1,21 @@
+require_relative 'test_helper'
+
+class SimilarAttributeFinderTest < Minitest::Test
+  def setup
+    @error = assert_raises(ActiveRecord::UnknownAttributeError) do
+      User.new(flrst_name: "wrong flrst name")
+    end
+  end
+
+  def test_similar_columns
+    assert @error.method_finder.similar_columns.include?("first_name")
+  end
+
+  def test_did_you_mean?
+    assert_match "Did you mean? first_name: string", @error.did_you_mean?
+  end
+
+  def test_message
+    assert_match @error.did_you_mean?, @error.message
+  end
+end

data/test/{no_method_error_extension_test.rb → similar_method_finder_test.rb}

@@ -1,6 +1,6 @@
 require_relative 'test_helper'
 
-class NoMethodErrorExtensionTest < Test::Unit::TestCase
+class SimilarMethodFinderTest < Minitest::Test
   class User
     def friends; end
     def first_name; end
@@ -23,23 +23,33 @@ class NoMethodErrorExtensionTest < Test::Unit::TestCase
     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 }
+      from_instance_method: assert_raises(NoMethodError){ user.flrst_name },
+      from_private_method:  assert_raises(NoMethodError){ user.friend },
+      from_module_method:   assert_raises(NoMethodError){ user.fr0m_module },
+      from_class_method:    assert_raises(NoMethodError){ User.l0ad }
     }
   end
 
+  def test_unknown_attribute_error_with_did_you_mean
+    error = assert_raises(ActiveRecord::UnknownAttributeError) do
+      ::User.new(flrst_name: "wrong flrst name")
+    end
+
+    assert error.method_finder.similar_columns.include?("first_name")
+    assert_match "Did you mean? first_name", error.did_you_mean?
+    assert_match error.did_you_mean?, error.message
+  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)
+    assert @errors[:from_instance_method].method_finder.similar_methods.include?(:first_name)
+    assert  @errors[:from_private_method].method_finder.similar_methods.include?(:friends)
+    assert   @errors[:from_module_method].method_finder.similar_methods.include?(:from_module)
+    assert    @errors[:from_class_method].method_finder.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)
+    error = assert_raises(NoMethodError){ User.new.dependents }
+    assert error.method_finder.similar_methods.include?(:descendants)
   end
 
   def test_did_you_mean?

data/test/{name_error_extension_test.rb → similar_name_finder_test.rb}

@@ -1,6 +1,6 @@
 require_relative 'test_helper'
 
-class NameErrorExtensionTest < Test::Unit::TestCase
+class SimilarNameFinderTest < Minitest::Test
   class User
     def call_flrst_name;  f1rst_name; end
     def call_fr0m_module; fr0m_module; end
@@ -15,8 +15,8 @@ class NameErrorExtensionTest < Test::Unit::TestCase
     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 }
+      from_instance_method: assert_raises(NameError){ user.call_flrst_name },
+      from_module_method:   assert_raises(NameError){ user.call_fr0m_module }
     }
 
     begin
@@ -27,12 +27,12 @@ class NameErrorExtensionTest < Test::Unit::TestCase
   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)
+    assert @errors[:from_instance_method].method_finder.similar_methods.include?(:first_name)
+    assert @errors[:from_module_method].method_finder.similar_methods.include?(:from_module)
   end
 
   def test_similar_local_variables
-    assert @instance_variable_error.similar_local_variables.include?(:user)
+    assert @instance_variable_error.method_finder.similar_local_variables.include?(:user)
   end
 
   def test_did_you_mean?

data/test/test_helper.rb

@@ -1,2 +1,25 @@
-require 'test/unit'
+require 'minitest/autorun'
+require 'minitest/unit'
 require 'did_you_mean'
+require 'active_record'
+
+begin
+  MiniTest::Test
+rescue NameError
+  MiniTest::Test = MiniTest::Unit::TestCase
+end
+
+# database
+ActiveRecord::Base.configurations = {'test' => {adapter: 'sqlite3', database: ':memory:'}}
+ActiveRecord::Base.establish_connection('test')
+
+# models
+class User < ActiveRecord::Base; end
+
+class CreateAllTables < ActiveRecord::Migration
+  def self.up
+    create_table(:users) {|t| t.string :first_name; t.integer :last_name }
+  end
+end
+ActiveRecord::Migration.verbose = false
+CreateAllTables.up

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: did_you_mean
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Yuki Nishijima
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-20 00:00:00.000000000 Z
+date: 2014-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: text
@@ -80,6 +80,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  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'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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'
+- !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:
@@ -91,6 +133,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- Appraisals
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -231,14 +274,25 @@ files:
 - ext/did_you_mean/ruby_headers/220/vm_insnhelper.h
 - ext/did_you_mean/ruby_headers/220/vm_opts.h
 - ext/did_you_mean/vm_method.c
+- gemfiles/activerecord_30.gemfile
+- gemfiles/activerecord_31.gemfile
+- gemfiles/activerecord_32.gemfile
+- gemfiles/activerecord_40.gemfile
+- gemfiles/activerecord_41.gemfile
+- gemfiles/activerecord_edge.gemfile
 - lib/did_you_mean.rb
 - lib/did_you_mean/core_ext/name_error.rb
-- lib/did_you_mean/core_ext/no_method_error.rb
 - lib/did_you_mean/method_finder.rb
+- lib/did_you_mean/strategies.rb
+- lib/did_you_mean/strategies/similar_attribute_finder.rb
+- lib/did_you_mean/strategies/similar_method_finder.rb
+- lib/did_you_mean/strategies/similar_name_finder.rb
 - lib/did_you_mean/version.rb
+- test.sh
 - test/all_test.rb
-- test/name_error_extension_test.rb
-- test/no_method_error_extension_test.rb
+- test/similar_attribute_finder_test.rb
+- test/similar_method_finder_test.rb
+- test/similar_name_finder_test.rb
 - test/test_helper.rb
 homepage: https://github.com/yuki24/did_you_mean
 licenses:
@@ -266,6 +320,7 @@ specification_version: 4
 summary: '"Did you mean?" experience in Ruby'
 test_files:
 - test/all_test.rb
-- test/name_error_extension_test.rb
-- test/no_method_error_extension_test.rb
+- test/similar_attribute_finder_test.rb
+- test/similar_method_finder_test.rb
+- test/similar_name_finder_test.rb
 - test/test_helper.rb

data/lib/did_you_mean/core_ext/no_method_error.rb

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