rubocop 0.51.0 → 0.87.0

data/lib/rubocop/formatter/simple_text_formatter.rb

@@ -27,6 +27,7 @@ module RuboCop
 
       def file_finished(file, offenses)
         return if offenses.empty?
+
         count_stats(offenses)
         report_file(file, offenses)
       end
@@ -41,9 +42,13 @@ module RuboCop
         output.puts yellow("== #{smart_path(file)} ==")
 
         offenses.each do |o|
-          output.printf("%s:%3d:%3d: %s\n",
-                        colored_severity_code(o),
-                        o.line, o.real_column, message(o))
+          output.printf(
+            "%<severity>s:%3<line>d:%3<column>d: %<message>s\n",
+            severity: colored_severity_code(o),
+            line: o.line,
+            column: o.real_column,
+            message: message(o)
+          )
         end
       end
 
@@ -74,7 +79,15 @@ module RuboCop
       end
 
       def message(offense)
-        message = offense.corrected? ? green('[Corrected] ') : ''
+        message =
+          if offense.corrected_with_todo?
+            green('[Todo] ')
+          elsif offense.corrected?
+            green('[Corrected] ')
+          else
+            ''
+          end
+
         "#{message}#{annotate_message(offense.message)}"
       end
 
@@ -91,7 +104,7 @@ module RuboCop
         end
 
         def summary
-          if @correction_count > 0
+          if @correction_count.positive?
             "#{files} inspected, #{offenses} detected, #{corrections} corrected"
           else
             "#{files} inspected, #{offenses} detected"

data/lib/rubocop/formatter/tap_formatter.rb

@@ -42,11 +42,15 @@ module RuboCop
       end
 
       def report_offense(file, offense)
-        output.printf("# %s:%d:%d: %s: %s\n",
-                      cyan(smart_path(file)), offense.line, offense.real_column,
-                      colored_severity_code(offense), message(offense))
+        output.printf(
+          "# %<path>s:%<line>d:%<column>d: %<severity>s: %<message>s\n",
+          path: cyan(smart_path(file)),
+          line: offense.line,
+          column: offense.real_column,
+          severity: colored_severity_code(offense),
+          message: message(offense)
+        )
 
-        # rubocop:disable Lint/HandleExceptions
         begin
           return unless valid_line?(offense)
 
@@ -55,7 +59,6 @@ module RuboCop
         rescue IndexError
           # range is not on a valid line; perhaps the source file is empty
         end
-        # rubocop:enable Lint/HandleExceptions
       end
 
       def annotate_message(msg)
@@ -63,7 +66,15 @@ module RuboCop
       end
 
       def message(offense)
-        message = offense.corrected? ? '[Corrected] ' : ''
+        message =
+          if offense.corrected_with_todo?
+            '[Todo] '
+          elsif offense.corrected?
+            '[Corrected] '
+          else
+            ''
+          end
+
         "#{message}#{annotate_message(offense.message)}"
       end
     end

data/lib/rubocop/magic_comment.rb

@@ -6,7 +6,7 @@ module RuboCop
   # @abstract parent of three different magic comment handlers
   class MagicComment
     # @see https://git.io/vMC1C IRB's pattern for matching magic comment tokens
-    TOKEN = /[[:alnum:]\-_]+/
+    TOKEN = /[[:alnum:]\-_]+/.freeze
 
     # Detect magic comment format and pass it to the appropriate wrapper.
     #
@@ -42,6 +42,10 @@ module RuboCop
       frozen_string_literal == true
     end
 
+    def valid_literal_value?
+      [true, false].include?(frozen_string_literal)
+    end
+
     # Was a magic comment for the frozen string literal found?
     #
     # @return [Boolean]
@@ -129,18 +133,18 @@ module RuboCop
     # @see https://www.gnu.org/software/emacs/manual/html_node/emacs/Specify-Coding.html
     # @see https://git.io/vMCXh Emacs handling in Ruby's parse.y
     class EmacsComment < EditorComment
-      FORMAT    = /\-\*\-(.+)\-\*\-/
-      SEPARATOR = ';'.freeze
-      OPERATOR  = ':'.freeze
+      FORMAT    = /-\*-(.+)-\*-/.freeze
+      SEPARATOR = ';'
+      OPERATOR  = ':'
 
       def encoding
-        match('encoding')
+        match('(?:en)?coding')
       end
 
       private
 
       def extract_frozen_string_literal
-        match('frozen_string_literal')
+        match('frozen[_-]string[_-]literal')
       end
     end
 
@@ -153,9 +157,9 @@ module RuboCop
     #
     #   comment.encoding # => 'ascii-8bit'
     class VimComment < EditorComment
-      FORMAT    = /#\s*vim:\s*(.+)/
-      SEPARATOR = ', '.freeze
-      OPERATOR  = '='.freeze
+      FORMAT    = /#\s*vim:\s*(.+)/.freeze
+      SEPARATOR = ', '
+      OPERATOR  = '='
 
       # For some reason the fileencoding keyword only works if there
       # is at least one other token included in the string. For example
@@ -190,7 +194,7 @@ module RuboCop
     class SimpleComment < MagicComment
       # Match `encoding` or `coding`
       def encoding
-        extract(/\b(?:en)?coding: (#{TOKEN})/i)
+        extract(/\A\s*\#.*\b(?:en)?coding: (#{TOKEN})/i)
       end
 
       private
@@ -203,7 +207,7 @@ module RuboCop
       # Case-insensitive and dashes/underscores are acceptable.
       # @see https://git.io/vM7Mg
       def extract_frozen_string_literal
-        extract(/\A#\s*frozen[_-]string[_-]literal:\s*(#{TOKEN})\s*\z/i)
+        extract(/\A\s*#\s*frozen[_-]string[_-]literal:\s*(#{TOKEN})\s*\z/i)
       end
     end
   end

data/lib/rubocop/name_similarity.rb

@@ -3,19 +3,26 @@
 module RuboCop
   # Common functionality for finding names that are similar to a given name.
   module NameSimilarity
-    MINIMUM_SIMILARITY_TO_SUGGEST = 0.9
+    module_function
 
-    def find_similar_name(target_name, scope)
-      names = collect_variable_like_names(scope)
-      names.delete(target_name)
+    def find_similar_name(target_name, names)
+      similar_names = find_similar_names(target_name, names)
+
+      similar_names.first
+    end
 
-      scores = names.each_with_object({}) do |name, hash|
-        score = StringUtil.similarity(target_name, name)
-        hash[name] = score if score >= MINIMUM_SIMILARITY_TO_SUGGEST
-      end
+    def find_similar_names(target_name, names)
+      # DidYouMean::SpellChecker is not available in all versions of Ruby, and
+      # even on versions where it *is* available (>= 2.3), it is not always
+      # required correctly. So we do a feature check first.
+      # See: https://github.com/rubocop-hq/rubocop/issues/7979
+      return [] unless defined?(DidYouMean::SpellChecker)
+
+      names = names.dup
+      names.delete(target_name)
 
-      most_similar_name, _max_score = scores.max_by { |_, score| score }
-      most_similar_name
+      spell_checker = DidYouMean::SpellChecker.new(dictionary: names)
+      spell_checker.correct(target_name)
     end
   end
 end