rubocop 1.43.0 → 1.50.2

data/lib/rubocop/cop/style/word_array.rb

@@ -82,10 +82,19 @@ module RuboCop
           attr_accessor :largest_brackets
         end
 
+        def on_new_investigation
+          super
+
+          # Prevent O(n2) checks (checking the entire matrix once for each child array) by caching
+          @matrix_of_complex_content_cache = Hash.new do |cache, node|
+            cache[node] = matrix_of_complex_content?(node)
+          end
+        end
+
         def on_array(node)
           if bracketed_array_of?(:str, node)
             return if complex_content?(node.values)
-            return if within_2d_array_of_complex_content?(node)
+            return if within_matrix_of_complex_content?(node)
 
             check_bracketed_array(node, 'w')
           elsif node.percent_literal?(:string)
@@ -95,12 +104,15 @@ module RuboCop
 
         private
 
-        def within_2d_array_of_complex_content?(node)
+        def within_matrix_of_complex_content?(node)
           return false unless (parent = node.parent)
 
-          parent.array_type? &&
-            parent.values.all?(&:array_type?) &&
-            parent.values.any? { |subarray| complex_content?(subarray.values) }
+          parent.array_type? && @matrix_of_complex_content_cache[parent]
+        end
+
+        def matrix_of_complex_content?(array)
+          array.values.all?(&:array_type?) &&
+            array.values.any? { |subarray| complex_content?(subarray.values) }
         end
 
         def complex_content?(strings, complex_regex: word_regex)
@@ -110,7 +122,7 @@ module RuboCop
             string = s.str_content.dup.force_encoding(::Encoding::UTF_8)
             !string.valid_encoding? ||
               (complex_regex && !complex_regex.match?(string)) ||
-              / /.match?(string)
+              string.include?(' ')
           end
         end
 

data/lib/rubocop/cop/style/yoda_condition.rb

@@ -33,12 +33,14 @@ module RuboCop
       #   "bar" != foo
       #   42 >= foo
       #   10 < bar
+      #   99 == CONST
       #
       #   # good
       #   foo == 99
       #   foo == "bar"
       #   foo <= 42
       #   bar > 10
+      #   CONST == 99
       #   "#{interpolation}" == foo
       #   /#{interpolation}/ == foo
       #
@@ -92,9 +94,10 @@ module RuboCop
         def on_send(node)
           return unless yoda_compatible_condition?(node)
           return if (equality_only? && non_equality_operator?(node)) ||
-                    file_constant_equal_program_name?(node)
+                    file_constant_equal_program_name?(node) ||
+                    valid_yoda?(node)
 
-          valid_yoda?(node) || add_offense(node) do |corrector|
+          add_offense(node) do |corrector|
             corrector.replace(actual_code_range(node), corrected_code(node))
           end
         end
@@ -119,11 +122,11 @@ module RuboCop
           lhs = node.receiver
           rhs = node.first_argument
 
-          return true if (lhs.literal? && rhs.literal?) ||
-                         (!lhs.literal? && !rhs.literal?) ||
+          return true if (constant_portion?(lhs) && constant_portion?(rhs)) ||
+                         (!constant_portion?(lhs) && !constant_portion?(rhs)) ||
                          interpolation?(lhs)
 
-          enforce_yoda? ? lhs.literal? : rhs.literal?
+          enforce_yoda? ? constant_portion?(lhs) : constant_portion?(rhs)
         end
 
         def message(node)
@@ -137,8 +140,12 @@ module RuboCop
           "#{rhs.source} #{reverse_comparison(node.method_name)} #{lhs.source}"
         end
 
+        def constant_portion?(node)
+          node.literal? || node.const_type?
+        end
+
         def actual_code_range(node)
-          range_between(node.loc.expression.begin_pos, node.loc.expression.end_pos)
+          range_between(node.source_range.begin_pos, node.source_range.end_pos)
         end
 
         def reverse_comparison(operator)

data/lib/rubocop/cop/style/yoda_expression.rb

@@ -24,12 +24,14 @@ module RuboCop
       #   1 + x
       #   10 * y
       #   1 & z
+      #   1 + CONST
       #
       #   # good
       #   60 * 24
       #   x + 1
       #   y * 10
       #   z & 1
+      #   CONST + 1
       #
       #   # good
       #   1 | x
@@ -50,8 +52,7 @@ module RuboCop
 
           lhs = node.receiver
           rhs = node.first_argument
-          return if !lhs.numeric_type? || rhs.numeric_type?
-
+          return unless yoda_expression_constant?(lhs, rhs)
           return if offended_ancestor?(node)
 
           message = format(MSG, source: rhs.source)
@@ -64,6 +65,14 @@ module RuboCop
 
         private
 
+        def yoda_expression_constant?(lhs, rhs)
+          constant_portion?(lhs) && !constant_portion?(rhs)
+        end
+
+        def constant_portion?(node)
+          node.numeric_type? || node.const_type?
+        end
+
         def supported_operators
           Array(cop_config['SupportedOperators'])
         end

data/lib/rubocop/cop/style/zero_length_predicate.rb

@@ -4,10 +4,13 @@ module RuboCop
   module Cop
     module Style
       # Checks for numeric comparisons that can be replaced
-      # by a predicate method, such as receiver.length == 0,
-      # receiver.length > 0, receiver.length != 0,
-      # receiver.length < 1 and receiver.size == 0 that can be
-      # replaced by receiver.empty? and !receiver.empty?.
+      # by a predicate method, such as `receiver.length == 0`,
+      # `receiver.length > 0`, and `receiver.length != 0`,
+      # `receiver.length < 1` and `receiver.size == 0` that can be
+      # replaced by `receiver.empty?` and `!receiver.empty?`.
+      #
+      # NOTE: `File`, `Tempfile`, and `StringIO` do not have `empty?`
+      # so allow `size == 0` and `size.zero?`.
       #
       # @safety
       #   This cop is unsafe because it cannot be guaranteed that the receiver
@@ -49,6 +52,7 @@ module RuboCop
 
         def check_zero_length_predicate(node)
           return unless (length_method = zero_length_predicate(node.parent))
+          return if non_polymorphic_collection?(node.parent)
 
           offense = node.loc.selector.join(node.parent.source_range.end)
           message = format(ZERO_MSG, current: "#{length_method}.zero?")
@@ -134,7 +138,7 @@ module RuboCop
         # @!method non_polymorphic_collection?(node)
         def_node_matcher :non_polymorphic_collection?, <<~PATTERN
           {(send (send (send (const {nil? cbase} :File) :stat _) ...) ...)
-           (send (send (send (const {nil? cbase} {:Tempfile :StringIO}) {:new :open} ...) ...) ...)}
+           (send (send (send (const {nil? cbase} {:File :Tempfile :StringIO}) {:new :open} ...) ...) ...)}
         PATTERN
       end
     end

data/lib/rubocop/cop/team.rb

@@ -28,7 +28,7 @@ module RuboCop
       def self.mobilize_cops(cop_classes, config, options = {})
         cop_classes = Registry.new(cop_classes.to_a, options) unless cop_classes.is_a?(Registry)
 
-        cop_classes.enabled(config).map do |cop_class|
+        cop_classes.map do |cop_class|
           cop_class.new(config, options)
         end
       end
@@ -58,6 +58,7 @@ module RuboCop
         @options = options
         reset
         @ready = true
+        @registry = Registry.new(cops, options.dup)
 
         validate_config
       end
@@ -77,24 +78,25 @@ module RuboCop
       end
 
       # @return [Commissioner::InvestigationReport]
-      def investigate(processed_source)
+      def investigate(processed_source, offset: 0, original: processed_source)
         be_ready
 
         # The autocorrection process may have to be repeated multiple times
         # until there are no corrections left to perform
         # To speed things up, run autocorrecting cops by themselves, and only
         # run the other cops when no corrections are left
-        on_duty = roundup_relevant_cops(processed_source.file_path)
+        on_duty = roundup_relevant_cops(processed_source)
 
         autocorrect_cops, other_cops = on_duty.partition(&:autocorrect?)
+        report = investigate_partial(autocorrect_cops, processed_source,
+                                     offset: offset, original: original)
 
-        report = investigate_partial(autocorrect_cops, processed_source)
-
-        unless autocorrect(processed_source, report)
+        unless autocorrect(processed_source, report, offset: offset, original: original)
           # If we corrected some errors, another round of inspection will be
           # done, and any other offenses will be caught then, so only need
           # to check other_cops if no correction was done
-          report = report.merge(investigate_partial(other_cops, processed_source))
+          report = report.merge(investigate_partial(other_cops, processed_source,
+                                                    offset: offset, original: original))
         end
 
         process_errors(processed_source.path, report.errors)
@@ -116,12 +118,12 @@ module RuboCop
 
       private
 
-      def autocorrect(processed_source, report)
+      def autocorrect(processed_source, report, original:, offset:)
         @updated_source_file = false
         return unless autocorrect?
         return if report.processed_source.parser_error
 
-        new_source = autocorrect_report(report)
+        new_source = autocorrect_report(report, original: original, offset: offset)
 
         return unless new_source
 
@@ -129,7 +131,7 @@ module RuboCop
           # holds source read in from stdin, when --stdin option is used
           @options[:stdin] = new_source
         else
-          filename = processed_source.buffer.name
+          filename = processed_source.file_path
           File.write(filename, new_source)
         end
         @updated_source_file = true
@@ -149,17 +151,19 @@ module RuboCop
       end
 
       # @return [Commissioner::InvestigationReport]
-      def investigate_partial(cops, processed_source)
+      def investigate_partial(cops, processed_source, offset:, original:)
         commissioner = Commissioner.new(cops, self.class.forces_for(cops), @options)
-        commissioner.investigate(processed_source)
+        commissioner.investigate(processed_source, offset: offset, original: original)
       end
 
       # @return [Array<cop>]
-      def roundup_relevant_cops(filename)
-        cops.reject do |cop|
-          cop.excluded_file?(filename) ||
-            !support_target_ruby_version?(cop) ||
-            !support_target_rails_version?(cop)
+      def roundup_relevant_cops(processed_source)
+        cops.select do |cop|
+          next true if processed_source.comment_config.cop_opted_in?(cop)
+          next false if cop.excluded_file?(processed_source.file_path)
+          next false unless @registry.enabled?(cop, @config)
+
+          support_target_ruby_version?(cop) && support_target_rails_version?(cop)
         end
       end
 
@@ -175,18 +179,22 @@ module RuboCop
         cop.class.support_target_rails_version?(cop.target_rails_version)
       end
 
-      def autocorrect_report(report)
-        corrector = collate_corrections(report)
+      def autocorrect_report(report, offset:, original:)
+        corrector = collate_corrections(report, offset: offset, original: original)
 
         corrector.rewrite unless corrector.empty?
       end
 
-      def collate_corrections(report)
-        corrector = Corrector.new(report.processed_source)
+      def collate_corrections(report, offset:, original:)
+        corrector = Corrector.new(original)
 
         each_corrector(report) do |to_merge|
           suppress_clobbering do
-            corrector.merge!(to_merge)
+            if offset.positive?
+              corrector.import!(to_merge, offset: offset)
+            else
+              corrector.merge!(to_merge)
+            end
           end
         end
 

data/lib/rubocop/cop/util.rb

@@ -3,6 +3,7 @@
 module RuboCop
   module Cop
     # This module contains a collection of useful utility methods.
+    # rubocop:disable Metrics/ModuleLength
     module Util
       include PathUtil
 
@@ -80,7 +81,7 @@ module RuboCop
       end
 
       def args_end(node)
-        node.loc.expression.end
+        node.source_range.end
       end
 
       def on_node(syms, sexp, excludes = [], &block)
@@ -92,13 +93,20 @@ module RuboCop
         sexp.each_child_node { |elem| on_node(syms, elem, excludes, &block) }
       end
 
+      # Arbitrarily chosen value, should be enough to cover
+      # the most nested source code in real world projects.
+      MAX_LINE_BEGINS_REGEX_INDEX = 50
       LINE_BEGINS_REGEX_CACHE = Hash.new do |hash, index|
-        hash[index] = /^\s{#{index}}\S/
+        hash[index] = /^\s{#{index}}\S/ if index <= MAX_LINE_BEGINS_REGEX_INDEX
       end
-      private_constant :LINE_BEGINS_REGEX_CACHE
+      private_constant :MAX_LINE_BEGINS_REGEX_INDEX, :LINE_BEGINS_REGEX_CACHE
 
       def begins_its_line?(range)
-        range.source_line.match?(LINE_BEGINS_REGEX_CACHE[range.column])
+        if (regex = LINE_BEGINS_REGEX_CACHE[range.column])
+          range.source_line.match?(regex)
+        else
+          range.source_line.index(/\S/) == range.column
+        end
       end
 
       # Returns, for example, a bare `if` node if the given node is an `if`
@@ -190,5 +198,6 @@ module RuboCop
         source == target || (source.is_a?(Array) && source.include?(target))
       end
     end
+    # rubocop:enable Metrics/ModuleLength
   end
 end

data/lib/rubocop/cop/variable_force/scope.rb

@@ -45,9 +45,9 @@ module RuboCop
             node
           else
             child_index = case node.type
-                          when :module, :sclass     then 1
-                          when :def, :class, :block then 2
-                          when :defs                then 3
+                          when :module, :sclass then 1
+                          when :def, :class, :block, :numblock then 2
+                          when :defs then 3
                           end
 
             node.children[child_index]

data/lib/rubocop/cop/variable_force/variable.rb

@@ -52,7 +52,7 @@ module RuboCop
             # if/unless keyword. A preceding assignment is needed to put the
             # variable in scope. For this reason we skip to the next assignment
             # here.
-            next if in_modifier_if?(assignment)
+            next if in_modifier_conditional?(assignment)
 
             break if !assignment.branch || assignment.branch == reference.branch
 
@@ -63,10 +63,12 @@ module RuboCop
         end
         # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
-        def in_modifier_if?(assignment)
+        def in_modifier_conditional?(assignment)
           parent = assignment.node.parent
           parent = parent.parent if parent&.begin_type?
-          parent&.if_type? && parent&.modifier_form?
+          return false if parent.nil?
+
+          (parent.if_type? || parent.while_type? || parent.until_type?) && parent.modifier_form?
         end
 
         def capture_with_block!

data/lib/rubocop/cop/variable_force/variable_table.rb

@@ -97,8 +97,10 @@ module RuboCop
           scope_stack.reverse_each do |scope|
             variable = scope.variables[name]
             return variable if variable
+
             # Only block scope allows referencing outer scope variables.
-            return nil unless scope.node.block_type?
+            node = scope.node
+            return nil unless node.block_type? || node.numblock_type?
           end
 
           nil

data/lib/rubocop/cop/variable_force.rb

@@ -50,7 +50,7 @@ module RuboCop
 
       ZERO_ARITY_SUPER_TYPE = :zsuper
 
-      TWISTED_SCOPE_TYPES = %i[block class sclass defs module].freeze
+      TWISTED_SCOPE_TYPES = %i[block numblock class sclass defs module].freeze
       SCOPE_TYPES = (TWISTED_SCOPE_TYPES + [:def]).freeze
 
       SEND_TYPE = :send

data/lib/rubocop/cops_documentation_generator.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'fileutils'
+
 # Class for generating documentation of all cops departments
 # @api private
 class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
@@ -14,6 +16,8 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
     @departments = departments.map(&:to_sym).sort!
     @cops = RuboCop::Cop::Registry.global
     @config = RuboCop::ConfigLoader.default_configuration
+    @docs_path = "#{Dir.pwd}/docs/modules/ROOT/pages/"
+    FileUtils.mkdir_p(@docs_path)
   end
 
   def call
@@ -27,7 +31,7 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
 
   private
 
-  attr_reader :departments, :cops, :config
+  attr_reader :departments, :cops, :config, :docs_path
 
   def cops_of_department(department)
     cops.with_department(department).sort!
@@ -252,7 +256,7 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
     content = +"= #{department}\n"
     selected_cops.each { |cop| content << print_cop_with_doc(cop) }
     content << footer_for_department(department)
-    file_name = "#{Dir.pwd}/docs/modules/ROOT/pages/#{department_to_basename(department)}.adoc"
+    file_name = "#{docs_path}/#{department_to_basename(department)}.adoc"
     File.open(file_name, 'w') do |file|
       puts "* generated #{file_name}"
       file.write("#{content.strip}\n")
@@ -298,7 +302,10 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
   end
 
   def print_table_of_contents
-    path = "#{Dir.pwd}/docs/modules/ROOT/pages/cops.adoc"
+    path = "#{docs_path}/cops.adoc"
+
+    File.write(path, table_contents) and return unless File.exist?(path)
+
     original = File.read(path)
     content = +"// START_COP_LIST\n\n"
 

data/lib/rubocop/directive_comment.rb

@@ -45,9 +45,9 @@ module RuboCop
 
     def range
       match = comment.text.match(DIRECTIVE_COMMENT_REGEXP)
-      begin_pos = comment.loc.expression.begin_pos
+      begin_pos = comment.source_range.begin_pos
       Parser::Source::Range.new(
-        comment.loc.expression.source_buffer, begin_pos + match.begin(0), begin_pos + match.end(0)
+        comment.source_range.source_buffer, begin_pos + match.begin(0), begin_pos + match.end(0)
       )
     end
 
@@ -108,7 +108,7 @@ module RuboCop
 
     # Returns line number for directive
     def line_number
-      comment.loc.expression.line
+      comment.source_range.line
     end
 
     private

data/lib/rubocop/ext/comment.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Ext
+    # Extensions to `Parser::Source::Comment`.
+    module Comment
+      def source
+        loc.expression.source
+      end
+
+      def source_range
+        loc.expression
+      end
+    end
+  end
+end
+
+Parser::Source::Comment.include RuboCop::Ext::Comment

data/lib/rubocop/ext/regexp_node.rb

@@ -29,7 +29,7 @@ module RuboCop
           @parsed_tree&.each_expression(true) { |e| e.origin = origin }
         end
       # Please remove this `else` branch when support for regexp_parser 1.8 will be dropped.
-      # It's for compatibility with regexp_arser 1.8 and will never be maintained.
+      # It's for compatibility with regexp_parser 1.8 and will never be maintained.
       else
         def assign_properties(*)
           super

data/lib/rubocop/ext/regexp_parser.rb

@@ -28,7 +28,7 @@ module RuboCop
               @expression ||= origin.adjust(begin_pos: ts, end_pos: ts + full_length)
             end
           # Please remove this `else` branch when support for regexp_parser 1.8 will be dropped.
-          # It's for compatibility with regexp_arser 1.8 and will never be maintained.
+          # It's for compatibility with regexp_parser 1.8 and will never be maintained.
           else
             attr_accessor :source
 

data/lib/rubocop/formatter/junit_formatter.rb

@@ -62,7 +62,10 @@ module RuboCop
       end
 
       def classname_attribute_value(file)
-        file.gsub(/\.rb\Z/, '').gsub("#{Dir.pwd}/", '').tr('/', '.')
+        @classname_attribute_value_cache ||= Hash.new do |hash, key|
+          hash[key] = key.gsub(/\.rb\Z/, '').gsub("#{Dir.pwd}/", '').tr('/', '.')
+        end
+        @classname_attribute_value_cache[file]
       end
 
       def finished(_inspected_files)

data/lib/rubocop/formatter/simple_text_formatter.rb

@@ -61,7 +61,7 @@ module RuboCop
                             correctable_count,
                             rainbow,
                             # :safe_autocorrect is a derived option based on several command-line
-                            # arguments - see Rubocop::Options#add_autocorrection_options
+                            # arguments - see RuboCop::Options#add_autocorrection_options
                             safe_autocorrect: @options[:safe_autocorrect])
 
         output.puts

data/lib/rubocop/formatter.rb

@@ -2,7 +2,6 @@
 
 module RuboCop
   # The bootstrap module for formatter.
-  # @api private
   module Formatter
     require_relative 'formatter/text_util'
 

data/lib/rubocop/options.rb

@@ -61,6 +61,9 @@ module RuboCop
         add_config_generation_options(opts)
         add_additional_modes(opts)
         add_general_options(opts)
+
+        # `stackprof` is not supported on JRuby and Windows.
+        add_profile_options(opts) if RUBY_ENGINE == 'ruby' && !Platform.windows?
       end
     end
 
@@ -179,7 +182,10 @@ module RuboCop
           raise OptionArgumentError, message
         end
 
-        @options[:"#{option}"] = list.empty? ? [''] : list.split(',')
+        cop_names = list.empty? ? [''] : list.split(',')
+        cop_names.unshift('Lint/Syntax') if option == 'only' && !cop_names.include?('Lint/Syntax')
+
+        @options[:"#{option}"] = cop_names
       end
     end
 
@@ -206,6 +212,7 @@ module RuboCop
         option(opts, '--start-server')
         option(opts, '--stop-server')
         option(opts, '--server-status')
+        option(opts, '--no-detach')
       end
     end
 
@@ -233,6 +240,16 @@ module RuboCop
       end
     end
 
+    def add_profile_options(opts)
+      section(opts, 'Profiling Options') do
+        option(opts, '--profile') do
+          @options[:profile] = true
+          @options[:cache] = 'false' unless @options.key?(:cache)
+        end
+        option(opts, '--memory')
+      end
+    end
+
     def handle_deprecated_option(old_option, new_option)
       warn rainbow.wrap("#{old_option} is deprecated; use #{new_option} instead.").yellow
       @options[long_opt_symbol([new_option])] = @options.delete(long_opt_symbol([old_option]))
@@ -424,6 +441,8 @@ module RuboCop
     def invalid_arguments_for_parallel
       [('--auto-gen-config' if @options.key?(:auto_gen_config)),
        ('-F/--fail-fast'    if @options.key?(:fail_fast)),
+       ('--profile'         if @options[:profile]),
+       ('--memory'          if @options[:memory]),
        ('--cache false'     if @options > { cache: 'false' })].compact
     end
 
@@ -465,6 +484,7 @@ module RuboCop
 
   # This module contains help texts for command line options.
   # @api private
+  # rubocop:disable Metrics/ModuleLength
   module OptionsHelp
     MAX_EXCL = RuboCop::Options::DEFAULT_MAXIMUM_EXCLUSION_ITEMS.to_s
     FORMATTER_OPTION_LIST = RuboCop::Formatter::FormatterSet::BUILTIN_FORMATTERS_FOR_KEYS.keys
@@ -599,9 +619,13 @@ module RuboCop
       start_server:                     'Start server process.',
       stop_server:                      'Stop server process.',
       server_status:                    'Show server status.',
+      no_detach:                        'Run the server process in the foreground.',
       raise_cop_error:                  ['Raise cop-related errors with cause and location.',
                                          'This is used to prevent cops from failing silently.',
-                                         'Default is false.']
+                                         'Default is false.'],
+      profile:                          'Profile rubocop',
+      memory:                           'Profile rubocop memory usage'
     }.freeze
   end
+  # rubocop:enable Metrics/ModuleLength
 end

data/lib/rubocop/result_cache.rb

@@ -86,7 +86,7 @@ module RuboCop
     attr :path
 
     def initialize(file, team, options, config_store, cache_root = nil)
-      cache_root ||= options[:cache_root]
+      cache_root ||= File.join(options[:cache_root], 'rubocop_cache') if options[:cache_root]
       cache_root ||= ResultCache.cache_root(config_store)
       @allow_symlinks_in_cache_location =
         ResultCache.allow_symlinks_in_cache_location?(config_store)

data/lib/rubocop/rspec/cop_helper.rb

@@ -69,7 +69,7 @@ module CopHelper
   end
 
   def _investigate(cop, processed_source)
-    team = RuboCop::Cop::Team.new([cop], nil, raise_error: true)
+    team = RuboCop::Cop::Team.new([cop], configuration, raise_error: true)
     report = team.investigate(processed_source)
     @last_corrector = report.correctors.first || RuboCop::Cop::Corrector.new(processed_source)
     report.offenses.reject(&:disabled?)