Module: Gem
- Extended by:
- Deprecate
- Defined in:
- lib/rubygems.rb,
lib/rubygems.rb,
lib/rubygems/errors.rb,
lib/rubygems/defaults.rb,
lib/rubygems/safe_yaml.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
Overview
TODO remove at RubyGems 4
Defined Under Namespace
Modules: BundlerVersionFinder, Commands, DefaultUserInteraction, Deprecate, Ext, GemcutterUtilities, InstallUpdateOptions, LocalRemoteOptions, SafeYAML, Security, SecurityOption, Text, UriParsing, 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, Licenses, List, LoadError, MissingSpecError, MissingSpecVersionError, MockGemUi, NameTuple, NoAliasYAMLTree, OperationNotSupportedError, Package, PackageTask, PathSupport, Platform, PlatformMismatch, RemoteError, RemoteFetcher, RemoteInstallationCancelled, RemoteInstallationSkipped, RemoteSourceException, Request, RequestSet, Requirement, Resolver, RubyVersionMismatch, RuntimeRequirementNotMetError, S3URISigner, Server, SilentUI, Source, SourceFetchProblem, SourceList, SpecFetcher, SpecificGemNotFoundException, Specification, SpecificationPolicy, StreamUI, StubSpecification, SystemExitException, TestCase, UninstallError, Uninstaller, UnsatisfiableDependencyError, UriFormatter, UriParser, Validator, VerificationError, Version
Constant Summary collapse
- VERSION =
"3.1.2".freeze
- RUBYGEMS_DIR =
File.dirname File.(__FILE__)
- UNTAINT =
Taint support is deprecated in Ruby 2.7. This allows switching “.untaint” to “.tap(&Gem::UNTAINT)”, to avoid deprecation warnings in Ruby 2.7.
RUBY_VERSION < '2.7' ? :untaint.to_sym : proc{}
- WIN_PATTERNS =
An Array of Regexps that match windows Ruby platforms.
[ /bccwin/i, /cygwin/i, /djgpp/i, /mingw/i, /mswin/i, /wince/i, ].freeze
- GEM_DEP_FILES =
%w[ gem.deps.rb gems.rb Gemfile Isolate ].freeze
- REPOSITORY_SUBDIRECTORIES =
Subdirectories in a gem repository
%w[ build_info cache doc extensions gems specifications ].freeze
- REPOSITORY_DEFAULT_GEM_SUBDIRECTORIES =
Subdirectories in a gem repository for default gems
%w[ gems specifications/default ].freeze
- READ_BINARY_ERRORS =
Exception classes used in a Gem.read_binary
rescue
statement [Errno::EACCES, Errno::EROFS, Errno::ENOSYS, Errno::ENOTSUP].freeze
- WRITE_BINARY_ERRORS =
Exception classes used in Gem.write_binary
rescue
statement [Errno::ENOSYS, Errno::ENOTSUP].freeze
- LOADED_SPECS_MUTEX =
Mutex.new
- MARSHAL_SPEC_DIR =
Location of Marshal quick gemspecs on remote repositories
"quick/Marshal.#{Gem.marshal_version}/".freeze
- DEFAULT_HOST =
"https://rubygems.org".freeze
- SyckDefaultKey =
YAML::Syck::DefaultKey
- UnsatisfiableDepedencyError =
Backwards compatible typo’d exception class for early RubyGems 2.0.x
Gem::UnsatisfiableDependencyError
- RubyGemsVersion =
VERSION
- RbConfigPriorities =
%w[ MAJOR MINOR TEENY EXEEXT RUBY_SO_NAME arch bindir datadir libdir ruby_install_name ruby_version rubylibprefix sitedir sitelibdir vendordir vendorlibdir rubylibdir ].freeze
- ConfigMap =
Configuration settings from ::RbConfig
Hash.new do |cm, key| cm[key] = RbConfig::CONFIG[key.to_s] end
- @@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.
-
.gemdeps ⇒ Object
readonly
GemDependencyAPI object, which is set when .use_gemdeps is called.
-
.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
-
.activate_bin_path(name, exec_name = nil, *requirements) ⇒ Object
Find the full path to the executable for gem
name
. -
.add_to_load_path(*paths) ⇒ Object
Add a list of paths to the $LOAD_PATH at the proper place.
-
.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_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.
-
.default_specifications_dir ⇒ Object
Path to specification files of default gems.
-
.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:.
- .env_requirement(gem_name) ⇒ Object
-
.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.
-
.java_platform? ⇒ Boolean
Is this a java platform?.
-
.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(depth = 1) ⇒ 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
-
.operating_system_defaults ⇒ Object
Default options for gem commands for Ruby packagers.
- .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
. -
.platform_defaults ⇒ Object
Default options for gem commands for Ruby implementers.
-
.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.
-
.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
-
.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.
-
.source_date_epoch ⇒ Object
The SOURCE_DATE_EPOCH environment variable (or, if that’s not set, the current time), converted to Time object.
-
.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.
- .suffix_regexp ⇒ Object
-
.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?.
-
.write_binary(path, data) ⇒ Object
Safely write a file in binary mode on all platforms.
Methods included from Deprecate
deprecate, skip, skip=, skip_during
Class Attribute Details
.done_installing_hooks ⇒ Object (readonly)
The list of hooks to be run after Gem::DependencyInstaller installs a set of gems
1333 1334 1335 |
# File 'lib/rubygems.rb', line 1333 def done_installing_hooks @done_installing_hooks end |
.gemdeps ⇒ Object (readonly)
GemDependencyAPI object, which is set when .use_gemdeps is called. This contains all the information from the Gemfile.
1269 1270 1271 |
# File 'lib/rubygems.rb', line 1269 def gemdeps @gemdeps end |
.loaded_specs ⇒ Object (readonly)
Hash of loaded Gem::Specification keyed by name
1263 1264 1265 |
# File 'lib/rubygems.rb', line 1263 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
1321 1322 1323 |
# File 'lib/rubygems.rb', line 1321 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
1327 1328 1329 |
# File 'lib/rubygems.rb', line 1327 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.
1338 1339 1340 |
# File 'lib/rubygems.rb', line 1338 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
1344 1345 1346 |
# File 'lib/rubygems.rb', line 1344 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
1349 1350 1351 |
# File 'lib/rubygems.rb', line 1349 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.
1354 1355 1356 |
# File 'lib/rubygems.rb', line 1354 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
1360 1361 1362 |
# File 'lib/rubygems.rb', line 1360 def pre_uninstall_hooks @pre_uninstall_hooks end |
Class Method Details
.activate_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, an exception will be raised, otherwise the specified executable’s path is returned. requirements
allows you to specify specific gem versions.
A side effect of this method is that it will activate the gem that contains the executable.
This method should only be used in bin stub files.
293 294 295 296 297 298 299 300 |
# File 'lib/rubygems.rb', line 293 def self.activate_bin_path(name, exec_name = nil, *requirements) # :nodoc: spec = find_spec_for_exe name, exec_name, requirements Gem::LOADED_SPECS_MUTEX.synchronize do spec.activate finish_resolve end spec.bin_file exec_name end |
.add_to_load_path(*paths) ⇒ Object
Add a list of paths to the $LOAD_PATH at the proper place.
666 667 668 669 670 671 672 673 674 675 676 |
# File 'lib/rubygems.rb', line 666 def self.add_to_load_path(*paths) insert_index = load_path_insert_index if insert_index # gem directories must come after -I and ENV['RUBYLIB'] $LOAD_PATH.insert(insert_index, *paths) else # we are probably testing in core, -I and RUBYLIB don't apply $LOAD_PATH.unshift(*paths) end end |
.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, an exception will be raised, otherwise the specified executable’s path is returned. requirements
allows you to specify specific gem versions.
245 246 247 248 249 250 251 252 253 |
# File 'lib/rubygems.rb', line 245 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 requirements = Gem::Requirement.default if requirements.empty? find_spec_for_exe(name, exec_name, requirements).bin_file exec_name end |
.binary_mode ⇒ Object
The mode needed to read a file as straight binary.
305 306 307 |
# File 'lib/rubygems.rb', line 305 def self.binary_mode 'rb' end |
.bindir(install_dir = Gem.dir) ⇒ Object
The path where gem executables are to be installed.
312 313 314 315 316 |
# File 'lib/rubygems.rb', line 312 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
1313 1314 1315 |
# File 'lib/rubygems.rb', line 1313 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.
323 324 325 326 327 328 |
# File 'lib/rubygems.rb', line 323 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.
333 334 335 |
# File 'lib/rubygems.rb', line 333 def self.config_file @config_file ||= File.join Gem.user_home, '.gemrc' end |
.configuration ⇒ Object
The standard configuration object for gems.
340 341 342 |
# File 'lib/rubygems.rb', line 340 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.
348 349 350 |
# File 'lib/rubygems.rb', line 348 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.
356 357 358 359 360 |
# File 'lib/rubygems.rb', line 356 def self.datadir(gem_name) spec = @loaded_specs[gem_name] return nil if spec.nil? spec.datadir end |
.default_bindir ⇒ Object
The default directory for binaries
117 118 119 120 121 122 123 |
# File 'lib/rubygems/defaults.rb', line 117 def self.default_bindir if defined? RUBY_FRAMEWORK_VERSION # mac framework support '/usr/bin' else # generic install RbConfig::CONFIG['bindir'] end end |
.default_cert_path ⇒ Object
The default signing certificate chain path
139 140 141 |
# File 'lib/rubygems/defaults.rb', line 139 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
30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 |
# File 'lib/rubygems/defaults.rb', line 30 def self.default_dir path = if defined? RUBY_FRAMEWORK_VERSION [ File.dirname(RbConfig::CONFIG['sitedir']), 'Gems', RbConfig::CONFIG['ruby_version'] ] else [ RbConfig::CONFIG['rubylibprefix'], '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
103 104 105 106 107 108 109 110 111 112 |
# File 'lib/rubygems/defaults.rb', line 103 def self.default_exec_format exec_format = RbConfig::CONFIG['ruby_install_name'].sub('ruby', '%s') rescue '%s' unless exec_format =~ /%s/ 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
55 56 57 |
# File 'lib/rubygems/defaults.rb', line 55 def self.default_ext_dir_for(base_dir) nil end |
.default_key_path ⇒ Object
The default signing key path
132 133 134 |
# File 'lib/rubygems/defaults.rb', line 132 def self.default_key_path File.join Gem.user_home, ".gem", "gem-private_key.pem" end |
.default_path ⇒ Object
Default gem load path
92 93 94 95 96 97 98 |
# File 'lib/rubygems/defaults.rb', line 92 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
62 63 64 |
# File 'lib/rubygems/defaults.rb', line 62 def self.default_rubygems_dirs nil # default to standard layout end |
.default_sources ⇒ Object
An Array of the default sources that come with RubyGems
14 15 16 |
# File 'lib/rubygems/defaults.rb', line 14 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
22 23 24 |
# File 'lib/rubygems/defaults.rb', line 22 def self.default_spec_cache_dir File.join Gem.user_home, '.gem', 'specs' end |
.default_specifications_dir ⇒ Object
Path to specification files of default gems.
69 70 71 |
# File 'lib/rubygems/defaults.rb', line 69 def self.default_specifications_dir File.join(Gem.default_dir, "specifications", "default") end |
.deflate(data) ⇒ Object
A Zlib::Deflate.deflate wrapper
365 366 367 368 |
# File 'lib/rubygems.rb', line 365 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
415 416 417 |
# File 'lib/rubygems.rb', line 415 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
791 792 793 |
# File 'lib/rubygems.rb', line 791 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.
449 450 451 |
# File 'lib/rubygems.rb', line 449 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.
436 437 438 |
# File 'lib/rubygems.rb', line 436 def self.ensure_gem_subdirectories(dir = Gem.dir, mode = nil) ensure_subdirectories(dir, mode, REPOSITORY_SUBDIRECTORIES) end |
.ensure_subdirectories(dir, mode, subdirs) ⇒ Object
:nodoc:
453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 |
# File 'lib/rubygems.rb', line 453 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 |
.env_requirement(gem_name) ⇒ Object
923 924 925 926 927 928 929 |
# File 'lib/rubygems.rb', line 923 def self.env_requirement(gem_name) @env_requirements_by_name ||= {} @env_requirements_by_name[gem_name] ||= begin req = ENV["GEM_REQUIREMENT_#{gem_name.upcase}"] || '>= 0'.freeze Gem::Requirement.create(req) end 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.
476 477 478 479 480 481 482 |
# File 'lib/rubygems.rb', line 476 def self.extension_api_version # :nodoc: if 'no' == RbConfig::CONFIG['ENABLE_SHARED'] "#{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
496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 |
# File 'lib/rubygems.rb', line 496 def self.find_files(glob, check_load_path=true) files = [] files = find_files_from_load_path glob if check_load_path gem_specifications = @gemdeps ? Gem.loaded_specs.values : Gem::Specification.stubs files.concat gem_specifications.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:
514 515 516 517 518 519 |
# File 'lib/rubygems.rb', line 514 def self.find_files_from_load_path(glob) # :nodoc: glob_with_suffixes = "#{glob}#{Gem.suffix_pattern}" $LOAD_PATH.map do |load_path| Gem::Util.glob_files_in_dir(glob_with_suffixes, load_path) end.flatten.select { |file| File.file? file.tap(&Gem::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.
533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 |
# File 'lib/rubygems.rb', line 533 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
1305 1306 1307 1308 |
# File 'lib/rubygems.rb', line 1305 def find_unresolved_default_spec(path) default_spec = @path_to_default_spec_map[path] return default_spec if default_spec && loaded_specs[default_spec.name] != default_spec end |
.finish_resolve(request_set = Gem::RequestSet.new) ⇒ Object
230 231 232 233 234 235 236 237 |
# File 'lib/rubygems.rb', line 230 def self.finish_resolve(request_set=Gem::RequestSet.new) request_set.import Gem::Specification.unresolved_deps.values request_set.import Gem.loaded_specs.values.map {|s| Gem::Dependency.new(s.name, s.version) } request_set.resolve_current.each do |s| s.full_spec.activate end end |
.gunzip(data) ⇒ Object
Zlib::GzipReader wrapper that unzips data
.
581 582 583 |
# File 'lib/rubygems.rb', line 581 def self.gunzip(data) Gem::Util.gunzip data end |
.gzip(data) ⇒ Object
Zlib::GzipWriter wrapper that zips data
.
595 596 597 |
# File 'lib/rubygems.rb', line 595 def self.gzip(data) Gem::Util.gzip data end |
.host ⇒ Object
Get the default RubyGems API host. This is normally https://rubygems.org
.
639 640 641 |
# File 'lib/rubygems.rb', line 639 def self.host @host ||= Gem::DEFAULT_HOST end |
.host=(host) ⇒ Object
Set the default RubyGems API host.
645 646 647 |
# File 'lib/rubygems.rb', line 645 def self.host=(host) @host = host end |
.inflate(data) ⇒ Object
A Zlib::Inflate#inflate wrapper
609 610 611 |
# File 'lib/rubygems.rb', line 609 def self.inflate(data) 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", ...>]
628 629 630 631 632 633 |
# File 'lib/rubygems.rb', line 628 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.
146 147 148 |
# File 'lib/rubygems/defaults.rb', line 146 def self.install_extension_in_lib # :nodoc: true end |
.java_platform? ⇒ Boolean
Is this a java platform?
1098 1099 1100 |
# File 'lib/rubygems.rb', line 1098 def self.java_platform? RUBY_PLATFORM == "java" end |
.latest_rubygems_version ⇒ Object
Returns the latest release version of RubyGems.
948 949 950 951 |
# File 'lib/rubygems.rb', line 948 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
.
935 936 937 938 939 940 941 942 943 |
# File 'lib/rubygems.rb', line 935 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
956 957 958 959 |
# File 'lib/rubygems.rb', line 956 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
1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 |
# File 'lib/rubygems.rb', line 1138 def self.load_env_plugins path = "rubygems_plugin" files = [] glob = "#{path}#{Gem.suffix_pattern}" $LOAD_PATH.each do |load_path| globbed = Gem::Util.glob_files_in_dir(glob, load_path) globbed.each do |load_path_file| files << load_path_file if File.file?(load_path_file.tap(&Gem::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.
653 654 655 656 657 658 659 660 661 |
# File 'lib/rubygems.rb', line 653 def self.load_path_insert_index $LOAD_PATH.each_with_index do |path, i| return i if path.instance_variable_defined?(:@gem_prelude_index) end index = $LOAD_PATH.index RbConfig::CONFIG['sitelibdir'] index end |
.load_plugin_files(plugins) ⇒ Object
Load plugins
as Ruby files
1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 |
# File 'lib/rubygems.rb', line 1105 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
1126 1127 1128 1129 1130 1131 1132 1133 |
# File 'lib/rubygems.rb', line 1126 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
683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 |
# File 'lib/rubygems.rb', line 683 def self.load_yaml return if @yaml_loaded return unless defined?(gem) begin gem 'psych', '>= 2.0.0' 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 require 'yaml' require 'rubygems/safe_yaml' # 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(depth = 1) ⇒ Object
The file name and line number of the caller of the caller of this method.
depth
is how many layers up the call stack it should go.
e.g.,
def a; Gem.location_of_caller; end a #=> [“x.rb”, 2] # (it’ll vary depending on file name and line number)
def b; c; end def c; Gem.location_of_caller(2); end b #=> [“x.rb”, 6] # (it’ll vary depending on file name and line number)
734 735 736 737 738 739 740 |
# File 'lib/rubygems.rb', line 734 def self.location_of_caller(depth = 1) caller[depth] =~ /(.*?):(\d+).*?$/i file = $1 lineno = $2.to_i [file, lineno] end |
.marshal_version ⇒ Object
The version of the Marshal format for your Ruby.
745 746 747 |
# File 'lib/rubygems.rb', line 745 def self.marshal_version "#{Marshal::MAJOR_VERSION}.#{Marshal::MINOR_VERSION}" end |
.needs {|rs| ... } ⇒ Object
222 223 224 225 226 227 228 |
# File 'lib/rubygems.rb', line 222 def self.needs rs = Gem::RequestSet.new yield rs finish_resolve rs end |
.operating_system_defaults ⇒ Object
Default options for gem commands for Ruby packagers.
The options here should be structured as an array of string “gem” command names as keys and a string of the default options as values.
Example:
def self.operating_system_defaults
{
'install' => '--no-rdoc --no-ri --env-shebang',
'update' => '--no-rdoc --no-ri --env-shebang'
}
end
179 180 181 |
# File 'lib/rubygems/defaults.rb', line 179 def self. {} end |
.path ⇒ Object
419 420 421 |
# File 'lib/rubygems.rb', line 419 def self.path paths.path end |
.path_separator ⇒ Object
How String Gem paths should be split. Overridable for esoteric platforms.
85 86 87 |
# File 'lib/rubygems/defaults.rb', line 85 def self.path_separator File::PATH_SEPARATOR end |
.paths ⇒ Object
Retrieve the PathSupport object that RubyGems uses to lookup files.
373 374 375 |
# File 'lib/rubygems.rb', line 373 def self.paths @paths ||= Gem::PathSupport.new(ENV) 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’ Keys for the env
hash should be Strings, and values of the hash should be Strings or nil
.
383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 |
# File 'lib/rubygems.rb', line 383 def self.paths=(env) clear_paths target = {} env.each_pair do |k,v| case k when 'GEM_HOME', 'GEM_PATH', 'GEM_SPEC_CACHE' case v when nil, String target[k] = v when Array unless Gem::Deprecate.skip warn <<-eowarn Array values in the parameter to `Gem.paths=` are deprecated. Please use a String or nil. An Array (#{env.inspect}) was passed in from #{caller[3]} eowarn end target[k] = v.join File::PATH_SEPARATOR end else target[k] = v end end @paths = Gem::PathSupport.new ENV.to_hash.merge(target) Gem::Specification.dirs = @paths.path end |
.platform_defaults ⇒ Object
Default options for gem commands for Ruby implementers.
The options here should be structured as an array of string “gem” command names as keys and a string of the default options as values.
Example:
def self.platform_defaults
{
'install' => '--no-rdoc --no-ri --env-shebang',
'update' => '--no-rdoc --no-ri --env-shebang'
}
end
198 199 200 |
# File 'lib/rubygems/defaults.rb', line 198 def self.platform_defaults {} end |
.platforms ⇒ Object
Array of platforms this RubyGems supports.
759 760 761 762 763 764 765 |
# File 'lib/rubygems.rb', line 759 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).
752 753 754 |
# File 'lib/rubygems.rb', line 752 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.
774 775 776 |
# File 'lib/rubygems.rb', line 774 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
782 783 784 |
# File 'lib/rubygems.rb', line 782 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.
799 800 801 |
# File 'lib/rubygems.rb', line 799 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
808 809 810 |
# File 'lib/rubygems.rb', line 808 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.
817 818 819 |
# File 'lib/rubygems.rb', line 817 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.
825 826 827 |
# File 'lib/rubygems.rb', line 825 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
834 835 836 |
# File 'lib/rubygems.rb', line 834 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.
843 844 845 846 847 848 849 850 851 |
# File 'lib/rubygems.rb', line 843 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) prefix end end |
.read_binary(path) ⇒ Object
Safely read a file in binary mode on all platforms.
863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 |
# File 'lib/rubygems.rb', line 863 def self.read_binary(path) File.open path, 'rb+' do |f| f.flock(File::LOCK_EX) f.read end rescue *READ_BINARY_ERRORS File.open path, 'rb' do |f| f.read end rescue Errno::ENOLCK # NFS if Thread.main != Thread.current raise else File.open path, 'rb' do |f| f.read end end end |
.refresh ⇒ Object
Refresh available gems from disk.
856 857 858 |
# File 'lib/rubygems.rb', line 856 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.
1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 |
# File 'lib/rubygems.rb', line 1283 def register_default_spec(spec) new_format = 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 @path_to_default_spec_map[file.sub(suffix_regexp, "")] = spec end end |
.ruby ⇒ Object
The path to the running Ruby interpreter.
905 906 907 908 909 910 911 912 913 914 |
# File 'lib/rubygems.rb', line 905 def self.ruby if @ruby.nil? @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’
68 69 70 |
# File 'lib/rubygems/test_case.rb', line 68 def self.ruby=(ruby) @ruby = ruby end |
.ruby_api_version ⇒ Object
Returns a String containing the API compatibility version of Ruby
919 920 921 |
# File 'lib/rubygems.rb', line 919 def self.ruby_api_version @ruby_api_version ||= RbConfig::CONFIG['ruby_version'].dup end |
.ruby_engine ⇒ Object
125 126 127 |
# File 'lib/rubygems/defaults.rb', line 125 def self.ruby_engine RUBY_ENGINE end |
.ruby_version ⇒ Object
A Gem::Version for the currently running Ruby.
964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 |
# File 'lib/rubygems.rb', line 964 def self.ruby_version return @ruby_version if defined? @ruby_version version = RUBY_VERSION.dup if defined?(RUBY_PATCHLEVEL) && RUBY_PATCHLEVEL != -1 version << ".#{RUBY_PATCHLEVEL}" elsif defined?(RUBY_DESCRIPTION) if RUBY_ENGINE == "ruby" desc = RUBY_DESCRIPTION[/\Aruby #{Regexp.quote(RUBY_VERSION)}([^ ]+) /, 1] else desc = RUBY_DESCRIPTION[/\A#{RUBY_ENGINE} #{Regexp.quote(RUBY_ENGINE_VERSION)} \(#{RUBY_VERSION}([^ ]+)\) /, 1] end version << ".#{desc}" if desc end @ruby_version = Gem::Version.new version end |
.rubygems_version ⇒ Object
A Gem::Version for the currently running RubyGems
985 986 987 988 |
# File 'lib/rubygems.rb', line 985 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’
52 53 54 |
# File 'lib/rubygems/test_case.rb', line 52 def self.searcher=(searcher) @searcher = searcher end |
.source_date_epoch ⇒ Object
The SOURCE_DATE_EPOCH environment variable (or, if that’s not set, the current time), converted to Time object. This is used throughout RubyGems for enabling reproducible builds.
If it is not set as an environment variable already, this also sets it.
Details on SOURCE_DATE_EPOCH: reproducible-builds.org/specs/source-date-epoch/
1247 1248 1249 1250 1251 1252 1253 |
# File 'lib/rubygems.rb', line 1247 def self.source_date_epoch if ENV["SOURCE_DATE_EPOCH"].nil? || ENV["SOURCE_DATE_EPOCH"].empty? ENV["SOURCE_DATE_EPOCH"] = Time.now.to_i.to_s end Time.at(ENV["SOURCE_DATE_EPOCH"].to_i).utc.freeze end |
.sources ⇒ Object
Returns an Array of sources to fetch remote gems from. Uses default_sources if the sources list is empty.
994 995 996 997 |
# File 'lib/rubygems.rb', line 994 def self.sources source_list = configuration.sources || default_sources @sources ||= Gem::SourceList.from(source_list) 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.
1006 1007 1008 1009 1010 1011 1012 |
# File 'lib/rubygems.rb', line 1006 def self.sources=(new_sources) if !new_sources @sources = nil else @sources = Gem::SourceList.from(new_sources) end end |
.spec_cache_dir ⇒ Object
423 424 425 |
# File 'lib/rubygems.rb', line 423 def self.spec_cache_dir paths.spec_cache_dir end |
.suffix_pattern ⇒ Object
Glob pattern for require-able path suffixes.
1017 1018 1019 |
# File 'lib/rubygems.rb', line 1017 def self.suffix_pattern @suffix_pattern ||= "{#{suffixes.join(',')}}" end |
.suffix_regexp ⇒ Object
1021 1022 1023 |
# File 'lib/rubygems.rb', line 1021 def self.suffix_regexp @suffix_regexp ||= /#{Regexp.union(suffixes)}\z/ end |
.suffixes ⇒ Object
Suffixes for require-able paths.
1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 |
# File 'lib/rubygems.rb', line 1028 def self.suffixes @suffixes ||= ['', '.rb', *%w(DLEXT DLEXT2).map do |key| val = RbConfig::CONFIG[key] next unless val and not val.empty? ".#{val}" end ].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.
1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 |
# File 'lib/rubygems.rb', line 1043 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.
197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 |
# File 'lib/rubygems.rb', line 197 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_by_path path return false unless spec return true if spec.activated? begin spec.activate rescue Gem::LoadError => e # this could fail due to gem dep collisions, go lax spec_by_name = Gem::Specification.find_by_name(spec.name) if spec_by_name.nil? raise e else spec_by_name.activate end end return true end |
.ui ⇒ Object
Lazily loads DefaultUserInteraction and returns the default UI.
1058 1059 1060 1061 1062 |
# File 'lib/rubygems.rb', line 1058 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.
1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 |
# File 'lib/rubygems.rb', line 1174 def self.use_gemdeps(path = nil) raise_exception = path path ||= ENV['RUBYGEMS_GEMDEPS'] return unless path path = path.dup if path == "-" 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.tap(&Gem::UNTAINT) unless File.file? path return unless raise_exception raise ArgumentError, "Unable to find gem dependencies file at #{path}" end ENV["BUNDLE_GEMFILE"] ||= File.(path) require 'rubygems/user_interaction' Gem::DefaultUserInteraction.use_ui(ui) do require "bundler" begin Bundler.ui.silence do @gemdeps = Bundler.setup end ensure Gem::DefaultUserInteraction.ui.close end @gemdeps.requested_specs.map(&:to_spec).sort_by(&:name) end rescue => e case e when Gem::LoadError, Gem::UnsatisfiableDependencyError, (defined?(Bundler::GemNotFound) ? Bundler::GemNotFound : Gem::LoadError) warn e. warn "You may need to `gem install -g` to install missing gems" warn "" else raise end 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.
1068 1069 1070 1071 1072 1073 1074 |
# File 'lib/rubygems.rb', line 1068 def self.use_paths(home, *paths) paths.flatten! paths.compact! hash = { "GEM_HOME" => home, "GEM_PATH" => paths.empty? ? home : paths.join(File::PATH_SEPARATOR) } hash.delete_if { |_, v| v.nil? } self.paths = hash end |
.user_dir ⇒ Object
Path for gems in the user’s home directory
76 77 78 79 80 |
# File 'lib/rubygems/defaults.rb', line 76 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.
1079 1080 1081 |
# File 'lib/rubygems.rb', line 1079 def self.user_home @user_home ||= find_home.tap(&Gem::UNTAINT) end |
.vendor_dir ⇒ Object
Directory where vendor gems are installed.
153 154 155 156 157 158 159 160 161 162 |
# File 'lib/rubygems/defaults.rb', line 153 def self.vendor_dir # :nodoc: if vendor_dir = ENV['GEM_VENDOR'] 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’
60 61 62 |
# File 'lib/rubygems/test_case.rb', line 60 def self.win_platform=(val) @@win_platform = val end |
.win_platform? ⇒ Boolean
Is this a windows platform?
1086 1087 1088 1089 1090 1091 1092 1093 |
# File 'lib/rubygems.rb', line 1086 def self.win_platform? if @@win_platform.nil? ruby_platform = RbConfig::CONFIG['host_os'] @@win_platform = !!WIN_PATTERNS.find { |r| ruby_platform =~ r } end @@win_platform end |
.write_binary(path, data) ⇒ Object
Safely write a file in binary mode on all platforms.
884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 |
# File 'lib/rubygems.rb', line 884 def self.write_binary(path, data) open(path, 'wb') do |io| begin io.flock(File::LOCK_EX) rescue *WRITE_BINARY_ERRORS end io.write data end rescue Errno::ENOLCK # NFS if Thread.main != Thread.current raise else open(path, 'wb') do |io| io.write data end end end |