rubocop 1.11.0 → 1.15.0

data/lib/rubocop/directive_comment.rb

@@ -5,28 +5,88 @@ module RuboCop
   # special `rubocop:disable` and `rubocop:enable` comment and exposes what
   # cops it contains.
   class DirectiveComment
-    attr_reader :comment
+    # @api private
+    REDUNDANT_COP = 'Lint/RedundantCopDisableDirective'
+    # @api private
+    COP_NAME_PATTERN = '([A-Z]\w+/)*(?:[A-Z]\w+)'
+    # @api private
+    COP_NAMES_PATTERN = "(?:#{COP_NAME_PATTERN} , )*#{COP_NAME_PATTERN}"
+    # @api private
+    COPS_PATTERN = "(all|#{COP_NAMES_PATTERN})"
+    # @api private
+    DIRECTIVE_COMMENT_REGEXP = Regexp.new(
+      "# rubocop : ((?:disable|enable|todo))\\b #{COPS_PATTERN}"
+        .gsub(' ', '\s*')
+    )
+
+    def self.before_comment(line)
+      line.split(DIRECTIVE_COMMENT_REGEXP).first
+    end
+
+    attr_reader :comment, :mode, :cops
 
     def initialize(comment)
       @comment = comment
+      @mode, @cops = match_captures
     end
 
-    # Return all the cops specified in the directive
-    def cops
-      match = comment.text.match(CommentConfig::COMMENT_DIRECTIVE_REGEXP)
-      return unless match
-
-      cops_string = match.captures[1]
-      cops_string.split(/,\s*/).uniq.sort
+    # Checks if this directive relates to single line
+    def single_line?
+      !self.class.before_comment(comment.text).empty?
     end
 
     # Checks if this directive contains all the given cop names
     def match?(cop_names)
-      cops == cop_names.uniq.sort
+      parsed_cop_names.uniq.sort == cop_names.uniq.sort
     end
 
     def range
       comment.location.expression
     end
+
+    # Returns match captures to directive comment pattern
+    def match_captures
+      @match_captures ||= comment.text.match(DIRECTIVE_COMMENT_REGEXP)&.captures
+    end
+
+    # Checks if this directive disables cops
+    def disabled?
+      %w[disable todo].include?(mode)
+    end
+
+    # Checks if this directive enables cops
+    def enabled?
+      mode == 'enable'
+    end
+
+    # Checks if this directive enables all cops
+    def enabled_all?
+      !disabled? && all_cops?
+    end
+
+    # Checks if all cops specified in this directive
+    def all_cops?
+      cops == 'all'
+    end
+
+    # Returns array of specified in this directive cop names
+    def cop_names
+      @cop_names ||= all_cops? ? all_cop_names : parsed_cop_names
+    end
+
+    # Returns line number for directive
+    def line_number
+      comment.loc.expression.line
+    end
+
+    private
+
+    def parsed_cop_names
+      (cops || '').split(/,\s*/)
+    end
+
+    def all_cop_names
+      Cop::Registry.global.names - [REDUNDANT_COP]
+    end
   end
 end

data/lib/rubocop/ext/regexp_parser.rb

@@ -39,9 +39,8 @@ module RuboCop
 
             # Shortcut to `loc.expression`
             def expression
-              @expression ||= begin
-                origin.adjust(begin_pos: start_index, end_pos: start_index + full_length)
-              end
+              end_pos = start_index + full_length
+              @expression ||= origin.adjust(begin_pos: start_index, end_pos: end_pos)
             end
           end
 
@@ -60,9 +59,7 @@ module RuboCop
           #
           # Please open issue if you need other locations
           def loc
-            @loc ||= begin
-              Map.new(expression, **build_location)
-            end
+            @loc ||= Map.new(expression, **build_location)
           end
 
           private

data/lib/rubocop/file_finder.rb

@@ -23,9 +23,7 @@ module RuboCop
 
     def find_last_file_upwards(filename, start_dir, stop_dir = nil)
       last_file = nil
-      traverse_files_upwards(filename, start_dir, stop_dir) do |file|
-        last_file = file
-      end
+      traverse_files_upwards(filename, start_dir, stop_dir) { |file| last_file = file }
       last_file
     end
 

data/lib/rubocop/formatter/clang_style_formatter.rb

@@ -49,8 +49,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
     end
   end

data/lib/rubocop/formatter/disabled_config_formatter.rb

@@ -71,9 +71,7 @@ module RuboCop
         command += ' --auto-gen-only-exclude' if @options[:auto_gen_only_exclude]
 
         if @exclude_limit_option
-          command +=
-            format(' --exclude-limit %<limit>d',
-                   limit: Integer(@exclude_limit_option))
+          command += format(' --exclude-limit %<limit>d', limit: Integer(@exclude_limit_option))
         end
         command += ' --no-offense-counts' unless show_offense_counts?
 
@@ -111,8 +109,7 @@ module RuboCop
 
         # In case auto_gen_only_exclude is set, only modify the maximum if the
         # files are not excluded one by one.
-        if !@options[:auto_gen_only_exclude] ||
-           @files_with_offenses[cop_name].size > @exclude_limit
+        if !@options[:auto_gen_only_exclude] || @files_with_offenses[cop_name].size > @exclude_limit
           cfg.merge!(cfg[:exclude_limit])
         end
 
@@ -144,9 +141,7 @@ module RuboCop
 
       def output_cop_param_comments(output_buffer, params, default_cfg)
         config_params = params.reject { |p| p.start_with?('Supported') }
-        output_buffer.puts(
-          "# Configuration parameters: #{config_params.join(', ')}."
-        )
+        output_buffer.puts("# Configuration parameters: #{config_params.join(', ')}.")
 
         params.each do |param|
           value = default_cfg[param]

data/lib/rubocop/formatter/git_hub_actions_formatter.rb

@@ -5,11 +5,7 @@ module RuboCop
     # 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
+      ESCAPE_MAP = { '%' => '%25', "\n" => '%0A', "\r" => '%0D' }.freeze
 
       def file_finished(file, offenses)
         offenses.each { |offense| report_offense(file, offense) }

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
 
@@ -97,9 +93,7 @@ module RuboCop
         # 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,17 +18,17 @@ 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
@@ -36,15 +36,11 @@ module RuboCop
         # In the future, it would be preferable to return only enabled cops.
         Cop::Registry.all.each do |cop|
           target_offenses = offenses_for_cop(offenses, cop)
+          @offense_count += target_offenses.count
 
           next unless relevant_for_output?(options, target_offenses)
 
-          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
+          add_testcase_element_to_testsuite_element(file, target_offenses, cop)
         end
       end
 
@@ -53,8 +49,15 @@ module RuboCop
       end
 
       def offenses_for_cop(all_offenses, cop)
-        all_offenses.select do |offense|
-          offense.cop_name == cop.cop_name
+        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
 
@@ -63,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/progress_formatter.rb

@@ -38,9 +38,7 @@ 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,

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)

data/lib/rubocop/magic_comment.rb

@@ -47,7 +47,7 @@ module RuboCop
     end
 
     def valid_shareable_constant_value?
-      %w[none literal experimental_everything experimental_copy].include?(shareable_constant_values)
+      %w[none literal experimental_everything experimental_copy].include?(shareable_constant_value)
     end
 
     # Was a magic comment for the frozen string literal found?

data/lib/rubocop/options.rb

@@ -112,9 +112,7 @@ module RuboCop
         @options.replace(ConfigRegeneration.new.options.merge(@options))
       end
 
-      option(opts, '--exclude-limit COUNT') do
-        @validator.validate_exclude_limit_option
-      end
+      option(opts, '--exclude-limit COUNT') { @validator.validate_exclude_limit_option }
 
       option(opts, '--disable-uncorrectable')
 
@@ -161,9 +159,7 @@ module RuboCop
 
     def add_cache_options(opts)
       option(opts, '-C', '--cache FLAG')
-      option(opts, '--cache-root DIR') do
-        @validator.validate_cache_enabled_for_cache_root
-      end
+      option(opts, '--cache-root DIR') { @validator.validate_cache_enabled_for_cache_root }
     end
 
     # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
@@ -173,16 +169,12 @@ module RuboCop
       option(opts, '-D', '--[no-]display-cop-names')
       option(opts, '-E', '--extra-details')
       option(opts, '-S', '--display-style-guide')
-      option(opts, '-a', '--auto-correct') do
-        @options[:safe_auto_correct] = true
-      end
+      option(opts, '-a', '--auto-correct') { @options[:safe_auto_correct] = true }
       option(opts, '--safe-auto-correct') do
         warn '--safe-auto-correct is deprecated; use --auto-correct'
         @options[:safe_auto_correct] = @options[:auto_correct] = true
       end
-      option(opts, '-A', '--auto-correct-all') do
-        @options[:auto_correct] = true
-      end
+      option(opts, '-A', '--auto-correct-all') { @options[:auto_correct] = true }
       option(opts, '--disable-pending-cops')
       option(opts, '--enable-pending-cops')
       option(opts, '--ignore-disable-comments')
@@ -194,7 +186,7 @@ module RuboCop
 
       option(opts, '-v', '--version')
       option(opts, '-V', '--verbose-version')
-      option(opts, '-P', '--parallel')
+      option(opts, '-P', '--[no-]parallel')
     end
     # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
 
@@ -229,8 +221,7 @@ module RuboCop
     # e.g. [..., '--auto-correct', ...] to :auto_correct.
     def long_opt_symbol(args)
       long_opt = args.find { |arg| arg.start_with?('--') }
-      long_opt[2..-1].sub('[no-]', '').sub(/ .*/, '')
-                     .tr('-', '_').gsub(/[\[\]]/, '').to_sym
+      long_opt[2..-1].sub('[no-]', '').sub(/ .*/, '').tr('-', '_').gsub(/[\[\]]/, '').to_sym
     end
 
     def require_feature(file)
@@ -286,16 +277,13 @@ module RuboCop
     end
 
     def validate_cop_options
-      %i[only except].each do |opt|
-        OptionsValidator.validate_cop_list(@options[opt])
-      end
+      %i[only except].each { |opt| OptionsValidator.validate_cop_list(@options[opt]) }
     end
 
     # rubocop:disable Metrics/AbcSize
     def validate_compatibility # rubocop:disable Metrics/MethodLength
       if only_includes_redundant_disable?
-        raise OptionArgumentError, 'Lint/RedundantCopDisableDirective cannot ' \
-                                   'be used with --only.'
+        raise OptionArgumentError, 'Lint/RedundantCopDisableDirective cannot be used with --only.'
       end
       raise OptionArgumentError, 'Syntax checking cannot be turned off.' if except_syntax?
       unless boolean_or_empty_cache?
@@ -309,12 +297,11 @@ module RuboCop
       validate_auto_gen_config
       validate_auto_correct
       validate_display_only_failed
-      validate_parallel
+      disable_parallel_when_invalid_option_combo
 
       return if incompatible_options.size <= 1
 
-      raise OptionArgumentError, 'Incompatible cli options: ' \
-                                 "#{incompatible_options.inspect}"
+      raise OptionArgumentError, "Incompatible cli options: #{incompatible_options.inspect}"
     end
     # rubocop:enable Metrics/AbcSize
 
@@ -326,8 +313,7 @@ module RuboCop
       %i[exclude_limit offense_counts auto_gen_timestamp
          auto_gen_only_exclude].each do |option|
         if @options.key?(option)
-          raise OptionArgumentError,
-                format(message, flag: option.to_s.tr('_', '-'))
+          raise OptionArgumentError, format(message, flag: option.to_s.tr('_', '-'))
         end
       end
     end
@@ -348,36 +334,32 @@ module RuboCop
             format('--disable-uncorrectable can only be used together with --auto-correct.')
     end
 
-    def validate_parallel
+    def disable_parallel_when_invalid_option_combo
       return unless @options.key?(:parallel)
 
-      if @options[:cache] == 'false'
-        raise OptionArgumentError, '-P/--parallel uses caching to speed up ' \
-                                   'execution, so combining with --cache ' \
-                                   'false is not allowed.'
+      invalid_options = [
+        { name: :auto_gen_config, value: true, flag: '--auto-gen-config' },
+        { name: :fail_fast, value: true, flag: '-F/--fail-fast.' },
+        { name: :auto_correct, value: true, flag: '--auto-correct.' },
+        { name: :cache, value: 'false', flag: '--cache false' }
+      ]
+
+      invalid_flags = invalid_options.each_with_object([]) do |option, flags|
+        # `>` rather than `>=` because `@options` will also contain `parallel: true`
+        flags << option[:flag] if @options > { option[:name] => option[:value] }
       end
 
-      validate_parallel_with_combo_option
-    end
+      return if invalid_flags.empty?
 
-    def validate_parallel_with_combo_option
-      combos = {
-        auto_gen_config: '-P/--parallel uses caching to speed up execution, ' \
-                         'while --auto-gen-config needs a non-cached run, ' \
-                         'so they cannot be combined.',
-        fail_fast: '-P/--parallel cannot be combined with -F/--fail-fast.',
-        auto_correct: '-P/--parallel cannot be combined with --auto-correct.'
-      }
+      @options.delete(:parallel)
 
-      combos.each do |key, msg|
-        raise OptionArgumentError, msg if @options.key?(key)
-      end
+      puts '-P/--parallel is being ignored because ' \
+           "it is not compatible with #{invalid_flags.join(', ')}"
     end
 
     def only_includes_redundant_disable?
       @options.key?(:only) &&
-        (@options[:only] & %w[Lint/RedundantCopDisableDirective
-                              RedundantCopDisableDirective]).any?
+        (@options[:only] & %w[Lint/RedundantCopDisableDirective RedundantCopDisableDirective]).any?
     end
 
     def display_only_fail_level_offenses_with_autocorrect?
@@ -385,8 +367,7 @@ module RuboCop
     end
 
     def except_syntax?
-      @options.key?(:except) &&
-        (@options[:except] & %w[Lint/Syntax Syntax]).any?
+      @options.key?(:except) && (@options[:except] & %w[Lint/Syntax Syntax]).any?
     end
 
     def boolean_or_empty_cache?
@@ -408,8 +389,7 @@ module RuboCop
     def validate_cache_enabled_for_cache_root
       return unless @options[:cache] == 'false'
 
-      raise OptionArgumentError, '--cache-root can not be used with ' \
-                                  '--cache false'
+      raise OptionArgumentError, '--cache-root can not be used with --cache false'
     end
   end
 
@@ -512,7 +492,7 @@ module RuboCop
       version:                          'Display version.',
       verbose_version:                  'Display verbose version.',
       parallel:                         ['Use available CPUs to execute inspection in',
-                                         'parallel.'],
+                                         'parallel. Default is false.'],
       stdin:                            ['Pipe source from STDIN, using FILE in offense',
                                          'reports. This is useful for editor integration.'],
       init:                             'Generate a .rubocop.yml file in the current directory.'