did_you_mean 1.2.1 → 1.5.0

data/Gemfile

@@ -4,5 +4,7 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'benchmark-ips'
+gem 'benchmark_driver'
 gem 'memory_profiler'
 gem 'jaro_winkler', '>= 1.4.0'
+gem 'test-unit'

data/README.md

@@ -1,4 +1,4 @@
-# did_you_mean [![Gem Version](https://badge.fury.io/rb/did_you_mean.svg)](https://rubygems.org/gems/did_you_mean) [![Build Status](https://travis-ci.org/yuki24/did_you_mean.svg?branch=master)](https://travis-ci.org/yuki24/did_you_mean)
+# did_you_mean [![Gem Version](https://badge.fury.io/rb/did_you_mean.svg)](https://rubygems.org/gems/did_you_mean) [![Build Status](https://travis-ci.org/ruby/did_you_mean.svg?branch=master)](https://travis-ci.org/ruby/did_you_mean)
 
 ## Installation
 
@@ -61,34 +61,12 @@ hash.fetch(:fooo)
 #    Did you mean?  :foo
 ```
 
-## Experimental Features
-
-Aside from the basic features above, the `did_you_mean` gem comes with experimental features. They can be enabled by calling `require 'did_you_mean/experimental'`.
-
-Note that **these experimental features should never be enabled in production as they would impact Ruby's performance and use some unstable Ruby APIs.**
-
-### Correcting an Instance Variable When It's Incorrectly Spelled
-
-```ruby
-require 'did_you_mean/experimental'
-
-@full_name = "Yuki Nishijima"
-@full_anme.split(" ")
-# => NoMethodError: undefined method `split' for nil:NilClass
-#    Did you mean?  @full_name
-```
-
-### Displaying a Warning When `initialize` is Incorrectly Spelled
+### LoadError
 
 ```ruby
-require 'did_you_mean/experimental'
-
-class Person
-  def intialize
-    ...
-  end
-end
-# => warning: intialize might be misspelled, perhaps you meant initialize?
+require 'net-http'
+# => LoadError (cannot load such file -- net-http)
+#    Did you mean?  net/http
 ```
 
 ## Verbose Formatter
@@ -108,9 +86,82 @@ OBject
 #
 ```
 
+## Using the `DidYouMean::SpellChecker`
+
+If you need to programmatically find the closest matches to the user input, you could do so by re-using the `DidYouMean::SpellChecker` object.
+
+```ruby
+spell_checker = DidYouMean::SpellChecker.new(dictionary: ['email', 'fail', 'eval'])
+
+spell_checker.correct('meail') # => ['email']
+spell_checker.correct('afil')  # => ['fail']
+```
+
+## Disabling `did_you_mean`
+
+Occasionally, you may want to disable the `did_you_mean` gem for e.g. debugging issues in the error object itself. You
+can disable it entirely by specifying `--disable-did_you_mean` option to the `ruby` command:
+
+```bash
+$ ruby --disable-did_you_mean -e "1.zeor?"
+-e:1:in `<main>': undefined method `zeor?' for 1:Integer (NameError)
+```
+
+When you do not have direct access to the `ruby` command (e.g. `rails console`, `irb`), you could applyoptions using the
+`RUBYOPT` environment variable:
+
+```bash
+$ RUBYOPT='--disable-did_you_mean' irb
+irb:0> 1.zeor?
+# => NoMethodError (undefined method `zeor?' for 1:Integer)
+```
+
+### Getting the original error message
+
+Sometimes, you do not want to disable the gem entirely, but need to get the original error message without suggestions
+(e.g. testing). In this case, you could use the `#original_message` method on the error object:
+
+```ruby
+no_method_error = begin
+                    1.zeor?
+                  rescue NoMethodError => error
+                    error
+                  end
+
+no_method_error.message
+# => NoMethodError (undefined method `zeor?' for 1:Integer)
+#    Did you mean?  zero?
+
+no_method_error.original_message
+# => NoMethodError (undefined method `zeor?' for 1:Integer)
+```
+
+## Benchmarking
+
+Performance is very important as the `did_you_mean` gem attempts to find the closest matches on the fly right after an exception
+is thrown. You could use the following rake tasks to get insights into how the gem performs:
+
+```bash
+bundle exec rake benchmark:ips:jaro
+bundle exec rake benchmark:ips:levenshtein
+bundle exec rake benchmark:memory
+bundle exec rake benchmark:memory:jaro
+bundle exec rake benchmark:memory:levenshtein
+```
+
+**Be sure to always use `bundle exec` otherwise it will activate the pre-installed version of the `did_you_mean`
+ gem rather than using what's in the `lib/`.**
+
+You could also use the [`benchmark-driver`](https://github.com/benchmark-driver/benchmark-driver) gem to know how each
+Ruby performs differently.
+
+```bash
+bundle exec benchmark-driver benchmark/speed.yml --rbenv '2.6.0 --jit;2.6.0;2.5.3;truffleruby-1.0.0-rc10' --run-duration 30
+```
+
 ## Contributing
 
-1. Fork it (http://github.com/yuki24/did_you_mean/fork)
+1. Fork it (https://github.com/ruby/did_you_mean/fork)
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Make sure all tests pass (`bundle exec rake`)

data/Rakefile

@@ -4,30 +4,32 @@ require 'rake/testtask'
 Rake::TestTask.new do |task|
   task.libs << "test"
 
-  task.test_files = Dir['test/**/*_test.rb'].reject {|path| /(experimental)/ =~ path }
+  task.test_files = Dir['test/**/test_*.rb'].reject {|path| path.end_with?("test_explore.rb") }
   task.verbose    = true
   task.warning    = true
+  task.ruby_opts  = %w[ --disable-did_you_mean ]
 end
 
-Rake::TestTask.new("test:experimental") do |task|
+Rake::TestTask.new("test:explore") do |task|
   task.libs << "test"
-  task.pattern = 'test/experimental/**/*_test.rb'
-  task.verbose = true
-  task.warning = true
-  task.ruby_opts << "-rdid_you_mean/experimental"
+
+  task.pattern   = 'test/tree_spell/test_explore.rb'
+  task.verbose   = true
+  task.warning   = true
+  task.ruby_opts = %w[ --disable-did_you_mean ]
 end
 
-task default: %i(test test:experimental)
+task default: %i(test)
 
 namespace :test do
   namespace :accuracy do
     desc "Download Wiktionary's Simple English data and save it as a dictionary"
     task :prepare do
-      sh 'ruby evaluation/dictionary_generator.rb'
+      sh "RUBYOPT='--disable-did_you_mean' ruby evaluation/dictionary_generator.rb"
     end
   end
 
-  desc "Calculate accuracy of the gems' spell checker"
+  desc "Calculate accuracy of the gem's spell checker"
   task :accuracy do
     if !File.exist?("evaluation/dictionary.yml")
       puts 'Generating dictionary for evaluation:'
@@ -35,13 +37,37 @@ namespace :test do
       puts "\n"
     end
 
-    sh 'ruby evaluation/calculator.rb'
+    sh "RUBYOPT='--disable-did_you_mean' ruby evaluation/calculator.rb"
   end
 end
 
 namespace :benchmark do
-  desc "Measure memory usage by the did_you_mean gem"
+  namespace :ips do
+    desc "Measure performance of the gem's Jaro distance implementation"
+    task :jaro do
+      sh "RUBYOPT='--disable-did_you_mean' ruby benchmark/jaro_winkler/speed.rb"
+    end
+
+    desc "Benchmark performance of the gem's Levenshtein distance implementation"
+    task :levenshtein do
+      sh "RUBYOPT='--disable-did_you_mean' ruby benchmark/levenshtein/speed.rb"
+    end
+  end
+
+  desc "Benchmark memory usage in the gem's spell checker"
   task :memory do
-    sh 'ruby benchmark/memory_usage.rb'
+    sh "RUBYOPT='--disable-did_you_mean' ruby benchmark/memory_usage.rb"
+  end
+
+  namespace :memory do
+    desc "Benchmark memory usage in the gem's Jaro distance implementation"
+    task :jaro do
+      sh "RUBYOPT='--disable-did_you_mean' ruby benchmark/jaro_winkler/memory_usage.rb"
+    end
+
+    desc "Benchmark memory usage in the gem's Levenshtein distance implementation"
+    task :levenshtein do
+      sh "RUBYOPT='--disable-did_you_mean' ruby benchmark/levenshtein/memory_usage.rb"
+    end
   end
 end

data/appveyor.yml

@@ -0,0 +1,25 @@
+install:
+  - set PATH=C:\Ruby26-x64\bin;%PATH%
+
+build: off
+
+branches:
+  only:
+    - master
+
+environment:
+  ruby_version: "24-%Platform%"
+  zlib_version: "1.2.11"
+  matrix:
+    - APPVEYOR_BUILD_WORKER_IMAGE: Visual Studio 2019
+    - APPVEYOR_BUILD_WORKER_IMAGE: Visual Studio 2017
+    - APPVEYOR_BUILD_WORKER_IMAGE: Visual Studio 2015
+
+before_test:
+  - ruby -v
+  - gem -v
+  - bundle -v
+  - gem uni did_you_mean
+
+test_script:
+  - rake

data/benchmark/jaro_winkler/memory_usage.rb

@@ -1,11 +1,11 @@
+# frozen-string-literal: true
+
 require 'memory_profiler'
 require 'did_you_mean/jaro_winkler'
 
-str1, str2 = "user_signed_in?", "user_logged_in?"
-
 report = MemoryProfiler.report do
-  80.times do
-    DidYouMean::Jaro.distance str1, str2
+  1000.times do
+    DidYouMean::Jaro.distance "user_signed_in?", "user_logged_in?"
   end
 end
 

data/benchmark/jaro_winkler/speed.rb

@@ -1,14 +1,22 @@
+# frozen-string-literal: true
+
 require 'benchmark/ips'
-require 'did_you_mean'
+require 'did_you_mean/jaro_winkler'
 
 Benchmark.ips do |x|
-  x.report "before" do
-    DidYouMean::Jaro.before_distance "user_signed_in?", "user_logged_in?"
+  x.report "original" do
+    DidYouMean::Jaro.distance "user_signed_in?", "user_logged_in?"
   end
 
-  x.report "after" do
-    DidYouMean::Jaro.after_distance "user_signed_in?", "user_logged_in?"
-  end
+  # This #proposed method is not defined. Write your own method using this
+  # name so we can reliably run the benchmark and measure the difference.
+  #
+  # Alternatively, you could directly update the #distance method and remove
+  # this completely.
+  #
+  # x.report "proposed" do
+  #   DidYouMean::Jaro.proposed "user_signed_in?", "user_logged_in?"
+  # end
 
   x.compare!
 end

data/benchmark/levenshtein/memory_usage.rb

@@ -1,11 +1,11 @@
+# frozen-string-literal: true
+
 require 'memory_profiler'
 require 'did_you_mean/levenshtein'
 
-str1, str2 = "user_signed_in?", "user_logged_in?"
-
 report = MemoryProfiler.report do
-  80.times do
-    DidYouMean::Levenshtein.distance str1, str2
+  1000.times do
+    DidYouMean::Levenshtein.distance "user_signed_in?", "user_logged_in?"
   end
 end
 

data/benchmark/levenshtein/speed.rb

@@ -1,17 +1,22 @@
+# frozen-string-literal: true
+
 require 'benchmark/ips'
-require 'did_you_mean'
 require 'did_you_mean/levenshtein'
 
-STR1, STR2 = "user_signed_in?", "user_logged_in?"
-
 Benchmark.ips do |x|
-  x.report "enumerable" do
-    DidYouMean::Levenshtein.before_distance STR1, STR2
+  x.report "original" do
+    DidYouMean::Levenshtein.distance "user_signed_in?", "user_logged_in?"
   end
 
-  x.report "while" do
-    DidYouMean::Levenshtein.after_distance STR1, STR2
-  end
+  # This #proposed method is not defined. Write your own method using this
+  # name so we can reliably run the benchmark and measure the difference.
+  #
+  # Alternatively, you could directly update the #distance method and remove
+  # this completely.
+  #
+  # x.report "proposed" do
+  #   DidYouMean::Levenshtein.proposed "user_signed_in?", "user_logged_in?"
+  # end
 
   x.compare!
 end

data/benchmark/require_path_checker.rb

@@ -0,0 +1,47 @@
+# frozen-string-literal: true
+#
+# Run the following command to run this script:
+#
+#   $ ruby --disable-did_you_mean benchmark/require_path_checker.rb
+#
+
+require_relative '../lib/did_you_mean/spell_checkers/require_path_checker'
+
+require 'benchmark/ips'
+
+Benchmark.ips do |x|
+  x.config(time: 10, warmup: 10)
+
+  exception_with_slash = begin
+                           require 'net/htto'
+                         rescue LoadError => error
+                           error
+                         end
+
+  exception_without_slash = begin
+                              require 'net-http'
+                            rescue LoadError => error
+                              error
+                            end
+
+  checker_for_path = DidYouMean::RequirePathChecker.new(exception_with_slash)
+  checker_for_file = DidYouMean::RequirePathChecker.new(exception_without_slash)
+
+  x.report "original (with a /)" do
+    checker_for_path.corrections
+  end
+
+  x.report "original (without /)" do
+    checker_for_file.corrections
+  end
+
+  #x.report "proposed (with a /)" do
+  #  checker_for_path.experiment
+  #end
+  #
+  #x.report "proposed (without /)" do
+  #  checker_for_file.experiment
+  #end
+
+  x.compare!
+end

data/benchmark/speed.yml

@@ -0,0 +1,13 @@
+prelude: |
+  require 'did_you_mean/spell_checker'
+
+  str1, str2 = "user_signed_in?", "user_logged_in?"
+  METHODS    = ''.methods
+  INPUT      = 'starts_with?'
+  collection = DidYouMean::SpellChecker.new(dictionary: METHODS)
+
+benchmark:
+  Jaro:          DidYouMean::Jaro.distance(str1, str2)
+  Jaro Winkler:  DidYouMean::JaroWinkler.distance(str1, str2)
+  Levenshtein:   DidYouMean::Levenshtein.distance(str1, str2)
+  Spell checker: collection.correct(INPUT)

data/did_you_mean.gemspec

@@ -1,7 +1,11 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'did_you_mean/version'
+begin
+  require_relative "lib/did_you_mean/version"
+rescue LoadError # Fallback to load version file in ruby core repository
+  require_relative "version"
+end
 
 Gem::Specification.new do |spec|
   spec.name          = "did_you_mean"
@@ -10,7 +14,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["mail@yukinishijima.net"]
   spec.summary       = '"Did you mean?" experience in Ruby'
   spec.description   = 'The gem that has been saving people from typos since 2014.'
-  spec.homepage      = "https://github.com/yuki24/did_you_mean"
+  spec.homepage      = "https://github.com/ruby/did_you_mean"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/).reject{|path| path.start_with?('evaluation/') }
@@ -19,7 +23,5 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.5.0'
 
-  spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "minitest"
 end

data/documentation/CHANGELOG.md.erb

@@ -0,0 +1,8 @@
+<% releases.each do |release| %>
+## [<%= release.name %>](https://github.com/<%= repository %>/tree/<%= release.tag_name %>)
+
+_<sup>released at <%= release.published_at %></sup>_
+
+<%= release.body.gsub(/\r\n/, "\n") %>
+
+<% end %>

data/documentation/changelog_generator.rb

@@ -0,0 +1,34 @@
+require 'octokit'
+require 'reverse_markdown'
+require 'erb'
+
+class ChangeLogGenerator
+  attr :repository, :template_path, :changelog_path
+
+  def initialize(repository, template_path: "CHANGELOG.md.erb", changelog_path: "CHANGELOG.md")
+    @repository     = repository
+    @template_path  = template_path
+    @changelog_path = changelog_path
+  end
+
+  def generate_and_save!
+    changelog_in_md   = ERB.new(template).result(binding)
+    changelog_in_html = Octokit.markdown(changelog_in_md, context: repository, mode: "gfm")
+
+    File.open(changelog_path, 'w') do |file|
+      file.write ReverseMarkdown.convert(changelog_in_html, github_flavored: true)
+    end
+  end
+
+  private
+
+  def template
+    open("#{__dir__}/#{template_path}").read
+  end
+
+  def releases
+    @releases ||= Octokit.releases(repository)
+  end
+end
+
+ChangeLogGenerator.new("ruby/did_you_mean").generate_and_save!