Merge pull request #3857 from austinpray/levenshtein-dym-bundler

Use DidYouMean::SpellChecker for gem suggestions in Bundler

Author: hsbt

Manifest.txt

@@ -190,7 +190,6 @@ bundler/lib/bundler/settings.rb
 bundler/lib/bundler/settings/validator.rb
 bundler/lib/bundler/setup.rb
 bundler/lib/bundler/shared_helpers.rb
-bundler/lib/bundler/similarity_detector.rb
 bundler/lib/bundler/source.rb
 bundler/lib/bundler/source/gemspec.rb
 bundler/lib/bundler/source/git.rb

bundler/lib/bundler/cli/common.rb

@@ -94,11 +94,14 @@ def self.ask_for_spec_from(specs)
     end
 
     def self.gem_not_found_message(missing_gem_name, alternatives)
-      require_relative "../similarity_detector"
       message = "Could not find gem '#{missing_gem_name}'."
       alternate_names = alternatives.map {|a| a.respond_to?(:name) ? a.name : a }
-      suggestions = SimilarityDetector.new(alternate_names).similar_word_list(missing_gem_name)
-      message += "\nDid you mean #{suggestions}?" if suggestions
+      if alternate_names.include?(missing_gem_name.downcase)
+        message += "\nDid you mean '#{missing_gem_name.downcase}'?"
+      elsif defined?(DidYouMean::SpellChecker)
+        suggestions = DidYouMean::SpellChecker.new(dictionary: alternate_names).correct(missing_gem_name)
+        message += "\nDid you mean #{word_list(suggestions)}?" unless suggestions.empty?
+      end
       message
     end
 
@@ -134,5 +137,19 @@ def self.clean_after_install?
       clean &&= !Bundler.use_system_gems?
       clean
     end
+
+    def self.word_list(words)
+      if words.empty?
+        return ""
+      end
+
+      words = words.map {|word| "'#{word}'" }
+
+      if words.length == 1
+        return words[0]
+      end
+
+      [words[0..-2].join(", "), words[-1]].join(" or ")
+    end
   end
 end

bundler/lib/bundler/similarity_detector.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "bundler/cli"
+
+RSpec.describe Bundler::CLI::Common do
+  describe "gem_not_found_message" do
+    it "should suggest alternate gem names" do
+      message = subject.gem_not_found_message("ralis", ["BOGUS"])
+      expect(message).to match("Could not find gem 'ralis'.$")
+      message = subject.gem_not_found_message("ralis", ["rails"])
+      expect(message).to match("Did you mean 'rails'?")
+      message = subject.gem_not_found_message("Rails", ["rails"])
+      expect(message).to match("Did you mean 'rails'?")
+      message = subject.gem_not_found_message("meail", %w[email fail eval])
+      expect(message).to match("Did you mean 'email'?")
+      message = subject.gem_not_found_message("nokogri", %w[nokogiri rails sidekiq dog])
+      expect(message).to match("Did you mean 'nokogiri'?")
+      message = subject.gem_not_found_message("methosd", %w[method methods bogus])
+      expect(message).to match(/Did you mean 'method(|s)' or 'method(|s)'?/)
+    end
+  end
+end

bundler/spec/bundler/cli_common_spec.rb

@@ -49,7 +49,7 @@
 
     it "suggests alternatives for similar-sounding gems" do
       bundle "open Rails", env: { "EDITOR" => "echo editor", "VISUAL" => "", "BUNDLER_EDITOR" => "" }, raise_on_error: false
-      expect(err).to match(/did you mean rails\?/i)
+      expect(err).to match(/did you mean 'rails'\?/i)
     end
 
     it "opens the gem with short words" do
@@ -80,12 +80,12 @@
 
     it "suggests alternatives for similar-sounding gems when using subpath" do
       bundle "open Rails --path README.md", env: { "EDITOR" => "echo editor", "VISUAL" => "", "BUNDLER_EDITOR" => "" }, raise_on_error: false
-      expect(err).to match(/did you mean rails\?/i)
+      expect(err).to match(/did you mean 'rails'\?/i)
     end
 
     it "suggests alternatives for similar-sounding gems when using deep subpath" do
       bundle "open Rails --path some/path/here", env: { "EDITOR" => "echo editor", "VISUAL" => "", "BUNDLER_EDITOR" => "" }, raise_on_error: false
-      expect(err).to match(/did you mean rails\?/i)
+      expect(err).to match(/did you mean 'rails'\?/i)
     end
 
     it "opens subpath of the short worded gem" do

bundler/spec/commands/open_spec.rb

@@ -193,7 +193,7 @@
     end
     it "should suggest alternatives" do
       bundle "update platformspecific", raise_on_error: false
-      expect(err).to include "Did you mean platform_specific?"
+      expect(err).to include "Did you mean 'platform_specific'?"
     end
   end