my_yard 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.
Files changed (151) hide show
  1. checksums.yaml +7 -0
  2. data/README.md +5 -0
  3. data/doc/GlobalSettings.html +556 -0
  4. data/doc/MyYard.html +1203 -0
  5. data/doc/TreeContext/Alternator.html +301 -0
  6. data/doc/TreeContext.html +471 -0
  7. data/doc/YardTheme.html +750 -0
  8. data/doc/YardThemeDefaults.html +418 -0
  9. data/doc/_index.html +174 -0
  10. data/doc/class_and_method_list.html +842 -0
  11. data/doc/class_list.html +51 -0
  12. data/doc/css/common.css +36 -0
  13. data/doc/css/full_list.css +62 -0
  14. data/doc/css/style.css +476 -0
  15. data/doc/file.README.html +79 -0
  16. data/doc/file_list.html +56 -0
  17. data/doc/frames.html +17 -0
  18. data/doc/index.html +79 -0
  19. data/doc/js/app.js +243 -0
  20. data/doc/js/full_list.js +213 -0
  21. data/doc/js/jquery.js +4 -0
  22. data/doc/just_file_list.html +37 -0
  23. data/doc/method_list.html +835 -0
  24. data/full_list.css +58 -0
  25. data/home_my_yard/templates/visualruby/class/dot/setup.rb +6 -0
  26. data/home_my_yard/templates/visualruby/class/dot/superklass.erb +3 -0
  27. data/home_my_yard/templates/visualruby/class/html/constructor_details.erb +8 -0
  28. data/home_my_yard/templates/visualruby/class/html/setup.rb +1 -0
  29. data/home_my_yard/templates/visualruby/class/html/subclasses.erb +4 -0
  30. data/home_my_yard/templates/visualruby/class/setup.rb +36 -0
  31. data/home_my_yard/templates/visualruby/class/text/setup.rb +11 -0
  32. data/home_my_yard/templates/visualruby/class/text/subclasses.erb +5 -0
  33. data/home_my_yard/templates/visualruby/constant/text/header.erb +11 -0
  34. data/home_my_yard/templates/visualruby/constant/text/setup.rb +3 -0
  35. data/home_my_yard/templates/visualruby/docstring/html/abstract.erb +4 -0
  36. data/home_my_yard/templates/visualruby/docstring/html/deprecated.erb +1 -0
  37. data/home_my_yard/templates/visualruby/docstring/html/index.erb +5 -0
  38. data/home_my_yard/templates/visualruby/docstring/html/note.erb +6 -0
  39. data/home_my_yard/templates/visualruby/docstring/html/private.erb +4 -0
  40. data/home_my_yard/templates/visualruby/docstring/html/returns_void.erb +1 -0
  41. data/home_my_yard/templates/visualruby/docstring/html/text.erb +1 -0
  42. data/home_my_yard/templates/visualruby/docstring/html/todo.erb +6 -0
  43. data/home_my_yard/templates/visualruby/docstring/setup.rb +51 -0
  44. data/home_my_yard/templates/visualruby/docstring/text/abstract.erb +2 -0
  45. data/home_my_yard/templates/visualruby/docstring/text/deprecated.erb +2 -0
  46. data/home_my_yard/templates/visualruby/docstring/text/index.erb +2 -0
  47. data/home_my_yard/templates/visualruby/docstring/text/note.erb +4 -0
  48. data/home_my_yard/templates/visualruby/docstring/text/private.erb +2 -0
  49. data/home_my_yard/templates/visualruby/docstring/text/returns_void.erb +1 -0
  50. data/home_my_yard/templates/visualruby/docstring/text/text.erb +1 -0
  51. data/home_my_yard/templates/visualruby/docstring/text/todo.erb +4 -0
  52. data/home_my_yard/templates/visualruby/fulldoc/html/class_and_method.erb +42 -0
  53. data/home_my_yard/templates/visualruby/fulldoc/html/css/common.css +1 -0
  54. data/home_my_yard/templates/visualruby/fulldoc/html/css/full_list.css +62 -0
  55. data/home_my_yard/templates/visualruby/fulldoc/html/css/style.css +476 -0
  56. data/home_my_yard/templates/visualruby/fulldoc/html/frames.erb +17 -0
  57. data/home_my_yard/templates/visualruby/fulldoc/html/full_list.erb +37 -0
  58. data/home_my_yard/templates/visualruby/fulldoc/html/full_list_class.erb +2 -0
  59. data/home_my_yard/templates/visualruby/fulldoc/html/full_list_file.erb +7 -0
  60. data/home_my_yard/templates/visualruby/fulldoc/html/full_list_method.erb +10 -0
  61. data/home_my_yard/templates/visualruby/fulldoc/html/js/app.js +243 -0
  62. data/home_my_yard/templates/visualruby/fulldoc/html/js/full_list.js +213 -0
  63. data/home_my_yard/templates/visualruby/fulldoc/html/js/jquery.js +4 -0
  64. data/home_my_yard/templates/visualruby/fulldoc/html/just_files.erb +33 -0
  65. data/home_my_yard/templates/visualruby/fulldoc/html/setup.rb +267 -0
  66. data/home_my_yard/templates/visualruby/layout/dot/header.erb +6 -0
  67. data/home_my_yard/templates/visualruby/layout/dot/setup.rb +14 -0
  68. data/home_my_yard/templates/visualruby/layout/html/breadcrumb.erb +11 -0
  69. data/home_my_yard/templates/visualruby/layout/html/files.erb +11 -0
  70. data/home_my_yard/templates/visualruby/layout/html/footer.erb +5 -0
  71. data/home_my_yard/templates/visualruby/layout/html/headers.erb +15 -0
  72. data/home_my_yard/templates/visualruby/layout/html/index.erb +2 -0
  73. data/home_my_yard/templates/visualruby/layout/html/layout.erb +30 -0
  74. data/home_my_yard/templates/visualruby/layout/html/listing.erb +4 -0
  75. data/home_my_yard/templates/visualruby/layout/html/objects.erb +32 -0
  76. data/home_my_yard/templates/visualruby/layout/html/script_setup.erb +4 -0
  77. data/home_my_yard/templates/visualruby/layout/html/search.erb +13 -0
  78. data/home_my_yard/templates/visualruby/layout/html/setup.rb +88 -0
  79. data/home_my_yard/templates/visualruby/method/html/header.erb +17 -0
  80. data/home_my_yard/templates/visualruby/method/setup.rb +3 -0
  81. data/home_my_yard/templates/visualruby/method/text/header.erb +1 -0
  82. data/home_my_yard/templates/visualruby/method_details/html/header.erb +3 -0
  83. data/home_my_yard/templates/visualruby/method_details/html/method_signature.erb +25 -0
  84. data/home_my_yard/templates/visualruby/method_details/html/source.erb +10 -0
  85. data/home_my_yard/templates/visualruby/method_details/setup.rb +10 -0
  86. data/home_my_yard/templates/visualruby/method_details/text/header.erb +10 -0
  87. data/home_my_yard/templates/visualruby/method_details/text/method_signature.erb +12 -0
  88. data/home_my_yard/templates/visualruby/method_details/text/setup.rb +10 -0
  89. data/home_my_yard/templates/visualruby/module/dot/child.erb +1 -0
  90. data/home_my_yard/templates/visualruby/module/dot/dependencies.erb +3 -0
  91. data/home_my_yard/templates/visualruby/module/dot/header.erb +6 -0
  92. data/home_my_yard/templates/visualruby/module/dot/info.erb +14 -0
  93. data/home_my_yard/templates/visualruby/module/dot/setup.rb +14 -0
  94. data/home_my_yard/templates/visualruby/module/html/attribute_details.erb +10 -0
  95. data/home_my_yard/templates/visualruby/module/html/attribute_summary.erb +8 -0
  96. data/home_my_yard/templates/visualruby/module/html/box_info.erb +43 -0
  97. data/home_my_yard/templates/visualruby/module/html/children.erb +8 -0
  98. data/home_my_yard/templates/visualruby/module/html/constant_summary.erb +13 -0
  99. data/home_my_yard/templates/visualruby/module/html/defines.erb +3 -0
  100. data/home_my_yard/templates/visualruby/module/html/header.erb +5 -0
  101. data/home_my_yard/templates/visualruby/module/html/inherited_attributes.erb +14 -0
  102. data/home_my_yard/templates/visualruby/module/html/inherited_constants.erb +8 -0
  103. data/home_my_yard/templates/visualruby/module/html/inherited_methods.erb +19 -0
  104. data/home_my_yard/templates/visualruby/module/html/item_summary.erb +40 -0
  105. data/home_my_yard/templates/visualruby/module/html/method_details_list.erb +9 -0
  106. data/home_my_yard/templates/visualruby/module/html/method_summary.erb +14 -0
  107. data/home_my_yard/templates/visualruby/module/html/methodmissing.erb +12 -0
  108. data/home_my_yard/templates/visualruby/module/html/pre_docstring.erb +1 -0
  109. data/home_my_yard/templates/visualruby/module/setup.rb +164 -0
  110. data/home_my_yard/templates/visualruby/module/text/children.erb +10 -0
  111. data/home_my_yard/templates/visualruby/module/text/class_meths_list.erb +8 -0
  112. data/home_my_yard/templates/visualruby/module/text/extends.erb +8 -0
  113. data/home_my_yard/templates/visualruby/module/text/header.erb +7 -0
  114. data/home_my_yard/templates/visualruby/module/text/includes.erb +8 -0
  115. data/home_my_yard/templates/visualruby/module/text/instance_meths_list.erb +8 -0
  116. data/home_my_yard/templates/visualruby/module/text/setup.rb +12 -0
  117. data/home_my_yard/templates/visualruby/onefile/html/files.erb +5 -0
  118. data/home_my_yard/templates/visualruby/onefile/html/headers.erb +6 -0
  119. data/home_my_yard/templates/visualruby/onefile/html/layout.erb +17 -0
  120. data/home_my_yard/templates/visualruby/onefile/html/readme.erb +3 -0
  121. data/home_my_yard/templates/visualruby/onefile/html/setup.rb +61 -0
  122. data/home_my_yard/templates/visualruby/root/dot/child.erb +3 -0
  123. data/home_my_yard/templates/visualruby/root/dot/setup.rb +5 -0
  124. data/home_my_yard/templates/visualruby/root/html/setup.rb +1 -0
  125. data/home_my_yard/templates/visualruby/tags/html/example.erb +11 -0
  126. data/home_my_yard/templates/visualruby/tags/html/index.erb +3 -0
  127. data/home_my_yard/templates/visualruby/tags/html/option.erb +24 -0
  128. data/home_my_yard/templates/visualruby/tags/html/overload.erb +14 -0
  129. data/home_my_yard/templates/visualruby/tags/html/see.erb +8 -0
  130. data/home_my_yard/templates/visualruby/tags/html/tag.erb +20 -0
  131. data/home_my_yard/templates/visualruby/tags/setup.rb +55 -0
  132. data/home_my_yard/templates/visualruby/tags/text/example.erb +12 -0
  133. data/home_my_yard/templates/visualruby/tags/text/index.erb +1 -0
  134. data/home_my_yard/templates/visualruby/tags/text/option.erb +20 -0
  135. data/home_my_yard/templates/visualruby/tags/text/overload.erb +19 -0
  136. data/home_my_yard/templates/visualruby/tags/text/see.erb +11 -0
  137. data/home_my_yard/templates/visualruby/tags/text/tag.erb +13 -0
  138. data/home_my_yard/themes/visualruby.yaml +36 -0
  139. data/install.md +11 -0
  140. data/my_yard +31 -0
  141. data/my_yard.gemspec +20 -0
  142. data/src/GlobalSettings.rb +22 -0
  143. data/src/MyYard.rb +195 -0
  144. data/src/YardTheme.rb +77 -0
  145. data/src/YardThemeDefaults.rb +100 -0
  146. data/src/glade/MyYard.glade +595 -0
  147. data/src/glade/MyYard.glade~ +595 -0
  148. data/src/glade/YardTheme.glade +791 -0
  149. data/src/glade/YardTheme.glade~ +812 -0
  150. data/style.css +474 -0
  151. metadata +224 -0
@@ -0,0 +1,30 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <%= erb(:headers) %>
5
+ </head>
6
+ <body>
7
+ <div class="nav_wrap">
8
+ <iframe id="nav" src="<%= @nav_url_file %>"></iframe>
9
+ <div id="resizer"></div>
10
+ </div>
11
+
12
+ <div id="main" tabindex="-1">
13
+ <!-- <div id="header">
14
+ <%= erb(:breadcrumb) %>
15
+ <%= erb(:search) %>
16
+ <div class="clear"></div>
17
+ </div>
18
+
19
+ <iframe id="search_frame" src="<%= @nav_url %>"></iframe>
20
+ -->
21
+ <div id="content"><%= yieldall %></div>
22
+
23
+ <%= erb(:footer) %>
24
+ </div>
25
+ <div id="resizer"></div>
26
+ <div class="nav_wrap">
27
+ <iframe id="nav" src="<%= @nav_url_class %>" ></iframe>
28
+ </div>
29
+ </body>
30
+ </html>
@@ -0,0 +1,4 @@
1
+ <div id="listing">
2
+ <h1 class="alphaindex">Alphabetic Index</h1>
3
+ <%= yieldall %>
4
+ </div>
@@ -0,0 +1,32 @@
1
+ <h2>Namespace Listing A-Z</h2>
2
+
3
+ <% if Registry.root.meths(:included => false).size > 0 %>
4
+ <ul class="toplevel"><li><%= linkify(Registry.root) %></li></ul>
5
+ <% end %>
6
+
7
+ <% i = 0 %>
8
+ <table>
9
+ <tr>
10
+ <td valign='top' width="33%">
11
+ <% @objects_by_letter.sort_by {|l,o| l.to_s }.each do |letter, objects| %>
12
+ <% if (i += 1) % 8 == 0 %>
13
+ </td><td valign='top' width="33%">
14
+ <% i = 0 %>
15
+ <% end %>
16
+ <ul id="alpha_<%= letter %>" class="alpha">
17
+ <li class="letter"><%= letter %></li>
18
+ <ul>
19
+ <% objects.each do |obj| %>
20
+ <li>
21
+ <%= linkify obj, obj.name %>
22
+ <% if !obj.namespace.root? %>
23
+ <small>(<%= obj.namespace.path %>)</small>
24
+ <% end %>
25
+ </li>
26
+ <% end %>
27
+ </ul>
28
+ </ul>
29
+ <% end %>
30
+ </td>
31
+ </tr>
32
+ </table>
@@ -0,0 +1,4 @@
1
+ <script type="text/javascript" charset="utf-8">
2
+ pathId = <%= @path ? @path.inspect : 'null' %>;
3
+ relpath = '<%= u = url_for(''); u + (u != '' ? '/' : '') %>';
4
+ </script>
@@ -0,0 +1,13 @@
1
+ <div id="search">
2
+ <% [menu_lists.first].each do |field| %>
3
+ <a class="full_list_link" id="<%= field[:type] %>_list_link"
4
+ href="<%= url_for_list(field[:type]) %>">
5
+
6
+ <svg width="24" height="24">
7
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
8
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
9
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
10
+ </svg>
11
+ </a>
12
+ <% end %>
13
+ </div>
@@ -0,0 +1,88 @@
1
+ def init
2
+ @breadcrumb = []
3
+ if @onefile
4
+ sections :layout
5
+ elsif @file
6
+ if @file.attributes[:namespace]
7
+ @object = options.object = Registry.at(@file.attributes[:namespace]) || Registry.root
8
+ end
9
+ @breadcrumb_title = "File: " + @file.title
10
+ @page_title = @breadcrumb_title
11
+ sections :layout, [:diskfile]
12
+ elsif @contents
13
+ sections :layout, [:contents]
14
+ else
15
+ case object
16
+ when '_index.html'
17
+ @page_title = options.title
18
+ sections :layout, [:index, [:listing, [:files, :objects]]]
19
+ when CodeObjects::Base
20
+ unless object.root?
21
+ cur = object.namespace
22
+ while !cur.root?
23
+ @breadcrumb.unshift(cur)
24
+ cur = cur.namespace
25
+ end
26
+ end
27
+
28
+ @page_title = format_object_title(object)
29
+ type = object.root? ? :module : object.type
30
+ sections :layout, [T(type)]
31
+ end
32
+ end
33
+ end
34
+
35
+ def contents
36
+ @contents
37
+ end
38
+
39
+ def index
40
+ @objects_by_letter = {}
41
+ objects = Registry.all(:class, :module).sort_by {|o| o.name.to_s }
42
+ objects = run_verifier(objects)
43
+ objects.each {|o| (@objects_by_letter[o.name.to_s[0,1].upcase] ||= []) << o }
44
+ erb(:index)
45
+ end
46
+
47
+ def layout
48
+ # eric @nav_url = url_for_list(!@file || options.index ? 'class' : 'file')
49
+ @nav_url_file = url_for_list("just_file")
50
+ @nav_url_class = url_for_list("class_and_method")
51
+ if !object || object.is_a?(String)
52
+ @path = nil
53
+ elsif @file
54
+ @path = @file.path
55
+ elsif !object.is_a?(YARD::CodeObjects::NamespaceObject)
56
+ @path = object.parent.path
57
+ else
58
+ @path = object.path
59
+ end
60
+
61
+ erb(:layout)
62
+ end
63
+
64
+ def diskfile
65
+ @file.attributes[:markup] ||= markup_for_file('', @file.filename)
66
+ data = htmlify(@file.contents, @file.attributes[:markup])
67
+ "<div id='filecontents'>" + data + "</div>"
68
+ end
69
+
70
+ # @return [Array<String>] core javascript files for layout
71
+ # @since 0.7.0
72
+ def javascripts
73
+ %w(js/jquery.js js/app.js)
74
+ end
75
+
76
+ # @return [Array<String>] core stylesheets for the layout
77
+ # @since 0.7.0
78
+ def stylesheets
79
+ %w(css/style.css css/common.css)
80
+ end
81
+
82
+ # @return [Array<Hash{Symbol=>String}>] the list of search links and drop-down menus
83
+ # @since 0.7.0
84
+ def menu_lists
85
+ [ { :type => 'class', :title => 'Classes', :search_title => 'Class List' },
86
+ { :type => 'method', :title => 'Methods', :search_title => 'Method List' },
87
+ { :type => 'file', :title => 'Files', :search_title => 'File List' } ]
88
+ end
@@ -0,0 +1,17 @@
1
+ <h1>Method: <%= object.path %></h1>
2
+ <div class="box_info">
3
+ <dl>
4
+ <dt class="">Defined in:</dt>
5
+ <dd class="">
6
+ <%= object.file %><% if object.files.size > 1 %><span class="defines">,<br />
7
+ <%= object.files[1..-1].map {|f| f.first }.join(",<br /> ") %></div>
8
+ <% end %>
9
+ </dd>
10
+ </dl>
11
+ </div>
12
+
13
+ <div class="method_details_list">
14
+ <div id="method_details">
15
+ <%= yieldall :index => 0 %>
16
+ </div>
17
+ </div>
@@ -0,0 +1,3 @@
1
+ def init
2
+ sections :header, [T('method_details')]
3
+ end
@@ -0,0 +1 @@
1
+ <%= yieldall %>
@@ -0,0 +1,3 @@
1
+ <div class="method_details <%= @index == 0 ? 'first' : '' %>">
2
+ <%= yieldall %>
3
+ </div>
@@ -0,0 +1,25 @@
1
+ <h3 class="signature <%= 'first' if @index == 0 %>" id="<%= anchor_for(object) %>">
2
+ <% if object.tags(:overload).size == 1 %>
3
+ <%= signature(object.tag(:overload), false) %>
4
+ <% elsif object.tags(:overload).size > 1 %>
5
+ <% object.tags(:overload).each do |overload| %>
6
+ <span class="overload"><%= signature(overload, false) %></span>
7
+ <% end %>
8
+ <% else %>
9
+ <%= signature(object, false) %>
10
+ <% end %>
11
+
12
+ <% if object.aliases.size > 0 %>
13
+ <span class="aliases">Also known as:
14
+ <span class="names"><%= object.aliases.map {|o|
15
+ "<span id='#{anchor_for(o)}'>" + h(o.name.to_s) + "</span>" }.join(", ") %></span>
16
+ </span>
17
+ <% end %>
18
+
19
+ <% if owner != object.namespace %>
20
+ <span class="not_defined_here">
21
+ Originally defined in <%= object.namespace.type %>
22
+ <%= linkify object, owner.relative_path(object.namespace) %>
23
+ </span>
24
+ <% end %>
25
+ </h3>
@@ -0,0 +1,10 @@
1
+ <table class="source_code">
2
+ <tr>
3
+ <td>
4
+ <pre class="lines"><%= "\n\n\n" %><%= h format_lines(object) %></pre>
5
+ </td>
6
+ <td>
7
+ <pre class="code"><span class="info file"># File '<%= h object.file %>'<% if object.line %>, line <%= object.line %><% end %></span><%= "\n\n" %><%= html_syntax_highlight object.source %></pre>
8
+ </td>
9
+ </tr>
10
+ </table>
@@ -0,0 +1,10 @@
1
+ def init
2
+ sections :header, [:method_signature, T('docstring'), :source]
3
+ end
4
+
5
+ def source
6
+ return if owner != object.namespace
7
+ return if Tags::OverloadTag === object
8
+ return if object.source.nil?
9
+ erb(:source)
10
+ end
@@ -0,0 +1,10 @@
1
+ <%= title_align_right format_object_title(object) %>
2
+
3
+ <%= align_right "(Defined in: #{object.file})" %>
4
+ <% if object.aliases.size > 0 %>
5
+
6
+ <%= align_right "(Also known as: #{object.aliases.map {|o| o.name(true).to_s }.join(',')})" %>
7
+ <% end %>
8
+
9
+ <%= yieldall %>
10
+
@@ -0,0 +1,12 @@
1
+
2
+ <% if object.tags(:overload).size == 1 %>
3
+ <%= indent wrap(signature(object.tag(:overload))) %>
4
+ <% elsif object.tags(:overload).size > 1 %>
5
+ <% object.tags(:overload).each do |overload| %>
6
+ <%= indent wrap(signature(overload)) %>
7
+ <% end %>
8
+ <% else %>
9
+ <%= indent wrap(signature(object)) %>
10
+ <% end %>
11
+ <%= hr %>
12
+
@@ -0,0 +1,10 @@
1
+ def init
2
+ super
3
+ sections.last.pop
4
+ end
5
+
6
+ def format_object_title(object)
7
+ title = "Method: #{object.name(true)}"
8
+ title += " (#{object.namespace})" if !object.namespace.root?
9
+ title
10
+ end
@@ -0,0 +1 @@
1
+ <%= format_path object %> [label="{<%= yieldall.gsub("\n", '') %>}" rank=sink];
@@ -0,0 +1,3 @@
1
+ <% object.mixins(:instance).each do |obj| %>
2
+ <%= format_path object %> -> <%= format_path obj %> [style=dotted arrowType=none];
3
+ <% end %>
@@ -0,0 +1,6 @@
1
+ subgraph cluster_<%= format_path object %> {
2
+ label = "<%= h(object.name) unless object.path == "" %>"; labelloc=b;
3
+ <% for obj in @modules %>
4
+ <%= yieldall :object => obj %>
5
+ <% end %>
6
+ }
@@ -0,0 +1,14 @@
1
+ <%= object.type %> <%= h object.name %>
2
+ <% if options.full %>
3
+ |
4
+ <% object.attributes.each do |scope, list| %>
5
+ <% list.sort_by {|name, rw| name.to_s }.each do |name, rw| %>
6
+ <%= uml_visibility(rw.values.compact.first) %> <%= h (rw[:read]||rw[:write]).name(true).gsub(/=$/,'') %> [<%= 'R' if rw[:read] %><%= 'W' if rw[:write] %>]\l
7
+ <% end %>
8
+ <% end %>
9
+ |
10
+ <% method_listing.each do |obj| %>
11
+ <%= uml_visibility obj %> <%= h obj.name(true) %>
12
+ <%= h(" : #{obj.tag(:return).types.first}") if obj.has_tag?(:return) && obj.tag(:return).types && obj.tag(:return).types.size > 0 %>\l
13
+ <% end %>
14
+ <% end %>
@@ -0,0 +1,14 @@
1
+ def init
2
+ @modules = object.children.select {|o| o.type == :module }
3
+ @classes = object.children.select {|o| o.type == :class }
4
+ sections :child, [:info], :classes, [T('class')], :header, [T('module')], :dependencies
5
+ end
6
+
7
+ def dependencies
8
+ return unless options.dependencies
9
+ erb(:dependencies)
10
+ end
11
+
12
+ def classes
13
+ @classes.map {|k| yieldall :object => k }.join("\n")
14
+ end
@@ -0,0 +1,10 @@
1
+ <% scopes(attr_listing) do |list, scope| %>
2
+ <div id="<%= scope %>_attr_details" class="attr_details">
3
+ <h2><%= scope.to_s.capitalize %> Attribute Details</h2>
4
+ <% list.each_with_index do |meth, i| %>
5
+ <% rw = meth.attr_info %>
6
+ <span id="<%= anchor_for(rw[meth.reader? ? :write : :read]) %>"></span>
7
+ <%= yieldall :object => meth, :owner => object, :index => i %>
8
+ <% end %>
9
+ </div>
10
+ <% end %>
@@ -0,0 +1,8 @@
1
+ <% groups(attr_listing, "Attribute") do |list, name| %>
2
+ <h2><%= name %> <small><a href="#" class="summary_toggle">collapse</a></small></h2>
3
+ <ul class="summary">
4
+ <% list.each do |meth| %>
5
+ <%= yieldall :item => meth %>
6
+ <% end %>
7
+ </ul>
8
+ <% end %>
@@ -0,0 +1,43 @@
1
+ <div class="box_info">
2
+ <% if CodeObjects::ClassObject === object && object.superclass %>
3
+ <dl>
4
+ <dt>Inherits:</dt>
5
+ <dd>
6
+ <span class="inheritName"><%= linkify object.superclass %></span>
7
+ <% if object.superclass.name != :BasicObject %>
8
+ <ul class="fullTree">
9
+ <li><%= linkify P(:Object) %></li>
10
+ <% object.inheritance_tree.reverse.each_with_index do |obj, i| %>
11
+ <li class="next"><%= obj == object ? obj.path : linkify(obj) %></li>
12
+ <% end %>
13
+ </ul>
14
+ <a href="#" class="inheritanceTree">show all</a>
15
+ <% end %>
16
+ </dd>
17
+ </dl>
18
+ <% end %>
19
+
20
+ <% [[:class, "Extended by"], [:instance, "Includes"]].each do |scope, name| %>
21
+ <% if (mix = run_verifier(object.mixins(scope))).size > 0 %>
22
+ <dl>
23
+ <dt><%= name %>:</dt>
24
+ <dd><%= mix.sort_by {|o| o.path }.map {|o| linkify(o) }.join(", ") %></dd>
25
+ </dl>
26
+ <% end %>
27
+ <% end %>
28
+
29
+ <% if (mixed_into = mixed_into(object)).size > 0 %>
30
+ <dl>
31
+ <dt>Included in:</dt>
32
+ <dd><%= mixed_into.sort_by {|o| o.path }.map {|o| linkify(o) }.join(", ") %></dd>
33
+ </dl>
34
+ <% end %>
35
+
36
+ <% unless object.root? %>
37
+ <dl>
38
+ <dt>Defined in:</dt>
39
+ <dd><%= erb(:defines) %></dd>
40
+ </dl>
41
+ <% end %>
42
+ </div>
43
+
@@ -0,0 +1,8 @@
1
+ <h2>Defined Under Namespace</h2>
2
+ <p class="children">
3
+ <% @inner.each do |name, list| %>
4
+ <% if list.size > 0 %>
5
+ <strong class="<%= name %>"><%= name.to_s.capitalize %>:</strong> <%= list.map {|child| linkify(child, child.name(true)) }.join(", ") %>
6
+ <% end %>
7
+ <% end %>
8
+ </p>
@@ -0,0 +1,13 @@
1
+ <% if constant_listing.size > 0 || object.constants.size > 0 %>
2
+ <h2>Constant Summary</h2>
3
+ <% if constant_listing.size > 0 %>
4
+ <dl class="constants">
5
+ <% constant_listing.each do |cnst| %>
6
+ <dt id="<%= anchor_for(cnst) %>" class="<%= cnst.has_tag?(:deprecated) ? 'deprecated' : '' %>"><%= cnst.name %> =
7
+ <%= yieldall :object => cnst %>
8
+ </dt>
9
+ <dd><pre class="code"><%= format_constant cnst.value %></pre></dd>
10
+ <% end %>
11
+ </dl>
12
+ <% end %>
13
+ <% end %>
@@ -0,0 +1,3 @@
1
+ <%= object.file ? object.file : '(unknown)' %><% if object.files.size > 1 %><span class="defines">,<br />
2
+ <%= object.files[1..-1].map {|f| f.first }.join(",<br /> ") %></span>
3
+ <% end %>
@@ -0,0 +1,5 @@
1
+ <h1><%= format_object_title(object) %>
2
+ <% if object.has_tag?(:abstract) %><span class="abstract note title">Abstract</span><% end %>
3
+ <% if object.has_tag?(:deprecated) %><span class="deprecated note title">Deprecated</span><% end %>
4
+ <% if object.has_tag?(:api) && object.tag(:api).text == 'private' %><span class="private note title">Private</span><% end %>
5
+ </h1>
@@ -0,0 +1,14 @@
1
+ <% found_method = false %>
2
+ <% inherited_attr_list do |superclass, attribs| %>
3
+ <% if attr_listing.size == 0 && !found_method %><h2>Instance Attribute Summary</h2><% end %>
4
+ <% found_method = true %>
5
+ <h3 class="inherited">Attributes <%= superclass.type == :class ? 'inherited' : 'included' %> from <%= linkify superclass %></h3>
6
+ <p class="inherited"><%= attribs.map do |method|
7
+ name = method.name(true).gsub(/=$/, '')
8
+ if superclass.type == :module && object.instance_mixins.include?(superclass)
9
+ name = "##{name}" unless name =~ /^#/
10
+ end
11
+ linkify(method, name)
12
+ end.join(", ")
13
+ %></p>
14
+ <% end %>
@@ -0,0 +1,8 @@
1
+ <% found_const = false %>
2
+ <% inherited_constant_list do |superclass, consts| %>
3
+ <% if constant_listing.size == 0 && !found_const %><h2>Constant Summary</h2><% end %>
4
+ <% found_const = true %>
5
+ <h3 class="inherited">Constants <%= superclass.type == :class ? 'inherited' : 'included' %>
6
+ from <%= linkify superclass %></h3>
7
+ <p class="inherited"><%= consts.map {|c| linkify c }.join(", ") %></p>
8
+ <% end %>
@@ -0,0 +1,19 @@
1
+ <% found_method = false %>
2
+ <% object.inheritance_tree(true)[1..-1].each do |superclass| %>
3
+ <% next if superclass.is_a?(YARD::CodeObjects::Proxy) %>
4
+ <% next if options.embed_mixins.size > 0 && options.embed_mixins_match?(superclass) != false %>
5
+ <% meths = prune_method_listing(superclass.meths(:included => false, :inherited => false)) %>
6
+ <% meths.reject! {|m| object.child(:scope => m.scope, :name => m.name) != nil } %>
7
+ <% meths.reject! {|m| m.is_alias? || m.is_attribute? } %>
8
+ <% next if meths.size == 0 %>
9
+ <% if method_listing.size == 0 && !found_method %><h2>Method Summary</h2><% end %>
10
+ <% found_method = true %>
11
+ <h3 class="inherited">Methods <%= superclass.type == :class ? 'inherited' : 'included' %> from <%= linkify superclass %></h3>
12
+ <p class="inherited"><%=
13
+ meths.sort_by {|o| o.name.to_s }.map do |m|
14
+ name = m.name(true)
15
+ name = name.gsub(/^#/,'') if superclass.type == :module && object.class_mixins.include?(superclass)
16
+ linkify(m, name)
17
+ end.join(", ")
18
+ %></p>
19
+ <% end %>
@@ -0,0 +1,40 @@
1
+ <li class="<%= @item.visibility %> <%= @item.has_tag?(:deprecated) ? 'deprecated' : '' %>">
2
+ <span class="summary_signature">
3
+ <% if @item.tags(:overload).size == 1 %>
4
+ <%= signature(@item.tag(:overload), true, !@item.attr_info) %>
5
+ <% else %>
6
+ <%= signature(@item, true, false, !@item.attr_info) %>
7
+ <% end %>
8
+
9
+ <% if @item.aliases.size > 0 %>
10
+ (also: <%= @item.aliases.map {|o| h(o.name(true)) }.join(", ") %>)
11
+ <% end %>
12
+ </span>
13
+ <% if object != @item.namespace %>
14
+ <span class="note title not_defined_here">
15
+ <%= @item.namespace.type == :class ? 'inherited' : (@item.scope == :class ? 'extended' : 'included') %>
16
+ from <%= linkify @item, object.relative_path(@item.namespace) %>
17
+ </span>
18
+ <% end %>
19
+ <% if @item.constructor? %>
20
+ <span class="note title constructor">constructor</span>
21
+ <% end %>
22
+ <% if rw = @item.attr_info %>
23
+ <% if !run_verifier([rw[:read]].compact).empty? && run_verifier([rw[:write]].compact).empty? %>
24
+ <span class="note title readonly">readonly</span>
25
+ <% end %>
26
+ <% if !run_verifier([rw[:write]].compact).empty? && run_verifier([rw[:read]].compact).empty? %>
27
+ <span class="note title writeonly">writeonly</span>
28
+ <% end %>
29
+ <% end %>
30
+ <% if @item.visibility != :public %><span class="note title <%= @item.visibility %>"><%= @item.visibility %></span><% end %>
31
+ <% if @item.has_tag?(:abstract) %><span class="abstract note title">abstract</span><% end %>
32
+ <% if @item.has_tag?(:deprecated) %><span class="deprecated note title">deprecated</span><% end %>
33
+ <% if @item.has_tag?(:api) && @item.tag(:api).text == 'private' %><span class="private note title">private</span><% end %>
34
+
35
+ <% if @item.has_tag?(:deprecated) %>
36
+ <span class="summary_desc"><strong>Deprecated.</strong> <%= htmlify_line @item.tag(:deprecated).text %></span>
37
+ <% else %>
38
+ <span class="summary_desc"><%= htmlify_line docstring_summary(@item) %></span>
39
+ <% end %>
40
+ </li>
@@ -0,0 +1,9 @@
1
+ <% scopes(method_listing(false)) do |list, scope| %>
2
+ <div id="<%= scope %>_method_details" class="method_details_list">
3
+ <h2><%= scope.to_s.capitalize %> Method Details</h2>
4
+
5
+ <% list.each_with_index do |meth, i| %>
6
+ <%= yieldall :object => meth, :owner => object, :index => i %>
7
+ <% end %>
8
+ </div>
9
+ <% end %>
@@ -0,0 +1,14 @@
1
+ <% if method_listing.size > 0 %>
2
+ <% groups(method_listing) do |list, name| %>
3
+ <h2>
4
+ <%= name %>
5
+ <small><a href="#" class="summary_toggle">collapse</a></small>
6
+ </h2>
7
+
8
+ <ul class="summary">
9
+ <% list.each do |meth| %>
10
+ <%= yieldall :item => meth %>
11
+ <% end %>
12
+ </ul>
13
+ <% end %>
14
+ <% end %>
@@ -0,0 +1,12 @@
1
+ <div id="method_missing_details" class="method_details_list">
2
+ <h2>Dynamic Method Handling</h2>
3
+ <p class="notice <%= @mm.namespace == object ? 'this' : 'super' %>">
4
+ This class handles dynamic methods through the <tt>method_missing</tt> method
5
+ <% if @mm.namespace != object %>
6
+ in the class <%= linkify @mm, @mm.namespace.path %>
7
+ <% end %>
8
+ </p>
9
+ <% if @mm.namespace == object %>
10
+ <%= yieldall :object => @mm, :index => 0 %>
11
+ <% end %>
12
+ </div>
@@ -0,0 +1 @@
1
+ <h2>Overview</h2>