Class: Docs::Rdoc::ContainerFilter

Inherits:
Filter
  • Object
show all
Defined in:
lib/docs/filters/rdoc/container.rb

Constant Summary

Constants inherited from Filter

Filter::SCHEME_RGX

Instance Method Summary collapse

Methods inherited from Filter

#absolute_url_string?, #at_css, #at_xpath, #base_url, #css, #current_url, #fragment_url_string?, #initial_page?, #parse_html, #relative_url_string?, #root_page?, #root_path, #root_url, #slug, #subpath, #subpath_to, #xpath

Instance Method Details

#callObject


4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
# File 'lib/docs/filters/rdoc/container.rb', line 4

def call
  if root_page?
    at_css 'main'
  else
    container = at_css 'main'

    # Add <dl> mentioning parent class and included modules
    meta = Nokogiri::XML::Node.new 'dl', doc
    meta['class'] = 'meta'

    if parent = at_css('#parent-class-section')
      meta << %(<dt>Parent:</dt><dd class="meta-parent">#{parent.at_css('.link').inner_html.strip}</dd>)
    end

    if includes = at_css('#includes-section')
      meta << %(<dt>Included modules:</dt><dd class="meta-includes">#{includes.css('a').map(&:to_html).join(', ')}</dd>)
    end

    if parent || includes
      container.at_css('h1').after(meta)
    end

    container
  end
end