Class: Solargraph::Pin::Base

Inherits:
Object
  • Object
show all
Defined in:
lib/solargraph/pin/base.rb

Direct Known Subclasses

Attribute, BaseVariable, Method, Plugin::Method, Symbol

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(source, node, namespace) ⇒ Base

Returns a new instance of Base.



13
14
15
16
17
 
# File 'lib/solargraph/pin/base.rb', line 13

def initialize source, node, namespace
  @source = source
  @node = node
  @namespace = namespace
end

Instance Attribute Details

#namespace ⇒ String (readonly)

Returns:

  • (String) 


11
12
13
 
# File 'lib/solargraph/pin/base.rb', line 11

def namespace
  @namespace
end

#node ⇒ Parser::AST::Node (readonly)

Returns:

  • (Parser::AST::Node) 


8
9
10
 
# File 'lib/solargraph/pin/base.rb', line 8

def node
  @node
end

#source ⇒ Solargraph::ApiMap::Source (readonly)

Returns:



5
6
7
 
# File 'lib/solargraph/pin/base.rb', line 5

def source
  @source
end

Instance Method Details

#docstring ⇒ YARD::Docstring

Returns:

  • (YARD::Docstring) 


20
21
22
 
# File 'lib/solargraph/pin/base.rb', line 20

def docstring
  @docstring ||= source.docstring_for(node)
end

#filename ⇒ String

Returns:

  • (String) 


60
61
62
 
# File 'lib/solargraph/pin/base.rb', line 60

def filename
  source.filename
end

#kind ⇒ String

Returns:

  • (String) 


35
36
37
 
# File 'lib/solargraph/pin/base.rb', line 35

def kind
  nil
end

#location ⇒ Object 



64
65
66
 
# File 'lib/solargraph/pin/base.rb', line 64

def location
  "#{source.filename}:#{node.location.expression.begin_pos}"
end

#name ⇒ String

Returns:

  • (String) 


25
26
27
 
# File 'lib/solargraph/pin/base.rb', line 25

def name
  nil
end

#parameters ⇒ Array<String>

Returns:

  • (Array<String>) 


55
56
57
 
# File 'lib/solargraph/pin/base.rb', line 55

def parameters
  []
end

#path ⇒ String

Returns:

  • (String) 


30
31
32
 
# File 'lib/solargraph/pin/base.rb', line 30

def path
  nil
end

#return_type ⇒ String

Returns:

  • (String) 


40
41
42
 
# File 'lib/solargraph/pin/base.rb', line 40

def return_type
  nil
end

#signature ⇒ String

Returns:

  • (String) 


45
46
47
 
# File 'lib/solargraph/pin/base.rb', line 45

def signature
  nil
end

#value ⇒ String

Returns:

  • (String) 


50
51
52
 
# File 'lib/solargraph/pin/base.rb', line 50

def value
  nil
end