class Solargraph::Convention::StructDefinition::StructDefintionNode

A node wrapper for a Struct definition via inheritance. @example

class MyStruct < Struct.new(:bar, :baz)
  def foo
  end
end

Attributes

node [R]

@return [Parser::AST::Node]

Public Class Methods

match? (node)

Source

# File lib/solargraph/convention/struct_definition/struct_definition_node.rb, line 30
def match?(node)
  return false unless node&.type == :class

  struct_definition_node?(node.children[1])
end

@example

s(:class,
  s(:const, nil, :Foo),
  s(:send,
    s(:const, nil, :Struct), :new,
    s(:sym, :bar),
    s(:sym, :baz)),
    s(:hash,
      s(:pair,
        s(:sym, :keyword_init),
        s(:true)))),
  s(:def, :foo,
    s(:args),
    s(:send, nil, :bar)))

@param node [Parser::AST::Node]

new (node)

Source

# File lib/solargraph/convention/struct_definition/struct_definition_node.rb, line 52
def initialize(node)
  @node = node
end

@param node [Parser::AST::Node]

Private Class Methods

struct_definition_node? (struct_node)

Source

# File lib/solargraph/convention/struct_definition/struct_definition_node.rb, line 40
def struct_definition_node?(struct_node)
  return false unless struct_node.is_a?(::Parser::AST::Node)
  return false unless struct_node&.type == :send
  return false unless struct_node.children[0]&.type == :const
  return false unless struct_node.children[0].children[1] == :Struct
  return false unless struct_node.children[1] == :new

  true
end

@param struct_node [Parser::AST::Node] @return [Boolean]

Public Instance Methods

attributes ()

Source

# File lib/solargraph/convention/struct_definition/struct_definition_node.rb, line 62
def attributes
  struct_attribute_nodes.map do |struct_def_param|
    next unless struct_def_param.type == :sym
    [struct_def_param, struct_def_param.children[0].to_s]
  end.compact
end

@return [Array<Array(Parser::AST::Node, String)>]

body_node ()

Source

# File lib/solargraph/convention/struct_definition/struct_definition_node.rb, line 81
def body_node
  node.children[2]
end

@return [Parser::AST::Node]

class_name ()

Source

# File lib/solargraph/convention/struct_definition/struct_definition_node.rb, line 57
def class_name
  Parser::NodeMethods.unpack_name(node)
end

@return [String]

keyword_init? ()

Source

# File lib/solargraph/convention/struct_definition/struct_definition_node.rb, line 69
def keyword_init?
  keyword_init_param = struct_attribute_nodes.find do |struct_def_param|
    struct_def_param.type == :hash && struct_def_param.children[0].type == :pair &&
      struct_def_param.children[0].children[0].children[0] == :keyword_init
  end

  return false if keyword_init_param.nil?

  keyword_init_param.children[0].children[1].type == :true
end

Private Instance Methods

struct_attribute_nodes ()

Source

# File lib/solargraph/convention/struct_definition/struct_definition_node.rb, line 96
def struct_attribute_nodes
  struct_node.children[2..-1]
end

@return [Array<Parser::AST::Node>]

struct_node ()

Source

# File lib/solargraph/convention/struct_definition/struct_definition_node.rb, line 91
def struct_node
  node.children[1]
end

@return [Parser::AST::Node]