Class: RuboCop::AST::ConstNode

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

Overview

A node extension for `const` nodes.

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 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

#absolute?Boolean

Returns if the constant starts with `::` (aka s(:cbase)).

Returns:

  • (Boolean)

    if the constant starts with `::` (aka s(:cbase))


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

def absolute?
  return false unless namespace

  each_path.first.cbase_type?
end

#each_path(&block) ⇒ Object

Yield nodes for the namespace

For `::Foo::Bar::BAZ` => yields:
   s(:cbase), then
   s(:const, :Foo), then
   s(:const, s(:const, :Foo), :Bar)

47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
# File 'lib/rubocop/ast/node/const_node.rb', line 47

def each_path(&block)
  return to_enum(__method__) unless block

  descendants = []
  last = self
  loop do
    last = last.children.first
    break if last.nil?

    descendants << last
    break unless last.const_type?
  end
  descendants.reverse_each(&block)

  self
end

#module_name?Boolean Also known as: class_name?

The body of this block.

Returns:

  • (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
    

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

def module_name?
  short_name.match?(/[[:lower:]]/)
end

#namespaceNode?

The `send` node associated with this block.

Returns:

  • (Node, nil)

    the node associated with the scope (e.g. cbase, const, …)


10
11
12
# File 'lib/rubocop/ast/node/const_node.rb', line 10

def namespace
  children[0]
end

#relative?Boolean

Returns if the constant does not start with `::` (aka s(:cbase)).

Returns:

  • (Boolean)

    if the constant does not start with `::` (aka s(:cbase))


37
38
39
# File 'lib/rubocop/ast/node/const_node.rb', line 37

def relative?
  !absolute?
end

#short_nameSymbol

Returns the demodulized name of the constant: “::Foo::Bar” => :Bar.

Returns:

  • (Symbol)

    the demodulized name of the constant: “::Foo::Bar” => :Bar


15
16
17
# File 'lib/rubocop/ast/node/const_node.rb', line 15

def short_name
  children[1]
end