RubyGems - yard - Versions diffs - 0.6.8 → 0.7.0 - Mend

yard 0.6.8 → 0.7.0

Potentially problematic release.

This version of yard might be problematic. Click here for more details.

Files changed (224) hide show

data/.yardopts +1 -0
data/ChangeLog +723 -0
data/README.md +16 -6
data/docs/CodeObjects.md +10 -16
data/docs/GettingStarted.md +232 -32
data/docs/Glossary.md +1 -2
data/docs/Handlers.md +10 -16
data/docs/Overview.md +14 -13
data/docs/Parser.md +13 -22
data/docs/Tags.md +209 -16
data/docs/Templates.md +237 -26
data/docs/WhatsNew.md +178 -2
data/lib/yard.rb +13 -10
data/lib/yard/autoload.rb +22 -18
data/lib/yard/cli/command.rb +13 -12
data/lib/yard/cli/command_parser.rb +20 -19
data/lib/yard/cli/config.rb +19 -19
data/lib/yard/cli/diff.rb +46 -21
data/lib/yard/cli/gems.rb +11 -11
data/lib/yard/cli/graph.rb +13 -13
data/lib/yard/cli/help.rb +1 -1
data/lib/yard/cli/list.rb +22 -0
data/lib/yard/cli/server.rb +17 -17
data/lib/yard/cli/stats.rb +32 -32
data/lib/yard/cli/yardoc.rb +181 -135
data/lib/yard/cli/yri.rb +29 -29
data/lib/yard/code_objects/base.rb +101 -101
data/lib/yard/code_objects/class_object.rb +20 -20
data/lib/yard/code_objects/constant_object.rb +1 -1
data/lib/yard/code_objects/extended_method_object.rb +5 -5
data/lib/yard/code_objects/extra_file_object.rb +89 -0
data/lib/yard/code_objects/macro_object.rb +215 -0
data/lib/yard/code_objects/method_object.rb +30 -30
data/lib/yard/code_objects/module_object.rb +1 -1
data/lib/yard/code_objects/namespace_object.rb +39 -39
data/lib/yard/code_objects/proxy.rb +38 -38
data/lib/yard/code_objects/root_object.rb +1 -1
data/lib/yard/config.rb +40 -40
data/lib/yard/core_ext/array.rb +2 -2
data/lib/yard/core_ext/file.rb +11 -11
data/lib/yard/core_ext/insertion.rb +10 -10
data/lib/yard/core_ext/module.rb +2 -2
data/lib/yard/core_ext/string.rb +2 -2
data/lib/yard/core_ext/symbol_hash.rb +14 -14
data/lib/yard/docstring.rb +122 -54
data/lib/yard/globals.rb +2 -2
data/lib/yard/handlers/base.rb +216 -127
data/lib/yard/handlers/processor.rb +65 -27
data/lib/yard/handlers/ruby/alias_handler.rb +6 -3
data/lib/yard/handlers/ruby/attribute_handler.rb +7 -6
data/lib/yard/handlers/ruby/base.rb +50 -31
data/lib/yard/handlers/ruby/class_condition_handler.rb +11 -11
data/lib/yard/handlers/ruby/class_handler.rb +10 -10
data/lib/yard/handlers/ruby/class_variable_handler.rb +3 -3
data/lib/yard/handlers/ruby/constant_handler.rb +7 -7
data/lib/yard/handlers/ruby/exception_handler.rb +2 -2
data/lib/yard/handlers/ruby/extend_handler.rb +1 -1
data/lib/yard/handlers/ruby/legacy/alias_handler.rb +8 -5
data/lib/yard/handlers/ruby/legacy/attribute_handler.rb +6 -5
data/lib/yard/handlers/ruby/legacy/base.rb +42 -27
data/lib/yard/handlers/ruby/legacy/class_condition_handler.rb +9 -9
data/lib/yard/handlers/ruby/legacy/class_handler.rb +13 -12
data/lib/yard/handlers/ruby/legacy/class_variable_handler.rb +3 -6
data/lib/yard/handlers/ruby/legacy/constant_handler.rb +5 -8
data/lib/yard/handlers/ruby/legacy/exception_handler.rb +1 -1
data/lib/yard/handlers/ruby/legacy/extend_handler.rb +1 -0
data/lib/yard/handlers/ruby/legacy/macro_handler.rb +40 -0
data/lib/yard/handlers/ruby/legacy/method_handler.rb +10 -10
data/lib/yard/handlers/ruby/legacy/mixin_handler.rb +4 -3
data/lib/yard/handlers/ruby/legacy/module_handler.rb +2 -1
data/lib/yard/handlers/ruby/legacy/private_constant_handler.rb +4 -4
data/lib/yard/handlers/ruby/legacy/visibility_handler.rb +2 -1
data/lib/yard/handlers/ruby/legacy/yield_handler.rb +3 -3
data/lib/yard/handlers/ruby/macro_handler.rb +41 -0
data/lib/yard/handlers/ruby/macro_handler_methods.rb +130 -0
data/lib/yard/handlers/ruby/method_condition_handler.rb +1 -1
data/lib/yard/handlers/ruby/method_handler.rb +13 -13
data/lib/yard/handlers/ruby/mixin_handler.rb +4 -4
data/lib/yard/handlers/ruby/module_handler.rb +2 -1
data/lib/yard/handlers/ruby/private_constant_handler.rb +4 -4
data/lib/yard/handlers/ruby/struct_handler_methods.rb +11 -11
data/lib/yard/handlers/ruby/visibility_handler.rb +1 -1
data/lib/yard/handlers/ruby/yield_handler.rb +5 -5
data/lib/yard/logging.rb +11 -11
data/lib/yard/parser/base.rb +8 -8
data/lib/yard/parser/c_parser.rb +42 -33
data/lib/yard/parser/ruby/ast_node.rb +62 -61
data/lib/yard/parser/ruby/legacy/ruby_lex.rb +66 -66
data/lib/yard/parser/ruby/legacy/ruby_parser.rb +4 -4
data/lib/yard/parser/ruby/legacy/statement.rb +11 -11
data/lib/yard/parser/ruby/legacy/statement_list.rb +15 -15
data/lib/yard/parser/ruby/legacy/token_list.rb +9 -9
data/lib/yard/parser/ruby/ruby_parser.rb +51 -37
data/lib/yard/parser/source_parser.rb +271 -46
data/lib/yard/rake/yardoc_task.rb +18 -17
data/lib/yard/registry.rb +64 -64
data/lib/yard/registry_store.rb +34 -34
data/lib/yard/rubygems/backports.rb +8 -0
data/lib/yard/rubygems/backports/LICENSE.txt +57 -0
data/lib/yard/rubygems/backports/MIT.txt +20 -0
data/lib/yard/rubygems/backports/gem.rb +8 -0
data/lib/yard/rubygems/backports/source_index.rb +353 -0
data/lib/yard/rubygems/specification.rb +2 -2
data/lib/yard/serializers/base.rb +20 -20
data/lib/yard/serializers/file_system_serializer.rb +28 -24
data/lib/yard/serializers/process_serializer.rb +3 -3
data/lib/yard/serializers/stdout_serializer.rb +6 -6
data/lib/yard/serializers/yardoc_serializer.rb +17 -17
data/lib/yard/server/adapter.rb +12 -12
data/lib/yard/server/commands/base.rb +26 -26
data/lib/yard/server/commands/display_file_command.rb +3 -2
data/lib/yard/server/commands/display_object_command.rb +5 -5
data/lib/yard/server/commands/frames_command.rb +1 -1
data/lib/yard/server/commands/library_command.rb +7 -7
data/lib/yard/server/commands/library_index_command.rb +2 -2
data/lib/yard/server/commands/list_command.rb +8 -8
data/lib/yard/server/commands/search_command.rb +8 -8
data/lib/yard/server/commands/static_file_command.rb +3 -3
data/lib/yard/server/doc_server_helper.rb +6 -3
data/lib/yard/server/doc_server_serializer.rb +1 -1
data/lib/yard/server/library_version.rb +45 -45
data/lib/yard/server/rack_adapter.rb +10 -10
data/lib/yard/server/router.rb +28 -28
data/lib/yard/server/static_caching.rb +5 -5
data/lib/yard/server/templates/default/fulldoc/html/css/custom.css +3 -3
data/lib/yard/server/templates/default/fulldoc/html/js/live.js +1 -1
data/lib/yard/server/templates/default/layout/html/breadcrumb.erb +2 -2
data/lib/yard/server/templates/default/layout/html/headers.erb +13 -8
data/lib/yard/server/templates/default/layout/html/setup.rb +7 -0
data/lib/yard/server/templates/doc_server/full_list/html/full_list.erb +2 -2
data/lib/yard/server/templates/doc_server/full_list/html/setup.rb +14 -4
data/lib/yard/server/templates/doc_server/library_list/html/contents.erb +2 -2
data/lib/yard/server/templates/doc_server/library_list/html/headers.erb +2 -2
data/lib/yard/server/templates/doc_server/processing/html/processing.erb +1 -1
data/lib/yard/server/templates/doc_server/search/html/search.erb +1 -1
data/lib/yard/server/webrick_adapter.rb +2 -2
data/lib/yard/tags/default_factory.rb +19 -19
data/lib/yard/tags/default_tag.rb +1 -1
data/lib/yard/tags/library.rb +68 -63
data/lib/yard/tags/option_tag.rb +1 -1
data/lib/yard/tags/overload_tag.rb +9 -9
data/lib/yard/tags/ref_tag_list.rb +2 -2
data/lib/yard/tags/tag.rb +7 -7
data/lib/yard/templates/engine.rb +31 -31
data/lib/yard/templates/erb_cache.rb +1 -1
data/lib/yard/templates/helpers/base_helper.rb +46 -32
data/lib/yard/templates/helpers/filter_helper.rb +2 -2
data/lib/yard/templates/helpers/html_helper.rb +120 -81
data/lib/yard/templates/helpers/html_syntax_highlight_helper.rb +4 -4
data/lib/yard/templates/helpers/markup/rdoc_markup.rb +9 -9
data/lib/yard/templates/helpers/markup_helper.rb +37 -30
data/lib/yard/templates/helpers/method_helper.rb +7 -7
data/lib/yard/templates/helpers/text_helper.rb +7 -7
data/lib/yard/templates/helpers/uml_helper.rb +3 -3
data/lib/yard/templates/section.rb +14 -14
data/lib/yard/templates/template.rb +54 -54
data/lib/yard/verifier.rb +27 -27
data/spec/cli/list_spec.rb +8 -0
data/spec/cli/yardoc_spec.rb +58 -10
data/spec/code_objects/extra_file_object_spec.rb +132 -0
data/spec/code_objects/macro_object_spec.rb +154 -0
data/spec/docstring_spec.rb +90 -0
data/spec/handlers/base_spec.rb +22 -0
data/spec/handlers/examples/macro_handler_001.rb.txt +73 -0
data/spec/handlers/examples/method_handler_001.rb.txt +17 -0
data/spec/handlers/macro_handler_spec.rb +140 -0
data/spec/handlers/method_handler_spec.rb +28 -0
data/spec/handlers/processor_spec.rb +4 -0
data/spec/handlers/spec_helper.rb +1 -1
data/spec/parser/c_parser_spec.rb +47 -16
data/spec/parser/examples/extrafile.c.txt +8 -0
data/spec/parser/examples/multifile.c.txt +6 -0
data/spec/parser/ruby/ruby_parser_spec.rb +5 -0
data/spec/parser/source_parser_spec.rb +235 -0
data/spec/rake/yardoc_task_spec.rb +22 -17
data/spec/serializers/file_system_serializer_spec.rb +6 -0
data/spec/server/commands/library_command_spec.rb +39 -0
data/spec/spec_helper.rb +14 -0
data/spec/templates/examples/method001.html +6 -6
data/spec/templates/examples/method002.html +4 -4
data/spec/templates/examples/method003.html +10 -10
data/spec/templates/examples/method005.html +2 -2
data/spec/templates/examples/module001.dot +2 -0
data/spec/templates/examples/module001.html +76 -37
data/spec/templates/examples/module001.txt +1 -1
data/spec/templates/helpers/base_helper_spec.rb +7 -2
data/spec/templates/helpers/html_helper_spec.rb +49 -5
data/spec/templates/helpers/markup_helper_spec.rb +9 -8
data/spec/templates/module_spec.rb +7 -0
data/spec/templates/onefile_spec.rb +47 -0
data/templates/default/fulldoc/html/css/style.css +7 -5
data/templates/default/fulldoc/html/full_list.erb +13 -10
data/templates/default/fulldoc/html/full_list_files.erb +1 -1
data/templates/default/fulldoc/html/js/app.js +16 -14
data/templates/default/fulldoc/html/js/full_list.js +7 -6
data/templates/default/fulldoc/html/setup.rb +78 -17
data/templates/default/layout/html/files.erb +1 -1
data/templates/default/layout/html/headers.erb +11 -7
data/templates/default/layout/html/search.erb +4 -4
data/templates/default/layout/html/setup.rb +28 -8
data/templates/default/module/html/inherited_attributes.erb +17 -0
data/templates/default/module/setup.rb +1 -1
data/templates/default/onefile/html/files.erb +2 -2
data/templates/default/onefile/html/layout.erb +1 -1
data/templates/default/onefile/html/setup.rb +7 -5
data/templates/default/tags/html/option.erb +1 -1
data/templates/default/tags/html/tag.erb +3 -3
data/templates/guide/class/html/setup.rb +1 -0
data/templates/guide/docstring/html/setup.rb +1 -0
data/templates/guide/fulldoc/html/css/style.css +91 -0
data/templates/guide/fulldoc/html/js/app.js +33 -0
data/templates/guide/fulldoc/html/setup.rb +54 -0
data/templates/guide/layout/html/layout.erb +81 -0
data/templates/guide/layout/html/setup.rb +24 -0
data/templates/guide/method/html/header.erb +18 -0
data/templates/guide/method/html/setup.rb +21 -0
data/templates/guide/module/html/header.erb +7 -0
data/templates/guide/module/html/method_list.erb +5 -0
data/templates/guide/module/html/setup.rb +26 -0
data/templates/guide/tags/html/setup.rb +8 -0
metadata +40 -7
data/lib/yard/handlers/ruby/legacy/process_handler.rb +0 -13
data/lib/yard/handlers/ruby/process_handler.rb +0 -18
data/spec/handlers/process_handler_spec.rb +0 -17

data/templates/default/fulldoc/html/setup.rb CHANGED Viewed

@@ -2,15 +2,14 @@ include Helpers::ModuleHelper
 def init
   options[:objects] = objects = run_verifier(options[:objects])
-  options[:files] = ([options[:readme]] + options[:files]).compact.map {|t| t.to_s }
+  options[:files] = ([options[:readme]] + options[:files]).uniq.compact
   options[:readme] = options[:files].first
-  options[:title] ||= "Documentation by YARD #{YARD::VERSION}"
   return serialize_onefile if options[:onefile]
   generate_assets
   serialize('_index.html')
   options[:files].each_with_index do |file, i|
-    serialize_file(file, i == 0 ? options[:title] : nil)
+    serialize_file(file, file.title)
   end
   options.delete(:objects)
@@ -27,6 +26,9 @@ def init
   end
 end
+# Generate an HTML document for the specified object. This method is used by
+# most of the objects found in the Registry.
+# @param [CodeObject] object to be saved to HTML
 def serialize(object)
   options[:object] = object
   serialize_index(options) if object == '_index.html' && options[:files].empty?
@@ -35,52 +37,104 @@ def serialize(object)
   end
 end
+# Generate the documentation output in one file (--one-file) which will load the
+# contents of all the javascript and css and output the entire contents without
+# depending on any additional files
 def serialize_onefile
-  options[:css_data] = file('css/style.css', true) + "\n" + file('css/common.css', true)
-  options[:js_data] = file('js/jquery.js', true) + file('js/app.js', true)
+  layout = Object.new.extend(T('layout'))
+  options[:css_data] = layout.stylesheets.map {|sheet| file(sheet,true) }.join("\n")
+  options[:js_data] = layout.javascripts.map {|script| file(script,true) }.join("")
   Templates::Engine.with_serializer('index.html', options[:serializer]) do
     T('onefile').run(options)
   end
 end
+# Generate the index document for the output
+# @params [Hash] options contains data and flags that influence the output
 def serialize_index(options)
   Templates::Engine.with_serializer('index.html', options[:serializer]) do
     T('layout').run(options)
   end
 end
+# Generate a single HTML file with the layout template applied. This is generally
+# the README file or files specified on the command-line.
+#
+# @param [File] file object to be saved to the output
+# @param [String] title currently unused
+#
+# @see layout#diskfile
 def serialize_file(file, title = nil)
   options[:object] = Registry.root
   options[:file] = file
-  options[:page_title] = title
-  options[:serialized_path] = 'file.' + File.basename(file.gsub(/\.[^.]+$/, '')) + '.html'
+  outfile = 'file.' + file.name + '.html'
   serialize_index(options) if file == options[:readme]
-  Templates::Engine.with_serializer(options[:serialized_path], options[:serializer]) do
+  Templates::Engine.with_serializer(outfile, options[:serializer]) do
     T('layout').run(options)
   end
   options.delete(:file)
-  options.delete(:serialized_path)
-  options.delete(:page_title)
 end
+#
+# Generates a file to the output with the specified contents.
+#
+# @example saving a custom html file to the documenation root
+#
+#   asset('my_custom.html','<html><body>Custom File</body></html>')
+#
+# @param [String] path relative to the document output where the file will be
+#   created.
+# @param [String] content the contents that are saved to the file.
 def asset(path, content)
   options[:serializer].serialize(path, content) if options[:serializer]
 end
+# @return [Array<String>] Stylesheet files that are additionally loaded for the
+#   searchable full lists, e.g., Class List, Method List, File List
+# @since 0.7.0
+def stylesheets_full_list
+  %w(css/full_list.css css/common.css)
+end
+# @return [Array<String>] Javascript files that are additionally loaded for the
+#   searchable full lists, e.g., Class List, Method List, File List.
+# @since 0.7.0
+def javascripts_full_list
+  %w(js/jquery.js js/full_list.js)
+end
+def menu_lists
+  Object.new.extend(T('layout')).menu_lists
+end
+# Generates all the javascript files, stylesheet files, menu lists
+# (i.e. class, method, and file) based on the the values returned from the
+# layout's menu_list method, and the frameset in the documentation output
+#
 def generate_assets
-  %w( js/jquery.js js/app.js js/full_list.js
-      css/style.css css/full_list.css css/common.css ).each do |file|
+  @object = Registry.root
+  layout = Object.new.extend(T('layout'))
+  (layout.javascripts + javascripts_full_list +
+      layout.stylesheets + stylesheets_full_list).uniq.each do |file|
     asset(file, file(file, true))
   end
-  @object = Registry.root
-  generate_method_list
-  generate_class_list
-  generate_file_list
+  layout.menu_lists.each do |list|
+    list_generator_method = "generate_#{list[:type]}_list"
+    if respond_to?(list_generator_method)
+      send(list_generator_method)
+    else
+      log.error "Unable to generate '#{list[:title]}' list because no method " +
+        "'#{list_generator_method}' exists"
+    end
+  end
   generate_frameset
 end
+# Generate a searchable method list in the output
+# @see ModuleHelper#prune_method_listing
 def generate_method_list
   @items = prune_method_listing(Registry.all(:method), false)
   @items = @items.reject {|m| m.name.to_s =~ /=$/ && m.is_attribute? }
@@ -90,6 +144,7 @@ def generate_method_list
   asset('method_list.html', erb(:full_list))
 end
+# Generate a searchable class list in the output
 def generate_class_list
   @items = options[:objects]
   @list_title = "Class List"
@@ -97,6 +152,7 @@ def generate_class_list
   asset('class_list.html', erb(:full_list))
 end
+# Generate a searchable file list in the output
 def generate_file_list
   @file_list = true
   @items = options[:files]
@@ -106,10 +162,15 @@ def generate_file_list
   @file_list = nil
 end
+# Generate the frame documentation in the output
 def generate_frameset
+  @javascripts = javascripts_full_list
+  @stylesheets = stylesheets_full_list
   asset('frames.html', erb(:frames))
 end
+# @return [String] HTML output of the classes to be displayed in the
+#    full_list_class template.
 def class_list(root = Registry.root)
   out = ""
   children = run_verifier(root.children)

data/templates/default/layout/html/files.erb CHANGED Viewed

@@ -3,7 +3,7 @@
   <ul id="files">
   <% n = 1 %>
   <% @files.each_with_index do |file, i| %>
-    <li class="r<%= n %>"><%= link_file(file, File.basename(file).gsub(/\.[^.]+$/, '')) %></li>
+    <li class="r<%= n %>"><%= link_file(file) %></li>
     <% n = n == 2 ? 1 : 2 %>
   <% end %>
   </ul>

data/templates/default/layout/html/headers.erb CHANGED Viewed

@@ -1,13 +1,17 @@
 <meta http-equiv="Content-Type" content="text/html; charset=<%= charset %>" />
-<title><%= @page_title %></title>
-<link rel="stylesheet" href="<%= url_for("css/style.css") %>" type="text/css" media="screen" charset="utf-8" />
-<link rel="stylesheet" href="<%= url_for("css/common.css") %>" type="text/css" media="screen" charset="utf-8" />
-<% if @extra_css %>
-  <link rel="stylesheet" href="<%= url_for @extra_css %>" type="text/css" media="screen" charset="utf-8" />
+<title>
+  <%= h @page_title %>
+  <% if options[:title] && @page_title != options[:title] %>
+    &mdash; <%= h options[:title] %>
+  <% end %>
+</title>
+<% stylesheets.each do |stylesheet| %>
+  <link rel="stylesheet" href="<%= url_for(stylesheet) %>" type="text/css" media="screen" charset="utf-8" />
 <% end %>
 <script type="text/javascript" charset="utf-8">
   relpath = '<%= url_for('') %>';
   if (relpath != '') relpath += '/';
 </script>
-<script type="text/javascript" charset="utf-8" src="<%= url_for("js/jquery.js") %>"></script>
-<script type="text/javascript" charset="utf-8" src="<%= url_for("js/app.js") %>"></script>
+<% javascripts.each do |javascript| %>
+  <script type="text/javascript" charset="utf-8" src="<%= url_for(javascript) %>"></script>
+<% end %>

data/templates/default/layout/html/search.erb CHANGED Viewed

@@ -1,5 +1,5 @@
 <div id="search">
-  <a id="class_list_link" href="#">Class List</a>
-  <a id="method_list_link" href="#">Method List</a>
-  <a id ="file_list_link" href="#">File List</a>
-</div>
+  <% menu_lists.each do |field| %>
+    <a id="<%= field[:type] %>_list_link" href="#"><%= field[:search_title] %></a>
+  <% end %>
+</div>

data/templates/default/layout/html/setup.rb CHANGED Viewed

@@ -1,14 +1,13 @@
 def init
-  @breadcrumb = []
+  @breadcrumb = []
   if @onefile
     sections :layout
   elsif @file
-    @contents = File.read(@file)
-    @file = File.basename(@file)
-    @fname = @file.gsub(/\.[^.]+$/, '')
-    @breadcrumb_title = "File: " + @fname
-    @page_title ||= @breadcrumb_title
+    if @file.attributes[:namespace]
+      @object = options[:object] = Registry.at(@file.attributes[:namespace]) || Registry.root
+    end
+    @breadcrumb_title = "File: " + @file.title
+    @page_title = @breadcrumb_title
     sections :layout, [:diskfile]
   elsif object
     case object
@@ -46,6 +45,27 @@ def index
 end
 def diskfile
-  data = htmlify(markup_file_contents(@contents), markup_for_file(@contents, @file))
+  @file.attributes[:markup] ||= markup_for_file('', @file.filename)
+  data = htmlify(@file.contents, @file.attributes[:markup])
   "<div id='filecontents'>" + data + "</div>"
 end
+# @return [Array<String>] core javascript files for layout
+# @since 0.7.0
+def javascripts
+  %w(js/jquery.js js/app.js)
+end
+# @return [Array<String>] core stylesheets for the layout
+# @since 0.7.0
+def stylesheets
+  %w(css/style.css css/common.css)
+end
+# @return [Array<Hash{Symbol=>String}>] the list of search links and drop-down menus
+# @since 0.7.0
+def menu_lists
+[ { :type => 'class', :title => 'Classes', :search_title => 'Class List' },
+  { :type => 'method', :title => 'Methods', :search_title => 'Method List' },
+  { :type => 'file', :title => 'Files', :search_title => 'File List' } ]
+end

data/templates/default/module/html/inherited_attributes.erb ADDED Viewed

@@ -0,0 +1,17 @@
+<% found_method = false %>
+<% object.inheritance_tree(true)[1..-1].each do |superclass| %>
+  <% next if superclass.is_a?(YARD::CodeObjects::Proxy) %>
+  <% attribs = superclass.attributes[:instance] %>
+  <% next if attribs.size == 0 %>
+  <% if attr_listing.size == 0 && !found_method %><h2>Instance Attribute Summary</h2><% end %>
+  <% found_method = true %>
+  <h3 class="inherited">Attributes <%= superclass.type == :class ? 'inherited' : 'included' %> from <%= linkify superclass %></h3>
+  <p class="inherited"><%=
+    attribs.sort_by {|args| args.first.to_s }.collect do |args|
+      name, methods = args
+      method = methods[:read] || methods[:write]
+      name = method.name.to_s.gsub(/^#/,'') if superclass.type == :module && object.class_mixins.include?(superclass)
+      linkify(method, name)
+    end.join(", ")
+  %></p>
+<% end %>

data/templates/default/module/setup.rb CHANGED Viewed

@@ -3,7 +3,7 @@ include Helpers::ModuleHelper
 def init
   sections :header, :box_info, :pre_docstring, T('docstring'), :children,
     :constant_summary, [T('docstring')], :inherited_constants,
-    :attribute_summary, [:item_summary],
+    :attribute_summary, [:item_summary], :inherited_attributes,
     :method_summary, [:item_summary], :inherited_methods,
     :methodmissing, [T('method_details')],
     :attribute_details, [T('method_details')],

data/templates/default/onefile/html/files.erb CHANGED Viewed

@@ -1,5 +1,5 @@
 <% @files.each do |file| %>
-  <% @file, @contents = file, read_file(file) %>
-  <h2><%= file %></h2>
+  <% @file = file %>
+  <h2><%= file.title %></h2>
   <%= diskfile %>
 <% end %>

data/templates/default/onefile/html/layout.erb CHANGED Viewed

@@ -2,7 +2,7 @@
   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   <head>
-    <meta name="Content-Type" content="text/html; charset=<%= charset %>" />
+    <meta http-equiv="Content-Type" content="text/html; charset=<%= charset %>" />
     <title><%= @title %></title>
     <style type="text/css" media="screen">
       <%= @css_data %>

data/templates/default/onefile/html/setup.rb CHANGED Viewed

@@ -16,13 +16,9 @@ end
 private
-def read_file(file)
-  File.read(file).force_encoding(charset)
-end
 def parse_top_comments_from_file
   data = ""
-  tokens = TokenList.new(read_file(@readme))
+  tokens = TokenList.new(@readme.contents)
   tokens.each do |token|
     break unless token.is_a?(RubyToken::TkCOMMENT) || token.is_a?(RubyToken::TkNL)
     data << (token.text[/\A#\s{0,1}(.*)/, 1] || "\n")
@@ -31,7 +27,13 @@ def parse_top_comments_from_file
 end
 def override_serializer
+  return if @serializer.nil?
   class << @serializer
+    def serialize(object, data)
+      return unless object == 'index.html'
+      super
+    end
     def serialized_path(object)
       return object if object.is_a?(String)
       return 'index.html'

data/templates/default/tags/html/option.erb CHANGED Viewed

@@ -6,8 +6,8 @@
     <ul class="option">
       <% for tag in tags %>
         <li>
-          <span class="type"><%= format_types(tag.pair.types || ['Object']) %></span>
           <span class="name"><%= tag.pair.name %></span>
+          <span class="type"><%= format_types(tag.pair.types || ['Object']) %></span>
           <span class="default">
             <% if tag.pair.defaults %>
               &mdash; default:

data/templates/default/tags/html/tag.erb CHANGED Viewed

@@ -2,12 +2,12 @@
 <ul class="<%= @name %>">
   <% object.tags(@name).each do |tag| %>
     <li>
-      <% unless @no_types %>
-        <span class='type'><%= format_types(tag.types) %></span>
-      <% end %>
       <% unless @no_names %>
         <span class='name'><%= h tag.name %></span>
       <% end %>
+      <% unless @no_types %>
+        <span class='type'><%= format_types(tag.types) %></span>
+      <% end %>
       <% if @name == :param && (o=object.parameters.assoc(tag.name.to_s)) && o[1] %>
         <em class="default">(defaults to: <tt><%= h o[1] %></tt>)</em>
       <% end %>

data/templates/guide/class/html/setup.rb ADDED Viewed

	@@ -0,0 +1 @@
1	+ include T('guide/module/html')

data/templates/guide/docstring/html/setup.rb ADDED Viewed

	@@ -0,0 +1 @@
1	+ include T('default/docstring/html')

data/templates/guide/fulldoc/html/css/style.css ADDED Viewed

@@ -0,0 +1,91 @@
+body { color: #3e4349; font-family: Georgia, serif; font-size: 17px; margin: 0; }
+h1, h2, h3, h4, h5, h6 { font-weight: normal; color: #000; font-family: Georgia, serif; }
+h1 { color: #040; }
+h2 { color: #060; }
+#sidebar h2 { color: #2f2; }
+strong { color: #000; }
+.object_link, tt, code { font-family: 'Consolas', 'BitStream Vera Sans Mono', monospace; font-size: 14px; }
+.method_header .path, .module_header .path { font-family: 'Consolas', 'BitStream Vera Sans Mono', monospace; }
+.method_header .path.space, .module_header .path.space { padding-left: 5px; }
+.method_header { font-size: 0.95em; }
+.method_body { margin-left: 2em; }
+.tags h3, .tags h4 { font-size: 0.9em; font-weight: bold; color: #3e4349; }
+.tags .param .name { font-style: italic; }
+.tags .option .name { font-family: monospace; color: #000; font-size: 0.8em; }
+.tags .option .type, .tags .param .type { font-size: 10px; vertical-align: super; }
+.tags .option .type tt, .tags .param .type tt,
+.tags .option .type tt .object_link, .tags .param .type tt .object_link { font-size: 10px; }
+.module_methods { margin-left: 2em; }
+.method_header .since, .module_header .since { font-size: 0.75em; color: #888; vertical-align: super; }
+ul { list-style: square; }
+.inline { display: inline; }
+.inline p:first-child { display: inline; }
+.inline p { font-family: Georgia, serif; font-size: 16px; color: #3e4349; }
+.docstring .note { margin: 1em 0; }
+.docstring h1, .docstring h2, .docstring h3, .docstring h4 { padding: 0; border: 0; border-bottom: 1px dotted #bbb; }
+.docstring h1 { font-size: 1.2em; }
+.docstring h2 { font-size: 1.1em; }
+.docstring h3 { font-size: 1.1em; }
+#filecontents strong { font-weight: normal; color: #000; }
+.readonly { font-size: 0.75em; color: #888; vertical-align: super; }
+#page { width: 940px; margin: 0px auto; }
+#top_nav { background: #8e0; padding: 4px 8px; }
+#inner_nav { width: 940px; margin: 0px auto; }
+#inner_nav a { border: 0; text-decoration: none; color: #777; }
+#inner_nav a:hover { color: #eee; }
+#top_nav .links { display: block; float: right; }
+#content { margin-left: 30px; width: 660px; float: left; }
+#sidebar { float: left; width: 200px; float: left; padding: 18px 10px; padding-top: 0; }
+#sidebar h2 { font-weight: 100; color: #3e4349; font-size: 1.45em; }
+#sidebar ol { padding-left: 19px; margin-left: 0; list-style: square; }
+#sidebar a { color: #777; }
+#sidebar ol.top { padding-left: 0; margin-left: 0; list-style: none; }
+#sidebar a { font-size: 0.9em; }
+#footer { margin: 0 auto; width: 940px; text-align: center; margin-top: 30px; padding: 20px 0; color: #888; font-size: 0.8em; border-top: 1px dotted #bbb; }
+#footer a { color: #444; }
+#links strong { font-size: 0.95em; font-weight: normal; color: #000; }
+a { color: #268; text-decoration: none; }
+a:hover { color: #060; background: #8e0; }
+/* syntax highlighting */
+.source_code { display: none; padding: 3px 8px; border-left: 8px solid #ddd; margin-top: 5px; }
+#filecontents pre.code, .docstring pre.code, .source_code pre { font-family: monospace; }
+#filecontents pre.code, .docstring pre.code { display: block; }
+.source_code .lines { padding-right: 12px; color: #555; text-align: right; }
+#filecontents pre.code, .docstring pre.code,
+.tags .example {
+  font-size: 0.9em;
+  padding: 7px 30px;
+  margin: 15px -30px;
+  margin-left: -30px;
+  background: #eee;
+  line-height: 1.3em;
+  font-family: 'Consolas', 'BitStream Vera Sans Mono', monospace;
+ }
+pre.code { color: #3e4349; }
+pre.code .info.file { color: #555; }
+pre.code .val { color: #036A07; }
+pre.code .tstring_content,
+pre.code .heredoc_beg, pre.code .heredoc_end,
+pre.code .qwords_beg, pre.code .qwords_end,
+pre.code .tstring, pre.code .dstring { color: #036A07; }
+pre.code .fid, pre.code .id.new, pre.code .id.to_s,
+pre.code .id.to_sym, pre.code .id.to_f,
+pre.code .dot + pre.code .id,
+pre.code .id.to_i pre.code .id.each { color: #0085FF; }
+pre.code .comment { color: #0066FF; }
+pre.code .const, pre.code .constant { color: #585CF6; }
+pre.code .symbol { color: #C5060B; }
+pre.code .kw,
+pre.code .label,
+pre.code .id.require,
+pre.code .id.extend,
+pre.code .id.include { color: #0000FF; }
+pre.code .ivar { color: #318495; }
+pre.code .gvar,
+pre.code .id.backref,
+pre.code .id.nth_ref { color: #6D79DE; }
+pre.code .regexp, .dregexp { color: #036A07; }
+pre.code a { border-bottom: 1px dotted #bbf; }