Class: RuboCop::AST::MasgnNode
- Defined in:
- lib/rubocop/ast/node/masgn_node.rb
Overview
A node extension for ‘masgn` 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.
Constant Summary
Constants inherited from Node
Node::ARGUMENT_TYPES, Node::ASSIGNMENTS, Node::BASIC_CONDITIONALS, Node::BASIC_LITERALS, Node::COMPARISON_OPERATORS, Node::COMPOSITE_LITERALS, Node::CONDITIONALS, Node::EQUALS_ASSIGNMENTS, Node::FALSEY_LITERALS, Node::IMMUTABLE_LITERALS, Node::KEYWORDS, Node::LITERALS, Node::LOOP_TYPES, Node::MUTABLE_LITERALS, Node::OPERATOR_KEYWORDS, Node::POST_CONDITION_LOOP_TYPES, Node::REFERENCES, Node::SHORTHAND_ASSIGNMENTS, Node::SPECIAL_KEYWORDS, Node::TRUTHY_LITERALS, Node::VARIABLES
Instance Method Summary collapse
-
#assignments ⇒ Array<Node>
The assignment nodes of the multiple assignment.
-
#expression ⇒ Node
(also: #rhs)
The RHS (right hand side) of the multiple assignment.
-
#lhs ⇒ MlhsNode
The ‘mlhs` node.
-
#names ⇒ Array<Symbol>
Names of all the variables being assigned.
-
#values ⇒ Array<Node>
In contrast to ‘expression`, `values` always returns a Ruby array containing all the nodes being assigned on the RHS.
Methods inherited from Node
#ancestors, #argument?, #argument_type?, #assignment?, #assignment_or_similar?, #basic_conditional?, #basic_literal?, #boolean_type?, #call_type?, #chained?, #class_constructor?, #class_definition?, #complete!, #complete?, #conditional?, #const_name, #defined_module, #defined_module_name, #each_ancestor, #empty_source?, #equals_asgn?, #falsey_literal?, #first_line, #global_const?, #guard_clause?, #immutable_literal?, #initialize, #keyword?, #lambda?, #lambda_or_proc?, #last_line, #left_sibling, #left_siblings, #line_count, #literal?, #loop_keyword?, #match_guard_clause?, #module_definition?, #multiline?, #mutable_literal?, #nonempty_line_count, #numeric_type?, #operator_keyword?, #parent, #parent?, #parent_module_name, #parenthesized_call?, #post_condition_loop?, #proc?, #pure?, #range_type?, #receiver, #recursive_basic_literal?, #recursive_literal?, #reference?, #right_sibling, #right_siblings, #root?, #send_type?, #shorthand_asgn?, #sibling_index, #single_line?, #source, #source_length, #source_range, #special_keyword?, #str_content, #struct_constructor?, #truthy_literal?, #updated, #value_used?, #variable?
Methods included from NodePattern::Macros
#def_node_matcher, #def_node_search
Methods included from Descendence
#child_nodes, #descendants, #each_child_node, #each_descendant, #each_node
Methods included from Sexp
Constructor Details
This class inherits a constructor from RuboCop::AST::Node
Instance Method Details
#assignments ⇒ Array<Node>
Returns the assignment nodes of the multiple assignment.
16 17 18 |
# File 'lib/rubocop/ast/node/masgn_node.rb', line 16 def assignments lhs.assignments end |
#expression ⇒ Node Also known as: rhs
The RHS (right hand side) of the multiple assignment. This returns the nodes as parsed: either a single node if the RHS has a single value, or an ‘array` node containing multiple nodes.
NOTE: Due to how parsing works, ‘expression` will return the same for `a, b = x, y` and `a, b = [x, y]`.
39 40 41 |
# File 'lib/rubocop/ast/node/masgn_node.rb', line 39 def expression node_parts[1] end |
#lhs ⇒ MlhsNode
Returns the ‘mlhs` node.
10 11 12 13 |
# File 'lib/rubocop/ast/node/masgn_node.rb', line 10 def lhs # The first child is a `mlhs` node node_parts[0] end |
#names ⇒ Array<Symbol>
Returns names of all the variables being assigned.
21 22 23 24 25 26 27 28 29 |
# File 'lib/rubocop/ast/node/masgn_node.rb', line 21 def names assignments.map do |assignment| if assignment.send_type? || assignment.indexasgn_type? assignment.method_name else assignment.name end end end |
#values ⇒ Array<Node>
In contrast to ‘expression`, `values` always returns a Ruby array containing all the nodes being assigned on the RHS.
Literal arrays are considered a singular value; but unlike ‘expression`, implied `array` nodes from assigning multiple values on the RHS are treated as separate.
52 53 54 |
# File 'lib/rubocop/ast/node/masgn_node.rb', line 52 def values multiple_rhs? ? expression.children : [expression] end |