Class: RuboCop::AST::PairNode

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

Overview

A node extension for `pair` nodes. This will be used in place of a plain node when the builder constructs the AST, making its methods available to all `pair` 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

Methods included from HashElementNode

#delimiter_delta, #key, #key_delta, #same_line?, #value, #value_delta

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?, #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, #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

#s

Constructor Details

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

Instance Method Details

#colon?Boolean

Checks whether the `pair` uses a colon delimiter.

Returns:

  • (Boolean)

    whether this `pair` uses a colon delimiter


30
31
32
# File 'lib/rubocop/ast/node/pair_node.rb', line 30

def colon?
  loc.operator.is?(COLON)
end

#delimiter(*deprecated, with_spacing: deprecated.first) ⇒ String

Returns the delimiter of the `pair` as a string. Returns `=>` for a colon delimited `pair` and `:` for a hash rocket delimited `pair`.

Parameters:

  • with_spacing (Boolean) (defaults to: deprecated.first)

    whether to include spacing

Returns:

  • (String)

    the delimiter of the `pair`


39
40
41
42
43
44
45
# File 'lib/rubocop/ast/node/pair_node.rb', line 39

def delimiter(*deprecated, with_spacing: deprecated.first)
  if with_spacing
    hash_rocket? ? SPACED_HASH_ROCKET : SPACED_COLON
  else
    hash_rocket? ? HASH_ROCKET : COLON
  end
end

#hash_rocket?Boolean

Checks whether the `pair` uses a hash rocket delimiter.

Returns:

  • (Boolean)

    whether this `pair` uses a hash rocket delimiter


23
24
25
# File 'lib/rubocop/ast/node/pair_node.rb', line 23

def hash_rocket?
  loc.operator.is?(HASH_ROCKET)
end

#inverse_delimiter(*deprecated, with_spacing: deprecated.first) ⇒ String

Returns the inverse delimiter of the `pair` as a string.

Parameters:

  • with_spacing (Boolean) (defaults to: deprecated.first)

    whether to include spacing

Returns:

  • (String)

    the inverse delimiter of the `pair`


51
52
53
54
55
56
57
# File 'lib/rubocop/ast/node/pair_node.rb', line 51

def inverse_delimiter(*deprecated, with_spacing: deprecated.first)
  if with_spacing
    hash_rocket? ? SPACED_COLON : SPACED_HASH_ROCKET
  else
    hash_rocket? ? COLON : HASH_ROCKET
  end
end

#value_on_new_line?Boolean

Checks whether the value starts on its own line.

Returns:

  • (Boolean)

    whether the value in the `pair` starts its own line


62
63
64
# File 'lib/rubocop/ast/node/pair_node.rb', line 62

def value_on_new_line?
  key.loc.line != value.loc.line
end