rubocop-ast 1.8.0 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c8abd574665322b04af26974900562ce6224cdccb59fc1d8926971e39f0503f
-  data.tar.gz: 87096e43215bc016c8afc66194a93dc22567960e3bfebfaa99468e8736e35b36
+  metadata.gz: fc07fcefa159e288e9bfe924e4f974841ce03bc2bd46cca4baf4ea600296b2e8
+  data.tar.gz: 7e0eaf77c2f769a2ed491c171b591e53c6e14744d197616792fc45d9b063a9f9
 SHA512:
-  metadata.gz: 6a92317d5065b2b344c0130eaf37e77a410f4e0652cc30b9724ed44f0de05173213418bf9fd990b52de44e437547e90c0c6198f237c37ad8c8f99c9f4d0f2d9a
-  data.tar.gz: 9a304655d736e46e9f2f8a2094e4f0ac5ed7bcd1aa0ad19b16ad954f3b4d170d965203b24552478505454ac1f38650a393c8a0aede4c9412c083259756bf9ea1
+  metadata.gz: 5795ea28b4acae46dfe11ccfbd596c87ef0edc9ee20d2a248979bcbbeabefdf812d7a981f9ad648879730114767019a0e894894a6154c456e39fbe0ea9562c29
+  data.tar.gz: 5395f0a9f747811636ed1f62d0aecdd43d18d2aac7d00b550a40c81a2f82feb082ad62b381265e9b803df5eef21f15fa3f10d51d3ca2b76517356d338ec94dc4

data/lib/rubocop/ast/builder.rb

@@ -20,6 +20,7 @@ module RuboCop
       # @api private
       NODE_MAP = {
         and:          AndNode,
+        and_asgn:     AndAsgnNode,
         alias:        AliasNode,
         arg:          ArgNode,
         blockarg:     ArgNode,
@@ -32,10 +33,15 @@ module RuboCop
         shadowarg:    ArgNode,
         args:         ArgsNode,
         array:        ArrayNode,
+        lvasgn:       AsgnNode,
+        ivasgn:       AsgnNode,
+        cvasgn:       AsgnNode,
+        gvasgn:       AsgnNode,
         block:        BlockNode,
         numblock:     BlockNode,
         break:        BreakNode,
         case_match:   CaseMatchNode,
+        casgn:        CasgnNode,
         case:         CaseNode,
         class:        ClassNode,
         const:        ConstNode,
@@ -60,6 +66,8 @@ module RuboCop
         lambda:       LambdaNode,
         module:       ModuleNode,
         next:         NextNode,
+        op_asgn:      OpAsgnNode,
+        or_asgn:      OrAsgnNode,
         or:           OrNode,
         pair:         PairNode,
         procarg0:     Procarg0Node,

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module AST
+    # A node extension for `op_asgn` nodes.
+    # This will be used in place of a plain node when the builder constructs
+    # the AST, making its methods available to all assignment nodes within RuboCop.
+    class AndAsgnNode < OpAsgnNode
+      # The operator being used for assignment as a symbol.
+      #
+      # @return [Symbol] the assignment operator
+      def operator
+        :'&&'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module AST
+    # A node extension for `lvasgn`, `ivasgn`, `cvasgn`, and `gvasgn` nodes.
+    # This will be used in place of a plain node when the builder constructs
+    # the AST, making its methods available to all assignment nodes within RuboCop.
+    class AsgnNode < Node
+      # The name of the variable being assigned as a symbol.
+      #
+      # @return [Symbol] the name of the variable being assigned
+      def name
+        node_parts[0]
+      end
+
+      # The expression being assigned to the variable.
+      #
+      # @return [Node] the expression being assigned.
+      def expression
+        node_parts[1]
+      end
+    end
+  end
+end

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

@@ -47,6 +47,7 @@ module RuboCop
       # Returns the else branch of the `case` statement, if any.
       #
       # @return [Node] the else branch node of the `case` statement
+      # @return [EmptyElse] the empty 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]

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module AST
+    # A node extension for `casgn` nodes.
+    # This will be used in place of a plain node when the builder constructs
+    # the AST, making its methods available to all assignment nodes within RuboCop.
+    class CasgnNode < Node
+      # The namespace of the constant being assigned.
+      #
+      # @return [Node, nil] the node associated with the scope (e.g. cbase, const, ...)
+      def namespace
+        node_parts[0]
+      end
+
+      # The name of the variable being assigned as a symbol.
+      #
+      # @return [Symbol] the name of the variable being assigned
+      def name
+        node_parts[1]
+      end
+
+      # The expression being assigned to the variable.
+      #
+      # @return [Node] the expression being assigned.
+      def expression
+        node_parts[2]
+      end
+    end
+  end
+end

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

@@ -4,8 +4,6 @@ module RuboCop
   module AST
     # A node extension for `const` nodes.
     class ConstNode < Node
-      # The `send` node associated with this block.
-      #
       # @return [Node, nil] the node associated with the scope (e.g. cbase, const, ...)
       def namespace
         children[0]
@@ -16,8 +14,6 @@ module RuboCop
         children[1]
       end
 
-      # The body of this block.
-      #
       # @return [Boolean] if the constant is a Module / Class, according to the standard convention.
       #                   Note: some classes might have uppercase in which case this method
       #                         returns false

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module AST
+    # A node extension for `op_asgn` nodes.
+    # This will be used in place of a plain node when the builder constructs
+    # the AST, making its methods available to all assignment nodes within RuboCop.
+    class OpAsgnNode < Node
+      # @return [AsgnNode] the assignment node
+      def assignment_node
+        node_parts[0]
+      end
+
+      # The name of the variable being assigned as a symbol.
+      #
+      # @return [Symbol] the name of the variable being assigned
+      def name
+        assignment_node.name
+      end
+
+      # The operator being used for assignment as a symbol.
+      #
+      # @return [Symbol] the assignment operator
+      def operator
+        node_parts[1]
+      end
+
+      # The expression being assigned to the variable.
+      #
+      # @return [Node] the expression being assigned.
+      def expression
+        node_parts.last
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module AST
+    # A node extension for `op_asgn` nodes.
+    # This will be used in place of a plain node when the builder constructs
+    # the AST, making its methods available to all assignment nodes within RuboCop.
+    class OrAsgnNode < OpAsgnNode
+      # The operator being used for assignment as a symbol.
+      #
+      # @return [Symbol] the assignment operator
+      def operator
+        :'||'
+      end
+    end
+  end
+end

data/lib/rubocop/ast/node.rb

@@ -317,7 +317,11 @@ module RuboCop
         # returns nil if answer cannot be determined
         ancestors = each_ancestor(:class, :module, :sclass, :casgn, :block)
         result    = ancestors.map do |ancestor|
-          parent_module_name_part(ancestor) { |full_name| return full_name }
+          parent_module_name_part(ancestor) do |full_name|
+            return nil unless full_name
+
+            full_name
+          end
         end.compact.reverse.join('::')
         result.empty? ? 'Object' : result
       end
@@ -503,20 +507,20 @@ module RuboCop
       # @deprecated Use `:class_constructor?`
       # @!method struct_constructor?(node = self)
       def_node_matcher :struct_constructor?, <<~PATTERN
-        (block (send #global_const?(:Struct) :new ...) _ $_)
+        ({block numblock} (send #global_const?(:Struct) :new ...) _ $_)
       PATTERN
 
       # @!method class_definition?(node = self)
       def_node_matcher :class_definition?, <<~PATTERN
         {(class _ _ $_)
          (sclass _ $_)
-         (block (send #global_const?({:Struct :Class}) :new ...) _ $_)}
+         ({block numblock} (send #global_const?({:Struct :Class}) :new ...) _ $_)}
       PATTERN
 
       # @!method module_definition?(node = self)
       def_node_matcher :module_definition?, <<~PATTERN
         {(module _ $_)
-         (block (send #global_const?(:Module) :new ...) _ $_)}
+         ({block numblock} (send #global_const?(:Module) :new ...) _ $_)}
       PATTERN
 
       # Some expressions are evaluated for their value, some for their side

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

@@ -54,7 +54,7 @@ module RuboCop
           children_nodes.sum(&:nb_captures)
         end
 
-        # @return [Boolean] returns true iff matches variable number of elements
+        # @return [Boolean] returns whether it matches a variable number of elements
         def variadic?
           arity.is_a?(Range)
         end

data/lib/rubocop/ast/node_pattern.rb

@@ -80,23 +80,23 @@ module RuboCop
         "#<#{self.class} #{pattern}>"
       end
 
-      def marshal_load(pattern) #:nodoc:
+      def marshal_load(pattern) # :nodoc:
         initialize pattern
       end
 
-      def marshal_dump #:nodoc:
+      def marshal_dump # :nodoc:
         pattern
       end
 
-      def as_json(_options = nil) #:nodoc:
+      def as_json(_options = nil) # :nodoc:
         pattern
       end
 
-      def encode_with(coder) #:nodoc:
+      def encode_with(coder) # :nodoc:
         coder['pattern'] = pattern
       end
 
-      def init_with(coder) #:nodoc:
+      def init_with(coder) # :nodoc:
         initialize(coder['pattern'])
       end
 

data/lib/rubocop/ast/processed_source.rb

@@ -177,6 +177,14 @@ module RuboCop
         sorted_tokens[last_token_index(range_or_node)]
       end
 
+      # The tokens list is always sorted by token position, except for cases when heredoc
+      # is passed as a method argument. In this case tokens are interleaved by
+      # heredoc contents' tokens.
+      def sorted_tokens
+        # Use stable sort.
+        @sorted_tokens ||= tokens.sort_by.with_index { |token, i| [token.begin_pos, i] }
+      end
+
       private
 
       def comment_index
@@ -272,14 +280,6 @@ module RuboCop
         sorted_tokens.bsearch_index { |token| token.end_pos >= end_pos }
       end
 
-      # The tokens list is always sorted by token position, except for cases when heredoc
-      # is passed as a method argument. In this case tokens are interleaved by
-      # heredoc contents' tokens.
-      def sorted_tokens
-        # Use stable sort.
-        @sorted_tokens ||= tokens.sort_by.with_index { |token, i| [token.begin_pos, i] }
-      end
-
       def source_range(range_or_node)
         if range_or_node.respond_to?(:source_range)
           range_or_node.source_range

data/lib/rubocop/ast/version.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module AST
     module Version
-      STRING = '1.8.0'
+      STRING = '1.11.0'
     end
   end
 end

data/lib/rubocop/ast.rb

@@ -39,10 +39,12 @@ require_relative 'ast/node/and_node'
 require_relative 'ast/node/arg_node'
 require_relative 'ast/node/args_node'
 require_relative 'ast/node/array_node'
+require_relative 'ast/node/asgn_node'
 require_relative 'ast/node/block_node'
 require_relative 'ast/node/break_node'
 require_relative 'ast/node/case_match_node'
 require_relative 'ast/node/case_node'
+require_relative 'ast/node/casgn_node'
 require_relative 'ast/node/class_node'
 require_relative 'ast/node/const_node'
 require_relative 'ast/node/def_node'
@@ -61,6 +63,9 @@ require_relative 'ast/node/keyword_splat_node'
 require_relative 'ast/node/lambda_node'
 require_relative 'ast/node/module_node'
 require_relative 'ast/node/next_node'
+require_relative 'ast/node/op_asgn_node'
+require_relative 'ast/node/and_asgn_node'
+require_relative 'ast/node/or_asgn_node'
 require_relative 'ast/node/or_node'
 require_relative 'ast/node/pair_node'
 require_relative 'ast/node/procarg0_node'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-ast
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.11.0
 platform: ruby
 authors:
 - Bozhidar Batsov
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-14 00:00:00.000000000 Z
+date: 2021-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -63,14 +63,17 @@ files:
 - lib/rubocop/ast/ext/range_min_max.rb
 - lib/rubocop/ast/node.rb
 - lib/rubocop/ast/node/alias_node.rb
+- lib/rubocop/ast/node/and_asgn_node.rb
 - lib/rubocop/ast/node/and_node.rb
 - lib/rubocop/ast/node/arg_node.rb
 - lib/rubocop/ast/node/args_node.rb
 - lib/rubocop/ast/node/array_node.rb
+- lib/rubocop/ast/node/asgn_node.rb
 - lib/rubocop/ast/node/block_node.rb
 - lib/rubocop/ast/node/break_node.rb
 - lib/rubocop/ast/node/case_match_node.rb
 - lib/rubocop/ast/node/case_node.rb
+- lib/rubocop/ast/node/casgn_node.rb
 - lib/rubocop/ast/node/class_node.rb
 - lib/rubocop/ast/node/const_node.rb
 - lib/rubocop/ast/node/def_node.rb
@@ -102,6 +105,8 @@ files:
 - lib/rubocop/ast/node/mixin/predicate_operator_node.rb
 - lib/rubocop/ast/node/module_node.rb
 - lib/rubocop/ast/node/next_node.rb
+- lib/rubocop/ast/node/op_asgn_node.rb
+- lib/rubocop/ast/node/or_asgn_node.rb
 - lib/rubocop/ast/node/or_node.rb
 - lib/rubocop/ast/node/pair_node.rb
 - lib/rubocop/ast/node/procarg0_node.rb