Extended maintenance of Ruby versions 1.8.7 and 1.9.2 ended on July 31, 2014. Read more

In Files

  • rubygems/doc_manager.rb

Class/Module Index [+]

Quicksearch

Gem::DocManager

The documentation manager generates RDoc and RI for RubyGems.

Public Class Methods

configured_args() click to toggle source
 
               # File rubygems/doc_manager.rb, line 19
def self.configured_args
  @configured_args ||= []
end
            
configured_args=(args) click to toggle source
 
               # File rubygems/doc_manager.rb, line 23
def self.configured_args=(args)
  case args
  when Array
    @configured_args = args
  when String
    @configured_args = args.split
  end
end
            
load_rdoc() click to toggle source

Load RDoc from a gem if it is available, otherwise from Ruby’s stdlib

 
               # File rubygems/doc_manager.rb, line 35
def self.load_rdoc
  begin
    gem 'rdoc'
  rescue Gem::LoadError
    # use built-in RDoc
  end

  begin
    require 'rdoc/rdoc'

    @rdoc_version = if defined? RDoc::VERSION then
                      Gem::Version.new RDoc::VERSION
                    else
                      Gem::Version.new '1.0.1' # HACK parsing is hard
                    end

  rescue LoadError => e
    raise Gem::DocumentError,
        "ERROR: RDoc documentation generator not installed: #{e}"
  end
end
            
new(spec, rdoc_args="") click to toggle source

Create a document manager for spec. rdoc_args contains arguments for RDoc (template etc.) as a String.

 
               # File rubygems/doc_manager.rb, line 87
def initialize(spec, rdoc_args="")
  @spec = spec
  @doc_dir = File.join(spec.installation_path, "doc", spec.full_name)
  @rdoc_args = rdoc_args.nil? ? [] : rdoc_args.split
end
            
rdoc_version() click to toggle source
 
               # File rubygems/doc_manager.rb, line 57
def self.rdoc_version
  @rdoc_version
end
            
update_ri_cache() click to toggle source

Updates the RI cache for RDoc 2 if it is installed

 
               # File rubygems/doc_manager.rb, line 64
def self.update_ri_cache
  load_rdoc rescue return

  return unless defined? RDoc::VERSION # RDoc 1 does not have VERSION

  require 'rdoc/ri/driver'

  options = {
    :use_cache => true,
    :use_system => true,
    :use_site => true,
    :use_home => true,
    :use_gems => true,
    :formatter => RDoc::RI::Formatter,
  }

  driver = RDoc::RI::Driver.new(options).class_cache
end
            

Public Instance Methods

generate_rdoc() click to toggle source

Generate the RDoc documents for this gem spec.

Note that if both RI and RDoc documents are generated from the same process, the RI docs should be done first (a likely bug in RDoc will cause RI docs generation to fail if run after RDoc).

 
               # File rubygems/doc_manager.rb, line 128
def generate_rdoc
  setup_rdoc
  install_rdoc

  FileUtils.mkdir_p @doc_dir unless File.exist?(@doc_dir)
end
            
generate_ri() click to toggle source

Generate the RI documents for this gem spec.

Note that if both RI and RDoc documents are generated from the same process, the RI docs should be done first (a likely bug in RDoc will cause RI docs generation to fail if run after RDoc).

 
               # File rubygems/doc_manager.rb, line 114
def generate_ri
  setup_rdoc
  install_ri # RDoc bug, ri goes first

  FileUtils.mkdir_p @doc_dir unless File.exist?(@doc_dir)
end
            
install_rdoc() click to toggle source

Generate and install RDoc into the documentation directory

 
               # File rubygems/doc_manager.rb, line 138
def install_rdoc
  rdoc_dir = File.join @doc_dir, 'rdoc'

  FileUtils.rm_rf rdoc_dir

  say "Installing RDoc documentation for #{@spec.full_name}..."
  run_rdoc '--op', rdoc_dir
end
            
install_ri() click to toggle source

Generate and install RI into the documentation directory

 
               # File rubygems/doc_manager.rb, line 150
def install_ri
  ri_dir = File.join @doc_dir, 'ri'

  FileUtils.rm_rf ri_dir

  say "Installing ri documentation for #{@spec.full_name}..."
  run_rdoc '--ri', '--op', ri_dir
end
            
rdoc_installed?() click to toggle source

Is the RDoc documentation installed?

 
               # File rubygems/doc_manager.rb, line 96
def rdoc_installed?
  File.exist?(File.join(@doc_dir, "rdoc"))
end
            
ri_installed?() click to toggle source

Is the RI documentation installed?

 
               # File rubygems/doc_manager.rb, line 103
def ri_installed?
  File.exist?(File.join(@doc_dir, "ri"))
end
            
run_rdoc(*args) click to toggle source

Run RDoc with args, which is an ARGV style argument list

 
               # File rubygems/doc_manager.rb, line 162
def run_rdoc(*args)
  args << @spec.rdoc_options
  args << self.class.configured_args
  args << '--quiet'
  args << @spec.require_paths.clone
  args << @spec.extra_rdoc_files
  args << '--title' << "#{@spec.full_name} Documentation"
  args = args.flatten.map do |arg| arg.to_s end

  if self.class.rdoc_version >= Gem::Version.new('2.4.0') then
    args.delete '--inline-source'
    args.delete '--promiscuous'
    args.delete '-p'
    args.delete '--one-file'
    # HACK more
  end

  r = RDoc::RDoc.new

  old_pwd = Dir.pwd
  Dir.chdir @spec.full_gem_path

  say "rdoc #{args.join ' '}" if Gem.configuration.really_verbose

  begin
    r.document args
  rescue Errno::EACCES => e
    dirname = File.dirname e.message.split("-")[1].strip
    raise Gem::FilePermissionError.new(dirname)
  rescue RuntimeError => ex
    alert_error "While generating documentation for #{@spec.full_name}"
    ui.errs.puts "... MESSAGE:   #{ex}"
    ui.errs.puts "... RDOC args: #{args.join(' ')}"
    ui.errs.puts "\t#{ex.backtrace.join "\n\t"}" if
    Gem.configuration.backtrace
    ui.errs.puts "(continuing with the rest of the installation)"
  ensure
    Dir.chdir old_pwd
  end
end
            
setup_rdoc() click to toggle source
 
               # File rubygems/doc_manager.rb, line 203
def setup_rdoc
  if File.exist?(@doc_dir) && !File.writable?(@doc_dir) then
    raise Gem::FilePermissionError.new(@doc_dir)
  end

  FileUtils.mkdir_p @doc_dir unless File.exist?(@doc_dir)

  self.class.load_rdoc
end
            
uninstall_doc() click to toggle source

Remove RDoc and RI documentation

 
               # File rubygems/doc_manager.rb, line 216
def uninstall_doc
  raise Gem::FilePermissionError.new(@spec.installation_path) unless
  File.writable? @spec.installation_path

  original_name = [
    @spec.name, @spec.version, @spec.original_platform].join '-'

  doc_dir = File.join @spec.installation_path, 'doc', @spec.full_name
  unless File.directory? doc_dir then
    doc_dir = File.join @spec.installation_path, 'doc', original_name
  end

  FileUtils.rm_rf doc_dir

  ri_dir = File.join @spec.installation_path, 'ri', @spec.full_name

  unless File.directory? ri_dir then
    ri_dir = File.join @spec.installation_path, 'ri', original_name
  end

  FileUtils.rm_rf ri_dir
end
            

Commenting is here to help enhance the documentation. For example, code samples, or clarification of the documentation.

If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.

If you wish to post a correction of the docs, please do so, but also file bug report so that it can be corrected for the next release. Thank you.

If you want to help improve the Ruby documentation, please visit Documenting-ruby.org.

blog comments powered by Disqus