rdoc 4.3.0 → 5.0.0.beta1

data/lib/rdoc/markup/to_bs.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 ##
 # Outputs RDoc markup with hot backspace action!  You will probably need a
 # pager to use this output format.

data/lib/rdoc/markup/to_html.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 require 'cgi'
 
 ##

data/lib/rdoc/markup/to_html_crossref.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 ##
 # Subclass of the RDoc::Markup::ToHtml class that supports looking up method
 # names, classes, etc to create links.  RDoc::CrossReference is used to

data/lib/rdoc/markup/to_html_snippet.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 ##
 # Outputs RDoc markup as paragraphs with inline markup only.
 

data/lib/rdoc/markup/to_joined_paragraph.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 ##
 # Joins the parts of an RDoc::Markup::Paragraph into a single String.
 #

data/lib/rdoc/markup/to_label.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 require 'cgi'
 
 ##

data/lib/rdoc/markup/to_markdown.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 # :markup: markdown
 
 ##

data/lib/rdoc/markup/to_rdoc.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 ##
 # Outputs RDoc markup as RDoc markup! (mostly)
 

data/lib/rdoc/markup/to_table_of_contents.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 ##
 # Extracts just the RDoc::Markup::Heading elements from a
 # RDoc::Markup::Document to help build a table of contents

data/lib/rdoc/markup/to_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 ##
 # This Markup outputter is used for testing purposes.
 

data/lib/rdoc/markup/to_tt_only.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 ##
 # Extracts sections of text enclosed in plus, tt or code.  Used to discover
 # undocumented parameters.

data/lib/rdoc/markup/verbatim.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 ##
 # A section of verbatim text
 

data/lib/rdoc/meta_method.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 ##
 # MetaMethod represents a meta-programmed method
 

data/lib/rdoc/method_attr.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 ##
 # Abstract class representing either a method or an attribute.
 

data/lib/rdoc/mixin.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 ##
 # A Mixin adds features from a module into another context.  RDoc::Include and
 # RDoc::Extend are both mixins.

data/lib/rdoc/normal_class.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 ##
 # A normal class, neither singleton nor anonymous
 

data/lib/rdoc/normal_module.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 ##
 # A normal module, like NormalClass
 

data/lib/rdoc/options.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 require 'optparse'
 require 'pathname'
 

data/lib/rdoc/parser.rb

@@ -1,4 +1,5 @@
 # -*- coding: us-ascii -*-
+# frozen_string_literal: false
 
 ##
 # A parser is simple a class that subclasses RDoc::Parser and implements #scan

data/lib/rdoc/parser/c.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 require 'tsort'
 
 ##
@@ -605,18 +606,46 @@ class RDoc::Parser::C < RDoc::Parser
     RDoc::Comment.new comment, @top_level
   end
 
+  ##
+  # Generate a Ruby-method table
+
+  def gen_body_table file_content
+    table = {}
+    file_content.scan(%r{
+      ((?>/\*.*?\*/\s*)?)
+      ((?:(?:\w+)\s+)?
+        (?:intern\s+)?VALUE\s+(\w+)
+        \s*(?:\([^)]*\))(?:[^;]|$))
+    | ((?>/\*.*?\*/\s*))^\s*(\#\s*define\s+(\w+)\s+(\w+))
+    | ^\s*\#\s*define\s+(\w+)\s+(\w+)
+    }xm) do
+      case
+      when $1
+        table[$3] = [:func_def, $1, $2, $~.offset(2)] if !table[$3] || table[$3][0] != :func_def
+      when $4
+        table[$6] = [:macro_def, $4, $5, $~.offset(5), $7] if !table[$6] || table[$6][0] == :macro_alias
+      when $8
+        table[$8] ||= [:macro_alias, $9]
+      end
+    end
+    table
+  end
+
   ##
   # Find the C code corresponding to a Ruby method
 
   def find_body class_name, meth_name, meth_obj, file_content, quiet = false
-    case file_content
-    when %r%((?>/\*.*?\*/\s*)?)
-            ((?:(?:\w+)\s+)?
-             (?:intern\s+)?VALUE\s+#{meth_name}
-             \s*(\([^)]*\))([^;]|$))%xm then
-      comment = RDoc::Comment.new $1, @top_level
-      body = $2
-      offset, = $~.offset(2)
+    if file_content
+      @body_table ||= {}
+      @body_table[file_content] ||= gen_body_table file_content
+      type, *args = @body_table[file_content][meth_name]
+    end
+
+    case type
+    when :func_def
+      comment = RDoc::Comment.new args[0], @top_level
+      body = args[1]
+      offset, = args[2]
 
       comment.remove_private if comment
 
@@ -645,12 +674,12 @@ class RDoc::Parser::C < RDoc::Parser
       meth_obj.line    = file_content[0, offset].count("\n") + 1
 
       body
-    when %r%((?>/\*.*?\*/\s*))^\s*(\#\s*define\s+#{meth_name}\s+(\w+))%m then
-      comment = RDoc::Comment.new $1, @top_level
-      body = $2
-      offset = $~.offset(2).first
+    when :macro_def
+      comment = RDoc::Comment.new args[0], @top_level
+      body = args[1]
+      offset, = args[2]
 
-      find_body class_name, $3, meth_obj, file_content, true
+      find_body class_name, args[3], meth_obj, file_content, true
 
       comment.normalize
       find_modifiers comment, meth_obj
@@ -664,11 +693,11 @@ class RDoc::Parser::C < RDoc::Parser
       meth_obj.line    = file_content[0, offset].count("\n") + 1
 
       body
-    when %r%^\s*\#\s*define\s+#{meth_name}\s+(\w+)%m then
+    when :macro_alias
       # with no comment we hope the aliased definition has it and use it's
       # definition
 
-      body = find_body(class_name, $1, meth_obj, file_content, true)
+      body = find_body(class_name, args[0], meth_obj, file_content, true)
 
       return body if body
 
@@ -763,28 +792,42 @@ class RDoc::Parser::C < RDoc::Parser
     class_mod.add_comment comment, @top_level
   end
 
+  ##
+  # Generate a const table
+
+  def gen_const_table file_content
+    table = {}
+    @content.scan(%r{
+      ((?>^\s*/\*.*?\*/\s+))
+        rb_define_(\w+)\((?:\s*(?:\w+),)?\s*
+                           "(\w+)"\s*,
+                           .*?\)\s*;
+    | Document-(?:const|global|variable):\s
+        ((?:\w+::)*\w+)
+        \s*?\n((?>.*?\*/))
+    }mxi) do
+      case
+      when $1 then table[[$2, $3]] = $1
+      when $4 then table[$4] = "/*\n" + $5
+      end
+    end
+    table
+  end
+
   ##
   # Finds a comment matching +type+ and +const_name+ either above the
   # comment or in the matching Document- section.
 
   def find_const_comment(type, const_name, class_name = nil)
-    comment = if @content =~ %r%((?>^\s*/\*.*?\*/\s+))
-                             rb_define_#{type}\((?:\s*(\w+),)?\s*
-                                                "#{const_name}"\s*,
-                                                .*?\)\s*;%xmi then
-                $1
-              elsif class_name and
-                    @content =~ %r%Document-(?:const|global|variable):\s
-                                   #{class_name}::#{const_name}
-                                   \s*?\n((?>.*?\*/))%xm then
-                "/*\n#{$1}"
-              elsif @content =~ %r%Document-(?:const|global|variable):
-                                   \s#{const_name}
-                                   \s*?\n((?>.*?\*/))%xm then
-                "/*\n#{$1}"
-              else
-                ''
-              end
+    @const_table ||= {}
+    @const_table[@content] ||= gen_const_table @content
+    table = @const_table[@content]
+
+    comment =
+      table[[type, const_name]] ||
+      (class_name && table[class_name + "::" + const_name]) ||
+      table[const_name] ||
+      ''
 
     RDoc::Comment.new comment, @top_level
   end
@@ -840,7 +883,7 @@ class RDoc::Parser::C < RDoc::Parser
     comment = find_attr_comment var_name, attr_name
     comment.normalize
 
-    name = attr_name.gsub(/rb_intern\("([^"]+)"\)/, '\1')
+    name = attr_name.gsub(/rb_intern(?:_const)?\("([^"]+)"\)/, '\1')
 
     attr = RDoc::Attr.new '', name, rw, comment
 

data/lib/rdoc/parser/changelog.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 require 'time'
 
 ##
@@ -101,9 +102,11 @@ class RDoc::Parser::ChangeLog < RDoc::Parser
   # Groups +entries+ by date.
 
   def group_entries entries
+    @time_cache ||= {}
     entries.group_by do |title, _|
       begin
-        Time.parse(title).strftime '%Y-%m-%d'
+        time = @time_cache[title]
+        (time || Time.parse(title)).strftime '%Y-%m-%d'
       rescue NoMethodError, ArgumentError
         time, = title.split '  ', 2
         Time.parse(time).strftime '%Y-%m-%d'
@@ -127,6 +130,7 @@ class RDoc::Parser::ChangeLog < RDoc::Parser
   #        'README.EXT.ja:  ditto']]
 
   def parse_entries
+    @time_cache ||= {}
     entries = []
     entry_name = nil
     entry_body = []
@@ -142,6 +146,7 @@ class RDoc::Parser::ChangeLog < RDoc::Parser
 
         begin
           time = Time.parse entry_name
+          @time_cache[entry_name] = time
           # HACK Ruby 1.8 does not raise ArgumentError for Time.parse "Other"
           entry_name = nil unless entry_name =~ /#{time.year}/
         rescue NoMethodError
@@ -184,6 +189,7 @@ class RDoc::Parser::ChangeLog < RDoc::Parser
   # Converts the ChangeLog into an RDoc::Markup::Document
 
   def scan
+    @time_cache = {}
     entries = parse_entries
     grouped_entries = group_entries entries
 

data/lib/rdoc/parser/markdown.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 ##
 # Parse a Markdown format file.  The parsed RDoc::Markup::Document is attached
 # as a file comment.

data/lib/rdoc/parser/rd.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 ##
 # Parse a RD format file.  The parsed RDoc::Markup::Document is attached as a
 # file comment.

data/lib/rdoc/parser/ruby.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 ##
 # This file contains stuff stolen outright from:
 #

data/lib/rdoc/parser/ruby_tools.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 ##
 # Collection of methods for writing parsers against RDoc::RubyLex and
 # RDoc::RubyToken

data/lib/rdoc/parser/simple.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 ##
 # Parse a non-source file. We basically take the whole thing as one big
 # comment.

data/lib/rdoc/parser/text.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 ##
 # Indicates this parser is text and doesn't contain code constructs.
 #

data/lib/rdoc/rd.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 ##
 # RDoc::RD implements the RD format from the rdtool gem.
 #

data/lib/rdoc/rd/inline.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 ##
 # Inline keeps track of markup and labels to create proper links.
 

data/lib/rdoc/rdoc.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 require 'rdoc'
 
 require 'find'
@@ -436,7 +437,7 @@ The internal error was:
 
   def remove_unparseable files
     files.reject do |file|
-      file =~ /\.(?:class|eps|erb|scpt\.txt|ttf|yml)$/i or
+      file =~ /\.(?:class|eps|erb|scpt\.txt|svg|ttf|yml)$/i or
         (file =~ /tags$/i and
          open(file, 'rb') { |io|
            io.read(100) =~ /\A(\f\n[^,]+,\d+$|!_TAG_)/

data/lib/rdoc/require.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 ##
 # A file loaded by \#require
 

data/lib/rdoc/ri.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 require 'rdoc'
 
 ##

data/lib/rdoc/ri/driver.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 require 'abbrev'
 require 'optparse'
 
@@ -906,22 +907,9 @@ The ri pager can be set with the 'RI_PAGER' environment variable or the
   # will be expanded to Zlib::DataError.
 
   def expand_class klass
-    klass.split('::').inject '' do |expanded, klass_part|
-      expanded << '::' unless expanded.empty?
-      short = expanded << klass_part
-
-      subset = classes.keys.select do |klass_name|
-        klass_name =~ /^#{expanded}[^:]*$/
-      end
-
-      abbrevs = Abbrev.abbrev subset
-
-      expanded = abbrevs[short]
-
-      raise NotFoundError, short unless expanded
-
-      expanded.dup
-    end
+    ary = classes.keys.grep(Regexp.new("\\A#{klass.gsub(/(?=::|\z)/, '[^:]*')}\\z"))
+    raise NotFoundError, klass if ary.length != 1
+    ary.first
   end
 
   ##
@@ -1088,10 +1076,8 @@ The ri pager can be set with the 'RI_PAGER' environment variable or the
 
       return if name.nil? or name.empty?
 
-      name = expand_name name.strip
-
       begin
-        display_name name
+        display_name expand_name(name.strip)
       rescue NotFoundError => e
         puts e.message
       end

data/lib/rdoc/ri/formatter.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 ##
 # For RubyGems backwards compatibility
 

data/lib/rdoc/ri/paths.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 require 'rdoc/ri'
 
 ##

data/lib/rdoc/ri/store.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 module RDoc::RI
 
   Store = RDoc::Store # :nodoc: