rdoc 6.2.1 → 6.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ed13122ed21f8a23f92864685b11e29d15bded252571e52a16ca87318c84063
-  data.tar.gz: 96904ccc1312e72b6418b55132b810f52a5ace7004ad9c12ac4d37be258cae14
+  metadata.gz: 18741ef6dd2db34af2ea15a9e8a154a760c1f01bb0d69d15dc3af3f70cc00d7c
+  data.tar.gz: e61ab91ee4b0e776dd36e934da0534e6d52aa259ddff18be057955e109db08b4
 SHA512:
-  metadata.gz: ee977c75f90e1ec1b928fef68a78c737bface67434386ad6dda066e873d3da6b5c19bdfa8719614367be5a54fc0e9e89f342bd0766bbb067cf33eaf3fd06c7f9
-  data.tar.gz: 1434f635ecd255f3ab22bd90d1397f9c90189810c5d251e7f0557728239ce0aa4f967d21c49623a67459244c041fa4b2c38cc4504ed509ad6522f244a8eeece8
+  metadata.gz: 9ea75c4b0339de23f73f84c890b23cb0b7bacb87ea191258f54160a28a4519c0e8edfbf6bc17ef67e631d923b17cb2030f79048d269b032eefe8b92f62fdb9df
+  data.tar.gz: bdbf42dea5706d0b13ce653a8591ff9fc0ece11b4d49c18e7d32bd725e901a3dd2e5feb3479b4185a874d12e024e7f77b6324592405a9b826efd00bb68589373

data/lib/rdoc.rb

@@ -120,6 +120,27 @@ module RDoc
     end
   end
 
+  def self.home
+    rdoc_dir = begin
+                File.expand_path('~/.rdoc')
+              rescue ArgumentError
+              end
+
+    if File.directory?(rdoc_dir)
+      rdoc_dir
+    else
+      begin
+        # XDG
+        xdg_data_home = ENV["XDG_DATA_HOME"] || File.join(File.expand_path("~"), '.local', 'share')
+        unless File.exist?(xdg_data_home)
+          FileUtils.mkdir_p xdg_data_home
+        end
+        File.join xdg_data_home, "rdoc"
+      rescue Errno::EACCES
+      end
+    end
+  end
+
   autoload :RDoc,           'rdoc/rdoc'
 
   autoload :CrossReference, 'rdoc/cross_reference'

data/lib/rdoc/any_method.rb

@@ -26,12 +26,6 @@ class RDoc::AnyMethod < RDoc::MethodAttr
 
   attr_accessor :c_function
 
-  ##
-  # Different ways to call this method
-
-  attr_reader :call_seq
-
-  ##
   # Parameters for this method
 
   attr_accessor :params
@@ -93,6 +87,19 @@ class RDoc::AnyMethod < RDoc::MethodAttr
     end
   end
 
+  ##
+  # Different ways to call this method
+
+  def call_seq
+    unless call_seq = _call_seq
+      call_seq = is_alias_for._call_seq if is_alias_for
+    end
+
+    return unless call_seq
+
+    deduplicate_call_seq(call_seq)
+  end
+
   ##
   # Sets the different ways you can call this method.  If an empty +call_seq+
   # is given nil is assumed.
@@ -312,5 +319,43 @@ class RDoc::AnyMethod < RDoc::MethodAttr
     @superclass_method
   end
 
-end
+  protected
+
+  ##
+  # call_seq without deduplication and alias lookup.
+
+  def _call_seq
+    @call_seq if defined?(@call_seq) && @call_seq
+  end
+
+  private
+
+  ##
+  # call_seq with alias examples information removed, if this
+  # method is an alias method.
+
+  def deduplicate_call_seq(call_seq)
+    return call_seq unless is_alias_for || !aliases.empty?
+
+    method_name = self.name
+    method_name = method_name[0, 1] if method_name =~ /\A\[/
 
+    entries = call_seq.split "\n"
+
+    ignore = aliases.map(&:name)
+    if is_alias_for
+      ignore << is_alias_for.name
+      ignore.concat is_alias_for.aliases.map(&:name)
+    end
+    ignore.map! { |n| n =~ /\A\[/ ? n[0, 1] : n}
+    ignore.delete(method_name)
+    ignore = Regexp.union(ignore)
+
+    matching = entries.reject do |entry|
+      entry =~ /^\w*\.?#{ignore}/ or
+        entry =~ /\s#{ignore}\s/
+    end
+
+    matching.join "\n"
+  end
+end

data/lib/rdoc/context.rb

@@ -990,13 +990,21 @@ class RDoc::Context < RDoc::CodeObject
     @instance_attributes ||= attributes.reject { |a| a.singleton }
   end
 
+  ##
+  # Instance methods
+
+  def instance_methods
+    @instance_methods ||= method_list.reject { |a| a.singleton }
+  end
+
   ##
   # Instance methods
   #--
-  # TODO rename to instance_methods
+  # TODO remove this later
 
   def instance_method_list
-    @instance_method_list ||= method_list.reject { |a| a.singleton }
+    warn '#instance_method_list is obsoleted, please use #instance_methods'
+    @instance_methods ||= method_list.reject { |a| a.singleton }
   end
 
   ##

data/lib/rdoc/context/section.rb

@@ -34,8 +34,6 @@ class RDoc::Context::Section
 
   attr_reader :title
 
-  @@sequence = "SEC00000"
-
   ##
   # Creates a new section with +title+ and +comment+
 
@@ -43,9 +41,6 @@ class RDoc::Context::Section
     @parent = parent
     @title = title ? title.strip : title
 
-    @@sequence = @@sequence.succ
-    @sequence = @@sequence.dup
-
     @comments = []
 
     add_comment comment
@@ -233,13 +228,5 @@ class RDoc::Context::Section
     end
   end
 
-  ##
-  # Section sequence number (deprecated)
-
-  def sequence
-    warn "RDoc::Context::Section#sequence is deprecated, use #aref"
-    @sequence
-  end
-
 end
 

data/lib/rdoc/cross_reference.rb

@@ -19,7 +19,7 @@ class RDoc::CrossReference
   #
   # See CLASS_REGEXP_STR
 
-  METHOD_REGEXP_STR = '([a-z]\w*[!?=]?|%|===|\[\]=?|<<|>>|-|\+|\*)(?:\([\w.+*/=<>-]*\))?'
+  METHOD_REGEXP_STR = '([a-z]\w*[!?=]?|%|===|\[\]=?|<<|>>|\+@|-@|-|\+|\*)(?:\([\w.+*/=<>-]*\))?'
 
   ##
   # Regular expressions matching text that should potentially have
@@ -173,7 +173,7 @@ class RDoc::CrossReference
           end unless ref
 
     # Try a page name
-    ref = @store.page name if not ref and name =~ /^\w+$/
+    ref = @store.page name if not ref and name =~ /^[\w.]+$/
 
     ref = nil if RDoc::Alias === ref # external alias, can't link to it
 

data/lib/rdoc/erb_partial.rb

@@ -12,7 +12,7 @@ class RDoc::ERBPartial < ERB
   def set_eoutvar compiler, eoutvar = '_erbout'
     super
 
-    compiler.pre_cmd = ["#{eoutvar} ||= ''"]
+    compiler.pre_cmd = ["#{eoutvar} ||= +''"]
   end
 
 end

data/lib/rdoc/erbio.rb

@@ -20,11 +20,11 @@ class RDoc::ERBIO < ERB
   ##
   # Defaults +eoutvar+ to 'io', otherwise is identical to ERB's initialize
 
-  def initialize str, safe_level = nil, trim_mode = nil, eoutvar = 'io'
+  def initialize str, safe_level = nil, legacy_trim_mode = nil, legacy_eoutvar = 'io', trim_mode: nil, eoutvar: 'io'
     if RUBY_VERSION >= '2.6'
       super(str, trim_mode: trim_mode, eoutvar: eoutvar)
     else
-      super
+      super(str, safe_level, legacy_trim_mode, legacy_eoutvar)
     end
   end
 

data/lib/rdoc/generator/darkfish.rb

@@ -4,7 +4,7 @@
 require 'erb'
 require 'fileutils'
 require 'pathname'
-require 'rdoc/generator/markup'
+require_relative 'markup'
 
 ##
 # Darkfish RDoc HTML Generator
@@ -779,9 +779,9 @@ class RDoc::Generator::Darkfish
     end
 
     if RUBY_VERSION >= '2.6'
-      template = klass.new template, trim_mode: '<>', eoutvar: erbout
+      template = klass.new template, trim_mode: '-', eoutvar: erbout
     else
-      template = klass.new template, nil, '<>', erbout
+      template = klass.new template, nil, '-', erbout
     end
     @template_cache[file] = template
     template

data/lib/rdoc/generator/pot.rb

@@ -91,8 +91,8 @@ class RDoc::Generator::POT
     extractor.extract
   end
 
-  require 'rdoc/generator/pot/message_extractor'
-  require 'rdoc/generator/pot/po'
-  require 'rdoc/generator/pot/po_entry'
+  require_relative 'pot/message_extractor'
+  require_relative 'pot/po'
+  require_relative 'pot/po_entry'
 
 end

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

@@ -15,9 +15,8 @@
 
 <link href="<%= asset_rel_prefix %>/css/fonts.css" rel="stylesheet">
 <link href="<%= asset_rel_prefix %>/css/rdoc.css" rel="stylesheet">
-<% if @options.template_stylesheets.flatten.any? then %>
-<%   @options.template_stylesheets.flatten.each do |stylesheet| %>
+<%- if @options.template_stylesheets.flatten.any? then -%>
+<%-   @options.template_stylesheets.flatten.each do |stylesheet| -%>
 <link href="<%= asset_rel_prefix %>/<%= File.basename stylesheet %>" rel="stylesheet">
-<%   end %>
-<% end %>
-
+<%-   end -%>
+<%- end -%>

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

@@ -1,4 +1,4 @@
-<% if !svninfo.empty? then %>
+<%- if !svninfo.empty? then %>
 <div id="file-svninfo-section" class="nav-section">
   <h3>VCS Info</h3>
 
@@ -16,4 +16,4 @@
     </dl>
   </div>
 </div>
-<% end %>
+<%- end -%>

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

@@ -2,8 +2,8 @@
   <h3>Class and Module Index</h3>
 
   <ul class="link-list">
-  <% @modsort.each do |index_klass| %>
+  <%- @modsort.each do |index_klass| -%>
     <li><a href="<%= rel_prefix %>/<%= index_klass.path %>"><%= index_klass.full_name %></a>
-  <% end %>
+  <%- end -%>
   </ul>
 </div>

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

@@ -1,15 +1,15 @@
-<% unless klass.extends.empty? then %>
+<%- unless klass.extends.empty? then %>
 <div id="extends-section" class="nav-section">
   <h3>Extended With Modules</h3>
 
   <ul class="link-list">
-    <% klass.each_extend do |ext| %>
-  <% unless String === ext.module then %>
+    <%- klass.each_extend do |ext| -%>
+  <%- unless String === ext.module then -%>
     <li><a class="extend" href="<%= klass.aref_to ext.module.path %>"><%= ext.module.full_name %></a>
-  <% else %>
+  <%- else -%>
     <li><span class="extend"><%= ext.name %></span>
-  <% end %>
-  <% end %>
+  <%- end -%>
+  <%- end -%>
   </ul>
 </div>
-<% end %>
+<%- end -%>

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

@@ -2,8 +2,8 @@
   <h3>Defined In</h3>
 
   <ul>
-<% klass.in_files.each do |tl| %>
+<%- klass.in_files.each do |tl| -%>
     <li><%= h tl.relative_name %>
-<% end %>
+<%- end -%>
   </ul>
 </div>

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

@@ -1,15 +1,15 @@
-<% unless klass.includes.empty? then %>
+<%- unless klass.includes.empty? then %>
 <div id="includes-section" class="nav-section">
   <h3>Included Modules</h3>
 
   <ul class="link-list">
-  <% klass.each_include do |inc| %>
-  <% unless String === inc.module then %>
+  <%- klass.each_include do |inc| -%>
+  <%- unless String === inc.module then -%>
     <li><a class="include" href="<%= klass.aref_to inc.module.path %>"><%= inc.module.full_name %></a>
-  <% else %>
+  <%- else -%>
     <li><span class="include"><%= inc.name %></span>
-  <% end %>
-  <% end %>
+  <%- end -%>
+  <%- end -%>
   </ul>
 </div>
-<% end %>
+<%- end -%>

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

@@ -2,14 +2,14 @@
   <h3>Documentation</h3>
 
   <ul>
-  <% installed.each do |name, href, exists, type, _| %>
-    <% next if type == :extra %>
+  <%- installed.each do |name, href, exists, type, _| -%>
+    <%- next if type == :extra -%>
     <li class="folder">
-    <% if exists then %>
+    <%- if exists then -%>
       <a href="<%= href %>"><%= h name %></a>
-    <% else %>
+    <%- else -%>
       <%= h name %>
-    <% end %>
-  <% end %>
+    <%- end -%>
+  <%- end -%>
   </ul>
 </div>

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

@@ -1,12 +1,12 @@
-<% unless klass.method_list.empty? then %>
+<%- unless klass.method_list.empty? then %>
 <!-- Method Quickref -->
 <div id="method-list-section" class="nav-section">
   <h3>Methods</h3>
 
   <ul class="link-list" role="directory">
-    <% klass.each_method do |meth| %>
-    <li <% if meth.calls_super %>class="calls-super" <% end %>><a href="#<%= meth.aref %>"><%= meth.singleton ? '::' : '#' %><%= h meth.name %></a>
-    <% end %>
+    <%- klass.each_method do |meth| -%>
+    <li <%- if meth.calls_super %>class="calls-super" <%- end %>><a href="#<%= meth.aref %>"><%= meth.singleton ? '::' : '#' %><%= h meth.name -%></a>
+    <%- end -%>
   </ul>
 </div>
-<% end %>
+<%- end -%>

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

@@ -1,12 +1,12 @@
-<% simple_files = @files.select { |f| f.text? } %>
-<% unless simple_files.empty? then %>
+<%- simple_files = @files.select { |f| f.text? } %>
+<%- unless simple_files.empty? then -%>
 <div id="fileindex-section" class="nav-section">
   <h3>Pages</h3>
 
   <ul class="link-list">
-  <% simple_files.each do |f| %>
+  <%- simple_files.each do |f| -%>
     <li><a href="<%= rel_prefix %>/<%= f.path %>"><%= h f.page_name %></a>
-  <% end %>
+  <%- end -%>
   </ul>
 </div>
-<% end %>
+<%- end -%>

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

@@ -1,11 +1,11 @@
-<% if klass.type == 'class' then %>
+<%- if klass.type == 'class' then %>
 <div id="parent-class-section" class="nav-section">
   <h3>Parent</h3>
 
-  <% if klass.superclass and not String === klass.superclass then %>
+  <%- if klass.superclass and not String === klass.superclass then -%>
   <p class="link"><a href="<%= klass.aref_to klass.superclass.path %>"><%= klass.superclass.full_name %></a>
-  <% else %>
+  <%- else -%>
   <p class="link"><%= klass.superclass %>
-  <% end %>
+  <%- end -%>
 </div>
-<% end %>
+<%- end -%>

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

@@ -1,11 +1,11 @@
-<% unless klass.sections.length == 1 then %>
+<%- unless klass.sections.length == 1 then %>
 <div id="sections-section" class="nav-section">
   <h3>Sections</h3>
 
   <ul class="link-list" role="directory">
-    <% klass.sort_sections.each do |section| %>
+    <%- klass.sort_sections.each do |section| -%>
       <li><a href="#<%= section.aref %>"><%= h section.title %></a></li>
-    <% end %>
+    <%- end -%>
   </ul>
 </div>
-<% end %>
+<%- end -%>

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

@@ -1,4 +1,4 @@
-<% comment = if current.respond_to? :comment_location then
+<%- comment = if current.respond_to? :comment_location then
                current.comment_location
              else
                current.comment
@@ -10,9 +10,9 @@
   <h3>Table of Contents</h3>
 
   <ul class="link-list" role="directory">
-<%   table.each do |heading| %>
+<%-   table.each do |heading| -%>
     <li><a href="#<%= heading.label current %>"><%= heading.plain_html %></a>
-<%   end %>
+<%-   end -%>
   </ul>
 </div>
-<% end %>
+<%- end -%>