rdoc-babel 1.4.2 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53cc17d95591f5bea0a8af8d5402d76b8dd27b63649ba5d6eb97a4a245d2d4fa
-  data.tar.gz: 2da4547f70be3f03c84addfba2169c58d22e0d63772464430c4acc013244e7b5
+  metadata.gz: 6ae80737f13f1a0c60e44a540d27f66ee883e91c8bc0a5a40f09bc7edbe1d380
+  data.tar.gz: d962f2bdc15e62a2f4c5438e00b0ff4dbda17bce472b152c0f17bf3622daa3f1
 SHA512:
-  metadata.gz: 848d78b3cc6a7e26f268cbac815fb90b0a9e459c28178debf30209e6bf59b0fed0bc30ab582a7b0df84b997f880d9c603d7d588ae25916c2ee2cd05d4e023116
-  data.tar.gz: d4983d175a5ab88b46b7da22de74e11bf59bf4fb036ecc2653bb16ef2a725a4c5fccf543aa1be62ae56b8d21a013fe3429a36eb315d2050e0e7c4eab02d232bf
+  metadata.gz: 04124b697a014c2026f4b0cb6869c6803534fa14f5e499a373735b982254ec6c8c23146109ab371493cf56750496dba4a734ce101e47614ba0bce0ed5dac4013
+  data.tar.gz: c39012b02bd7f6c54f7a6f8102b9ee5ef9823ee75a844bea4b36f7364952ffc23ddd9cb6fbf5a6106667d5edea0fb80ed470411bda6ec8f1e3fa58d423080413

data/HISTORY.rdoc

@@ -1,3 +1,12 @@
+=== 1.5.1
+
+* tune the HTML & CSS
+* support RDoc 6.13.1
+
+=== 1.5.0
+
+* add support for RDoc <tt>:section:</tt> directive (instance methods only).
+
 === 1.4.2
 
 * import web fonts in the CSS

data/lib/rdoc/generator/babel.rb

@@ -3,26 +3,35 @@ require 'fileutils'
 require 'erb'
 
 # :stopdoc:
-# remove junk <span> at the end
 class RDoc::Markup::ToHtml
 
+  # remove junk <span> at the end
   undef accept_heading
-
   def accept_heading heading
     level = [6, heading.level].min
 
     label = heading.label @code_object
 
-    @res << if @options.output_decoration
-              "\n<h#{level} id=\"#{label}\">"
-            else
-              "\n<h#{level}>"
-            end
+    @res <<
+      if @options.output_decoration
+        "\n<h#{level} id=\"#{label}\">"
+      else
+        "\n<h#{level}>"
+      end
     @res << to_html(heading.text)
     @res << "</h#{level}>\n"
   end
 
 end
+
+class RDoc::Alias
+  # restore full_old_name (RDoc >= 6.13)
+  unless instance_methods.include?(:full_old_name)
+    def full_old_name
+      @full_name || "#{parent.name}#{pretty_old_name}"
+    end
+  end
+end
 # :startdoc:
 
 ##
@@ -33,7 +42,7 @@ class RDoc::Generator::Babel
 
   RDoc::RDoc.add_generator(self)
 
-  VERSION = '1.4.2'
+  VERSION = '1.5.1'
   DESCRIPTION = 'Alternate HTML documentation'
 
   include ERB::Util
@@ -276,6 +285,14 @@ class RDoc::Generator::Babel
       debug_msg "  %s %s" % [klass.type, klass.full_name]
       outfile = @output_dir + klass.path
       @class = klass
+      @sections = klass.sections
+      if @sections.size > 1
+        anonymous_section = @sections.find { |s| !s.title }
+        if anonymous_section
+          @sections.delete anonymous_section
+          @sections << anonymous_section
+        end
+      end
       self.render_template(template_file, binding(), outfile)
     end
   end
@@ -339,23 +356,23 @@ class RDoc::Generator::Babel
   # with alias information and link to ancestor method/attribute.
 
   def description(method)
-    desc = method.documented? ? method.description.strip : ''
+    desc = method.documented? ? method.description.strip : +''
     if method.is_alias_for
-      text = method.is_alias_for.documented? ? '<p>' : '<p class="nodoc">'
+      text = method.is_alias_for.documented? ? +'<p>' : +'<p class="nodoc">'
       text << 'Alias for ' << link(method, method.is_alias_for) << '</p>'
       append_with_nl desc, text
     end
     if method.see &&
         (@see_standard_ancestors ||
          method.see.parent.full_name !~ /^(Object|Kernel)$/)
-      text = method.see.documented? ? '<p>' : '<p class="nodoc">'
+      text = method.see.documented? ? +'<p>' : +'<p class="nodoc">'
       text << (desc.empty? ? 'See ' : 'See also ')
       text << link(method, method.see) << '</p>'
       append_with_nl desc, text
     end
     desc = '<p class="nodoc">(not documented)</p>' if desc.empty?
     unless method.aliases.empty?
-      text = '<p>Also aliased as '
+      text = +'<p>Also aliased as '
       text << method.aliases.map { |a| link(method, a) }.join(', ') << '</p>'
       append_with_nl desc, text
     end
@@ -465,6 +482,17 @@ class RDoc::Generator::Babel
     h(text).tr("\001\002\003\004", '&<>"').gsub("\n", '<br/>')
   end
 
+  # Returns a Hash { section => [methods] } for the current class methods +methods+.
+
+  def section_methods_hash(methods)
+    h = methods.group_by(&:section)
+
+    @sections.to_h do |section|
+      [section, h[section]]
+    end
+    .compact
+  end
+
 protected
 
   # Renders the erb template in +template_file+ within the
@@ -553,6 +581,7 @@ protected
   # and a final trailing newline.
 
   def append_with_nl(base, add)
+    base = +base
     base.strip!
     base.sub!(/\S\z/, "\\&\n")
     base << add

data/lib/rdoc/generator/ruby-lang/class-page.html.erb

@@ -79,13 +79,20 @@
       <% end %>
     </ul>
   <% end %>
-  <% unless @class.instance_methods.empty? %>
+  <% unless @class.instance_methods.empty?
+       section_hash = section_methods_hash(@class.instance_methods)
+       has_sections = section_hash.size > 1 || section_hash.keys.first.title
+       section_hash.each do |section, methods| %>
     <ul>
-      <% @class.instance_methods.sort.each do |m| %>
+       <% if has_sections %>
+      <li class="section-title"><%= section.title || 'Other' %></li>
+       <% end %>
+      <% methods.sort.each do |m| %>
       <% litag = m.documented? ? '<li>' : '<li class="nodoc">' %>
       <%= litag %><a href="#<%= m.aref %>"><span class="type"><%= @options.show_hash ? '#' : '' %></span><%= h m.name %></a></li>
       <% end %>
     </ul>
+    <% end %>
   <% end %>
 </div>
 <% end %>
@@ -221,7 +228,13 @@
      next if methods.empty?
 %>
 <h2 id="<%= visibility %>-<%= type %>-methods"><%= visibility.to_s.capitalize %> <%= type.capitalize %> Methods</h2>
-<% methods.each do |method| %>
+<% section_hash = section_methods_hash(methods)
+   has_sections = section_hash.size > 1 || section_hash.keys.first.title
+   section_hash.each do |section, methods|
+   if has_sections %>
+   <h3><%= section.title || 'Other' %></h3>
+<% end
+   methods.each do |method| %>
   <div id="<%= method.aref %>" class="method-detail<%= method.is_alias_for ? ' method-alias' : '' %>">
     <div class="method-heading">
     <% if method.call_seq %>
@@ -249,6 +262,7 @@
 
   </div> <!-- #<%= method.aref %> -->
 <% end # methods.each %>
+<% end # section_hash.each %>
 <% end # visibilities.each %>
 <% end # @class.methods_by_type.each %>
 

data/lib/rdoc/generator/ruby-lang/indexes.html.erb

@@ -28,7 +28,7 @@
     <div class="entries">
     <% @all_classes_and_modules.each do |k| %>
       <p class="<%= k.any_content ? k.type : k.type + ' nodoc' %>">
-        <span class="type"><%= k.type[0..0].upcase %></span><a href="<%= k.path %>"><%= k.full_name + (k.is_alias_for ? ' &rarr; ' << k.is_alias_for.full_name : '') %></a>
+        <span class="type"><%= k.type[0..0].upcase %></span><a href="<%= k.path %>"><%= k.full_name + (k.is_alias_for ? +' &rarr; ' << k.is_alias_for.full_name : '') %></a>
       </p>
     <% end %>
     </div>

data/lib/rdoc/generator/ruby-lang/rdoc.css

@@ -266,9 +266,11 @@ h4, h5, h6 {
   border: none;
 }
 
+/* links inside headings: keep blue
 h1 a, h2 a, h3 a {
-  color: #e62020; /* not the best, but no other idea */
+  color: #e62020;
 }
+*/
 
 h1 { font-size: 230%; }
 h2 { font-size: 180%; }
@@ -544,6 +546,12 @@ p#file-info {
 #method-list li a {
   padding: 0 4px 2px 4px; /* TRBL */
 }
+/* when there are sections: */
+#method-list li.section-title {
+  font-family: var(--default-font);
+  font-size: 9.5pt;
+  margin-right: 1ex;
+}
 
 /* mixed class/module lists */
 

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rdoc-babel
 version: !ruby/object:Gem::Version
-  version: 1.4.2
+  version: 1.5.1
 platform: ruby
 authors:
 - Thierry Lambert
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-10 00:00:00.000000000 Z
+date: 2025-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -98,7 +97,6 @@ homepage: https://github.com/thyresias/rdoc-babel
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options:
 - "--title"
 - RDoc Babel
@@ -117,8 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
-signing_key:
+rubygems_version: 3.6.6
 specification_version: 4
 summary: An RDoc formatter producing HTML documentation.
 test_files: []