123456789_123456789_123456789_123456789_123456789_

Class: Gem::PathSupport

Relationships & Source Files
Inherits: Object
Defined in: lib/rubygems/path_support.rb

Overview

PathSupport facilitates the GEM_HOME and GEM_PATH environment settings to the rest of RubyGems.

Class Method Summary

Instance Attribute Summary

  • #home readonly

    The default system path for managing Gems.

  • #path readonly

    Array of paths to search for Gems.

  • #spec_cache_dir readonly Internal use only

    Directory with spec cache.

Instance Method Summary

Constructor Details

.new(env) ⇒ PathSupport

Constructor. Takes a single argument which is to be treated like a hashtable, or defaults to ENV, the system environment.

[ GitHub ]

  
# File 'lib/rubygems/path_support.rb', line 25

def initialize(env)
  @home = env["GEM_HOME"] || Gem.default_dir

  if File::ALT_SEPARATOR
    @home = @home.gsub(File::ALT_SEPARATOR, File::SEPARATOR)
  end

  @home = expand(@home)

  @path = split_gem_path env["GEM_PATH"], @home

  @spec_cache_dir = env["GEM_SPEC_CACHE"] || Gem.default_spec_cache_dir

  @spec_cache_dir = @spec_cache_dir.dup.untaint
end

Instance Attribute Details

#home (readonly)

The default system path for managing Gems.

[ GitHub ]

  
# File 'lib/rubygems/path_support.rb', line 10

attr_reader :home

#path (readonly)

Array of paths to search for Gems.

[ GitHub ]

  
# File 'lib/rubygems/path_support.rb', line 14

attr_reader :path

#spec_cache_dir (readonly)

This method is for internal use only.

Directory with spec cache

[ GitHub ]

  
# File 'lib/rubygems/path_support.rb', line 18

attr_reader :spec_cache_dir # :nodoc:

Instance Method Details

#default_path (private)

Return the default ::Gem path

[ GitHub ]

  
# File 'lib/rubygems/path_support.rb', line 74

def default_path
  gem_path = Gem.default_path + [@home]

  if defined?(APPLE_GEM_HOME)
    gem_path << APPLE_GEM_HOME
  end
  gem_path
end

#expand(path) (private)

[ GitHub ]

  
# File 'lib/rubygems/path_support.rb', line 83

def expand(path)
  if File.directory?(path)
    File.realpath(path)
  else
    path
  end
end

#split_gem_path(gpaths, home) (private)

Split the ::Gem search path (as reported by Gem.path).

[ GitHub ]

  
# File 'lib/rubygems/path_support.rb', line 46

def split_gem_path(gpaths, home)
  # FIX: it should be [home, *path], not [*path, home]

  gem_path = []

  if gpaths
    gem_path = gpaths.split(Gem.path_separator)
    # Handle the path_separator being set to a regexp, which will cause
    # end_with? to error
    if gpaths =~ /#{Gem.path_separator}\z/
      gem_path += default_path
    end

    if File::ALT_SEPARATOR
      gem_path.map! do |this_path|
        this_path.gsub File::ALT_SEPARATOR, File::SEPARATOR
      end
    end

    gem_path << home
  else
    gem_path = default_path
  end

  gem_path.map { |path| expand(path) }.uniq
end