class Prism::ClassNode - Documentation for Ruby 4.0
Description: class Prism::ClassNode: Represents a class declaration involving the `class` keyword.
Keywords: ruby,class,Prism::ClassNode

🔍

No recent searches

# class Prism::ClassNode

Represents a class declaration involving the `class` keyword.

    class Foo end
    ^^^^^^^^^^^^^

### Attributes

body [R]

Represents the body of the class.

    class Foo
      foo
      ^^^

constant_path [R]

attr_reader `constant_path`: `ConstantReadNode` | `ConstantPathNode` | `CallNode`

locals [R]

attr_reader locals: Array

name [R]

The name of the class.

    class Foo end # name `:Foo`

superclass [R]

Represents the superclass of the class.

    class Foo < Bar
                ^^^

### Public Class Methods

new (source, node_id, location, flags, locals, class_keyword_loc, constant_path, inheritance_operator_loc, superclass, body, end_keyword_loc, name)
Source

    # File lib/prism/node.rb, line 4060
    def initialize(source, node_id, location, flags, locals, class_keyword_loc, constant_path, inheritance_operator_loc, superclass, body, end_keyword_loc, name)
      @source = source
      @node_id = node_id
      @location = location
      @flags = flags
      @locals = locals
      @class_keyword_loc = class_keyword_loc
      @constant_path = constant_path
      @inheritance_operator_loc = inheritance_operator_loc
      @superclass = superclass
      @body = body
      @end_keyword_loc = end_keyword_loc
      @name = name
    end

Initialize a new `ClassNode` node.

type ()
Source

    # File lib/prism/node.rb, line 4225
    def self.type
      :class_node
    end

Return a symbol representation of this node type. See `Node::type`.

### Public Instance Methods

=== (other)
Source

    # File lib/prism/node.rb, line 4231
    def ===(other)
      other.is_a?(ClassNode) &&
        (locals.length == other.locals.length) &&
        locals.zip(other.locals).all? { |left, right| left === right } &&
        (class_keyword_loc.nil? == other.class_keyword_loc.nil?) &&
        (constant_path === other.constant_path) &&
        (inheritance_operator_loc.nil? == other.inheritance_operator_loc.nil?) &&
        (superclass === other.superclass) &&
        (body === other.body) &&
        (end_keyword_loc.nil? == other.end_keyword_loc.nil?) &&
        (name === other.name)
    end

Implements case-equality for the node. This is effectively == but without comparing the value of locations. Locations are checked only for presence.

accept (visitor)
Source

    # File lib/prism/node.rb, line 4076
    def accept(visitor)
      visitor.visit_class_node(self)
    end

def accept: (`Visitor` visitor) -> void

child_nodes ()
Source

    # File lib/prism/node.rb, line 4081
    def child_nodes
      [constant_path, superclass, body]
    end

def `child_nodes`: () -> Array

Also aliased as: deconstruct
class_keyword ()
Source

    # File lib/prism/node.rb, line 4200
    def class_keyword
      class_keyword_loc.slice
    end

def `class_keyword`: () -> `String`

class_keyword_loc ()
Source

    # File lib/prism/node.rb, line 4128
    def class_keyword_loc
      location = @class_keyword_loc
      return location if location.is_a?(Location)
      @class_keyword_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
    end

Represents the location of the `class` keyword.

    class Foo end
    ^^^^^

comment_targets ()
Source

    # File lib/prism/node.rb, line 4104
    def comment_targets
      [class_keyword_loc, constant_path, *inheritance_operator_loc, *superclass, *body, end_keyword_loc] #: Array[Prism::node | Location]
    end

def `comment_targets`: () -> Array[Node | Location]

compact_child_nodes ()
Source

    # File lib/prism/node.rb, line 4095
    def compact_child_nodes
      compact = [] #: Array[Prism::node]
      compact << constant_path
      compact << superclass if superclass
      compact << body if body
      compact
    end

def `compact_child_nodes`: () -> Array

copy (node_id: self.node_id, location: self.location, flags: self.flags, locals: self.locals, class_keyword_loc: self.class_keyword_loc, constant_path: self.constant_path, inheritance_operator_loc: self.inheritance_operator_loc, superclass: self.superclass, body: self.body, end_keyword_loc: self.end_keyword_loc, name: self.name)
Source

    # File lib/prism/node.rb, line 4109
    def copy(node_id: self.node_id, location: self.location, flags: self.flags, locals: self.locals, class_keyword_loc: self.class_keyword_loc, constant_path: self.constant_path, inheritance_operator_loc: self.inheritance_operator_loc, superclass: self.superclass, body: self.body, end_keyword_loc: self.end_keyword_loc, name: self.name)
      ClassNode.new(source, node_id, location, flags, locals, class_keyword_loc, constant_path, inheritance_operator_loc, superclass, body, end_keyword_loc, name)
    end

def copy: (?node_id: `Integer`, ?location: `Location`, ?flags: `Integer`, ?locals: Array, ?class_keyword_loc: `Location`, ?constant_path: `ConstantReadNode` | `ConstantPathNode` | `CallNode`, ?inheritance_operator_loc: `Location`?, ?superclass: Prism::node?, ?body: `StatementsNode` | `BeginNode` | nil, ?end_keyword_loc: `Location`, ?name: `Symbol`) -> `ClassNode`

deconstruct ()

def deconstruct: () -> Array

Alias for: child_nodes
deconstruct_keys (keys)
Source

    # File lib/prism/node.rb, line 4117
    def deconstruct_keys(keys)
      { node_id: node_id, location: location, locals: locals, class_keyword_loc: class_keyword_loc, constant_path: constant_path, inheritance_operator_loc: inheritance_operator_loc, superclass: superclass, body: body, end_keyword_loc: end_keyword_loc, name: name }
    end

def `deconstruct_keys`: (Array keys) -> { node_id: `Integer`, location: `Location`, locals: Array, `class_keyword_loc`: `Location`, `constant_path`: `ConstantReadNode` | `ConstantPathNode` | `CallNode`, `inheritance_operator_loc`: `Location`?, superclass: Prism::node?, body: `StatementsNode` | `BeginNode` | nil, `end_keyword_loc`: `Location`, name: `Symbol` }

each_child_node () { |constant_path| ... }
Source

    # File lib/prism/node.rb, line 4086
    def each_child_node
      return to_enum(:each_child_node) unless block_given?

      yield constant_path
      yield superclass if superclass
      yield body if body
    end

def `each_child_node`: () { (Prism::node) -> void } -> void | () -> Enumerator

end_keyword ()
Source

    # File lib/prism/node.rb, line 4210
    def end_keyword
      end_keyword_loc.slice
    end

def `end_keyword`: () -> `String`

end_keyword_loc ()
Source

    # File lib/prism/node.rb, line 4182
    def end_keyword_loc
      location = @end_keyword_loc
      return location if location.is_a?(Location)
      @end_keyword_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
    end

Represents the location of the `end` keyword.

    class Foo end
              ^^^

inheritance_operator ()
Source

    # File lib/prism/node.rb, line 4205
    def inheritance_operator
      inheritance_operator_loc&.slice
    end

def `inheritance_operator`: () -> `String`?

inheritance_operator_loc ()
Source

    # File lib/prism/node.rb, line 4147
    def inheritance_operator_loc
      location = @inheritance_operator_loc
      case location
      when nil
        nil
      when Location
        location
      else
        @inheritance_operator_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
      end
    end

Represents the location of the `<` operator.

    class Foo < Bar
              ^

inspect ()
Source

    # File lib/prism/node.rb, line 4215
    def inspect
      InspectVisitor.compose(self)
    end

def inspect -> `String`

save_class_keyword_loc (repository)
Source

    # File lib/prism/node.rb, line 4136
    def save_class_keyword_loc(repository)
      repository.enter(node_id, :class_keyword_loc)
    end

Save the `class_keyword_loc` location using the given saved source so that it can be retrieved later.

save_end_keyword_loc (repository)
Source

    # File lib/prism/node.rb, line 4190
    def save_end_keyword_loc(repository)
      repository.enter(node_id, :end_keyword_loc)
    end

Save the `end_keyword_loc` location using the given saved source so that it can be retrieved later.

save_inheritance_operator_loc (repository)
Source

    # File lib/prism/node.rb, line 4161
    def save_inheritance_operator_loc(repository)
      repository.enter(node_id, :inheritance_operator_loc) unless @inheritance_operator_loc.nil?
    end

Save the `inheritance_operator_loc` location using the given saved source so that it can be retrieved later.

type ()
Source

    # File lib/prism/node.rb, line 4220
    def type
      :class_node
    end

Return a symbol representation of this node type. See `Node#type`.