Class: RDoc::MethodAttr

Inherits:

CodeObject

• Object
• CodeObject
• RDoc::MethodAttr

show all

Includes:

Comparable

Defined in:

lib/rdoc/method_attr.rb

Overview

Constant Summary

Constant Summary

Constants included from Text

Text::TO_HTML_CHARACTERS

Instance Attribute Summary (collapse)

• - (Object) aliases readonly

  Array of other names for this method/attribute.

• - (Object) arglists readonly

  The call_seq or the param_seq with method name, if there is no call_seq.

• - (Object) block_params

  Parameters yielded by the called block.

• - (Object) call_seq

  Different ways to call this method.

• - (Object) is_alias_for

  The method/attribute we're aliasing.

• - (Object) name

  Name of this method/attribute.

• - (Object) param_seq readonly

  Pretty parameter list for this method.

• - (Object) params

  Parameters for this method.

• - (Object) singleton

  Is this a singleton method/attribute?.

• - (Object) text readonly

  Source file token stream.

• - (Object) visibility

  public, protected, private.

Attributes inherited from CodeObject

#comment, #document_children, #document_self, #done_documenting, #file, #force_documentation, #line, #metadata, #offset, #parent, #received_nodoc, #section, #viewer

Instance Method Summary (collapse)

• - (Object) <=>(other)

  Order by #singleton then #name.

• - (Object) add_alias(an_alias, context)

  Abstract method.

• - (Object) aref

  HTML fragment reference for this method.

• - (Object) aref_prefix

  Prefix for aref, defined by subclasses.

• - (Boolean) documented?

  A method/attribute is documented if any of the following is true:

  • it was marked with :nodoc:;

  • it has a comment;

  • it is an alias for a documented method;

  • it has a #see method that is documented.

• - (Object) find_method_or_attribute(name)

  :nodoc:.

• - (Object) find_see

  :nodoc:.

• - (Object) full_name

  Full method/attribute name including namespace.

• - (Object) html_name

  HTML id-friendly method/attribute name.

• - (MethodAttr) initialize(text, name) constructor

  Creates a new MethodAttr from token stream text and method or attribute name name.

• - (Object) inspect

  :nodoc:.

• - (Object) name_prefix

  '::' for a class method/attribute, '#' for an instance method.

• - (Object) parent_name

  Name of our parent with special handling for un-marshaled methods.

• - (Object) path

  Path to this method.

• - (Object) pretty_name

  Method/attribute name with class/instance indicator.

• - (Object) pretty_print(q)

  :nodoc:.

• - (Object) see

  A method/attribute to look at, in particular if this method/attribute has no documentation.

• - (Object) to_s

  :nodoc:.

• - (Object) type

  Type of method/attribute (class or instance).

Methods inherited from CodeObject

#full_name=, #parent_file_name, #record_location, #start_doc, #stop_doc

Methods included from Text

encode_fallback, #expand_tabs, #flush_left, #markup, #normalize_comment, #parse, #strip_hashes, #strip_newlines, #strip_stars, #to_html, #wrap

79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97

# File 'lib/rdoc/method_attr.rb', line 79

def initialize text, name
  super()

  @text = text
  @name = name

  @aliases      = []
  @is_alias_for = nil
  @parent_name  = nil
  @singleton    = nil
  @visibility   = :public
  @see = false

  @arglists     = nil
  @block_params = nil
  @call_seq     = nil
  @param_seq    = nil
  @params       = nil
end

33
34
35

# File 'lib/rdoc/method_attr.rb', line 33

def aliases
  @aliases
end

65
66
67

# File 'lib/rdoc/method_attr.rb', line 65

def arglists
  @arglists
end

50
51
52

# File 'lib/rdoc/method_attr.rb', line 50

def block_params
  @block_params
end

60
61
62

# File 'lib/rdoc/method_attr.rb', line 60

def call_seq
  @call_seq
end

38
39
40

# File 'lib/rdoc/method_attr.rb', line 38

def is_alias_for
  @is_alias_for
end

13
14
15

# File 'lib/rdoc/method_attr.rb', line 13

def name
  @name
end

70
71
72

# File 'lib/rdoc/method_attr.rb', line 70

def param_seq
  @param_seq
end

55
56
57

# File 'lib/rdoc/method_attr.rb', line 55

def params
  @params
end

23
24
25

# File 'lib/rdoc/method_attr.rb', line 23

def singleton
  @singleton
end

28
29
30

# File 'lib/rdoc/method_attr.rb', line 28

def text
  @text
end

18
19
20

# File 'lib/rdoc/method_attr.rb', line 18

def visibility
  @visibility
end

102
103
104

# File 'lib/rdoc/method_attr.rb', line 102

def <=>(other)
  [@singleton ? 0 : 1, name] <=> [other.singleton ? 0 : 1, other.name]
end

181
182
183

# File 'lib/rdoc/method_attr.rb', line 181

def add_alias(an_alias, context)
  raise NotImplementedError
end

188
189
190
191
192

# File 'lib/rdoc/method_attr.rb', line 188

def aref
  type = singleton ? 'c' : 'i'
  # % characters are not allowed in html names => dash instead
  "#{aref_prefix}-#{type}-#{html_name}"
end

197
198
199

# File 'lib/rdoc/method_attr.rb', line 197

def aref_prefix
  raise NotImplementedError
end

113
114
115
116
117

# File 'lib/rdoc/method_attr.rb', line 113

def documented?
  super or
    (is_alias_for and is_alias_for.documented?) or
    (see and see.documented?)
end

150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170

# File 'lib/rdoc/method_attr.rb', line 150

def find_method_or_attribute name # :nodoc:
  return nil unless parent.respond_to? :ancestors

  searched = parent.ancestors
  kernel = RDoc::TopLevel.all_modules_hash['Kernel']

  searched << kernel if kernel &&
    parent != kernel && !searched.include?(kernel)

  searched.each do |ancestor|
    next if parent == ancestor
    next if String === ancestor

    other = ancestor.find_method_named('#' << name) ||
            ancestor.find_attribute_named(name)

    return other if other
  end

  nil
end

138
139
140
141
142
143
144
145
146
147
148

# File 'lib/rdoc/method_attr.rb', line 138

def find_see # :nodoc:
  return nil if singleton || is_alias_for

  # look for the method
  other = find_method_or_attribute name
  return other if other

  # if it is a setter, look for a getter
  return nil unless name =~ /[a-z_]=$/i   # avoid == or ===
  return find_method_or_attribute name[0..-2]
end

270
271
272

# File 'lib/rdoc/method_attr.rb', line 270

def full_name
  @full_name || "#{parent_name}#{pretty_name}"
end

263
264
265

# File 'lib/rdoc/method_attr.rb', line 263

def html_name
  CGI.escape(@name.gsub('-', '-2D')).gsub('%','-').sub(/^-/, '')
end

334
335
336
337
338
339
340
341
342

# File 'lib/rdoc/method_attr.rb', line 334

def inspect # :nodoc:
  alias_for = @is_alias_for ? " (alias for #{@is_alias_for.name})" : nil
  "#<%s:0x%x %s (%s)%s>" % [
    self.class, object_id,
    full_name,
    visibility,
    alias_for,
  ]
end

277
278
279

# File 'lib/rdoc/method_attr.rb', line 277

def name_prefix
  singleton ? '::' : '#'
end

305
306
307

# File 'lib/rdoc/method_attr.rb', line 305

def parent_name
  @parent_name || super
end

298
299
300

# File 'lib/rdoc/method_attr.rb', line 298

def path
  "#{@parent.path}##{aref}"
end

284
285
286

# File 'lib/rdoc/method_attr.rb', line 284

def pretty_name
  "#{name_prefix}#{@name}"
end

309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332

# File 'lib/rdoc/method_attr.rb', line 309

def pretty_print q # :nodoc:
  alias_for = @is_alias_for ? "alias for #{@is_alias_for.name}" : nil

  q.group 2, "[#{self.class.name} #{full_name} #{visibility}", "]" do
    if alias_for then
      q.breakable
      q.text alias_for
    end

    if text then
      q.breakable
      q.text "text:"
      q.breakable
      q.pp @text
    end

    unless comment.empty? then
      q.breakable
      q.text "comment:"
      q.breakable
      q.pp @comment
    end
  end
end

133
134
135
136

# File 'lib/rdoc/method_attr.rb', line 133

def see
  @see = find_see if @see == false
  @see
end

344
345
346
347
348
349
350

# File 'lib/rdoc/method_attr.rb', line 344

def to_s # :nodoc:
  if @is_alias_for
    "#{self.class.name}: #{full_name} -> #{is_alias_for}"
  else
    "#{self.class.name}: #{full_name}"
  end
end

291
292
293

# File 'lib/rdoc/method_attr.rb', line 291

def type
  singleton ? 'class' : 'instance'
end