mega-max-hub 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/mega-max-hub.gemspec +11 -0
- data/rdoc-8.0.0/CONTRIBUTING.md +195 -0
- data/rdoc-8.0.0/CVE-2013-0256.rdoc +49 -0
- data/rdoc-8.0.0/History.rdoc +1668 -0
- data/rdoc-8.0.0/LEGAL.rdoc +56 -0
- data/rdoc-8.0.0/LICENSE.rdoc +63 -0
- data/rdoc-8.0.0/README.md +236 -0
- data/rdoc-8.0.0/RI.md +842 -0
- data/rdoc-8.0.0/TODO.rdoc +60 -0
- data/rdoc-8.0.0/doc/markup_reference/markdown.md +659 -0
- data/rdoc-8.0.0/doc/markup_reference/rdoc.rdoc +1169 -0
- data/rdoc-8.0.0/exe/rdoc +43 -0
- data/rdoc-8.0.0/exe/ri +12 -0
- data/rdoc-8.0.0/lib/rdoc/code_object/alias.rb +98 -0
- data/rdoc-8.0.0/lib/rdoc/code_object/any_method.rb +387 -0
- data/rdoc-8.0.0/lib/rdoc/code_object/attr.rb +178 -0
- data/rdoc-8.0.0/lib/rdoc/code_object/class_module.rb +969 -0
- data/rdoc-8.0.0/lib/rdoc/code_object/constant.rb +221 -0
- data/rdoc-8.0.0/lib/rdoc/code_object/context/section.rb +182 -0
- data/rdoc-8.0.0/lib/rdoc/code_object/context.rb +1238 -0
- data/rdoc-8.0.0/lib/rdoc/code_object/extend.rb +9 -0
- data/rdoc-8.0.0/lib/rdoc/code_object/include.rb +9 -0
- data/rdoc-8.0.0/lib/rdoc/code_object/method_attr.rb +417 -0
- data/rdoc-8.0.0/lib/rdoc/code_object/mixin.rb +123 -0
- data/rdoc-8.0.0/lib/rdoc/code_object/normal_class.rb +92 -0
- data/rdoc-8.0.0/lib/rdoc/code_object/normal_module.rb +73 -0
- data/rdoc-8.0.0/lib/rdoc/code_object/require.rb +51 -0
- data/rdoc-8.0.0/lib/rdoc/code_object/single_class.rb +30 -0
- data/rdoc-8.0.0/lib/rdoc/code_object/top_level.rb +286 -0
- data/rdoc-8.0.0/lib/rdoc/code_object.rb +393 -0
- data/rdoc-8.0.0/lib/rdoc/code_objects.rb +5 -0
- data/rdoc-8.0.0/lib/rdoc/comment.rb +353 -0
- data/rdoc-8.0.0/lib/rdoc/cross_reference.rb +215 -0
- data/rdoc-8.0.0/lib/rdoc/encoding.rb +120 -0
- data/rdoc-8.0.0/lib/rdoc/erb_partial.rb +18 -0
- data/rdoc-8.0.0/lib/rdoc/erbio.rb +37 -0
- data/rdoc-8.0.0/lib/rdoc/generator/aliki.rb +200 -0
- data/rdoc-8.0.0/lib/rdoc/generator/darkfish.rb +824 -0
- data/rdoc-8.0.0/lib/rdoc/generator/json_index.rb +284 -0
- data/rdoc-8.0.0/lib/rdoc/generator/markup.rb +196 -0
- data/rdoc-8.0.0/lib/rdoc/generator/pot/message_extractor.rb +68 -0
- data/rdoc-8.0.0/lib/rdoc/generator/pot/po.rb +84 -0
- data/rdoc-8.0.0/lib/rdoc/generator/pot/po_entry.rb +141 -0
- data/rdoc-8.0.0/lib/rdoc/generator/pot.rb +94 -0
- data/rdoc-8.0.0/lib/rdoc/generator/ri.rb +30 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/aliki/DESIGN.md +536 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/aliki/_aside_toc.rhtml +8 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/aliki/_footer.rhtml +23 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/aliki/_head.rhtml +163 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/aliki/_header.rhtml +56 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/aliki/_icons.rhtml +208 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/aliki/_sidebar_ancestors.rhtml +16 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/aliki/_sidebar_classes.rhtml +15 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/aliki/_sidebar_extends.rhtml +27 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/aliki/_sidebar_includes.rhtml +27 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/aliki/_sidebar_installed.rhtml +16 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/aliki/_sidebar_methods.rhtml +41 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/aliki/_sidebar_pages.rhtml +67 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/aliki/_sidebar_search.rhtml +15 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/aliki/_sidebar_sections.rhtml +21 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/aliki/_sidebar_toggle.rhtml +3 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/aliki/class.rhtml +230 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/aliki/css/rdoc.css +2181 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/aliki/index.rhtml +22 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/aliki/js/aliki.js +513 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/aliki/js/bash_highlighter.js +167 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/aliki/js/c_highlighter.js +299 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/aliki/js/search_controller.js +129 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/aliki/js/search_navigation.js +105 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/aliki/js/search_ranker.js +239 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/aliki/js/theme-toggle.js +112 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/aliki/page.rhtml +18 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/aliki/servlet_not_found.rhtml +14 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/aliki/servlet_root.rhtml +65 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/darkfish/_footer.rhtml +5 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/darkfish/_head.rhtml +43 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/darkfish/_sidebar_classes.rhtml +5 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/darkfish/_sidebar_extends.rhtml +17 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/darkfish/_sidebar_includes.rhtml +17 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/darkfish/_sidebar_installed.rhtml +16 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/darkfish/_sidebar_methods.rhtml +21 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/darkfish/_sidebar_navigation.rhtml +11 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/darkfish/_sidebar_pages.rhtml +32 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/darkfish/_sidebar_parent.rhtml +6 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/darkfish/_sidebar_search.rhtml +15 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/darkfish/_sidebar_sections.rhtml +11 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/darkfish/_sidebar_table_of_contents.rhtml +39 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/darkfish/_sidebar_toggle.rhtml +3 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/darkfish/class.rhtml +220 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/darkfish/css/fonts.css +167 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/darkfish/css/rdoc.css +701 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/darkfish/fonts/Lato-Light.ttf +0 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/darkfish/fonts/Lato-LightItalic.ttf +0 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/darkfish/fonts/Lato-Regular.ttf +0 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/darkfish/fonts/Lato-RegularItalic.ttf +0 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/darkfish/fonts/SourceCodePro-Bold.ttf +0 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/darkfish/fonts/SourceCodePro-Regular.ttf +0 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/darkfish/images/add.png +0 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/darkfish/images/arrow_up.png +0 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/darkfish/images/brick.png +0 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/darkfish/images/brick_link.png +0 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/darkfish/images/bug.png +0 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/darkfish/images/bullet_black.png +0 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/darkfish/images/bullet_toggle_minus.png +0 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/darkfish/images/bullet_toggle_plus.png +0 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/darkfish/images/date.png +0 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/darkfish/images/delete.png +0 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/darkfish/images/find.png +0 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/darkfish/images/loadingAnimation.gif +0 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/darkfish/images/macFFBgHack.png +0 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/darkfish/images/package.png +0 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/darkfish/images/page_green.png +0 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/darkfish/images/page_white_text.png +0 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/darkfish/images/page_white_width.png +0 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/darkfish/images/plugin.png +0 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/darkfish/images/ruby.png +0 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/darkfish/images/tag_blue.png +0 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/darkfish/images/tag_green.png +0 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/darkfish/images/transparent.png +0 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/darkfish/images/wrench.png +0 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/darkfish/images/wrench_orange.png +0 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/darkfish/images/zoom.png +0 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/darkfish/index.rhtml +24 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/darkfish/js/darkfish.js +140 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/darkfish/js/search.js +120 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/darkfish/page.rhtml +19 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/darkfish/servlet_not_found.rhtml +21 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/darkfish/servlet_root.rhtml +65 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/darkfish/table_of_contents.rhtml +72 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/json_index/js/navigation.js +105 -0
- data/rdoc-8.0.0/lib/rdoc/generator/template/json_index/js/searcher.js +271 -0
- data/rdoc-8.0.0/lib/rdoc/generator.rb +52 -0
- data/rdoc-8.0.0/lib/rdoc/i18n/locale.rb +102 -0
- data/rdoc-8.0.0/lib/rdoc/i18n/text.rb +126 -0
- data/rdoc-8.0.0/lib/rdoc/i18n.rb +10 -0
- data/rdoc-8.0.0/lib/rdoc/known_classes.rb +74 -0
- data/rdoc-8.0.0/lib/rdoc/markdown/entities.rb +2131 -0
- data/rdoc-8.0.0/lib/rdoc/markdown/literals.kpeg +21 -0
- data/rdoc-8.0.0/lib/rdoc/markdown/literals.rb +454 -0
- data/rdoc-8.0.0/lib/rdoc/markdown.kpeg +1315 -0
- data/rdoc-8.0.0/lib/rdoc/markdown.rb +16865 -0
- data/rdoc-8.0.0/lib/rdoc/markup/blank_line.rb +29 -0
- data/rdoc-8.0.0/lib/rdoc/markup/block_quote.rb +14 -0
- data/rdoc-8.0.0/lib/rdoc/markup/document.rb +164 -0
- data/rdoc-8.0.0/lib/rdoc/markup/element.rb +21 -0
- data/rdoc-8.0.0/lib/rdoc/markup/formatter.rb +285 -0
- data/rdoc-8.0.0/lib/rdoc/markup/hard_break.rb +34 -0
- data/rdoc-8.0.0/lib/rdoc/markup/heading.rb +170 -0
- data/rdoc-8.0.0/lib/rdoc/markup/include.rb +42 -0
- data/rdoc-8.0.0/lib/rdoc/markup/indented_paragraph.rb +47 -0
- data/rdoc-8.0.0/lib/rdoc/markup/inline_parser.rb +312 -0
- data/rdoc-8.0.0/lib/rdoc/markup/list.rb +101 -0
- data/rdoc-8.0.0/lib/rdoc/markup/list_item.rb +99 -0
- data/rdoc-8.0.0/lib/rdoc/markup/paragraph.rb +28 -0
- data/rdoc-8.0.0/lib/rdoc/markup/parser.rb +585 -0
- data/rdoc-8.0.0/lib/rdoc/markup/pre_process.rb +317 -0
- data/rdoc-8.0.0/lib/rdoc/markup/raw.rb +66 -0
- data/rdoc-8.0.0/lib/rdoc/markup/rule.rb +20 -0
- data/rdoc-8.0.0/lib/rdoc/markup/table.rb +64 -0
- data/rdoc-8.0.0/lib/rdoc/markup/to_ansi.rb +144 -0
- data/rdoc-8.0.0/lib/rdoc/markup/to_bs.rb +86 -0
- data/rdoc-8.0.0/lib/rdoc/markup/to_html.rb +682 -0
- data/rdoc-8.0.0/lib/rdoc/markup/to_html_crossref.rb +261 -0
- data/rdoc-8.0.0/lib/rdoc/markup/to_html_snippet.rb +287 -0
- data/rdoc-8.0.0/lib/rdoc/markup/to_joined_paragraph.rb +41 -0
- data/rdoc-8.0.0/lib/rdoc/markup/to_label.rb +84 -0
- data/rdoc-8.0.0/lib/rdoc/markup/to_markdown.rb +215 -0
- data/rdoc-8.0.0/lib/rdoc/markup/to_rdoc.rb +421 -0
- data/rdoc-8.0.0/lib/rdoc/markup/to_table_of_contents.rb +88 -0
- data/rdoc-8.0.0/lib/rdoc/markup/to_test.rb +77 -0
- data/rdoc-8.0.0/lib/rdoc/markup/to_tt_only.rb +107 -0
- data/rdoc-8.0.0/lib/rdoc/markup/verbatim.rb +83 -0
- data/rdoc-8.0.0/lib/rdoc/markup.rb +219 -0
- data/rdoc-8.0.0/lib/rdoc/options.rb +1412 -0
- data/rdoc-8.0.0/lib/rdoc/parser/c.rb +1227 -0
- data/rdoc-8.0.0/lib/rdoc/parser/changelog.rb +379 -0
- data/rdoc-8.0.0/lib/rdoc/parser/markdown.rb +22 -0
- data/rdoc-8.0.0/lib/rdoc/parser/rbs.rb +275 -0
- data/rdoc-8.0.0/lib/rdoc/parser/rd.rb +22 -0
- data/rdoc-8.0.0/lib/rdoc/parser/ruby.rb +1266 -0
- data/rdoc-8.0.0/lib/rdoc/parser/ruby_colorizer.rb +253 -0
- data/rdoc-8.0.0/lib/rdoc/parser/simple.rb +44 -0
- data/rdoc-8.0.0/lib/rdoc/parser/text.rb +11 -0
- data/rdoc-8.0.0/lib/rdoc/parser.rb +298 -0
- data/rdoc-8.0.0/lib/rdoc/rbs_helper.rb +186 -0
- data/rdoc-8.0.0/lib/rdoc/rd/block_parser.rb +1706 -0
- data/rdoc-8.0.0/lib/rdoc/rd/block_parser.ry +643 -0
- data/rdoc-8.0.0/lib/rdoc/rd/inline.rb +71 -0
- data/rdoc-8.0.0/lib/rdoc/rd/inline_parser.rb +1854 -0
- data/rdoc-8.0.0/lib/rdoc/rd/inline_parser.ry +593 -0
- data/rdoc-8.0.0/lib/rdoc/rd.rb +99 -0
- data/rdoc-8.0.0/lib/rdoc/rdoc.rb +724 -0
- data/rdoc-8.0.0/lib/rdoc/ri/driver.rb +1572 -0
- data/rdoc-8.0.0/lib/rdoc/ri/formatter.rb +6 -0
- data/rdoc-8.0.0/lib/rdoc/ri/paths.rb +171 -0
- data/rdoc-8.0.0/lib/rdoc/ri/servlet.rb +452 -0
- data/rdoc-8.0.0/lib/rdoc/ri/store.rb +6 -0
- data/rdoc-8.0.0/lib/rdoc/ri/task.rb +71 -0
- data/rdoc-8.0.0/lib/rdoc/ri.rb +21 -0
- data/rdoc-8.0.0/lib/rdoc/rubygems_hook.rb +327 -0
- data/rdoc-8.0.0/lib/rdoc/server.rb +460 -0
- data/rdoc-8.0.0/lib/rdoc/stats/normal.rb +58 -0
- data/rdoc-8.0.0/lib/rdoc/stats/quiet.rb +59 -0
- data/rdoc-8.0.0/lib/rdoc/stats/verbose.rb +44 -0
- data/rdoc-8.0.0/lib/rdoc/stats.rb +484 -0
- data/rdoc-8.0.0/lib/rdoc/store.rb +1205 -0
- data/rdoc-8.0.0/lib/rdoc/task.rb +355 -0
- data/rdoc-8.0.0/lib/rdoc/text.rb +244 -0
- data/rdoc-8.0.0/lib/rdoc/token_stream.rb +104 -0
- data/rdoc-8.0.0/lib/rdoc/tom_doc.rb +257 -0
- data/rdoc-8.0.0/lib/rdoc/version.rb +10 -0
- data/rdoc-8.0.0/lib/rdoc.rb +239 -0
- data/rdoc-8.0.0/lib/rubygems_plugin.rb +14 -0
- data/rdoc-8.0.0/man/ri.1 +249 -0
- data/rdoc-8.0.0/rdoc-logo.svg +43 -0
- data/rdoc-8.0.0/rdoc.gemspec +74 -0
- metadata +256 -0
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
##
|
|
3
|
+
# A file loaded by \#require
|
|
4
|
+
|
|
5
|
+
class RDoc::Require < RDoc::CodeObject
|
|
6
|
+
|
|
7
|
+
##
|
|
8
|
+
# Name of the required file
|
|
9
|
+
|
|
10
|
+
attr_accessor :name
|
|
11
|
+
|
|
12
|
+
##
|
|
13
|
+
# Creates a new Require that loads +name+ with +comment+
|
|
14
|
+
|
|
15
|
+
def initialize(name, comment)
|
|
16
|
+
super()
|
|
17
|
+
@name = name.gsub(/'|"/, "") #'
|
|
18
|
+
@top_level = nil
|
|
19
|
+
self.comment = comment
|
|
20
|
+
end
|
|
21
|
+
|
|
22
|
+
def inspect # :nodoc:
|
|
23
|
+
"#<%s:0x%x require '%s' in %s>" % [
|
|
24
|
+
self.class,
|
|
25
|
+
object_id,
|
|
26
|
+
@name,
|
|
27
|
+
@parent ? @parent.base_name : '(unknown)'
|
|
28
|
+
]
|
|
29
|
+
end
|
|
30
|
+
|
|
31
|
+
def to_s # :nodoc:
|
|
32
|
+
"require #{name} in: #{parent}"
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
##
|
|
36
|
+
# The RDoc::TopLevel corresponding to this require, or +nil+ if not found.
|
|
37
|
+
|
|
38
|
+
def top_level
|
|
39
|
+
@top_level ||= begin
|
|
40
|
+
tl = RDoc::TopLevel.all_files_hash[name + '.rb']
|
|
41
|
+
|
|
42
|
+
if tl.nil? and RDoc::TopLevel.all_files.first.full_name =~ %r(^lib/) then
|
|
43
|
+
# second chance
|
|
44
|
+
tl = RDoc::TopLevel.all_files_hash['lib/' + name + '.rb']
|
|
45
|
+
end
|
|
46
|
+
|
|
47
|
+
tl
|
|
48
|
+
end
|
|
49
|
+
end
|
|
50
|
+
|
|
51
|
+
end
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
##
|
|
3
|
+
# A singleton class
|
|
4
|
+
|
|
5
|
+
class RDoc::SingleClass < RDoc::ClassModule
|
|
6
|
+
|
|
7
|
+
##
|
|
8
|
+
# Adds the superclass to the included modules.
|
|
9
|
+
|
|
10
|
+
def ancestors
|
|
11
|
+
superclass ? super + [superclass] : super
|
|
12
|
+
end
|
|
13
|
+
|
|
14
|
+
def aref_prefix # :nodoc:
|
|
15
|
+
'sclass'
|
|
16
|
+
end
|
|
17
|
+
|
|
18
|
+
##
|
|
19
|
+
# The definition of this singleton class, <tt>class << MyClassName</tt>
|
|
20
|
+
|
|
21
|
+
def definition
|
|
22
|
+
"class << #{full_name}"
|
|
23
|
+
end
|
|
24
|
+
|
|
25
|
+
def pretty_print(q) # :nodoc:
|
|
26
|
+
q.group 2, "[class << #{full_name}", "]" do
|
|
27
|
+
next
|
|
28
|
+
end
|
|
29
|
+
end
|
|
30
|
+
end
|
|
@@ -0,0 +1,286 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
##
|
|
3
|
+
# A TopLevel context is a representation of the contents of a single file
|
|
4
|
+
|
|
5
|
+
class RDoc::TopLevel < RDoc::Context
|
|
6
|
+
|
|
7
|
+
MARSHAL_VERSION = 0 # :nodoc:
|
|
8
|
+
|
|
9
|
+
##
|
|
10
|
+
# Relative name of this file
|
|
11
|
+
|
|
12
|
+
attr_accessor :relative_name
|
|
13
|
+
|
|
14
|
+
##
|
|
15
|
+
# Absolute name of this file
|
|
16
|
+
|
|
17
|
+
attr_accessor :absolute_name
|
|
18
|
+
|
|
19
|
+
##
|
|
20
|
+
# Base name of this file
|
|
21
|
+
|
|
22
|
+
attr_reader :base_name
|
|
23
|
+
|
|
24
|
+
##
|
|
25
|
+
# Base name of this file without the extension
|
|
26
|
+
|
|
27
|
+
attr_reader :page_name
|
|
28
|
+
|
|
29
|
+
##
|
|
30
|
+
# All the classes or modules that were declared in
|
|
31
|
+
# this file. These are assigned to either +#classes_hash+
|
|
32
|
+
# or +#modules_hash+ once we know what they really are.
|
|
33
|
+
|
|
34
|
+
attr_reader :classes_or_modules
|
|
35
|
+
|
|
36
|
+
##
|
|
37
|
+
# The parser class that processed this file
|
|
38
|
+
|
|
39
|
+
attr_reader :parser
|
|
40
|
+
|
|
41
|
+
##
|
|
42
|
+
# Creates a new TopLevel for the file at +absolute_name+. If documentation
|
|
43
|
+
# is being generated outside the source dir +relative_name+ is relative to
|
|
44
|
+
# the source directory.
|
|
45
|
+
|
|
46
|
+
def initialize(absolute_name, relative_name = absolute_name)
|
|
47
|
+
super()
|
|
48
|
+
@name = nil
|
|
49
|
+
@absolute_name = absolute_name
|
|
50
|
+
@relative_name = relative_name
|
|
51
|
+
@parser = nil
|
|
52
|
+
|
|
53
|
+
if relative_name
|
|
54
|
+
@base_name = File.basename(relative_name)
|
|
55
|
+
@page_name = @base_name.sub(/\.(rb|rdoc|txt|md)\z/i, '')
|
|
56
|
+
else
|
|
57
|
+
@base_name = nil
|
|
58
|
+
@page_name = nil
|
|
59
|
+
end
|
|
60
|
+
|
|
61
|
+
@classes_or_modules = []
|
|
62
|
+
end
|
|
63
|
+
|
|
64
|
+
##
|
|
65
|
+
# Sets the parser for this toplevel context, also the store.
|
|
66
|
+
|
|
67
|
+
def parser=(val)
|
|
68
|
+
@parser = val
|
|
69
|
+
@store&.cache_text_file(relative_name)
|
|
70
|
+
@parser
|
|
71
|
+
end
|
|
72
|
+
|
|
73
|
+
##
|
|
74
|
+
# An RDoc::TopLevel is equal to another with the same relative_name
|
|
75
|
+
|
|
76
|
+
def ==(other)
|
|
77
|
+
self.class === other and @relative_name == other.relative_name
|
|
78
|
+
end
|
|
79
|
+
|
|
80
|
+
alias eql? ==
|
|
81
|
+
|
|
82
|
+
##
|
|
83
|
+
# Adds +an_alias+ to +Object+ instead of +self+.
|
|
84
|
+
|
|
85
|
+
def add_alias(an_alias)
|
|
86
|
+
object_class.record_location self
|
|
87
|
+
return an_alias unless @document_self
|
|
88
|
+
object_class.add_alias an_alias
|
|
89
|
+
end
|
|
90
|
+
|
|
91
|
+
##
|
|
92
|
+
# Adds +constant+ to +Object+ instead of +self+.
|
|
93
|
+
|
|
94
|
+
def add_constant(constant)
|
|
95
|
+
object_class.record_location self
|
|
96
|
+
return constant unless @document_self
|
|
97
|
+
object_class.add_constant constant
|
|
98
|
+
end
|
|
99
|
+
|
|
100
|
+
##
|
|
101
|
+
# Adds +include+ to +Object+ instead of +self+.
|
|
102
|
+
|
|
103
|
+
def add_include(include)
|
|
104
|
+
object_class.record_location self
|
|
105
|
+
return include unless @document_self
|
|
106
|
+
object_class.add_include include
|
|
107
|
+
end
|
|
108
|
+
|
|
109
|
+
##
|
|
110
|
+
# Adds +method+ to +Object+ instead of +self+.
|
|
111
|
+
|
|
112
|
+
def add_method(method)
|
|
113
|
+
object_class.record_location self
|
|
114
|
+
return method unless @document_self
|
|
115
|
+
object_class.add_method method
|
|
116
|
+
end
|
|
117
|
+
|
|
118
|
+
##
|
|
119
|
+
# Adds class or module +mod+. Used in the building phase
|
|
120
|
+
# by the Ruby parser.
|
|
121
|
+
|
|
122
|
+
def add_to_classes_or_modules(mod)
|
|
123
|
+
@classes_or_modules << mod
|
|
124
|
+
end
|
|
125
|
+
|
|
126
|
+
alias name base_name
|
|
127
|
+
|
|
128
|
+
##
|
|
129
|
+
# See RDoc::TopLevel::find_class_or_module
|
|
130
|
+
#--
|
|
131
|
+
# TODO Why do we search through all classes/modules found, not just the
|
|
132
|
+
# ones of this instance?
|
|
133
|
+
|
|
134
|
+
def find_class_or_module(name)
|
|
135
|
+
@store.find_class_or_module name
|
|
136
|
+
end
|
|
137
|
+
|
|
138
|
+
##
|
|
139
|
+
# Finds a class or module named +symbol+
|
|
140
|
+
|
|
141
|
+
def find_local_symbol(symbol)
|
|
142
|
+
find_class_or_module(symbol) || super
|
|
143
|
+
end
|
|
144
|
+
|
|
145
|
+
##
|
|
146
|
+
# Finds a module or class with +name+
|
|
147
|
+
|
|
148
|
+
def find_module_named(name)
|
|
149
|
+
find_class_or_module(name)
|
|
150
|
+
end
|
|
151
|
+
|
|
152
|
+
alias get_module_named find_module_named
|
|
153
|
+
|
|
154
|
+
##
|
|
155
|
+
# Returns the relative name of this file
|
|
156
|
+
|
|
157
|
+
def full_name
|
|
158
|
+
@relative_name
|
|
159
|
+
end
|
|
160
|
+
|
|
161
|
+
##
|
|
162
|
+
# An RDoc::TopLevel has the same hash as another with the same
|
|
163
|
+
# relative_name
|
|
164
|
+
|
|
165
|
+
def hash
|
|
166
|
+
@relative_name.hash
|
|
167
|
+
end
|
|
168
|
+
|
|
169
|
+
##
|
|
170
|
+
# URL for this with a +prefix+
|
|
171
|
+
|
|
172
|
+
def http_url
|
|
173
|
+
@relative_name.tr('.', '_') + '.html'
|
|
174
|
+
end
|
|
175
|
+
|
|
176
|
+
def inspect # :nodoc:
|
|
177
|
+
"#<%s:0x%x %p modules: %p classes: %p>" % [
|
|
178
|
+
self.class, object_id,
|
|
179
|
+
base_name,
|
|
180
|
+
@modules.map { |n, m| m },
|
|
181
|
+
@classes.map { |n, c| c }
|
|
182
|
+
]
|
|
183
|
+
end
|
|
184
|
+
|
|
185
|
+
##
|
|
186
|
+
# Dumps this TopLevel for use by ri. See also #marshal_load
|
|
187
|
+
|
|
188
|
+
def marshal_dump
|
|
189
|
+
[
|
|
190
|
+
MARSHAL_VERSION,
|
|
191
|
+
@relative_name,
|
|
192
|
+
@parser,
|
|
193
|
+
parse(@comment),
|
|
194
|
+
]
|
|
195
|
+
end
|
|
196
|
+
|
|
197
|
+
##
|
|
198
|
+
# Loads this TopLevel from +array+.
|
|
199
|
+
|
|
200
|
+
def marshal_load(array) # :nodoc:
|
|
201
|
+
initialize array[1]
|
|
202
|
+
|
|
203
|
+
@parser = array[2]
|
|
204
|
+
@comment = RDoc::Comment.from_document array[3]
|
|
205
|
+
end
|
|
206
|
+
|
|
207
|
+
##
|
|
208
|
+
# Returns the NormalClass "Object", creating it if not found.
|
|
209
|
+
#
|
|
210
|
+
# Records +self+ as a location in "Object".
|
|
211
|
+
|
|
212
|
+
def object_class
|
|
213
|
+
@object_class ||= begin
|
|
214
|
+
oc = @store.find_class_named('Object') || add_class(RDoc::NormalClass, 'Object')
|
|
215
|
+
oc.record_location self
|
|
216
|
+
oc
|
|
217
|
+
end
|
|
218
|
+
end
|
|
219
|
+
|
|
220
|
+
##
|
|
221
|
+
# Path to this file for use with HTML generator output.
|
|
222
|
+
|
|
223
|
+
def path
|
|
224
|
+
base = if options.main_page == full_name
|
|
225
|
+
'index.html'
|
|
226
|
+
else
|
|
227
|
+
http_url
|
|
228
|
+
end
|
|
229
|
+
|
|
230
|
+
prefix = options.file_path_prefix
|
|
231
|
+
return base unless prefix
|
|
232
|
+
File.join(prefix, base)
|
|
233
|
+
end
|
|
234
|
+
|
|
235
|
+
def pretty_print(q) # :nodoc:
|
|
236
|
+
q.group 2, "[#{self.class}: ", "]" do
|
|
237
|
+
q.text "base name: #{base_name.inspect}"
|
|
238
|
+
q.breakable
|
|
239
|
+
|
|
240
|
+
items = @modules.map { |n, m| m }
|
|
241
|
+
items.concat @modules.map { |n, c| c }
|
|
242
|
+
q.seplist items do |mod| q.pp mod end
|
|
243
|
+
end
|
|
244
|
+
end
|
|
245
|
+
|
|
246
|
+
##
|
|
247
|
+
# Search record used by RDoc::Generator::JsonIndex
|
|
248
|
+
#
|
|
249
|
+
# TODO: Remove this method after dropping the darkfish theme and JsonIndex generator.
|
|
250
|
+
# Use #search_snippet instead for getting documentation snippets.
|
|
251
|
+
|
|
252
|
+
def search_record
|
|
253
|
+
return unless @parser < RDoc::Parser::Text
|
|
254
|
+
|
|
255
|
+
[
|
|
256
|
+
page_name,
|
|
257
|
+
'',
|
|
258
|
+
page_name,
|
|
259
|
+
'',
|
|
260
|
+
path,
|
|
261
|
+
'',
|
|
262
|
+
search_snippet,
|
|
263
|
+
]
|
|
264
|
+
end
|
|
265
|
+
|
|
266
|
+
##
|
|
267
|
+
# Returns an HTML snippet of the comment for search results.
|
|
268
|
+
|
|
269
|
+
def search_snippet
|
|
270
|
+
return '' if @comment.empty?
|
|
271
|
+
|
|
272
|
+
snippet(@comment)
|
|
273
|
+
end
|
|
274
|
+
|
|
275
|
+
##
|
|
276
|
+
# Is this TopLevel from a text file instead of a source code file?
|
|
277
|
+
|
|
278
|
+
def text?
|
|
279
|
+
@parser and @parser.include? RDoc::Parser::Text
|
|
280
|
+
end
|
|
281
|
+
|
|
282
|
+
def to_s # :nodoc:
|
|
283
|
+
"file #{full_name}"
|
|
284
|
+
end
|
|
285
|
+
|
|
286
|
+
end
|