rdoc 8.0.0 → 8.1.0

data/lib/rdoc/ri/store.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
-module RDoc::RI
+module RDoc
+  module RI
 
-  Store = RDoc::Store # :nodoc:
+    Store = ::RDoc::Store # :nodoc:
 
+  end
 end

data/lib/rdoc/ri/task.rb

@@ -6,66 +6,70 @@ end unless defined?(RDoc)
 
 require_relative '../task'
 
-##
-# RDoc::RI::Task creates ri data in <code>./.rdoc</code> for your project.
-#
-# It contains the following tasks:
-#
-# [ri]
-#   Build ri data
-#
-# [clobber_ri]
-#   Delete ri data files.  This target is automatically added to the main
-#   clobber target.
-#
-# [reri]
-#   Rebuild the ri data from scratch even if they are not out of date.
-#
-# Simple example:
-#
-#   require 'rdoc/ri/task'
-#
-#   RDoc::RI::Task.new do |ri|
-#     ri.main = 'README.md'
-#     ri.rdoc_files.include 'README.md', 'lib/**/*.rb'
-#   end
-#
-# For further configuration details see RDoc::Task.
+module RDoc
+  module RI
+    ##
+    # RDoc::RI::Task creates ri data in <code>./.rdoc</code> for your project.
+    #
+    # It contains the following tasks:
+    #
+    # [ri]
+    #   Build ri data
+    #
+    # [clobber_ri]
+    #   Delete ri data files.  This target is automatically added to the main
+    #   clobber target.
+    #
+    # [reri]
+    #   Rebuild the ri data from scratch even if they are not out of date.
+    #
+    # Simple example:
+    #
+    #   require 'rdoc/ri/task'
+    #
+    #   RDoc::RI::Task.new do |ri|
+    #     ri.main = 'README.md'
+    #     ri.rdoc_files.include 'README.md', 'lib/**/*.rb'
+    #   end
+    #
+    # For further configuration details see RDoc::Task.
 
-class RDoc::RI::Task < RDoc::Task
+    class Task < ::RDoc::Task
 
-  DEFAULT_NAMES = { # :nodoc:
-    :clobber_rdoc => :clobber_ri,
-    :rdoc         => :ri,
-    :rerdoc       => :reri,
-  }
+      DEFAULT_NAMES = { # :nodoc:
+        :clobber_rdoc => :clobber_ri,
+        :rdoc         => :ri,
+        :rerdoc       => :reri,
+      }
 
-  ##
-  # Create an ri task with the given name. See RDoc::Task for documentation on
-  # setting names.
+      ##
+      # Create an ri task with the given name. See RDoc::Task for documentation on
+      # setting names.
 
-  def initialize(name = DEFAULT_NAMES) # :yield: self
-    super
-  end
+      def initialize(name = DEFAULT_NAMES) # :yield: self
+        super
+      end
 
-  def clobber_task_description # :nodoc:
-    "Remove RI data files"
-  end
+      def clobber_task_description # :nodoc:
+        "Remove RI data files"
+      end
 
-  ##
-  # Sets default task values
+      ##
+      # Sets default task values
 
-  def defaults
-    super
+      def defaults
+        super
 
-    @rdoc_dir = '.rdoc'
-  end
+        @rdoc_dir = '.rdoc'
+      end
 
-  def rdoc_task_description # :nodoc:
-    'Build RI data files'
-  end
+      def rdoc_task_description # :nodoc:
+        'Build RI data files'
+      end
 
-  def rerdoc_task_description # :nodoc:
-    'Rebuild RI data files'
+      def rerdoc_task_description # :nodoc:
+        'Rebuild RI data files'
+      end
+    end
   end
 end

data/lib/rdoc/ri.rb

@@ -1,21 +1,23 @@
 # frozen_string_literal: true
 require_relative '../rdoc'
 
-##
-# Namespace for the ri command line tool's implementation.
-#
-# See <tt>ri --help</tt> for details.
+module RDoc
+  ##
+  # Namespace for the ri command line tool's implementation.
+  #
+  # See <tt>ri --help</tt> for details.
 
-module RDoc::RI
+  module RI
 
-  ##
-  # Base RI error class
+    ##
+    # Base RI error class
 
-  class Error < RDoc::Error; end
+    class Error < ::RDoc::Error; end
 
-  autoload :Driver,  "#{__dir__}/ri/driver"
-  autoload :Paths,   "#{__dir__}/ri/paths"
-  autoload :Servlet, "#{__dir__}/ri/servlet"
-  autoload :Store,   "#{__dir__}/ri/store"
+    autoload :Driver,  "#{__dir__}/ri/driver"
+    autoload :Paths,   "#{__dir__}/ri/paths"
+    autoload :Servlet, "#{__dir__}/ri/servlet"
+    autoload :Store,   "#{__dir__}/ri/store"
 
+  end
 end

data/lib/rdoc/rubygems_hook.rb

@@ -3,255 +3,257 @@ require 'rubygems/user_interaction'
 require 'fileutils'
 require_relative '../rdoc'
 
-# We define the following two similar name classes in this file:
-#
-# - RDoc::RubyGemsHook
-# - RDoc::RubygemsHook
-#
-# RDoc::RubyGemsHook is the main class that has real logic.
-#
-# RDoc::RubygemsHook is a class that is only for
-# compatibility. RDoc::RubygemsHook is used by RubyGems directly. We
-# can remove this when all maintained RubyGems remove
-# `rubygems/rdoc.rb`.
-
-class RDoc::RubyGemsHook
-
-  include Gem::UserInteraction
-  extend  Gem::UserInteraction
-
-  @rdoc_version = nil
-  @specs = []
+module RDoc
+  # We define the following two similar name classes in this file:
+  #
+  # - RDoc::RubyGemsHook
+  # - RDoc::RubygemsHook
+  #
+  # RDoc::RubyGemsHook is the main class that has real logic.
+  #
+  # RDoc::RubygemsHook is a class that is only for
+  # compatibility. RDoc::RubygemsHook is used by RubyGems directly. We
+  # can remove this when all maintained RubyGems remove
+  # `rubygems/rdoc.rb`.
 
-  ##
-  # Force installation of documentation?
+  class RubyGemsHook
 
-  attr_accessor :force
+    include Gem::UserInteraction
+    extend  Gem::UserInteraction
 
-  ##
-  # Generate rdoc?
+    @rdoc_version = nil
+    @specs = []
 
-  attr_accessor :generate_rdoc
+    ##
+    # Force installation of documentation?
 
-  ##
-  # Generate ri data?
+    attr_accessor :force
 
-  attr_accessor :generate_ri
+    ##
+    # Generate rdoc?
 
-  class << self
+    attr_accessor :generate_rdoc
 
     ##
-    # Loaded version of RDoc.  Set by ::load_rdoc
-
-    attr_reader :rdoc_version
+    # Generate ri data?
 
-  end
+    attr_accessor :generate_ri
 
-  ##
-  # Post installs hook that generates documentation for each specification in
-  # +specs+
+    class << self
 
-  def self.generate(installer, specs)
-    start = Time.now
-    types = installer.document
+      ##
+      # Loaded version of RDoc.  Set by ::load_rdoc
 
-    generate_rdoc = types.include? 'rdoc'
-    generate_ri   = types.include? 'ri'
+      attr_reader :rdoc_version
 
-    specs.each do |spec|
-      new(spec, generate_rdoc, generate_ri).generate
     end
 
-    return unless generate_rdoc or generate_ri
+    ##
+    # Post installs hook that generates documentation for each specification in
+    # +specs+
 
-    duration = (Time.now - start).to_i
-    names    = specs.map(&:name).join ', '
+    def self.generate(installer, specs)
+      start = Time.now
+      types = installer.document
 
-    say "Done installing documentation for #{names} after #{duration} seconds"
-  end
+      generate_rdoc = types.include? 'rdoc'
+      generate_ri   = types.include? 'ri'
 
-  def self.remove(uninstaller)
-    new(uninstaller.spec).remove
-  end
+      specs.each do |spec|
+        new(spec, generate_rdoc, generate_ri).generate
+      end
 
-  ##
-  # Loads the RDoc generator
+      return unless generate_rdoc or generate_ri
 
-  def self.load_rdoc
-    return if @rdoc_version
+      duration = (Time.now - start).to_i
+      names    = specs.map(&:name).join ', '
 
-    require_relative 'rdoc'
+      say "Done installing documentation for #{names} after #{duration} seconds"
+    end
 
-    @rdoc_version = Gem::Version.new ::RDoc::VERSION
-  end
+    def self.remove(uninstaller)
+      new(uninstaller.spec).remove
+    end
 
-  ##
-  # Creates a new documentation generator for +spec+.  RDoc and ri data
-  # generation can be enabled or disabled through +generate_rdoc+ and
-  # +generate_ri+ respectively.
-  #
-  # Only +generate_ri+ is enabled by default.
+    ##
+    # Loads the RDoc generator
 
-  def initialize(spec, generate_rdoc = false, generate_ri = true)
-    @doc_dir   = spec.doc_dir
-    @force     = false
-    @rdoc      = nil
-    @spec      = spec
+    def self.load_rdoc
+      return if @rdoc_version
 
-    @generate_rdoc = generate_rdoc
-    @generate_ri   = generate_ri
+      require_relative 'rdoc'
 
-    @rdoc_dir = spec.doc_dir 'rdoc'
-    @ri_dir   = spec.doc_dir 'ri'
-  end
+      @rdoc_version = Gem::Version.new VERSION
+    end
 
-  ##
-  # Removes legacy rdoc arguments from +args+
-  #--
-  # TODO move to RDoc::Options
+    ##
+    # Creates a new documentation generator for +spec+.  RDoc and ri data
+    # generation can be enabled or disabled through +generate_rdoc+ and
+    # +generate_ri+ respectively.
+    #
+    # Only +generate_ri+ is enabled by default.
 
-  def delete_legacy_args(args)
-    args.delete '--inline-source'
-    args.delete '--promiscuous'
-    args.delete '-p'
-    args.delete '--one-file'
-  end
+    def initialize(spec, generate_rdoc = false, generate_ri = true)
+      @doc_dir   = spec.doc_dir
+      @force     = false
+      @rdoc      = nil
+      @spec      = spec
 
-  ##
-  # Generates documentation using the named +generator+ ("aliki" or "ri")
-  # and following the given +options+.
-  #
-  # Documentation will be generated into +destination+
+      @generate_rdoc = generate_rdoc
+      @generate_ri   = generate_ri
 
-  def document(generator, options, destination)
-    generator_name = generator
+      @rdoc_dir = spec.doc_dir 'rdoc'
+      @ri_dir   = spec.doc_dir 'ri'
+    end
 
-    options = options.dup
-    options.exclude ||= [] # TODO maybe move to RDoc::Options#finish
-    options.setup_generator generator
-    options.op_dir = destination
-    Dir.chdir @spec.full_gem_path do
-      options.finish
+    ##
+    # Removes legacy rdoc arguments from +args+
+    #--
+    # TODO move to RDoc::Options
+
+    def delete_legacy_args(args)
+      args.delete '--inline-source'
+      args.delete '--promiscuous'
+      args.delete '-p'
+      args.delete '--one-file'
     end
 
-    generator = options.generator.new @rdoc.store, options
+    ##
+    # Generates documentation using the named +generator+ ("aliki" or "ri")
+    # and following the given +options+.
+    #
+    # Documentation will be generated into +destination+
+
+    def document(generator, options, destination)
+      generator_name = generator
+
+      options = options.dup
+      options.exclude ||= [] # TODO maybe move to RDoc::Options#finish
+      options.setup_generator generator
+      options.op_dir = destination
+      Dir.chdir @spec.full_gem_path do
+        options.finish
+      end
+
+      generator = options.generator.new @rdoc.store, options
 
-    @rdoc.options = options
-    @rdoc.generator = generator
+      @rdoc.options = options
+      @rdoc.generator = generator
 
-    say "Installing #{generator_name} documentation for #{@spec.full_name}"
+      say "Installing #{generator_name} documentation for #{@spec.full_name}"
 
-    FileUtils.mkdir_p options.op_dir
+      FileUtils.mkdir_p options.op_dir
 
-    Dir.chdir options.op_dir do
-      begin
-        @rdoc.class.current = @rdoc
-        @rdoc.generator.generate
-      ensure
-        @rdoc.class.current = nil
+      Dir.chdir options.op_dir do
+        begin
+          @rdoc.class.current = @rdoc
+          @rdoc.generator.generate
+        ensure
+          @rdoc.class.current = nil
+        end
       end
     end
-  end
 
-  ##
-  # Generates RDoc and ri data
+    ##
+    # Generates RDoc and ri data
 
-  def generate
-    return if @spec.default_gem?
-    return unless @generate_ri or @generate_rdoc
+    def generate
+      return if @spec.default_gem?
+      return unless @generate_ri or @generate_rdoc
 
-    setup
+      setup
 
-    options = nil
+      options = nil
 
-    args = @spec.rdoc_options
-    args.concat @spec.source_paths
-    args.concat @spec.extra_rdoc_files
+      args = @spec.rdoc_options
+      args.concat @spec.source_paths
+      args.concat @spec.extra_rdoc_files
 
-    case config_args = Gem.configuration[:rdoc]
-    when String then
-      args = args.concat config_args.split(' ')
-    when Array then
-      args = args.concat config_args
-    end
+      case config_args = Gem.configuration[:rdoc]
+      when String
+        args = args.concat config_args.split(' ')
+      when Array
+        args = args.concat config_args
+      end
 
-    delete_legacy_args args
+      delete_legacy_args args
 
-    Dir.chdir @spec.full_gem_path do
-      options = ::RDoc::Options.new
-      options.default_title = "#{@spec.full_name} Documentation"
-      options.parse args
-      options.quiet = !Gem.configuration.really_verbose
-    end
+      Dir.chdir @spec.full_gem_path do
+        options = Options.new
+        options.default_title = "#{@spec.full_name} Documentation"
+        options.parse args
+        options.quiet = !Gem.configuration.really_verbose
+      end
 
-    @rdoc = new_rdoc
+      @rdoc = new_rdoc
 
-    say "Parsing documentation for #{@spec.full_name}"
+      say "Parsing documentation for #{@spec.full_name}"
 
-    Dir.chdir @spec.full_gem_path do
-      # RDoc::Options#finish must be called before parse_files.
-      # RDoc::Options#finish is also called after ri/aliki generator setup.
-      # We need to dup the options to avoid modifying it after finish is called.
-      parse_options = options.dup
-      parse_options.finish
-      @rdoc.options = parse_options
-      @rdoc.store = RDoc::Store.new(parse_options)
-      @rdoc.parse_files parse_options.files
-    end
+      Dir.chdir @spec.full_gem_path do
+        # RDoc::Options#finish must be called before parse_files.
+        # RDoc::Options#finish is also called after ri/aliki generator setup.
+        # We need to dup the options to avoid modifying it after finish is called.
+        parse_options = options.dup
+        parse_options.finish
+        @rdoc.options = parse_options
+        @rdoc.store = Store.new(parse_options)
+        @rdoc.parse_files parse_options.files
+      end
 
-    document 'ri',       options, @ri_dir if
-      @generate_ri   and (@force or not File.exist? @ri_dir)
+      document 'ri',       options, @ri_dir if
+        @generate_ri   and (@force or not File.exist? @ri_dir)
 
-    document 'aliki', options, @rdoc_dir if
-      @generate_rdoc and (@force or not File.exist? @rdoc_dir)
-  end
+      document 'aliki', options, @rdoc_dir if
+        @generate_rdoc and (@force or not File.exist? @rdoc_dir)
+    end
 
-  ##
-  # #new_rdoc creates a new RDoc instance.  This method is provided only to
-  # make testing easier.
+    ##
+    # #new_rdoc creates a new RDoc instance.  This method is provided only to
+    # make testing easier.
 
-  def new_rdoc # :nodoc:
-    ::RDoc::RDoc.new
-  end
+    def new_rdoc # :nodoc:
+      RDoc.new
+    end
 
-  ##
-  # Is rdoc documentation installed?
+    ##
+    # Is rdoc documentation installed?
 
-  def rdoc_installed?
-    File.exist? @rdoc_dir
-  end
+    def rdoc_installed?
+      File.exist? @rdoc_dir
+    end
 
-  ##
-  # Removes generated RDoc and ri data
+    ##
+    # Removes generated RDoc and ri data
 
-  def remove
-    base_dir = @spec.base_dir
+    def remove
+      base_dir = @spec.base_dir
 
-    raise Gem::FilePermissionError, base_dir unless File.writable? base_dir
+      raise Gem::FilePermissionError, base_dir unless File.writable? base_dir
 
-    FileUtils.rm_rf @rdoc_dir
-    FileUtils.rm_rf @ri_dir
-  end
+      FileUtils.rm_rf @rdoc_dir
+      FileUtils.rm_rf @ri_dir
+    end
 
-  ##
-  # Is ri data installed?
+    ##
+    # Is ri data installed?
 
-  def ri_installed?
-    File.exist? @ri_dir
-  end
+    def ri_installed?
+      File.exist? @ri_dir
+    end
 
-  ##
-  # Prepares the spec for documentation generation
+    ##
+    # Prepares the spec for documentation generation
 
-  def setup
-    self.class.load_rdoc
+    def setup
+      self.class.load_rdoc
 
-    raise Gem::FilePermissionError, @doc_dir if
-      File.exist?(@doc_dir) and not File.writable?(@doc_dir)
+      raise Gem::FilePermissionError, @doc_dir if
+        File.exist?(@doc_dir) and not File.writable?(@doc_dir)
 
-    FileUtils.mkdir_p @doc_dir unless File.exist? @doc_dir
-  end
+      FileUtils.mkdir_p @doc_dir unless File.exist? @doc_dir
+    end
 
+  end
 end
 
 module RDoc