gitlab-rdoc 6.3.2

data/lib/rdoc/ri/formatter.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+##
+# For RubyGems backwards compatibility
+
+module RDoc::RI::Formatter # :nodoc:
+end

data/lib/rdoc/ri/paths.rb

@@ -0,0 +1,171 @@
+# frozen_string_literal: true
+require_relative '../rdoc'
+
+##
+# The directories where ri data lives.  Paths can be enumerated via ::each, or
+# queried individually via ::system_dir, ::site_dir, ::home_dir and ::gem_dir.
+
+module RDoc::RI::Paths
+
+  #:stopdoc:
+  require 'rbconfig'
+
+  version = RbConfig::CONFIG['ruby_version']
+
+  BASE    = File.join RbConfig::CONFIG['ridir'], version
+
+  HOMEDIR = RDoc.home
+  #:startdoc:
+
+  ##
+  # Iterates over each selected path yielding the directory and type.
+  #
+  # Yielded types:
+  # :system:: Where Ruby's ri data is stored.  Yielded when +system+ is
+  #           true
+  # :site:: Where ri for installed libraries are stored.  Yielded when
+  #         +site+ is true.  Normally no ri data is stored here.
+  # :home:: ~/.rdoc.  Yielded when +home+ is true.
+  # :gem:: ri data for an installed gem.  Yielded when +gems+ is true.
+  # :extra:: ri data directory from the command line.  Yielded for each
+  #          entry in +extra_dirs+
+
+  def self.each system = true, site = true, home = true, gems = :latest, *extra_dirs # :yields: directory, type
+    return enum_for __method__, system, site, home, gems, *extra_dirs unless
+      block_given?
+
+    extra_dirs.each do |dir|
+      yield dir, :extra
+    end
+
+    yield system_dir,  :system if system
+    yield site_dir,    :site   if site
+    yield home_dir,    :home   if home and HOMEDIR
+
+    gemdirs(gems).each do |dir|
+      yield dir, :gem
+    end if gems
+
+    nil
+  end
+
+  ##
+  # The ri directory for the gem with +gem_name+.
+
+  def self.gem_dir name, version
+    req = Gem::Requirement.new "= #{version}"
+
+    spec = Gem::Specification.find_by_name name, req
+
+    File.join spec.doc_dir, 'ri'
+  end
+
+  ##
+  # The latest installed gems' ri directories.  +filter+ can be :all or
+  # :latest.
+  #
+  # A +filter+ :all includes all versions of gems and includes gems without
+  # ri documentation.
+
+  def self.gemdirs filter = :latest
+    ri_paths = {}
+
+    all = Gem::Specification.map do |spec|
+      [File.join(spec.doc_dir, 'ri'), spec.name, spec.version]
+    end
+
+    if filter == :all then
+      gemdirs = []
+
+      all.group_by do |_, name, _|
+        name
+      end.sort_by do |group, _|
+        group
+      end.map do |group, items|
+        items.sort_by do |_, _, version|
+          version
+        end.reverse_each do |dir,|
+          gemdirs << dir
+        end
+      end
+
+      return gemdirs
+    end
+
+    all.each do |dir, name, ver|
+      next unless File.exist? dir
+
+      if ri_paths[name].nil? or ver > ri_paths[name].first then
+        ri_paths[name] = [ver, name, dir]
+      end
+    end
+
+    ri_paths.sort_by { |_, (_, name, _)| name }.map { |k, v| v.last }
+  rescue LoadError
+    []
+  end
+
+  ##
+  # The location of the rdoc data in the user's home directory.
+  #
+  # Like ::system, ri data in the user's home directory is rare and predates
+  # libraries distributed via RubyGems.  ri data is rarely generated into this
+  # directory.
+
+  def self.home_dir
+    HOMEDIR
+  end
+
+  ##
+  # Returns existing directories from the selected documentation directories
+  # as an Array.
+  #
+  # See also ::each
+
+  def self.path(system = true, site = true, home = true, gems = :latest, *extra_dirs)
+    path = raw_path system, site, home, gems, *extra_dirs
+
+    path.select { |directory| File.directory? directory }
+  end
+
+  ##
+  # Returns selected documentation directories including nonexistent
+  # directories.
+  #
+  # See also ::each
+
+  def self.raw_path(system, site, home, gems, *extra_dirs)
+    path = []
+
+    each(system, site, home, gems, *extra_dirs) do |dir, type|
+      path << dir
+    end
+
+    path.compact
+  end
+
+  ##
+  # The location of ri data installed into the site dir.
+  #
+  # Historically this was available for documentation installed by Ruby
+  # libraries predating RubyGems.  It is unlikely to contain any content for
+  # modern Ruby installations.
+
+  def self.site_dir
+    File.join BASE, 'site'
+  end
+
+  ##
+  # The location of the built-in ri data.
+  #
+  # This data is built automatically when `make` is run when Ruby is
+  # installed.  If you did not install Ruby by hand you may need to install
+  # the documentation yourself.  Please consult the documentation for your
+  # package manager or Ruby installer for details.  You can also use the
+  # rdoc-data gem to install system ri data for common versions of Ruby.
+
+  def self.system_dir
+    File.join BASE, 'system'
+  end
+
+end

data/lib/rdoc/ri/store.rb

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

data/lib/rdoc/ri/task.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+begin
+  gem 'rdoc'
+rescue Gem::LoadError
+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.rdoc'
+#     ri.rdoc_files.include 'README.rdoc', 'lib/**/*.rb'
+#   end
+#
+# For further configuration details see RDoc::Task.
+
+class RDoc::RI::Task < RDoc::Task
+
+  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.
+
+  def initialize name = DEFAULT_NAMES # :yield: self
+    super
+  end
+
+  def clobber_task_description # :nodoc:
+    "Remove RI data files"
+  end
+
+  ##
+  # Sets default task values
+
+  def defaults
+    super
+
+    @rdoc_dir = '.rdoc'
+  end
+
+  def rdoc_task_description # :nodoc:
+    'Build RI data files'
+  end
+
+  def rerdoc_task_description # :nodoc:
+    'Rebuild RI data files'
+  end
+end

data/lib/rdoc/ri.rb

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

data/lib/rdoc/rubygems_hook.rb

@@ -0,0 +1,246 @@
+# frozen_string_literal: true
+require 'rubygems/user_interaction'
+require 'fileutils'
+require 'rdoc'
+
+##
+# Gem::RDoc provides methods to generate RDoc and ri data for installed gems
+# upon gem installation.
+#
+# This file is automatically required by RubyGems 1.9 and newer.
+
+class RDoc::RubygemsHook
+
+  include Gem::UserInteraction
+  extend  Gem::UserInteraction
+
+  @rdoc_version = nil
+  @specs = []
+
+  ##
+  # Force installation of documentation?
+
+  attr_accessor :force
+
+  ##
+  # Generate rdoc?
+
+  attr_accessor :generate_rdoc
+
+  ##
+  # Generate ri data?
+
+  attr_accessor :generate_ri
+
+  class << self
+
+    ##
+    # Loaded version of RDoc.  Set by ::load_rdoc
+
+    attr_reader :rdoc_version
+
+  end
+
+  ##
+  # Post installs hook that generates documentation for each specification in
+  # +specs+
+
+  def self.generation_hook installer, specs
+    start = Time.now
+    types = installer.document
+
+    generate_rdoc = types.include? 'rdoc'
+    generate_ri   = types.include? 'ri'
+
+    specs.each do |spec|
+      new(spec, generate_rdoc, generate_ri).generate
+    end
+
+    return unless generate_rdoc or generate_ri
+
+    duration = (Time.now - start).to_i
+    names    = specs.map(&:name).join ', '
+
+    say "Done installing documentation for #{names} after #{duration} seconds"
+  end
+
+  ##
+  # Loads the RDoc generator
+
+  def self.load_rdoc
+    return if @rdoc_version
+
+    require_relative 'rdoc'
+
+    @rdoc_version = Gem::Version.new ::RDoc::VERSION
+  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.
+
+  def initialize spec, generate_rdoc = false, generate_ri = true
+    @doc_dir   = spec.doc_dir
+    @force     = false
+    @rdoc      = nil
+    @spec      = spec
+
+    @generate_rdoc = generate_rdoc
+    @generate_ri   = generate_ri
+
+    @rdoc_dir = spec.doc_dir 'rdoc'
+    @ri_dir   = spec.doc_dir 'ri'
+  end
+
+  ##
+  # 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
+
+  ##
+  # Generates documentation using the named +generator+ ("darkfish" 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
+    options.finish
+
+    generator = options.generator.new @rdoc.store, options
+
+    @rdoc.options = options
+    @rdoc.generator = generator
+
+    say "Installing #{generator_name} documentation for #{@spec.full_name}"
+
+    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
+      end
+    end
+  end
+
+  ##
+  # Generates RDoc and ri data
+
+  def generate
+    return if @spec.default_gem?
+    return unless @generate_ri or @generate_rdoc
+
+    setup
+
+    options = nil
+
+    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
+
+    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
+    end
+
+    options.quiet = !Gem.configuration.really_verbose
+
+    @rdoc = new_rdoc
+    @rdoc.options = options
+
+    store = RDoc::Store.new
+    store.encoding = options.encoding
+    store.dry_run  = options.dry_run
+    store.main     = options.main_page
+    store.title    = options.title
+
+    @rdoc.store = store
+
+    say "Parsing documentation for #{@spec.full_name}"
+
+    Dir.chdir @spec.full_gem_path do
+      @rdoc.parse_files options.files
+    end
+
+    document 'ri',       options, @ri_dir if
+      @generate_ri   and (@force or not File.exist? @ri_dir)
+
+    document 'darkfish', 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.
+
+  def new_rdoc # :nodoc:
+    ::RDoc::RDoc.new
+  end
+
+  ##
+  # Is rdoc documentation installed?
+
+  def rdoc_installed?
+    File.exist? @rdoc_dir
+  end
+
+  ##
+  # Removes generated RDoc and ri data
+
+  def remove
+    base_dir = @spec.base_dir
+
+    raise Gem::FilePermissionError, base_dir unless File.writable? base_dir
+
+    FileUtils.rm_rf @rdoc_dir
+    FileUtils.rm_rf @ri_dir
+  end
+
+  ##
+  # Is ri data installed?
+
+  def ri_installed?
+    File.exist? @ri_dir
+  end
+
+  ##
+  # Prepares the spec for documentation generation
+
+  def setup
+    self.class.load_rdoc
+
+    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
+
+end