rubocop 1.36.0 → 1.40.0

data/lib/rubocop/cop/variable_force.rb

@@ -108,34 +108,26 @@ module RuboCop
         :skip_children
       end
 
-      # rubocop:disable Metrics/MethodLength, Metrics/CyclomaticComplexity
+      # rubocop:disable Layout/ClassStructure
+      NODE_HANDLER_METHOD_NAMES = [
+        [VARIABLE_ASSIGNMENT_TYPE, :process_variable_assignment],
+        [REGEXP_NAMED_CAPTURE_TYPE, :process_regexp_named_captures],
+        [MULTIPLE_ASSIGNMENT_TYPE, :process_variable_multiple_assignment],
+        [VARIABLE_REFERENCE_TYPE, :process_variable_referencing],
+        [RESCUE_TYPE, :process_rescue],
+        [ZERO_ARITY_SUPER_TYPE, :process_zero_arity_super],
+        [SEND_TYPE, :process_send],
+        *ARGUMENT_DECLARATION_TYPES.product([:process_variable_declaration]),
+        *OPERATOR_ASSIGNMENT_TYPES.product([:process_variable_operator_assignment]),
+        *LOOP_TYPES.product([:process_loop]),
+        *SCOPE_TYPES.product([:process_scope])
+      ].to_h.freeze
+      private_constant :NODE_HANDLER_METHOD_NAMES
+      # rubocop:enable Layout/ClassStructure
+
       def node_handler_method_name(node)
-        case node.type
-        when VARIABLE_ASSIGNMENT_TYPE
-          :process_variable_assignment
-        when REGEXP_NAMED_CAPTURE_TYPE
-          :process_regexp_named_captures
-        when MULTIPLE_ASSIGNMENT_TYPE
-          :process_variable_multiple_assignment
-        when VARIABLE_REFERENCE_TYPE
-          :process_variable_referencing
-        when RESCUE_TYPE
-          :process_rescue
-        when ZERO_ARITY_SUPER_TYPE
-          :process_zero_arity_super
-        when SEND_TYPE
-          :process_send
-        when *ARGUMENT_DECLARATION_TYPES
-          :process_variable_declaration
-        when *OPERATOR_ASSIGNMENT_TYPES
-          :process_variable_operator_assignment
-        when *LOOP_TYPES
-          :process_loop
-        when *SCOPE_TYPES
-          :process_scope
-        end
+        NODE_HANDLER_METHOD_NAMES[node.type]
       end
-      # rubocop:enable Metrics/MethodLength, Metrics/CyclomaticComplexity
 
       def process_variable_declaration(node)
         variable_name = node.children.first
@@ -358,13 +350,12 @@ module RuboCop
         end
       end
 
-      # Use Node#equal? for accurate check.
       def scanned_node?(node)
-        scanned_nodes.any? { |scanned_node| scanned_node.equal?(node) }
+        scanned_nodes.include?(node)
       end
 
       def scanned_nodes
-        @scanned_nodes ||= []
+        @scanned_nodes ||= Set.new.compare_by_identity
       end
 
       # Hooks invoked by VariableTable.

data/lib/rubocop/cops_documentation_generator.rb

@@ -185,7 +185,8 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
   def to_table(header, content)
     table = ['|===', "| #{header.join(' | ')}\n\n"].join("\n")
     marked_contents = content.map do |plain_content|
-      plain_content.map { |c| "| #{c}" }.join("\n")
+      # Escape `|` with backslash to prevent the regexp `|` is not used as a table separator.
+      plain_content.map { |c| "| #{c.gsub(/\|/, '\|')}" }.join("\n")
     end
     table << marked_contents.join("\n\n")
     table << "\n|===\n"

data/lib/rubocop/ext/processed_source.rb

@@ -4,6 +4,8 @@ module RuboCop
   module Ext
     # Extensions to AST::ProcessedSource for our cached comment_config
     module ProcessedSource
+      attr_accessor :registry, :config
+
       def comment_config
         @comment_config ||= CommentConfig.new(self)
       end

data/lib/rubocop/formatter/disabled_config_formatter.rb

@@ -65,18 +65,26 @@ module RuboCop
         @options.fetch(:offense_counts, true)
       end
 
+      def auto_gen_enforced_style?
+        @options.fetch(:auto_gen_enforced_style, true)
+      end
+
       def command
         command = 'rubocop --auto-gen-config'
 
         command += ' --auto-gen-only-exclude' if @options[:auto_gen_only_exclude]
 
-        if @exclude_limit_option
+        if no_exclude_limit?
+          command += ' --no-exclude-limit'
+        elsif @exclude_limit_option
           command += format(' --exclude-limit %<limit>d', limit: Integer(@exclude_limit_option))
         end
         command += ' --no-offense-counts' unless show_offense_counts?
 
         command += ' --no-auto-gen-timestamp' unless show_timestamp?
 
+        command += ' --no-auto-gen-enforced-style' unless auto_gen_enforced_style?
+
         command
       end
 
@@ -170,24 +178,29 @@ module RuboCop
       end
 
       def output_cop_config(output_buffer, cfg, cop_name)
-        # 'Enabled' option will be put into file only if exclude
-        # limit is exceeded.
-        cfg_without_enabled = cfg.reject { |key| key == 'Enabled' }
-
+        filtered_cfg = filtered_config(cfg)
         output_buffer.puts "#{cop_name}:"
-        cfg_without_enabled.each do |key, value|
+        filtered_cfg.each do |key, value|
           value = value[0] if value.is_a?(Array)
           output_buffer.puts "  #{key}: #{value}"
         end
 
-        output_offending_files(output_buffer, cfg_without_enabled, cop_name)
+        output_offending_files(output_buffer, filtered_cfg, cop_name)
+      end
+
+      def filtered_config(cfg)
+        # 'Enabled' option will be put into file only if exclude
+        # limit is exceeded.
+        rejected_keys = ['Enabled']
+        rejected_keys << 'EnforcedStyle' unless auto_gen_enforced_style?
+        cfg.reject { |key| rejected_keys.include?(key) }
       end
 
       def output_offending_files(output_buffer, cfg, cop_name)
         return unless cfg.empty?
 
         offending_files = @files_with_offenses[cop_name].sort
-        if offending_files.count > @exclude_limit
+        if !no_exclude_limit? && offending_files.count > @exclude_limit
           output_buffer.puts '  Enabled: false'
         else
           output_exclude_list(output_buffer, offending_files, cop_name)
@@ -245,6 +258,10 @@ module RuboCop
       def safe_autocorrect?(config)
         config.fetch('Safe', true) && config.fetch('SafeAutoCorrect', true)
       end
+
+      def no_exclude_limit?
+        @options[:no_exclude_limit] == false
+      end
     end
   end
 end

data/lib/rubocop/formatter/html_formatter.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
+require 'base64'
 require 'cgi'
 require 'erb'
 require 'ostruct'
-require 'base64'
 
 module RuboCop
   module Formatter

data/lib/rubocop/formatter/offense_count_formatter.rb

@@ -12,13 +12,14 @@ module RuboCop
     # 26  LineLength
     # 3   OneLineConditional
     # --
-    # 29  Total
+    # 29  Total in 5 files
     class OffenseCountFormatter < BaseFormatter
       attr_reader :offense_counts
 
       def started(target_files)
         super
         @offense_counts = Hash.new(0)
+        @offending_files_count = 0
         @style_guide_links = {}
 
         return unless output.tty?
@@ -43,26 +44,28 @@ module RuboCop
         if options[:display_style_guide]
           offenses.each { |o| @style_guide_links[o.cop_name] ||= o.message[/ \(http\S+\)\Z/] }
         end
+        @offending_files_count += 1 unless offenses.empty?
         @progressbar.increment if instance_variable_defined?(:@progressbar)
       end
 
       def finished(_inspected_files)
-        report_summary(@offense_counts)
+        report_summary(@offense_counts, @offending_files_count)
       end
 
       # rubocop:disable Metrics/AbcSize
-      def report_summary(offense_counts)
+      def report_summary(offense_counts, offending_files_count)
         per_cop_counts = ordered_offense_counts(offense_counts)
         total_count = total_offense_count(offense_counts)
 
         output.puts
 
+        column_width = total_count.to_s.length + 2
         per_cop_counts.each do |cop_name, count|
-          output.puts "#{count.to_s.ljust(total_count.to_s.length + 2)}#{cop_name}" \
+          output.puts "#{count.to_s.ljust(column_width)}#{cop_name}" \
                       "#{@style_guide_links[cop_name]}\n"
         end
         output.puts '--'
-        output.puts "#{total_count}  Total"
+        output.puts "#{total_count}  Total in #{offending_files_count} files"
 
         output.puts
       end

data/lib/rubocop/formatter/worst_offenders_formatter.rb

@@ -12,7 +12,7 @@ module RuboCop
     # 26  this/file/is/really/bad.rb
     # 3   just/ok.rb
     # --
-    # 29  Total
+    # 29  Total in 2 files
     class WorstOffendersFormatter < BaseFormatter
       attr_reader :offense_counts
 
@@ -36,14 +36,17 @@ module RuboCop
       def report_summary(offense_counts)
         per_file_counts = ordered_offense_counts(offense_counts)
         total_count = total_offense_count(offense_counts)
+        file_count = per_file_counts.size
 
         output.puts
 
+        column_width = total_count.to_s.length + 2
         per_file_counts.each do |file_name, count|
-          output.puts "#{count.to_s.ljust(total_count.to_s.length + 2)}#{file_name}\n"
+          output.puts "#{count.to_s.ljust(column_width)}#{file_name}\n"
         end
+
         output.puts '--'
-        output.puts "#{total_count}  Total"
+        output.puts "#{total_count}  Total in #{file_count} files"
 
         output.puts
       end

data/lib/rubocop/formatter.rb

@@ -6,6 +6,7 @@ module RuboCop
 
     require_relative 'formatter/base_formatter'
     require_relative 'formatter/simple_text_formatter'
+
     # relies on simple text
     require_relative 'formatter/clang_style_formatter'
     require_relative 'formatter/disabled_config_formatter'
@@ -18,11 +19,12 @@ module RuboCop
     require_relative 'formatter/junit_formatter'
     require_relative 'formatter/markdown_formatter'
     require_relative 'formatter/offense_count_formatter'
+    require_relative 'formatter/pacman_formatter'
     require_relative 'formatter/progress_formatter'
     require_relative 'formatter/quiet_formatter'
     require_relative 'formatter/tap_formatter'
     require_relative 'formatter/worst_offenders_formatter'
-    require_relative 'formatter/pacman_formatter'
+
     # relies on progress formatter
     require_relative 'formatter/auto_gen_config_formatter'
 

data/lib/rubocop/optimized_patterns.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module RuboCop
+  # @api private
+  module OptimizedPatterns
+    # A wrapper around patterns array to perform optimized search.
+    # @api private
+    class PatternsSet
+      def initialize(patterns)
+        @strings = Set.new
+        @patterns = []
+        partition_patterns(patterns)
+      end
+
+      def match?(path)
+        @strings.include?(path) || @patterns.any? { |pattern| PathUtil.match_path?(pattern, path) }
+      end
+
+      private
+
+      def partition_patterns(patterns)
+        patterns.each do |pattern|
+          if pattern.is_a?(String) && !pattern.match?(/[*{\[?]/)
+            @strings << pattern
+          else
+            @patterns << pattern
+          end
+        end
+      end
+    end
+
+    @cache = {}.compare_by_identity
+
+    def self.from(patterns)
+      @cache[patterns] ||= PatternsSet.new(patterns)
+    end
+  end
+end

data/lib/rubocop/options.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
 require 'optparse'
-require 'shellwords'
+require_relative 'arguments_env'
+require_relative 'arguments_file'
 
 module RuboCop
   class IncorrectCopNameError < StandardError; end
@@ -24,7 +25,10 @@ module RuboCop
     end
 
     def parse(command_line_args)
+      args_from_file = ArgumentsFile.read_as_arguments
+      args_from_env = ArgumentsEnv.read_as_arguments
       args = args_from_file.concat(args_from_env).concat(command_line_args)
+
       define_options.parse!(args)
 
       @validator.validate_compatibility
@@ -45,18 +49,6 @@ module RuboCop
 
     private
 
-    def args_from_file
-      if File.exist?('.rubocop') && !File.directory?('.rubocop')
-        File.read('.rubocop').shellsplit
-      else
-        []
-      end
-    end
-
-    def args_from_env
-      Shellwords.split(ENV.fetch('RUBOCOP_OPTS', ''))
-    end
-
     def define_options
       OptionParser.new do |opts|
         opts.banner = rainbow.wrap('Usage: rubocop [options] [file1, file2, ...]').bright
@@ -73,7 +65,7 @@ module RuboCop
     end
 
     def add_check_options(opts) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-      section(opts, 'Basic Options') do
+      section(opts, 'Basic Options') do # rubocop:disable Metrics/BlockLength
         option(opts, '-l', '--lint') do
           @options[:only] ||= []
           @options[:only] << 'Lint'
@@ -98,6 +90,7 @@ module RuboCop
         option(opts, '--force-default-config')
         option(opts, '-s', '--stdin FILE')
         option(opts, '-P', '--[no-]parallel')
+        option(opts, '--raise-cop-error')
         add_severity_option(opts)
       end
     end
@@ -169,10 +162,12 @@ module RuboCop
         end
 
         option(opts, '--exclude-limit COUNT') { @validator.validate_exclude_limit_option }
+        option(opts, '--no-exclude-limit')
 
         option(opts, '--[no-]offense-counts')
         option(opts, '--[no-]auto-gen-only-exclude')
         option(opts, '--[no-]auto-gen-timestamp')
+        option(opts, '--[no-]auto-gen-enforced-style')
       end
     end
 
@@ -400,6 +395,12 @@ module RuboCop
     end
 
     def validate_autocorrect
+      if @options.key?(:safe_autocorrect) && @options.key?(:autocorrect_all)
+        message = Rainbow(<<~MESSAGE).red
+          Error: Both safe and unsafe autocorrect options are specified, use only one.
+        MESSAGE
+        raise OptionArgumentError, message
+      end
       return if @options.key?(:autocorrect)
       return unless @options.key?(:disable_uncorrectable)
 
@@ -464,7 +465,7 @@ module RuboCop
 
   # This module contains help texts for command line options.
   # @api private
-  module OptionsHelp
+  module OptionsHelp # rubocop:disable Metrics/ModuleLength
     MAX_EXCL = RuboCop::Options::DEFAULT_MAXIMUM_EXCLUSION_ITEMS.to_s
     FORMATTER_OPTION_LIST = RuboCop::Formatter::FormatterSet::BUILTIN_FORMATTERS_FOR_KEYS.keys
 
@@ -486,6 +487,13 @@ module RuboCop
       auto_gen_timestamp:
                                         ['Include the date and time when the --auto-gen-config',
                                          'was run in the file it generates. Default is true.'],
+      auto_gen_enforced_style:
+                                        ['Add a setting to the TODO configuration file to enforce',
+                                         'the style used, rather than a per-file exclusion',
+                                         'if one style is used in all files for cop with',
+                                         'EnforcedStyle as a configurable option',
+                                         'when the --auto-gen-config was run',
+                                         'in the file it generates. Default is true.'],
       auto_gen_only_exclude:
                                         ['Generate only Exclude parameters and not Max',
                                          'when running --auto-gen-config, except if the',
@@ -497,6 +505,7 @@ module RuboCop
       disable_uncorrectable:            ['Used with --autocorrect to annotate any',
                                          'offenses that do not support autocorrect',
                                          'with `rubocop:todo` comments.'],
+      no_exclude_limit:                 ['Do not set the limit for how many files to exclude.'],
       force_exclusion:                  ['Any files excluded by `Exclude` in configuration',
                                          'files will be excluded, even if given explicitly',
                                          'as arguments.'],
@@ -589,7 +598,10 @@ module RuboCop
       restart_server:                   'Restart server process.',
       start_server:                     'Start server process.',
       stop_server:                      'Stop server process.',
-      server_status:                    'Show server status.'
+      server_status:                    'Show server status.',
+      raise_cop_error:                  ['Raise cop-related errors with cause and location.',
+                                         'This is used to prevent cops from failing silently.',
+                                         'Default is false.']
     }.freeze
   end
 end

data/lib/rubocop/path_util.rb

@@ -33,11 +33,18 @@ module RuboCop
       end
     end
 
+    # rubocop:disable Metrics/MethodLength, Metrics/CyclomaticComplexity
     def match_path?(pattern, path)
       case pattern
       when String
-        File.fnmatch?(pattern, path, File::FNM_PATHNAME | File::FNM_EXTGLOB) ||
-          hidden_file_in_not_hidden_dir?(pattern, path)
+        matches =
+          if pattern == path
+            true
+          elsif pattern.match?(/[*{\[?]/)
+            File.fnmatch?(pattern, path, File::FNM_PATHNAME | File::FNM_EXTGLOB)
+          end
+
+        matches || hidden_file_in_not_hidden_dir?(pattern, path)
       when Regexp
         begin
           pattern.match?(path)
@@ -48,6 +55,7 @@ module RuboCop
         end
       end
     end
+    # rubocop:enable Metrics/MethodLength, Metrics/CyclomaticComplexity
 
     # Returns true for an absolute Unix or Windows path.
     def absolute?(path)
@@ -67,8 +75,12 @@ module RuboCop
       maybe_hidden_file?(path) && File.basename(path).start_with?('.')
     end
 
+    HIDDEN_FILE_PATTERN = "#{File::SEPARATOR}."
+
     # Loose check to reduce memory allocations
     def maybe_hidden_file?(path)
+      return false unless path.include?(HIDDEN_FILE_PATTERN)
+
       separator_index = path.rindex(File::SEPARATOR)
       return false unless separator_index
 

data/lib/rubocop/result_cache.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 require 'digest/sha1'
-require 'find'
 require 'etc'
+require 'find'
 require 'zlib'
 require_relative 'cache_config'
 

data/lib/rubocop/rspec/cop_helper.rb

@@ -28,7 +28,30 @@ module CopHelper
       file = file.path
     end
 
-    RuboCop::ProcessedSource.new(source, ruby_version, file)
+    processed_source = RuboCop::ProcessedSource.new(source, ruby_version, file)
+    processed_source.config = configuration
+    processed_source.registry = registry
+    processed_source
+  end
+
+  def configuration
+    @configuration ||= if defined?(config)
+                         config
+                       else
+                         RuboCop::Config.new({}, "#{Dir.pwd}/.rubocop.yml")
+                       end
+  end
+
+  def registry
+    @registry ||= begin
+      keys = configuration.keys
+      cops =
+        keys.map { |directive| RuboCop::Cop::Registry.global.find_cops_by_directive(directive) }
+            .flatten
+      cops << cop_class if defined?(cop_class) && !cops.include?(cop_class)
+      cops.compact!
+      RuboCop::Cop::Registry.new(cops)
+    end
   end
 
   def autocorrect_source_file(source)

data/lib/rubocop/rspec/shared_contexts.rb

@@ -2,7 +2,7 @@
 
 require 'tmpdir'
 
-RSpec.shared_context 'isolated environment' do
+RSpec.shared_context 'isolated environment' do # rubocop:disable Metrics/BlockLength
   around do |example|
     Dir.mktmpdir do |tmpdir|
       original_home = Dir.home
@@ -36,6 +36,19 @@ RSpec.shared_context 'isolated environment' do
       end
     end
   end
+
+  if RuboCop.const_defined?(:Server)
+    around do |example|
+      RuboCop::Server::Cache.cache_root_path = nil
+      RuboCop::Server::Cache.instance_variable_set(:@project_dir_cache_key, nil)
+      begin
+        example.run
+      ensure
+        RuboCop::Server::Cache.cache_root_path = nil
+        RuboCop::Server::Cache.instance_variable_set(:@project_dir_cache_key, nil)
+      end
+    end
+  end
 end
 
 RSpec.shared_context 'maintain registry' do

data/lib/rubocop/rspec/support.rb

@@ -3,10 +3,10 @@
 # Require this file to load code that supports testing using RSpec.
 
 require_relative 'cop_helper'
-require_relative 'host_environment_simulation_helper'
-require_relative 'shared_contexts'
 require_relative 'expect_offense'
+require_relative 'host_environment_simulation_helper'
 require_relative 'parallel_formatter'
+require_relative 'shared_contexts'
 
 RSpec.configure do |config|
   config.include CopHelper

data/lib/rubocop/runner.rb

@@ -423,17 +423,21 @@ module RuboCop
     end
 
     def get_processed_source(file)
-      ruby_version = @config_store.for_file(file).target_ruby_version
-
-      if @options[:stdin]
-        ProcessedSource.new(@options[:stdin], ruby_version, file)
-      else
-        begin
-          ProcessedSource.from_file(file, ruby_version)
-        rescue Errno::ENOENT
-          raise RuboCop::Error, "No such file or directory: #{file}"
-        end
-      end
+      config = @config_store.for_file(file)
+      ruby_version = config.target_ruby_version
+
+      processed_source = if @options[:stdin]
+                           ProcessedSource.new(@options[:stdin], ruby_version, file)
+                         else
+                           begin
+                             ProcessedSource.from_file(file, ruby_version)
+                           rescue Errno::ENOENT
+                             raise RuboCop::Error, "No such file or directory: #{file}"
+                           end
+                         end
+      processed_source.config = config
+      processed_source.registry = mobilized_cop_classes(config)
+      processed_source
     end
 
     # A Cop::Team instance is stateful and may change when inspecting.

data/lib/rubocop/server/cache.rb

@@ -103,9 +103,13 @@ module RuboCop
           dir.join('version')
         end
 
+        def stderr_path
+          dir.join('stderr')
+        end
+
         def pid_running?
           Process.kill(0, pid_path.read.to_i) == 1
-        rescue Errno::ESRCH
+        rescue Errno::ESRCH, Errno::ENOENT
           false
         end
 

data/lib/rubocop/server/cli.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require 'rainbow'
+require_relative '../arguments_env'
+require_relative '../arguments_file'
 
 #
 # This code is based on https://github.com/fohte/rubocop-daemon.
@@ -29,7 +31,7 @@ module RuboCop
         @exit = false
       end
 
-      # rubocop:disable Metrics/MethodLength
+      # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
       def run(argv = ARGV)
         unless Server.support_server?
           return error('RuboCop server is not supported by this Ruby.') if use_server_option?(argv)
@@ -50,11 +52,16 @@ module RuboCop
           return error("#{server_command} cannot be combined with other options.")
         end
 
+        if server_command.nil?
+          server_command = ArgumentsEnv.read_as_arguments.delete('--server') ||
+                           ArgumentsFile.read_as_arguments.delete('--server')
+        end
+
         run_command(server_command)
 
         STATUS_SUCCESS
       end
-      # rubocop:enable Metrics/MethodLength
+      # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
 
       def exit?
         @exit

data/lib/rubocop/server/client_command/exec.rb

@@ -23,6 +23,7 @@ module RuboCop
             args: ARGV.dup,
             body: $stdin.tty? ? '' : $stdin.read
           )
+          warn stderr unless stderr.empty?
           status
         end
 
@@ -43,6 +44,10 @@ module RuboCop
           RuboCop::Version::STRING != Cache.version_path.read
         end
 
+        def stderr
+          Cache.stderr_path.read
+        end
+
         def status
           unless Cache.status_path.file?
             raise "RuboCop server: Could not find status file at: #{Cache.status_path}"