rdoc-babel 1.4.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6ae764381b167bd89156dc785a2a039b9fe66197e26ab1887b565225279c0de
-  data.tar.gz: 07c955b085e7aa2c195363b40cd0904bcc3a871727f19089d6060546131d9647
+  metadata.gz: 8459c975be3bbda71642ce8cdb4b02fa2c91d5fed8882ccce54ec67494141ac7
+  data.tar.gz: cbb23203f2df483db114e6aca6f8127152b91d3341ce1aae6cf3483453021b81
 SHA512:
-  metadata.gz: 011f9c6d9f66bbf81ae89064b8de0b4973dd397409ba439a8d6b03a8bad2549db5542e4f1d4c607a9c53c672a3d30dcfe152ebd9a055522bad9f70f10aa54402
-  data.tar.gz: 5aa917b782b26a0e1adc5217168d1eaa16e19d9a447eb664bd5ced9e52f0a3eeff2b12fb83660b61f0af1f8fcf572d8423ba82e74e39ef99cf761bb8441ee8ba
+  metadata.gz: 51291ffdffe11249f1afba73b1cf2677c8d77067a5c4361ac8dd0115fa898d26ac8f336993fcf902d3b86a7db92fa02987a6744cea5162550f8b04a74b1043be
+  data.tar.gz: d45166d6a503d87e3e294dd702da9d6fc0baf9042127c77c76b4b61770642468c2dade6394532b2e4f39a70bdfa3e120c45c23ffec1bf9159890dfa54d5ec6d7

data/HISTORY.rdoc

@@ -1,3 +1,11 @@
+=== 1.5.0
+
+* add support for RDoc section directive for instance methods.
+
+=== 1.4.2
+
+* import web fonts in the CSS
+
 === 1.4.1
 
 * remove an extra </span> in class HTML

data/lib/rdoc/generator/babel.rb

@@ -3,21 +3,21 @@ 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
@@ -33,7 +33,7 @@ class RDoc::Generator::Babel
 
   RDoc::RDoc.add_generator(self)
 
-  VERSION = '1.4.1'
+  VERSION = '1.5.0'
   DESCRIPTION = 'Alternate HTML documentation'
 
   include ERB::Util
@@ -276,6 +276,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 +347,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 +473,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 +572,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

@@ -4,7 +4,6 @@
   <meta charset="<%= @options.charset %>">
   <title><%= @class.full_name %> &ndash; <%= h @options.title %></title>
   <link href="<%= @stylesheet_url %>" rel="stylesheet">
-  <link href="https://fonts.googleapis.com/css?family=Noto+Sans" rel="stylesheet">
   <script src="<%= @rel_prefix %>/scripts/mainFrame.js" type="text/javascript"></script>
 </head>
 <body>
@@ -80,13 +79,24 @@
       <% 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|
+        if has_sections %>
+    <div class="section-methods">
+    <p class="methods-section"><%= section.title || 'Other' %></p>
+       <% end %>
     <ul>
-      <% @class.instance_methods.sort.each do |m| %>
+      <% 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>
+      <% if has_sections %>
+    </div>
+      <% end %>
+    <% end %>
   <% end %>
 </div>
 <% end %>
@@ -222,7 +232,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 %>
@@ -250,6 +266,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/file-page.html.erb

@@ -4,7 +4,6 @@
   <meta charset="<%= @options.charset %>">
   <title><%= @file.base_name %> &ndash; <%= h @options.title %></title>
   <link href="<%= @stylesheet_url %>" rel="stylesheet">
-  <link href="https://fonts.googleapis.com/css?family=Noto+Sans" rel="stylesheet">
   <script src="<%= @rel_prefix %>/scripts/mainFrame.js" type="text/javascript"></script>
 </head>
 <body>

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

@@ -4,7 +4,6 @@
   <meta charset="<%= @options.charset %>">
   <title>Index of <%= @simple_files.empty? ? '' : 'Files, ' %> Classes &amp; Methods in <%= h @options.title %></title>
   <link href="<%= @stylesheet_url %>" rel="stylesheet">
-  <link href="https://fonts.googleapis.com/css?family=Noto+Sans" rel="stylesheet">
   <script src="scripts/quicksearch.js" type="text/javascript"></script>
   <script src="scripts/indexFrame.js" type="text/javascript"></script>
   <base target="_parent">
@@ -29,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

@@ -1,3 +1,4 @@
+@import url('https://fonts.googleapis.com/css2?family=Noto+Sans:ital,wght@0,100..900;1,100..900&family=Open+Sans:ital,wght@0,300..800;1,300..800&display=swap');
 
 :root {
   --default-font: "Noto Sans", Verdana, Geneva, Arial, Helvetica, sans-serif;
@@ -543,6 +544,18 @@ p#file-info {
 #method-list li a {
   padding: 0 4px 2px 4px; /* TRBL */
 }
+/* when there are sections: */
+#method-list .section-methods p.methods-section {
+  display: inline-block;
+  margin-top: 0;
+  margin-left: 1.5ex;
+  font-size: 9.5pt;
+}
+#method-list .section-methods ul {
+  display: inline-block;
+  margin-top: 0;
+  margin-left: 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.1
+  version: 1.5.0
 platform: ruby
 authors:
 - Thierry Lambert
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-27 00:00:00.000000000 Z
+date: 2025-04-06 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.17
-signing_key:
+rubygems_version: 3.6.6
 specification_version: 4
 summary: An RDoc formatter producing HTML documentation.
 test_files: []