Class: Bundler::RubygemsIntegration
Relationships & Source Files | |
Inherits: | Object |
Defined in: | lib/bundler/rubygems_integration.rb |
Constant Summary
-
EXT_LOCK =
# File 'lib/bundler/rubygems_integration.rb', line 8Monitor.new
Class Method Summary
Instance Attribute Summary
- #build_args rw
- #build_args=(args) rw
- #plain_specs rw
- #plain_specs=(specs) rw
- #sources rw
- #sources=(val) rw
- #ui=(obj) writeonly
Instance Method Summary
-
#add_default_gems_to(specs)
Add default gems not already present in specs, and return them as a hash.
- #add_to_load_path(paths)
- #all_specs
- #backport_ext_builder_monitor
- #bin_path(gem, bin, ver)
- #build(spec, skip_validation = false)
- #build_gem(gem_dir, spec)
- #clear_paths
- #configuration
- #correct_for_windows_path(path)
-
#default_stubs
See additional method definition at line 612.
- #download_gem(spec, uri, cache_dir)
- #ext_lock
- #fetch_all_remote_specs(remote)
- #fetch_specs(remote, name)
- #find_name(name)
- #gem_bindir
- #gem_cache
- #gem_dir
- #gem_from_path(path, policy = nil)
- #gem_path
- #gem_remote_fetcher
- #inflate(obj)
- #install_with_build_args(args)
- #load_env_plugins
- #load_plugin_files(files)
- #load_plugins
- #loaded_gem_paths
- #loaded_specs(name)
- #mark_loaded(spec)
- #marshal_spec_dir
- #method_visibility(klass, method)
- #path(obj)
- #path_separator
- #post_reset_hooks
- #provides?(req_str) ⇒ Boolean
- #read_binary(path)
- #redefine_method(klass, method, unbound_method = nil, &block)
-
#replace_bin_path(specs_by_name)
Used to make bin stubs that are not created by bundler work under bundler.
-
#replace_entrypoints(specs)
Replace or hook into RubyGems to provide a bundlerized view of the world.
- #replace_gem(specs, specs_by_name)
- #repository_subdirectories
- #reset
- #reverse_rubygems_kernel_mixin
- #ruby_engine
- #security_policies
- #security_policy_keys
- #set_installed_by_version(spec, installed_by_version = Gem::VERSION)
- #spec_cache_dirs
- #spec_from_gem(path, policy = nil)
- #spec_matches_for_glob(spec, glob)
- #spec_missing_extensions?(spec, default = true) ⇒ Boolean
- #stub_rubygems(specs)
- #stub_set_spec(stub, spec)
- #suffix_pattern
- #undo_replacements
- #use_gemdeps(gemfile)
- #user_home
- #validate(spec)
- #version
- #with_build_args(args)
Constructor Details
.new ⇒ RubygemsIntegration
# File 'lib/bundler/rubygems_integration.rb', line 23
def initialize @replaced_methods = {} backport_ext_builder_monitor end
Class Method Details
.provides?(req_str) ⇒ Boolean
# File 'lib/bundler/rubygems_integration.rb', line 19
def self.provides?(req_str) Gem::Requirement.new(req_str).satisfied_by?(version) end
.version
[ GitHub ]Instance Attribute Details
#build_args (rw)
[ GitHub ]#build_args=(args) (rw)
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 41
def build_args=(args) require "rubygems/command" Gem::Command.build_args = args end
#plain_specs (rw)
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 494
def plain_specs Gem::Specification._all end
#plain_specs=(specs) (rw)
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 498
def plain_specs=(specs) Gem::Specification.all = specs end
#sources (rw)
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 154
def sources Gem.sources end
#sources=(val) (rw)
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 145
def sources=(val) # Gem.configuration creates a new Gem::ConfigFile, which by default will read ~/.gemrc # If that file exists, its settings (including sources) will overwrite the values we # are about to set here. In order to avoid that, we force memoizing the config file now. configuration Gem.sources = val end
#ui=(obj) (writeonly)
[ GitHub ]Instance Method Details
#add_default_gems_to(specs)
Add default gems not already present in specs, and return them as a hash.
# File 'lib/bundler/rubygems_integration.rb', line 421
def add_default_gems_to(specs) specs_by_name = specs.reduce({}) do |h, s| h[s.name] = s h end Bundler.rubygems.default_stubs.each do |stub| default_spec = stub.to_spec default_spec_name = default_spec.name next if specs_by_name.key?(default_spec_name) specs << default_spec specs_by_name[default_spec_name] = default_spec end specs_by_name end
#add_to_load_path(paths)
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 50
def add_to_load_path(paths) return Gem.add_to_load_path(*paths) if Gem.respond_to?(:add_to_load_path) if insert_index = Gem.load_path_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
#all_specs
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 582
def all_specs Gem::Specification.stubs.map do |stub| StubSpecification.from_stub(stub) end end
#backport_ext_builder_monitor
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 588
def backport_ext_builder_monitor # So we can avoid requiring "rubygems/ext" in its entirety Gem.module_eval <<-RUBY, __FILE__, __LINE__ + 1 module Ext end RUBY require "rubygems/ext/builder" Gem::Ext::Builder.class_eval do unless const_defined?(:CHDIR_MONITOR) const_set(:CHDIR_MONITOR, EXT_LOCK) end remove_const(:CHDIR_MUTEX) if const_defined?(:CHDIR_MUTEX) const_set(:CHDIR_MUTEX, const_get(:CHDIR_MONITOR)) end end
#bin_path(gem, bin, ver)
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 206
def bin_path(gem, bin, ver) Gem.bin_path(gem, bin, ver) end
#build(spec, skip_validation = false)
[ GitHub ]#build_gem(gem_dir, spec)
[ GitHub ]#clear_paths
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 202
def clear_paths Gem.clear_paths end
#configuration
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 111
def configuration require_relative "psyched_yaml" Gem.configuration rescue Gem::SystemExitException, LoadError => e Bundler.ui.error "#{e.class}: #{e.}" Bundler.ui.trace e raise rescue YamlLibrarySyntaxError => e raise YamlSyntaxError.new(e, "Your RubyGems configuration, which is " \ "usually located in ~/.gemrc, contains invalid YAML syntax.") end
#correct_for_windows_path(path)
[ GitHub ]#default_stubs
See additional method definition at line 612.
# File 'lib/bundler/rubygems_integration.rb', line 616
def default_stubs Gem::Specification.default_stubs("*.gemspec") end
#download_gem(spec, uri, cache_dir)
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 521
def download_gem(spec, uri, cache_dir) require "rubygems/remote_fetcher" uri = Bundler.settings.mirror_for(uri) fetcher = gem_remote_fetcher fetcher.headers = { "X-Gemfile-Source" => spec.remote.original_uri.to_s } if spec.remote.original_uri Bundler::Retry.new("download gem from #{uri}").attempts do gem_file_name = spec.file_name local_gem_path = File.join cache_dir, gem_file_name return if File.exist? local_gem_path begin remote_gem_path = uri + "gems/#{gem_file_name}" remote_gem_path = remote_gem_path.to_s if provides?("< 3.2.0.rc.1") SharedHelpers.filesystem_access(local_gem_path) do fetcher.cache_update_path remote_gem_path, local_gem_path end rescue Gem::RemoteFetcher::FetchError raise if spec.original_platform == spec.platform original_gem_file_name = "#{spec.original_name}.gem" raise if gem_file_name == original_gem_file_name gem_file_name = original_gem_file_name retry end end rescue Gem::RemoteFetcher::FetchError => e raise Bundler::HTTPError, "Could not download gem from #{uri} due to underlying error <#{e.}>" end
#ext_lock
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 231
def ext_lock EXT_LOCK end
#fetch_all_remote_specs(remote)
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 514
def fetch_all_remote_specs(remote) specs = fetch_specs(remote, "specs") pres = fetch_specs(remote, "prerelease_specs") || [] specs.concat(pres) end
#fetch_specs(remote, name)
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 502
def fetch_specs(remote, name) require "rubygems/remote_fetcher" path = remote.uri.to_s + "#{name}.#{Gem.marshal_version}.gz" fetcher = gem_remote_fetcher fetcher.headers = { "X-Gemfile-Source" => remote.original_uri.to_s } if remote.original_uri string = fetcher.fetch_path(path) Bundler.load_marshal(string) rescue Gem::RemoteFetcher::FetchError # it's okay for prerelease to fail raise unless name == "prerelease_specs" end
#find_name(name)
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 607
def find_name(name) Gem::Specification.stubs_for(name).map(&:to_spec) end
#gem_bindir
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 162
def gem_bindir Gem.bindir end
#gem_cache
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 186
def gem_cache gem_path.map {|p| File. ("cache", p) } end
#gem_dir
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 158
def gem_dir Gem.dir end
#gem_from_path(path, policy = nil)
[ GitHub ]#gem_path
[ GitHub ]#gem_remote_fetcher
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 552
def gem_remote_fetcher require "rubygems/remote_fetcher" proxy = configuration[:http_proxy] Gem::RemoteFetcher.new(proxy) end
#inflate(obj)
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 131
def inflate(obj) Gem::Util.inflate(obj) end
#install_with_build_args(args)
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 574
def install_with_build_args(args) yield end
#load_env_plugins
[ GitHub ]#load_plugin_files(files)
[ GitHub ]#load_plugins
[ GitHub ]#loaded_gem_paths
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 210
def loaded_gem_paths loaded_gem_paths = Gem.loaded_specs.map {|_, s| s.full_require_paths } loaded_gem_paths.flatten end
#loaded_specs(name)
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 46
def loaded_specs(name) Gem.loaded_specs[name] end
#mark_loaded(spec)
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 62
def mark_loaded(spec) if spec.respond_to?(:activated=) current = Gem.loaded_specs[spec.name] current.activated = false if current spec.activated = true end Gem.loaded_specs[spec.name] = spec end
#marshal_spec_dir
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 198
def marshal_spec_dir Gem::MARSHAL_SPEC_DIR end
#method_visibility(klass, method)
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 472
def method_visibility(klass, method) if klass.private_method_defined?(method) :private elsif klass.protected_method_defined?(method) :protected else :public end end
#path(obj)
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 107
def path(obj) obj.to_s end
#path_separator
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 578
def path_separator Gem.path_separator end
#post_reset_hooks
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 178
def post_reset_hooks Gem.post_reset_hooks end
#provides?(req_str) ⇒ Boolean
# File 'lib/bundler/rubygems_integration.rb', line 32
def provides?(req_str) self.class.provides?(req_str) end
#read_binary(path)
[ GitHub ]#redefine_method(klass, method, unbound_method = nil, &block)
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 451
def redefine_method(klass, method, unbound_method = nil, &block) visibility = method_visibility(klass, method) begin if (instance_method = klass.instance_method(method)) && method != :initialize # doing this to ensure we also get private methods klass.send(:remove_method, method) end rescue NameError # method isn't defined nil end @replaced_methods[[method, klass]] = instance_method if unbound_method klass.send(:define_method, method, unbound_method) klass.send(visibility, method) elsif block klass.send(:define_method, method, &block) klass.send(visibility, method) end end
#replace_bin_path(specs_by_name)
Used to make bin stubs that are not created by bundler work under bundler. The new Gem.bin_path
only considers gems in specs
# File 'lib/bundler/rubygems_integration.rb', line 343
def replace_bin_path(specs_by_name) gem_class = (class << Gem; self; end) redefine_method(gem_class, :find_spec_for_exe) do |gem_name, *args| exec_name = args.first raise ArgumentError, "you must supply exec_name" unless exec_name spec_with_name = specs_by_name[gem_name] matching_specs_by_exec_name = specs_by_name.values.select {|s| s.executables.include?(exec_name) } spec = matching_specs_by_exec_name.delete(spec_with_name) unless spec || !matching_specs_by_exec_name.empty? = "can't find executable #{exec_name} for gem #{gem_name}" if spec_with_name.nil? += ". #{gem_name} is not currently included in the bundle, " \ "perhaps you meant to add it to your #{Bundler.default_gemfile.basename}?" end raise Gem::Exception, end unless spec spec = matching_specs_by_exec_name.shift warn \ "Bundler is using a binstub that was created for a different gem (#{spec.name}).\n" \ "You should run `bundle binstub #{gem_name}` " \ "to work around a system/bundle conflict." end unless matching_specs_by_exec_name.empty? conflicting_names = matching_specs_by_exec_name.map(&:name).join(", ") warn \ "The `#{exec_name}` executable in the `#{spec.name}` gem is being loaded, but it's also present in other gems (#{conflicting_names}).\n" \ "If you meant to run the executable for another gem, make sure you use a project specific binstub (`bundle binstub <gem_name>`).\n" \ "If you plan to use multiple conflicting executables, generate binstubs for them and disambiguate their names." end spec end redefine_method(gem_class, :activate_bin_path) do |name, *args| exec_name = args.first return ENV["BUNDLE_BIN_PATH"] if exec_name == "bundle" # Copy of Rubygems activate_bin_path impl requirement = args.last spec = find_spec_for_exe name, exec_name, [requirement] gem_bin = File.join(spec.full_gem_path, spec.bindir, exec_name) gem_from_path_bin = File.join(File.dirname(spec.loaded_from), spec.bindir, exec_name) File.exist?(gem_bin) ? gem_bin : gem_from_path_bin end redefine_method(gem_class, :bin_path) do |name, *args| exec_name = args.first return ENV["BUNDLE_BIN_PATH"] if exec_name == "bundle" spec = find_spec_for_exe(name, *args) exec_name ||= spec.default_executable gem_bin = File.join(spec.full_gem_path, spec.bindir, exec_name) gem_from_path_bin = File.join(File.dirname(spec.loaded_from), spec.bindir, exec_name) File.exist?(gem_bin) ? gem_bin : gem_from_path_bin end end
#replace_entrypoints(specs)
Replace or hook into RubyGems to provide a bundlerized view of the world.
# File 'lib/bundler/rubygems_integration.rb', line 410
def replace_entrypoints(specs) specs_by_name = add_default_gems_to(specs) replace_gem(specs, specs_by_name) stub_rubygems(specs) replace_bin_path(specs_by_name) Gem.clear_paths end
#replace_gem(specs, specs_by_name)
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 290
def replace_gem(specs, specs_by_name) reverse_rubygems_kernel_mixin executables = nil kernel = (class << ::Kernel; self; end) [kernel, ::Kernel].each do |kernel_class| redefine_method(kernel_class, :gem) do |dep, *reqs| if executables && executables.include?(File.basename(caller.first.split(":").first)) break end reqs.pop if reqs.last.is_a?(Hash) unless dep.respond_to?(:name) && dep.respond_to?(:requirement) dep = Gem::Dependency.new(dep, reqs) end if spec = specs_by_name[dep.name] return true if dep.matches_spec?(spec) end = if spec.nil? target_file = begin Bundler.default_gemfile.basename rescue GemfileNotFound "inline Gemfile" end "#{dep.name} is not part of the bundle." \ " Add it to your #{target_file}." else "can't activate #{dep}, already activated #{spec.full_name}. " \ "Make sure all dependencies are added to Gemfile." end e = Gem::LoadError.new( ) e.name = dep.name if e.respond_to?(:requirement=) e.requirement = dep.requirement elsif e.respond_to?(:version_requirement=) e.version_requirement = dep.requirement end raise e end # backwards compatibility shim, see https://github.com/rubygems/bundler/issues/5102 kernel_class.send(:public, :gem) if Bundler.feature_flag.setup_makes_kernel_gem_public? end end
#repository_subdirectories
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 570
def repository_subdirectories Gem::REPOSITORY_SUBDIRECTORIES end
#reset
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 174
def reset Gem::Specification.reset end
#reverse_rubygems_kernel_mixin
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 280
def reverse_rubygems_kernel_mixin # Disable rubygems' gem activation system kernel = (class << ::Kernel; self; end) [kernel, ::Kernel].each do |k| if k.private_method_defined?(:gem_original_require) redefine_method(k, :require, k.instance_method(:gem_original_require)) end end end
#ruby_engine
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 123
def ruby_engine Gem.ruby_engine end
#security_policies
[ GitHub ]#security_policy_keys
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 267
def security_policy_keys %w[High Medium Low AlmostNo No].map {|level| "#{level}Security" } end
#set_installed_by_version(spec, installed_by_version = Gem::VERSION)
[ GitHub ]#spec_cache_dirs
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 190
def spec_cache_dirs @spec_cache_dirs ||= begin dirs = gem_path.map {|dir| File.join(dir, "specifications") } dirs << Gem.spec_cache_dir if Gem.respond_to?(:spec_cache_dir) # Not in RubyGems 2.0.3 or earlier dirs.uniq.select {|dir| File.directory? dir } end end
#spec_from_gem(path, policy = nil)
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 247
def spec_from_gem(path, policy = nil) require "rubygems/security" require_relative "psyched_yaml" gem_from_path(path, security_policies[policy]).spec rescue Exception, Gem::Exception, Gem::Security::Exception => e # rubocop:disable Lint/RescueException if e.is_a?(Gem::Security::Exception) || e. =~ /unknown trust policy|unsigned gem/i || e. =~ /couldn't verify (meta)?data signature/i raise SecurityError, "The gem #{File.basename(path, ".gem")} can't be installed because " \ "the security policy didn't allow it, with the message: #{e.}" else raise e end end
#spec_matches_for_glob(spec, glob)
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 95
def spec_matches_for_glob(spec, glob) return spec.matches_for_glob(glob) if spec.respond_to?(:matches_for_glob) spec.load_paths.map do |lp| Dir["#{lp}/#{glob}#{suffix_pattern}"] end.flatten(1) end
#spec_missing_extensions?(spec, default = true) ⇒ Boolean
# File 'lib/bundler/rubygems_integration.rb', line 86
def spec_missing_extensions?(spec, default = true) return spec.missing_extensions? if spec.respond_to?(:missing_extensions?) return false if spec.default_gem? return false if spec.extensions.empty? default end
#stub_rubygems(specs)
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 482
def stub_rubygems(specs) Gem::Specification.all = specs Gem.post_reset do Gem::Specification.all = specs end redefine_method((class << Gem; self; end), :finish_resolve) do |*| [] end end
#stub_set_spec(stub, spec)
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 103
def stub_set_spec(stub, spec) stub.instance_variable_set(:@spec, spec) end
#suffix_pattern
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 182
def suffix_pattern Gem.suffix_pattern end
#undo_replacements
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 439
def undo_replacements @replaced_methods.each do |(sym, klass), method| redefine_method(klass, sym, method) end if Binding.public_method_defined?(:source_location) post_reset_hooks.reject! {|proc| proc.binding.source_location[0] == __FILE__ } else post_reset_hooks.reject! {|proc| proc.binding.eval("__FILE__") == __FILE__ } end @replaced_methods.clear end
#use_gemdeps(gemfile)
[ GitHub ]#user_home
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 166
def user_home Gem.user_home end
#validate(spec)
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 71
def validate(spec) Bundler.ui.silence { spec.validate(false) } rescue Gem::InvalidSpecificationException => e = "The gemspec at #{spec.loaded_from} is not valid. Please fix this gemspec.\n" \ "The validation error was '#{e.}'\n" raise Gem::InvalidSpecificationException.new( ) rescue Errno::ENOENT nil end
#version
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 28
def version self.class.version end
#with_build_args(args)
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 235
def with_build_args(args) ext_lock.synchronize do old_args = build_args begin self.build_args = args yield ensure self.build_args = old_args end end end