rdoc 6.13.0 → 6.14.0

data/lib/rdoc/code_object.rb

@@ -236,7 +236,7 @@ class RDoc::CodeObject
   #
   # Set to +nil+ to clear RDoc's cached value
 
-  def full_name= full_name
+  def full_name=(full_name)
     @full_name = full_name
   end
 
@@ -316,7 +316,7 @@ class RDoc::CodeObject
   ##
   # Records the RDoc::TopLevel (file) where this code object was defined
 
-  def record_location top_level
+  def record_location(top_level)
     @ignored    = false
     @suppressed = false
     @file       = top_level
@@ -358,7 +358,7 @@ class RDoc::CodeObject
   ##
   # Sets the +store+ that contains this CodeObject
 
-  def store= store
+  def store=(store)
     @store = store
 
     return unless @track_visibility

data/lib/rdoc/comment.rb

@@ -53,7 +53,7 @@ class RDoc::Comment
   # Creates a new comment with +text+ that is found in the RDoc::TopLevel
   # +location+.
 
-  def initialize text = nil, location = nil, language = nil
+  def initialize(text = nil, location = nil, language = nil)
     @location = location
     @text     = text.nil? ? nil : text.dup
     @language = language
@@ -67,11 +67,11 @@ class RDoc::Comment
   #--
   # TODO deep copy @document
 
-  def initialize_copy copy # :nodoc:
+  def initialize_copy(copy) # :nodoc:
     @text = copy.text.dup
   end
 
-  def == other # :nodoc:
+  def ==(other) # :nodoc:
     self.class === other and
       other.text == @text and other.location == @location
   end
@@ -129,7 +129,7 @@ class RDoc::Comment
   ##
   # HACK dubious
 
-  def encode! encoding
+  def encode!(encoding)
     @text = String.new @text, encoding: encoding
     self
   end
@@ -137,7 +137,7 @@ class RDoc::Comment
   ##
   # Sets the format of this comment and resets any parsed document
 
-  def format= format
+  def format=(format)
     @format = format
     @document = nil
   end
@@ -208,7 +208,7 @@ class RDoc::Comment
   #
   # An error is raised if the comment contains a document but no text.
 
-  def text= text
+  def text=(text)
     raise RDoc::Error, 'replacing document-only comment is not allowed' if
       @text.nil? and @document
 

data/lib/rdoc/cross_reference.rb

@@ -124,7 +124,7 @@ class RDoc::CrossReference
   # Allows cross-references to be created based on the given +context+
   # (RDoc::Context).
 
-  def initialize context
+  def initialize(context)
     @context = context
     @store   = context.store
 
@@ -134,7 +134,7 @@ class RDoc::CrossReference
   ##
   # Returns a method reference to +name+.
 
-  def resolve_method name
+  def resolve_method(name)
     ref = nil
 
     if /#{CLASS_REGEXP_STR}([.#]|::)#{METHOD_REGEXP_STR}/o =~ name then
@@ -187,7 +187,7 @@ class RDoc::CrossReference
   # returned.  If +name+ is escaped +name+ is returned.  If +name+ is not
   # found +text+ is returned.
 
-  def resolve name, text
+  def resolve(name, text)
     return @seen[name] if @seen.include? name
 
     ref = case name

data/lib/rdoc/encoding.rb

@@ -29,7 +29,7 @@ module RDoc::Encoding
   # If +force_transcode+ is true the document will be transcoded and any
   # unknown character in the target encoding will be replaced with '?'
 
-  def self.read_file filename, encoding, force_transcode = false
+  def self.read_file(filename, encoding, force_transcode = false)
     content = File.open filename, "rb" do |f| f.read end
     content.gsub!("\r\n", "\n") if RUBY_PLATFORM =~ /mswin|mingw/
 
@@ -89,7 +89,7 @@ module RDoc::Encoding
   ##
   # Detects the encoding of +string+ based on the magic comment
 
-  def self.detect_encoding string
+  def self.detect_encoding(string)
     result = HEADER_REGEXP.match string
     name = result && result[:name]
 
@@ -99,7 +99,7 @@ module RDoc::Encoding
   ##
   # Removes magic comments and shebang
 
-  def self.remove_magic_comment string
+  def self.remove_magic_comment(string)
     string.sub HEADER_REGEXP do |s|
       s.gsub(/[^\n]/, '')
     end
@@ -109,7 +109,7 @@ module RDoc::Encoding
   # Changes encoding based on +encoding+ without converting and returns new
   # string
 
-  def self.change_encoding text, encoding
+  def self.change_encoding(text, encoding)
     if text.kind_of? RDoc::Comment
       text.encode! encoding
     else

data/lib/rdoc/erb_partial.rb

@@ -9,7 +9,7 @@ class RDoc::ERBPartial < ERB
   # Overrides +compiler+ startup to set the +eoutvar+ to an empty string only
   # if it isn't already set.
 
-  def set_eoutvar compiler, eoutvar = '_erbout'
+  def set_eoutvar(compiler, eoutvar = '_erbout')
     super
 
     compiler.pre_cmd = ["#{eoutvar} ||= +''"]

data/lib/rdoc/erbio.rb

@@ -20,14 +20,14 @@ class RDoc::ERBIO < ERB
   ##
   # Defaults +eoutvar+ to 'io', otherwise is identical to ERB's initialize
 
-  def initialize str, trim_mode: nil, eoutvar: 'io'
+  def initialize(str, trim_mode: nil, eoutvar: 'io')
     super(str, trim_mode: trim_mode, eoutvar: eoutvar)
   end
 
   ##
   # Instructs +compiler+ how to write to +io_variable+
 
-  def set_eoutvar compiler, io_variable
+  def set_eoutvar(compiler, io_variable)
     compiler.put_cmd    = "#{io_variable}.write"
     compiler.insert_cmd = "#{io_variable}.write"
     compiler.pre_cmd    = []

data/lib/rdoc/generator/darkfish.rb

@@ -150,7 +150,7 @@ class RDoc::Generator::Darkfish
   ##
   # Initialize a few instance variables before we start
 
-  def initialize store, options
+  def initialize(store, options)
     @store   = store
     @options = options
 
@@ -269,7 +269,7 @@ class RDoc::Generator::Darkfish
   # Return a list of the documented modules sorted by salience first, then
   # by name.
 
-  def get_sorted_module_list classes
+  def get_sorted_module_list(classes)
     classes.select do |klass|
       klass.display?
     end.sort
@@ -313,7 +313,7 @@ class RDoc::Generator::Darkfish
   ##
   # Generates a class file for +klass+
 
-  def generate_class klass, template_file = nil
+  def generate_class(klass, template_file = nil)
     current = klass
 
     template_file ||= @template_dir + 'class.rhtml'
@@ -435,7 +435,7 @@ class RDoc::Generator::Darkfish
   ##
   # Generate a page file for +file+
 
-  def generate_page file
+  def generate_page(file)
     template_file = @template_dir + 'page.rhtml'
 
     out_file = @outputdir + file.path
@@ -462,7 +462,7 @@ class RDoc::Generator::Darkfish
   ##
   # Generates the 404 page for the RDoc servlet
 
-  def generate_servlet_not_found message
+  def generate_servlet_not_found(message)
     template_file = @template_dir + 'servlet_not_found.rhtml'
     return unless template_file.exist?
 
@@ -493,7 +493,7 @@ class RDoc::Generator::Darkfish
   ##
   # Generates the servlet root page for the RDoc servlet
 
-  def generate_servlet_root installed
+  def generate_servlet_root(installed)
     template_file = @template_dir + 'servlet_root.rhtml'
     return unless template_file.exist?
 
@@ -547,7 +547,7 @@ class RDoc::Generator::Darkfish
     raise error
   end
 
-  def install_rdoc_static_file source, destination, options # :nodoc:
+  def install_rdoc_static_file(source, destination, options) # :nodoc:
     return unless source.exist?
 
     begin
@@ -586,7 +586,7 @@ class RDoc::Generator::Darkfish
   # For backwards compatibility, if +body_file+ contains "<html" the body is
   # used directly.
 
-  def assemble_template body_file
+  def assemble_template(body_file)
     body = body_file.read
     return body if body =~ /<html/
 
@@ -595,7 +595,7 @@ class RDoc::Generator::Darkfish
     <<-TEMPLATE
 <!DOCTYPE html>
 
-<html>
+<html lang="#{@options.locale&.name || 'en'}">
 <head>
 #{head_file.read}
 
@@ -607,7 +607,7 @@ class RDoc::Generator::Darkfish
   # Renders the ERb contained in +file_name+ relative to the template
   # directory and returns the result based on the current context.
 
-  def render file_name
+  def render(file_name)
     template_file = @template_dir + file_name
 
     template = template_for template_file, false, RDoc::ERBPartial
@@ -625,7 +625,7 @@ class RDoc::Generator::Darkfish
   #
   # An io will be yielded which must be captured by binding in the caller.
 
-  def render_template template_file, out_file = nil # :yield: io
+  def render_template(template_file, out_file = nil) # :yield: io
     io_output = out_file && !@dry_run && @file_output
     erb_klass = io_output ? RDoc::ERBIO : ERB
 
@@ -659,7 +659,7 @@ class RDoc::Generator::Darkfish
   # Creates the result for +template+ with +context+.  If an error is raised a
   # Pathname +template_file+ will indicate the file where the error occurred.
 
-  def template_result template, context, template_file
+  def template_result(template, context, template_file)
     template.filename = template_file.to_s
     template.result context
   rescue NoMethodError => e
@@ -672,7 +672,7 @@ class RDoc::Generator::Darkfish
   ##
   # Retrieves a cache template for +file+, if present, or fills the cache.
 
-  def template_for file, page = true, klass = ERB
+  def template_for(file, page = true, klass = ERB)
     template = @template_cache[file]
 
     return template if template
@@ -793,7 +793,7 @@ class RDoc::Generator::Darkfish
 
   private
 
-  def nesting_namespaces_to_class_modules klass
+  def nesting_namespaces_to_class_modules(klass)
     tree = {}
 
     klass.nesting_namespaces.zip(klass.fully_qualified_nesting_namespaces) do |ns, fqns|
@@ -803,7 +803,7 @@ class RDoc::Generator::Darkfish
     tree
   end
 
-  def generate_nesting_namespaces_breadcrumb klass, rel_prefix
+  def generate_nesting_namespaces_breadcrumb(klass, rel_prefix)
     nesting_namespaces_to_class_modules(klass).map do |namespace, class_module|
       path = class_module ? (rel_prefix + class_module.path).to_s : ""
       { name: namespace, path: path, self: klass.full_name == class_module&.full_name }

data/lib/rdoc/generator/json_index.rb

@@ -89,7 +89,7 @@ class RDoc::Generator::JsonIndex
   # Creates a new generator.
   # +options+ are the same options passed to the parent generator.
 
-  def initialize parent_generator, options
+  def initialize(parent_generator, options)
     @parent_generator = parent_generator
     @store            = parent_generator.store
     @options          = options
@@ -263,7 +263,7 @@ class RDoc::Generator::JsonIndex
     end
   end
 
-  def reset files, classes # :nodoc:
+  def reset(files, classes) # :nodoc:
     @files   = files
     @classes = classes
 
@@ -277,7 +277,7 @@ class RDoc::Generator::JsonIndex
   ##
   # Removes whitespace and downcases +string+
 
-  def search_string string
+  def search_string(string)
     string.downcase.gsub(/\s/, '')
   end
 

data/lib/rdoc/generator/markup.rb

@@ -55,6 +55,18 @@ module RDoc::Generator::Markup
     end
   end
 
+  ##
+  # The preferred URL for this object.
+
+  def canonical_url
+    options = @store.options
+    if path
+      File.join(options.canonical_root, path.to_s)
+    else
+      options.canonical_root
+    end
+  end
+
 end
 
 class RDoc::CodeObject

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

@@ -7,7 +7,7 @@ class RDoc::Generator::POT::MessageExtractor
   ##
   # Creates a message extractor for +store+.
 
-  def initialize store
+  def initialize(store)
     @store = store
     @po = RDoc::Generator::POT::PO.new
   end
@@ -25,7 +25,7 @@ class RDoc::Generator::POT::MessageExtractor
 
   private
 
-  def extract_from_klass klass
+  def extract_from_klass(klass)
     extract_text(klass.comment_location, klass.full_name)
 
     klass.each_section do |section, constants, attributes|
@@ -48,7 +48,7 @@ class RDoc::Generator::POT::MessageExtractor
     end
   end
 
-  def extract_text text, comment, location = nil
+  def extract_text(text, comment, location = nil)
     return if text.nil?
 
     options = {
@@ -61,7 +61,7 @@ class RDoc::Generator::POT::MessageExtractor
     end
   end
 
-  def entry msgid, options
+  def entry(msgid, options)
     RDoc::Generator::POT::POEntry.new(msgid, options)
   end
 

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

@@ -15,7 +15,7 @@ class RDoc::Generator::POT::PO
   ##
   # Adds a PO entry to the PO.
 
-  def add entry
+  def add(entry)
     existing_entry = @entries[entry.msgid]
     if existing_entry
       entry = existing_entry.merge(entry)

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

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/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 {

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