did_you_mean 1.2.1 → 1.5.0

data/test/tree_spell/test_human_typo.rb

@@ -0,0 +1,24 @@
+require_relative '../helper'
+require_relative 'human_typo'
+
+class HumanTypoTest < Test::Unit::TestCase
+  def setup
+    @input = 'spec/services/anything_spec'
+    @sh = TreeSpell::HumanTypo.new(@input, lambda: 0.05)
+    @len = @input.length
+  end
+
+  def test_changes
+    # srand seed ensures all four actions are called
+    srand 247_696_449
+    sh = TreeSpell::HumanTypo.new(@input, lambda: 0.20)
+    word_error = sh.call
+    assert_equal word_error, 'spec/suervcieq/anythin_gpec'
+  end
+
+  def test_check_input
+    assert_raise(RuntimeError, "input length must be greater than 5 characters: tiny") do
+      TreeSpell::HumanTypo.new('tiny')
+    end
+  end
+end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: did_you_mean
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.5.0
 platform: ruby
 authors:
 - Yuki Nishijima
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-03 00:00:00.000000000 Z
+date: 2020-12-22 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  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: rake
   requirement: !ruby/object:Gem::Requirement
@@ -38,20 +24,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: The gem that has been saving people from typos since 2014.
 email:
 - mail@yukinishijima.net
@@ -59,27 +31,30 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
-- ".ruby-version"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- appveyor.yml
 - benchmark/jaro_winkler/memory_usage.rb
 - benchmark/jaro_winkler/speed.rb
 - benchmark/levenshtein/memory_usage.rb
 - benchmark/levenshtein/speed.rb
 - benchmark/memory_usage.rb
+- benchmark/require_path_checker.rb
+- benchmark/speed.yml
 - did_you_mean.gemspec
-- doc/CHANGELOG.md.erb
-- doc/changelog_generator.rb
+- documentation/CHANGELOG.md.erb
+- documentation/changelog_generator.rb
+- documentation/human_typo_api.md
+- documentation/tree_spell_algorithm.md
+- documentation/tree_spell_checker_api.md
 - lib/did_you_mean.rb
 - lib/did_you_mean/core_ext/name_error.rb
 - lib/did_you_mean/experimental.rb
-- lib/did_you_mean/experimental/initializer_name_correction.rb
-- lib/did_you_mean/experimental/ivar_name_correction.rb
 - lib/did_you_mean/formatters/plain_formatter.rb
 - lib/did_you_mean/formatters/verbose_formatter.rb
 - lib/did_you_mean/jaro_winkler.rb
@@ -91,24 +66,31 @@ files:
 - lib/did_you_mean/spell_checkers/name_error_checkers/class_name_checker.rb
 - lib/did_you_mean/spell_checkers/name_error_checkers/variable_name_checker.rb
 - lib/did_you_mean/spell_checkers/null_checker.rb
+- lib/did_you_mean/spell_checkers/require_path_checker.rb
+- lib/did_you_mean/tree_spell_checker.rb
 - lib/did_you_mean/verbose.rb
-- lib/did_you_mean/verbose_formatter.rb
 - lib/did_you_mean/version.rb
-- test/core_ext/name_error_extension_test.rb
-- test/deprecated_formatter_test.rb
-- test/edit_distance/jaro_winkler_test.rb
-- test/experimental/initializer_name_correction_test.rb
-- test/experimental/method_name_checker_test.rb
+- test/core_ext/test_name_error_extension.rb
+- test/edit_distance/test_jaro_winkler.rb
 - test/fixtures/book.rb
-- test/spell_checker_test.rb
-- test/spell_checking/class_name_check_test.rb
-- test/spell_checking/key_name_check_test.rb
-- test/spell_checking/method_name_check_test.rb
-- test/spell_checking/uncorrectable_name_check_test.rb
-- test/spell_checking/variable_name_check_test.rb
-- test/test_helper.rb
-- test/verbose_formatter_test.rb
-homepage: https://github.com/yuki24/did_you_mean
+- test/fixtures/mini_dir.yml
+- test/fixtures/rspec_dir.yml
+- test/helper.rb
+- test/spell_checking/test_class_name_check.rb
+- test/spell_checking/test_key_name_check.rb
+- test/spell_checking/test_method_name_check.rb
+- test/spell_checking/test_require_path_check.rb
+- test/spell_checking/test_uncorrectable_name_check.rb
+- test/spell_checking/test_variable_name_check.rb
+- test/test_spell_checker.rb
+- test/test_tree_spell_checker.rb
+- test/test_verbose_formatter.rb
+- test/tree_spell/change_word.rb
+- test/tree_spell/human_typo.rb
+- test/tree_spell/test_change_word.rb
+- test/tree_spell/test_explore.rb
+- test/tree_spell/test_human_typo.rb
+homepage: https://github.com/ruby/did_you_mean
 licenses:
 - MIT
 metadata: {}
@@ -127,23 +109,28 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.3
 signing_key: 
 specification_version: 4
 summary: '"Did you mean?" experience in Ruby'
 test_files:
-- test/core_ext/name_error_extension_test.rb
-- test/deprecated_formatter_test.rb
-- test/edit_distance/jaro_winkler_test.rb
-- test/experimental/initializer_name_correction_test.rb
-- test/experimental/method_name_checker_test.rb
+- test/core_ext/test_name_error_extension.rb
+- test/edit_distance/test_jaro_winkler.rb
 - test/fixtures/book.rb
-- test/spell_checker_test.rb
-- test/spell_checking/class_name_check_test.rb
-- test/spell_checking/key_name_check_test.rb
-- test/spell_checking/method_name_check_test.rb
-- test/spell_checking/uncorrectable_name_check_test.rb
-- test/spell_checking/variable_name_check_test.rb
-- test/test_helper.rb
-- test/verbose_formatter_test.rb
+- test/fixtures/mini_dir.yml
+- test/fixtures/rspec_dir.yml
+- test/helper.rb
+- test/spell_checking/test_class_name_check.rb
+- test/spell_checking/test_key_name_check.rb
+- test/spell_checking/test_method_name_check.rb
+- test/spell_checking/test_require_path_check.rb
+- test/spell_checking/test_uncorrectable_name_check.rb
+- test/spell_checking/test_variable_name_check.rb
+- test/test_spell_checker.rb
+- test/test_tree_spell_checker.rb
+- test/test_verbose_formatter.rb
+- test/tree_spell/change_word.rb
+- test/tree_spell/human_typo.rb
+- test/tree_spell/test_change_word.rb
+- test/tree_spell/test_explore.rb
+- test/tree_spell/test_human_typo.rb

data/.ruby-version

@@ -1 +0,0 @@
-2.5.1

data/.travis.yml

@@ -1,14 +0,0 @@
-language: ruby
-script:   bundle exec rake
-cache:    bundler
-sudo:     false
-
-before_install:
-  - gem install bundler
-
-after_success:
-  - bundle exec rake test:accuracy
-  - bundle exec rake benchmark:memory
-
-rvm:
-  - 2.5.1

data/lib/did_you_mean/experimental/initializer_name_correction.rb

@@ -1,20 +0,0 @@
-# frozen-string-literal: true
-
-require 'did_you_mean/levenshtein'
-
-module DidYouMean
-  module Experimental
-    module InitializerNameCorrection
-      def method_added(name)
-        super
-
-        distance = Levenshtein.distance(name.to_s, 'initialize')
-        if distance != 0 && distance <= 2
-          warn "warning: #{name} might be misspelled, perhaps you meant initialize?"
-        end
-      end
-    end
-
-    ::Class.prepend(InitializerNameCorrection)
-  end
-end

data/lib/did_you_mean/experimental/ivar_name_correction.rb

@@ -1,74 +0,0 @@
-# frozen-string-literal: true
-
-require 'did_you_mean'
-
-module DidYouMean
-  module Experimental #:nodoc:
-    class IvarNameCheckerBuilder #:nodoc:
-      attr_reader :original_checker
-
-      def initialize(original_checker) #:nodoc:
-        @original_checker = original_checker
-      end
-
-      def new(no_method_error) #:nodoc:
-        IvarNameChecker.new(no_method_error, original_checker: @original_checker)
-      end
-    end
-
-    class IvarNameChecker #:nodoc:
-      REPLS = {
-        "(irb)" => -> { Readline::HISTORY.to_a.last }
-      }
-
-      TRACE = TracePoint.trace(:raise) do |tp|
-        e = tp.raised_exception
-
-        if SPELL_CHECKERS.include?(e.class.to_s) && !e.instance_variable_defined?(:@frame_binding)
-          e.instance_variable_set(:@frame_binding, tp.binding)
-        end
-      end
-
-      attr_reader :original_checker
-
-      def initialize(no_method_error, original_checker: )
-        @original_checker = original_checker.new(no_method_error)
-
-        @location   = no_method_error.backtrace_locations.first
-        @ivar_names = no_method_error.frame_binding.receiver.instance_variables
-      end
-
-      def corrections
-        original_checker.corrections + ivar_name_corrections
-      end
-
-      def ivar_name_corrections
-        @ivar_name_corrections ||= SpellChecker.new(dictionary: @ivar_names).correct(receiver_name.to_s)
-      end
-
-      private
-
-      def receiver_name
-        return unless @original_checker.receiver.nil?
-
-        abs_path = @location.absolute_path
-        lineno   = @location.lineno
-
-        /@(\w+)*\.#{@original_checker.method_name}/ =~ line(abs_path, lineno).to_s && $1
-      end
-
-      def line(abs_path, lineno)
-        if REPLS[abs_path]
-          REPLS[abs_path].call
-        elsif File.exist?(abs_path)
-          File.open(abs_path) do |file|
-            file.detect { file.lineno == lineno }
-          end
-        end
-      end
-    end
-  end
-
-  NameError.send(:attr, :frame_binding)
-  SPELL_CHECKERS['NoMethodError'] = Experimental::IvarNameCheckerBuilder.new(SPELL_CHECKERS['NoMethodError'])
-end

data/lib/did_you_mean/verbose_formatter.rb

@@ -1,7 +0,0 @@
-require 'did_you_mean'
-require 'did_you_mean/formatters/verbose_formatter'
-
-DidYouMean.formatter = DidYouMean::VerboseFormatter.new
-
-warn '`require "did_you_mean/verbose_formatter"\' has been deprecated and will be removed' \
-     " in the next major Ruby version. Please require 'did_you_mean/verbose' instead."

data/test/core_ext/name_error_extension_test.rb

@@ -1,47 +0,0 @@
-require 'test_helper'
-
-class NameErrorExtensionTest < Minitest::Test
-  SPELL_CHECKERS = DidYouMean::SPELL_CHECKERS
-
-  class TestSpellChecker
-    def initialize(*); end
-    def corrections; ["does_exist"]; end
-  end
-
-  def setup
-    @org, SPELL_CHECKERS['NameError'] = SPELL_CHECKERS['NameError'], TestSpellChecker
-
-    @error = assert_raises(NameError){ doesnt_exist }
-  end
-
-  def teardown
-    SPELL_CHECKERS['NameError'] = @org
-  end
-
-  def test_message
-    message = <<~MESSAGE.chomp
-      undefined local variable or method `doesnt_exist' for #{to_s}
-      Did you mean?  does_exist
-    MESSAGE
-
-    assert_equal message, @error.to_s
-    assert_equal message, @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"
-    end
-
-    error.to_s
-    assert_equal 1, error.to_s.scan("Did you mean?").count
-  end
-end
-
-class DeprecatedIgnoreCallersTest < Minitest::Test
-  def test_ignore
-    assert_output nil, "IGNORED_CALLERS has been deprecated and has no effect.\n" do
-      DidYouMean::IGNORED_CALLERS << /( |`)do_not_correct_typo'/
-    end
-  end
-end

data/test/deprecated_formatter_test.rb

@@ -1,9 +0,0 @@
-require 'test_helper'
-
-class DeprecatedFormatterTest < Minitest::Test
-  def test_deprecated_formatter
-    assert_output nil, /test\/deprecated_formatter_test.rb:6: warning: constant DidYouMean::Formatter is deprecated/ do
-      assert_equal "\nDid you mean?  does_exist", ::DidYouMean::Formatter.new(['does_exist']).to_s
-    end
-  end
-end

data/test/experimental/initializer_name_correction_test.rb

@@ -1,15 +0,0 @@
-require 'test_helper'
-
-class InitializerNameCorrectionTest < Minitest::Test
-  def test_corrects_wrong_initializer_name
-    assert_output nil, "warning: intialize might be misspelled, perhaps you meant initialize?\n" do
-      Class.new { def intialize; end }
-    end
-  end
-
-  def test_does_not_correct_correct_initializer_name
-    assert_output nil, "" do
-      Class.new { def initialize; end }
-    end
-  end
-end

data/test/experimental/method_name_checker_test.rb

@@ -1,13 +0,0 @@
-require 'test_helper'
-
-class ExperimentalMethodNameCorrectionTest < Minitest::Test
-  def test_corrects_incorrect_ivar_name
-    @number = 1
-    @nubmer = nil
-    error = assert_raises(NoMethodError) { @nubmer.zero? }
-    remove_instance_variable :@nubmer
-
-    assert_correction :@number, error.corrections
-    assert_match "Did you mean?  @number", error.to_s
-  end
-end

data/test/test_helper.rb

@@ -1,13 +0,0 @@
-require 'minitest/autorun'
-require 'minitest/pride'
-require 'did_you_mean'
-
-puts "DidYouMean version: #{DidYouMean::VERSION}"
-
-module DidYouMean::TestHelper
-  def assert_correction(expected, array)
-    assert_equal Array(expected), array, "Expected #{array.inspect} to only include #{expected.inspect}"
-  end
-end
-
-MiniTest::Test.include(DidYouMean::TestHelper)

data/test/verbose_formatter_test.rb

@@ -1,23 +0,0 @@
-require 'test_helper'
-
-class VerboseFormatterTest < Minitest::Test
-  def setup
-    require 'did_you_mean/verbose'
-
-    does_exist = does_exist = nil
-    @error = assert_raises(NameError){ doesnt_exist }
-  end
-
-  def teardown
-    DidYouMean.formatter = DidYouMean::PlainFormatter.new
-  end
-
-  def test_message
-    assert_equal <<~MESSAGE.chomp, @error.message
-      undefined local variable or method `doesnt_exist' for #{to_s}
-
-          Did you mean? does_exist
-       
-    MESSAGE
-  end
-end