rubocop 0.76.0 → 0.83.0

data/lib/rubocop/ast/builder.rb

@@ -15,48 +15,51 @@ module RuboCop
     #   root_node = parser.parse(buffer)
     class Builder < Parser::Builders::Default
       NODE_MAP = {
-        and:        AndNode,
-        alias:      AliasNode,
-        args:       ArgsNode,
-        array:      ArrayNode,
-        block:      BlockNode,
-        break:      BreakNode,
-        case:       CaseNode,
-        class:      ClassNode,
-        def:        DefNode,
-        defined?:   DefinedNode,
-        defs:       DefNode,
-        ensure:     EnsureNode,
-        for:        ForNode,
-        float:      FloatNode,
-        hash:       HashNode,
-        if:         IfNode,
-        int:        IntNode,
-        irange:     RangeNode,
-        erange:     RangeNode,
-        kwsplat:    KeywordSplatNode,
-        module:     ModuleNode,
-        or:         OrNode,
-        pair:       PairNode,
-        regexp:     RegexpNode,
-        resbody:    ResbodyNode,
-        retry:      RetryNode,
-        return:     ReturnNode,
-        csend:      SendNode,
-        send:       SendNode,
-        str:        StrNode,
-        dstr:       StrNode,
-        xstr:       StrNode,
-        sclass:     SelfClassNode,
-        super:      SuperNode,
-        zsuper:     SuperNode,
-        sym:        SymbolNode,
-        until:      UntilNode,
-        until_post: UntilNode,
-        when:       WhenNode,
-        while:      WhileNode,
-        while_post: WhileNode,
-        yield:      YieldNode
+        and:          AndNode,
+        alias:        AliasNode,
+        args:         ArgsNode,
+        array:        ArrayNode,
+        block:        BlockNode,
+        numblock:     BlockNode,
+        break:        BreakNode,
+        case_match:   CaseMatchNode,
+        case:         CaseNode,
+        class:        ClassNode,
+        def:          DefNode,
+        defined?:     DefinedNode,
+        defs:         DefNode,
+        ensure:       EnsureNode,
+        for:          ForNode,
+        forward_args: ForwardArgsNode,
+        float:        FloatNode,
+        hash:         HashNode,
+        if:           IfNode,
+        int:          IntNode,
+        irange:       RangeNode,
+        erange:       RangeNode,
+        kwsplat:      KeywordSplatNode,
+        module:       ModuleNode,
+        or:           OrNode,
+        pair:         PairNode,
+        regexp:       RegexpNode,
+        resbody:      ResbodyNode,
+        retry:        RetryNode,
+        return:       ReturnNode,
+        csend:        SendNode,
+        send:         SendNode,
+        str:          StrNode,
+        dstr:         StrNode,
+        xstr:         StrNode,
+        sclass:       SelfClassNode,
+        super:        SuperNode,
+        zsuper:       SuperNode,
+        sym:          SymbolNode,
+        until:        UntilNode,
+        until_post:   UntilNode,
+        when:         WhenNode,
+        while:        WhileNode,
+        while_post:   WhileNode,
+        yield:        YieldNode
       }.freeze
 
       # Generates {Node} from the given information.

data/lib/rubocop/ast/node/array_node.rb

@@ -18,6 +18,19 @@ module RuboCop
         each_child_node.to_a
       end
 
+      # Calls the given block for all values in the `array` literal.
+      #
+      # @yieldparam [Node] node each node
+      # @return [self] if a block is given
+      # @return [Enumerator] if no block is given
+      def each_value(&block)
+        return to_enum(__method__) unless block_given?
+
+        values.each(&block)
+
+        self
+      end
+
       # Checks whether the `array` literal is delimited by square brackets.
       #
       # @return [Boolean] whether the array is enclosed in square brackets

data/lib/rubocop/ast/node/block_node.rb

@@ -9,6 +9,8 @@ module RuboCop
     # A `block` node is essentially a method send with a block. Parser nests
     # the `send` node inside the `block` node.
     class BlockNode < Node
+      include MethodIdentifierPredicates
+
       VOID_CONTEXT_METHODS = %i[each tap].freeze
 
       # The `send` node associated with this block.
@@ -22,7 +24,11 @@ module RuboCop
       #
       # @return [Array<Node>]
       def arguments
-        node_parts[1]
+        if numblock_type?
+          [] # Numbered parameters have no block arguments.
+        else
+          node_parts[1]
+        end
       end
 
       # The body of this block.

data/lib/rubocop/ast/node/case_match_node.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module AST
+    # A node extension for `case_match` nodes. This will be used in place of
+    # a plain node when the builder constructs the AST, making its methods
+    # available to all `case_match` nodes within RuboCop.
+    class CaseMatchNode < Node
+      include ConditionalNode
+
+      # Returns the keyword of the `case` statement as a string.
+      #
+      # @return [String] the keyword of the `case` statement
+      def keyword
+        'case'
+      end
+
+      # Calls the given block for each `in_pattern` node in the `in` statement.
+      # If no block is given, an `Enumerator` is returned.
+      #
+      # @return [self] if a block is given
+      # @return [Enumerator] if no block is given
+      def each_in_pattern
+        return in_pattern_branches.to_enum(__method__) unless block_given?
+
+        in_pattern_branches.each do |condition|
+          yield condition
+        end
+
+        self
+      end
+
+      # Returns an array of all the when branches in the `case` statement.
+      #
+      # @return [Array<Node>] an array of `in_pattern` nodes
+      def in_pattern_branches
+        node_parts[1...-1]
+      end
+
+      # Returns the else branch of the `case` statement, if any.
+      #
+      # @return [Node] the else branch node of the `case` statement
+      # @return [nil] if the case statement does not have an else branch.
+      def else_branch
+        node_parts[-1]
+      end
+
+      # Checks whether this case statement has an `else` branch.
+      #
+      # @return [Boolean] whether the `case` statement has an `else` branch
+      def else?
+        !loc.else.nil?
+      end
+    end
+  end
+end

data/lib/rubocop/ast/node/def_node.rb

@@ -16,6 +16,17 @@ module RuboCop
         method?(:initialize) || assignment_method?
       end
 
+      # Checks whether this method definition node forwards its arguments
+      # as per the feature added in Ruby 2.7.
+      #
+      # @note This is written in a way that may support lead arguments
+      #       which are rumored to be added in a later version of Ruby.
+      #
+      # @return [Boolean] whether the `def` node uses argument forwarding
+      def argument_forwarding?
+        arguments.any?(&:forward_args_type?)
+      end
+
       # The name of the defined method as a symbol.
       #
       # @return [Symbol] the name of the defined method

data/lib/rubocop/ast/node/forward_args_node.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module AST
+    # A node extension for `forward-args` nodes. This will be used in place
+    # of a plain node when the builder constructs the AST, making its methods
+    # available to all `forward-args` nodes within RuboCop.
+    class ForwardArgsNode < Node
+      include CollectionNode
+
+      # Node wraps itself in an array to be compatible with other
+      # enumerable argument types.
+      def to_a
+        [self]
+      end
+    end
+  end
+end

data/lib/rubocop/ast/node/mixin/method_dispatch_node.rb

@@ -121,6 +121,14 @@ module RuboCop
         loc.respond_to?(:dot) && loc.dot && loc.dot.is?('::')
       end
 
+      # Checks whether the dispatched method uses a safe navigation operator to
+      # connect the receiver and the method name.
+      #
+      # @return [Boolean] whether the method was called with a connecting dot
+      def safe_navigation?
+        loc.respond_to?(:dot) && loc.dot && loc.dot.is?('&.')
+      end
+
       # Checks whether the *explicit* receiver of this method dispatch is
       # `self`.
       #

data/lib/rubocop/ast/node/regexp_node.rb

@@ -21,14 +21,12 @@ module RuboCop
 
       # @return [RuboCop::AST::Node] a regopt node
       def regopt
-        first, second = *self
-        first.regopt_type? ? first : second
+        children.last
       end
 
       # @return [String] a string of regexp content
       def content
-        str = children.first
-        str.str_content || ''
+        children.select(&:str_type?).map(&:str_content).join
       end
     end
   end

data/lib/rubocop/ast/node/send_node.rb

@@ -8,6 +8,10 @@ module RuboCop
     class SendNode < Node
       include ParameterizedNode
       include MethodDispatchNode
+
+      def_node_matcher :attribute_accessor?, <<~PATTERN
+        (send nil? ${:attr_reader :attr_writer :attr_accessor :attr} $...)
+      PATTERN
     end
   end
 end

data/lib/rubocop/ast/node.rb

@@ -98,7 +98,7 @@ module RuboCop
         @mutable_attributes.frozen?
       end
 
-      protected :parent= # rubocop:disable Style/AccessModifierDeclarations
+      protected :parent=
 
       # Override `AST::Node#updated` so that `AST::Processor` does not try to
       # mutate our ASTs. Since we keep references from children to parents and
@@ -116,7 +116,7 @@ module RuboCop
       #
       # @return [Integer] the index of the receiver node in its siblings
       def sibling_index
-        parent.children.index { |sibling| sibling.equal?(self) }
+        parent&.children&.index { |sibling| sibling.equal?(self) }
       end
 
       # Common destructuring method. This can be used to normalize
@@ -141,9 +141,6 @@ module RuboCop
       #   Yield only nodes matching any of the types.
       #   @param [Symbol] type_a a node type
       #   @param [Symbol] type_b a node type
-      # @overload each_ancestor(types)
-      #   Yield only nodes matching any of types in the array.
-      #   @param [Array<Symbol>] types an array containing node types
       # @yieldparam [Node] node each ancestor node
       # @return [self] if a block is given
       # @return [Enumerator] if no block is given
@@ -178,9 +175,6 @@ module RuboCop
       #   Yield only nodes matching any of the types.
       #   @param [Symbol] type_a a node type
       #   @param [Symbol] type_b a node type
-      # @overload each_child_node(types)
-      #   Yield only nodes matching any of types in the array.
-      #   @param [Array<Symbol>] types an array containing node types
       # @yieldparam [Node] node each child node
       # @return [self] if a block is given
       # @return [Enumerator] if no block is given
@@ -216,9 +210,6 @@ module RuboCop
       #   Yield only nodes matching any of the types.
       #   @param [Symbol] type_a a node type
       #   @param [Symbol] type_b a node type
-      # @overload each_descendant(types)
-      #   Yield only nodes matching any of types in the array.
-      #   @param [Array<Symbol>] types an array containing node types
       # @yieldparam [Node] node each descendant node
       # @return [self] if a block is given
       # @return [Enumerator] if no block is given
@@ -254,9 +245,6 @@ module RuboCop
       #   Yield only nodes matching any of the types.
       #   @param [Symbol] type_a a node type
       #   @param [Symbol] type_b a node type
-      # @overload each_node(types)
-      #   Yield only nodes matching any of types in the array.
-      #   @param [Array<Symbol>] types an array containing node types
       # @yieldparam [Node] node each node
       # @return [self] if a block is given
       # @return [Enumerator] if no block is given
@@ -303,7 +291,7 @@ module RuboCop
       ## Destructuring
 
       def_node_matcher :receiver, <<~PATTERN
-        {(send $_ ...) (block (send $_ ...) ...)}
+        {(send $_ ...) ({block numblock} (send $_ ...) ...)}
       PATTERN
 
       def_node_matcher :str_content, '(str $_)'
@@ -325,9 +313,8 @@ module RuboCop
          (casgn $_ $_        (send (const nil? {:Class :Module}) :new ...))
          (casgn $_ $_ (block (send (const nil? {:Class :Module}) :new ...) ...))}
       PATTERN
-      # rubocop:disable Style/AccessModifierDeclarations
+
       private :defined_module0
-      # rubocop:enable Style/AccessModifierDeclarations
 
       def defined_module
         namespace, name = *defined_module0
@@ -481,7 +468,13 @@ module RuboCop
         irange_type? || erange_type?
       end
 
-      def_node_matcher :guard_clause?, <<~PATTERN
+      def guard_clause?
+        node = and_type? || or_type? ? rhs : self
+
+        node.match_guard_clause?
+      end
+
+      def_node_matcher :match_guard_clause?, <<~PATTERN
         [${(send nil? {:raise :fail} ...) return break next} single_line?]
       PATTERN
 
@@ -491,7 +484,7 @@ module RuboCop
          (send (const nil? :Proc) :new)}
       PATTERN
 
-      def_node_matcher :lambda?, '(block (send nil? :lambda) ...)'
+      def_node_matcher :lambda?, '({block numblock} (send nil? :lambda) ...)'
       def_node_matcher :lambda_or_proc?, '{lambda? proc?}'
 
       def_node_matcher :class_constructor?, <<~PATTERN
@@ -624,7 +617,7 @@ module RuboCop
       end
 
       def parent_module_name_for_block(ancestor)
-        if ancestor.method_name == :class_eval
+        if ancestor.method?(:class_eval)
           # `class_eval` with no receiver applies to whatever module or class
           # we are currently in
           return unless (receiver = ancestor.receiver)

data/lib/rubocop/ast/traversal.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+# rubocop:disable Metrics/ModuleLength
 module RuboCop
   module AST
     # Provides methods for traversing an AST.
@@ -18,15 +19,21 @@ module RuboCop
                              rational str sym regopt self lvar
                              ivar cvar gvar nth_ref back_ref cbase
                              arg restarg blockarg shadowarg
-                             kwrestarg zsuper lambda redo retry].freeze
+                             kwrestarg zsuper lambda redo retry
+                             forward_args forwarded_args
+                             match_var match_nil_pattern empty_else].freeze
       ONE_CHILD_NODE    = %i[splat kwsplat block_pass not break next
                              preexe postexe match_current_line defined?
-                             arg_expr].freeze
+                             arg_expr pin match_rest if_guard unless_guard
+                             match_with_trailing_comma].freeze
       MANY_CHILD_NODES  = %i[dstr dsym xstr regexp array hash pair
                              mlhs masgn or_asgn and_asgn
                              undef alias args super yield or and
                              while_post until_post iflipflop eflipflop
-                             match_with_lvasgn begin kwbegin return].freeze
+                             match_with_lvasgn begin kwbegin return
+                             in_match match_alt
+                             match_as array_pattern array_pattern_with_tail
+                             hash_pattern const_pattern].freeze
       SECOND_CHILD_ONLY = %i[lvasgn ivasgn cvasgn gvasgn optarg kwarg
                              kwoptarg].freeze
 
@@ -171,13 +178,25 @@ module RuboCop
         nil
       end
 
-      alias on_rescue  on_case
-      alias on_resbody on_case
-      alias on_ensure  on_case
-      alias on_for     on_case
-      alias on_when    on_case
-      alias on_irange  on_case
-      alias on_erange  on_case
+      alias on_rescue     on_case
+      alias on_resbody    on_case
+      alias on_ensure     on_case
+      alias on_for        on_case
+      alias on_when       on_case
+      alias on_case_match on_case
+      alias on_in_pattern on_case
+      alias on_irange     on_case
+      alias on_erange     on_case
+
+      def on_numblock(node)
+        children = node.children
+        child = children[0]
+        send(:"on_#{child.type}", child)
+        return unless (child = children[2])
+
+        send(:"on_#{child.type}", child)
+      end
     end
   end
 end
+# rubocop:enable Metrics/ModuleLength

data/lib/rubocop/cli/command/auto_genenerate_config.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+module RuboCop
+  class CLI
+    module Command
+      # Generate a configuration file acting as a TODO list.
+      class AutoGenerateConfig < Base
+        self.command_name = :auto_gen_config
+
+        PHASE_1 = 'Phase 1 of 2: run Layout/LineLength cop'
+        PHASE_2 = 'Phase 2 of 2: run all cops'
+
+        PHASE_1_OVERRIDDEN =
+          '(skipped because the default Layout/LineLength:Max is overridden)'
+        PHASE_1_DISABLED =
+          '(skipped because Layout/LineLength is disabled)'
+
+        def run
+          add_formatter
+          reset_config_and_auto_gen_file
+          line_length_contents = maybe_run_line_length_cop
+          run_all_cops(line_length_contents)
+        end
+
+        private
+
+        def maybe_run_line_length_cop
+          if !line_length_enabled?(@config_store.for(Dir.pwd))
+            skip_line_length_cop(PHASE_1_DISABLED)
+          elsif !same_max_line_length?(
+            @config_store.for(Dir.pwd), ConfigLoader.default_configuration
+          )
+            skip_line_length_cop(PHASE_1_OVERRIDDEN)
+          else
+            run_line_length_cop
+          end
+        end
+
+        def skip_line_length_cop(reason)
+          puts Rainbow("#{PHASE_1} #{reason}").yellow
+          ''
+        end
+
+        def line_length_enabled?(config)
+          line_length_cop(config)['Enabled']
+        end
+
+        def same_max_line_length?(config1, config2)
+          max_line_length(config1) == max_line_length(config2)
+        end
+
+        def max_line_length(config)
+          line_length_cop(config)['Max']
+        end
+
+        def line_length_cop(config)
+          config.for_cop('Layout/LineLength')
+        end
+
+        # Do an initial run with only Layout/LineLength so that cops that
+        # depend on Layout/LineLength:Max get the correct value for that
+        # parameter.
+        def run_line_length_cop
+          puts Rainbow(PHASE_1).yellow
+          @options[:only] = ['Layout/LineLength']
+          execute_runner
+          @options.delete(:only)
+          @config_store = ConfigStore.new
+          # Save the todo configuration of the LineLength cop.
+          IO.read(ConfigLoader::AUTO_GENERATED_FILE)
+            .lines
+            .drop_while { |line| line.start_with?('#') }
+            .join
+        end
+
+        def run_all_cops(line_length_contents)
+          puts Rainbow(PHASE_2).yellow
+          result = execute_runner
+          # This run was made with the current maximum length allowed, so append
+          # the saved setting for LineLength.
+          File.open(ConfigLoader::AUTO_GENERATED_FILE, 'a') do |f|
+            f.write(line_length_contents)
+          end
+          result
+        end
+
+        def reset_config_and_auto_gen_file
+          @config_store = ConfigStore.new
+          @config_store.options_config = @options[:config] if @options[:config]
+          File.open(ConfigLoader::AUTO_GENERATED_FILE, 'w') {}
+          ConfigLoader.add_inheritance_from_auto_generated_file
+        end
+
+        def add_formatter
+          @options[:formatters] << [Formatter::DisabledConfigFormatter,
+                                    ConfigLoader::AUTO_GENERATED_FILE]
+        end
+
+        def execute_runner
+          Environment.new(@options, @config_store, @paths).run(:execute_runner)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cli/command/base.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module RuboCop
+  class CLI
+    module Command
+      # A subcommand in the CLI.
+      class Base
+        attr_reader :env
+
+        @subclasses = []
+
+        class << self
+          attr_accessor :command_name
+
+          def inherited(subclass)
+            @subclasses << subclass
+          end
+
+          def by_command_name(name)
+            @subclasses.detect { |s| s.command_name == name }
+          end
+        end
+
+        def initialize(env)
+          @env = env
+          @options = env.options
+          @config_store = env.config_store
+          @paths = env.paths
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cli/command/execute_runner.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module RuboCop
+  class CLI
+    module Command
+      # Run all the selected cops and report the result.
+      class ExecuteRunner < Base
+        include Formatter::TextUtil
+
+        self.command_name = :execute_runner
+
+        def run
+          execute_runner(@paths)
+        end
+
+        private
+
+        def execute_runner(paths)
+          runner = Runner.new(@options, @config_store)
+
+          all_passed = runner.run(paths)
+          display_warning_summary(runner.warnings)
+          display_error_summary(runner.errors)
+          maybe_print_corrected_source
+
+          all_pass_or_excluded = all_passed || @options[:auto_gen_config]
+
+          if runner.aborting?
+            STATUS_INTERRUPTED
+          elsif all_pass_or_excluded && runner.errors.empty?
+            STATUS_SUCCESS
+          else
+            STATUS_OFFENSES
+          end
+        end
+
+        def display_warning_summary(warnings)
+          return if warnings.empty?
+
+          warn Rainbow("\n#{pluralize(warnings.size, 'warning')}:").yellow
+
+          warnings.each { |warning| warn warning }
+        end
+
+        def display_error_summary(errors)
+          return if errors.empty?
+
+          warn Rainbow("\n#{pluralize(errors.size, 'error')} occurred:").red
+
+          errors.each { |error| warn error }
+
+          warn <<~WARNING
+            Errors are usually caused by RuboCop bugs.
+            Please, report your problems to RuboCop's issue tracker.
+            #{Gem.loaded_specs['rubocop'].metadata['bug_tracker_uri']}
+
+            Mention the following information in the issue report:
+            #{RuboCop::Version.version(true)}
+          WARNING
+        end
+
+        def maybe_print_corrected_source
+          # If we are asked to autocorrect source code read from stdin, the only
+          # reasonable place to write it is to stdout
+          # Unfortunately, we also write other information to stdout
+          # So a delimiter is needed for tools to easily identify where the
+          # autocorrected source begins
+          return unless @options[:stdin] && @options[:auto_correct]
+
+          puts '=' * 20
+          print @options[:stdin]
+        end
+      end
+    end
+  end
+end