Class: Solargraph::Convention::StructDefinition::StructDefintionNode

Inherits:
Object
  • Object
show all
Defined in:
lib/solargraph/convention/struct_definition/struct_definition_node.rb

Overview

A node wrapper for a Struct definition via inheritance.

Examples:

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

Direct Known Subclasses

StructAssignmentNode

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(node) ⇒ StructDefintionNode

Returns a new instance of StructDefintionNode.

Parameters:

  • node (Parser::AST::Node) 


52
53
54
 
# File 'lib/solargraph/convention/struct_definition/struct_definition_node.rb', line 52

def initialize(node)
  @node = node
end

Class Method Details

.match?(node) ⇒ Boolean

Examples:

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)))

Parameters:

  • node (Parser::AST::Node)

Returns:

  • (Boolean) 


30
31
32
33
34
 
# 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

Instance Method Details

#attributes ⇒ Array<Array(Parser::AST::Node, String)>

Returns:

  • (Array<Array(Parser::AST::Node, String)>) 


62
63
64
65
66
67
 
# 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

#body_node ⇒ Parser::AST::Node

Returns:

  • (Parser::AST::Node) 


81
82
83
 
# File 'lib/solargraph/convention/struct_definition/struct_definition_node.rb', line 81

def body_node
  node.children[2]
end

#class_name ⇒ String

Returns:

  • (String) 


57
58
59
 
# File 'lib/solargraph/convention/struct_definition/struct_definition_node.rb', line 57

def class_name
  Parser::NodeMethods.unpack_name(node)
end

#keyword_init? ⇒ Boolean

Returns:

  • (Boolean) 


69
70
71
72
73
74
75
76
77
78
 
# 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