Change find_similar_name to a module_function

Change `NameSimilarity#find_similar_name` into `NameSimilarity.find_similar_name`, since it no longer needs to call back to a method in the same context.
rubocop · May 10, 2020 · fd3ba1f · fd3ba1f
1 parent 77b59de
commit fd3ba1f
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 4 deletions.
diff --git a/lib/rubocop/cop/lint/redundant_cop_disable_directive.rb b/lib/rubocop/cop/lint/redundant_cop_disable_directive.rb
@@ -26,7 +26,6 @@ module Lint
       #   # good
       #   x += 1
       class RedundantCopDisableDirective < Cop
-        include NameSimilarity
         include RangeHelp
 
         COP_NAME = 'Lint/RedundantCopDisableDirective'
@@ -235,7 +234,7 @@ def describe(cop)
           elsif all_cop_names.include?(cop)
             "`#{cop}`"
           else
-            similar = find_similar_name(cop, all_cop_names)
+            similar = NameSimilarity.find_similar_name(cop, all_cop_names)
             if similar
               "`#{cop}` (did you mean `#{similar}`?)"
             else

diff --git a/lib/rubocop/cop/lint/useless_assignment.rb b/lib/rubocop/cop/lint/useless_assignment.rb
@@ -31,7 +31,6 @@ module Lint
       #     do_something(some_var)
       #   end
       class UselessAssignment < Cop
-        include NameSimilarity
         MSG = 'Useless assignment to variable - `%<variable>s`.'
 
         def join_force?(force_class)
@@ -95,7 +94,8 @@ def operator_assignment_message(scope, assignment)
 
         def similar_name_message(variable)
           variable_like_names = collect_variable_like_names(variable.scope)
-          similar_name = find_similar_name(variable.name, variable_like_names)
+          similar_name = NameSimilarity.find_similar_name(variable.name,
+                                                          variable_like_names)
           " Did you mean `#{similar_name}`?" if similar_name
         end
 

diff --git a/lib/rubocop/name_similarity.rb b/lib/rubocop/name_similarity.rb
@@ -3,6 +3,8 @@
 module RuboCop
   # Common functionality for finding names that are similar to a given name.
   module NameSimilarity
+    module_function
+
     MINIMUM_SIMILARITY_TO_SUGGEST = 0.9
 
     def find_similar_name(target_name, names)