rdoc 5.1.0 → 6.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9174b0195d9838a298a513ba2085d112124c7794
-  data.tar.gz: 2004a3d7156daa611a1d889f9ea9c6c1fa3e5258
+SHA256:
+  metadata.gz: 327e6414793206350f148388b0df495ff2c748c1d4bb129ef320a442e4084619
+  data.tar.gz: 44c884a1eb18506c90af82fefa6f7686973ab32e1ceb42c6616b0ffbf88ac868
 SHA512:
-  metadata.gz: '092085cdf5a1d41d6c317ad6574f8b36b09f2658df2736fb19dcb4f475df81d3b8db6172a8a2cc1c342aef8a791b6c0b432dce2d7e158b0086f1a95c2b34d40c'
-  data.tar.gz: 6f206046fd878159a867e3d394deb4ddf5f37a3f437bf314cfd214f6b11e5ab1c2f5d81cadef42ac04fec22396e90f463cfb4e1169877380968a9e45cb1dfabe
+  metadata.gz: 8691cde93b42f6c4ff77f6212e40c5c15c408b1953e58cf14f17cef142970ff79564bf7fe12b7f072067267fd67ad62920241e54e7a6d592487545bd19a82311
+  data.tar.gz: 3adbda517d389982d0d67ccd92478d0b0912c156c2988a26089715ff77e998025d6f2d8eafd44cdbd66daa2c647bd2201d1c0f57c5731bac19c45aea3014ae4c

data/CONTRIBUTING.rdoc

@@ -8,7 +8,7 @@ classes for each feature.
 == Bugs
 
 If you think you found a bug, file a ticket on the {issues
-tracker}[https://github.com/rdoc/rdoc/issues] on github.
+tracker}[https://github.com/ruby/rdoc/issues] on github.
 
 If your bug involves an error RDoc produced please include a sample file that
 illustrates the problem or link to the repository or gem that is associated
@@ -17,8 +17,8 @@ with the bug.
 Please include steps to reproduce the issue.  Here are some examples of good
 issues:
 
-* https://github.com/rdoc/rdoc/issues/55
-* https://github.com/rdoc/rdoc/issues/61
+* https://github.com/ruby/rdoc/issues/55
+* https://github.com/ruby/rdoc/issues/61
 
 == Developer Quick Start
 
@@ -35,7 +35,7 @@ This will install all the necessary dependencies for development with rake,
 generate documentation and run the tests for the first time.
 
 If the tests don't pass on the first run check the {Travis CI page for
-RDoc}[https://travis-ci.org/rdoc/rdoc] to see if there are any known failures
+RDoc}[https://travis-ci.org/ruby/rdoc] to see if there are any known failures
 (there shouldn't be).
 
 You can now use `rake` and `autotest` to run the tests.

data/Gemfile

@@ -1,3 +1,12 @@
 source 'https://rubygems.org'
 
 gemspec
+
+group :development do
+  gem "rake"
+  gem "racc", "> 1.4.10"
+  gem "kpeg"
+  gem "test-unit"
+  gem "minitest" # for test_rdoc_rubygems_hook.rb
+  gem "rubocop"
+end

data/History.rdoc

@@ -1,12 +1,12 @@
 === 5.1.0 / 2017-02-24
 
 * Bug fixes
- * Fix an issue that rdoc fails when running on Windows with RUBYOPT=-U.
-   PR #430 by Toshihiko Ichida
+  * Fix an issue that rdoc fails when running on Windows with RUBYOPT=-U.
+    PR #430 by Toshihiko Ichida
 
 * Minor enhancements
- * Parse ruby 2.1 <visibility> def. PR #436 by Akira Matsuda.
- * Suppress warnings in eval. PR #440 by Nobuyoshi Nakada.
+  * Parse ruby 2.1 <visibility> def. PR #436 by Akira Matsuda.
+  * Suppress warnings in eval. PR #440 by Nobuyoshi Nakada.
 
 === 5.0.0 / 2016-11-05
 

data/README.rdoc

@@ -1,10 +1,9 @@
 = \RDoc - Ruby Documentation System
 
-home :: https://github.com/rdoc/rdoc
-rdoc :: https://rdoc.github.io/rdoc
-bugs :: https://github.com/rdoc/rdoc/issues
-build status :: {<img src="https://travis-ci.org/rdoc/rdoc.svg?branch=master" alt="Build Status" />}[https://travis-ci.org/rdoc/rdoc]
-code quality :: {<img src="https://codeclimate.com/github/rdoc/rdoc/badges/gpa.svg" alt="Code Climate">}[https://codeclimate.com/github/rdoc/rdoc]
+home :: https://github.com/ruby/rdoc
+rdoc :: https://ruby.github.io/rdoc
+bugs :: https://github.com/ruby/rdoc/issues
+code quality :: {<img src="https://codeclimate.com/github/ruby/rdoc/badges/gpa.svg" alt="Code Climate">}[https://codeclimate.com/github/ruby/rdoc]
 
 == Description
 
@@ -47,7 +46,7 @@ contain just Markup-style markup (with or without leading '#' comment
 markers).  If directory names are passed to RDoc, they are scanned
 recursively for C and Ruby source files only.
 
-To generate documentation using +rake+ see RDoc::Task[https://rdoc.github.io/rdoc/RDocTask.html].
+To generate documentation using +rake+ see RDoc::Task[https://ruby.github.io/rdoc/RDocTask.html].
 
 To generate documentation programmatically:
 

data/Rakefile

@@ -3,10 +3,8 @@ require 'rdoc/task'
 require 'bundler/gem_tasks'
 require 'rake/testtask'
 
-ENV['BENCHMARK'] = 'yes'
-
 task :docs    => :generate
-task :test    => :generate
+task :test    => [:normal_test, :rubygems_test]
 
 PARSER_FILES = %w[
   lib/rdoc/rd/block_parser.ry
@@ -35,10 +33,18 @@ task ghpages: :rdoc do
   FileUtils.cp_r Dir.glob("/tmp/html/*"), "."
 end
 
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList['test/**/test_*.rb']
+Rake::TestTask.new(:normal_test) do |t|
+  t.libs << "test/rdoc"
+  t.verbose = true
+  t.deps = :generate
+  t.test_files = FileList["test/**/test_*.rb"].exclude("test/rdoc/test_rdoc_rubygems_hook.rb")
+end
+
+Rake::TestTask.new(:rubygems_test) do |t|
+  t.libs << "test/rdoc"
+  t.verbose = true
+  t.deps = :generate
+  t.pattern = "test/rdoc/test_rdoc_rubygems_hook.rb"
 end
 
 path = "pkg/#{Bundler::GemHelper.gemspec.full_name}"
@@ -55,20 +61,25 @@ package_parser_files = PARSER_FILES.map do |parser_file|
 end
 
 parsed_files = PARSER_FILES.map do |parser_file|
-  name = File.basename(parser_file, File.extname(parser_file))
-  _path = File.dirname(parser_file)
-  parsed_file = "#{_path}/#{name}.rb"
+  ext = File.extname(parser_file)
+  parsed_file = "#{parser_file.chomp(ext)}.rb"
 
-  file parsed_file do |t|
+  file parsed_file => parser_file do |t|
     puts "Generating #{parsed_file}..."
-    if parser_file =~ /\.ry\z/ # need racc
+    case ext
+    when '.ry' # need racc
       racc = Gem.bin_path 'racc', 'racc'
       rb_file = parser_file.gsub(/\.ry\z/, ".rb")
-      ruby "-rubygems #{racc} -l -o #{rb_file} #{parser_file}"
-    elsif parser_file =~ /\.kpeg\z/ # need kpeg
+      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
+    when '.kpeg' # need kpeg
       kpeg = Gem.bin_path 'kpeg', 'kpeg'
       rb_file = parser_file.gsub(/\.kpeg\z/, ".rb")
-      ruby "-rubygems #{kpeg} -fsv -o #{rb_file} #{parser_file}"
+      ruby "#{kpeg} -fsv -o #{rb_file} #{parser_file}"
     end
   end
 
@@ -76,58 +87,15 @@ parsed_files = PARSER_FILES.map do |parser_file|
 end
 
 task "#{path}.gem" => package_parser_files
+desc "Generate all files used racc and kpeg"
 task :generate => parsed_files
-task :check_manifest => :generate
-
-# These tasks expect to have the following directory structure:
-#
-#   git/git.rubini.us/code # Rubinius git HEAD checkout
-#   svn/ruby/trunk         # ruby subversion HEAD checkout
-#   svn/rdoc/trunk         # RDoc subversion HEAD checkout
-#
-# If you don't have this directory structure, set RUBY_PATH and/or
-# RUBINIUS_PATH.
-
-diff_options = "-urpN --exclude '*svn*' --exclude '*swp' --exclude '*rbc'"
-rsync_options = "-avP --exclude '*svn*' --exclude '*swp' --exclude '*rbc' --exclude '*.rej' --exclude '*.orig' --exclude '*.kpeg' --exclude '*.ry' --exclude 'literals_1_8.rb' --exclude 'gauntlet_rdoc.rb'"
-
-rubinius_dir = ENV['RUBINIUS_PATH'] || '../../../git/git.rubini.us/code'
-ruby_dir = ENV['RUBY_PATH'] || '../../svn/ruby/trunk'
-
-desc "Updates Ruby HEAD with the currently checked-out copy of RDoc."
-task :update_ruby do
-  sh "rsync #{rsync_options} bin/rdoc #{ruby_dir}/bin/rdoc"
-  sh "rsync #{rsync_options} bin/ri #{ruby_dir}/bin/ri"
-  sh "rsync #{rsync_options} lib/ #{ruby_dir}/lib"
-  sh "rsync #{rsync_options} test/ #{ruby_dir}/test/rdoc"
-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"
-  sh "diff #{diff_options} lib/rdoc #{ruby_dir}/lib/rdoc; true"
-  sh "diff #{diff_options} test #{ruby_dir}/test/rdoc; true"
-end
-
-desc "Updates Rubinius HEAD with the currently checked-out copy of RDoc."
-task :update_rubinius do
-  sh "rsync #{rsync_options} bin/rdoc #{rubinius_dir}/lib/bin/rdoc.rb"
-  sh "rsync #{rsync_options} bin/ri #{rubinius_dir}/lib/bin/ri.rb"
-  sh "rsync #{rsync_options} lib/ #{rubinius_dir}/lib"
-  sh "rsync #{rsync_options} test/ #{rubinius_dir}/test/rdoc"
-end
-
-desc "Diffs Rubinius HEAD with the currently checked-out copy of RDoc."
-task :diff_rubinius do
-  sh "diff #{diff_options} bin/rdoc #{rubinius_dir}/lib/bin/rdoc.rb; true"
-  sh "diff #{diff_options} bin/ri #{rubinius_dir}/lib/bin/ri.rb; true"
-  sh "diff #{diff_options} lib/rdoc.rb #{rubinius_dir}/lib/rdoc.rb; true"
-  sh "diff #{diff_options} lib/rdoc #{rubinius_dir}/lib/rdoc; true"
-  sh "diff #{diff_options} test #{rubinius_dir}/test/rdoc; true"
+begin
+  require 'rubocop/rake_task'
+rescue LoadError
+else
+  RuboCop::RakeTask.new(:rubocop) do |t|
+    t.options = [*parsed_files]
+  end
+  task :build => [:generate, "rubocop:auto_correct"]
 end
-
-task :build => [:generate]

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
 
@@ -26,12 +26,6 @@ class RDoc::AnyMethod < RDoc::MethodAttr
 
   attr_accessor :c_function
 
-  ##
-  # Different ways to call this method
-
-  attr_reader :call_seq
-
-  ##
   # Parameters for this method
 
   attr_accessor :params
@@ -93,6 +87,19 @@ class RDoc::AnyMethod < RDoc::MethodAttr
     end
   end
 
+  ##
+  # Different ways to call this method
+
+  def call_seq
+    unless call_seq = _call_seq
+      call_seq = is_alias_for._call_seq if is_alias_for
+    end
+
+    return unless call_seq
+
+    deduplicate_call_seq(call_seq)
+  end
+
   ##
   # Sets the different ways you can call this method.  If an empty +call_seq+
   # is given nil is assumed.
@@ -244,9 +251,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 +272,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,12 +281,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.gsub(/\s*\#.*/, '')
-      block = block.tr("\n", " ").squeeze(" ")
+      block = @block_params.tr_s("\n ", " ")
       if block[0] == ?(
-        block.sub!(/^\(/, '').sub!(/\)/, '')
+        block = block.sub(/^\(/, '').sub(/\)/, '')
       end
       params << " { |#{block}| ... }"
     end
@@ -313,5 +319,43 @@ class RDoc::AnyMethod < RDoc::MethodAttr
     @superclass_method
   end
 
-end
+  protected
+
+  ##
+  # call_seq without deduplication and alias lookup.
+
+  def _call_seq
+    @call_seq if defined?(@call_seq) && @call_seq
+  end
+
+  private
+
+  ##
+  # call_seq with alias examples information removed, if this
+  # method is an alias method.
+
+  def deduplicate_call_seq(call_seq)
+    return call_seq unless is_alias_for || !aliases.empty?
+
+    method_name = self.name
+    method_name = method_name[0, 1] if method_name =~ /\A\[/
 
+    entries = call_seq.split "\n"
+
+    ignore = aliases.map(&:name)
+    if is_alias_for
+      ignore << is_alias_for.name
+      ignore.concat is_alias_for.aliases.map(&:name)
+    end
+    ignore.map! { |n| n =~ /\A\[/ ? n[0, 1] : n}
+    ignore.delete(method_name)
+    ignore = Regexp.union(ignore)
+
+    matching = entries.reject do |entry|
+      entry =~ /^\w*\.?#{ignore}/ or
+        entry =~ /\s#{ignore}\s/
+    end
+
+    matching.join "\n"
+  end
+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]
 
@@ -208,7 +210,7 @@ class RDoc::ClassModule < RDoc::Context
                 normalize_comment comment
               end
 
-    comment = "#{@comment}\n---\n#{comment}" unless @comment.empty?
+    comment = "#{@comment.to_s}\n---\n#{comment.to_s}" unless @comment.empty?
 
     super comment
   end

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.
 #
@@ -69,13 +69,6 @@ class RDoc::CodeObject
 
   attr_reader :metadata
 
-  ##
-  # Offset in #file where this CodeObject was defined
-  #--
-  # TODO character or byte?
-
-  attr_accessor :offset
-
   ##
   # Sets the parent CodeObject
 
@@ -151,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.
@@ -23,6 +23,11 @@ class RDoc::Comment
 
   attr_accessor :location
 
+  ##
+  # Line where this Comment was written
+
+  attr_accessor :line
+
   ##
   # For duck-typing when merging classes at load time
 
@@ -33,6 +38,11 @@ class RDoc::Comment
 
   attr_reader :text
 
+  ##
+  # Alias for text
+
+  alias to_s text
+
   ##
   # Overrides the content returned by #parse.  Use when there is no #text
   # source for this comment
@@ -43,9 +53,10 @@ class RDoc::Comment
   # Creates a new comment with +text+ that is found in the RDoc::TopLevel
   # +location+.
 
-  def initialize text = nil, location = nil
+  def initialize text = nil, location = nil, language = nil
     @location = location
-    @text     = text
+    @text     = text.nil? ? nil : text.dup
+    @language = language
 
     @document   = nil
     @format     = 'rdoc'
@@ -114,10 +125,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 +148,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 +221,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 +237,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
 
@@ -36,7 +36,7 @@ class RDoc::Constant < RDoc::CodeObject
     @value = value
 
     @is_alias_for = nil
-    @visibility   = nil
+    @visibility   = :public
 
     self.comment = comment
   end
@@ -136,7 +136,7 @@ class RDoc::Constant < RDoc::CodeObject
     initialize array[1], nil, array[5]
 
     @full_name     = array[2]
-    @visibility    = array[3]
+    @visibility    = array[3] || :public
     @is_alias_for  = array[4]
     #                      5 handled above
     #                      6 handled below

data/lib/rdoc/context/section.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # A section of documentation like:
 #
@@ -34,8 +34,6 @@ class RDoc::Context::Section
 
   attr_reader :title
 
-  @@sequence = "SEC00000"
-
   ##
   # Creates a new section with +title+ and +comment+
 
@@ -43,9 +41,6 @@ class RDoc::Context::Section
     @parent = parent
     @title = title ? title.strip : title
 
-    @@sequence.succ!
-    @sequence = @@sequence.dup
-
     @comments = []
 
     add_comment comment
@@ -233,13 +228,5 @@ class RDoc::Context::Section
     end
   end
 
-  ##
-  # Section sequence number (deprecated)
-
-  def sequence
-    warn "RDoc::Context::Section#sequence is deprecated, use #aref"
-    @sequence
-  end
-
 end