Class: Inch::Language::Elixir::Provider::Reader::Object::Base
Abstract
- Inherits:
-
Object
- Object
- Inch::Language::Elixir::Provider::Reader::Object::Base
show all
- Defined in:
- lib/inch/language/elixir/provider/reader/object/base.rb
Overview
Instance Attribute Summary collapse
Instance Method Summary
collapse
Constructor Details
#initialize(hash) ⇒ Base
Returns a new instance of Base.
12
13
14
|
# File 'lib/inch/language/elixir/provider/reader/object/base.rb', line 12
def initialize(hash)
@hash = hash
end
|
Instance Attribute Details
#children_fullnames ⇒ Object
33
34
35
|
# File 'lib/inch/language/elixir/provider/reader/object/base.rb', line 33
def children_fullnames
@children_fullnames ||= []
end
|
Instance Method Details
#aliased_object_fullname ⇒ Object
49
50
51
|
# File 'lib/inch/language/elixir/provider/reader/object/base.rb', line 49
def aliased_object_fullname
nil
end
|
#aliases_fullnames ⇒ Object
53
54
55
|
# File 'lib/inch/language/elixir/provider/reader/object/base.rb', line 53
def aliases_fullnames
nil
end
|
#api_tag? ⇒ Boolean
45
46
47
|
# File 'lib/inch/language/elixir/provider/reader/object/base.rb', line 45
def api_tag?
nil
end
|
#attributes ⇒ Object
57
58
59
|
# File 'lib/inch/language/elixir/provider/reader/object/base.rb', line 57
def attributes
[]
end
|
#bang_name? ⇒ Boolean
61
62
63
|
# File 'lib/inch/language/elixir/provider/reader/object/base.rb', line 61
def bang_name?
false
end
|
#constant? ⇒ Boolean
65
66
67
|
# File 'lib/inch/language/elixir/provider/reader/object/base.rb', line 65
def constant?
false end
|
#constructor? ⇒ Boolean
69
70
71
|
# File 'lib/inch/language/elixir/provider/reader/object/base.rb', line 69
def constructor?
false
end
|
73
74
75
|
# File 'lib/inch/language/elixir/provider/reader/object/base.rb', line 73
def depth
fullname.split('.').size
end
|
78
79
80
|
# File 'lib/inch/language/elixir/provider/reader/object/base.rb', line 78
def docstring
@docstring ||= Docstring.new(@hash['doc'])
end
|
28
29
30
|
# File 'lib/inch/language/elixir/provider/reader/object/base.rb', line 28
def filename
nil
end
|
24
25
26
|
# File 'lib/inch/language/elixir/provider/reader/object/base.rb', line 24
def files
[]
end
|
20
21
22
|
# File 'lib/inch/language/elixir/provider/reader/object/base.rb', line 20
def fullname
fail NotImplementedError
end
|
#getter? ⇒ Boolean
82
83
84
|
# File 'lib/inch/language/elixir/provider/reader/object/base.rb', line 82
def getter?
name =~ /^get_/ end
|
#has_children? ⇒ Boolean
86
87
88
|
# File 'lib/inch/language/elixir/provider/reader/object/base.rb', line 86
def has_children?
!children_fullnames.empty?
end
|
#has_code_example? ⇒ Boolean
90
91
92
|
# File 'lib/inch/language/elixir/provider/reader/object/base.rb', line 90
def has_code_example?
docstring.code_examples.size > 0
end
|
#has_doc? ⇒ Boolean
94
95
96
|
# File 'lib/inch/language/elixir/provider/reader/object/base.rb', line 94
def has_doc?
!undocumented?
end
|
#has_multiple_code_examples? ⇒ Boolean
98
99
100
|
# File 'lib/inch/language/elixir/provider/reader/object/base.rb', line 98
def has_multiple_code_examples?
docstring.code_examples.size > 1
end
|
102
103
104
|
# File 'lib/inch/language/elixir/provider/reader/object/base.rb', line 102
def has_unconsidered_tags?
false end
|
#in_root? ⇒ Boolean
170
171
172
|
# File 'lib/inch/language/elixir/provider/reader/object/base.rb', line 170
def in_root?
depth == 1
end
|
#method? ⇒ Boolean
106
107
108
|
# File 'lib/inch/language/elixir/provider/reader/object/base.rb', line 106
def method?
false
end
|
16
17
18
|
# File 'lib/inch/language/elixir/provider/reader/object/base.rb', line 16
def name
@hash['name']
end
|
#namespace? ⇒ Boolean
114
115
116
|
# File 'lib/inch/language/elixir/provider/reader/object/base.rb', line 114
def namespace?
false
end
|
#nodoc? ⇒ Boolean
110
111
112
|
# File 'lib/inch/language/elixir/provider/reader/object/base.rb', line 110
def nodoc?
@hash['doc'] == false
end
|
#original_docstring ⇒ Object
118
119
120
|
# File 'lib/inch/language/elixir/provider/reader/object/base.rb', line 118
def original_docstring
@hash['doc']
end
|
#overridden? ⇒ Boolean
122
123
124
|
# File 'lib/inch/language/elixir/provider/reader/object/base.rb', line 122
def overridden?
false end
|
#overridden_method_fullname ⇒ Object
126
127
128
|
# File 'lib/inch/language/elixir/provider/reader/object/base.rb', line 126
def overridden_method_fullname
nil end
|
#parameters ⇒ Object
130
131
132
|
# File 'lib/inch/language/elixir/provider/reader/object/base.rb', line 130
def parameters
[]
end
|
#parent_fullname ⇒ Object
37
38
39
40
41
42
43
|
# File 'lib/inch/language/elixir/provider/reader/object/base.rb', line 37
def parent_fullname
if depth == 1
nil
else
fullname.split('.')[0...-1].join('.')
end
end
|
#private? ⇒ Boolean
134
135
136
|
# File 'lib/inch/language/elixir/provider/reader/object/base.rb', line 134
def private?
false
end
|
#protected? ⇒ Boolean
146
147
148
|
# File 'lib/inch/language/elixir/provider/reader/object/base.rb', line 146
def protected?
false
end
|
#public? ⇒ Boolean
150
151
152
|
# File 'lib/inch/language/elixir/provider/reader/object/base.rb', line 150
def public?
true
end
|
#questioning_name? ⇒ Boolean
154
155
156
|
# File 'lib/inch/language/elixir/provider/reader/object/base.rb', line 154
def questioning_name?
fullname =~ /\?$/
end
|
#return_described? ⇒ Boolean
158
159
160
|
# File 'lib/inch/language/elixir/provider/reader/object/base.rb', line 158
def return_described?
false end
|
#return_mentioned? ⇒ Boolean
162
163
164
|
# File 'lib/inch/language/elixir/provider/reader/object/base.rb', line 162
def return_mentioned?
false end
|
#return_typed? ⇒ Boolean
166
167
168
|
# File 'lib/inch/language/elixir/provider/reader/object/base.rb', line 166
def return_typed?
false end
|
#setter? ⇒ Boolean
174
175
176
|
# File 'lib/inch/language/elixir/provider/reader/object/base.rb', line 174
def setter?
name =~ /^set_/ end
|
178
179
180
|
# File 'lib/inch/language/elixir/provider/reader/object/base.rb', line 178
def source
nil
end
|
#tagged_as_internal_api? ⇒ Boolean
138
139
140
|
# File 'lib/inch/language/elixir/provider/reader/object/base.rb', line 138
def tagged_as_internal_api?
false
end
|
#tagged_as_private? ⇒ Boolean
142
143
144
|
# File 'lib/inch/language/elixir/provider/reader/object/base.rb', line 142
def tagged_as_private?
nodoc?
end
|
#unconsidered_tag_count ⇒ Object
182
183
184
|
# File 'lib/inch/language/elixir/provider/reader/object/base.rb', line 182
def unconsidered_tag_count
0
end
|
#undocumented? ⇒ Boolean
186
187
188
|
# File 'lib/inch/language/elixir/provider/reader/object/base.rb', line 186
def undocumented?
@hash['doc'].nil?
end
|
#visibility ⇒ Object
190
191
192
|
# File 'lib/inch/language/elixir/provider/reader/object/base.rb', line 190
def visibility
:public
end
|