did_you_mean 0.10.0 → 1.0.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d6d3f969922420aa102b5ee43ea65bdacb2b4725
-  data.tar.gz: f210a32c4570c5dd2e6945651f4151f79a6e3080
+  metadata.gz: 8b34cbc0ccdd5f3ad3b8edce86667a3cc74b5378
+  data.tar.gz: 876c524186e3e5874bd5e481e18aaa94287dad63
 SHA512:
-  metadata.gz: 1c9c187c605e907ee58179f3087d062e33ef69e9b40849b6157eacf9f64c61feb8b1eaa19894ef8e62fcc4d9a5599295551800514dc5285e436ac96a80034ec2
-  data.tar.gz: ad9976fcd8321fa17a083a7f701ff2bd0b143dd3647c1116d0e1a239e26e0f9e4d8bc4fae552320f030620f8fc5da6c9c048c19447a641388a8ee8224e99a423
+  metadata.gz: 76ad432f1fe5a9d346d415a5c09b47f7563c4e176a8b522272a426b7baabbf38b149cfad7c7bf846a991f7599e535a9c6781d8661a7c65f09a638f84edb298e0
+  data.tar.gz: 8b52260010d946d8e341a11cf0969570e3c590da11f65d3c7f920a418714b382e6da7acb30e398ddc55727cee848135c42b338caafd0aced87766357f22b1061

data/.travis.yml

@@ -3,27 +3,9 @@ script:   bundle exec rake test
 cache:    bundler
 sudo:     false
 
-before_install:
-  - 'if [[ "$TRAVIS_RUBY_VERSION" =~ "jruby" ]]; then rvm get head && rvm use --install $TRAVIS_RUBY_VERSION; fi'
-
 after_success:
   - bundle exec rake test:accuracy
   - bundle exec rake benchmark:memory
 
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1
-  - 2.2
   - ruby-head
-  - jruby-1.7.21
-  - jruby-9.0.0.0
-  - jruby-head
-  - rbx-2.4.1
-  - rbx-2.5.8
-
-matrix:
-  allow_failures:
-    - rvm: ruby-head
-    - rvm: jruby-head
-  fast_finish: true

data/CHANGELOG.md

@@ -1,3 +1,28 @@
+## [v0.10.0](https://github.com/yuki24/did_you_mean/tree/v0.10.0)
+
+_<sup>released on 2015-08-21 06:44:11 UTC</sup>_
+
+#### New Features
+
+- Now it corrects an instance variable name if the ivar name is mistyped and `NoMethodError` is raised:
+
+```ruby
+@number = 1
+@nubmer.zero?
+# => NoMethodError: undefined method `zero?' for nil:NilClass
+#
+#     Did you mean? @number
+#
+```
+
+- Support for JRuby 9.0.0.0
+- Prefix-based correction ( [@tjohn](https://github.com/tjohn), [#50](https://github.com/yuki24/did_you_mean/issues/50 "Match start of method name"), [#49](https://github.com/yuki24/did_you_mean/issues/49 "Use Jaro distance instead of Jaro-Winkler distance"))
+- Correction search is about 75% faster than 0.9.10
+
+#### Breaking Changes
+
+- The ActiveRecord integration has been removed
+
 ## [v0.9.10](https://github.com/yuki24/did_you_mean/tree/v0.9.10)
 
 _<sup>released on 2015-05-14 03:04:47 UTC</sup>_
@@ -12,7 +37,7 @@ _<sup>released on 2015-05-13 03:48:19 UTC</sup>_
 
 #### Small/Internal Changes
 
-- Order word suggestions based on Levenshtein distance ( [@tleish](https://github.com/tleish), [#31](https://github.com/yuki24/did_you_mean/pull/31 "Order word suggestions based on Levenshtein.distance."))
+- Order word corrections based on Levenshtein distance ( [@tleish](https://github.com/tleish), [#31](https://github.com/yuki24/did_you_mean/pull/31 "Order word corrections based on Levenshtein.distance."))
 - Reduce memory allocation by about 40%
 - Speed up Levenshtein distance calculation by about 40%
 - The Java extension has been replaced with a pure JRuby implementation
@@ -55,7 +80,7 @@ _<sup>released on 2014-11-19 20:00:00 UTC</sup>_
 
 #### Bug Fixes
 
-- Fixed a bug where no suggestions will be made on JRuby
+- Fixed a bug where no corrections will be made on JRuby
 
 ## [v0.9.3](https://github.com/yuki24/did_you_mean/tree/v0.9.3)
 
@@ -150,7 +175,7 @@ _<sup>released on 2014-05-18 00:23:24 UTC</sup>_
 
 #### New Features
 
-- Added basic support for constants. Now you'll see class name suggestions when you misspelled a class names/module names:
+- Added basic support for constants. Now you'll see class name corrections when you misspelled a class names/module names:
 
 ```ruby
 > Ocject

data/Gemfile

@@ -6,10 +6,3 @@ gemspec
 gem 'benchmark-ips'
 gem 'memory_profiler'
 gem 'jaro_winkler', '~> 1.3.6'
-
-platforms :rbx do
-  gem 'rubysl', '~> 2.0'
-  gem 'rubysl-openssl', '2.2.1'
-  gem 'racc'
-  gem 'rubinius-developer_tools'
-end

data/README.md

@@ -2,15 +2,9 @@
 
 'Did you mean?' experience in Ruby. No, Really.
 
-**For those who are still using 0.6.0, 0.7.0 and 0.8.0, please upgrade to the latest version (0.9.6) as they have a serious bug with Ruby 2.1.3 and 2.1.4 installed on Mac OS X.**
-
 ## Installation
 
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'did_you_mean', group: [:development, :test]
-```
+This gem will automatically be activated when a Ruby process starts up. No special setup is required.
 
 ## Examples
 
@@ -74,18 +68,10 @@ params.with_inddiferent_access
 
 ## 'Did You Mean' Experience is Everywhere
 
-_did\_you\_mean_ gem automagically puts method suggestions into the error message. This means you'll have the "Did you mean?" experience almost everywhere:
+_did\_you\_mean_ gem automagically puts method corrections into the error message. This means you'll have the "Did you mean?" experience almost everywhere:
 
 ![Did you mean? on BetterErrors](https://raw.githubusercontent.com/yuki24/did_you_mean/master/doc/did_you_mean_example.png)
 
-## Support
-
-_did\_you\_mean_ gem supports the following implementations:
-
- * MRI 1.9.3, 2.0.0, 2.1.x, 2.2.x and ruby-head
- * JRuby 1.7.21, 9.0.0.0 and jruby-head
- * Rubinius 2.4.1 and 2.5.8
-
 ## Contributing
 
 1. Fork it (http://github.com/yuki24/did_you_mean/fork)

data/Rakefile

@@ -1,25 +1,13 @@
 require 'bundler/gem_tasks'
-
-if RUBY_ENGINE == "ruby"
-  require 'rake/extensiontask'
-
-  Rake::ExtensionTask.new 'did_you_mean' do |ext|
-    ext.name    = "method_receiver"
-    ext.lib_dir = "lib/did_you_mean"
-  end
-end
-
 require 'rake/testtask'
 
 Rake::TestTask.new do |task|
   task.libs << "test"
   task.pattern = 'test/**/*_test.rb'
   task.verbose = true
-  # task.warning = true
+  task.warning = true
 end
 
-desc "Run tests"
-task test: [:clobber, :compile] if RUBY_ENGINE == 'ruby'
 task default: :test
 
 namespace :test do

data/benchmark/memory_usage.rb

@@ -6,18 +6,18 @@ require 'did_you_mean'
 # executable = -> { error.to_s }
 
 class DidYouMean::WordCollection
-  include DidYouMean::BaseFinder
+  include DidYouMean::SpellCheckable
 
   def initialize(words)
     @words = words
   end
 
   def similar_to(input, filter = EMPTY)
-    @suggestions, @input = nil, input
-    suggestions
+    @corrections, @input = nil, input
+    corrections
   end
 
-  def searches
+  def candidates
     { @input => @words }
   end
 end if !defined?(DidYouMean::WordCollection)

data/did_you_mean.gemspec

@@ -15,22 +15,12 @@ Gem::Specification.new do |spec|
 
   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.test_files    = spec.files.grep(%r{^(test)/})
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = '>= 1.9.3'
-
-  case RUBY_ENGINE
-  when 'ruby'
-    spec.extensions = ["ext/did_you_mean/extconf.rb"]
-  when 'jruby'
-    spec.platform = 'java'
-  end
-
-  spec.add_dependency "interception"
+  spec.required_ruby_version = '>= 2.3.0dev'
 
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "rake-compiler"
   spec.add_development_dependency "minitest"
 end

data/evaluation/calculator.rb

@@ -38,18 +38,18 @@ report "loading program" do
   end
 
   class DidYouMean::WordCollection
-    include DidYouMean::BaseFinder
+    include DidYouMean::SpellCheckable
 
     def initialize(words)
       @words = words
     end
 
     def similar_to(input, filter = EMPTY)
-      @suggestions, @input = nil, input
-      suggestions
+      @corrections, @input = nil, input
+      corrections
     end
 
-    def searches
+    def candidates
       { @input => @words }
     end
 
@@ -119,4 +119,4 @@ File.open(filename, 'w') do |file|
   file.write(words_not_corrected.to_yaml)
 end
 
-puts "Incorrect suggestions were logged to #{filename}."
+puts "Incorrect corrections were logged to #{filename}."

data/lib/did_you_mean.rb

@@ -1,36 +1,28 @@
-require "interception"
-
 require "did_you_mean/version"
 require "did_you_mean/core_ext/name_error"
-require "did_you_mean/core_ext/no_method_error"
-require "did_you_mean/finders"
+
+require "did_you_mean/spell_checkable"
+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'
+
 require "did_you_mean/formatter"
 
 module DidYouMean
-  Interception.listen do |exception, binding|
-    # On IRB/pry console, this event is called twice. In the second event,
-    # we get IRB/pry binding. So it shouldn't override @frame_binding if
-    # it's already defined.
-    if DidYouMean.finders.include?(exception.class.to_s) && !exception.instance_variable_defined?(:@frame_binding)
-      exception.instance_variable_set(:@frame_binding, binding)
-    end
-  end
+  @@trace = TracePoint.new(:raise) do |tp|
+    e, b = tp.raised_exception, tp.binding
 
-  def self.finders
-    @@finders ||= Hash.new(NullFinder)
+    if SPELL_CHECKERS.include?(e.class.to_s) && !e.instance_variable_defined?(:@frame_binding)
+      e.instance_variable_set(:@frame_binding, b)
+    end
   end
+  @@trace.enable
 
-  finders.merge!("NameError" => NameErrorFinders)
+  IGNORED_CALLERS = []
 
-  case RUBY_ENGINE
-  when 'ruby', 'jruby'
-    finders["NoMethodError"] = MethodFinder
-  when 'rbx'
-    finders["NoMethodError"] =
-      if (___ rescue $!).class.to_s == "NameError" # For rbx > 2.5.0
-        MethodFinder
-      else
-        MethodFinder::RubiniusSupport              # For rbx < 2.5.0
-      end
-  end
+  SPELL_CHECKERS = Hash.new(NullChecker)
+  SPELL_CHECKERS.merge!({
+    "NameError"     => NameErrorCheckers,
+    "NoMethodError" => MethodNameChecker
+  })
 end

data/lib/did_you_mean/core_ext/name_error.rb

@@ -1,38 +1,28 @@
 module DidYouMean
   module Correctable
+    prepend_features NameError
     attr_reader :frame_binding
 
-    IGNORED_CALLERS = [
-      /( |`)missing_name'/,
-      /( |`)safe_constantize'/
-    ].freeze
-    private_constant :IGNORED_CALLERS
-
-    def self.included(klass)
-      klass.class_eval do
-        __to_s__ = klass.instance_method(:to_s)
-        define_method(:original_message){ __to_s__.bind(self).call }
+    def original_message
+      method(:to_s).super_method.call
+    end
 
-        def to_s
-          msg = original_message.dup
-          bt  = caller.first(6)
+    def to_s
+      msg = super.dup
+      bt  = caller(1, 6)
 
-          msg << Formatter.new(suggestions).to_s if IGNORED_CALLERS.all? {|ignored| bt.grep(ignored).empty? }
-          msg
-        rescue
-          original_message
-        end
-      end
+      msg << Formatter.new(corrections).to_s if IGNORED_CALLERS.all? {|ignored| bt.grep(ignored).empty? }
+      msg
+    rescue
+      super
     end
 
-    def suggestions
-      finder.suggestions
+    def corrections
+      spell_checker.corrections
     end
 
-    def finder
-      @finder ||= DidYouMean.finders[self.class.to_s].new(self)
+    def spell_checker
+      @spell_checker ||= SPELL_CHECKERS[self.class.to_s].new(self)
     end
   end
 end
-
-NameError.send(:include, DidYouMean::Correctable)

data/lib/did_you_mean/formatter.rb

@@ -1,20 +1,14 @@
 module DidYouMean
   class Formatter
-    def initialize(suggestions = [])
-      @suggestions = suggestions
+    def initialize(corrections = [])
+      @corrections = corrections
     end
 
     def to_s
-      return "" if @suggestions.empty?
+      return "".freeze if @corrections.empty?
 
-      output = "\n\n"
-      output << "    Did you mean? #{format(@suggestions.first)}\n"
-      output << @suggestions.drop(1).map{|word| "#{' ' * 18}#{format(word)}\n" }.join
-      output << " " # for rspec
-    end
-
-    def format(name)
-      name
+      output = "\nDid you mean?  "
+      output << @corrections.join("\n" << ' '.freeze * 15)
     end
   end
 end

data/lib/did_you_mean/jaro_winkler.rb

@@ -13,9 +13,8 @@ module DidYouMean
       flags2     = 0
 
       # Avoid duplicating enumerable objects
-      # Also, call #to_a since #codepoints returns an Enumerator on Ruby 1.9.3.
-      str1_codepoints = str1.codepoints.to_a
-      str2_codepoints = str2.codepoints.to_a
+      str1_codepoints = str1.codepoints
+      str2_codepoints = str2.codepoints
 
       i = 0
       while i < length1
@@ -69,7 +68,7 @@ module DidYouMean
       jaro_distance = Jaro.distance(str1, str2)
 
       if jaro_distance > THRESHOLD
-        codepoints2  = str2.codepoints.to_a
+        codepoints2  = str2.codepoints
         prefix_bonus = 0
 
         i = 0

data/lib/did_you_mean/levenshtein.rb

@@ -12,7 +12,7 @@ module DidYouMean
       x = nil
 
       # to avoid duplicating an enumerable object, create it outside of the loop
-      str2_codepoints = str2.codepoints.to_a
+      str2_codepoints = str2.codepoints
 
       str1.each_codepoint.with_index(1) do |char1, i|
         j = 0

data/lib/did_you_mean/{finders.rb → spell_checkable.rb}

@@ -2,12 +2,12 @@ require "did_you_mean/levenshtein"
 require "did_you_mean/jaro_winkler"
 
 module DidYouMean
-  module BaseFinder
+  module SpellCheckable
     AT    = "@".freeze
     EMPTY = "".freeze
 
-    def suggestions
-      @suggestions ||= searches.flat_map do |input, candidates|
+    def corrections
+      @corrections ||= candidates.flat_map do |input, candidates|
         input     = normalize(input)
         threshold = input.length > 3 ? 0.834 : 0.77
 
@@ -33,7 +33,7 @@ module DidYouMean
       end
     end
 
-    def searches
+    def candidates
       raise NotImplementedError
     end
 
@@ -51,12 +51,4 @@ module DidYouMean
       str
     end
   end
-
-  class NullFinder
-    def initialize(*);  end
-    def suggestions; [] end
-  end
 end
-
-require 'did_you_mean/finders/name_error_finders'
-require 'did_you_mean/finders/method_finder'