class Prism::ParametersNode
Represents the list of parameters on a method, block, or lambda definition.
def a(b, c, d)
^^^^^^^
end
Public Class Methods
Source
# File lib/prism/node.rb, line 19486 def initialize(source, node_id, location, flags, requireds, optionals, rest, posts, keywords, keyword_rest, block) @source = source @node_id = node_id @location = location @flags = flags @requireds = requireds @optionals = optionals @rest = rest @posts = posts @keywords = keywords @keyword_rest = keyword_rest @block = block end
Initialize a new ParametersNode node.
Public Instance Methods
Source
# File lib/prism/node.rb, line 19634 def block @block end
Returns the block attribute.
Source
# File lib/prism/node.rb, line 19626 def keyword_rest @keyword_rest end
Returns the keyword_rest attribute.
Source
# File lib/prism/node.rb, line 19618 def keywords @keywords end
Returns the keywords attribute.
Source
# File lib/prism/node.rb, line 19594 def optionals @optionals end
Returns the optionals attribute.
Source
# File lib/prism/node.rb, line 19610 def posts @posts end
Returns the posts attribute.
Source
# File lib/prism/node.rb, line 19586 def requireds @requireds end
Returns the requireds attribute.
Source
# File lib/prism/node.rb, line 19602 def rest @rest end
Returns the rest attribute.
Source
# File lib/prism/node_ext.rb, line 272 def signature names = [] #: Array[[Symbol, Symbol] | [Symbol]] requireds.each do |param| names << (param.is_a?(MultiTargetNode) ? [:req] : [:req, param.name]) end optionals.each { |param| names << [:opt, param.name] } if rest && rest.is_a?(RestParameterNode) names << [:rest, rest.name || :*] end posts.each do |param| case param when MultiTargetNode names << [:req] when NoKeywordsParameterNode, KeywordRestParameterNode, NoBlockParameterNode, BlockParameterNode, ForwardingParameterNode # Invalid syntax, e.g. "def f(**nil, ...)" moves the NoKeywordsParameterNode to posts raise "Invalid syntax" else names << [:req, param.name] end end # Regardless of the order in which the keywords were defined, the required # keywords always come first followed by the optional keywords. keyopt = [] #: Array[OptionalKeywordParameterNode] keywords.each do |param| if param.is_a?(OptionalKeywordParameterNode) keyopt << param else names << [:keyreq, param.name] end end keyopt.each { |param| names << [:key, param.name] } case keyword_rest when ForwardingParameterNode names.concat([[:rest, :*], [:keyrest, :**], [:block, :&]]) when KeywordRestParameterNode names << [:keyrest, keyword_rest.name || :**] when NoKeywordsParameterNode names << [:nokey] end case block when BlockParameterNode names << [:block, block.name || :&] when NoBlockParameterNode names << [:noblock] end names end
Mirrors the Method#parameters method.
Node Interface
Public Class Methods
Public Instance Methods
Source
# File lib/prism/node.rb, line 19512 def accept(visitor) visitor.visit_parameters_node(self) end
See Node.accept.
Source
# File lib/prism/node.rb, line 19517 def child_nodes [*requireds, *optionals, rest, *posts, *keywords, keyword_rest, block] end
See Node.child_nodes.
Also aliased as: deconstruct
Source
# File lib/prism/node.rb, line 19548 def comment_targets [*requireds, *optionals, *rest, *posts, *keywords, *keyword_rest, *block] #: Array[Prism::node | Location] end
See Node.comment_targets.
Source
# File lib/prism/node.rb, line 19535 def compact_child_nodes compact = [] #: Array[Prism::node] compact.concat(requireds) compact.concat(optionals) compact << rest if rest compact.concat(posts) compact.concat(keywords) compact << keyword_rest if keyword_rest compact << block if block compact end
Source
# File lib/prism/node.rb, line 19556 def copy(node_id: self.node_id, location: self.location, flags: self.flags, requireds: self.requireds, optionals: self.optionals, rest: self.rest, posts: self.posts, keywords: self.keywords, keyword_rest: self.keyword_rest, block: self.block) ParametersNode.new(source, node_id, location, flags, requireds, optionals, rest, posts, keywords, keyword_rest, block) end
Creates a copy of self with the given fields, using self as the template.
Source
# File lib/prism/node.rb, line 19522 def each_child_node return to_enum(:each_child_node) unless block_given? requireds.each { |node| yield node } optionals.each { |node| yield node } yield rest if rest posts.each { |node| yield node } keywords.each { |node| yield node } yield keyword_rest if keyword_rest yield block if block end
See Node.each_child_node.