Module: Gem
- Defined in:
- lib/rubygems/errors.rb,
lib/rubygems.rb,
lib/rubygems.rb,
lib/rubygems/defaults.rb,
lib/rubygems/syck_hack.rb,
lib/rubygems/test_case.rb,
lib/rubygems/util/list.rb,
lib/rubygems/psych_tree.rb,
lib/rubygems/compatibility.rb,
lib/rubygems/compatibility.rb
Overview
– This file contains all sorts of little compatibility hacks that we’ve had to introduce over the years. Quarantining them into one file helps us know when we can get rid of them.
Ruby 1.9.x has introduced some things that are awkward, and we need to support them, so we define some constants to use later. ++
Defined Under Namespace
Modules: Commands, DefaultUserInteraction, Deprecate, Ext, GemcutterUtilities, InstallUpdateOptions, LocalRemoteOptions, Security, Text, UserInteraction, Util, VersionOption Classes: AvailableSet, BasicSpecification, Command, CommandLineError, CommandManager, ConfigFile, ConflictError, ConsoleUI, Dependency, DependencyError, DependencyInstaller, DependencyList, DependencyRemovalException, DependencyResolutionError, Doctor, DocumentError, EndOfYAMLException, ErrorReason, Exception, FakeFetcher, FilePermissionError, FormatException, GemNotFoundException, GemNotInHomeException, GemRunner, ImpossibleDependenciesError, Indexer, InstallError, Installer, InstallerTestCase, InvalidSpecificationException, List, LoadError, MockGemUi, NameTuple, NoAliasYAMLTree, OperationNotSupportedError, Package, PackageTask, PathSupport, Platform, PlatformMismatch, RDoc, RemoteError, RemoteFetcher, RemoteInstallationCancelled, RemoteInstallationSkipped, RemoteSourceException, Request, RequestSet, Requirement, Resolver, RubyVersionMismatch, Server, SilentUI, Source, SourceFetchProblem, SourceList, SpecFetcher, SpecificGemNotFoundException, Specification, StreamUI, StringSink, StringSource, StubSpecification, SystemExitException, TestCase, Uninstaller, UnsatisfiableDependencyError, UriFormatter, Validator, VerificationError, Version
Constant Summary collapse
- VERSION =
'2.4.6'
- RUBYGEMS_DIR =
File.dirname File.(__FILE__)
- WIN_PATTERNS =
An Array of Regexps that match windows Ruby platforms.
[ /bccwin/i, /cygwin/i, /djgpp/i, /mingw/i, /mswin/i, /wince/i, ]
- GEM_DEP_FILES =
%w[ gem.deps.rb Gemfile Isolate ]
- REPOSITORY_SUBDIRECTORIES =
Subdirectories in a gem repository
%w[ build_info cache doc extensions gems specifications ]
- REPOSITORY_DEFAULT_GEM_SUBDIRECTORIES =
Subdirectories in a gem repository for default gems
%w[ gems specifications/default ]
- LOADED_SPECS_MUTEX =
Mutex.new
- MARSHAL_SPEC_DIR =
Location of Marshal quick gemspecs on remote repositories
"quick/Marshal.#{Gem.marshal_version}/"
- DEFAULT_HOST =
"https://rubygems.org"
- DependencyResolver =
TODO remove in RubyGems 3
Gem::Resolver
- SyckDefaultKey =
YAML::Syck::DefaultKey
- UnsatisfiableDepedencyError =
Backwards compatible typo’d exception class for early RubyGems 2.0.x
Gem::UnsatisfiableDependencyError
- RubyGemsVersion =
VERSION
- RbConfigPriorities =
TODO remove at RubyGems 3
%w[ MAJOR MINOR TEENY EXEEXT RUBY_SO_NAME arch bindir datadir libdir ruby_install_name ruby_version rubylibprefix sitedir sitelibdir vendordir vendorlibdir rubylibdir ]
- ConfigMap =
Configuration settings from ::RbConfig
Hash.new do |cm, key| # TODO remove at RubyGems 3 cm[key] = RbConfig::CONFIG[key.to_s] end
- RubyGemsPackageVersion =
VERSION
- @@win_platform =
nil
Class Attribute Summary collapse
-
.done_installing_hooks ⇒ Object
readonly
The list of hooks to be run after Gem::DependencyInstaller installs a set of gems.
-
.loaded_specs ⇒ Object
readonly
Hash of loaded Gem::Specification keyed by name.
-
.post_build_hooks ⇒ Object
readonly
The list of hooks to be run after Gem::Installer#install extracts files and builds extensions.
-
.post_install_hooks ⇒ Object
readonly
The list of hooks to be run after Gem::Installer#install completes installation.
-
.post_reset_hooks ⇒ Object
readonly
The list of hooks to be run after Gem::Specification.reset is run.
-
.post_uninstall_hooks ⇒ Object
readonly
The list of hooks to be run after Gem::Uninstaller#uninstall completes installation.
-
.pre_install_hooks ⇒ Object
readonly
The list of hooks to be run before Gem::Installer#install does any work.
-
.pre_reset_hooks ⇒ Object
readonly
The list of hooks to be run before Gem::Specification.reset is run.
-
.pre_uninstall_hooks ⇒ Object
readonly
The list of hooks to be run before Gem::Uninstaller#uninstall does any work.
Class Method Summary collapse
-
.bin_path(name, exec_name = nil, *requirements) ⇒ Object
Find the full path to the executable for gem
name
. -
.binary_mode ⇒ Object
The mode needed to read a file as straight binary.
-
.bindir(install_dir = Gem.dir) ⇒ Object
The path where gem executables are to be installed.
-
.clear_default_specs ⇒ Object
Clear default gem related variables.
-
.clear_paths ⇒ Object
Reset the
dir
andpath
values. -
.config_file ⇒ Object
The path to standard location of the user’s .gemrc file.
-
.configuration ⇒ Object
The standard configuration object for gems.
-
.configuration=(config) ⇒ Object
Use the given configuration object (which implements the ConfigFile protocol) as the standard configuration object.
-
.datadir(gem_name) ⇒ Object
The path to the data directory specified by the gem name.
-
.default_bindir ⇒ Object
The default directory for binaries.
-
.default_cert_path ⇒ Object
The default signing certificate chain path.
-
.default_dir ⇒ Object
Default home directory path to be used if an alternate value is not specified in the environment.
-
.default_exec_format ⇒ Object
Deduce Ruby’s –program-prefix and –program-suffix from its install name.
-
.default_ext_dir_for(base_dir) ⇒ Object
Returns binary extensions dir for specified RubyGems base dir or nil if such directory cannot be determined.
-
.default_gems_use_full_paths? ⇒ Boolean
Whether to expect full paths in default gems - true for non-MRI ruby implementations.
-
.default_key_path ⇒ Object
The default signing key path.
-
.default_path ⇒ Object
Default gem load path.
-
.default_rubygems_dirs ⇒ Object
Paths where RubyGems’ .rb files and bin files are installed.
-
.default_sources ⇒ Object
An Array of the default sources that come with RubyGems.
-
.default_spec_cache_dir ⇒ Object
Default spec directory path to be used if an alternate value is not specified in the environment.
-
.deflate(data) ⇒ Object
A Zlib::Deflate.deflate wrapper.
-
.dir ⇒ Object
The path where gems are to be installed.
-
.done_installing(&hook) ⇒ Object
Adds a post-installs hook that will be passed a Gem::DependencyInstaller and a list of installed specifications when Gem::DependencyInstaller#install is complete.
-
.ensure_default_gem_subdirectories(dir = Gem.dir, mode = nil) ⇒ Object
Quietly ensure the Gem directory
dir
contains all the proper subdirectories for handling default gems. -
.ensure_gem_subdirectories(dir = Gem.dir, mode = nil) ⇒ Object
Quietly ensure the Gem directory
dir
contains all the proper subdirectories. -
.ensure_subdirectories(dir, mode, subdirs) ⇒ Object
:nodoc:.
-
.extension_api_version ⇒ Object
The extension API version of ruby.
-
.find_files(glob, check_load_path = true) ⇒ Object
Returns a list of paths matching
glob
that can be used by a gem to pick up features from other gems. -
.find_files_from_load_path(glob) ⇒ Object
:nodoc:.
-
.find_latest_files(glob, check_load_path = true) ⇒ Object
Returns a list of paths matching
glob
from the latest gems that can be used by a gem to pick up features from other gems. -
.find_unresolved_default_spec(path) ⇒ Object
Find a Gem::Specification of default gem from
path
. - .finish_resolve(request_set = Gem::RequestSet.new) ⇒ Object
-
.gunzip(data) ⇒ Object
Zlib::GzipReader wrapper that unzips
data
. -
.gzip(data) ⇒ Object
Zlib::GzipWriter wrapper that zips
data
. -
.host ⇒ Object
Get the default RubyGems API host.
-
.host=(host) ⇒ Object
Set the default RubyGems API host.
-
.inflate(data) ⇒ Object
A Zlib::Inflate#inflate wrapper.
-
.install(name, version = Gem::Requirement.default, *options) ⇒ Object
Top level install helper method.
-
.install_extension_in_lib ⇒ Object
Install extensions into lib as well as into the extension directory.
-
.latest_rubygems_version ⇒ Object
Returns the latest release version of RubyGems.
-
.latest_spec_for(name) ⇒ Object
Returns the latest release-version specification for the gem
name
. -
.latest_version_for(name) ⇒ Object
Returns the version of the latest release-version of gem
name
. -
.load_env_plugins ⇒ Object
Find all ‘rubygems_plugin’ files in $LOAD_PATH and load them.
-
.load_path_insert_index ⇒ Object
The index to insert activated gem paths into the $LOAD_PATH.
-
.load_plugin_files(plugins) ⇒ Object
Load
plugins
as Ruby files. -
.load_plugins ⇒ Object
Find the ‘rubygems_plugin’ files in the latest installed gems and load them.
-
.load_yaml ⇒ Object
Loads YAML, preferring Psych.
-
.location_of_caller ⇒ Object
The file name and line number of the caller of the caller of this method.
-
.marshal_version ⇒ Object
The version of the Marshal format for your Ruby.
- .needs {|rs| ... } ⇒ Object
- .path ⇒ Object
-
.path_separator ⇒ Object
How String Gem paths should be split.
-
.paths ⇒ Object
Retrieve the PathSupport object that RubyGems uses to lookup files.
-
.paths=(env) ⇒ Object
Initialize the filesystem paths to use from
env
. -
.platforms ⇒ Object
Array of platforms this RubyGems supports.
-
.platforms=(platforms) ⇒ Object
Set array of platforms this RubyGems supports (primarily for testing).
-
.post_build(&hook) ⇒ Object
Adds a post-build hook that will be passed an Gem::Installer instance when Gem::Installer#install is called.
-
.post_install(&hook) ⇒ Object
Adds a post-install hook that will be passed an Gem::Installer instance when Gem::Installer#install is called.
-
.post_reset(&hook) ⇒ Object
Adds a hook that will get run after Gem::Specification.reset is run.
-
.post_uninstall(&hook) ⇒ Object
Adds a post-uninstall hook that will be passed a Gem::Uninstaller instance and the spec that was uninstalled when Gem::Uninstaller#uninstall is called.
-
.pre_install(&hook) ⇒ Object
Adds a pre-install hook that will be passed an Gem::Installer instance when Gem::Installer#install is called.
-
.pre_reset(&hook) ⇒ Object
Adds a hook that will get run before Gem::Specification.reset is run.
-
.pre_uninstall(&hook) ⇒ Object
Adds a pre-uninstall hook that will be passed an Gem::Uninstaller instance and the spec that will be uninstalled when Gem::Uninstaller#uninstall is called.
-
.prefix ⇒ Object
The directory prefix this RubyGems was installed at.
-
.read_binary(path) ⇒ Object
Safely read a file in binary mode on all platforms.
-
.refresh ⇒ Object
Refresh available gems from disk.
-
.register_default_spec(spec) ⇒ Object
Register a Gem::Specification for default gem.
-
.remove_unresolved_default_spec(spec) ⇒ Object
Remove needless Gem::Specification of default gem from unresolved default gem list.
-
.ruby ⇒ Object
The path to the running Ruby interpreter.
-
.ruby=(ruby) ⇒ Object
Allows setting path to Ruby.
-
.ruby_api_version ⇒ Object
Returns a String containing the API compatibility version of Ruby.
-
.ruby_engine ⇒ Object
A wrapper around RUBY_ENGINE const that may not be defined.
-
.ruby_version ⇒ Object
A Gem::Version for the currently running Ruby.
-
.rubygems_version ⇒ Object
A Gem::Version for the currently running RubyGems.
-
.searcher=(searcher) ⇒ Object
Allows setting the gem path searcher.
-
.sources ⇒ Object
Returns an Array of sources to fetch remote gems from.
-
.sources=(new_sources) ⇒ Object
Need to be able to set the sources without calling Gem.sources.replace since that would cause an infinite loop.
- .spec_cache_dir ⇒ Object
-
.suffix_pattern ⇒ Object
Glob pattern for require-able path suffixes.
-
.suffixes ⇒ Object
Suffixes for require-able paths.
-
.time(msg, width = 0, display = Gem.configuration.verbose) ⇒ Object
Prints the amount of time the supplied block takes to run using the debug UI output.
-
.try_activate(path) ⇒ Object
Try to activate a gem containing
path
. -
.ui ⇒ Object
Lazily loads DefaultUserInteraction and returns the default UI.
-
.use_gemdeps(path = nil) ⇒ Object
(also: detect_gemdeps)
Looks for a gem dependency file at
path
and activates the gems in the file if found. -
.use_paths(home, *paths) ⇒ Object
Use the
home
andpaths
values for Gem.dir and Gem.path. -
.user_dir ⇒ Object
Path for gems in the user’s home directory.
-
.user_home ⇒ Object
The home directory for the user.
-
.vendor_dir ⇒ Object
Directory where vendor gems are installed.
-
.win_platform=(val) ⇒ Object
Allows toggling Windows behavior.
-
.win_platform? ⇒ Boolean
Is this a windows platform?.
Class Attribute Details
.done_installing_hooks ⇒ Object (readonly)
The list of hooks to be run after Gem::DependencyInstaller installs a set of gems
1159 1160 1161 |
# File 'lib/rubygems.rb', line 1159 def done_installing_hooks @done_installing_hooks end |
.loaded_specs ⇒ Object (readonly)
Hash of loaded Gem::Specification keyed by name
1083 1084 1085 |
# File 'lib/rubygems.rb', line 1083 def loaded_specs @loaded_specs end |
.post_build_hooks ⇒ Object (readonly)
The list of hooks to be run after Gem::Installer#install extracts files and builds extensions
1147 1148 1149 |
# File 'lib/rubygems.rb', line 1147 def post_build_hooks @post_build_hooks end |
.post_install_hooks ⇒ Object (readonly)
The list of hooks to be run after Gem::Installer#install completes installation
1153 1154 1155 |
# File 'lib/rubygems.rb', line 1153 def post_install_hooks @post_install_hooks end |
.post_reset_hooks ⇒ Object (readonly)
The list of hooks to be run after Gem::Specification.reset is run.
1164 1165 1166 |
# File 'lib/rubygems.rb', line 1164 def post_reset_hooks @post_reset_hooks end |
.post_uninstall_hooks ⇒ Object (readonly)
The list of hooks to be run after Gem::Uninstaller#uninstall completes installation
1170 1171 1172 |
# File 'lib/rubygems.rb', line 1170 def post_uninstall_hooks @post_uninstall_hooks end |
.pre_install_hooks ⇒ Object (readonly)
The list of hooks to be run before Gem::Installer#install does any work
1175 1176 1177 |
# File 'lib/rubygems.rb', line 1175 def pre_install_hooks @pre_install_hooks end |
.pre_reset_hooks ⇒ Object (readonly)
The list of hooks to be run before Gem::Specification.reset is run.
1180 1181 1182 |
# File 'lib/rubygems.rb', line 1180 def pre_reset_hooks @pre_reset_hooks end |
.pre_uninstall_hooks ⇒ Object (readonly)
The list of hooks to be run before Gem::Uninstaller#uninstall does any work
1186 1187 1188 |
# File 'lib/rubygems.rb', line 1186 def pre_uninstall_hooks @pre_uninstall_hooks end |
Class Method Details
.bin_path(name, exec_name = nil, *requirements) ⇒ Object
Find the full path to the executable for gem name
. If the exec_name
is not given, the gem’s default_executable is chosen, otherwise the specified executable’s path is returned. requirements
allows you to specify specific gem versions.
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 |
# File 'lib/rubygems.rb', line 226 def self.bin_path(name, exec_name = nil, *requirements) # TODO: fails test_self_bin_path_bin_file_gone_in_latest # Gem::Specification.find_by_name(name, *requirements).bin_file exec_name raise ArgumentError, "you must supply exec_name" unless exec_name requirements = Gem::Requirement.default if requirements.empty? dep = Gem::Dependency.new name, requirements loaded = Gem.loaded_specs[name] return loaded.bin_file exec_name if loaded && dep.matches_spec?(loaded) specs = dep.matching_specs(true) raise Gem::GemNotFoundException, "can't find gem #{name} (#{requirements})" if specs.empty? specs = specs.find_all { |spec| spec.executables.include? exec_name } if exec_name unless spec = specs.last msg = "can't find gem #{name} (#{requirements}) with executable #{exec_name}" raise Gem::GemNotFoundException, msg end spec.bin_file exec_name end |
.binary_mode ⇒ Object
The mode needed to read a file as straight binary.
261 262 263 |
# File 'lib/rubygems.rb', line 261 def self.binary_mode 'rb' end |
.bindir(install_dir = Gem.dir) ⇒ Object
The path where gem executables are to be installed.
268 269 270 271 272 |
# File 'lib/rubygems.rb', line 268 def self.bindir(install_dir=Gem.dir) return File.join install_dir, 'bin' unless install_dir.to_s == Gem.default_dir.to_s Gem.default_bindir end |
.clear_default_specs ⇒ Object
Clear default gem related variables. It is for test
1139 1140 1141 |
# File 'lib/rubygems.rb', line 1139 def clear_default_specs @path_to_default_spec_map.clear end |
.clear_paths ⇒ Object
Reset the dir
and path
values. The next time dir
or path
is requested, the values will be calculated from scratch. This is mainly used by the unit tests to provide test isolation.
279 280 281 282 283 284 |
# File 'lib/rubygems.rb', line 279 def self.clear_paths @paths = nil @user_home = nil Gem::Specification.reset Gem::Security.reset if defined?(Gem::Security) end |
.config_file ⇒ Object
The path to standard location of the user’s .gemrc file.
289 290 291 |
# File 'lib/rubygems.rb', line 289 def self.config_file @config_file ||= File.join Gem.user_home, '.gemrc' end |
.configuration ⇒ Object
The standard configuration object for gems.
296 297 298 |
# File 'lib/rubygems.rb', line 296 def self.configuration @configuration ||= Gem::ConfigFile.new [] end |
.configuration=(config) ⇒ Object
Use the given configuration object (which implements the ConfigFile protocol) as the standard configuration object.
304 305 306 |
# File 'lib/rubygems.rb', line 304 def self.configuration=(config) @configuration = config end |
.datadir(gem_name) ⇒ Object
The path to the data directory specified by the gem name. If the package is not available as a gem, return nil.
312 313 314 315 316 317 318 |
# File 'lib/rubygems.rb', line 312 def self.datadir(gem_name) # TODO: deprecate and move to Gem::Specification # and drop the extra ", gem_name" which is uselessly redundant spec = @loaded_specs[gem_name] return nil if spec.nil? File.join spec.full_gem_path, "data", gem_name end |
.default_bindir ⇒ Object
The default directory for binaries
116 117 118 119 120 121 122 |
# File 'lib/rubygems/defaults.rb', line 116 def self.default_bindir if defined? RUBY_FRAMEWORK_VERSION then # mac framework support '/usr/bin' else # generic install RbConfig::CONFIG['bindir'] end end |
.default_cert_path ⇒ Object
The default signing certificate chain path
145 146 147 |
# File 'lib/rubygems/defaults.rb', line 145 def self.default_cert_path File.join Gem.user_home, ".gem", "gem-public_cert.pem" end |
.default_dir ⇒ Object
Default home directory path to be used if an alternate value is not specified in the environment
29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 |
# File 'lib/rubygems/defaults.rb', line 29 def self.default_dir path = if defined? RUBY_FRAMEWORK_VERSION then [ File.dirname(RbConfig::CONFIG['sitedir']), 'Gems', RbConfig::CONFIG['ruby_version'] ] elsif RbConfig::CONFIG['rubylibprefix'] then [ RbConfig::CONFIG['rubylibprefix'], 'gems', RbConfig::CONFIG['ruby_version'] ] else [ RbConfig::CONFIG['libdir'], ruby_engine, 'gems', RbConfig::CONFIG['ruby_version'] ] end @default_dir ||= File.join(*path) end |
.default_exec_format ⇒ Object
Deduce Ruby’s –program-prefix and –program-suffix from its install name
102 103 104 105 106 107 108 109 110 111 |
# File 'lib/rubygems/defaults.rb', line 102 def self.default_exec_format exec_format = RbConfig::CONFIG['ruby_install_name'].sub('ruby', '%s') rescue '%s' unless exec_format =~ /%s/ then raise Gem::Exception, "[BUG] invalid exec_format #{exec_format.inspect}, no %s" end exec_format end |
.default_ext_dir_for(base_dir) ⇒ Object
Returns binary extensions dir for specified RubyGems base dir or nil if such directory cannot be determined.
By default, the binary extensions are located side by side with their Ruby counterparts, therefore nil is returned
61 62 63 |
# File 'lib/rubygems/defaults.rb', line 61 def self.default_ext_dir_for base_dir nil end |
.default_gems_use_full_paths? ⇒ Boolean
Whether to expect full paths in default gems - true for non-MRI ruby implementations
152 153 154 |
# File 'lib/rubygems/defaults.rb', line 152 def self.default_gems_use_full_paths? ruby_engine != 'ruby' end |
.default_key_path ⇒ Object
The default signing key path
138 139 140 |
# File 'lib/rubygems/defaults.rb', line 138 def self.default_key_path File.join Gem.user_home, ".gem", "gem-private_key.pem" end |
.default_path ⇒ Object
Default gem load path
91 92 93 94 95 96 97 |
# File 'lib/rubygems/defaults.rb', line 91 def self.default_path path = [] path << user_dir if user_home && File.exist?(user_home) path << default_dir path << vendor_dir if vendor_dir and File.directory? vendor_dir path end |
.default_rubygems_dirs ⇒ Object
Paths where RubyGems’ .rb files and bin files are installed
68 69 70 |
# File 'lib/rubygems/defaults.rb', line 68 def self.default_rubygems_dirs nil # default to standard layout end |
.default_sources ⇒ Object
An Array of the default sources that come with RubyGems
13 14 15 |
# File 'lib/rubygems/defaults.rb', line 13 def self.default_sources %w[https://rubygems.org/] end |
.default_spec_cache_dir ⇒ Object
Default spec directory path to be used if an alternate value is not specified in the environment
21 22 23 |
# File 'lib/rubygems/defaults.rb', line 21 def self.default_spec_cache_dir File.join Gem.user_home, '.gem', 'specs' end |
.deflate(data) ⇒ Object
A Zlib::Deflate.deflate wrapper
323 324 325 326 |
# File 'lib/rubygems.rb', line 323 def self.deflate(data) require 'zlib' Zlib::Deflate.deflate data end |
.dir ⇒ Object
The path where gems are to be installed. – FIXME deprecate these once everything else has been done -ebh
350 351 352 |
# File 'lib/rubygems.rb', line 350 def self.dir paths.home end |
.done_installing(&hook) ⇒ Object
Adds a post-installs hook that will be passed a Gem::DependencyInstaller and a list of installed specifications when Gem::DependencyInstaller#install is complete
699 700 701 |
# File 'lib/rubygems.rb', line 699 def self.done_installing(&hook) @done_installing_hooks << hook end |
.ensure_default_gem_subdirectories(dir = Gem.dir, mode = nil) ⇒ Object
Quietly ensure the Gem directory dir
contains all the proper subdirectories for handling default gems. If we can’t create a directory due to a permission problem, then we will silently continue.
If mode
is given, missing directories are created with this mode.
World-writable directories will never be created.
384 385 386 |
# File 'lib/rubygems.rb', line 384 def self.ensure_default_gem_subdirectories dir = Gem.dir, mode = nil ensure_subdirectories(dir, mode, REPOSITORY_DEFAULT_GEM_SUBDIRECTORIES) end |
.ensure_gem_subdirectories(dir = Gem.dir, mode = nil) ⇒ Object
Quietly ensure the Gem directory dir
contains all the proper subdirectories. If we can’t create a directory due to a permission problem, then we will silently continue.
If mode
is given, missing directories are created with this mode.
World-writable directories will never be created.
371 372 373 |
# File 'lib/rubygems.rb', line 371 def self.ensure_gem_subdirectories dir = Gem.dir, mode = nil ensure_subdirectories(dir, mode, REPOSITORY_SUBDIRECTORIES) end |
.ensure_subdirectories(dir, mode, subdirs) ⇒ Object
:nodoc:
388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 |
# File 'lib/rubygems.rb', line 388 def self.ensure_subdirectories dir, mode, subdirs # :nodoc: old_umask = File.umask File.umask old_umask | 002 require 'fileutils' = {} [:mode] = mode if mode subdirs.each do |name| subdir = File.join dir, name next if File.exist? subdir FileUtils.mkdir_p subdir, rescue nil end ensure File.umask old_umask end |
.extension_api_version ⇒ Object
The extension API version of ruby. This includes the static vs non-static distinction as extensions cannot be shared between the two.
411 412 413 414 415 416 417 |
# File 'lib/rubygems.rb', line 411 def self.extension_api_version # :nodoc: if 'no' == RbConfig::CONFIG['ENABLE_SHARED'] then "#{ruby_api_version}-static" else ruby_api_version end end |
.find_files(glob, check_load_path = true) ⇒ Object
Returns a list of paths matching glob
that can be used by a gem to pick up features from other gems. For example:
Gem.find_files('rdoc/discover').each do |path| load path end
if check_load_path
is true (the default), then find_files also searches $LOAD_PATH for files as well as gems.
Note that find_files will return all files even if they are from different versions of the same gem. See also find_latest_files
431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 |
# File 'lib/rubygems.rb', line 431 def self.find_files(glob, check_load_path=true) files = [] files = find_files_from_load_path glob if check_load_path files.concat Gem::Specification.map { |spec| spec.matches_for_glob("#{glob}#{Gem.suffix_pattern}") }.flatten # $LOAD_PATH might contain duplicate entries or reference # the spec dirs directly, so we prune. files.uniq! if check_load_path return files end |
.find_files_from_load_path(glob) ⇒ Object
:nodoc:
447 448 449 450 451 |
# File 'lib/rubygems.rb', line 447 def self.find_files_from_load_path glob # :nodoc: $LOAD_PATH.map { |load_path| Dir["#{File. glob, load_path}#{Gem.suffix_pattern}"] }.flatten.select { |file| File.file? file.untaint } end |
.find_latest_files(glob, check_load_path = true) ⇒ Object
Returns a list of paths matching glob
from the latest gems that can be used by a gem to pick up features from other gems. For example:
Gem.find_latest_files('rdoc/discover').each do |path| load path end
if check_load_path
is true (the default), then find_latest_files also searches $LOAD_PATH for files as well as gems.
Unlike find_files, find_latest_files will return only files from the latest version of a gem.
465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 |
# File 'lib/rubygems.rb', line 465 def self.find_latest_files(glob, check_load_path=true) files = [] files = find_files_from_load_path glob if check_load_path files.concat Gem::Specification.latest_specs(true).map { |spec| spec.matches_for_glob("#{glob}#{Gem.suffix_pattern}") }.flatten # $LOAD_PATH might contain duplicate entries or reference # the spec dirs directly, so we prune. files.uniq! if check_load_path return files end |
.find_unresolved_default_spec(path) ⇒ Object
Find a Gem::Specification of default gem from path
1118 1119 1120 1121 1122 1123 1124 |
# File 'lib/rubygems.rb', line 1118 def find_unresolved_default_spec(path) Gem.suffixes.each do |suffix| spec = @path_to_default_spec_map["#{path}#{suffix}"] return spec if spec end nil end |
.finish_resolve(request_set = Gem::RequestSet.new) ⇒ Object
212 213 214 215 216 217 218 |
# File 'lib/rubygems.rb', line 212 def self.finish_resolve(request_set=Gem::RequestSet.new) request_set.import Gem::Specification.unresolved_deps.values request_set.resolve_current.each do |s| s.full_spec.activate end end |
.gunzip(data) ⇒ Object
Zlib::GzipReader wrapper that unzips data
.
526 527 528 529 |
# File 'lib/rubygems.rb', line 526 def self.gunzip(data) require 'rubygems/util' Gem::Util.gunzip data end |
.gzip(data) ⇒ Object
Zlib::GzipWriter wrapper that zips data
.
534 535 536 537 |
# File 'lib/rubygems.rb', line 534 def self.gzip(data) require 'rubygems/util' Gem::Util.gzip data end |
.host ⇒ Object
Get the default RubyGems API host. This is normally https://rubygems.org
.
566 567 568 569 |
# File 'lib/rubygems.rb', line 566 def self.host # TODO: move to utils @host ||= Gem::DEFAULT_HOST end |
.host=(host) ⇒ Object
Set the default RubyGems API host.
573 574 575 576 |
# File 'lib/rubygems.rb', line 573 def self.host= host # TODO: move to utils @host = host end |
.inflate(data) ⇒ Object
A Zlib::Inflate#inflate wrapper
542 543 544 545 |
# File 'lib/rubygems.rb', line 542 def self.inflate(data) require 'rubygems/util' Gem::Util.inflate data end |
.install(name, version = Gem::Requirement.default, *options) ⇒ Object
Top level install helper method. Allows you to install gems interactively:
% irb
>> Gem.install "minitest"
Fetching: minitest-3.0.1.gem (100%)
=> [#<Gem::Specification:0x1013b4528 @name="minitest", ...>]
555 556 557 558 559 560 |
# File 'lib/rubygems.rb', line 555 def self.install name, version = Gem::Requirement.default, * require "rubygems/dependency_installer" inst = Gem::DependencyInstaller.new(*) inst.install name, version inst.installed_gems end |
.install_extension_in_lib ⇒ Object
Install extensions into lib as well as into the extension directory.
159 160 161 |
# File 'lib/rubygems/defaults.rb', line 159 def self.install_extension_in_lib # :nodoc: true end |
.latest_rubygems_version ⇒ Object
Returns the latest release version of RubyGems.
819 820 821 822 |
# File 'lib/rubygems.rb', line 819 def self.latest_rubygems_version latest_version_for('rubygems-update') or raise "Can't find 'rubygems-update' in any repo. Check `gem source list`." end |
.latest_spec_for(name) ⇒ Object
Returns the latest release-version specification for the gem name
.
806 807 808 809 810 811 812 813 814 |
# File 'lib/rubygems.rb', line 806 def self.latest_spec_for name dependency = Gem::Dependency.new name fetcher = Gem::SpecFetcher.fetcher spec_tuples, = fetcher.spec_for_dependency dependency spec, = spec_tuples.first spec end |
.latest_version_for(name) ⇒ Object
Returns the version of the latest release-version of gem name
827 828 829 830 |
# File 'lib/rubygems.rb', line 827 def self.latest_version_for name spec = latest_spec_for name spec and spec.version end |
.load_env_plugins ⇒ Object
Find all ‘rubygems_plugin’ files in $LOAD_PATH and load them
990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 |
# File 'lib/rubygems.rb', line 990 def self.load_env_plugins path = "rubygems_plugin" files = [] $LOAD_PATH.each do |load_path| globbed = Dir["#{File. path, load_path}#{Gem.suffix_pattern}"] globbed.each do |load_path_file| files << load_path_file if File.file?(load_path_file.untaint) end end load_plugin_files files end |
.load_path_insert_index ⇒ Object
The index to insert activated gem paths into the $LOAD_PATH. The activated gem’s paths are inserted before site lib directory by default.
582 583 584 585 586 |
# File 'lib/rubygems.rb', line 582 def self.load_path_insert_index index = $LOAD_PATH.index RbConfig::CONFIG['sitelibdir'] index end |
.load_plugin_files(plugins) ⇒ Object
Load plugins
as Ruby files
957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 |
# File 'lib/rubygems.rb', line 957 def self.load_plugin_files plugins # :nodoc: plugins.each do |plugin| # Skip older versions of the GemCutter plugin: Its commands are in # RubyGems proper now. next if plugin =~ /gemcutter-0\.[0-3]/ begin load plugin rescue ::Exception => e details = "#{plugin.inspect}: #{e.} (#{e.class})" warn "Error loading RubyGems plugin #{details}" end end end |
.load_plugins ⇒ Object
Find the ‘rubygems_plugin’ files in the latest installed gems and load them
978 979 980 981 982 983 984 985 |
# File 'lib/rubygems.rb', line 978 def self.load_plugins # Remove this env var by at least 3.0 if ENV['RUBYGEMS_LOAD_ALL_PLUGINS'] load_plugin_files find_files('rubygems_plugin', false) else load_plugin_files find_latest_files('rubygems_plugin', false) end end |
.load_yaml ⇒ Object
Loads YAML, preferring Psych
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 |
# File 'lib/rubygems.rb', line 593 def self.load_yaml return if @yaml_loaded return unless defined?(gem) test_syck = ENV['TEST_SYCK'] unless test_syck begin gem 'psych', '>= 1.2.1' rescue Gem::LoadError # It's OK if the user does not have the psych gem installed. We will # attempt to require the stdlib version end begin # Try requiring the gem version *or* stdlib version of psych. require 'psych' rescue ::LoadError # If we can't load psych, thats fine, go on. else # If 'yaml' has already been required, then we have to # be sure to switch it over to the newly loaded psych. if defined?(YAML::ENGINE) && YAML::ENGINE.yamler != "psych" YAML::ENGINE.yamler = "psych" end require 'rubygems/psych_additions' require 'rubygems/psych_tree' end end require 'yaml' # If we're supposed to be using syck, then we may have to force # activate it via the YAML::ENGINE API. if test_syck and defined?(YAML::ENGINE) YAML::ENGINE.yamler = "syck" unless YAML::ENGINE.syck? end # Now that we're sure some kind of yaml library is loaded, pull # in our hack to deal with Syck's DefaultKey ugliness. require 'rubygems/syck_hack' @yaml_loaded = true end |
.location_of_caller ⇒ Object
The file name and line number of the caller of the caller of this method.
642 643 644 645 646 647 648 |
# File 'lib/rubygems.rb', line 642 def self.location_of_caller caller[1] =~ /(.*?):(\d+).*?$/i file = $1 lineno = $2.to_i [file, lineno] end |
.marshal_version ⇒ Object
The version of the Marshal format for your Ruby.
653 654 655 |
# File 'lib/rubygems.rb', line 653 def self.marshal_version "#{Marshal::MAJOR_VERSION}.#{Marshal::MINOR_VERSION}" end |
.needs {|rs| ... } ⇒ Object
204 205 206 207 208 209 210 |
# File 'lib/rubygems.rb', line 204 def self.needs rs = Gem::RequestSet.new yield rs finish_resolve rs end |
.path ⇒ Object
354 355 356 |
# File 'lib/rubygems.rb', line 354 def self.path paths.path end |
.path_separator ⇒ Object
How String Gem paths should be split. Overridable for esoteric platforms.
84 85 86 |
# File 'lib/rubygems/defaults.rb', line 84 def self.path_separator File::PATH_SEPARATOR end |
.paths ⇒ Object
Retrieve the PathSupport object that RubyGems uses to lookup files.
331 332 333 |
# File 'lib/rubygems.rb', line 331 def self.paths @paths ||= Gem::PathSupport.new end |
.paths=(env) ⇒ Object
Initialize the filesystem paths to use from env
. env
is a hash-like object (typically ENV) that is queried for ‘GEM_HOME’, ‘GEM_PATH’, and ‘GEM_SPEC_CACHE’
339 340 341 342 343 |
# File 'lib/rubygems.rb', line 339 def self.paths=(env) clear_paths @paths = Gem::PathSupport.new env Gem::Specification.dirs = @paths.path end |
.platforms ⇒ Object
Array of platforms this RubyGems supports.
667 668 669 670 671 672 673 |
# File 'lib/rubygems.rb', line 667 def self.platforms @platforms ||= [] if @platforms.empty? @platforms = [Gem::Platform::RUBY, Gem::Platform.local] end @platforms end |
.platforms=(platforms) ⇒ Object
Set array of platforms this RubyGems supports (primarily for testing).
660 661 662 |
# File 'lib/rubygems.rb', line 660 def self.platforms=(platforms) @platforms = platforms end |
.post_build(&hook) ⇒ Object
Adds a post-build hook that will be passed an Gem::Installer instance when Gem::Installer#install is called. The hook is called after the gem has been extracted and extensions have been built but before the executables or gemspec has been written. If the hook returns false
then the gem’s files will be removed and the install will be aborted.
682 683 684 |
# File 'lib/rubygems.rb', line 682 def self.post_build(&hook) @post_build_hooks << hook end |
.post_install(&hook) ⇒ Object
Adds a post-install hook that will be passed an Gem::Installer instance when Gem::Installer#install is called
690 691 692 |
# File 'lib/rubygems.rb', line 690 def self.post_install(&hook) @post_install_hooks << hook end |
.post_reset(&hook) ⇒ Object
Adds a hook that will get run after Gem::Specification.reset is run.
707 708 709 |
# File 'lib/rubygems.rb', line 707 def self.post_reset(&hook) @post_reset_hooks << hook end |
.post_uninstall(&hook) ⇒ Object
Adds a post-uninstall hook that will be passed a Gem::Uninstaller instance and the spec that was uninstalled when Gem::Uninstaller#uninstall is called
716 717 718 |
# File 'lib/rubygems.rb', line 716 def self.post_uninstall(&hook) @post_uninstall_hooks << hook end |
.pre_install(&hook) ⇒ Object
Adds a pre-install hook that will be passed an Gem::Installer instance when Gem::Installer#install is called. If the hook returns false
then the install will be aborted.
725 726 727 |
# File 'lib/rubygems.rb', line 725 def self.pre_install(&hook) @pre_install_hooks << hook end |
.pre_reset(&hook) ⇒ Object
Adds a hook that will get run before Gem::Specification.reset is run.
733 734 735 |
# File 'lib/rubygems.rb', line 733 def self.pre_reset(&hook) @pre_reset_hooks << hook end |
.pre_uninstall(&hook) ⇒ Object
Adds a pre-uninstall hook that will be passed an Gem::Uninstaller instance and the spec that will be uninstalled when Gem::Uninstaller#uninstall is called
742 743 744 |
# File 'lib/rubygems.rb', line 742 def self.pre_uninstall(&hook) @pre_uninstall_hooks << hook end |
.prefix ⇒ Object
The directory prefix this RubyGems was installed at. If your prefix is in a standard location (ie, rubygems is installed where you’d expect it to be), then prefix returns nil.
751 752 753 754 755 756 757 758 759 |
# File 'lib/rubygems.rb', line 751 def self.prefix prefix = File.dirname RUBYGEMS_DIR if prefix != File.(RbConfig::CONFIG['sitelibdir']) and prefix != File.(RbConfig::CONFIG['libdir']) and 'lib' == File.basename(RUBYGEMS_DIR) then prefix end end |
.read_binary(path) ⇒ Object
Safely read a file in binary mode on all platforms.
771 772 773 774 775 776 777 778 779 780 |
# File 'lib/rubygems.rb', line 771 def self.read_binary(path) open path, 'rb+' do |f| f.flock(File::LOCK_EX) f.read end rescue Errno::EACCES open path, 'rb' do |f| f.read end end |
.refresh ⇒ Object
Refresh available gems from disk.
764 765 766 |
# File 'lib/rubygems.rb', line 764 def self.refresh Gem::Specification.reset end |
.register_default_spec(spec) ⇒ Object
Register a Gem::Specification for default gem.
Two formats for the specification are supported:
-
MRI 2.0 style, where spec.files contains unprefixed require names. The spec’s filenames will be registered as-is.
-
New style, where spec.files contains files prefixed with paths from spec.require_paths. The prefixes are stripped before registering the spec’s filenames. Unprefixed files are omitted.
1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 |
# File 'lib/rubygems.rb', line 1097 def register_default_spec(spec) new_format = Gem.default_gems_use_full_paths? || spec.require_paths.any? {|path| spec.files.any? {|f| f.start_with? path } } if new_format prefix_group = spec.require_paths.map {|f| f + "/"}.join("|") prefix_pattern = /^(#{prefix_group})/ end spec.files.each do |file| if new_format file = file.sub(prefix_pattern, "") next unless $~ end @path_to_default_spec_map[file] = spec end end |
.remove_unresolved_default_spec(spec) ⇒ Object
Remove needless Gem::Specification of default gem from unresolved default gem list
1130 1131 1132 1133 1134 |
# File 'lib/rubygems.rb', line 1130 def remove_unresolved_default_spec(spec) spec.files.each do |file| @path_to_default_spec_map.delete(file) end end |
.ruby ⇒ Object
The path to the running Ruby interpreter.
785 786 787 788 789 790 791 792 793 794 |
# File 'lib/rubygems.rb', line 785 def self.ruby if @ruby.nil? then @ruby = File.join(RbConfig::CONFIG['bindir'], "#{RbConfig::CONFIG['ruby_install_name']}#{RbConfig::CONFIG['EXEEXT']}") @ruby = "\"#{@ruby}\"" if @ruby =~ /\s/ end @ruby end |
.ruby=(ruby) ⇒ Object
Allows setting path to Ruby. This method is available when requiring ‘rubygems/test_case’
66 67 68 |
# File 'lib/rubygems/test_case.rb', line 66 def self.ruby= ruby @ruby = ruby end |
.ruby_api_version ⇒ Object
Returns a String containing the API compatibility version of Ruby
799 800 801 |
# File 'lib/rubygems.rb', line 799 def self.ruby_api_version @ruby_api_version ||= RbConfig::CONFIG['ruby_version'].dup end |
.ruby_engine ⇒ Object
A wrapper around RUBY_ENGINE const that may not be defined
127 128 129 130 131 132 133 |
# File 'lib/rubygems/defaults.rb', line 127 def self.ruby_engine if defined? RUBY_ENGINE then RUBY_ENGINE else 'ruby' end end |
.ruby_version ⇒ Object
A Gem::Version for the currently running Ruby.
835 836 837 838 839 840 841 842 843 844 845 846 |
# File 'lib/rubygems.rb', line 835 def self.ruby_version return @ruby_version if defined? @ruby_version version = RUBY_VERSION.dup if defined?(RUBY_PATCHLEVEL) && RUBY_PATCHLEVEL != -1 then version << ".#{RUBY_PATCHLEVEL}" elsif defined?(RUBY_REVISION) then version << ".dev.#{RUBY_REVISION}" end @ruby_version = Gem::Version.new version end |
.rubygems_version ⇒ Object
A Gem::Version for the currently running RubyGems
851 852 853 854 |
# File 'lib/rubygems.rb', line 851 def self.rubygems_version return @rubygems_version if defined? @rubygems_version @rubygems_version = Gem::Version.new Gem::VERSION end |
.searcher=(searcher) ⇒ Object
Allows setting the gem path searcher. This method is available when requiring ‘rubygems/test_case’
50 51 52 |
# File 'lib/rubygems/test_case.rb', line 50 def self.searcher=(searcher) @searcher = searcher end |
.sources ⇒ Object
Returns an Array of sources to fetch remote gems from. Uses default_sources if the sources list is empty.
860 861 862 |
# File 'lib/rubygems.rb', line 860 def self.sources @sources ||= Gem::SourceList.from(default_sources) end |
.sources=(new_sources) ⇒ Object
Need to be able to set the sources without calling Gem.sources.replace since that would cause an infinite loop.
DOC: This comment is not documentation about the method itself, it’s more of a code comment about the implementation.
871 872 873 874 875 876 877 |
# File 'lib/rubygems.rb', line 871 def self.sources= new_sources if !new_sources @sources = nil else @sources = Gem::SourceList.from(new_sources) end end |
.spec_cache_dir ⇒ Object
358 359 360 |
# File 'lib/rubygems.rb', line 358 def self.spec_cache_dir paths.spec_cache_dir end |
.suffix_pattern ⇒ Object
Glob pattern for require-able path suffixes.
882 883 884 |
# File 'lib/rubygems.rb', line 882 def self.suffix_pattern @suffix_pattern ||= "{#{suffixes.join(',')}}" end |
.suffixes ⇒ Object
Suffixes for require-able paths.
889 890 891 892 893 894 895 896 897 898 |
# File 'lib/rubygems.rb', line 889 def self.suffixes @suffixes ||= ['', '.rb', *%w(DLEXT DLEXT2).map { |key| val = RbConfig::CONFIG[key] next unless val and not val.empty? ".#{val}" } ].compact.uniq end |
.time(msg, width = 0, display = Gem.configuration.verbose) ⇒ Object
Prints the amount of time the supplied block takes to run using the debug UI output.
904 905 906 907 908 909 910 911 912 913 914 |
# File 'lib/rubygems.rb', line 904 def self.time(msg, width = 0, display = Gem.configuration.verbose) now = Time.now value = yield elapsed = Time.now - now ui.say "%2$*1$s: %3$3.3fs" % [-width, msg, elapsed] if display value end |
.try_activate(path) ⇒ Object
Try to activate a gem containing path
. Returns true if activation succeeded or wasn’t needed because it was already activated. Returns false if it can’t find the path in a gem.
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 |
# File 'lib/rubygems.rb', line 180 def self.try_activate path # finds the _latest_ version... regardless of loaded specs and their deps # if another gem had a requirement that would mean we shouldn't # activate the latest version, then either it would already be activated # or if it was ambiguous (and thus unresolved) the code in our custom # require will try to activate the more specific version. spec = Gem::Specification.find_inactive_by_path path unless spec spec = Gem::Specification.find_by_path path return true if spec && spec.activated? return false end begin spec.activate rescue Gem::LoadError # this could fail due to gem dep collisions, go lax Gem::Specification.find_by_name(spec.name).activate end return true end |
.ui ⇒ Object
Lazily loads DefaultUserInteraction and returns the default UI.
919 920 921 922 923 |
# File 'lib/rubygems.rb', line 919 def self.ui require 'rubygems/user_interaction' Gem::DefaultUserInteraction.ui end |
.use_gemdeps(path = nil) ⇒ Object Also known as: detect_gemdeps
Looks for a gem dependency file at path
and activates the gems in the file if found. If the file is not found an ArgumentError is raised.
If path
is not given the RUBYGEMS_GEMDEPS environment variable is used, but if no file is found no exception is raised.
If ‘-’ is given for path
RubyGems searches up from the current working directory for gem dependency files (gem.deps.rb, Gemfile, Isolate) and activates the gems in the first one found.
You can run this automatically when rubygems starts. To enable, set the RUBYGEMS_GEMDEPS
environment variable to either the path of your gem dependencies file or “-” to auto-discover in parent directories.
NOTE: Enabling automatic discovery on multiuser systems can lead to execution of arbitrary code when used from directories outside your control.
1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 |
# File 'lib/rubygems.rb', line 1025 def self.use_gemdeps path = nil raise_exception = path path ||= ENV['RUBYGEMS_GEMDEPS'] return unless path path = path.dup if path == "-" then require 'rubygems/util' Gem::Util.traverse_parents Dir.pwd do |directory| dep_file = GEM_DEP_FILES.find { |f| File.file?(f) } next unless dep_file path = File.join directory, dep_file break end end path.untaint unless File.file? path then return unless raise_exception raise ArgumentError, "Unable to find gem dependencies file at #{path}" end rs = Gem::RequestSet.new rs.load_gemdeps path rs.resolve_current.map do |s| sp = s.full_spec sp.activate sp end rescue Gem::LoadError, Gem::UnsatisfiableDependencyError => e warn e. warn "You may need to `gem install -g` to install missing gems" warn "" end |
.use_paths(home, *paths) ⇒ Object
Use the home
and paths
values for Gem.dir and Gem.path. Used mainly by the unit tests to provide environment isolation.
929 930 931 932 933 |
# File 'lib/rubygems.rb', line 929 def self.use_paths(home, *paths) paths = nil if paths == [nil] paths = paths.first if Array === Array(paths).first self.paths = { "GEM_HOME" => home, "GEM_PATH" => paths } end |
.user_dir ⇒ Object
Path for gems in the user’s home directory
75 76 77 78 79 |
# File 'lib/rubygems/defaults.rb', line 75 def self.user_dir parts = [Gem.user_home, '.gem', ruby_engine] parts << RbConfig::CONFIG['ruby_version'] unless RbConfig::CONFIG['ruby_version'].empty? File.join parts end |
.user_home ⇒ Object
The home directory for the user.
938 939 940 |
# File 'lib/rubygems.rb', line 938 def self.user_home @user_home ||= find_home.untaint end |
.vendor_dir ⇒ Object
Directory where vendor gems are installed.
166 167 168 169 170 171 172 173 174 175 |
# File 'lib/rubygems/defaults.rb', line 166 def self.vendor_dir # :nodoc: if vendor_dir = ENV['GEM_VENDOR'] then return vendor_dir.dup end return nil unless RbConfig::CONFIG.key? 'vendordir' File.join RbConfig::CONFIG['vendordir'], 'gems', RbConfig::CONFIG['ruby_version'] end |
.win_platform=(val) ⇒ Object
Allows toggling Windows behavior. This method is available when requiring ‘rubygems/test_case’
58 59 60 |
# File 'lib/rubygems/test_case.rb', line 58 def self.win_platform=(val) @@win_platform = val end |
.win_platform? ⇒ Boolean
Is this a windows platform?
945 946 947 948 949 950 951 952 |
# File 'lib/rubygems.rb', line 945 def self.win_platform? if @@win_platform.nil? then ruby_platform = RbConfig::CONFIG['host_os'] @@win_platform = !!WIN_PATTERNS.find { |r| ruby_platform =~ r } end @@win_platform end |