rubocop 0.82.0 → 1.18.4

data/lib/rubocop/formatter/git_hub_actions_formatter.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Formatter
+    # This formatter formats report data as GitHub Workflow commands resulting
+    # in GitHub check annotations when run within GitHub Actions.
+    class GitHubActionsFormatter < BaseFormatter
+      ESCAPE_MAP = { '%' => '%25', "\n" => '%0A', "\r" => '%0D' }.freeze
+
+      def file_finished(file, offenses)
+        offenses.each { |offense| report_offense(file, offense) }
+      end
+
+      private
+
+      def github_escape(string)
+        string.gsub(Regexp.union(ESCAPE_MAP.keys), ESCAPE_MAP)
+      end
+
+      def minimum_severity_to_fail
+        @minimum_severity_to_fail ||= begin
+          # Unless given explicitly as `fail_level`, `:info` severity offenses do not fail
+          name = options.fetch(:fail_level, :refactor)
+          RuboCop::Cop::Severity.new(name)
+        end
+      end
+
+      def github_severity(offense)
+        offense.severity < minimum_severity_to_fail ? 'warning' : 'error'
+      end
+
+      def report_offense(file, offense)
+        output.printf(
+          "\n::%<severity>s file=%<file>s,line=%<line>d,col=%<column>d::%<message>s\n",
+          severity: github_severity(offense),
+          file: PathUtil.smart_path(file),
+          line: offense.line,
+          column: offense.real_column,
+          message: github_escape(offense.message)
+        )
+      end
+    end
+  end
+end

data/lib/rubocop/formatter/html_formatter.rb

@@ -11,8 +11,7 @@ module RuboCop
     # This formatter saves the output as an html file.
     class HTMLFormatter < BaseFormatter
       ELLIPSES = '<span class="extra-code">...</span>'
-      TEMPLATE_PATH =
-        File.expand_path('../../../assets/output.html.erb', __dir__)
+      TEMPLATE_PATH = File.expand_path('../../../assets/output.html.erb', __dir__)
 
       Color = Struct.new(:red, :green, :blue, :alpha) do
         def to_s
@@ -20,9 +19,7 @@ module RuboCop
         end
 
         def fade_out(amount)
-          dup.tap do |color|
-            color.alpha -= amount
-          end
+          dup.tap { |color| color.alpha -= amount }
         end
       end
 
@@ -79,8 +76,7 @@ module RuboCop
           fatal:      Color.new(0xD2, 0x32, 0x2D, 1.0)
         }.freeze
 
-        LOGO_IMAGE_PATH =
-          File.expand_path('../../../assets/logo.png', __dir__)
+        LOGO_IMAGE_PATH = File.expand_path('../../../assets/logo.png', __dir__)
 
         attr_reader :files, :summary
 
@@ -90,14 +86,14 @@ module RuboCop
         end
 
         # Make Kernel#binding public.
+        # rubocop:disable Lint/UselessMethodDefinition
         def binding
           super
         end
+        # rubocop:enable Lint/UselessMethodDefinition
 
         def decorated_message(offense)
-          offense.message.gsub(/`(.+?)`/) do
-            "<code>#{Regexp.last_match(1)}</code>"
-          end
+          offense.message.gsub(/`(.+?)`/) { "<code>#{Regexp.last_match(1)}</code>" }
         end
 
         def highlighted_source_line(offense)

data/lib/rubocop/formatter/json_formatter.rb

@@ -13,11 +13,7 @@ module RuboCop
 
       def initialize(output, options = {})
         super
-        @output_hash = {
-          metadata: metadata_hash,
-          files:    [],
-          summary:  { offense_count: 0 }
-        }
+        @output_hash = { metadata: metadata_hash, files: [], summary: { offense_count: 0 } }
       end
 
       def started(target_files)

data/lib/rubocop/formatter/junit_formatter.rb

@@ -18,33 +18,46 @@ module RuboCop
       def initialize(output, options = {})
         super
 
-        @document = REXML::Document.new.tap do |document|
-          document << REXML::XMLDecl.new
-        end
+        @document = REXML::Document.new.tap { |document| document << REXML::XMLDecl.new }
         testsuites = REXML::Element.new('testsuites', @document)
         testsuite = REXML::Element.new('testsuite', testsuites)
-        @testsuite = testsuite.tap do |element|
-          element.add_attributes('name' => 'rubocop')
-        end
+        @testsuite = testsuite.tap { |element| element.add_attributes('name' => 'rubocop') }
+
+        reset_count
       end
 
       def file_finished(file, offenses)
+        @inspected_file_count += 1
+
         # TODO: Returns all cops with the same behavior as
         # the original rubocop-junit-formatter.
         # https://github.com/mikian/rubocop-junit-formatter/blob/v0.1.4/lib/rubocop/formatter/junit_formatter.rb#L9
         #
         # In the future, it would be preferable to return only enabled cops.
-        Cop::Cop.all.each do |cop|
-          REXML::Element.new('testcase', @testsuite).tap do |testcase|
-            testcase.attributes['classname'] = classname_attribute_value(file)
-            testcase.attributes['name'] = cop.cop_name
+        Cop::Registry.all.each do |cop|
+          target_offenses = offenses_for_cop(offenses, cop)
+          @offense_count += target_offenses.count
 
-            target_offenses = offenses.select do |offense|
-              offense.cop_name == cop.cop_name
-            end
+          next unless relevant_for_output?(options, target_offenses)
 
-            add_failure_to(testcase, target_offenses, cop.cop_name)
-          end
+          add_testcase_element_to_testsuite_element(file, target_offenses, cop)
+        end
+      end
+
+      def relevant_for_output?(options, target_offenses)
+        !options[:display_only_failed] || target_offenses.any?
+      end
+
+      def offenses_for_cop(all_offenses, cop)
+        all_offenses.select { |offense| offense.cop_name == cop.cop_name }
+      end
+
+      def add_testcase_element_to_testsuite_element(file, target_offenses, cop)
+        REXML::Element.new('testcase', @testsuite).tap do |testcase|
+          testcase.attributes['classname'] = classname_attribute_value(file)
+          testcase.attributes['name'] = cop.cop_name
+
+          add_failure_to(testcase, target_offenses, cop.cop_name)
         end
       end
 
@@ -53,11 +66,17 @@ module RuboCop
       end
 
       def finished(_inspected_files)
+        @testsuite.add_attributes('tests' => @inspected_file_count, 'failures' => @offense_count)
         @document.write(output, 2)
       end
 
       private
 
+      def reset_count
+        @inspected_file_count = 0
+        @offense_count = 0
+      end
+
       def add_failure_to(testcase, offenses, cop_name)
         # One failure per offense. Zero failures is a passing test case,
         # for most surefire/nUnit parsers.

data/lib/rubocop/formatter/offense_count_formatter.rb

@@ -63,11 +63,11 @@ module RuboCop
       # rubocop:enable Metrics/AbcSize
 
       def ordered_offense_counts(offense_counts)
-        Hash[offense_counts.sort_by { |k, v| [-v, k] }]
+        offense_counts.sort_by { |k, v| [-v, k] }.to_h
       end
 
       def total_offense_count(offense_counts)
-        offense_counts.values.inject(0, :+)
+        offense_counts.values.sum
       end
     end
   end

data/lib/rubocop/formatter/progress_formatter.rb

@@ -38,14 +38,13 @@ module RuboCop
           output.puts 'Offenses:'
           output.puts
 
-          @offenses_for_files.each do |file, offenses|
-            report_file(file, offenses)
-          end
+          @offenses_for_files.each { |file, offenses| report_file(file, offenses) }
         end
 
         report_summary(inspected_files.size,
                        @total_offense_count,
-                       @total_correction_count)
+                       @total_correction_count,
+                       @total_correctable_count)
       end
 
       def report_file_as_mark(offenses)

data/lib/rubocop/formatter/quiet_formatter.rb

@@ -5,7 +5,7 @@ module RuboCop
     # If no offenses are found, no output is displayed.
     # Otherwise, SimpleTextFormatter's output is displayed.
     class QuietFormatter < SimpleTextFormatter
-      def report_summary(file_count, offense_count, correction_count)
+      def report_summary(file_count, offense_count, correction_count, correctable_count)
         super unless offense_count.zero?
       end
     end

data/lib/rubocop/formatter/simple_text_formatter.rb

@@ -13,6 +13,7 @@ module RuboCop
       include PathUtil
 
       COLOR_FOR_SEVERITY = {
+        info:       :gray,
         refactor:   :yellow,
         convention: :yellow,
         warning:    :magenta,
@@ -23,6 +24,7 @@ module RuboCop
       def started(_target_files)
         @total_offense_count = 0
         @total_correction_count = 0
+        @total_correctable_count = 0
       end
 
       def file_finished(file, offenses)
@@ -35,7 +37,8 @@ module RuboCop
       def finished(inspected_files)
         report_summary(inspected_files.count,
                        @total_offense_count,
-                       @total_correction_count)
+                       @total_correction_count,
+                       @total_correctable_count)
       end
 
       def report_file(file, offenses)
@@ -52,11 +55,13 @@ module RuboCop
         end
       end
 
-      def report_summary(file_count, offense_count, correction_count)
+      def report_summary(file_count, offense_count, correction_count, correctable_count)
         report = Report.new(file_count,
                             offense_count,
                             correction_count,
-                            rainbow)
+                            correctable_count,
+                            rainbow,
+                            safe_auto_correct: @options[:safe_auto_correct])
 
         output.puts
         output.puts report.summary
@@ -66,11 +71,13 @@ module RuboCop
 
       def count_stats(offenses)
         @total_offense_count += offenses.count
-        @total_correction_count += offenses.count(&:corrected?)
+        corrected = offenses.count(&:corrected?)
+        @total_correction_count += corrected
+        @total_correctable_count += offenses.count(&:correctable?) - corrected
       end
 
       def colored_severity_code(offense)
-        color = COLOR_FOR_SEVERITY[offense.severity.name]
+        color = COLOR_FOR_SEVERITY.fetch(offense.severity.name)
         colorize(offense.severity.code, color)
       end
 
@@ -84,6 +91,8 @@ module RuboCop
             green('[Todo] ')
           elsif offense.corrected?
             green('[Corrected] ')
+          elsif offense.correctable?
+            yellow('[Correctable] ')
           else
             ''
           end
@@ -96,16 +105,30 @@ module RuboCop
         include Colorizable
         include TextUtil
 
-        def initialize(file_count, offense_count, correction_count, rainbow)
+        # rubocop:disable Metrics/ParameterLists
+        def initialize(
+          file_count, offense_count, correction_count, correctable_count, rainbow,
+          safe_auto_correct: false
+        )
           @file_count = file_count
           @offense_count = offense_count
           @correction_count = correction_count
+          @correctable_count = correctable_count
           @rainbow = rainbow
+          @safe_auto_correct = safe_auto_correct
         end
+        # rubocop:enable Metrics/ParameterLists
 
         def summary
           if @correction_count.positive?
-            "#{files} inspected, #{offenses} detected, #{corrections} corrected"
+            if @correctable_count.positive?
+              "#{files} inspected, #{offenses} detected, #{corrections} corrected,"\
+                " #{correctable}"
+            else
+              "#{files} inspected, #{offenses} detected, #{corrections} corrected"
+            end
+          elsif @correctable_count.positive?
+            "#{files} inspected, #{offenses} detected, #{correctable}"
           else
             "#{files} inspected, #{offenses} detected"
           end
@@ -132,6 +155,16 @@ module RuboCop
 
           colorize(text, color)
         end
+
+        def correctable
+          if @safe_auto_correct
+            text = pluralize(@correctable_count, 'more offense')
+            "#{colorize(text, :yellow)} can be corrected with `rubocop -A`"
+          else
+            text = pluralize(@correctable_count, 'offense')
+            "#{colorize(text, :yellow)} auto-correctable"
+          end
+        end
       end
     end
   end

data/lib/rubocop/formatter/tap_formatter.rb

@@ -37,8 +37,10 @@ module RuboCop
       end
 
       def report_highlighted_area(highlighted_area)
-        output.puts("# #{' ' * highlighted_area.begin_pos}" \
-                    "#{'^' * highlighted_area.size}")
+        space_area  = highlighted_area.source_buffer.slice(0...highlighted_area.begin_pos)
+        source_area = highlighted_area.source
+        output.puts("# #{' ' * Unicode::DisplayWidth.of(space_area)}" \
+                    "#{'^' * Unicode::DisplayWidth.of(source_area)}")
       end
 
       def report_offense(file, offense)
@@ -71,6 +73,8 @@ module RuboCop
             '[Todo] '
           elsif offense.corrected?
             '[Corrected] '
+          elsif offense.correctable?
+            '[Correctable] '
           else
             ''
           end

data/lib/rubocop/formatter/worst_offenders_formatter.rb

@@ -51,11 +51,11 @@ module RuboCop
       # rubocop:enable Metrics/AbcSize
 
       def ordered_offense_counts(offense_counts)
-        Hash[offense_counts.sort_by { |k, v| [-v, k] }]
+        offense_counts.sort_by { |k, v| [-v, k] }.to_h
       end
 
       def total_offense_count(offense_counts)
-        offense_counts.values.inject(0, :+)
+        offense_counts.values.sum
       end
     end
   end

data/lib/rubocop/lockfile.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module RuboCop
+  # Encapsulation of a lockfile for use when checking for gems.
+  # Does not actually resolve gems, just parses the lockfile.
+  # @api private
+  class Lockfile
+    # Gems that the bundle depends on
+    def dependencies
+      return [] unless parser
+
+      parser.dependencies.values
+    end
+
+    # All activated gems, including transitive dependencies
+    def gems
+      return [] unless parser
+
+      # `Bundler::LockfileParser` returns `Bundler::LazySpecification` objects
+      # which are not resolved, so extract the dependencies from them
+      parser.dependencies.values.concat(parser.specs.flat_map(&:dependencies))
+    end
+
+    def includes_gem?(name)
+      gems.any? { |gem| gem.name == name }
+    end
+
+    private
+
+    def parser
+      return unless defined?(Bundler) && Bundler.default_lockfile
+      return @parser if defined?(@parser)
+
+      lockfile = Bundler.read_file(Bundler.default_lockfile)
+      @parser = lockfile ? Bundler::LockfileParser.new(lockfile) : nil
+    rescue Bundler::BundlerError
+      nil
+    end
+  end
+end

data/lib/rubocop/magic_comment.rb

@@ -27,7 +27,7 @@ module RuboCop
     end
 
     def any?
-      frozen_string_literal_specified? || encoding_specified?
+      frozen_string_literal_specified? || encoding_specified? || shareable_constant_value_specified?
     end
 
     # Does the magic comment enable the frozen string literal feature.
@@ -46,6 +46,10 @@ module RuboCop
       [true, false].include?(frozen_string_literal)
     end
 
+    def valid_shareable_constant_value?
+      %w[none literal experimental_everything experimental_copy].include?(shareable_constant_value)
+    end
+
     # Was a magic comment for the frozen string literal found?
     #
     # @return [Boolean]
@@ -53,6 +57,13 @@ module RuboCop
       specified?(frozen_string_literal)
     end
 
+    # Was a shareable_constant_value specified?
+    #
+    # @return [Boolean]
+    def shareable_constant_value_specified?
+      specified?(shareable_constant_value)
+    end
+
     # Expose the `frozen_string_literal` value coerced to a boolean if possible.
     #
     # @return [Boolean] if value is `true` or `false`
@@ -69,6 +80,13 @@ module RuboCop
       end
     end
 
+    # Expose the `shareable_constant_value` value coerced to a boolean if possible.
+    #
+    # @return [String] for shareable_constant_value config
+    def shareable_constant_value
+      extract_shareable_constant_value
+    end
+
     def encoding_specified?
       specified?(encoding)
     end
@@ -133,7 +151,7 @@ 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    = /\-\*\-(.+)\-\*\-/.freeze
+      FORMAT    = /-\*-(.+)-\*-/.freeze
       SEPARATOR = ';'
       OPERATOR  = ':'
 
@@ -146,6 +164,10 @@ module RuboCop
       def extract_frozen_string_literal
         match('frozen[_-]string[_-]literal')
       end
+
+      def extract_shareable_constant_value
+        match('shareable[_-]constant[_-]values')
+      end
     end
 
     # Wrapper for Vim style magic comments.
@@ -176,6 +198,9 @@ module RuboCop
 
       # Vim comments cannot specify frozen string literal behavior.
       def frozen_string_literal; end
+
+      # Vim comments cannot specify shareable constant values behavior.
+      def shareable_constant_value; end
     end
 
     # Wrapper for regular magic comments not bound to an editor.
@@ -194,7 +219,7 @@ module RuboCop
     class SimpleComment < MagicComment
       # Match `encoding` or `coding`
       def encoding
-        extract(/\A\s*\#.*\b(?:en)?coding: (#{TOKEN})/i)
+        extract(/\A\s*\#.*\b(?:en)?coding: (#{TOKEN})/io)
       end
 
       private
@@ -207,7 +232,11 @@ module RuboCop
       # Case-insensitive and dashes/underscores are acceptable.
       # @see https://git.io/vM7Mg
       def extract_frozen_string_literal
-        extract(/\A\s*#\s*frozen[_-]string[_-]literal:\s*(#{TOKEN})\s*\z/i)
+        extract(/\A\s*#\s*frozen[_-]string[_-]literal:\s*(#{TOKEN})\s*\z/io)
+      end
+
+      def extract_shareable_constant_value
+        extract(/\A\s*#\s*shareable[_-]constant[_-]value:\s*(#{TOKEN})\s*\z/io)
       end
     end
   end