rdoc 8.0.0 → 8.1.0

data/lib/rdoc/ri/formatter.rb

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

data/lib/rdoc/ri/paths.rb

@@ -1,171 +1,175 @@
 # 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']
+module RDoc
+  module RI
+    ##
+    # 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 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
 
-  BASE    = File.join RbConfig::CONFIG['ridir'], version
+        yield system_dir,  :system if system
+        yield site_dir,    :site   if site
+        yield home_dir,    :home   if home and HOMEDIR
 
-  HOMEDIR = RDoc.home
-  #:startdoc:
+        gemdirs(gems).each do |dir|
+          yield dir, :gem
+        end if gems
 
-  ##
-  # 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+
+        nil
+      end
 
-  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?
+      ##
+      # The ri directory for the gem with +gem_name+.
 
-    extra_dirs.each do |dir|
-      yield dir, :extra
-    end
+      def self.gem_dir(name, version)
+        req = Gem::Requirement.new "= #{version}"
 
-    yield system_dir,  :system if system
-    yield site_dir,    :site   if site
-    yield home_dir,    :home   if home and HOMEDIR
+        spec = Gem::Specification.find_by_name name, req
 
-    gemdirs(gems).each do |dir|
-      yield dir, :gem
-    end if gems
+        File.join spec.doc_dir, 'ri'
+      end
 
-    nil
-  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.
 
-  ##
-  # The ri directory for the gem with +gem_name+.
+      def self.gemdirs(filter = :latest)
+        ri_paths = {}
 
-  def self.gem_dir(name, version)
-    req = Gem::Requirement.new "= #{version}"
+        all = Gem::Specification.map do |spec|
+          [File.join(spec.doc_dir, 'ri'), spec.name, spec.version]
+        end
 
-    spec = Gem::Specification.find_by_name name, req
+        if filter == :all
+          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
 
-    File.join spec.doc_dir, 'ri'
-  end
+        all.each do |dir, name, ver|
+          next unless File.exist? dir
 
-  ##
-  # 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.
+          if ri_paths[name].nil? or ver > ri_paths[name].first
+            ri_paths[name] = [ver, name, dir]
+          end
+        end
 
-  def self.gemdirs(filter = :latest)
-    ri_paths = {}
+        ri_paths.sort_by { |_, (_, name, _)| name }.map { |k, v| v.last }
+      rescue LoadError
+        []
+      end
 
-    all = Gem::Specification.map do |spec|
-      [File.join(spec.doc_dir, 'ri'), spec.name, spec.version]
-    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.
 
-    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
+      def self.home_dir
+        HOMEDIR
       end
 
-      return gemdirs
-    end
+      ##
+      # Returns existing directories from the selected documentation directories
+      # as an Array.
+      #
+      # See also ::each
 
-    all.each do |dir, name, ver|
-      next unless File.exist? dir
+      def self.path(system = true, site = true, home = true, gems = :latest, *extra_dirs)
+        path = raw_path system, site, home, gems, *extra_dirs
 
-      if ri_paths[name].nil? or ver > ri_paths[name].first then
-        ri_paths[name] = [ver, name, dir]
+        path.select { |directory| File.directory? directory }
       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.
+      ##
+      # Returns selected documentation directories including nonexistent
+      # directories.
+      #
+      # See also ::each
 
-  def self.home_dir
-    HOMEDIR
-  end
+      def self.raw_path(system, site, home, gems, *extra_dirs)
+        path = []
 
-  ##
-  # Returns existing directories from the selected documentation directories
-  # as an Array.
-  #
-  # See also ::each
+        each(system, site, home, gems, *extra_dirs) do |dir, type|
+          path << dir
+        end
 
-  def self.path(system = true, site = true, home = true, gems = :latest, *extra_dirs)
-    path = raw_path system, site, home, gems, *extra_dirs
+        path.compact
+      end
 
-    path.select { |directory| File.directory? directory }
-  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.
 
-  ##
-  # Returns selected documentation directories including nonexistent
-  # directories.
-  #
-  # See also ::each
+      def self.site_dir
+        File.join BASE, 'site'
+      end
 
-  def self.raw_path(system, site, home, gems, *extra_dirs)
-    path = []
+      ##
+      # 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
 
-    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