Module: Gem
- Defined in:
- lib/rubygems.rb,
lib/rubygems.rb,
lib/rubygems/errors.rb,
lib/rubygems/openssl.rb,
lib/rubygems/defaults.rb,
lib/rubygems/deprecate.rb,
lib/rubygems/safe_yaml.rb,
lib/rubygems/util/list.rb,
lib/rubygems/psych_tree.rb,
lib/rubygems/ci_detector.rb,
lib/rubygems/safe_marshal.rb,
lib/rubygems/compatibility.rb,
lib/rubygems/yaml_serializer.rb,
lib/rubygems/safe_marshal/reader.rb,
lib/rubygems/specification_record.rb,
lib/rubygems/safe_marshal/elements.rb,
lib/rubygems/vendor/uri/lib/uri/common.rb
Overview
module Gem::URI
Defined Under Namespace
Modules: BundlerVersionFinder, CIDetector, Commands, DefaultUserInteraction, Deprecate, Ext, GemcutterUtilities, GemspecHelpers, InstallUpdateOptions, InstallerUninstallerUtils, LocalRemoteOptions, Molinillo, Net, QueryUtils, SafeMarshal, SafeYAML, SecureRandom, Security, SecurityOption, TSort, Text, Timeout, URI, UpdateSuggestion, UserInteraction, Util, VersionOption, YAMLSerializer Classes: AvailableSet, BasicSpecification, Command, CommandLineError, CommandManager, ConfigFile, ConflictError, ConsoleUI, Dependency, DependencyError, DependencyInstaller, DependencyList, DependencyRemovalException, DependencyResolutionError, Doctor, DocumentError, EndOfYAMLException, ErrorReason, Exception, FilePermissionError, FormatException, GemNotFoundException, GemNotInHomeException, GemRunner, ImpossibleDependenciesError, InstallError, Installer, InvalidSpecificationException, Licenses, List, LoadError, MissingSpecError, MissingSpecVersionError, NameTuple, NoAliasYAMLTree, OperationNotSupportedError, OptionParser, Package, PackageTask, PathSupport, Platform, PlatformMismatch, RemoteError, RemoteFetcher, RemoteInstallationCancelled, RemoteInstallationSkipped, RemoteSourceException, Request, RequestSet, Requirement, Resolv, Resolver, RubyVersionMismatch, RuntimeRequirementNotMetError, S3URISigner, SilentUI, Source, SourceFetchProblem, SourceList, SpecFetcher, SpecificGemNotFoundException, Specification, SpecificationPolicy, SpecificationRecord, StreamUI, StubSpecification, SystemExitException, TargetRbConfig, UninstallError, Uninstaller, UnknownCommandError, UnknownCommandSpellChecker, UnsatisfiableDependencyError, Uri, UriFormatter, Validator, VerificationError, Version, WebauthnVerificationError
Constant Summary collapse
- VERSION =
"3.6.7"
- RUBYGEMS_DIR =
__dir__
- 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 plugins specifications ].freeze
- REPOSITORY_DEFAULT_GEM_SUBDIRECTORIES =
Subdirectories in a gem repository for default gems
%w[ gems specifications/default ].freeze
- DEFAULT_SOURCE_DATE_EPOCH =
The default value for SOURCE_DATE_EPOCH if not specified. We want a date after 1980-01-01, to prevent issues with Zip files. This particular timestamp is for 1980-01-02 00:00:00 GMT.
315_619_200
- LOADED_SPECS_MUTEX =
Thread::Mutex.new
- MARSHAL_SPEC_DIR =
Location of Marshal quick gemspecs on remote repositories
"quick/Marshal.#{Gem.marshal_version}/".freeze
- HAVE_OPENSSL =
:nodoc:
defined? OpenSSL::SSL # :nodoc:
- DEFAULT_HOST =
"https://rubygems.org"
- RubyGemsVersion =
:stopdoc:
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
-
.disable_system_update_message ⇒ Object
RubyGems distributors (like operating system package managers) can disable RubyGems update by setting this to error message printed to end-users on gem update –system instead of actual update.
-
.discover_gems_on_require ⇒ Object
Whether RubyGems should enhance builtin ‘require` to automatically check whether the path required is present in installed gems, and automatically activate them and add them to `$LOAD_PATH`.
-
.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
. -
.activated_gem_paths ⇒ Object
The number of paths in the $LOAD_PATH from activated gems.
-
.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.
-
.cache_home ⇒ Object
The path to standard location of the user’s cache directory.
-
.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.
-
.config_home ⇒ Object
The path to standard location of the user’s configuration directory.
-
.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.
-
.data_home ⇒ Object
The path to standard location of the user’s data directory.
-
.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.
-
.default_user_install ⇒ Object
Enables automatic installation into user directory.
-
.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.
-
.dynamic_library_suffixes ⇒ Object
Suffixes for dynamic library require-able paths.
-
.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_config_file ⇒ Object
Finds the user’s config file.
-
.find_default_spec(path) ⇒ Object
Find a Gem::Specification of default gem from
path
. -
.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 an unresolved Gem::Specification of default gem from
path
. - .finish_resolve(request_set = Gem::RequestSet.new) ⇒ Object
-
.freebsd_platform? ⇒ Boolean
Is this platform FreeBSD.
-
.host ⇒ Object
Get the default RubyGems API host.
-
.host=(host) ⇒ Object
Set the default RubyGems API host.
-
.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 rubygems plugin files in the standard location and load them.
- .load_safe_marshal ⇒ Object
-
.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
-
.open_file(path, flags, &block) ⇒ Object
Open a file with given flags.
-
.open_file_with_flock(path, &block) ⇒ Object
Open a file with given flags, and protect access with flock.
-
.open_file_with_lock(path, &block) ⇒ Object
Open a file with given flags, and protect access with a file lock.
-
.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).
-
.plugin_suffix_pattern ⇒ Object
Glob pattern for require-able plugin suffixes.
-
.plugin_suffix_regexp ⇒ Object
Regexp for require-able plugin suffixes.
-
.plugindir(install_dir = Gem.dir) ⇒ Object
The path were rubygems plugins are to be installed.
-
.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_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.
- .set_target_rbconfig(rbconfig_path) ⇒ Object
-
.solaris_platform? ⇒ Boolean
Is this platform Solaris?.
-
.source_date_epoch ⇒ Object
Returns the value of Gem.source_date_epoch_string, as a Time object.
-
.source_date_epoch_string ⇒ Object
If the SOURCE_DATE_EPOCH environment variable is set, returns it’s value.
-
.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
-
.state_file ⇒ Object
The path to standard location of the user’s state file.
-
.state_home ⇒ Object
The path to standard location of the user’s state directory.
-
.suffix_pattern ⇒ Object
Glob pattern for require-able path suffixes.
-
.suffix_regexp ⇒ Object
Regexp for require-able path suffixes.
-
.suffixes ⇒ Object
Suffixes for require-able paths.
-
.target_rbconfig ⇒ Object
The RbConfig object for the deployment target platform.
-
.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.
-
.URI(uri) ⇒ Object
Returns a Gem::URI object derived from the given
uri
, which may be a Gem::URI string or an existing Gem::URI object:. -
.use_gemdeps(path = nil) ⇒ Object
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? ⇒ Boolean
Is this a windows platform?.
-
.write_binary(path, data) ⇒ Object
Safely write a file in binary mode on all platforms.
Class Attribute Details
.disable_system_update_message ⇒ Object
RubyGems distributors (like operating system package managers) can disable RubyGems update by setting this to error message printed to end-users on gem update –system instead of actual update.
1208 1209 1210 |
# File 'lib/rubygems.rb', line 1208 def @disable_system_update_message end |
.discover_gems_on_require ⇒ Object
Whether RubyGems should enhance builtin ‘require` to automatically check whether the path required is present in installed gems, and automatically activate them and add them to `$LOAD_PATH`.
1215 1216 1217 |
# File 'lib/rubygems.rb', line 1215 def discover_gems_on_require @discover_gems_on_require end |
.done_installing_hooks ⇒ Object (readonly)
The list of hooks to be run after Gem::DependencyInstaller installs a set of gems
1300 1301 1302 |
# File 'lib/rubygems.rb', line 1300 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.
1226 1227 1228 |
# File 'lib/rubygems.rb', line 1226 def gemdeps @gemdeps end |
.loaded_specs ⇒ Object (readonly)
Hash of loaded Gem::Specification keyed by name
1220 1221 1222 |
# File 'lib/rubygems.rb', line 1220 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
1288 1289 1290 |
# File 'lib/rubygems.rb', line 1288 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
1294 1295 1296 |
# File 'lib/rubygems.rb', line 1294 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.
1305 1306 1307 |
# File 'lib/rubygems.rb', line 1305 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
1311 1312 1313 |
# File 'lib/rubygems.rb', line 1311 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
1316 1317 1318 |
# File 'lib/rubygems.rb', line 1316 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.
1321 1322 1323 |
# File 'lib/rubygems.rb', line 1321 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
1327 1328 1329 |
# File 'lib/rubygems.rb', line 1327 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.
287 288 289 290 291 292 293 294 |
# File 'lib/rubygems.rb', line 287 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 |
.activated_gem_paths ⇒ Object
The number of paths in the $LOAD_PATH from activated gems. Used to prioritize -I
and ENV['RUBYLIB']
entries during require
.
599 600 601 |
# File 'lib/rubygems.rb', line 599 def self.activated_gem_paths @activated_gem_paths ||= 0 end |
.add_to_load_path(*paths) ⇒ Object
Add a list of paths to the $LOAD_PATH at the proper place.
606 607 608 609 610 611 |
# File 'lib/rubygems.rb', line 606 def self.add_to_load_path(*paths) @activated_gem_paths = activated_gem_paths + paths.size # gem directories must come after -I and ENV['RUBYLIB'] $LOAD_PATH.insert(Gem.load_path_insert_index, *paths) 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 |
# File 'lib/rubygems.rb', line 245 def self.bin_path(name, exec_name = nil, *requirements) 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.
299 300 301 |
# File 'lib/rubygems.rb', line 299 def self.binary_mode "rb" end |
.bindir(install_dir = Gem.dir) ⇒ Object
The path where gem executables are to be installed.
306 307 308 309 310 |
# File 'lib/rubygems.rb', line 306 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 |
.cache_home ⇒ Object
The path to standard location of the user’s cache directory.
147 148 149 |
# File 'lib/rubygems/defaults.rb', line 147 def self.cache_home @cache_home ||= ENV["XDG_CACHE_HOME"] || File.join(Gem.user_home, ".cache") end |
.clear_default_specs ⇒ Object
Clear default gem related variables. It is for test
1280 1281 1282 |
# File 'lib/rubygems.rb', line 1280 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.
324 325 326 327 328 329 |
# File 'lib/rubygems.rb', line 324 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.
133 134 135 |
# File 'lib/rubygems/defaults.rb', line 133 def self.config_file @config_file ||= find_config_file end |
.config_home ⇒ Object
The path to standard location of the user’s configuration directory.
114 115 116 |
# File 'lib/rubygems/defaults.rb', line 114 def self.config_home @config_home ||= ENV["XDG_CONFIG_HOME"] || File.join(Gem.user_home, ".config") end |
.configuration ⇒ Object
The standard configuration object for gems.
334 335 336 |
# File 'lib/rubygems.rb', line 334 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.
342 343 344 |
# File 'lib/rubygems.rb', line 342 def self.configuration=(config) @configuration = config end |
.data_home ⇒ Object
The path to standard location of the user’s data directory.
154 155 156 |
# File 'lib/rubygems/defaults.rb', line 154 def self.data_home @data_home ||= ENV["XDG_DATA_HOME"] || File.join(Gem.user_home, ".local", "share") end |
.default_bindir ⇒ Object
The default directory for binaries
204 205 206 |
# File 'lib/rubygems/defaults.rb', line 204 def self.default_bindir RbConfig::CONFIG["bindir"] end |
.default_cert_path ⇒ Object
The default signing certificate chain path
228 229 230 231 232 233 234 235 236 |
# File 'lib/rubygems/defaults.rb', line 228 def self.default_cert_path default_cert_path = File.join Gem.user_home, ".gem", "gem-public_cert.pem" unless File.exist?(default_cert_path) default_cert_path = File.join Gem.data_home, "gem", "gem-public_cert.pem" end default_cert_path end |
.default_dir ⇒ Object
Default home directory path to be used if an alternate value is not specified in the environment
37 38 39 |
# File 'lib/rubygems/defaults.rb', line 37 def self.default_dir @default_dir ||= File.join(RbConfig::CONFIG["rubylibprefix"], "gems", RbConfig::CONFIG["ruby_version"]) end |
.default_exec_format ⇒ Object
Deduce Ruby’s –program-prefix and –program-suffix from its install name
186 187 188 189 190 191 192 193 194 195 196 197 198 199 |
# File 'lib/rubygems/defaults.rb', line 186 def self.default_exec_format exec_format = begin RbConfig::CONFIG["ruby_install_name"].sub("ruby", "%s") rescue StandardError "%s" end unless exec_format.include?("%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
48 49 50 |
# File 'lib/rubygems/defaults.rb', line 48 def self.default_ext_dir_for(base_dir) nil end |
.default_key_path ⇒ Object
The default signing key path
215 216 217 218 219 220 221 222 223 |
# File 'lib/rubygems/defaults.rb', line 215 def self.default_key_path default_key_path = File.join Gem.user_home, ".gem", "gem-private_key.pem" unless File.exist?(default_key_path) default_key_path = File.join Gem.data_home, "gem", "gem-private_key.pem" end default_key_path end |
.default_path ⇒ Object
Default gem load path
175 176 177 178 179 180 181 |
# File 'lib/rubygems/defaults.rb', line 175 def self.default_path path = [] path << user_dir if user_home && File.exist?(user_home) path << default_dir path << vendor_dir if vendor_dir && File.directory?(vendor_dir) path end |
.default_rubygems_dirs ⇒ Object
Paths where RubyGems’ .rb files and bin files are installed
55 56 57 |
# File 'lib/rubygems/defaults.rb', line 55 def self.default_rubygems_dirs nil # default to standard layout end |
.default_sources ⇒ Object
An Array of the default sources that come with RubyGems
15 16 17 |
# File 'lib/rubygems/defaults.rb', line 15 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
23 24 25 26 27 28 29 30 31 |
# File 'lib/rubygems/defaults.rb', line 23 def self.default_spec_cache_dir default_spec_cache_dir = File.join Gem.user_home, ".gem", "specs" unless File.exist?(default_spec_cache_dir) default_spec_cache_dir = File.join Gem.cache_home, "gem", "specs" end default_spec_cache_dir end |
.default_specifications_dir ⇒ Object
Path to specification files of default gems.
62 63 64 |
# File 'lib/rubygems/defaults.rb', line 62 def self.default_specifications_dir @default_specifications_dir ||= File.join(Gem.default_dir, "specifications", "default") end |
.default_user_install ⇒ Object
Enables automatic installation into user directory
241 242 243 244 245 246 247 248 |
# File 'lib/rubygems/defaults.rb', line 241 def self.default_user_install # :nodoc: if !ENV.key?("GEM_HOME") && File.exist?(Gem.dir) && !File.writable?(Gem.dir) Gem.ui.say "Defaulting to user installation because default installation directory (#{Gem.dir}) is not writable." return true end false end |
.deflate(data) ⇒ Object
A Zlib::Deflate.deflate wrapper
349 350 351 352 |
# File 'lib/rubygems.rb', line 349 def self.deflate(data) require "zlib" Zlib::Deflate.deflate data end |
.dir ⇒ Object
The path where gems are to be installed.
397 398 399 |
# File 'lib/rubygems.rb', line 397 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
710 711 712 |
# File 'lib/rubygems.rb', line 710 def self.done_installing(&hook) @done_installing_hooks << hook end |
.dynamic_library_suffixes ⇒ Object
Suffixes for dynamic library require-able paths.
991 992 993 |
# File 'lib/rubygems.rb', line 991 def self.dynamic_library_suffixes @dynamic_library_suffixes ||= suffixes - [".rb"] 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.
448 449 450 |
# File 'lib/rubygems.rb', line 448 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.
435 436 437 |
# File 'lib/rubygems.rb', line 435 def self.ensure_gem_subdirectories(dir = Gem.dir, mode = nil) ensure_subdirectories(dir, mode, REPOSITORY_SUBDIRECTORIES) end |
.ensure_subdirectories(dir, mode, subdirs) ⇒ Object
:nodoc:
452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 |
# File 'lib/rubygems.rb', line 452 def self.ensure_subdirectories(dir, mode, subdirs) # :nodoc: old_umask = File.umask File.umask old_umask | 0o002 = {} [:mode] = mode if mode subdirs.each do |name| subdir = File.join dir, name next if File.exist? subdir require "fileutils" begin FileUtils.mkdir_p subdir, ** rescue SystemCallError end end ensure File.umask old_umask end |
.env_requirement(gem_name) ⇒ Object
859 860 861 862 863 864 865 |
# File 'lib/rubygems.rb', line 859 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" 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.
479 480 481 482 483 484 485 |
# File 'lib/rubygems.rb', line 479 def self.extension_api_version # :nodoc: if target_rbconfig["ENABLE_SHARED"] == "no" "#{ruby_api_version}-static" else ruby_api_version end end |
.find_config_file ⇒ Object
Finds the user’s config file
121 122 123 124 125 126 127 128 |
# File 'lib/rubygems/defaults.rb', line 121 def self.find_config_file gemrc = File.join Gem.user_home, ".gemrc" if File.exist? gemrc gemrc else File.join Gem.config_home, "gem", "gemrc" end end |
.find_default_spec(path) ⇒ Object
Find a Gem::Specification of default gem from path
1265 1266 1267 |
# File 'lib/rubygems.rb', line 1265 def find_default_spec(path) @path_to_default_spec_map[path] 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
499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 |
# File 'lib/rubygems.rb', line 499 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.flat_map {|spec| spec.matches_for_glob("#{glob}#{Gem.suffix_pattern}") } # $LOAD_PATH might contain duplicate entries or reference # the spec dirs directly, so we prune. files.uniq! if check_load_path files end |
.find_files_from_load_path(glob) ⇒ Object
:nodoc:
517 518 519 520 521 522 |
# File 'lib/rubygems.rb', line 517 def self.find_files_from_load_path(glob) # :nodoc: glob_with_suffixes = "#{glob}#{Gem.suffix_pattern}" $LOAD_PATH.flat_map do |load_path| Gem::Util.glob_files_in_dir(glob_with_suffixes, load_path) end.select {|file| File.file? file } 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.
536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 |
# File 'lib/rubygems.rb', line 536 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).flat_map {|spec| spec.matches_for_glob("#{glob}#{Gem.suffix_pattern}") } # $LOAD_PATH might contain duplicate entries or reference # the spec dirs directly, so we prune. files.uniq! if check_load_path files end |
.find_unresolved_default_spec(path) ⇒ Object
Find an unresolved Gem::Specification of default gem from path
1272 1273 1274 1275 |
# File 'lib/rubygems.rb', line 1272 def find_unresolved_default_spec(path) default_spec = @path_to_default_spec_map[path] 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 |
.freebsd_platform? ⇒ Boolean
Is this platform FreeBSD
1061 1062 1063 |
# File 'lib/rubygems.rb', line 1061 def self.freebsd_platform? RbConfig::CONFIG["host_os"].to_s.include?("bsd") end |
.host ⇒ Object
Get the default RubyGems API host. This is normally https://rubygems.org
.
571 572 573 |
# File 'lib/rubygems.rb', line 571 def self.host @host ||= Gem::DEFAULT_HOST end |
.host=(host) ⇒ Object
Set the default RubyGems API host.
577 578 579 |
# File 'lib/rubygems.rb', line 577 def self.host=(host) @host = host 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-5.14.0.gem (100%)
=> [#<Gem::Specification:0x1013b4528 @name="minitest", ...>]
560 561 562 563 564 565 |
# File 'lib/rubygems.rb', line 560 def self.install(name, version = Gem::Requirement.default, *) require_relative "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.
253 254 255 |
# File 'lib/rubygems/defaults.rb', line 253 def self.install_extension_in_lib # :nodoc: Gem.configuration.install_extension_in_lib end |
.java_platform? ⇒ Boolean
Is this a java platform?
1047 1048 1049 |
# File 'lib/rubygems.rb', line 1047 def self.java_platform? RUBY_PLATFORM == "java" end |
.latest_rubygems_version ⇒ Object
Returns the latest release version of RubyGems.
884 885 886 887 |
# File 'lib/rubygems.rb', line 884 def self.latest_rubygems_version latest_version_for("rubygems-update") || 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
.
871 872 873 874 875 876 877 878 879 |
# File 'lib/rubygems.rb', line 871 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.last spec end |
.latest_version_for(name) ⇒ Object
Returns the version of the latest release-version of gem name
892 893 894 |
# File 'lib/rubygems.rb', line 892 def self.latest_version_for(name) latest_spec_for(name)&.version end |
.load_env_plugins ⇒ Object
Find all ‘rubygems_plugin’ files in $LOAD_PATH and load them
1096 1097 1098 |
# File 'lib/rubygems.rb', line 1096 def self.load_env_plugins load_plugin_files find_files_from_load_path("rubygems_plugin") 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.
585 586 587 588 589 590 591 592 593 |
# File 'lib/rubygems.rb', line 585 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 || 0 end |
.load_plugin_files(plugins) ⇒ Object
Load plugins
as Ruby files
1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 |
# File 'lib/rubygems.rb', line 1068 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 /gemcutter-0\.[0-3]/.match?(plugin) begin load plugin rescue ScriptError, StandardError => e details = "#{plugin.inspect}: #{e.} (#{e.class})" warn "Error loading RubyGems plugin #{details}" end end end |
.load_plugins ⇒ Object
Find rubygems plugin files in the standard location and load them
1087 1088 1089 1090 1091 |
# File 'lib/rubygems.rb', line 1087 def self.load_plugins Gem.path.each do |gem_path| load_plugin_files Gem::Util.glob_files_in_dir("*#{Gem.plugin_suffix_pattern}", plugindir(gem_path)) end end |
.load_safe_marshal ⇒ Object
631 632 633 634 635 636 637 |
# File 'lib/rubygems.rb', line 631 def self.load_safe_marshal return if @safe_marshal_loaded require_relative "rubygems/safe_marshal" @safe_marshal_loaded = true end |
.load_yaml ⇒ Object
Loads YAML, preferring Psych
618 619 620 621 622 623 624 625 626 627 |
# File 'lib/rubygems.rb', line 618 def self.load_yaml return if @yaml_loaded require "psych" require_relative "rubygems/psych_tree" require_relative "rubygems/safe_yaml" @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)
653 654 655 656 657 658 659 |
# File 'lib/rubygems.rb', line 653 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.
664 665 666 |
# File 'lib/rubygems.rb', line 664 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 |
.open_file(path, flags, &block) ⇒ Object
Open a file with given flags
800 801 802 |
# File 'lib/rubygems.rb', line 800 def self.open_file(path, flags, &block) File.open(path, flags, &block) end |
.open_file_with_flock(path, &block) ⇒ Object
Open a file with given flags, and protect access with flock
818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 |
# File 'lib/rubygems.rb', line 818 def self.open_file_with_flock(path, &block) # read-write mode is used rather than read-only in order to support NFS mode = IO::RDWR | IO::APPEND | IO::CREAT | IO::BINARY mode |= IO::SHARE_DELETE if IO.const_defined?(:SHARE_DELETE) File.open(path, mode) do |io| begin # Try to get a lock without blocking. # If we do, the file is locked. # Otherwise, explain why we're waiting and get a lock, but block this time. if io.flock(File::LOCK_EX | File::LOCK_NB) != 0 warn "Waiting for another process to let go of lock: #{path}" io.flock(File::LOCK_EX) end io.puts(Process.pid) rescue Errno::ENOSYS, Errno::ENOTSUP end yield io end end |
.open_file_with_lock(path, &block) ⇒ Object
Open a file with given flags, and protect access with a file lock
807 808 809 810 811 812 813 |
# File 'lib/rubygems.rb', line 807 def self.open_file_with_lock(path, &block) file_lock = "#{path}.lock" open_file_with_flock(file_lock, &block) ensure require "fileutils" FileUtils.rm_f file_lock 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
286 287 288 |
# File 'lib/rubygems/defaults.rb', line 286 def self. {} end |
.path ⇒ Object
401 402 403 |
# File 'lib/rubygems.rb', line 401 def self.path paths.path end |
.path_separator ⇒ Object
How String Gem paths should be split. Overridable for esoteric platforms.
168 169 170 |
# File 'lib/rubygems/defaults.rb', line 168 def self.path_separator File::PATH_SEPARATOR end |
.paths ⇒ Object
Retrieve the PathSupport object that RubyGems uses to lookup files.
357 358 359 |
# File 'lib/rubygems.rb', line 357 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
.
367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 |
# File 'lib/rubygems.rb', line 367 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
305 306 307 |
# File 'lib/rubygems/defaults.rb', line 305 def self.platform_defaults {} end |
.platforms ⇒ Object
Array of platforms this RubyGems supports.
678 679 680 681 682 683 684 |
# File 'lib/rubygems.rb', line 678 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).
671 672 673 |
# File 'lib/rubygems.rb', line 671 def self.platforms=(platforms) @platforms = platforms end |
.plugin_suffix_pattern ⇒ Object
Glob pattern for require-able plugin suffixes.
964 965 966 |
# File 'lib/rubygems.rb', line 964 def self.plugin_suffix_pattern @plugin_suffix_pattern ||= "_plugin#{suffix_pattern}" end |
.plugin_suffix_regexp ⇒ Object
Regexp for require-able plugin suffixes.
971 972 973 |
# File 'lib/rubygems.rb', line 971 def self.plugin_suffix_regexp @plugin_suffix_regexp ||= /_plugin#{suffix_regexp}\z/ end |
.plugindir(install_dir = Gem.dir) ⇒ Object
The path were rubygems plugins are to be installed.
315 316 317 |
# File 'lib/rubygems.rb', line 315 def self.plugindir(install_dir=Gem.dir) File.join install_dir, "plugins" 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.
693 694 695 |
# File 'lib/rubygems.rb', line 693 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
701 702 703 |
# File 'lib/rubygems.rb', line 701 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.
718 719 720 |
# File 'lib/rubygems.rb', line 718 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
727 728 729 |
# File 'lib/rubygems.rb', line 727 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.
736 737 738 |
# File 'lib/rubygems.rb', line 736 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.
744 745 746 |
# File 'lib/rubygems.rb', line 744 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
753 754 755 |
# File 'lib/rubygems.rb', line 753 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.
762 763 764 765 766 767 768 769 770 |
# File 'lib/rubygems.rb', line 762 def self.prefix prefix = File.dirname RUBYGEMS_DIR if prefix != File.(RbConfig::CONFIG["sitelibdir"]) && prefix != File.(RbConfig::CONFIG["libdir"]) && File.basename(RUBYGEMS_DIR) == "lib" prefix end end |
.read_binary(path) ⇒ Object
Safely read a file in binary mode on all platforms.
782 783 784 |
# File 'lib/rubygems.rb', line 782 def self.read_binary(path) File.binread(path) end |
.refresh ⇒ Object
Refresh available gems from disk.
775 776 777 |
# File 'lib/rubygems.rb', line 775 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.
1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 |
# File 'lib/rubygems.rb', line 1240 def register_default_spec(spec) extended_require_paths = spec.require_paths.map {|f| f + "/" } new_format = extended_require_paths.any? {|path| spec.files.any? {|f| f.start_with? path } } if new_format prefix_group = extended_require_paths.join("|") prefix_pattern = /^(#{prefix_group})/ end spec.files.each do |file| if new_format file = file.sub(prefix_pattern, "") next unless $~ end spec.activate if already_loaded?(file) @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.
842 843 844 845 846 847 848 849 850 |
# File 'lib/rubygems.rb', line 842 def self.ruby if @ruby.nil? @ruby = RbConfig.ruby @ruby = "\"#{@ruby}\"" if /\s/.match?(@ruby) end @ruby end |
.ruby_api_version ⇒ Object
Returns a String containing the API compatibility version of Ruby
855 856 857 |
# File 'lib/rubygems.rb', line 855 def self.ruby_api_version @ruby_api_version ||= target_rbconfig["ruby_version"].dup end |
.ruby_engine ⇒ Object
208 209 210 |
# File 'lib/rubygems/defaults.rb', line 208 def self.ruby_engine RUBY_ENGINE end |
.ruby_version ⇒ Object
A Gem::Version for the currently running Ruby.
899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 |
# File 'lib/rubygems.rb', line 899 def self.ruby_version return @ruby_version if defined? @ruby_version version = RUBY_VERSION.dup if RUBY_PATCHLEVEL == -1 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
918 919 920 921 |
# File 'lib/rubygems.rb', line 918 def self.rubygems_version return @rubygems_version if defined? @rubygems_version @rubygems_version = Gem::Version.new Gem::VERSION end |
.set_target_rbconfig(rbconfig_path) ⇒ Object
419 420 421 422 423 424 |
# File 'lib/rubygems.rb', line 419 def self.set_target_rbconfig(rbconfig_path) @target_rbconfig = Gem::TargetRbConfig.from_path(rbconfig_path) Gem::Platform.local(refresh: true) Gem.platforms << Gem::Platform.local unless Gem.platforms.include? Gem::Platform.local @target_rbconfig end |
.solaris_platform? ⇒ Boolean
Is this platform Solaris?
1054 1055 1056 |
# File 'lib/rubygems.rb', line 1054 def self.solaris_platform? RUBY_PLATFORM.include?("solaris") end |
.source_date_epoch ⇒ Object
Returns the value of Gem.source_date_epoch_string, as a Time object.
This is used throughout RubyGems for enabling reproducible builds.
1195 1196 1197 |
# File 'lib/rubygems.rb', line 1195 def self.source_date_epoch Time.at(source_date_epoch_string.to_i).utc.freeze end |
.source_date_epoch_string ⇒ Object
If the SOURCE_DATE_EPOCH environment variable is set, returns it’s value. Otherwise, returns DEFAULT_SOURCE_DATE_EPOCH as a string.
NOTE(@duckinator): The implementation is a tad weird because we want to:
1. Make builds reproducible by default, by having this function always
return the same result during a given run.
2. Allow changing ENV['SOURCE_DATE_EPOCH'] at runtime, since multiple
tests that set this variable will be run in a single process.
If you simplify this function and a lot of tests fail, that is likely due to #2 above.
Details on SOURCE_DATE_EPOCH: reproducible-builds.org/specs/source-date-epoch/
1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 |
# File 'lib/rubygems.rb', line 1179 def self.source_date_epoch_string specified_epoch = ENV["SOURCE_DATE_EPOCH"] # If it's empty or just whitespace, treat it like it wasn't set at all. specified_epoch = nil if !specified_epoch.nil? && specified_epoch.strip.empty? epoch = specified_epoch || DEFAULT_SOURCE_DATE_EPOCH.to_s epoch.strip end |
.sources ⇒ Object
Returns an Array of sources to fetch remote gems from. Uses default_sources if the sources list is empty.
927 928 929 930 |
# File 'lib/rubygems.rb', line 927 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.
939 940 941 942 943 944 945 |
# File 'lib/rubygems.rb', line 939 def self.sources=(new_sources) if !new_sources @sources = nil else @sources = Gem::SourceList.from(new_sources) end end |
.spec_cache_dir ⇒ Object
405 406 407 |
# File 'lib/rubygems.rb', line 405 def self.spec_cache_dir paths.spec_cache_dir end |
.state_file ⇒ Object
The path to standard location of the user’s state file.
140 141 142 |
# File 'lib/rubygems/defaults.rb', line 140 def self.state_file @state_file ||= File.join(Gem.state_home, "gem", "last_update_check") end |
.state_home ⇒ Object
The path to standard location of the user’s state directory.
161 162 163 |
# File 'lib/rubygems/defaults.rb', line 161 def self.state_home @state_home ||= ENV["XDG_STATE_HOME"] || File.join(Gem.user_home, ".local", "state") end |
.suffix_pattern ⇒ Object
Glob pattern for require-able path suffixes.
950 951 952 |
# File 'lib/rubygems.rb', line 950 def self.suffix_pattern @suffix_pattern ||= "{#{suffixes.join(",")}}" end |
.suffix_regexp ⇒ Object
Regexp for require-able path suffixes.
957 958 959 |
# File 'lib/rubygems.rb', line 957 def self.suffix_regexp @suffix_regexp ||= /#{Regexp.union(suffixes)}\z/ end |
.suffixes ⇒ Object
Suffixes for require-able paths.
978 979 980 981 982 983 984 985 986 |
# File 'lib/rubygems.rb', line 978 def self.suffixes @suffixes ||= ["", ".rb", *%w[DLEXT DLEXT2].map do |key| val = RbConfig::CONFIG[key] next unless val && !val.empty? ".#{val}" end].compact.uniq end |
.target_rbconfig ⇒ Object
The RbConfig object for the deployment target platform.
This is usually the same as the running platform, but may be different if you are cross-compiling.
415 416 417 |
# File 'lib/rubygems.rb', line 415 def self.target_rbconfig @target_rbconfig || Gem::TargetRbConfig.for_running_ruby 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.
999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 |
# File 'lib/rubygems.rb', line 999 def self.time(msg, width = 0, display = Gem.configuration.verbose) now = Time.now value = yield elapsed = Time.now - now ui.say format("%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 true end |
.ui ⇒ Object
Lazily loads DefaultUserInteraction and returns the default UI.
1014 1015 1016 1017 1018 |
# File 'lib/rubygems.rb', line 1014 def self.ui require_relative "rubygems/user_interaction" Gem::DefaultUserInteraction.ui end |
.URI(uri) ⇒ Object
Returns a Gem::URI object derived from the given uri
, which may be a Gem::URI string or an existing Gem::URI object:
# Returns a new Gem::URI.
uri = Gem::URI('http://github.com/ruby/ruby')
# => #<Gem::URI::HTTP http://github.com/ruby/ruby>
# Returns the given Gem::URI.
Gem::URI(uri)
# => #<Gem::URI::HTTP http://github.com/ruby/ruby>
869 870 871 872 873 874 875 876 877 878 |
# File 'lib/rubygems/vendor/uri/lib/uri/common.rb', line 869 def URI(uri) if uri.is_a?(Gem::URI::Generic) uri elsif uri = String.try_convert(uri) Gem::URI.parse(uri) else raise ArgumentError, "bad argument (expected Gem::URI object or Gem::URI string)" end end |
.use_gemdeps(path = nil) ⇒ Object
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.
1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 |
# File 'lib/rubygems.rb', line 1120 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 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_relative "rubygems/user_interaction" require "bundler" begin Gem::DefaultUserInteraction.use_ui(ui) do Bundler.ui.silence do @gemdeps = Bundler.setup end ensure Gem::DefaultUserInteraction.ui.close end rescue Bundler::BundlerError => e warn e. warn "You may need to `bundle install` to install missing gems" warn "" 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.
1024 1025 1026 1027 1028 1029 1030 |
# File 'lib/rubygems.rb', line 1024 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
103 104 105 106 107 108 109 |
# File 'lib/rubygems/defaults.rb', line 103 def self.user_dir gem_dir = File.join(Gem.user_home, ".gem") gem_dir = File.join(Gem.data_home, "gem") unless File.exist?(gem_dir) parts = [gem_dir, 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.
96 97 98 |
# File 'lib/rubygems/defaults.rb', line 96 def self.user_home @user_home ||= find_home end |
.vendor_dir ⇒ Object
Directory where vendor gems are installed.
260 261 262 263 264 265 266 267 268 269 |
# File 'lib/rubygems/defaults.rb', line 260 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? ⇒ Boolean
Is this a windows platform?
1035 1036 1037 1038 1039 1040 1041 1042 |
# File 'lib/rubygems.rb', line 1035 def self.win_platform? if @@win_platform.nil? ruby_platform = RbConfig::CONFIG["host_os"] @@win_platform = !WIN_PATTERNS.find {|r| ruby_platform =~ r }.nil? end @@win_platform end |
.write_binary(path, data) ⇒ Object
Safely write a file in binary mode on all platforms.
789 790 791 792 793 794 795 |
# File 'lib/rubygems.rb', line 789 def self.write_binary(path, data) File.binwrite(path, data) rescue Errno::ENOSPC # If we ran out of space but the file exists, it's *guaranteed* to be corrupted. File.delete(path) if File.exist?(path) raise end |