Class: SyntaxTree::Undef

Inherits:
Node
  • Object
show all
Defined in:
lib/syntax_tree/node.rb

Overview

Undef represents the use of the undef keyword.

undef method

Defined Under Namespace

Classes: UndefArgumentFormatter

Instance Attribute Summary collapse

Attributes inherited from Node

#location

Instance Method Summary collapse

Methods inherited from Node

#construct_keys, #pretty_print, #to_json

Constructor Details

#initialize(symbols:, location:) ⇒ Undef

Returns a new instance of Undef.



11114
11115
11116
11117
11118
# File 'lib/syntax_tree/node.rb', line 11114

def initialize(symbols:, location:)
  @symbols = symbols
  @location = location
  @comments = []
end

Instance Attribute Details

#commentsObject (readonly)

Array[ Comment | EmbDoc ]

the comments attached to this node



11112
11113
11114
# File 'lib/syntax_tree/node.rb', line 11112

def comments
  @comments
end

#symbolsObject (readonly)

Array[ DynaSymbol | SymbolLiteral ]

the symbols to undefine



11109
11110
11111
# File 'lib/syntax_tree/node.rb', line 11109

def symbols
  @symbols
end

Instance Method Details

#===(other) ⇒ Object



11157
11158
11159
# File 'lib/syntax_tree/node.rb', line 11157

def ===(other)
  other.is_a?(Undef) && ArrayMatch.call(symbols, other.symbols)
end

#accept(visitor) ⇒ Object



11120
11121
11122
# File 'lib/syntax_tree/node.rb', line 11120

def accept(visitor)
  visitor.visit_undef(self)
end

#child_nodesObject Also known as: deconstruct



11124
11125
11126
# File 'lib/syntax_tree/node.rb', line 11124

def child_nodes
  symbols
end

#copy(symbols: nil, location: nil) ⇒ Object



11128
11129
11130
11131
11132
11133
11134
11135
11136
11137
# File 'lib/syntax_tree/node.rb', line 11128

def copy(symbols: nil, location: nil)
  node =
    Undef.new(
      symbols: symbols || self.symbols,
      location: location || self.location
    )

  node.comments.concat(comments.map(&:copy))
  node
end

#deconstruct_keys(_keys) ⇒ Object



11141
11142
11143
# File 'lib/syntax_tree/node.rb', line 11141

def deconstruct_keys(_keys)
  { symbols: symbols, location: location, comments: comments }
end

#format(q) ⇒ Object



11145
11146
11147
11148
11149
11150
11151
11152
11153
11154
11155
# File 'lib/syntax_tree/node.rb', line 11145

def format(q)
  keyword = "undef "
  formatters = symbols.map { |symbol| UndefArgumentFormatter.new(symbol) }

  q.group do
    q.text(keyword)
    q.nest(keyword.length) do
      q.seplist(formatters) { |formatter| q.format(formatter) }
    end
  end
end