did_you_mean 1.3.1 → 1.4.0

data/test/test_verbose_formatter.rb

@@ -0,0 +1,21 @@
+require_relative './helper'
+
+class VerboseFormatterTest < Test::Unit::TestCase
+  def setup
+    require_relative File.join(DidYouMean::TestHelper.root, 'verbose')
+  end
+
+  def teardown
+    DidYouMean.formatter = DidYouMean::PlainFormatter.new
+  end
+
+  def test_message
+    @error = assert_raise(NoMethodError){ 1.zeor? }
+
+    assert_match <<~MESSAGE.strip, @error.message
+      undefined method `zeor?' for 1:Integer
+
+          Did you mean? zero?
+    MESSAGE
+  end
+end

data/test/tree_spell/change_word.rb

@@ -0,0 +1,61 @@
+module TreeSpell
+  # Changes a word with one of four actions:
+  # insertion, substitution, deletion and transposition.
+  class ChangeWord
+    # initialize with input string
+    def initialize(input)
+      @input = input
+      @len = input.length
+    end
+
+    # insert char after index of i_place
+    def insertion(i_place, char)
+      @word = input.dup
+      return char + word if i_place == 0
+      return word + char if i_place == len - 1
+      word.insert(i_place + 1, char)
+    end
+
+    # substitute char at index of i_place
+    def substitution(i_place, char)
+      @word = input.dup
+      word[i_place] = char
+      word
+    end
+
+    # delete character at index of i_place
+    def deletion(i_place)
+      @word = input.dup
+      word.slice!(i_place)
+      word
+    end
+
+    # transpose char at i_place with char at i_place + direction
+    # if i_place + direction is out of bounds just swap in other direction
+    def transposition(i_place, direction)
+      @word = input.dup
+      w = word.dup
+      return  swap_first_two(w) if i_place + direction < 0
+      return  swap_last_two(w) if i_place + direction >= len
+      swap_two(w, i_place, direction)
+      w
+    end
+
+    private
+
+    attr_accessor :word, :input, :len
+
+    def swap_first_two(w)
+      w[1] + w[0] + word[2..-1]
+    end
+
+    def swap_last_two(w)
+      w[0...(len - 2)] + word[len - 1] + word[len - 2]
+    end
+
+    def swap_two(w, i_place, direction)
+      w[i_place] = word[i_place + direction]
+      w[i_place + direction] = word[i_place]
+    end
+  end
+end

data/test/tree_spell/human_typo.rb

@@ -0,0 +1,89 @@
+# module for classes needed to test TreeSpellChecker
+module TreeSpell
+  require_relative 'change_word'
+  # Simulate an error prone human typist
+  # see doc/human_typo_api.md for the api description
+  class HumanTypo
+    def initialize(input, lambda: 0.05)
+      @input = input
+      check_input
+      @len = input.length
+      @lambda = lambda
+    end
+
+    def call
+      @word = input.dup
+      i_place = initialize_i_place
+      loop do
+        action = action_type
+        @word = make_change action, i_place
+        @len = word.length
+        i_place += exponential
+        break if i_place >= len
+      end
+      word
+    end
+
+    private
+
+    attr_accessor :input, :word, :len, :lambda
+
+    def initialize_i_place
+      i_place = nil
+      loop do
+        i_place = exponential
+        break if i_place < len
+      end
+      i_place
+    end
+
+    def exponential
+      (rand / (lambda / 2)).to_i
+    end
+
+    def rand_char
+      popular_chars =  alphabetic_characters + special_characters
+      n = popular_chars.length
+      popular_chars[rand(n)]
+    end
+
+    def alphabetic_characters
+      ('a'..'z').to_a.join + ('A'..'Z').to_a.join
+    end
+
+    def special_characters
+      '?<>,.!`+=-_":;@#$%^&*()'
+    end
+
+    def toss
+      return +1 if rand >= 0.5
+      -1
+    end
+
+    def action_type
+      [:insert, :transpose, :delete, :substitute][rand(4)]
+    end
+
+    def make_change(action, i_place)
+      cw = ChangeWord.new(word)
+      case action
+      when :delete
+        cw.deletion(i_place)
+      when :insert
+        cw.insertion(i_place, rand_char)
+      when :substitute
+        cw.substitution(i_place, rand_char)
+      when :transpose
+        cw.transposition(i_place, toss)
+      end
+    end
+
+    def check_input
+      fail check_input_message if input.nil? || input.length < 5
+    end
+
+    def check_input_message
+      "input length must be greater than 5 characters: #{input}"
+    end
+  end
+end

data/test/tree_spell/test_change_word.rb

@@ -0,0 +1,38 @@
+require_relative '../helper'
+require_relative 'change_word'
+
+class ChangeWordTest < Test::Unit::TestCase
+  def setup
+    @input = 'spec/services/anything_spec'
+    @cw = TreeSpell::ChangeWord.new(@input)
+    @len = @input.length
+  end
+
+  def test_deleletion
+    assert_match @cw.deletion(5), 'spec/ervices/anything_spec'
+    assert_match @cw.deletion(@len - 1), 'spec/services/anything_spe'
+    assert_match @cw.deletion(0), 'pec/services/anything_spec'
+  end
+
+  def test_substitution
+    assert_match @cw.substitution(5, '$'), 'spec/$ervices/anything_spec'
+    assert_match @cw.substitution(@len - 1, '$'), 'spec/services/anything_spe$'
+    assert_match @cw.substitution(0, '$'), '$pec/services/anything_spec'
+  end
+
+  def test_insertion
+    assert_match @cw.insertion(7, 'X'), 'spec/serXvices/anything_spec'
+    assert_match @cw.insertion(0, 'X'), 'Xspec/services/anything_spec'
+    assert_match @cw.insertion(@len - 1, 'X'), 'spec/services/anything_specX'
+  end
+
+  def test_transposition
+    n = @input.length
+    assert_match @cw.transposition(0, -1), 'psec/services/anything_spec'
+    assert_match @cw.transposition(n - 1, +1), 'spec/services/anything_spce'
+    assert_match @cw.transposition(4, +1), 'specs/ervices/anything_spec'
+    assert_match @cw.transposition(4, -1), 'spe/cservices/anything_spec'
+    assert_match @cw.transposition(21, -1), 'spec/services/anythign_spec'
+    assert_match @cw.transposition(21, +1), 'spec/services/anythin_gspec'
+  end
+end

data/test/tree_spell/test_explore.rb

@@ -0,0 +1,128 @@
+require 'set'
+require 'yaml'
+
+require_relative '../helper'
+require_relative 'human_typo'
+
+# statistical tests on tree_spell algorithms
+class ExploreTest < Test::Unit::TestCase
+  MINI_DIRECTORIES = YAML.load_file(File.expand_path('../fixtures/mini_dir.yml', __dir__))
+  RSPEC_DIRECTORIES = YAML.load_file(File.expand_path('../fixtures/rspec_dir.yml', __dir__))
+
+  def test_checkers_with_many_typos_on_mini
+    n_repeat = 10_000
+    many_typos n_repeat, MINI_DIRECTORIES, 'Minitest'
+  end
+
+  def test_checkers_with_many_typos_on_rspec
+    n_repeat = 10_000
+    many_typos n_repeat, RSPEC_DIRECTORIES, 'Rspec'
+  end
+
+  def test_human_typo
+    n_repeat = 10_000
+    total_changes = 0
+    word = 'any_string_that_is_40_characters_long_sp'
+    n_repeat.times do
+      word_error = TreeSpell::HumanTypo.new(word).call
+      total_changes += DidYouMean::Levenshtein.distance(word, word_error)
+    end
+    mean_changes = (total_changes.to_f / n_repeat).round(2)
+    puts ''
+    puts "HumanTypo mean_changes: #{mean_changes} with n_repeat: #{n_repeat}"
+    puts 'Expected  mean_changes: 2.1 with n_repeat: 10000, plus/minus 0.03'
+    puts ''
+  end
+
+  def test_execution_speed
+    n_repeat = 1_000
+    puts ''
+    puts 'Testing execution time of Standard'
+    measure_execution_speed(n_repeat) do |files, error|
+      DidYouMean::SpellChecker.new(dictionary: files).correct error
+    end
+    puts ''
+    puts 'Testing execution time of Tree'
+    measure_execution_speed(n_repeat) do |files, error|
+      DidYouMean::TreeSpellChecker.new(dictionary: files).correct error
+    end
+    puts ''
+    puts 'Testing execution time of Augmented Tree'
+    measure_execution_speed(n_repeat) do |files, error|
+      DidYouMean::TreeSpellChecker.new(dictionary: files, augment: true).correct error
+    end
+  end
+
+  private
+
+  def measure_execution_speed(n_repeat, &block)
+    len = RSPEC_DIRECTORIES.length
+    start_time = Time.now
+    n_repeat.times do
+      word = RSPEC_DIRECTORIES[rand len]
+      word_error = TreeSpell::HumanTypo.new(word).call
+      block.call(RSPEC_DIRECTORIES, word_error)
+    end
+    time_ms = (Time.now - start_time).to_f * 1000 / n_repeat
+    puts "Average time (ms): #{time_ms.round(1)}"
+  end
+
+  def many_typos(n_repeat, files, title)
+    first_times = [0, 0, 0]
+    total_suggestions = [0, 0, 0]
+    total_failures = [0, 0, 0]
+    len = files.length
+    n_repeat.times do
+      word = files[rand len]
+      word_error = TreeSpell::HumanTypo.new(word).call
+      suggestions_a = group_suggestions word_error, files
+      check_first_is_right word, suggestions_a, first_times
+      check_no_suggestions suggestions_a, total_suggestions
+      check_for_failure word, suggestions_a, total_failures
+    end
+    print_results first_times, total_suggestions, total_failures, n_repeat, title
+  end
+
+  def group_suggestions(word_error, files)
+    a0 = DidYouMean::TreeSpellChecker.new(dictionary: files).correct word_error
+    a1 = ::DidYouMean::SpellChecker.new(dictionary: files).correct word_error
+    a2 =  a0.empty? ? a1 : a0
+    [a0, a1, a2]
+  end
+
+  def check_for_failure(word, suggestions_a, total_failures)
+    suggestions_a.each_with_index.map do |a, i|
+      total_failures[i] += 1 unless a.include? word
+    end
+  end
+
+  def check_first_is_right(word, suggestions_a, first_times)
+    suggestions_a.each_with_index.map do |a, i|
+      first_times[i] += 1 if word == a.first
+    end
+  end
+
+  def check_no_suggestions(suggestions_a, total_suggestions)
+    suggestions_a.each_with_index.map do |a, i|
+      total_suggestions[i] += a.length
+    end
+  end
+
+  def print_results(first_times, total_suggestions, total_failures, n_repeat, title)
+    algorithms = ['Tree     ', 'Standard ', 'Augmented']
+    print_header title
+    (0..2).each do |i|
+      ft = (first_times[i].to_f / n_repeat * 100).round(1)
+      mns = (total_suggestions[i].to_f / (n_repeat - total_failures[i])).round(1)
+      f = (total_failures[i].to_f / n_repeat * 100).round(1)
+      puts " #{algorithms[i]}  #{' ' * 7}  #{ft} #{' ' * 14} #{mns} #{' ' * 15} #{f} #{' ' * 16}"
+    end
+  end
+
+  def print_header(title)
+    puts "#{' ' * 30} #{title} Summary #{' ' * 31}"
+    puts '-' * 80
+    puts " Method  |   First Time (\%)    Mean Suggestions       Failures (\%) #{' ' * 13}"
+    puts '-' * 80
+  end
+end

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.3.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Yuki Nishijima
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-29 00:00:00.000000000 Z
+date: 2019-12-24 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,13 +31,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
-- ".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
@@ -73,8 +46,11 @@ files:
 - benchmark/memory_usage.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
@@ -91,22 +67,29 @@ 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/tree_spell_checker.rb
 - lib/did_you_mean/verbose.rb
 - lib/did_you_mean/version.rb
-- test/core_ext/name_error_extension_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_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: {}
@@ -130,16 +113,22 @@ signing_key:
 specification_version: 4
 summary: '"Did you mean?" experience in Ruby'
 test_files:
-- test/core_ext/name_error_extension_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_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