rdoc 6.12.0 → 6.14.1

data/lib/rdoc/text.rb

@@ -52,7 +52,7 @@ module RDoc::Text
   ##
   # Transcodes +character+ to +encoding+ with a +fallback+ character.
 
-  def self.encode_fallback character, encoding, fallback
+  def self.encode_fallback(character, encoding, fallback)
     character.encode(encoding, :fallback => { character => fallback },
                      :undef => :replace, :replace => fallback)
   end
@@ -60,7 +60,7 @@ module RDoc::Text
   ##
   # Expands tab characters in +text+ to eight spaces
 
-  def expand_tabs text
+  def expand_tabs(text)
     expanded = []
 
     text.each_line do |line|
@@ -79,7 +79,7 @@ module RDoc::Text
   ##
   # Flush +text+ left based on the shortest line
 
-  def flush_left text
+  def flush_left(text)
     indent = 9999
 
     text.each_line do |line|
@@ -98,9 +98,9 @@ module RDoc::Text
   #
   # Requires the including class to implement #formatter
 
-  def markup text
-    if @store.rdoc.options
-      locale = @store.rdoc.options.locale
+  def markup(text)
+    if @store.options
+      locale = @store.options.locale
     else
       locale = nil
     end
@@ -114,7 +114,7 @@ module RDoc::Text
   ##
   # Strips hashes, expands tabs then flushes +text+ to the left
 
-  def normalize_comment text
+  def normalize_comment(text)
     return text if text.empty?
 
     case language
@@ -132,7 +132,7 @@ module RDoc::Text
   ##
   # Normalizes +text+ then builds a RDoc::Markup::Document from it
 
-  def parse text, format = 'rdoc'
+  def parse(text, format = 'rdoc')
     return text if RDoc::Markup::Document === text
     return text.parse if RDoc::Comment === text
 
@@ -146,7 +146,7 @@ module RDoc::Text
   ##
   # The first +limit+ characters of +text+ as HTML
 
-  def snippet text, limit = 100
+  def snippet(text, limit = 100)
     document = parse text
 
     RDoc::Markup::ToHtmlSnippet.new(options, limit).convert document
@@ -155,7 +155,7 @@ module RDoc::Text
   ##
   # Strips leading # characters from +text+
 
-  def strip_hashes text
+  def strip_hashes(text)
     return text if text =~ /^(?>\s*)[^\#]/
 
     empty = ''
@@ -167,14 +167,14 @@ module RDoc::Text
   ##
   # Strips leading and trailing \n characters from +text+
 
-  def strip_newlines text
+  def strip_newlines(text)
     text.gsub(/\A\n*(.*?)\n*\z/m) do $1 end # block preserves String encoding
   end
 
   ##
   # Strips /* */ style comments
 
-  def strip_stars text
+  def strip_stars(text)
     return text unless text =~ %r%/\*.*\*/%m
 
     encoding = text.encoding
@@ -197,7 +197,7 @@ module RDoc::Text
   # Converts ampersand, dashes, ellipsis, quotes, copyright and registered
   # trademark symbols in +text+ to properly encoded characters.
 
-  def to_html text
+  def to_html(text)
     html = (''.encode text.encoding).dup
 
     encoded = RDoc::Text::TO_HTML_CHARACTERS[text.encoding]

data/lib/rdoc/token_stream.rb

@@ -13,7 +13,7 @@ module RDoc::TokenStream
   # <tt><span></tt> elements. Some tokens types are wrapped in spans
   # with the given class names. Other token types are not wrapped in spans.
 
-  def self.to_html token_stream
+  def self.to_html(token_stream)
     starting_title = false
 
     token_stream.map do |t|

data/lib/rdoc/tom_doc.rb

@@ -75,7 +75,7 @@ class RDoc::TomDoc < RDoc::Markup::Parser
   #
   # Returns an RDoc::Markup::Document representing the TomDoc format.
 
-  def self.parse text
+  def self.parse(text)
     parser = new
 
     parser.tokenize text
@@ -91,7 +91,7 @@ class RDoc::TomDoc < RDoc::Markup::Parser
   #
   # Returns a String containing the signature and nil if not
 
-  def self.signature comment
+  def self.signature(comment)
     return unless comment.tomdoc?
 
     document = comment.parse
@@ -134,7 +134,7 @@ class RDoc::TomDoc < RDoc::Markup::Parser
   #
   # Returns an RDoc::Markup::Heading
 
-  def build_heading level
+  def build_heading(level)
     heading = super
 
     @section = heading.text
@@ -150,7 +150,7 @@ class RDoc::TomDoc < RDoc::Markup::Parser
   #
   # Returns an RDoc::Markup::Verbatim
 
-  def build_verbatim margin
+  def build_verbatim(margin)
     verbatim = super
 
     verbatim.format = :ruby if @section == 'Examples'
@@ -164,7 +164,7 @@ class RDoc::TomDoc < RDoc::Markup::Parser
   #
   # Returns an RDoc::Markup::Paragraph.
 
-  def build_paragraph margin
+  def build_paragraph(margin)
     p :paragraph_start => margin if @debug
 
     paragraph = RDoc::Markup::Paragraph.new
@@ -204,7 +204,7 @@ class RDoc::TomDoc < RDoc::Markup::Parser
   ##
   # Detects a section change to "Returns" and adds a heading
 
-  def parse_text parent, indent # :nodoc:
+  def parse_text(parent, indent) # :nodoc:
     paragraph = build_paragraph indent
 
     if false == @seen_returns and 'Returns' == @section then
@@ -222,7 +222,7 @@ class RDoc::TomDoc < RDoc::Markup::Parser
   #
   # Returns self.
 
-  def tokenize text
+  def tokenize(text)
     text = text.sub(/\A(Public|Internal|Deprecated):\s+/, '')
 
     setup_scanner text

data/lib/rdoc/version.rb

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

data/man/ri.1

@@ -36,6 +36,8 @@ can be:
 .It Class::method | Class#method | Class.method | method
 .Pp
 .It gem_name: | gem_name:README | gem_name:History
+.Pp
+.It ruby: | ruby:NEWS | ruby:globals
 .El
 .Pp
 All class names may be abbreviated to their minimum unambiguous form.

data/rdoc.gemspec

@@ -0,0 +1,69 @@
+begin
+  require_relative "lib/rdoc/version"
+rescue LoadError
+  # for Ruby repository
+  require_relative "version"
+end
+
+Gem::Specification.new do |s|
+  s.name = "rdoc"
+  s.version = RDoc::VERSION
+
+  s.authors = [
+    "Eric Hodel",
+    "Dave Thomas",
+    "Phil Hagelberg",
+    "Tony Strauss",
+    "Zachary Scott",
+    "Hiroshi SHIBATA",
+    "ITOYANAGI Sakura"
+  ]
+  s.email = ["drbrain@segment7.net", "", "", "", "mail@zzak.io", "hsbt@ruby-lang.org", "aycabta@gmail.com"]
+
+  s.summary = "RDoc produces HTML and command-line documentation for Ruby projects"
+  s.description = <<-DESCRIPTION
+RDoc produces HTML and command-line documentation for Ruby projects.
+RDoc includes the +rdoc+ and +ri+ tools for generating and displaying documentation from the command-line.
+  DESCRIPTION
+  s.homepage = "https://ruby.github.io/rdoc"
+  s.licenses = ["Ruby"]
+
+  s.metadata["homepage_uri"] = s.homepage
+  s.metadata["source_code_uri"] = "https://github.com/ruby/rdoc"
+  s.metadata["changelog_uri"] = "#{s.metadata["source_code_uri"]}/releases"
+
+  s.bindir = "exe"
+  s.executables = ["rdoc", "ri"]
+  s.require_paths = ["lib"]
+  # for ruby core repository. It was generated by
+  # `git ls-files -z`.split("\x0").each {|f| puts "    #{f.dump}," unless f.start_with?(*%W[test/ spec/ features/ .]) }
+  non_lib_files = [
+    "CONTRIBUTING.rdoc",
+    "CVE-2013-0256.rdoc",
+    "ExampleMarkdown.md",
+    "ExampleRDoc.rdoc",
+    "History.rdoc",
+    "LEGAL.rdoc",
+    "LICENSE.rdoc",
+    "README.rdoc",
+    "RI.md",
+    "TODO.rdoc",
+    "exe/rdoc",
+    "exe/ri",
+    "man/ri.1",
+    "rdoc.gemspec",
+  ]
+  template_files = Dir.glob("lib/rdoc/generator/template/**/*")
+  lib_files = Dir.glob("lib/**/*.{rb,kpeg,ry}", base: File.expand_path('..', __FILE__))
+
+  s.files = (non_lib_files + template_files + lib_files).uniq
+
+  s.rdoc_options = ["--main", "README.rdoc"]
+  s.extra_rdoc_files += s.files.grep(%r[\A[^\/]+\.(?:rdoc|md)\z])
+
+  s.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
+  s.required_rubygems_version = Gem::Requirement.new(">= 2.2")
+
+  s.add_dependency 'psych', '>= 4.0.0'
+  s.add_dependency 'erb'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rdoc
 version: !ruby/object:Gem::Version
-  version: 6.12.0
+  version: 6.14.1
 platform: ruby
 authors:
 - Eric Hodel
@@ -13,7 +13,7 @@ authors:
 - ITOYANAGI Sakura
 bindir: exe
 cert_chain: []
-date: 2025-02-06 00:00:00.000000000 Z
+date: 2025-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: psych
@@ -29,6 +29,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: erb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |
   RDoc produces HTML and command-line documentation for Ruby projects.
   RDoc includes the +rdoc+ and +ri+ tools for generating and displaying documentation from the command-line.
@@ -106,10 +120,8 @@ files:
 - lib/rdoc/generator/ri.rb
 - lib/rdoc/generator/template/darkfish/_footer.rhtml
 - lib/rdoc/generator/template/darkfish/_head.rhtml
-- lib/rdoc/generator/template/darkfish/_sidebar_VCS_info.rhtml
 - lib/rdoc/generator/template/darkfish/_sidebar_classes.rhtml
 - lib/rdoc/generator/template/darkfish/_sidebar_extends.rhtml
-- lib/rdoc/generator/template/darkfish/_sidebar_in_files.rhtml
 - lib/rdoc/generator/template/darkfish/_sidebar_includes.rhtml
 - lib/rdoc/generator/template/darkfish/_sidebar_installed.rhtml
 - lib/rdoc/generator/template/darkfish/_sidebar_methods.rhtml
@@ -246,6 +258,7 @@ files:
 - lib/rdoc/version.rb
 - lib/rubygems_plugin.rb
 - man/ri.1
+- rdoc.gemspec
 homepage: https://ruby.github.io/rdoc
 licenses:
 - Ruby
@@ -269,7 +282,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '2.2'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.7
 specification_version: 4
 summary: RDoc produces HTML and command-line documentation for Ruby projects
 test_files: []

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

@@ -1,19 +0,0 @@
-<%- if !svninfo.empty? then %>
-<div id="file-svninfo-section" class="nav-section">
-  <h3>VCS Info</h3>
-
-  <div class="section-body">
-    <dl class="svninfo">
-      <dt>Rev
-      <dd><%= svninfo[:rev] %>
-
-      <dt>Last Checked In
-      <dd><%= svninfo[:commitdate].strftime('%Y-%m-%d %H:%M:%S') %>
-        (<%= svninfo[:commitdelta] %> ago)
-
-      <dt>Checked in by
-      <dd><%= svninfo[:committer] %>
-    </dl>
-  </div>
-</div>
-<%- end -%>

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

@@ -1,9 +0,0 @@
-<div id="file-list-section" class="nav-section">
-  <h3>Defined In</h3>
-
-  <ul>
-<%- klass.in_files.each do |tl| -%>
-    <li><%= h tl.relative_name %>
-<%- end -%>
-  </ul>
-</div>