Class: RDoc::ClassModule

Inherits:
Context show all
Defined in:
lib/rdoc/code_object/class_module.rb,
lib/rdoc/generator/markup.rb

Overview

ClassModule is the base class for objects representing either a class or a module.

Direct Known Subclasses

AnonClass, NormalClass, NormalModule, SingleClass

Constant Summary collapse

MARSHAL_VERSION =
1

RDoc 3.7

  • Added visibility, singleton and file to attributes

  • Added file to constants

  • Added file to includes

  • Added file to methods

2

RDoc 3.13

  • Added extends

3

RDoc 4.0

  • Added sections

  • Added in_files

  • Added parent name

  • Complete Constant dump

3

Constants inherited from Context

RDoc::Context::TOMDOC_TITLES, RDoc::Context::TOMDOC_TITLES_SORT, RDoc::Context::TYPES

Constants included from Text

Text::MARKUP_FORMAT, Text::SPACE_SEPARATED_LETTER_CLASS, Text::TO_HTML_CHARACTERS

Instance Attribute Summary collapse

Attributes inherited from Context

#aliases, #attributes, #block_params, #constants, #constants_hash, #current_line_visibility, #current_section, #extends, #external_aliases, #in_files, #includes, #method_list, #methods_hash, #name, #params, #requires, #temporary_section, #unmatched_alias_lists, #visibility

Attributes inherited from CodeObject

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

Attributes included from Text

#language

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Context

#<=>, #add, #add_alias, #add_attribute, #add_class, #add_class_or_module, #add_constant, #add_extend, #add_include, #add_method, #add_module, #add_module_alias, #add_module_by_normal_module, #add_require, #add_section, #add_to, #any_content, #child_name, #class_attributes, #class_method_list, #classes, #classes_and_modules, #classes_hash, #defined_in?, #display, #each_attribute, #each_classmodule, #each_constant, #each_extend, #each_include, #each_method, #each_section, #find_attribute, #find_attribute_named, #find_class_method_named, #find_constant_named, #find_enclosing_module_named, #find_external_alias, #find_external_alias_named, #find_file_named, #find_instance_method_named, #find_local_symbol, #find_method, #find_method_named, #find_module_named, #find_symbol, #find_symbol_module, #fully_documented?, #http_url, #initialize_methods_etc, #instance_attributes, #instance_method_list, #instance_methods, #methods_by_type, #methods_matching, #modules, #modules_hash, #ongoing_visibility=, #record_location, #remove_from_documentation?, #remove_invisible, #remove_invisible_in, #resolve_aliases, #section_contents, #sections, #sections_hash, #set_constant_visibility_for, #set_current_section, #set_visibility_for, #sort_sections, #top_level, #upgrade_to_class

Methods inherited from CodeObject

#display?, #each_parent, #file_name, #full_name=, #ignore, #ignored?, #initialize_visibility, #options, #parent_file_name, #parent_name, #record_location, #start_doc, #stop_doc, #suppress, #suppressed?

Methods included from Generator::Markup

#aref_to, #as_href, #cvs_url, #formatter

Methods included from Text

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

Constructor Details

#initialize(name, superclass = nil) ⇒ ClassModule

Creates a new ClassModule with name with optional superclass

This is a constructor for subclasses, and must never be called directly.



111
112
113
114
115
116
117
118
119
120
 
# File 'lib/rdoc/code_object/class_module.rb', line 111

def initialize(name, superclass = nil)
  @constant_aliases = []
  @diagram          = nil
  @is_alias_for     = nil
  @name             = name
  @superclass       = superclass
  @comment_location = [] # [[comment, location]]

  super()
end

Instance Attribute Details

#comment_location ⇒ Object

Comment and the location it came from. Use #add_comment to add comments



35
36
37
 
# File 'lib/rdoc/code_object/class_module.rb', line 35

def comment_location
  @comment_location
end

#constant_aliases ⇒ Object

Constants that are aliases for this class or module



30
31
32
 
# File 'lib/rdoc/code_object/class_module.rb', line 30

def constant_aliases
  @constant_aliases
end

#diagram ⇒ Object

:nodoc:



37
38
39
 
# File 'lib/rdoc/code_object/class_module.rb', line 37

def diagram
  @diagram
end

#is_alias_for ⇒ Object

Class or module this constant is an alias for



42
43
44
 
# File 'lib/rdoc/code_object/class_module.rb', line 42

def is_alias_for
  @is_alias_for
end

Class Method Details

.from_module(class_type, mod) ⇒ Object

Return a RDoc::ClassModule of class class_type that is a copy of module module. Used to promote modules to classes. – TODO move to RDoc::NormalClass (I think)



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/rdoc/code_object/class_module.rb', line 50

def self.from_module class_type, mod
  klass = class_type.new mod.name

  mod.comment_location.each do |comment, location|
    klass.add_comment comment, location
  end

  klass.parent = mod.parent
  klass.section = mod.section
  klass.viewer = mod.viewer

  klass.attributes.concat mod.attributes
  klass.method_list.concat mod.method_list
  klass.aliases.concat mod.aliases
  klass.external_aliases.concat mod.external_aliases
  klass.constants.concat mod.constants
  klass.includes.concat mod.includes
  klass.extends.concat mod.extends

  klass.methods_hash.update mod.methods_hash
  klass.constants_hash.update mod.constants_hash

  klass.current_section = mod.current_section
  klass.in_files.concat mod.in_files
  klass.sections.concat mod.sections
  klass.unmatched_alias_lists = mod.unmatched_alias_lists
  klass.current_section = mod.current_section
  klass.visibility = mod.visibility

  klass.classes_hash.update mod.classes_hash
  klass.modules_hash.update mod.modules_hash
  klass.metadata.update mod.metadata

  klass.document_self = mod.received_nodoc ? nil : mod.document_self
  klass.document_children = mod.document_children
  klass.force_documentation = mod.force_documentation
  klass.done_documenting = mod.done_documenting

  # update the parent of all children

  (klass.attributes +
   klass.method_list +
   klass.aliases +
   klass.external_aliases +
   klass.constants +
   klass.includes +
   klass.extends +
   klass.classes +
   klass.modules).each do |obj|
    obj.parent = klass
    obj.full_name = nil
  end

  klass
end

Instance Method Details

#add_comment(comment, location) ⇒ Object

Adds comment to this ClassModule’s list of comments at location. This method is preferred over #comment= since it allows ri data to be updated across multiple runs.



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/rdoc/code_object/class_module.rb', line 127

def add_comment comment, location
  return unless document_self

  original = comment

  comment = case comment
            when RDoc::Comment then
              comment.normalize
            else
              normalize_comment comment
            end

  if location.parser == RDoc::Parser::C
    @comment_location.delete_if { |(_, l)| l == location }
  end

  @comment_location << [comment, location]

  self.comment = original
end

#add_things(my_things, other_things) ⇒ Object

:nodoc:



148
149
150
151
152
153
154
155
156
157
 
# File 'lib/rdoc/code_object/class_module.rb', line 148

def add_things my_things, other_things # :nodoc:
  other_things.each do |group, things|
    my_things[group].each { |thing| yield false, thing } if
      my_things.include? group

    things.each do |thing|
      yield true, thing
    end
  end
end

#ancestors ⇒ Object Also known as: direct_ancestors

Ancestors list for this ClassModule: the list of included modules (classes will add their superclass if any).

Returns the included classes or modules, not the includes themselves. The returned values are either String or RDoc::NormalModule instances (see RDoc::Include#module).

The values are returned in reverse order of their inclusion, which is the order suitable for searching methods/attributes in the ancestors. The superclass, if any, comes last.



171
172
173
 
# File 'lib/rdoc/code_object/class_module.rb', line 171

def ancestors
  includes.map { |i| i.module }.reverse
end

#aref ⇒ Object

HTML fragment reference for this module or class. See RDoc::NormalClass#aref and RDoc::NormalModule#aref



183
184
185
 
# File 'lib/rdoc/code_object/class_module.rb', line 183

def aref
  "#{aref_prefix}-#{full_name}"
end

#aref_prefix ⇒ Object

:nodoc:

Raises:

  • (NotImplementedError) 


175
176
177
 
# File 'lib/rdoc/code_object/class_module.rb', line 175

def aref_prefix # :nodoc:
  raise NotImplementedError, "missing aref_prefix for #{self.class}"
end

#clear_comment ⇒ Object

Clears the comment. Used by the Ruby parser.



195
196
197
 
# File 'lib/rdoc/code_object/class_module.rb', line 195

def clear_comment
  @comment = ''
end

#comment=(comment) ⇒ Object

This method is deprecated, use #add_comment instead.

Appends comment to the current comment, but separated by a rule. Works more like +=.



205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/rdoc/code_object/class_module.rb', line 205

def comment= comment # :nodoc:
  comment = case comment
            when RDoc::Comment then
              comment.normalize
            else
              normalize_comment comment
            end

  comment = "#{@comment.to_s}\n---\n#{comment.to_s}" unless @comment.empty?

  super comment
end

#complete(min_visibility) ⇒ Object

Prepares this ClassModule for use by a generator.

See RDoc::Store#complete



223
224
225
226
227
228
229
 
# File 'lib/rdoc/code_object/class_module.rb', line 223

def complete min_visibility
  update_aliases
  remove_nodoc_children
  embed_mixins
  update_includes
  remove_invisible min_visibility
end

#description ⇒ Object

Handy wrapper for marking up this class or module’s comment



131
132
133
 
# File 'lib/rdoc/generator/markup.rb', line 131

def description
  markup @comment_location
end

#document_self_or_methods ⇒ Object

Does this ClassModule or any of its methods have document_self set?



234
235
236
 
# File 'lib/rdoc/code_object/class_module.rb', line 234

def document_self_or_methods
  document_self || method_list.any?{ |m| m.document_self }
end

#documented? ⇒ Boolean

Does this class or module have a comment with content or is #received_nodoc true?

Returns:

  • (Boolean) 


242
243
244
245
246
 
# File 'lib/rdoc/code_object/class_module.rb', line 242

def documented?
  return true if @received_nodoc
  return false if @comment_location.empty?
  @comment_location.any? { |comment, _| not comment.empty? }
end

#each_ancestor ⇒ Object

Iterates the ancestors of this class or module for which an RDoc::ClassModule exists.



252
253
254
255
256
257
258
259
260
 
# File 'lib/rdoc/code_object/class_module.rb', line 252

def each_ancestor # :yields: module
  return enum_for __method__ unless block_given?

  ancestors.each do |mod|
    next if String === mod
    next if self == mod
    yield mod
  end
end

#embed_mixins ⇒ Object 



816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
 
# File 'lib/rdoc/code_object/class_module.rb', line 816

def embed_mixins
  return unless options.embed_mixins

  includes.each do |include|
    next if String === include.module
    include.module.method_list.each do |code_object|
      add_method(prepare_to_embed(code_object))
    end
    include.module.constants.each do |code_object|
      add_constant(prepare_to_embed(code_object))
    end
    include.module.attributes.each do |code_object|
      add_attribute(prepare_to_embed(code_object))
    end
  end

  extends.each do |ext|
    next if String === ext.module
    ext.module.method_list.each do |code_object|
      add_method(prepare_to_embed(code_object, true))
    end
    ext.module.attributes.each do |code_object|
      add_attribute(prepare_to_embed(code_object, true))
    end
  end
end

#find_ancestor_local_symbol(symbol) ⇒ Object

Looks for a symbol in the #ancestors. See Context#find_local_symbol.



265
266
267
268
269
270
271
272
 
# File 'lib/rdoc/code_object/class_module.rb', line 265

def find_ancestor_local_symbol symbol
  each_ancestor do |m|
    res = m.find_local_symbol(symbol)
    return res if res
  end

  nil
end

#find_class_named(name) ⇒ Object

Finds a class or module with name in this namespace or its descendants



277
278
279
280
281
282
283
284
285
 
# File 'lib/rdoc/code_object/class_module.rb', line 277

def find_class_named name
  return self if full_name == name
  return self if @name == name

  @classes.values.find do |klass|
    next if klass == self
    klass.find_class_named name
  end
end

#full_name ⇒ Object

Return the fully qualified name of this class or module



290
291
292
293
294
295
296
 
# File 'lib/rdoc/code_object/class_module.rb', line 290

def full_name
  @full_name ||= if RDoc::ClassModule === parent then
                   "#{parent.full_name}::#{@name}"
                 else
                   @name
                 end
end

#marshal_dump ⇒ Object

TODO: filter included items by #display?



301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/rdoc/code_object/class_module.rb', line 301

def marshal_dump # :nodoc:
  attrs = attributes.sort.map do |attr|
    next unless attr.display?
    [ attr.name, attr.rw,
      attr.visibility, attr.singleton, attr.file_name,
    ]
  end.compact

  method_types = methods_by_type.map do |type, visibilities|
    visibilities = visibilities.map do |visibility, methods|
      method_names = methods.map do |method|
        next unless method.display?
        [method.name, method.file_name]
      end.compact

      [visibility, method_names.uniq]
    end

    [type, visibilities]
  end

  [ MARSHAL_VERSION,
    @name,
    full_name,
    @superclass,
    parse(@comment_location),
    attrs,
    constants.select { |constant| constant.display? },
    includes.map do |incl|
      next unless incl.display?
      [incl.name, parse(incl.comment), incl.file_name]
    end.compact,
    method_types,
    extends.map do |ext|
      next unless ext.display?
      [ext.name, parse(ext.comment), ext.file_name]
    end.compact,
    @sections.values,
    @in_files.map do |tl|
      tl.relative_name
    end,
    parent.full_name,
    parent.class,
  ]
end

#marshal_load(array) ⇒ Object

:nodoc:



347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
 
# File 'lib/rdoc/code_object/class_module.rb', line 347

def marshal_load array # :nodoc:
  initialize_visibility
  initialize_methods_etc
  @current_section   = nil
  @document_self     = true
  @done_documenting  = false
  @parent            = nil
  @temporary_section = nil
  @visibility        = nil
  @classes           = {}
  @modules           = {}

  @name       = array[1]
  @full_name  = array[2]
  @superclass = array[3]
  @comment    = array[4]

  @comment_location = if RDoc::Markup::Document === @comment.parts.first then
                        @comment
                      else
                        RDoc::Markup::Document.new @comment
                      end

  array[5].each do |name, rw, visibility, singleton, file|
    singleton  ||= false
    visibility ||= :public

    attr = RDoc::Attr.new nil, name, rw, nil, singleton

    add_attribute attr
    attr.visibility = visibility
    attr.record_location RDoc::TopLevel.new file
  end

  array[6].each do |constant, comment, file|
    case constant
    when RDoc::Constant then
      add_constant constant
    else
      constant = add_constant RDoc::Constant.new(constant, nil, comment)
      constant.record_location RDoc::TopLevel.new file
    end
  end

  array[7].each do |name, comment, file|
    incl = add_include RDoc::Include.new(name, comment)
    incl.record_location RDoc::TopLevel.new file
  end

  array[8].each do |type, visibilities|
    visibilities.each do |visibility, methods|
      @visibility = visibility

      methods.each do |name, file|
        method = RDoc::AnyMethod.new nil, name
        method.singleton = true if type == 'class'
        method.record_location RDoc::TopLevel.new file
        add_method method
      end
    end
  end

  array[9].each do |name, comment, file|
    ext = add_extend RDoc::Extend.new(name, comment)
    ext.record_location RDoc::TopLevel.new file
  end if array[9] # Support Marshal version 1

  sections = (array[10] || []).map do |section|
    [section.title, section]
  end

  @sections = Hash[*sections.flatten]
  @current_section = add_section nil

  @in_files = []

  (array[11] || []).each do |filename|
    record_location RDoc::TopLevel.new filename
  end

  @parent_name  = array[12]
  @parent_class = array[13]
end

#merge(class_module) ⇒ Object

Merges class_module into this ClassModule.

The data in class_module is preferred over the receiver.



436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
 
# File 'lib/rdoc/code_object/class_module.rb', line 436

def merge class_module
  @parent      = class_module.parent
  @parent_name = class_module.parent_name

  other_document = parse class_module.comment_location

  if other_document then
    document = parse @comment_location

    document = document.merge other_document

    @comment = @comment_location = document
  end

  cm = class_module
  other_files = cm.in_files

  merge_collections attributes, cm.attributes, other_files do |add, attr|
    if add then
      add_attribute attr
    else
      @attributes.delete attr
      @methods_hash.delete attr.pretty_name
    end
  end

  merge_collections constants, cm.constants, other_files do |add, const|
    if add then
      add_constant const
    else
      @constants.delete const
      @constants_hash.delete const.name
    end
  end

  merge_collections includes, cm.includes, other_files do |add, incl|
    if add then
      add_include incl
    else
      @includes.delete incl
    end
  end

  @includes.uniq! # clean up

  merge_collections extends, cm.extends, other_files do |add, ext|
    if add then
      add_extend ext
    else
      @extends.delete ext
    end
  end

  @extends.uniq! # clean up

  merge_collections method_list, cm.method_list, other_files do |add, meth|
    if add then
      add_method meth
    else
      @method_list.delete meth
      @methods_hash.delete meth.pretty_name
    end
  end

  merge_sections cm

  self
end

#merge_collections(mine, other, other_files, &block) ⇒ Object

Merges collection mine with other preferring other. other_files is used to help determine which items should be deleted.

Yields whether the item should be added or removed (true or false) and the item to be added or removed.

merge_collections things, other.things, other.in_files do |add, thing|
  if add then
    # add the thing
  else
    # remove the thing
  end
end



520
521
522
523
524
525
526
 
# File 'lib/rdoc/code_object/class_module.rb', line 520

def merge_collections mine, other, other_files, &block # :nodoc:
  my_things    = mine. group_by { |thing| thing.file }
  other_things = other.group_by { |thing| thing.file }

  remove_things my_things, other_files,  &block
  add_things    my_things, other_things, &block
end

#merge_sections(cm) ⇒ Object

Merges the comments in this ClassModule with the comments in the other ClassModule cm.



532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
 
# File 'lib/rdoc/code_object/class_module.rb', line 532

def merge_sections cm # :nodoc:
  my_sections    =    sections.group_by { |section| section.title }
  other_sections = cm.sections.group_by { |section| section.title }

  other_files = cm.in_files

  remove_things my_sections, other_files do |_, section|
    @sections.delete section.title
  end

  other_sections.each do |group, sections|
    if my_sections.include? group
      my_sections[group].each do |my_section|
        other_section = cm.sections_hash[group]

        my_comments    = my_section.comments
        other_comments = other_section.comments

        other_files = other_section.in_files

        merge_collections my_comments, other_comments, other_files do |add, comment|
          if add then
            my_section.add_comment comment
          else
            my_section.remove_comment comment
          end
        end
      end
    else
      sections.each do |section|
        add_section group, section.comments
      end
    end
  end
end

#module? ⇒ Boolean

Does this object represent a module?

Returns:

  • (Boolean) 


571
572
573
 
# File 'lib/rdoc/code_object/class_module.rb', line 571

def module?
  false
end

#name=(new_name) ⇒ Object

Allows overriding the initial name.

Used for modules and classes that are constant aliases.



580
581
582
 
# File 'lib/rdoc/code_object/class_module.rb', line 580

def name= new_name
  @name = new_name
end

#name_for_path ⇒ Object

Name to use to generate the url: modules and classes that are aliases for another module or class return the name of the latter.



623
624
625
 
# File 'lib/rdoc/code_object/class_module.rb', line 623

def name_for_path
  is_alias_for ? is_alias_for.full_name : full_name
end

#non_aliases ⇒ Object

Returns the classes and modules that are not constants aliasing another class or module. For use by formatters only (caches its result).



632
633
634
 
# File 'lib/rdoc/code_object/class_module.rb', line 632

def non_aliases
  @non_aliases ||= classes_and_modules.reject { |cm| cm.is_alias_for }
end

#parse(comment_location) ⇒ Object

Parses comment_location into an RDoc::Markup::Document composed of multiple RDoc::Markup::Documents with their file set.



588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
 
# File 'lib/rdoc/code_object/class_module.rb', line 588

def parse comment_location
  case comment_location
  when String then
    super
  when Array then
    docs = comment_location.map do |comment, location|
      doc = super comment
      doc.file = location
      doc
    end

    RDoc::Markup::Document.new(*docs)
  when RDoc::Comment then
    doc = super comment_location.text, comment_location.format
    doc.file = comment_location.location
    doc
  when RDoc::Markup::Document then
    return comment_location
  else
    raise ArgumentError, "unknown comment class #{comment_location.class}"
  end
end

#path ⇒ Object

Path to this class or module for use with HTML generator output.



614
615
616
 
# File 'lib/rdoc/code_object/class_module.rb', line 614

def path
  http_url @store.rdoc.generator.class_dir
end

#remove_nodoc_children ⇒ Object

Updates the child modules or classes of class/module parent by deleting the ones that have been removed from the documentation.

parent_hash is either parent.modules_hash or parent.classes_hash and all_hash is ::all_modules_hash or ::all_classes_hash.



644
645
646
647
648
649
650
651
652
653
654
655
656
 
# File 'lib/rdoc/code_object/class_module.rb', line 644

def remove_nodoc_children
  prefix = self.full_name + '::'

  modules_hash.each_key do |name|
    full_name = prefix + name
    modules_hash.delete name unless @store.modules_hash[full_name]
  end

  classes_hash.each_key do |name|
    full_name = prefix + name
    classes_hash.delete name unless @store.classes_hash[full_name]
  end
end

#remove_things(my_things, other_files) ⇒ Object

:nodoc:



658
659
660
661
662
663
664
665
666
667
668
 
# File 'lib/rdoc/code_object/class_module.rb', line 658

def remove_things my_things, other_files # :nodoc:
  my_things.delete_if do |file, things|
    next false unless other_files.include? file

    things.each do |thing|
      yield false, thing
    end

    true
  end
end

#search_record ⇒ Object

Search record used by RDoc::Generator::JsonIndex



673
674
675
676
677
678
679
680
681
682
683
 
# File 'lib/rdoc/code_object/class_module.rb', line 673

def search_record
  [
    name,
    full_name,
    full_name,
    '',
    path,
    '',
    snippet(@comment_location),
  ]
end

#store=(store) ⇒ Object

Sets the store for this class or module and its contained code objects.



688
689
690
691
692
693
694
695
696
 
# File 'lib/rdoc/code_object/class_module.rb', line 688

def store= store
  super

  @attributes .each do |attr|  attr.store  = store end
  @constants  .each do |const| const.store = store end
  @includes   .each do |incl|  incl.store  = store end
  @extends    .each do |ext|   ext.store   = store end
  @method_list.each do |meth|  meth.store  = store end
end

#super_classes ⇒ Object

Get all super classes of this class in an array. The last element might be a string if the name is unknown.



718
719
720
721
722
723
724
725
726
 
# File 'lib/rdoc/code_object/class_module.rb', line 718

def super_classes
  result = []
  parent = self
  while parent = parent.superclass
    result << parent
    return result if parent.is_a?(String)
  end
  result
end

#superclass ⇒ Object

Get the superclass of this class. Attempts to retrieve the superclass object, returns the name if it is not known.



702
703
704
 
# File 'lib/rdoc/code_object/class_module.rb', line 702

def superclass
  @store.find_class_named(@superclass) || @superclass
end

#superclass=(superclass) ⇒ Object

Set the superclass of this class to superclass

Raises:

  • (NoMethodError) 


709
710
711
712
 
# File 'lib/rdoc/code_object/class_module.rb', line 709

def superclass=(superclass)
  raise NoMethodError, "#{full_name} is a module" if module?
  @superclass = superclass
end

#to_s ⇒ Object

:nodoc:



728
729
730
731
732
733
734
 
# File 'lib/rdoc/code_object/class_module.rb', line 728

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

#type ⇒ Object

‘module’ or ‘class’



739
740
741
 
# File 'lib/rdoc/code_object/class_module.rb', line 739

def type
  module? ? 'module' : 'class'
end

#update_aliases ⇒ Object

Updates the child modules & classes by replacing the ones that are aliases through a constant.

The aliased module/class is replaced in the children and in RDoc::Store#modules_hash or RDoc::Store#classes_hash by a copy that has RDoc::ClassModule#is_alias_for set to the aliased module/class, and this copy is added to #aliases of the aliased module/class.

Formatters can use the #non_aliases method to retrieve children that are not aliases, for instance to list the namespace content, since the aliased modules are included in the constants of the class/module, that are listed separately.



758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
 
# File 'lib/rdoc/code_object/class_module.rb', line 758

def update_aliases
  constants.each do |const|
    next unless cm = const.is_alias_for
    cm_alias = cm.dup
    cm_alias.name = const.name

    # Don't move top-level aliases under Object, they look ugly there
    unless RDoc::TopLevel === cm_alias.parent then
      cm_alias.parent = self
      cm_alias.full_name = nil # force update for new parent
    end

    cm_alias.aliases.clear
    cm_alias.is_alias_for = cm

    if cm.module? then
      @store.modules_hash[cm_alias.full_name] = cm_alias
      modules_hash[const.name] = cm_alias
    else
      @store.classes_hash[cm_alias.full_name] = cm_alias
      classes_hash[const.name] = cm_alias
    end

    cm.aliases << cm_alias
  end
end

#update_extends ⇒ Object

Deletes from #extends those whose module has been removed from the documentation. – FIXME: like update_includes, extends are not reliably removed



806
807
808
809
810
811
812
813
814
 
# File 'lib/rdoc/code_object/class_module.rb', line 806

def update_extends
  extends.reject! do |ext|
    mod = ext.module

    !(String === mod) && @store.modules_hash[mod.full_name].nil?
  end

  extends.uniq!
end

#update_includes ⇒ Object

Deletes from #includes those whose module has been removed from the documentation. – FIXME: includes are not reliably removed, see _possible_bug test case



791
792
793
794
795
796
797
798
 
# File 'lib/rdoc/code_object/class_module.rb', line 791

def update_includes
  includes.reject! do |include|
    mod = include.module
    !(String === mod) && @store.modules_hash[mod.full_name].nil?
  end

  includes.uniq!
end