Class: RuboCop::AST::BlockNode

Inherits:
Node
  • Object
show all
Includes:
MethodIdentifierPredicates
Defined in:
lib/rubocop/ast/node/block_node.rb

Overview

A node extension for `block` nodes. This will be used in place of a plain node when the builder constructs the AST, making its methods available to all `send` nodes within RuboCop.

A `block` node is essentially a method send with a block. Parser nests the `send` node inside the `block` node.

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

Methods included from MethodIdentifierPredicates

#assignment_method?, #bang_method?, #camel_case_method?, #comparison_method?, #const_receiver?, #enumerable_method?, #enumerator_method?, #method?, #negation_method?, #nonmutating_array_method?, #nonmutating_binary_operator_method?, #nonmutating_hash_method?, #nonmutating_operator_method?, #nonmutating_string_method?, #nonmutating_unary_operator_method?, #operator_method?, #predicate_method?, #prefix_bang?, #prefix_not?, #self_receiver?

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_or_proc?, #last_line, #left_sibling, #left_siblings, #line_count, #literal?, #loop_keyword?, #match_guard_clause?, #module_definition?, #mutable_literal?, #node_parts, #nonempty_line_count, #numeric_type?, #operator_keyword?, #parent, #parent?, #parent_module_name, #parenthesized_call?, #post_condition_loop?, #proc?, #pure?, #range_type?, #receiver, #reference?, #right_sibling, #right_siblings, #root?, #shorthand_asgn?, #sibling_index, #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

#s

Constructor Details

This class inherits a constructor from RuboCop::AST::Node

Instance Method Details

#argument_listArray<Node>

Returns a collection of all descendants of this node that are argument type nodes. See `ArgsNode#argument_list` for details.

Returns:


42
43
44
45
46
47
48
# File 'lib/rubocop/ast/node/block_node.rb', line 42

def argument_list
  if numblock_type?
    numbered_arguments
  else
    arguments.argument_list
  end
end

#argumentsArray<Node>

The arguments of this block. Note that if the block has destructured arguments, `arguments` will return a `mlhs` node, whereas `argument_list` will return only actual argument nodes.

Returns:


30
31
32
33
34
35
36
# File 'lib/rubocop/ast/node/block_node.rb', line 30

def arguments
  if numblock_type?
    [].freeze # Numbered parameters have no block arguments.
  else
    node_parts[1]
  end
end

#arguments?Boolean

Checks whether this block takes any arguments.

Returns:

  • (Boolean)

    whether this `block` node takes any arguments


67
68
69
# File 'lib/rubocop/ast/node/block_node.rb', line 67

def arguments?
  !arguments.empty?
end

#bodyNode?

The body of this block.

Returns:

  • (Node, nil)

    the body of the `block` node or `nil`


53
54
55
# File 'lib/rubocop/ast/node/block_node.rb', line 53

def body
  node_parts[2]
end

#braces?Boolean

Checks whether the `block` literal is delimited by curly braces.

Returns:

  • (Boolean)

    whether the `block` literal is enclosed in braces


74
75
76
# File 'lib/rubocop/ast/node/block_node.rb', line 74

def braces?
  loc.end&.is?('}')
end

#closing_delimiterString

The closing delimiter for this `block` literal.

Returns:

  • (String)

    the closing delimiter for the `block` literal


102
103
104
# File 'lib/rubocop/ast/node/block_node.rb', line 102

def closing_delimiter
  delimiters.last
end

#delimitersArray<String>

The delimiters for this `block` literal.

Returns:

  • (Array<String>)

    the delimiters for the `block` literal


88
89
90
# File 'lib/rubocop/ast/node/block_node.rb', line 88

def delimiters
  [loc.begin.source, loc.end.source].freeze
end

#keywords?Boolean

Checks whether the `block` literal is delimited by `do`-`end` keywords.

Returns:

  • (Boolean)

    whether the `block` literal is enclosed in `do`-`end`


81
82
83
# File 'lib/rubocop/ast/node/block_node.rb', line 81

def keywords?
  loc.end&.is?('end')
end

#lambda?Boolean

Checks whether this `block` literal belongs to a lambda.

Returns:

  • (Boolean)

    whether the `block` literal belongs to a lambda


125
126
127
# File 'lib/rubocop/ast/node/block_node.rb', line 125

def lambda?
  send_node.method?(:lambda)
end

#method_nameSymbol

The name of the dispatched method as a symbol.

Returns:

  • (Symbol)

    the name of the dispatched method


60
61
62
# File 'lib/rubocop/ast/node/block_node.rb', line 60

def method_name
  send_node.method_name
end

#multiline?Boolean

Checks whether this is a multiline block. This is overridden here because the general version in `Node` does not work for `block` nodes.

Returns:

  • (Boolean)

    whether the `block` literal is on a several lines


118
119
120
# File 'lib/rubocop/ast/node/block_node.rb', line 118

def multiline?
  !single_line?
end

#opening_delimiterString

The opening delimiter for this `block` literal.

Returns:

  • (String)

    the opening delimiter for the `block` literal


95
96
97
# File 'lib/rubocop/ast/node/block_node.rb', line 95

def opening_delimiter
  delimiters.first
end

#send_nodeSendNode

The `send` node associated with this block.

Returns:

  • (SendNode)

    the `send` node associated with the `block` node


20
21
22
# File 'lib/rubocop/ast/node/block_node.rb', line 20

def send_node
  node_parts[0]
end

#single_line?Boolean

Checks whether this is a single line block. This is overridden here because the general version in `Node` does not work for `block` nodes.

Returns:

  • (Boolean)

    whether the `block` literal is on a single line


110
111
112
# File 'lib/rubocop/ast/node/block_node.rb', line 110

def single_line?
  loc.begin.line == loc.end.line
end

#void_context?Boolean

Checks whether this node body is a void context.

Returns:

  • (Boolean)

    whether the `block` node body is a void context


132
133
134
# File 'lib/rubocop/ast/node/block_node.rb', line 132

def void_context?
  VOID_CONTEXT_METHODS.include?(method_name)
end