rdoc 6.12.0 → 6.14.1

data/lib/rdoc/generator/pot/po_entry.rb

@@ -26,7 +26,7 @@ class RDoc::Generator::POT::POEntry
   # Creates a PO entry for +msgid+. Other values can be specified by
   # +options+.
 
-  def initialize msgid, options = {}
+  def initialize(msgid, options = {})
     @msgid = msgid
     @msgstr = options[:msgstr] || ""
     @translator_comment = options[:translator_comment]
@@ -53,7 +53,7 @@ msgstr #{format_message(@msgstr)}
   ##
   # Merges the PO entry with +other_entry+.
 
-  def merge other_entry
+  def merge(other_entry)
     options = {
       :extracted_comment  => merge_string(@extracted_comment,
                                           other_entry.extracted_comment),
@@ -69,7 +69,7 @@ msgstr #{format_message(@msgstr)}
 
   private
 
-  def format_comment mark, comment
+  def format_comment(mark, comment)
     return '' unless comment
     return '' if comment.empty?
 
@@ -106,7 +106,7 @@ msgstr #{format_message(@msgstr)}
     "\#, #{formatted_flags}\n"
   end
 
-  def format_message message
+  def format_message(message)
     return "\"#{escape(message)}\"" unless message.include?("\n")
 
     formatted_message = '""'
@@ -117,7 +117,7 @@ msgstr #{format_message(@msgstr)}
     formatted_message
   end
 
-  def escape string
+  def escape(string)
     string.gsub(/["\\\t\n]/) do |special_character|
       case special_character
       when "\t"
@@ -130,11 +130,11 @@ msgstr #{format_message(@msgstr)}
     end
   end
 
-  def merge_string string1, string2
+  def merge_string(string1, string2)
     [string1, string2].compact.join("\n")
   end
 
-  def merge_array array1, array2
+  def merge_array(array1, array2)
       (array1 + array2).uniq
   end
 

data/lib/rdoc/generator/pot.rb

@@ -65,7 +65,7 @@ class RDoc::Generator::POT
   ##
   # Set up a new .pot generator
 
-  def initialize store, options #:not-new:
+  def initialize(store, options) #:not-new:
     @options    = options
     @store      = store
   end
@@ -81,11 +81,6 @@ class RDoc::Generator::POT
     end
   end
 
-  # :nodoc:
-  def class_dir
-    nil
-  end
-
   private
   def extract_messages
     extractor = MessageExtractor.new(@store)

data/lib/rdoc/generator/ri.rb

@@ -14,7 +14,7 @@ class RDoc::Generator::RI
   ##
   # Set up a new ri generator
 
-  def initialize store, options #:not-new:
+  def initialize(store, options) #:not-new:
     @options    = options
     @store      = store
     @store.path = '.'

data/lib/rdoc/generator/template/darkfish/_head.rhtml

@@ -25,6 +25,11 @@
   <%- end -%>
 <%- end -%>
 
+<%- if canonical_url = @options.canonical_root -%>
+<% canonical_url = current.canonical_url if defined?(current) %>
+<link rel="canonical" href="<%= canonical_url %>">
+<%- end -%>
+
 <script type="text/javascript">
   var rdoc_rel_prefix = "<%= h asset_rel_prefix %>/";
   var index_rel_prefix = "<%= h rel_prefix %>/";

data/lib/rdoc/generator/template/darkfish/_sidebar_classes.rhtml

@@ -1,34 +1,5 @@
 <div id="classindex-section" class="nav-section">
   <h3>Class and Module Index</h3>
 
-  <%-
-  all_classes = @classes.group_by do |klass|
-    klass.full_name[/\A[^:]++(?:::[^:]++(?=::))*+(?=::[^:]*+\z)/]
-  end.delete_if do |_, klasses|
-    !klasses.any?(&:display?)
-  end
-  link = proc do |index_klass, display = index_klass.display?|
-    if display
-      -%><code><a href="<%= rel_prefix %>/<%= index_klass.path %>"><%= index_klass.name %></a></code><%-
-    else
-      -%><code><%= index_klass.name %></code><%-
-    end
-  end
-  if top = all_classes[nil]
-    solo = top.one? {|klass| klass.display?}
-    traverse = proc do |klasses| -%>
-  <ul class="link-list">
-      <%- klasses.uniq!(&:full_name) -%>
-      <%- klasses.each do |index_klass| -%>
-        <%- if children = all_classes[index_klass.full_name] -%>
-  <li><details<% if solo; solo = false %> open<% end %>><summary><% link.call(index_klass) %></summary>
-          <%- traverse.call(children) -%>
-  </ul></details>
-        <%- elsif index_klass.display? -%>
-  <li><% link.call(index_klass, true) %>
-        <%- end -%>
-      <%- end -%>
-    <%- end -%>
-    <%- traverse.call(top) -%>
-  <%- end -%>
+  <%= generate_class_index_content(@classes, rel_prefix) %>
 </div>

data/lib/rdoc/generator/template/darkfish/_sidebar_extends.rhtml

@@ -3,7 +3,7 @@
   <h3>Extended With Modules</h3>
 
   <ul class="link-list">
-    <%- klass.each_extend do |ext| -%>
+    <%- klass.extends.each do |ext| -%>
   <%- unless String === ext.module then -%>
     <li><a class="extend" href="<%= klass.aref_to ext.module.path %>"><%= ext.module.full_name %></a>
   <%- else -%>

data/lib/rdoc/generator/template/darkfish/_sidebar_includes.rhtml

@@ -3,7 +3,7 @@
   <h3>Included Modules</h3>
 
   <ul class="link-list">
-  <%- klass.each_include do |inc| -%>
+  <%- klass.includes.each do |inc| -%>
   <%- unless String === inc.module then -%>
     <li><a class="include" href="<%= klass.aref_to inc.module.path %>"><%= inc.module.full_name %></a>
   <%- else -%>

data/lib/rdoc/generator/template/darkfish/class.rhtml

@@ -18,6 +18,21 @@
 </nav>
 
 <main role="main" aria-labelledby="<%=h klass.aref %>">
+  <%# If nesting level is 1, breadcrumb list is not needed %>
+  <% if breadcrumb.size > 1 %>
+    <ol role="navigation" aria-label="breadcrumb" class="breadcrumb">
+      <% breadcrumb.each do |namespace| %>
+      <li>
+        <% if namespace[:self] %>
+        <span><%= namespace[:name] %></span>
+        <% else %>
+        <a href="<%= namespace[:path] %>"><%= namespace[:name] %></a><span>::</span>
+        <% end %>
+      </li>
+      <% end %>
+    </ol>
+  <% end %>
+
   <h1 id="<%=h klass.aref %>" class="anchor-link <%= klass.type %>">
     <%= klass.type %> <%= klass.full_name %>
   </h1>

data/lib/rdoc/generator/template/darkfish/css/rdoc.css

@@ -96,6 +96,8 @@ main .anchor-link:target {
 a {
   color: var(--link-color);
   transition: color 0.3s ease;
+  text-decoration: underline;
+  text-underline-offset: 0.2em; /* Make sure it doesn't overlap with underscores in a method name. */
 }
 
 a:hover {
@@ -199,6 +201,19 @@ nav h3,
   font-size: 1em;
 }
 
+ol.breadcrumb {
+  display: flex;
+
+  padding: 0;
+  margin: 0 0 1em;
+}
+
+ol.breadcrumb li {
+  display: block;
+  list-style: none;
+  font-size: 125%;
+}
+
 nav ul,
 nav dl,
 nav p {

data/lib/rdoc/markdown.kpeg

@@ -992,9 +992,8 @@ Strike = &{ strike? }
          "~~"
          { strike a.join }
 
-# TODO alt text support
-Image = "!" ( ExplicitLink | ReferenceLink ):a
-        { "rdoc-image:#{a[/\[(.*)\]/, 1]}" }
+Image = "!" ExplicitLinkWithLabel:a
+        { "rdoc-image:#{a[:link]}:#{a[:label]}" }
 
 Link =  ExplicitLink | ReferenceLink | AutoLink
 
@@ -1006,8 +1005,11 @@ ReferenceLinkDouble = Label:content < Spnl > !"[]" Label:label
 ReferenceLinkSingle = Label:content < (Spnl "[]")? >
                       { link_to content, content, text }
 
-ExplicitLink =  Label:l "(" @Sp Source:s Spnl Title @Sp ")"
-                { "{#{l}}[#{s}]" }
+ExplicitLink = ExplicitLinkWithLabel:a
+               { "{#{a[:label]}}[#{a[:link]}]" }
+
+ExplicitLinkWithLabel = Label:label "(" @Sp Source:link Spnl Title @Sp ")"
+                        { { label: label, link: link } }
 
 Source  = ( "<" < SourceContents > ">" | < SourceContents > )
           { text }

data/lib/rdoc/markdown.rb

@@ -10978,7 +10978,7 @@ class RDoc::Markdown
     return _tmp
   end
 
-  # Image = "!" (ExplicitLink | ReferenceLink):a { "rdoc-image:#{a[/\[(.*)\]/, 1]}" }
+  # Image = "!" ExplicitLinkWithLabel:a { "rdoc-image:#{a[:link]}:#{a[:label]}" }
   def _Image
 
     _save = self.pos
@@ -10988,24 +10988,13 @@ class RDoc::Markdown
         self.pos = _save
         break
       end
-
-      _save1 = self.pos
-      while true # choice
-        _tmp = apply(:_ExplicitLink)
-        break if _tmp
-        self.pos = _save1
-        _tmp = apply(:_ReferenceLink)
-        break if _tmp
-        self.pos = _save1
-        break
-      end # end choice
-
+      _tmp = apply(:_ExplicitLinkWithLabel)
       a = @result
       unless _tmp
         self.pos = _save
         break
       end
-      @result = begin;  "rdoc-image:#{a[/\[(.*)\]/, 1]}" ; end
+      @result = begin;  "rdoc-image:#{a[:link]}:#{a[:label]}" ; end
       _tmp = true
       unless _tmp
         self.pos = _save
@@ -11153,13 +11142,36 @@ class RDoc::Markdown
     return _tmp
   end
 
-  # ExplicitLink = Label:l "(" @Sp Source:s Spnl Title @Sp ")" { "{#{l}}[#{s}]" }
+  # ExplicitLink = ExplicitLinkWithLabel:a { "{#{a[:label]}}[#{a[:link]}]" }
   def _ExplicitLink
 
+    _save = self.pos
+    while true # sequence
+      _tmp = apply(:_ExplicitLinkWithLabel)
+      a = @result
+      unless _tmp
+        self.pos = _save
+        break
+      end
+      @result = begin;  "{#{a[:label]}}[#{a[:link]}]" ; end
+      _tmp = true
+      unless _tmp
+        self.pos = _save
+      end
+      break
+    end # end sequence
+
+    set_failed_rule :_ExplicitLink unless _tmp
+    return _tmp
+  end
+
+  # ExplicitLinkWithLabel = Label:label "(" @Sp Source:link Spnl Title @Sp ")" { { label: label, link: link } }
+  def _ExplicitLinkWithLabel
+
     _save = self.pos
     while true # sequence
       _tmp = apply(:_Label)
-      l = @result
+      label = @result
       unless _tmp
         self.pos = _save
         break
@@ -11175,7 +11187,7 @@ class RDoc::Markdown
         break
       end
       _tmp = apply(:_Source)
-      s = @result
+      link = @result
       unless _tmp
         self.pos = _save
         break
@@ -11200,7 +11212,7 @@ class RDoc::Markdown
         self.pos = _save
         break
       end
-      @result = begin;  "{#{l}}[#{s}]" ; end
+      @result = begin;  { label: label, link: link } ; end
       _tmp = true
       unless _tmp
         self.pos = _save
@@ -11208,7 +11220,7 @@ class RDoc::Markdown
       break
     end # end sequence
 
-    set_failed_rule :_ExplicitLink unless _tmp
+    set_failed_rule :_ExplicitLinkWithLabel unless _tmp
     return _tmp
   end
 
@@ -16711,12 +16723,13 @@ class RDoc::Markdown
   Rules[:_StrongStar] = rule_info("StrongStar", "\"**\" !@Whitespace @StartList:a (!\"**\" Inline:b { a << b })+ \"**\" { strong a.join }")
   Rules[:_StrongUl] = rule_info("StrongUl", "\"__\" !@Whitespace @StartList:a (!\"__\" Inline:b { a << b })+ \"__\" { strong a.join }")
   Rules[:_Strike] = rule_info("Strike", "&{ strike? } \"~~\" !@Whitespace @StartList:a (!\"~~\" Inline:b { a << b })+ \"~~\" { strike a.join }")
-  Rules[:_Image] = rule_info("Image", "\"!\" (ExplicitLink | ReferenceLink):a { \"rdoc-image:\#{a[/\\[(.*)\\]/, 1]}\" }")
+  Rules[:_Image] = rule_info("Image", "\"!\" ExplicitLinkWithLabel:a { \"rdoc-image:\#{a[:link]}:\#{a[:label]}\" }")
   Rules[:_Link] = rule_info("Link", "(ExplicitLink | ReferenceLink | AutoLink)")
   Rules[:_ReferenceLink] = rule_info("ReferenceLink", "(ReferenceLinkDouble | ReferenceLinkSingle)")
   Rules[:_ReferenceLinkDouble] = rule_info("ReferenceLinkDouble", "Label:content < Spnl > !\"[]\" Label:label { link_to content, label, text }")
   Rules[:_ReferenceLinkSingle] = rule_info("ReferenceLinkSingle", "Label:content < (Spnl \"[]\")? > { link_to content, content, text }")
-  Rules[:_ExplicitLink] = rule_info("ExplicitLink", "Label:l \"(\" @Sp Source:s Spnl Title @Sp \")\" { \"{\#{l}}[\#{s}]\" }")
+  Rules[:_ExplicitLink] = rule_info("ExplicitLink", "ExplicitLinkWithLabel:a { \"{\#{a[:label]}}[\#{a[:link]}]\" }")
+  Rules[:_ExplicitLinkWithLabel] = rule_info("ExplicitLinkWithLabel", "Label:label \"(\" @Sp Source:link Spnl Title @Sp \")\" { { label: label, link: link } }")
   Rules[:_Source] = rule_info("Source", "(\"<\" < SourceContents > \">\" | < SourceContents >) { text }")
   Rules[:_SourceContents] = rule_info("SourceContents", "((!\"(\" !\")\" !\">\" Nonspacechar)+ | \"(\" SourceContents \")\")*")
   Rules[:_Title] = rule_info("Title", "(TitleSingle | TitleDouble | \"\"):a { a }")

data/lib/rdoc/markup/attribute_manager.rb

@@ -107,7 +107,7 @@ class RDoc::Markup::AttributeManager
   ##
   # Changes the current attribute from +current+ to +new+
 
-  def change_attribute current, new
+  def change_attribute(current, new)
     diff = current ^ new
     attribute(new & diff, current & diff)
   end
@@ -116,7 +116,7 @@ class RDoc::Markup::AttributeManager
   # Used by the tests to change attributes by name from +current_set+ to
   # +new_set+
 
-  def changed_attribute_by_name current_set, new_set
+  def changed_attribute_by_name(current_set, new_set)
     current = new = 0
     current_set.each do |name|
       current |= @attributes.bitmap_for(name)
@@ -220,7 +220,7 @@ class RDoc::Markup::AttributeManager
   ##
   # Converts regexp handling sequences to RDoc attributes
 
-  def convert_regexp_handlings str, attrs, exclusive = false
+  def convert_regexp_handlings(str, attrs, exclusive = false)
     @regexp_handlings.each do |regexp, attribute|
       next unless exclusive == exclusive?(attribute)
       str.scan(regexp) do
@@ -295,7 +295,7 @@ class RDoc::Markup::AttributeManager
   #
   #   @am.add_regexp_handling(/((https?:)\S+\w)/, :HYPERLINK)
 
-  def add_regexp_handling pattern, name, exclusive = false
+  def add_regexp_handling(pattern, name, exclusive = false)
     bitmap = @attributes.bitmap_for(name)
     @regexp_handlings << [pattern, bitmap]
     @exclusive_bitmap |= bitmap if exclusive
@@ -304,7 +304,7 @@ class RDoc::Markup::AttributeManager
   ##
   # Processes +str+ converting attributes, HTML and regexp handlings
 
-  def flow str
+  def flow(str)
     @str = str.dup
 
     mask_protected_sequences

data/lib/rdoc/markup/attributes.rb

@@ -26,7 +26,7 @@ class RDoc::Markup::Attributes
   ##
   # Returns a unique bit for +name+
 
-  def bitmap_for name
+  def bitmap_for(name)
     bitmap = @name_to_bitmap.assoc name
 
     unless bitmap then
@@ -43,7 +43,7 @@ class RDoc::Markup::Attributes
   ##
   # Returns a string representation of +bitmap+
 
-  def as_string bitmap
+  def as_string(bitmap)
     return 'none' if bitmap.zero?
     res = []
 
@@ -57,7 +57,7 @@ class RDoc::Markup::Attributes
   ##
   # yields each attribute name in +bitmap+
 
-  def each_name_of bitmap
+  def each_name_of(bitmap)
     return enum_for __method__, bitmap unless block_given?
 
     @name_to_bitmap.each do |name, bit|

data/lib/rdoc/markup/blank_line.rb

@@ -16,11 +16,11 @@ class RDoc::Markup::BlankLine
   ##
   # Calls #accept_blank_line on +visitor+
 
-  def accept visitor
+  def accept(visitor)
     visitor.accept_blank_line self
   end
 
-  def pretty_print q # :nodoc:
+  def pretty_print(q) # :nodoc:
     q.text 'blankline'
   end
 

data/lib/rdoc/markup/block_quote.rb

@@ -7,7 +7,7 @@ class RDoc::Markup::BlockQuote < RDoc::Markup::Raw
   ##
   # Calls #accept_block_quote on +visitor+
 
-  def accept visitor
+  def accept(visitor)
     visitor.accept_block_quote self
   end
 

data/lib/rdoc/markup/document.rb

@@ -37,7 +37,7 @@ class RDoc::Markup::Document
   ##
   # Appends +part+ to the document
 
-  def << part
+  def <<(part)
     case part
     when RDoc::Markup::Document then
       unless part.empty? then
@@ -53,7 +53,7 @@ class RDoc::Markup::Document
     end
   end
 
-  def == other # :nodoc:
+  def ==(other) # :nodoc:
     self.class == other.class and
       @file == other.file and
       @parts == other.parts
@@ -62,7 +62,7 @@ class RDoc::Markup::Document
   ##
   # Runs this document and all its #items through +visitor+
 
-  def accept visitor
+  def accept(visitor)
     visitor.start_accepting
 
     visitor.accept_document self
@@ -73,14 +73,14 @@ class RDoc::Markup::Document
   ##
   # Concatenates the given +parts+ onto the document
 
-  def concat parts
+  def concat(parts)
     self.parts.concat parts
   end
 
   ##
   # Enumerator for the parts of this document
 
-  def each &block
+  def each(&block)
     @parts.each(&block)
   end
 
@@ -94,7 +94,7 @@ class RDoc::Markup::Document
   ##
   # The file this Document was created from.
 
-  def file= location
+  def file=(location)
     @file = case location
             when RDoc::TopLevel then
               location.relative_name
@@ -111,7 +111,7 @@ class RDoc::Markup::Document
   #
   # The information in +other+ is preferred over the receiver
 
-  def merge other
+  def merge(other)
     if empty? then
       @parts = other.parts
       return self
@@ -135,7 +135,7 @@ class RDoc::Markup::Document
     RDoc::Markup::Document === @parts.first
   end
 
-  def pretty_print q # :nodoc:
+  def pretty_print(q) # :nodoc:
     start = @file ? "[doc (#{@file}): " : '[doc: '
 
     q.group 2, start, ']' do

data/lib/rdoc/markup/formatter.rb

@@ -21,7 +21,7 @@ class RDoc::Markup::Formatter
   ##
   # Converts a target url to one that is relative to a given path
 
-  def self.gen_relative_url path, target
+  def self.gen_relative_url(path, target)
     from        = File.dirname path
     to, to_file = File.split target
 
@@ -45,7 +45,7 @@ class RDoc::Markup::Formatter
   ##
   # Creates a new Formatter
 
-  def initialize options, markup = nil
+  def initialize(options, markup = nil)
     @options = options
 
     @markup = markup || RDoc::Markup.new
@@ -66,7 +66,7 @@ class RDoc::Markup::Formatter
   ##
   # Adds +document+ to the output
 
-  def accept_document document
+  def accept_document(document)
     document.parts.each do |item|
       case item
       when RDoc::Markup::Document then # HACK
@@ -117,7 +117,7 @@ class RDoc::Markup::Formatter
   ##
   # Marks up +content+
 
-  def convert content
+  def convert(content)
     @markup.convert content, self
   end
 
@@ -147,7 +147,7 @@ class RDoc::Markup::Formatter
   ##
   # Converts added regexp handlings. See RDoc::Markup#add_regexp_handling
 
-  def convert_regexp_handling target
+  def convert_regexp_handling(target)
     return target.text if in_tt?
 
     handled = false
@@ -173,7 +173,7 @@ class RDoc::Markup::Formatter
   ##
   # Converts a string to be fancier if desired
 
-  def convert_string string
+  def convert_string(string)
     string
   end
 
@@ -195,7 +195,7 @@ class RDoc::Markup::Formatter
     @in_tt > 0
   end
 
-  def tt_tag? attr_mask, reverse = false
+  def tt_tag?(attr_mask, reverse = false)
     each_attr_tag(attr_mask, reverse) do |tag|
       return true if tt? tag
     end
@@ -205,7 +205,7 @@ class RDoc::Markup::Formatter
   ##
   # Turns on tags for +item+ on +res+
 
-  def on_tags res, item
+  def on_tags(res, item)
     each_attr_tag(item.turn_on) do |tag|
       res << annotate(tag.on)
       @in_tt += 1 if tt? tag
@@ -215,14 +215,14 @@ class RDoc::Markup::Formatter
   ##
   # Turns off tags for +item+ on +res+
 
-  def off_tags res, item
+  def off_tags(res, item)
     each_attr_tag(item.turn_off, true) do |tag|
       @in_tt -= 1 if tt? tag
       res << annotate(tag.off)
     end
   end
 
-  def each_attr_tag attr_mask, reverse = false
+  def each_attr_tag(attr_mask, reverse = false)
     return if attr_mask.zero?
 
     @attr_tags.public_send(reverse ? :reverse_each : :each) do |tag|
@@ -235,7 +235,7 @@ class RDoc::Markup::Formatter
   ##
   # Extracts and a scheme, url and an anchor id from +url+ and returns them.
 
-  def parse_url url
+  def parse_url(url)
     case url
     when /^rdoc-label:([^:]*)(?::(.*))?/ then
       scheme = 'link'
@@ -265,7 +265,7 @@ class RDoc::Markup::Formatter
   ##
   # Is +tag+ a tt tag?
 
-  def tt? tag
+  def tt?(tag)
     tag.bit == @tt_bit
   end
 

data/lib/rdoc/markup/hard_break.rb

@@ -16,15 +16,15 @@ class RDoc::Markup::HardBreak
   ##
   # Calls #accept_hard_break on +visitor+
 
-  def accept visitor
+  def accept(visitor)
     visitor.accept_hard_break self
   end
 
-  def == other # :nodoc:
+  def ==(other) # :nodoc:
     self.class === other
   end
 
-  def pretty_print q # :nodoc:
+  def pretty_print(q) # :nodoc:
     q.text "[break]"
   end