Class: RuboCop::AST::BlockNode

Inherits:
Node
  • Object
show all
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 collapse

VOID_CONTEXT_METHODS =
%i[each tap].freeze

Constants inherited from Node

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::MUTABLE_LITERALS, Node::OPERATOR_KEYWORDS, Node::REFERENCES, Node::SHORTHAND_ASSIGNMENTS, Node::SPECIAL_KEYWORDS, Node::TRUTHY_LITERALS, Node::VARIABLES

Instance Method Summary collapse

Methods inherited from Node

#ancestors, #argument?, #assignment?, #basic_conditional?, #basic_literal?, #boolean_type?, #call_type?, #chained?, #child_nodes, #complete!, #complete?, #conditional?, #const_name, #defined_module, #defined_module_name, #descendants, #each_ancestor, #each_child_node, #each_descendant, #each_node, #empty_source?, #equals_asgn?, #falsey_literal?, #first_line, #immutable_literal?, #initialize, #keyword?, #last_line, #line_count, #literal?, #mutable_literal?, #node_parts, #nonempty_line_count, #numeric_type?, #operator_keyword?, #parent, #parent_module_name, #parenthesized_call?, #pure?, #range_type?, #receiver, #reference?, #shorthand_asgn?, #sibling_index, #source, #source_length, #source_range, #special_keyword?, #truthy_literal?, #updated, #value_used?, #variable?

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search, #node_search_all, #node_search_body, #node_search_first

Methods included from Sexp

#s

Constructor Details

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

Instance Method Details

#argumentsArray<Node>

The arguments of this block.

Returns:


24
25
26
# File 'lib/rubocop/ast/node/block_node.rb', line 24

def arguments
  node_parts[1]
end

#arguments?Boolean

Checks whether this block takes any arguments.

Returns:

  • (Boolean)

    whether this `block` node takes any arguments


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

def arguments?
  !arguments.empty?
end

#bodyNode?

The body of this block.

Returns:

  • (Node, nil)

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


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

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


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

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

#closing_delimiterString

The closing delimiter for this `block` literal.

Returns:

  • (String)

    the closing delimiter for the `block` literal


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

def closing_delimiter
  delimiters.last
end

#delimitersArray<String>

The delimiters for this `block` literal.

Returns:

  • (Array<String>)

    the delimiters for the `block` literal


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

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`


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

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


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

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


38
39
40
# File 'lib/rubocop/ast/node/block_node.rb', line 38

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


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

def multiline?
  !single_line?
end

#opening_delimiterString

The opening delimiter for this `block` literal.

Returns:

  • (String)

    the opening delimiter for the `block` literal


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

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


17
18
19
# File 'lib/rubocop/ast/node/block_node.rb', line 17

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


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

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


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

def void_context?
  VOID_CONTEXT_METHODS.include?(method_name)
end