did_you_mean 0.9.10-java → 0.10.0-java

data/lib/did_you_mean/jaro_winkler.rb

@@ -0,0 +1,87 @@
+module DidYouMean
+  module Jaro
+    module_function
+
+    def distance(str1, str2)
+      str1, str2 = str2, str1 if str1.length > str2.length
+      length1, length2 = str1.length, str2.length
+
+      m          = 0.0
+      t          = 0.0
+      range      = (length2 / 2).floor - 1
+      flags1     = 0
+      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
+
+      i = 0
+      while i < length1
+        last = i + range
+        j    = (i >= range) ? i - range : 0
+
+        while j <= last
+          if flags2[j] == 0 && str1_codepoints[i] == str2_codepoints[j]
+            flags2 |= (1 << j)
+            flags1 |= (1 << i)
+            m += 1
+            break
+          end
+
+          j += 1
+        end
+
+        i += 1
+      end
+
+      k = i = 0
+      while i < length1
+        if flags1[i] != 0
+          j = index = k
+
+          k = while j < length2
+            index = j
+            break(j + 1) if flags2[j] != 0
+
+            j += 1
+          end
+
+          t += 1 if str1_codepoints[i] != str2_codepoints[index]
+        end
+
+        i += 1
+      end
+      t = (t / 2).floor
+
+      m == 0 ? 0 : (m / length1 + m / length2 + (m - t) / m) / 3
+    end
+  end
+
+  module JaroWinkler
+    WEIGHT    = 0.1
+    THRESHOLD = 0.7
+
+    module_function
+
+    def distance(str1, str2)
+      jaro_distance = Jaro.distance(str1, str2)
+
+      if jaro_distance > THRESHOLD
+        codepoints2  = str2.codepoints.to_a
+        prefix_bonus = 0
+
+        i = 0
+        str1.each_codepoint do |char1|
+          char1 == codepoints2[i] && i < 4 ? prefix_bonus += 1 : break
+          i += 1
+        end
+
+        jaro_distance + (prefix_bonus * WEIGHT * (1 - jaro_distance))
+      else
+        jaro_distance
+      end
+    end
+  end
+end

data/lib/did_you_mean/test_helper.rb

@@ -1,6 +1,6 @@
 module DidYouMean
   module TestHelper
-    def assert_suggestion(array, expected)
+    def assert_suggestion(expected, array)
       assert_equal [expected], array, "Expected #{array.inspect} to only include #{expected.inspect}"
     end
   end

data/lib/did_you_mean/version.rb

@@ -1,3 +1,3 @@
 module DidYouMean
-  VERSION = "0.9.10"
+  VERSION = "0.10.0"
 end

data/test/core_ext/name_error_extension_test.rb

@@ -0,0 +1,74 @@
+require 'test_helper'
+
+class NameErrorExtensionTest < Minitest::Test
+  class TestFinder
+    def initialize(*); end
+    def suggestions; ["Y U SO SLOW?"]; end
+  end
+
+  def setup
+    @org = DidYouMean.finders[NAME_ERROR.to_s]
+    DidYouMean.finders[NAME_ERROR.to_s] = TestFinder
+
+    @error = assert_raises(NAME_ERROR){ doesnt_exist }
+  end
+
+  def teardown
+    DidYouMean.finders[NAME_ERROR.to_s] = @org
+  end
+
+  def test_message_provides_original_message
+    skip if RUBY_ENGINE == 'rbx'
+
+    assert_match "undefined local variable or method", @error.to_s
+  end
+
+  def test_message
+    assert_match "Did you mean? Y U SO SLOW?", @error.to_s
+    assert_match "Did you mean? Y U SO SLOW?", @error.message
+  end
+
+  def test_to_s_does_not_make_disruptive_changes_to_error_message
+    error = assert_raises(NameError) do
+      raise NameError, "uninitialized constant Object".freeze
+    end
+
+    assert_equal 1, error.to_s.scan("Did you mean?").count
+  end
+end
+
+class IgnoreCallersTest < Minitest::Test
+  class Boomer
+    def initialize(*)
+      raise Exception, "finder was created when it shouldn't!"
+    end
+  end
+
+  def setup
+    @org = DidYouMean.finders[NAME_ERROR.to_s]
+    DidYouMean.finders[NAME_ERROR.to_s] = Boomer
+
+    @error = assert_raises(NAME_ERROR){ doesnt_exist }
+  end
+
+  def teardown
+    DidYouMean.finders[NAME_ERROR.to_s] = @org
+  end
+
+  def test_ignore_missing_name
+    assert_nothing_raised { missing_name }
+  end
+
+  def test_ignore_safe_constantize
+    assert_nothing_raised { safe_constantize }
+  end
+
+  private
+
+  def safe_constantize; @error.message end
+  def missing_name;     @error.message end
+
+  def assert_nothing_raised
+    yield
+  end
+end

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

@@ -1,4 +1,4 @@
-require_relative 'test_helper'
+require 'test_helper'
 
 class NoMethodErrorExtensionTest < Minitest::Test
   def test_receiver_with_string

data/test/correctable/class_name_test.rb

@@ -0,0 +1,65 @@
+require 'test_helper'
+
+module ACRONYM
+end
+
+class Project
+  def self.bo0k
+    Bo0k
+  end
+end
+
+class Book
+  class TableOfContents; end
+
+  def tableof_contents
+    TableofContents
+  end
+
+  class Page
+    def tableof_contents
+      TableofContents
+    end
+
+    def self.tableof_contents
+      TableofContents
+    end
+  end
+end
+
+class ClassNameTest < Minitest::Test
+  def test_suggestions
+    error = assert_raises(NameError) { ::Bo0k }
+    assert_suggestion "Book", error.suggestions
+  end
+
+  def test_suggestions_include_case_specific_class_name
+    error = assert_raises(NameError) { ::Acronym }
+    assert_suggestion "ACRONYM", error.suggestions
+  end
+
+  def test_suggestions_include_top_level_class_name
+    error = assert_raises(NameError) { Project.bo0k }
+    assert_suggestion "Book", error.suggestions
+  end
+
+  def test_names_in_suggestions_have_namespaces
+    error = assert_raises(NameError) { ::Book::TableofContents }
+    assert_suggestion "Book::TableOfContents", error.suggestions
+  end
+
+  def test_suggestions_searches_for_names_in_upper_level_scopes
+    error = assert_raises(NameError) { Book::Page.tableof_contents }
+    assert_suggestion "Book::TableOfContents", error.suggestions
+  end
+
+  def test_suggestions_should_work_from_within_instance_method
+    error = assert_raises(NameError) { ::Book.new.tableof_contents }
+    assert_suggestion "Book::TableOfContents", error.suggestions
+  end
+
+  def test_suggestions_should_work_from_within_instance_method_on_nested_class
+    error = assert_raises(NameError) { ::Book::Page.new.tableof_contents }
+    assert_suggestion "Book::TableOfContents", error.suggestions
+  end
+end

data/test/correctable/method_name_test.rb

@@ -0,0 +1,84 @@
+require 'test_helper'
+
+class MethodNameTest < Minitest::Test
+  class User
+    def friends; end
+    def first_name; end
+    def descendants; end
+    def call_incorrect_private_method
+      raiae NoMethodError
+    end
+
+    protected
+    def the_protected_method; end
+
+    private
+    def friend; end
+    def the_private_method; end
+
+    class << self
+      def load; end
+    end
+  end
+
+  module UserModule
+    def from_module; end
+  end
+
+  def setup
+    @user = User.new.extend(UserModule)
+  end
+
+  def test_suggestions_include_instance_method
+    error = assert_raises(NoMethodError){ @user.flrst_name }
+
+    assert_suggestion :first_name, error.suggestions
+    assert_match "Did you mean? first_name",  error.to_s
+  end
+
+  def test_suggestions_include_private_method
+    error = assert_raises(NoMethodError){ @user.friend }
+
+    assert_suggestion :friends, error.suggestions
+    assert_match "Did you mean? friends", error.to_s
+  end
+
+  def test_suggestions_include_method_from_module
+    error = assert_raises(NoMethodError){ @user.fr0m_module }
+
+    assert_suggestion :from_module, error.suggestions
+    assert_match "Did you mean? from_module", error.to_s
+  end
+
+  def test_suggestions_include_class_method
+    error = assert_raises(NoMethodError){ User.l0ad }
+
+    assert_suggestion :load, error.suggestions
+    assert_match "Did you mean? load", error.to_s
+  end
+
+  def test_private_methods_should_not_be_suggested
+    error = assert_raises(NoMethodError){ User.new.the_protected_method }
+    refute_includes error.suggestions, :the_protected_method
+
+    error = assert_raises(NoMethodError){ User.new.the_private_method }
+    refute_includes error.suggestions, :the_private_method
+  end
+
+  def test_suggestions_when_private_method_is_called_with_args
+    error = assert_raises(NoMethodError){ @user.call_incorrect_private_method }
+
+    assert_suggestion :raise, error.suggestions
+    assert_match "Did you mean? raise", error.to_s
+  end
+
+  def test_corrects_incorrect_ivar_name
+    skip if RUBY_ENGINE == 'rbx'
+
+    @number = 1
+    error = assert_raises(NoMethodError) { @nubmer.zero? }
+
+    assert_suggestion :@number, error.suggestions
+    assert_match "Did you mean? @number", error.to_s
+  end
+end

data/test/{null_finder_test.rb → correctable/uncorrectable_name_test.rb}

@@ -1,6 +1,6 @@
-require_relative 'test_helper'
+require 'test_helper'
 
-class NullFinderTest < Minitest::Test
+class UncorrectableNameTest < Minitest::Test
   class FirstNameError < NameError; end
 
   def setup
@@ -9,11 +9,7 @@ class NullFinderTest < Minitest::Test
     end
   end
 
-  def test_did_you_mean?
-    assert_nil @error.did_you_mean?
-  end
-
   def test_message
-    refute_includes "Did you mean?", @error.message
+    assert_equal "Other name error", @error.message
   end
 end

data/test/correctable/variable_name_test.rb

@@ -0,0 +1,79 @@
+require 'test_helper'
+
+class VariableNameTest < Minitest::Test
+  class User
+    def initialize
+      @email_address = 'email_address@address.net'
+    end
+
+    def first_name; end
+    def to_s
+      "#{@first_name} #{@last_name} <#{email_address}>"
+    end
+
+    private
+
+    def cia_codename; "Alexa" end
+  end
+
+  module UserModule
+    def from_module; end
+  end
+
+  def setup
+    @user = User.new.extend(UserModule)
+  end
+
+  def test_suggestions_include_instance_method
+    error = assert_raises(NAME_ERROR) do
+      @user.instance_eval { flrst_name }
+    end
+
+    assert_suggestion :first_name, error.suggestions
+    assert_match "Did you mean? first_name", error.to_s
+  end
+
+  def test_suggestions_include_method_from_module
+    error = assert_raises(NAME_ERROR) do
+      @user.instance_eval { fr0m_module }
+    end
+
+    assert_suggestion :from_module, error.suggestions
+    assert_match "Did you mean? from_module", error.to_s
+  end
+
+  def test_suggestions_include_local_variable_name
+    person  = nil
+    error = (eprson rescue $!) # Do not use @assert_raises here as it changes a scope.
+
+    assert_suggestion :person, error.suggestions
+    assert_match "Did you mean? person", error.to_s
+  end
+
+  def test_suggestions_include_instance_variable_name
+    error = assert_raises(NAME_ERROR){ @user.to_s }
+
+    assert_suggestion :@email_address, error.suggestions
+    assert_match "Did you mean? @email_address", error.to_s
+  end
+
+  def test_suggestions_include_private_method
+    error = assert_raises(NAME_ERROR) do
+      @user.instance_eval { cia_code_name }
+    end
+
+    assert_suggestion :cia_codename,  error.suggestions
+    assert_match "Did you mean? cia_codename",  error.to_s
+  end
+
+  @@does_exist = true
+
+  def test_suggestions_include_class_variable_name
+    skip if RUBY_ENGINE == 'rbx'
+
+    error = assert_raises(NameError){ @@doesnt_exist }
+
+    assert_suggestion :@@does_exist, error.suggestions
+    assert_match "Did you mean? @@does_exist", error.to_s
+  end
+end

data/test/edit_distance/jaro_winkler_test.rb

@@ -0,0 +1,30 @@
+# -*- coding: utf-8 -*-
+require 'test_helper'
+
+class JaroWinklerTest < Minitest::Test
+  def test_jaro_winkler_distance
+    assert_distance 0.9667, 'henka',      'henkan'
+    assert_distance 1.0,    'al',         'al'
+    assert_distance 0.9611, 'martha',     'marhta'
+    assert_distance 0.8324, 'jones',      'johnson'
+    assert_distance 0.9167, 'abcvwxyz',   'zabcvwxy'
+    assert_distance 0.9583, 'abcvwxyz',   'cabvwxyz'
+    assert_distance 0.84,   'dwayne',     'duane'
+    assert_distance 0.8133, 'dixon',      'dicksonx'
+    assert_distance 0.0,    'fvie',       'ten'
+    assert_distance 0.9067, 'does_exist', 'doesnt_exist'
+  end
+
+  def test_jarowinkler_distance_with_utf8_strings
+    assert_distance 0.9818, '變形金剛4:絕跡重生', '變形金剛4: 絕跡重生'
+    assert_distance 0.8222, '連勝文',             '連勝丼'
+    assert_distance 0.8222, '馬英九',             '馬英丸'
+    assert_distance 0.6667, '良い',               'いい'
+  end
+
+  private
+
+  def assert_distance(score, str1, str2)
+    assert_equal score, DidYouMean::JaroWinkler.distance(str1, str2).round(4)
+  end
+end