lib/rdoc/ri/paths.rb

   1 require 'rdoc/ri'
   2
   3 ##
   4 # Encapsulate all the strangeness to do with finding out where to find RDoc
   5 # files
   6 #
   7 # We basically deal with three directories:
   8 #
   9 # 1. The 'system' documentation directory, which holds the documentation
  10 #    distributed with Ruby, and which is managed by the Ruby install process
  11 # 2. The 'site' directory, which contains site-wide documentation added
  12 #    locally.
  13 # 3. The 'user' documentation directory, stored under the user's own home
  14 #    directory.
  15 #
  16 # There's contention about all this, but for now:
  17 #
  18 # system:: $datadir/ri/<ver>/system/...
  19 # site::   $datadir/ri/<ver>/site/...
  20 # user::   ~/.rdoc
  21
  22 module RDoc::RI::Paths
  23
  24   #:stopdoc:
  25   require 'rbconfig'
  26
  27   DOC_DIR  = "doc/rdoc"
  28
  29   version = RbConfig::CONFIG['ruby_version']
  30
  31   base    = File.join(RbConfig::CONFIG['datadir'], "ri", version)
  32   SYSDIR  = File.join(base, "system")
  33   SITEDIR = File.join(base, "site")
  34   homedir = ENV['HOME'] || ENV['USERPROFILE'] || ENV['HOMEPATH']
  35
  36   if homedir then
  37     HOMEDIR = File.join(homedir, ".rdoc")
  38   else
  39     HOMEDIR = nil
  40   end
  41
  42   # This is the search path for 'ri'
  43   PATH = [ SYSDIR, SITEDIR, HOMEDIR ].find_all {|p| p && File.directory?(p)}
  44
  45   begin
  46     require 'rubygems' unless defined?(Gem) and defined?(Gem::Enable) and
  47                               Gem::Enable
  48
  49     # HACK dup'd from Gem.latest_partials and friends
  50     all_paths = []
  51
  52     all_paths = Gem.path.map do |dir|
  53       Dir[File.join(dir, 'doc', '*', 'ri')]
  54     end.flatten
  55
  56     ri_paths = {}
  57
  58     all_paths.each do |dir|
  59       base = File.basename File.dirname(dir)
  60       if base =~ /(.*)-((\d+\.)*\d+)/ then
  61         name, version = $1, $2
  62         ver = Gem::Version.new version
  63         if ri_paths[name].nil? or ver > ri_paths[name][0] then
  64           ri_paths[name] = [ver, dir]
  65         end
  66       end
  67     end
  68
  69     GEMDIRS = ri_paths.map { |k,v| v.last }.sort
  70     GEMDIRS.each { |dir| PATH << dir }
  71   rescue LoadError
  72     GEMDIRS = []
  73   end
  74
  75   # Returns the selected documentation directories as an Array, or PATH if no
  76   # overriding directories were given.
  77
  78   def self.path(use_system, use_site, use_home, use_gems, *extra_dirs)
  79     path = raw_path(use_system, use_site, use_home, use_gems, *extra_dirs)
  80     return path.select { |directory| File.directory? directory }
  81   end
  82
  83   # Returns the selected documentation directories including nonexistent
  84   # directories.  Used to print out what paths were searched if no ri was
  85   # found.
  86
  87   def self.raw_path(use_system, use_site, use_home, use_gems, *extra_dirs)
  88     return PATH unless use_system or use_site or use_home or use_gems or
  89                        not extra_dirs.empty?
  90
  91     path = []
  92     path << extra_dirs unless extra_dirs.empty?
  93     path << SYSDIR if use_system
  94     path << SITEDIR if use_site
  95     path << HOMEDIR if use_home
  96     path << GEMDIRS if use_gems
  97
  98     return path.flatten.compact
  99   end
 100
 101 end
 102