Class: Prism::ModuleNode

Inherits:
PrismNode
  • Object
show all
Defined in:
lib/prism/node.rb,
ext/prism/api_node.c

Overview

Represents a module declaration involving the ‘module` keyword.

module Foo end
^^^^^^^^^^^^^^

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(locals, module_keyword_loc, constant_path, body, end_keyword_loc, name, location) ⇒ ModuleNode

def initialize: (locals: Array, module_keyword_loc: Location, constant_path: Node, body: Node?, end_keyword_loc: Location, name: Symbol, location: Location) -> void



9902
9903
9904
9905
9906
9907
9908
9909
9910
 
# File 'lib/prism/node.rb', line 9902

def initialize(locals, module_keyword_loc, constant_path, body, end_keyword_loc, name, location)
  @locals = locals
  @module_keyword_loc = module_keyword_loc
  @constant_path = constant_path
  @body = body
  @end_keyword_loc = end_keyword_loc
  @name = name
  @location = location
end

Instance Attribute Details

#body ⇒ Object (readonly)

attr_reader body: Node?



9893
9894
9895
 
# File 'lib/prism/node.rb', line 9893

def body
  @body
end

#constant_path ⇒ Object (readonly)

attr_reader constant_path: Node



9890
9891
9892
 
# File 'lib/prism/node.rb', line 9890

def constant_path
  @constant_path
end

#end_keyword_loc ⇒ Object (readonly)

attr_reader end_keyword_loc: Location



9896
9897
9898
 
# File 'lib/prism/node.rb', line 9896

def end_keyword_loc
  @end_keyword_loc
end

#locals ⇒ Object (readonly)

attr_reader locals: Array



9884
9885
9886
 
# File 'lib/prism/node.rb', line 9884

def locals
  @locals
end

#module_keyword_loc ⇒ Object (readonly)

attr_reader module_keyword_loc: Location



9887
9888
9889
 
# File 'lib/prism/node.rb', line 9887

def module_keyword_loc
  @module_keyword_loc
end

#name ⇒ Object (readonly)

attr_reader name: Symbol



9899
9900
9901
 
# File 'lib/prism/node.rb', line 9899

def name
  @name
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



9913
9914
9915
 
# File 'lib/prism/node.rb', line 9913

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

#child_nodes ⇒ Object Also known as: deconstruct

def child_nodes: () -> Array[nil | Node]



9918
9919
9920
 
# File 'lib/prism/node.rb', line 9918

def child_nodes
  [constant_path, body]
end

#comment_targets ⇒ Object

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



9931
9932
9933
 
# File 'lib/prism/node.rb', line 9931

def comment_targets
  [module_keyword_loc, constant_path, *body, end_keyword_loc]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



9923
9924
9925
9926
9927
9928
 
# File 'lib/prism/node.rb', line 9923

def compact_child_nodes
  compact = []
  compact << constant_path
  compact << body if body
  compact
end

#copy(**params) ⇒ Object

def copy: (**params) -> ModuleNode



9936
9937
9938
9939
9940
9941
9942
9943
9944
9945
9946
 
# File 'lib/prism/node.rb', line 9936

def copy(**params)
  ModuleNode.new(
    params.fetch(:locals) { locals },
    params.fetch(:module_keyword_loc) { module_keyword_loc },
    params.fetch(:constant_path) { constant_path },
    params.fetch(:body) { body },
    params.fetch(:end_keyword_loc) { end_keyword_loc },
    params.fetch(:name) { name },
    params.fetch(:location) { location },
  )
end

#deconstruct_keys(keys) ⇒ Object

def deconstruct_keys: (keys: Array) -> Hash[Symbol, nil | Node | Array | String | Token | Array | Location]



9952
9953
9954
 
# File 'lib/prism/node.rb', line 9952

def deconstruct_keys(keys)
  { locals: locals, module_keyword_loc: module_keyword_loc, constant_path: constant_path, body: body, end_keyword_loc: end_keyword_loc, name: name, location: location }
end

#end_keyword ⇒ Object

def end_keyword: () -> String



9962
9963
9964
 
# File 'lib/prism/node.rb', line 9962

def end_keyword
  end_keyword_loc.slice
end

#inspect(inspector = NodeInspector.new) ⇒ Object 



9966
9967
9968
9969
9970
9971
9972
9973
9974
9975
9976
9977
9978
9979
9980
9981
 
# File 'lib/prism/node.rb', line 9966

def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  inspector << "├── locals: #{locals.inspect}\n"
  inspector << "├── module_keyword_loc: #{inspector.location(module_keyword_loc)}\n"
  inspector << "├── constant_path:\n"
  inspector << inspector.child_node(constant_path, "│   ")
  if (body = self.body).nil?
    inspector << "├── body: ∅\n"
  else
    inspector << "├── body:\n"
    inspector << body.inspect(inspector.child_inspector("│   ")).delete_prefix(inspector.prefix)
  end
  inspector << "├── end_keyword_loc: #{inspector.location(end_keyword_loc)}\n"
  inspector << "└── name: #{name.inspect}\n"
  inspector.to_str
end

#module_keyword ⇒ Object

def module_keyword: () -> String



9957
9958
9959
 
# File 'lib/prism/node.rb', line 9957

def module_keyword
  module_keyword_loc.slice
end

#type ⇒ Object

Sometimes you want to check an instance of a node against a list of classes to see what kind of behavior to perform. Usually this is done by calling ‘[cls1, cls2].include?(node.class)` or putting the node into a case statement and doing `case node; when cls1; when cls2; end`. Both of these approaches are relatively slow because of the constant lookups, method calls, and/or array allocations.

Instead, you can call #type, which will return to you a symbol that you can use for comparison. This is faster than the other approaches because it uses a single integer comparison, but also because if you’re on CRuby you can take advantage of the fact that case statements with all symbol keys will use a jump table.

def type: () -> Symbol



9997
9998
9999
 
# File 'lib/prism/node.rb', line 9997

def type
  :module_node
end