rdoc 6.0.0.beta3 → 6.0.0.beta4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f0664803866527a745f0bd9497407b3fb2efecff918b205368ad1c429a63954
-  data.tar.gz: 98336bc89aab5c3b779b518a8a51b5dd4d48fbc9c592cf5b57b41d8876c725e1
+  metadata.gz: 342dd946b79ae94f39a4d57825de50df2faa0115c34ce84bf2db00b6afa03429
+  data.tar.gz: e6ca1cfa9be24f43cf9df81b206d5e035e817e36a6841158ef583ac93175047b
 SHA512:
-  metadata.gz: a4602b0b46be7eec1d5efbdbdb9dc029b6e0bdd074c3a513dae02c9fb227bf9faadc7cbfefb6423531f3b9939116534d3f24ec63c4d48964c96a16607814aa2a
-  data.tar.gz: 67e6b12048e14cacf0f96b6480b63acf90348990fc28f1bc34ed7c2df42375c56c3ee44a9ad30ae5f6b7d462ea35b7f1e5ead35b64e80bc077c6ec1dee2bcc66
+  metadata.gz: 8ffbc7917d2f6d11e3a3f8c6d5a98e5ff774afdc499caa0ca98c2ecb62e2008eda64b8478dcbf67e8fa5de5e8bf51ba766354455db7f8fef1e4e5d42822a63dd
+  data.tar.gz: 39552e0dd1cad025fbcce9cf1cf7220e74f29dd8f74e67f84a6f468ed8f9121e97169e4047e72b03639fc9937ace4b6e2d5652dcfe9ec1bfd9a1c299d60c34a5

data/.gitignore

@@ -8,6 +8,7 @@
 /lib/rdoc/rd/block_parser.rb
 /lib/rdoc/rd/inline_parser.rb
 /lib/rdoc/markdown.rb
+/lib/rdoc/markdown/literals.rb
 /pkg
 /tmp
 Gemfile.lock

data/.travis.yml

@@ -7,7 +7,7 @@ rvm:
   - 2.3.5
   - 2.4.2
   - ruby-head
-  - jruby-9.1.13.0
+  - jruby-9.1.14.0
 env:
   global:
     NOBENCHMARK=1

data/Rakefile

@@ -63,6 +63,11 @@ parsed_files = PARSER_FILES.map do |parser_file|
       racc = Gem.bin_path 'racc', 'racc'
       rb_file = parser_file.gsub(/\.ry\z/, ".rb")
       ruby "#{racc} -l -o #{rb_file} #{parser_file}"
+      open(rb_file, 'r+') do |f|
+        newtext = "# frozen_string_literal: true\n#{f.read}"
+        f.rewind
+        f.write newtext
+      end
     elsif parser_file =~ /\.kpeg\z/ # need kpeg
       kpeg = Gem.bin_path 'kpeg', 'kpeg'
       rb_file = parser_file.gsub(/\.kpeg\z/, ".rb")
@@ -104,8 +109,6 @@ end
 
 desc "Diffs Ruby HEAD with the currently checked-out copy of RDoc."
 task :diff_ruby do
-  options = "-urpN --exclude '*svn*' --exclude '*swp' --exclude '*rbc'"
-
   sh "diff #{diff_options} bin/rdoc #{ruby_dir}/bin/rdoc; true"
   sh "diff #{diff_options} bin/ri #{ruby_dir}/bin/ri; true"
   sh "diff #{diff_options} lib/rdoc.rb #{ruby_dir}/lib/rdoc.rb; true"

data/lib/rdoc.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 $DEBUG_RDOC = nil
 
 # :main: README.rdoc
@@ -65,7 +65,7 @@ module RDoc
   ##
   # RDoc version you are using
 
-  VERSION = '6.0.0.beta3'
+  VERSION = '6.0.0.beta4'
 
   ##
   # Method visibilities
@@ -149,7 +149,6 @@ module RDoc
   autoload :KNOWN_CLASSES,  'rdoc/known_classes'
 
   autoload :RipperStateLex, 'rdoc/parser/ripper_state_lex'
-  autoload :RubyToken,      'rdoc/ruby_token'
   autoload :TokenStream,    'rdoc/token_stream'
 
   autoload :Comment,        'rdoc/comment'

data/lib/rdoc/alias.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # Represent an alias, which is an old_name/new_name pair associated with a
 # particular context

data/lib/rdoc/anon_class.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # An anonymous class like:
 #

data/lib/rdoc/any_method.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # AnyMethod is the base class for objects representing methods
 
@@ -244,9 +244,9 @@ class RDoc::AnyMethod < RDoc::MethodAttr
     if @block_params then
       # If this method has explicit block parameters, remove any explicit
       # &block
-      params.sub!(/,?\s*&\w+/, '')
+      params = params.sub(/,?\s*&\w+/, '')
     else
-      params.sub!(/\&(\w+)/, '\1')
+      params = params.sub(/\&(\w+)/, '\1')
     end
 
     params = params.gsub(/\s+/, '').split(',').reject(&:empty?)
@@ -265,7 +265,7 @@ class RDoc::AnyMethod < RDoc::MethodAttr
       params = params.sub(/(\|[^|]+\|)\s*\.\.\.\s*(end|\})/, '\1 \2')
     elsif @params then
       params = @params.gsub(/\s*\#.*/, '')
-      params = params.tr("\n", " ").squeeze(" ")
+      params = params.tr_s("\n ", " ")
       params = "(#{params})" unless params[0] == ?(
     else
       params = ''
@@ -274,11 +274,11 @@ class RDoc::AnyMethod < RDoc::MethodAttr
     if @block_params then
       # If this method has explicit block parameters, remove any explicit
       # &block
-      params.sub!(/,?\s*&\w+/, '')
+      params = params.sub(/,?\s*&\w+/, '')
 
-      block = @block_params.tr("\n", " ").squeeze(" ")
+      block = @block_params.tr_s("\n ", " ")
       if block[0] == ?(
-        block.sub!(/^\(/, '').sub!(/\)/, '')
+        block = block.sub(/^\(/, '').sub(/\)/, '')
       end
       params << " { |#{block}| ... }"
     end

data/lib/rdoc/attr.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # An attribute created by \#attr, \#attr_reader, \#attr_writer or
 # \#attr_accessor

data/lib/rdoc/class_module.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # ClassModule is the base class for objects representing either a class or a
 # module.
@@ -136,7 +136,9 @@ class RDoc::ClassModule < RDoc::Context
                 normalize_comment comment
               end
 
-    @comment_location.delete_if { |(_, l)| l == location }
+    if location.parser == RDoc::Parser::C
+      @comment_location.delete_if { |(_, l)| l == location }
+    end
 
     @comment_location << [comment, location]
 

data/lib/rdoc/code_object.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # Base class for the RDoc code tree.
 #
@@ -144,7 +144,7 @@ class RDoc::CodeObject
                    # HACK correct fix is to have #initialize create @comment
                    #      with the correct encoding
                    if String === @comment and @comment.empty? then
-                     @comment.force_encoding comment.encoding
+                     @comment = RDoc::Encoding.change_encoding @comment, comment.encoding
                    end
                    @comment
                  end

data/lib/rdoc/code_objects.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 # This file was used to load all the RDoc::CodeObject subclasses at once.  Now
 # autoload handles this.
 

data/lib/rdoc/comment.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # A comment holds the text comment for a RDoc::CodeObject and provides a
 # unified way of cleaning it up and parsing it into an RDoc::Markup::Document.
@@ -45,7 +45,7 @@ class RDoc::Comment
 
   def initialize text = nil, location = nil
     @location = location
-    @text     = text
+    @text     = text.nil? ? nil : text.dup
 
     @document   = nil
     @format     = 'rdoc'
@@ -114,10 +114,14 @@ class RDoc::Comment
 
       method.call_seq = seq.chomp
 
-    elsif @text.sub!(/^\s*:?call-seq:(.*?)(^\s*$|\z)/m, '') then
-      seq = $1
-      seq.gsub!(/^\s*/, '')
-      method.call_seq = seq
+    else
+      regexp = /^\s*:?call-seq:(.*?)(^\s*$|\z)/m
+      if regexp =~ @text then
+        @text = @text.sub(regexp, '')
+        seq = $1
+        seq.gsub!(/^\s*/, '')
+        method.call_seq = seq
+      end
     end
 
     method
@@ -133,8 +137,14 @@ class RDoc::Comment
   ##
   # HACK dubious
 
-  def force_encoding encoding
-    @text.force_encoding encoding
+  def encode! encoding
+    # TODO: Remove this condition after Ruby 2.2 EOL
+    if RUBY_VERSION < '2.3.0'
+      @text = @text.force_encoding encoding
+    else
+      @text = String.new @text, encoding: encoding
+    end
+    self
   end
 
   ##
@@ -200,7 +210,7 @@ class RDoc::Comment
   def remove_private
     # Workaround for gsub encoding for Ruby 1.9.2 and earlier
     empty = ''
-    empty.force_encoding @text.encoding
+    empty = RDoc::Encoding.change_encoding empty, @text.encoding
 
     @text = @text.gsub(%r%^\s*([#*]?)--.*?^\s*(\1)\+\+\n?%m, empty)
     @text = @text.sub(%r%^\s*[#*]?--.*%m, '')
@@ -216,7 +226,7 @@ class RDoc::Comment
       @text.nil? and @document
 
     @document = nil
-    @text = text
+    @text = text.nil? ? nil : text.dup
   end
 
   ##

data/lib/rdoc/constant.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # A constant
 

data/lib/rdoc/context.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 require 'cgi'
 
 ##
@@ -239,7 +239,7 @@ class RDoc::Context < RDoc::CodeObject
 
       if known then
         known.comment = attribute.comment if known.comment.empty?
-      elsif registered = @methods_hash[attribute.pretty_name << '='] and
+      elsif registered = @methods_hash[attribute.pretty_name + '='] and
             RDoc::Attr === registered then
         registered.rw = 'RW'
       else
@@ -249,7 +249,7 @@ class RDoc::Context < RDoc::CodeObject
     end
 
     if attribute.rw.index 'W' then
-      key = attribute.pretty_name << '='
+      key = attribute.pretty_name + '='
       known = @methods_hash[key]
 
       if known then

data/lib/rdoc/context/section.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # A section of documentation like:
 #
@@ -43,7 +43,7 @@ class RDoc::Context::Section
     @parent = parent
     @title = title ? title.strip : title
 
-    @@sequence.succ!
+    @@sequence = @@sequence.succ
     @sequence = @@sequence.dup
 
     @comments = []

data/lib/rdoc/cross_reference.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # RDoc::CrossReference is a reusable way to create cross references for names.
 

data/lib/rdoc/encoding.rb

@@ -1,5 +1,5 @@
 # coding: US-ASCII
-# frozen_string_literal: false
+# frozen_string_literal: true
 
 ##
 # This class is a wrapper around File IO and Encoding that helps RDoc load
@@ -23,26 +23,26 @@ module RDoc::Encoding
 
     utf8 = content.sub!(/\A\xef\xbb\xbf/, '')
 
-    RDoc::Encoding.set_encoding content
+    content = RDoc::Encoding.set_encoding content
 
     begin
       encoding ||= Encoding.default_external
       orig_encoding = content.encoding
 
       if not orig_encoding.ascii_compatible? then
-        content.encode! encoding
+        content = content.encode encoding
       elsif utf8 then
-        content.force_encoding Encoding::UTF_8
-        content.encode! encoding
+        content = RDoc::Encoding.change_encoding content, Encoding::UTF_8
+        content = content.encode encoding
       else
         # assume the content is in our output encoding
-        content.force_encoding encoding
+        content = RDoc::Encoding.change_encoding content, encoding
       end
 
       unless content.valid_encoding? then
         # revert and try to transcode
-        content.force_encoding orig_encoding
-        content.encode! encoding
+        content = RDoc::Encoding.change_encoding content, orig_encoding
+        content = content.encode encoding
       end
 
       unless content.valid_encoding? then
@@ -52,10 +52,11 @@ module RDoc::Encoding
     rescue Encoding::InvalidByteSequenceError,
            Encoding::UndefinedConversionError => e
       if force_transcode then
-        content.force_encoding orig_encoding
-        content.encode!(encoding,
-                        :invalid => :replace, :undef => :replace,
-                        :replace => '?')
+        content = RDoc::Encoding.change_encoding content, orig_encoding
+        content = content.encode(encoding,
+                                 :invalid => :replace,
+                                 :undef => :replace,
+                                 :replace => '?')
         return content
       else
         warn "unable to convert #{e.message} for #{filename}, skipping"
@@ -77,15 +78,17 @@ module RDoc::Encoding
     first_line = $1
 
     if first_line =~ /\A# +frozen[-_]string[-_]literal[=:].+$/i
-      string.sub! first_line, ''
+      string = string.sub first_line, ''
     end
+
+    string
   end
 
   ##
   # Sets the encoding of +string+ based on the magic comment
 
   def self.set_encoding string
-    remove_frozen_string_literal string
+    string = remove_frozen_string_literal string
 
     string =~ /\A(?:#!.*\n)?(.*\n)/
 
@@ -94,15 +97,34 @@ module RDoc::Encoding
     name = case first_line
            when /^<\?xml[^?]*encoding=(["'])(.*?)\1/ then $2
            when /\b(?:en)?coding[=:]\s*([^\s;]+)/i   then $1
-           else                                           return
+           else                                           return string
            end
 
-    string.sub! first_line, ''
+    string = string.sub first_line, ''
 
-    remove_frozen_string_literal string
+    string = remove_frozen_string_literal string
 
     enc = Encoding.find name
-    string.force_encoding enc if enc
+    string = RDoc::Encoding.change_encoding string, enc if enc
+
+    string
+  end
+
+  ##
+  # Changes encoding based on +encoding+ without converting and returns new
+  # string
+
+  def self.change_encoding text, encoding
+    if text.kind_of? RDoc::Comment
+      text.encode! encoding
+    else
+      # TODO: Remove this condition after Ruby 2.2 EOL
+      if RUBY_VERSION < '2.3.0'
+        text.force_encoding encoding
+      else
+        String.new text, encoding: encoding
+      end
+    end
   end
 
 end

data/lib/rdoc/erb_partial.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # Allows an ERB template to be rendered in the context (binding) of an
 # existing ERB template evaluation.

data/lib/rdoc/erbio.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 require 'erb'
 
 ##

data/lib/rdoc/extend.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # A Module extension to a class with \#extend
 #

data/lib/rdoc/generator.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # RDoc uses generators to turn parsed source code in the form of an
 # RDoc::CodeObject tree into some form of output.  RDoc comes with the HTML

data/lib/rdoc/generator/darkfish.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 # -*- mode: ruby; ruby-indent-level: 2; tab-width: 2 -*-
 
 require 'erb'
@@ -313,12 +313,16 @@ class RDoc::Generator::Darkfish
     search_index_rel_prefix = rel_prefix
     search_index_rel_prefix += @asset_rel_path if @file_output
 
-    # suppress 1.9.3 warning
-    asset_rel_prefix = asset_rel_prefix = rel_prefix + @asset_rel_path
+    asset_rel_prefix = rel_prefix + @asset_rel_path
 
     @title = @options.title
 
-    render_template template_file, out_file do |io| binding end
+    render_template template_file, out_file do |io|
+      here = binding
+      # suppress 1.9.3 warning
+      here.local_variable_set(:asset_rel_prefix, asset_rel_prefix)
+      here
+    end
   rescue => e
     error = RDoc::Error.new \
       "error generating index.html: #{e.message} (#{e.class})"
@@ -343,14 +347,19 @@ class RDoc::Generator::Darkfish
     search_index_rel_prefix = rel_prefix
     search_index_rel_prefix += @asset_rel_path if @file_output
 
-    # suppress 1.9.3 warning
-    asset_rel_prefix = asset_rel_prefix = rel_prefix + @asset_rel_path
-    svninfo          = svninfo          = get_svninfo(current)
+    asset_rel_prefix = rel_prefix + @asset_rel_path
+    svninfo          = get_svninfo(current)
 
     @title = "#{klass.type} #{klass.full_name} - #{@options.title}"
 
     debug_msg "  rendering #{out_file}"
-    render_template template_file, out_file do |io| binding end
+    render_template template_file, out_file do |io|
+      here = binding
+      # suppress 1.9.3 warning
+      here.local_variable_set(:asset_rel_prefix, asset_rel_prefix)
+      here.local_variable_set(:svninfo, svninfo)
+      here
+    end
   end
 
   ##
@@ -416,8 +425,7 @@ class RDoc::Generator::Darkfish
       search_index_rel_prefix = rel_prefix
       search_index_rel_prefix += @asset_rel_path if @file_output
 
-      # suppress 1.9.3 warning
-      asset_rel_prefix = asset_rel_prefix = rel_prefix + @asset_rel_path
+      asset_rel_prefix = rel_prefix + @asset_rel_path
 
       unless filepage_file then
         if file.text? then
@@ -434,7 +442,13 @@ class RDoc::Generator::Darkfish
       @title += " - #{@options.title}"
       template_file ||= filepage_file
 
-      render_template template_file, out_file do |io| binding end
+      render_template template_file, out_file do |io|
+        here = binding
+        # suppress 1.9.3 warning
+        here.local_variable_set(:asset_rel_prefix, asset_rel_prefix)
+        here.local_variable_set(:current, current)
+        here
+      end
     end
   rescue => e
     error =
@@ -458,14 +472,19 @@ class RDoc::Generator::Darkfish
     search_index_rel_prefix = rel_prefix
     search_index_rel_prefix += @asset_rel_path if @file_output
 
-    # suppress 1.9.3 warning
-    current          = current          = file
-    asset_rel_prefix = asset_rel_prefix = rel_prefix + @asset_rel_path
+    current          = file
+    asset_rel_prefix = rel_prefix + @asset_rel_path
 
     @title = "#{file.page_name} - #{@options.title}"
 
     debug_msg "  rendering #{out_file}"
-    render_template template_file, out_file do |io| binding end
+    render_template template_file, out_file do |io|
+      here = binding
+      # suppress 1.9.3 warning
+      here.local_variable_set(:current, current)
+      here.local_variable_set(:asset_rel_prefix, asset_rel_prefix)
+      here
+    end
   end
 
   ##
@@ -483,12 +502,16 @@ class RDoc::Generator::Darkfish
     search_index_rel_prefix = rel_prefix
     search_index_rel_prefix += @asset_rel_path if @file_output
 
-    # suppress 1.9.3 warning
-    asset_rel_prefix = asset_rel_prefix = ''
+    asset_rel_prefix = ''
 
     @title = 'Not Found'
 
-    render_template template_file do |io| binding end
+    render_template template_file do |io|
+      here = binding
+      # suppress 1.9.3 warning
+      here.local_variable_set(:asset_rel_prefix, asset_rel_prefix)
+      here
+    end
   rescue => e
     error = RDoc::Error.new \
       "error generating servlet_not_found: #{e.message} (#{e.class})"
@@ -540,12 +563,16 @@ class RDoc::Generator::Darkfish
     search_index_rel_prefix = rel_prefix
     search_index_rel_prefix += @asset_rel_path if @file_output
 
-    # suppress 1.9.3 warning
-    asset_rel_prefix = asset_rel_prefix = rel_prefix + @asset_rel_path
+    asset_rel_prefix = rel_prefix + @asset_rel_path
 
     @title = "Table of Contents - #{@options.title}"
 
-    render_template template_file, out_file do |io| binding end
+    render_template template_file, out_file do |io|
+      here = binding
+      # suppress 1.9.3 warning
+      here.local_variable_set(:asset_rel_prefix, asset_rel_prefix)
+      here
+    end
   rescue => e
     error = RDoc::Error.new \
       "error generating table_of_contents.html: #{e.message} (#{e.class})"