rdoc 4.2.1 → 6.3.1

data/lib/rdoc/rd/inline.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 ##
 # Inline keeps track of markup and labels to create proper links.
 
@@ -49,11 +50,11 @@ class RDoc::RD::Inline
   def append more
     case more
     when String then
-      @reference << more
-      @rdoc      << more
+      @reference += more
+      @rdoc      += more
     when RDoc::RD::Inline then
-      @reference << more.reference
-      @rdoc      << more.rdoc
+      @reference += more.reference
+      @rdoc      += more.rdoc
     else
       raise "unknown thingy #{more}"
     end

data/lib/rdoc/rd/inline_parser.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 #
 # DO NOT MODIFY!!!!
-# This file is automatically generated by Racc 1.4.14
-# from Racc grammer file "".
+# This file is automatically generated by Racc 1.5.1
+# from Racc grammar file "".
 #
 
 require 'racc/parser.rb'
@@ -96,7 +97,7 @@ end
 def parse inline
   @inline = inline
   @src = StringScanner.new inline
-  @pre = ""
+  @pre = "".dup
   @yydebug = true
   do_parse.to_s
 end
@@ -732,12 +733,12 @@ Racc_debug_parser = false
 # reduce 1 omitted
 
 def _reduce_2(val, _values, result)
- result.append val[1] 
+ result.append val[1]
     result
 end
 
 def _reduce_3(val, _values, result)
- result = val[0] 
+ result = val[0]
     result
 end
 
@@ -762,28 +763,28 @@ end
 def _reduce_13(val, _values, result)
       content = val[1]
       result = inline "<em>#{content}</em>", content
-    
+
     result
 end
 
 def _reduce_14(val, _values, result)
       content = val[1]
       result = inline "<code>#{content}</code>", content
-    
+
     result
 end
 
 def _reduce_15(val, _values, result)
       content = val[1]
       result = inline "+#{content}+", content
-    
+
     result
 end
 
 def _reduce_16(val, _values, result)
       content = val[1]
       result = inline "<tt>#{content}</tt>", content
-    
+
     result
 end
 
@@ -791,13 +792,13 @@ def _reduce_17(val, _values, result)
       label = val[1]
       @block_parser.add_label label.reference
       result = "<span id=\"label-#{label}\">#{label}</span>"
-    
+
     result
 end
 
 def _reduce_18(val, _values, result)
       result = "{#{val[1]}}[#{val[2].join}]"
-    
+
     result
 end
 
@@ -805,13 +806,13 @@ def _reduce_19(val, _values, result)
       scheme, inline = val[1]
 
       result = "{#{inline}}[#{scheme}#{inline.reference}]"
-    
+
     result
 end
 
 def _reduce_20(val, _values, result)
       result = [nil, inline(val[1])]
-    
+
     result
 end
 
@@ -820,25 +821,25 @@ def _reduce_21(val, _values, result)
         'rdoc-label:',
         inline("#{val[0].reference}/#{val[1].reference}")
       ]
-    
+
     result
 end
 
 def _reduce_22(val, _values, result)
       result = ['rdoc-label:', val[0].reference]
-    
+
     result
 end
 
 def _reduce_23(val, _values, result)
       result = ['rdoc-label:', "#{val[0].reference}/"]
-    
+
     result
 end
 
 def _reduce_24(val, _values, result)
       result = [nil, inline(val[1])]
-    
+
     result
 end
 
@@ -847,92 +848,92 @@ def _reduce_25(val, _values, result)
         'rdoc-label:',
         inline("#{val[0].reference}/#{val[1].reference}")
       ]
-    
+
     result
 end
 
 def _reduce_26(val, _values, result)
       result = ['rdoc-label:', val[0]]
-    
+
     result
 end
 
 def _reduce_27(val, _values, result)
       ref = val[0].reference
       result = ['rdoc-label:', inline(ref, "#{ref}/")]
-    
+
     result
 end
 
 # reduce 28 omitted
 
 def _reduce_29(val, _values, result)
- result = val[1] 
+ result = val[1]
     result
 end
 
 def _reduce_30(val, _values, result)
- result = val[1] 
+ result = val[1]
     result
 end
 
 def _reduce_31(val, _values, result)
       result = inline val[0]
-    
+
     result
 end
 
 def _reduce_32(val, _values, result)
       result = inline "\"#{val[1]}\""
-    
+
     result
 end
 
 def _reduce_33(val, _values, result)
       result = inline val[0]
-    
+
     result
 end
 
 def _reduce_34(val, _values, result)
       result = inline "\"#{val[1]}\""
-    
+
     result
 end
 
 # reduce 35 omitted
 
 def _reduce_36(val, _values, result)
- result = val[1] 
+ result = val[1]
     result
 end
 
 def _reduce_37(val, _values, result)
- result = inline val[1] 
+ result = inline val[1]
     result
 end
 
 def _reduce_38(val, _values, result)
       result = val[0].append val[1]
-    
+
     result
 end
 
 def _reduce_39(val, _values, result)
       result = val[0].append val[1]
-    
+
     result
 end
 
 def _reduce_40(val, _values, result)
       result = val[0]
-    
+
     result
 end
 
 def _reduce_41(val, _values, result)
       result = inline val[0]
-    
+
     result
 end
 
@@ -940,25 +941,25 @@ end
 
 def _reduce_43(val, _values, result)
       result = val[0].append val[1]
-    
+
     result
 end
 
 def _reduce_44(val, _values, result)
       result = inline val[0]
-    
+
     result
 end
 
 def _reduce_45(val, _values, result)
       result = val[0].append val[1]
-    
+
     result
 end
 
 def _reduce_46(val, _values, result)
       result = val[0]
-    
+
     result
 end
 
@@ -984,24 +985,24 @@ end
 
 def _reduce_57(val, _values, result)
       result = val[0]
-    
+
     result
 end
 
 def _reduce_58(val, _values, result)
       result = inline val[0]
-    
+
     result
 end
 
 def _reduce_59(val, _values, result)
       result = inline val[0]
-    
+
     result
 end
 
 def _reduce_60(val, _values, result)
- result << val[1] 
+ result << val[1]
     result
 end
 
@@ -1009,7 +1010,7 @@ end
 
 def _reduce_62(val, _values, result)
       result << val[1]
-    
+
     result
 end
 
@@ -1017,7 +1018,7 @@ end
 
 def _reduce_64(val, _values, result)
       result << val[1]
-    
+
     result
 end
 
@@ -1048,7 +1049,7 @@ end
 # reduce 77 omitted
 
 def _reduce_78(val, _values, result)
- result << val[1] 
+ result << val[1]
     result
 end
 
@@ -1099,13 +1100,13 @@ end
 def _reduce_101(val, _values, result)
       index = @block_parser.add_footnote val[1].rdoc
       result = "{*#{index}}[rdoc-label:foottext-#{index}:footmark-#{index}]"
-    
+
     result
 end
 
 def _reduce_102(val, _values, result)
       result = inline "<tt>#{val[1]}</tt>", val[1]
-    
+
     result
 end
 
@@ -1122,7 +1123,7 @@ end
 # reduce 108 omitted
 
 def _reduce_109(val, _values, result)
- result << val[1] 
+ result << val[1]
     result
 end
 
@@ -1130,24 +1131,24 @@ end
 
 def _reduce_111(val, _values, result)
       result = inline val[0]
-    
+
     result
 end
 
 # reduce 112 omitted
 
 def _reduce_113(val, _values, result)
- result = val[1] 
+ result = val[1]
     result
 end
 
 def _reduce_114(val, _values, result)
- result = val[1] 
+ result = val[1]
     result
 end
 
 def _reduce_115(val, _values, result)
- result = val[1] 
+ result = val[1]
     result
 end
 
@@ -1192,7 +1193,7 @@ end
 # reduce 135 omitted
 
 def _reduce_136(val, _values, result)
- result << val[1] 
+ result << val[1]
     result
 end
 

data/lib/rdoc/rd/inline_parser.ry

@@ -436,7 +436,7 @@ end
 def parse inline
   @inline = inline
   @src = StringScanner.new inline
-  @pre = ""
+  @pre = "".dup
   @yydebug = true
   do_parse.to_s
 end

data/lib/rdoc/rd.rb

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

data/lib/rdoc/rdoc.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'rdoc'
 
 require 'find'
@@ -23,7 +24,7 @@ require 'time'
 #   rdoc.document argv
 #
 # Where +argv+ is an array of strings, each corresponding to an argument you'd
-# give rdoc on the command line.  See <tt>rdoc --help<tt> for details.
+# give rdoc on the command line.  See <tt>rdoc --help</tt> for details.
 
 class RDoc::RDoc
 
@@ -34,11 +35,6 @@ class RDoc::RDoc
 
   GENERATORS = {}
 
-  ##
-  # File pattern to exclude
-
-  attr_accessor :exclude
-
   ##
   # Generator instance used for creating output
 
@@ -92,7 +88,6 @@ class RDoc::RDoc
 
   def initialize
     @current       = nil
-    @exclude       = nil
     @generator     = nil
     @last_modified = {}
     @old_siginfo   = nil
@@ -115,13 +110,19 @@ class RDoc::RDoc
   def gather_files files
     files = ["."] if files.empty?
 
-    file_list = normalized_file_list files, true, @exclude
-
-    file_list = file_list.uniq
+    file_list = normalized_file_list files, true, @options.exclude
 
-    file_list = remove_unparseable file_list
+    file_list = remove_unparseable(file_list)
 
-    file_list.sort
+    if file_list.count {|name, mtime|
+         file_list[name] = @last_modified[name] unless mtime
+         mtime
+       } > 0
+      @last_modified.replace file_list
+      file_list.keys.sort
+    else
+      []
+    end
   end
 
   ##
@@ -160,19 +161,20 @@ class RDoc::RDoc
 
     RDoc.load_yaml
 
-    parse_error = if Object.const_defined? :Psych then
-                    Psych::SyntaxError
-                  else
-                    ArgumentError
-                  end
-
     begin
       options = YAML.load_file '.rdoc_options'
-    rescue *parse_error
+    rescue Psych::SyntaxError
     end
 
+    return RDoc::Options.new if options == false # Allow empty file.
+
     raise RDoc::Error, "#{options_file} is not a valid rdoc options file" unless
-      RDoc::Options === options
+      RDoc::Options === options or Hash === options
+
+    if Hash === options
+      # Override the default values with the contents of YAML file.
+      options = RDoc::Options.new options
+    end
 
     options
   end
@@ -193,7 +195,7 @@ class RDoc::RDoc
       error "#{dir} exists and is not a directory" unless File.directory? dir
 
       begin
-        open flag_file do |io|
+        File.open flag_file do |io|
           unless force then
             Time.parse io.gets
 
@@ -237,8 +239,11 @@ option)
 
   def update_output_dir(op_dir, time, last = {})
     return if @options.dry_run or not @options.update_output_dir
+    unless ENV['SOURCE_DATE_EPOCH'].nil?
+      time = Time.at(ENV['SOURCE_DATE_EPOCH'].to_i).gmtime
+    end
 
-    open output_flag_file(op_dir), "w" do |f|
+    File.open output_flag_file(op_dir), "w" do |f|
       f.puts time.rfc2822
       last.each do |n, t|
         f.puts "#{n}\t#{t.rfc2822}"
@@ -262,11 +267,11 @@ option)
     # read and strip comments
     patterns = File.read(filename).gsub(/#.*/, '')
 
-    result = []
+    result = {}
 
-    patterns.split.each do |patt|
+    patterns.split(' ').each do |patt|
       candidates = Dir.glob(File.join(in_dir, patt))
-      result.concat normalized_file_list(candidates)
+      result.update normalized_file_list(candidates, false, @options.exclude)
     end
 
     result
@@ -286,21 +291,21 @@ option)
 
   def normalized_file_list(relative_files, force_doc = false,
                            exclude_pattern = nil)
-    file_list = []
+    file_list = {}
 
     relative_files.each do |rel_file_name|
+      rel_file_name = rel_file_name.sub(/^\.\//, '')
       next if rel_file_name.end_with? 'created.rid'
       next if exclude_pattern && exclude_pattern =~ rel_file_name
       stat = File.stat rel_file_name rescue next
 
       case type = stat.ftype
       when "file" then
-        next if last_modified = @last_modified[rel_file_name] and
-                stat.mtime.to_i <= last_modified.to_i
+        mtime = (stat.mtime unless (last_modified = @last_modified[rel_file_name] and
+                                    stat.mtime.to_i <= last_modified.to_i))
 
         if force_doc or RDoc::Parser.can_parse(rel_file_name) then
-          file_list << rel_file_name.sub(/^\.\//, '')
-          @last_modified[rel_file_name] = stat.mtime
+          file_list[rel_file_name] = mtime
         end
       when "directory" then
         next if rel_file_name == "CVS" || rel_file_name == ".svn"
@@ -311,16 +316,16 @@ option)
         dot_doc = File.join rel_file_name, RDoc::DOT_DOC_FILENAME
 
         if File.file? dot_doc then
-          file_list << parse_dot_doc_file(rel_file_name, dot_doc)
+          file_list.update(parse_dot_doc_file(rel_file_name, dot_doc))
         else
-          file_list << list_files_in_directory(rel_file_name)
+          file_list.update(list_files_in_directory(rel_file_name))
         end
       else
         warn "rdoc can't parse the #{type} #{rel_file_name}"
       end
     end
 
-    file_list.flatten
+    file_list
   end
 
   ##
@@ -339,10 +344,8 @@ option)
   # Parses +filename+ and returns an RDoc::TopLevel
 
   def parse_file filename
-    if Object.const_defined? :Encoding then
-      encoding = @options.encoding
-      filename = filename.encode encoding
-    end
+    encoding = @options.encoding
+    filename = filename.encode encoding
 
     @stats.add_file filename
 
@@ -365,7 +368,7 @@ option)
         relative_path.relative_path_from @options.page_dir
     end
 
-    top_level = @store.add_file filename, relative_path.to_s
+    top_level = @store.add_file filename, relative_name: relative_path.to_s
 
     parser = RDoc::Parser.for top_level, filename, content, @options, @stats
 
@@ -418,6 +421,7 @@ The internal error was:
 
     return [] if file_list.empty?
 
+    original_options = @options.dup
     @stats.begin_adding
 
     file_info = file_list.map do |filename|
@@ -426,6 +430,7 @@ The internal error was:
     end.compact
 
     @stats.done_adding
+    @options = original_options
 
     file_info
   end
@@ -435,10 +440,10 @@ The internal error was:
   # files for emacs and vim.
 
   def remove_unparseable files
-    files.reject do |file|
-      file =~ /\.(?:class|eps|erb|scpt\.txt|ttf|yml)$/i or
+    files.reject do |file, *|
+      file =~ /\.(?:class|eps|erb|scpt\.txt|svg|ttf|yml)$/i or
         (file =~ /tags$/i and
-         open(file, 'rb') { |io|
+         File.open(file, 'rb') { |io|
            io.read(100) =~ /\A(\f\n[^,]+,\d+$|!_TAG_)/
          })
     end
@@ -474,13 +479,11 @@ The internal error was:
       exit
     end
 
-    @exclude = @options.exclude
-
     unless @options.coverage_report then
       @last_modified = setup_output_dir @options.op_dir, @options.force_update
     end
 
-    @store.encoding = @options.encoding if @options.respond_to? :encoding
+    @store.encoding = @options.encoding
     @store.dry_run  = @options.dry_run
     @store.main     = @options.main_page
     @store.title    = @options.title
@@ -526,13 +529,18 @@ The internal error was:
   # by the RDoc options
 
   def generate
-    Dir.chdir @options.op_dir do
-      unless @options.quiet then
-        $stderr.puts "\nGenerating #{@generator.class.name.sub(/^.*::/, '')} format into #{Dir.pwd}..."
-      end
-
+    if @options.dry_run then
+      # do nothing
       @generator.generate
-      update_output_dir '.', @start_time, @last_modified
+    else
+      Dir.chdir @options.op_dir do
+        unless @options.quiet then
+          $stderr.puts "\nGenerating #{@generator.class.name.sub(/^.*::/, '')} format into #{Dir.pwd}..."
+        end
+
+        @generator.generate
+        update_output_dir '.', @start_time, @last_modified
+      end
     end
   end
 
@@ -552,23 +560,20 @@ end
 begin
   require 'rubygems'
 
-  if Gem.respond_to? :find_files then
-    rdoc_extensions = Gem.find_files 'rdoc/discover'
+  rdoc_extensions = Gem.find_files 'rdoc/discover'
 
-    rdoc_extensions.each do |extension|
-      begin
-        load extension
-      rescue => e
-        warn "error loading #{extension.inspect}: #{e.message} (#{e.class})"
-        warn "\t#{e.backtrace.join "\n\t"}" if $DEBUG
-      end
+  rdoc_extensions.each do |extension|
+    begin
+      load extension
+    rescue => e
+      warn "error loading #{extension.inspect}: #{e.message} (#{e.class})"
+      warn "\t#{e.backtrace.join "\n\t"}" if $DEBUG
     end
   end
 rescue LoadError
 end
 
 # require built-in generators after discovery in case they've been replaced
-require 'rdoc/generator/darkfish'
-require 'rdoc/generator/ri'
-require 'rdoc/generator/pot'
-
+require_relative 'generator/darkfish'
+require_relative 'generator/ri'
+require_relative 'generator/pot'