rdoc 6.6.2 → 6.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 060b06473aafc2a0a07ded738b5be7819ddd0520d7e2033ef72311ff8dd57248
-  data.tar.gz: 500fd282367d6cefeb9257518a0ed5e5371cf3c09a6addc8ac30be1dbe7ba267
+  metadata.gz: 7b5120e82f653957d49d069e88f361f338a2db7f40bdc0756ffcea7d3bd3c4f2
+  data.tar.gz: a0f09a9246684a22992f2deff120c238b24fbe59a20dfdfa87b340fecc9ce297
 SHA512:
-  metadata.gz: 52461100f11f5123da6874e2786b4a83248435fd4955609647421c49a71c5d6ba98bd869fc3c510e64d148992461762b4213390b7aa33bd9dd80d7caad665638
-  data.tar.gz: 87b21e587bc4e2d97b35f56b4be8e28a1ac40961dc5caf2f61ab3500f5f3a9147195b917d329a1264cb6f4605daec30bb5603c2269a09c5a89da359074928805
+  metadata.gz: e0391b650362cb28f505eaf1d258b259debc4d828ad98643e3a27c1a16811d2bf126b40dd3f9872f4d50536e6875a4691e52c4e6d3732850150710866baf0f69
+  data.tar.gz: c8a40bfeedd964ce6b42781c1ee6c93dda1917a3333b79ebe8b886cd26a8fe49b32522a156c39c99811134fa8bd60612aface400f06641bea155d07a9de6ec2a

data/CONTRIBUTING.rdoc

@@ -40,7 +40,7 @@ If the tests don't pass on the first run check the {GitHub Actions page}[https:/
 You can now use `rake` and `autotest` to run the tests.
 
 Note: the `rake` command must be used first before running any tests, because
-its used to generate various parsers implemented in RDoc. Also `rake clean` is
+it's used to generate various parsers implemented in RDoc. Also `rake clean` is
 helpful to delete these generated files.
 
 == Glossary

data/lib/rdoc/context.rb

@@ -710,7 +710,7 @@ class RDoc::Context < RDoc::CodeObject
   # This method exists to make it easy to work with Context subclasses that
   # aren't part of RDoc.
 
-  def each_ancestor # :nodoc:
+  def each_ancestor(&_) # :nodoc:
   end
 
   ##

data/lib/rdoc/markdown.kpeg

@@ -9,7 +9,7 @@
 # RDoc::Markdown as described by the [markdown syntax][syntax].
 #
 # To choose Markdown as your only default format see
-# RDoc::Options@Saved+Options for instructions on setting up a `.doc_options`
+# RDoc::Options@Saved+Options for instructions on setting up a `.rdoc_options`
 # file to store your project default.
 #
 # ## Usage
@@ -1237,7 +1237,7 @@ DefinitionListItem = ( DefinitionListLabel+ ):label
                        list_items
                      }
 
-DefinitionListLabel = StrChunk:label @Sp @Newline
+DefinitionListLabel = Inline:label @Sp @Newline
                       { label }
 
 DefinitionListDefinition = @NonindentSpace ":" @Space Inlines:a @BlankLine+

data/lib/rdoc/markdown.rb

@@ -6,7 +6,7 @@
 # RDoc::Markdown as described by the [markdown syntax][syntax].
 #
 # To choose Markdown as your only default format see
-# RDoc::Options@Saved+Options for instructions on setting up a `.doc_options`
+# RDoc::Options@Saved+Options for instructions on setting up a `.rdoc_options`
 # file to store your project default.
 #
 # ## Usage
@@ -16445,12 +16445,12 @@ class RDoc::Markdown
     return _tmp
   end
 
-  # DefinitionListLabel = StrChunk:label @Sp @Newline { label }
+  # DefinitionListLabel = Inline:label @Sp @Newline { label }
   def _DefinitionListLabel
 
     _save = self.pos
     while true # sequence
-      _tmp = apply(:_StrChunk)
+      _tmp = apply(:_Inline)
       label = @result
       unless _tmp
         self.pos = _save
@@ -16777,7 +16777,7 @@ class RDoc::Markdown
   Rules[:_TableAlign] = rule_info("TableAlign", "< /:?-+:?/ > @Sp {                 text.start_with?(\":\") ?                 (text.end_with?(\":\") ? :center : :left) :                 (text.end_with?(\":\") ? :right : nil)               }")
   Rules[:_DefinitionList] = rule_info("DefinitionList", "&{ definition_lists? } DefinitionListItem+:list { RDoc::Markup::List.new :NOTE, *list.flatten }")
   Rules[:_DefinitionListItem] = rule_info("DefinitionListItem", "DefinitionListLabel+:label DefinitionListDefinition+:defns { list_items = []                        list_items <<                          RDoc::Markup::ListItem.new(label, defns.shift)                         list_items.concat defns.map { |defn|                          RDoc::Markup::ListItem.new nil, defn                        } unless list_items.empty?                         list_items                      }")
-  Rules[:_DefinitionListLabel] = rule_info("DefinitionListLabel", "StrChunk:label @Sp @Newline { label }")
+  Rules[:_DefinitionListLabel] = rule_info("DefinitionListLabel", "Inline:label @Sp @Newline { label }")
   Rules[:_DefinitionListDefinition] = rule_info("DefinitionListDefinition", "@NonindentSpace \":\" @Space Inlines:a @BlankLine+ { paragraph a }")
   # :startdoc:
 end

data/lib/rdoc/markup/to_bs.rb

@@ -40,6 +40,31 @@ class RDoc::Markup::ToBs < RDoc::Markup::ToRdoc
     @res << "\n"
   end
 
+  ##
+  # Prepares the visitor for consuming +list_item+
+
+  def accept_list_item_start list_item
+    type = @list_type.last
+
+    case type
+    when :NOTE, :LABEL then
+      bullets = Array(list_item.label).map do |label|
+        attributes(label).strip
+      end.join "\n"
+
+      bullets << ":\n" unless bullets.empty?
+
+      @prefix = ' ' * @indent
+      @indent += 2
+      @prefix << bullets + (' ' * @indent)
+    else
+      bullet = type == :BULLET ? '*' :  @list_index.last.to_s + '.'
+      @prefix = (' ' * @indent) + bullet.ljust(bullet.length + 1)
+      width = bullet.length + 1
+      @indent += width
+    end
+  end
+
   ##
   # Turns on or off regexp handling for +convert_string+
 

data/lib/rdoc/markup/to_html_crossref.rb

@@ -63,8 +63,8 @@ class RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml
 
     name = name[1..-1] unless @show_hash if name[0, 1] == '#'
 
-    if !(name.end_with?('+@', '-@')) and name =~ /(.*[^#:])@/
-      text ||= "#{CGI.unescape $'} at <code>#{$1}</code>"
+    if !(name.end_with?('+@', '-@')) and name =~ /(.*[^#:])?@/
+      text ||= [CGI.unescape($'), (" at <code>#{$1}</code>" if $~.begin(1))].join("")
       code = false
     else
       text ||= name
@@ -139,35 +139,34 @@ class RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml
   # Creates an HTML link to +name+ with the given +text+.
 
   def link name, text, code = true
-    if !(name.end_with?('+@', '-@')) and name =~ /(.*[^#:])@/
+    if !(name.end_with?('+@', '-@')) and name =~ /(.*[^#:])?@/
       name = $1
       label = $'
     end
 
-    ref = @cross_reference.resolve name, text
+    ref = @cross_reference.resolve name, text if name
 
     case ref
     when String then
       ref
     else
-      path = ref.as_href @from_path
+      path = ref ? ref.as_href(@from_path) : +""
 
       if code and RDoc::CodeObject === ref and !(RDoc::TopLevel === ref)
         text = "<code>#{CGI.escapeHTML text}</code>"
       end
 
-      if path =~ /#/ then
-        path << "-label-#{label}"
-      elsif ref.sections and
-            ref.sections.any? { |section| label == section.title } then
-        path << "##{label}"
-      else
-        if ref.respond_to?(:aref)
+      if label
+        if path =~ /#/
+          path << "-label-#{label}"
+        elsif ref&.sections&.any? { |section| label == section.title }
+          path << "##{label}"
+        elsif ref.respond_to?(:aref)
           path << "##{ref.aref}-label-#{label}"
         else
           path << "#label-#{label}"
         end
-      end if label
+      end
 
       "<a href=\"#{path}\">#{text}</a>"
     end

data/lib/rdoc/markup/to_markdown.rb

@@ -45,8 +45,6 @@ class RDoc::Markup::ToMarkdown < RDoc::Markup::ToRdoc
   # Finishes consumption of `list`
 
   def accept_list_end list
-    @res << "\n"
-
     super
   end
 
@@ -60,6 +58,8 @@ class RDoc::Markup::ToMarkdown < RDoc::Markup::ToRdoc
             when :NOTE, :LABEL then
               use_prefix
 
+              @res << "\n"
+
               4
             else
               @list_index[-1] = @list_index.last.succ
@@ -81,11 +81,11 @@ class RDoc::Markup::ToMarkdown < RDoc::Markup::ToRdoc
         attributes(label).strip
       end.join "\n"
 
-      bullets << "\n:"
+      bullets << "\n" unless bullets.empty?
 
       @prefix = ' ' * @indent
       @indent += 4
-      @prefix << bullets + (' ' * (@indent - 1))
+      @prefix << bullets << ":" << (' ' * (@indent - 1))
     else
       bullet = type == :BULLET ? '*' : @list_index.last.to_s + '.'
       @prefix = (' ' * @indent) + bullet.ljust(4)

data/lib/rdoc/markup/to_rdoc.rb

@@ -145,11 +145,19 @@ class RDoc::Markup::ToRdoc < RDoc::Markup::Formatter
 
     case type
     when :NOTE, :LABEL then
-      bullets = Array(list_item.label).map do |label|
+      stripped_labels = Array(list_item.label).map do |label|
         attributes(label).strip
-      end.join "\n"
+      end
+
+      bullets = case type
+      when :NOTE
+        stripped_labels.map { |b| "#{b}::" }
+      when :LABEL
+        stripped_labels.map { |b| "[#{b}]" }
+      end
 
-      bullets << ":\n" unless bullets.empty?
+      bullets = bullets.join("\n")
+      bullets << "\n" unless stripped_labels.empty?
 
       @prefix = ' ' * @indent
       @indent += 2

data/lib/rdoc/options.rb

@@ -105,6 +105,7 @@ class RDoc::Options
     generator_name
     generator_options
     generators
+    locale
     op_dir
     page_dir
     option_parser

data/lib/rdoc/parser/c.rb

@@ -756,17 +756,27 @@ class RDoc::Parser::C < RDoc::Parser
   def gen_const_table file_content
     table = {}
     @content.scan(%r{
-      ((?>^\s*/\*.*?\*/\s+))
-        rb_define_(\w+)\((?:\s*(?:\w+),)?\s*
-                           "(\w+)"\s*,
+      (?<doc>(?>^\s*/\*.*?\*/\s+))
+        rb_define_(?<type>\w+)\(\s*(?:\w+),\s*
+                           "(?<name>\w+)"\s*,
                            .*?\)\s*;
+    |  (?<doc>(?>^\s*/\*.*?\*/\s+))
+        rb_file_(?<type>const)\(\s*
+                           "(?<name>\w+)"\s*,
+                           .*?\)\s*;
+    |  (?<doc>(?>^\s*/\*.*?\*/\s+))
+        rb_curses_define_(?<type>const)\(\s*
+                           (?<name>\w+)
+                           \s*\)\s*;
     | Document-(?:const|global|variable):\s
-        ((?:\w+::)*\w+)
-        \s*?\n((?>.*?\*/))
+        (?<name>(?:\w+::)*\w+)
+        \s*?\n(?<doc>(?>.*?\*/))
     }mxi) do
-      case
-      when $1 then table[[$2, $3]] = $1
-      when $4 then table[$4] = "/*\n" + $5
+      name, doc, type = $~.values_at(:name, :doc, :type)
+      if type
+        table[[type, name]] = doc
+      else
+        table[name] = "/*\n" + doc
       end
     end
     table

data/lib/rdoc/parser/ruby.rb

@@ -789,8 +789,10 @@ class RDoc::Parser::Ruby < RDoc::Parser
     al.line   = line_no
 
     read_documentation_modifiers al, RDoc::ATTR_MODIFIERS
-    context.add_alias al
-    @stats.add_alias al
+    if al.document_self or not @track_visibility
+      context.add_alias al
+      @stats.add_alias al
+    end
 
     al
   end
@@ -1453,6 +1455,12 @@ class RDoc::Parser::Ruby < RDoc::Parser
     meth = RDoc::AnyMethod.new get_tkread, name
     look_for_directives_in meth, comment
     meth.singleton = single == SINGLE ? true : singleton
+    if singleton
+      # `current_line_visibility' is useless because it works against
+      # the normal method named as same as the singleton method, after
+      # the latter was defined.  Of course these are different things.
+      container.current_line_visibility = :public
+    end
 
     record_location meth
     meth.line   = line_no
@@ -1776,6 +1784,7 @@ class RDoc::Parser::Ruby < RDoc::Parser
 
     nest = 1
     save_visibility = container.visibility
+    container.visibility = :public unless current_method
 
     non_comment_seen = true
 

data/lib/rdoc/parser.rb

@@ -125,9 +125,11 @@ class RDoc::Parser
     return parser if ext_name.empty?
 
     if parser == RDoc::Parser::Simple and ext_name !~ /txt|rdoc/ then
-      case check_modeline file_name
+      case mode = check_modeline(file_name)
       when nil, 'rdoc' then # continue
-      else return nil
+      else
+        RDoc::Parser.parsers.find { |_, p| return p if mode.casecmp?(p.name[/\w+\z/]) }
+        return nil
       end
     end
 

data/lib/rdoc/rd/block_parser.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 #
 # DO NOT MODIFY!!!!
-# This file is automatically generated by Racc 1.7.3
+# This file is automatically generated by Racc 1.8.0
 # from Racc grammar file "block_parser.ry".
 #
 
@@ -23,7 +23,7 @@ unless $".find {|p| p.end_with?('/racc/info.rb')}
 $".push "#{__dir__}/racc/info.rb"
 
 module Racc
-  VERSION   = '1.7.3'
+  VERSION   = '1.8.0'
   Version = VERSION
   Copyright = 'Copyright (c) 1999-2006 Minero Aoki'
 end
@@ -31,10 +31,6 @@ end
 end
 
 
-unless defined?(NotImplementedError)
-  NotImplementedError = NotImplementError # :nodoc:
-end
-
 module Racc
   class ParseError < StandardError; end
 end

data/lib/rdoc/rd/inline_parser.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 #
 # DO NOT MODIFY!!!!
-# This file is automatically generated by Racc 1.7.3
+# This file is automatically generated by Racc 1.8.0
 # from Racc grammar file "inline_parser.ry".
 #
 
@@ -23,7 +23,7 @@ unless $".find {|p| p.end_with?('/racc/info.rb')}
 $".push "#{__dir__}/racc/info.rb"
 
 module Racc
-  VERSION   = '1.7.3'
+  VERSION   = '1.8.0'
   Version = VERSION
   Copyright = 'Copyright (c) 1999-2006 Minero Aoki'
 end
@@ -31,10 +31,6 @@ end
 end
 
 
-unless defined?(NotImplementedError)
-  NotImplementedError = NotImplementError # :nodoc:
-end
-
 module Racc
   class ParseError < StandardError; end
 end

data/lib/rdoc/ri/driver.rb

@@ -1088,7 +1088,7 @@ or the PAGER environment variable.
 
     loop do
       name = if defined? Readline then
-               Readline.readline ">> "
+               Readline.readline ">> ", true
              else
                print ">> "
                $stdin.gets

data/lib/rdoc/store.rb

@@ -559,9 +559,7 @@ class RDoc::Store
   def load_cache
     #orig_enc = @encoding
 
-    File.open cache_path, 'rb' do |io|
-      @cache = Marshal.load io
-    end
+    @cache = marshal_load(cache_path)
 
     load_enc = @cache[:encoding]
 
@@ -618,9 +616,7 @@ class RDoc::Store
   def load_class_data klass_name
     file = class_file klass_name
 
-    File.open file, 'rb' do |io|
-      Marshal.load io
-    end
+    marshal_load(file)
   rescue Errno::ENOENT => e
     error = MissingFileError.new(self, file, klass_name)
     error.set_backtrace e.backtrace
@@ -633,14 +629,10 @@ class RDoc::Store
   def load_method klass_name, method_name
     file = method_file klass_name, method_name
 
-    File.open file, 'rb' do |io|
-      obj = Marshal.load io
-      obj.store = self
-      obj.parent =
-        find_class_or_module(klass_name) || load_class(klass_name) unless
-          obj.parent
-      obj
-    end
+    obj = marshal_load(file)
+    obj.store = self
+    obj.parent ||= find_class_or_module(klass_name) || load_class(klass_name)
+    obj
   rescue Errno::ENOENT => e
     error = MissingFileError.new(self, file, klass_name + method_name)
     error.set_backtrace e.backtrace
@@ -653,11 +645,9 @@ class RDoc::Store
   def load_page page_name
     file = page_file page_name
 
-    File.open file, 'rb' do |io|
-      obj = Marshal.load io
-      obj.store = self
-      obj
-    end
+    obj = marshal_load(file)
+    obj.store = self
+    obj
   rescue Errno::ENOENT => e
     error = MissingFileError.new(self, file, page_name)
     error.set_backtrace e.backtrace
@@ -979,4 +969,21 @@ class RDoc::Store
     @unique_modules
   end
 
+  private
+  def marshal_load(file)
+    File.open(file, 'rb') {|io| Marshal.load(io, MarshalFilter)}
+  end
+
+  MarshalFilter = proc do |obj|
+    case obj
+    when true, false, nil, Array, Class, Encoding, Hash, Integer, String, Symbol, RDoc::Text
+    else
+      unless obj.class.name.start_with?("RDoc::")
+        raise TypeError, "not permitted class: #{obj.class.name}"
+      end
+    end
+    obj
+  end
+  private_constant :MarshalFilter
+
 end

data/lib/rdoc/version.rb

@@ -5,6 +5,6 @@ module RDoc
   ##
   # RDoc version you are using
 
-  VERSION = '6.6.2'
+  VERSION = '6.7.0'
 
 end

data/lib/rdoc.rb

@@ -121,7 +121,7 @@ module RDoc
   end
 
   ##
-  # Seaches and returns the directory for settings.
+  # Searches and returns the directory for settings.
   #
   # 1. <tt>$HOME/.rdoc</tt> directory, if it exists.
   # 2. The +rdoc+ directory under the path specified by the

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rdoc
 version: !ruby/object:Gem::Version
-  version: 6.6.2
+  version: 6.7.0
 platform: ruby
 authors:
 - Eric Hodel
@@ -11,10 +11,9 @@ authors:
 - Zachary Scott
 - Hiroshi SHIBATA
 - ITOYANAGI Sakura
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-16 00:00:00.000000000 Z
+date: 2024-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: psych
@@ -253,7 +252,6 @@ metadata:
   homepage_uri: https://ruby.github.io/rdoc
   source_code_uri: https://github.com/ruby/rdoc
   changelog_uri: https://github.com/ruby/rdoc/releases
-post_install_message:
 rdoc_options:
 - "--main"
 - README.rdoc
@@ -270,8 +268,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '2.2'
 requirements: []
-rubygems_version: 3.5.0.dev
-signing_key:
+rubygems_version: 3.6.0.dev
 specification_version: 4
 summary: RDoc produces HTML and command-line documentation for Ruby projects
 test_files: []