Class: Inch::CodeObject::Provider::YARD::Object::Base Abstract

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Includes:
NodocHelper
Defined in:
lib/inch/code_object/provider/yard/object/base.rb

Overview

This class is abstract.

Defined Under Namespace

Classes: CodeLocation

Constant Summary collapse

CONSIDERED_YARD_TAGS =

Tags considered by wrapper methods like #has_code_example?

%w(api example param private return since)
AUTO_GENERATED_TAG_NAMES =
%w(raise yield)
RUBY_CORE =
%w(
  Array Bignum BasicObject Object Module Class Complex NilClass
  Numeric String Float Fiber FiberError Continuation Dir File
  Encoding Enumerator StopIteration Enumerator::Generator
  Enumerator::Yielder Exception SystemExit SignalException Interrupt
  StandardError TypeError ArgumentError IndexError KeyError
  RangeError ScriptError SyntaxError LoadError NotImplementedError
  NameError NoMethodError RuntimeError SecurityError NoMemoryError
  EncodingError SystemCallError Encoding::CompatibilityError
  File::Stat IO Hash ENV IOError EOFError ARGF RubyVM
  RubyVM::InstructionSequence Math::DomainError ZeroDivisionError
  FloatDomainError Integer Fixnum Data TrueClass FalseClass Mutex
  Thread Proc LocalJumpError SystemStackError Method UnboundMethod
  Binding Process::Status Random Range Rational RegexpError Regexp
  MatchData Symbol Struct ThreadGroup ThreadError Time
  Encoding::UndefinedConversionError
  Encoding::InvalidByteSequenceError
  Encoding::ConverterNotFoundError Encoding::Converter RubyVM::Env

  Comparable Kernel File::Constants Enumerable Errno FileTest GC
  ObjectSpace GC::Profiler IO::WaitReadable IO::WaitWritable Marshal
  Math Process Process::UID Process::GID Process::Sys Signal
)

Constants included from NodocHelper

NodocHelper::DOC_REGEX, NodocHelper::NO_DOC_ALL_REGEX, NodocHelper::NO_DOC_REGEX

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from NodocHelper

#declarations, #explicit_doc_comment?, #explicit_nodoc_all_comment?, #explicit_nodoc_comment?, #get_line_no, #implicit_nodoc_all_comment?, #implicit_nodoc_comment?, #nodoc?, #nodoc_comment?

Constructor Details

#initialize(object) ⇒ Base

Returns a new instance of Base.

Parameters:

  • object (YARD::CodeObjects::Base)

    the actual (YARD) code object



30
31
32
33
34
35
# File 'lib/inch/code_object/provider/yard/object/base.rb', line 30

def initialize(object)
  @object = object
  @api_tag = __api_tag
  @parent = __parent
  @private_tag = __private_tag
end

Instance Attribute Details

#aliased_object_fullnameObject

Returns the fullname of the object that the current object is an alias for



39
40
41
# File 'lib/inch/code_object/provider/yard/object/base.rb', line 39

def aliased_object_fullname
  @aliased_object_fullname
end

#api_tagObject (readonly)

Returns the value of attribute api_tag.



51
52
53
# File 'lib/inch/code_object/provider/yard/object/base.rb', line 51

def api_tag
  @api_tag
end

#base_dirString

Returns the codebase’s directory.

Returns:

  • (String)

    the codebase’s directory



17
18
19
# File 'lib/inch/code_object/provider/yard/object/base.rb', line 17

def base_dir
  @base_dir
end

#objectYARD::CodeObjects::Base (readonly)

Returns the actual (YARD) code object.

Returns:

  • (YARD::CodeObjects::Base)

    the actual (YARD) code object



14
15
16
# File 'lib/inch/code_object/provider/yard/object/base.rb', line 14

def object
  @object
end

#parentArray? (readonly)

Returns the parent of the current object or nil.

Returns:

  • (Array, nil)

    the parent of the current object or nil



214
215
216
# File 'lib/inch/code_object/provider/yard/object/base.rb', line 214

def parent
  @parent
end

Instance Method Details

#__parentObject



216
217
218
# File 'lib/inch/code_object/provider/yard/object/base.rb', line 216

def __parent
  YARD::Object.for(object.parent) if object.parent
end

#aliases_fullnamesObject

Returns the fullnames of the objects that are aliases for the current object



43
44
45
# File 'lib/inch/code_object/provider/yard/object/base.rb', line 43

def aliases_fullnames
  []
end

#api_tag?Boolean

Returns:

  • (Boolean)


47
48
49
# File 'lib/inch/code_object/provider/yard/object/base.rb', line 47

def api_tag?
  !api_tag.nil?
end

#child(_name) ⇒ CodeObject::Proxy::Base?

To be overridden

Returns:

See Also:



57
58
59
# File 'lib/inch/code_object/provider/yard/object/base.rb', line 57

def child(_name)
  nil
end

#childrenObject

To be overridden



69
70
71
# File 'lib/inch/code_object/provider/yard/object/base.rb', line 69

def children
  []
end

#children_fullnamesArray?

Returns the full names of the children of the current object.

Returns:

  • (Array, nil)

    the full names of the children of the current object



63
64
65
# File 'lib/inch/code_object/provider/yard/object/base.rb', line 63

def children_fullnames
  []
end

#core?Boolean

Returns:

  • (Boolean)


96
97
98
# File 'lib/inch/code_object/provider/yard/object/base.rb', line 96

def core?
  RUBY_CORE.include?(name.to_s)
end

#depthFixnum

Note:

top-level counts, that’s why Foo has depth 1!

The depth of the following is 4:

Foo::Bar::Baz#initialize
 ^    ^    ^      ^
 1 << 2 << 3  <<  4

depth answers the question “how many layers of code objects are above this one?”

Returns:

  • (Fixnum)

    the depth of the object in terms of namespace



190
191
192
# File 'lib/inch/code_object/provider/yard/object/base.rb', line 190

def depth
  @__depth ||= __depth
end

#docstringDocstring

Returns:



101
102
103
# File 'lib/inch/code_object/provider/yard/object/base.rb', line 101

def docstring
  @docstring ||= Docstring.new(object.docstring)
end

#filenameString

Returns the name of the file where the object is declared first

Returns:

  • (String)

    a filename



129
130
131
132
133
# File 'lib/inch/code_object/provider/yard/object/base.rb', line 129

def filename
  # just checking the first file (which is the file where an object
  # is first declared)
  files.first && files.first.filename
end

#filesArray<CodeLocation>

Returns all files declaring the object in the form of an Array of Arrays containing the location of their declaration.

Returns:



109
110
111
112
113
114
115
116
117
# File 'lib/inch/code_object/provider/yard/object/base.rb', line 109

def files
  object.files.map do |(filename, line_no)|
    CodeLocation.new(base_dir, filename, line_no)
  end
rescue ::YARD::CodeObjects::ProxyMethodError
  # this error is raised by YARD
  # see broken.rb in test fixtures
  []
end

#fullnameObject



135
136
137
# File 'lib/inch/code_object/provider/yard/object/base.rb', line 135

def fullname
  @fullname ||= object.path
end

#has_children?Boolean

Returns:

  • (Boolean)


143
144
145
# File 'lib/inch/code_object/provider/yard/object/base.rb', line 143

def has_children?
  !children.empty?
end

#has_code_example?Boolean

Returns:

  • (Boolean)


147
148
149
150
# File 'lib/inch/code_object/provider/yard/object/base.rb', line 147

def has_code_example?
  !tags(:example).empty? ||
    docstring.contains_code_example?
end

#has_doc?Boolean

Returns:

  • (Boolean)


152
153
154
# File 'lib/inch/code_object/provider/yard/object/base.rb', line 152

def has_doc?
  !docstring.empty?
end

#has_multiple_code_examples?Boolean

Returns:

  • (Boolean)


156
157
158
159
160
161
162
163
164
165
166
167
168
# File 'lib/inch/code_object/provider/yard/object/base.rb', line 156

def has_multiple_code_examples?
  if tags(:example).size > 1 || docstring.code_examples.size > 1
    true
  else
    if (tag = tag(:example))
      multi_code_examples?(tag.text)
    elsif (text = docstring.code_examples.first)
      multi_code_examples?(text)
    else
      false
    end
  end
end

#has_unconsidered_tags?Boolean

Returns:

  • (Boolean)


170
171
172
# File 'lib/inch/code_object/provider/yard/object/base.rb', line 170

def has_unconsidered_tags?
  !unconsidered_tags.empty?
end

#in_in_root?Boolean

Returns:

  • (Boolean)


174
175
176
# File 'lib/inch/code_object/provider/yard/object/base.rb', line 174

def in_in_root?
  depth == 1
end

#in_root?Boolean

Returns:

  • (Boolean)


240
241
242
# File 'lib/inch/code_object/provider/yard/object/base.rb', line 240

def in_root?
  depth == 1
end

#inspectObject



253
254
255
# File 'lib/inch/code_object/provider/yard/object/base.rb', line 253

def inspect
  "#<#{self.class}: #{fullname}>"
end

#method?Boolean

Returns true if the object represents a method.

Returns:

  • (Boolean)

    true if the object represents a method



195
196
197
# File 'lib/inch/code_object/provider/yard/object/base.rb', line 195

def method?
  false
end

#nameObject



139
140
141
# File 'lib/inch/code_object/provider/yard/object/base.rb', line 139

def name
  @name ||= object.name
end

#namespace?Boolean

Returns true if the object represents a namespace.

Returns:

  • (Boolean)

    true if the object represents a namespace



200
201
202
# File 'lib/inch/code_object/provider/yard/object/base.rb', line 200

def namespace?
  false
end

#original_docstringString

Returns the documentation comments.

Returns:

  • (String)

    the documentation comments



205
206
207
# File 'lib/inch/code_object/provider/yard/object/base.rb', line 205

def original_docstring
  object.docstring.all.to_s
end

#parametersObject



209
210
211
# File 'lib/inch/code_object/provider/yard/object/base.rb', line 209

def parameters
  []
end

#private?Boolean

Returns:

  • (Boolean)


220
221
222
# File 'lib/inch/code_object/provider/yard/object/base.rb', line 220

def private?
  visibility == :private
end

#protected?Boolean

Returns:

  • (Boolean)


232
233
234
# File 'lib/inch/code_object/provider/yard/object/base.rb', line 232

def protected?
  visibility == :protected
end

#public?Boolean

Returns:

  • (Boolean)


236
237
238
# File 'lib/inch/code_object/provider/yard/object/base.rb', line 236

def public?
  visibility == :public
end

#tagged_as_internal_api?Boolean

Returns:

  • (Boolean)


224
225
226
# File 'lib/inch/code_object/provider/yard/object/base.rb', line 224

def tagged_as_internal_api?
  private_api_tag? || docstring.describes_internal_api?
end

#tagged_as_private?Boolean

Returns:

  • (Boolean)


228
229
230
# File 'lib/inch/code_object/provider/yard/object/base.rb', line 228

def tagged_as_private?
  private_tag? || docstring.describes_private_object?
end

#unconsidered_tag_countObject



249
250
251
# File 'lib/inch/code_object/provider/yard/object/base.rb', line 249

def unconsidered_tag_count
  unconsidered_tags.size
end

#undocumented?Boolean

Returns true if the object has no documentation at all.

Returns:

  • (Boolean)

    true if the object has no documentation at all



245
246
247
# File 'lib/inch/code_object/provider/yard/object/base.rb', line 245

def undocumented?
  original_docstring.empty?
end