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 9Monitor.new
Class Method Summary
- .new ⇒ RubygemsIntegration constructor
Instance Attribute Summary
- #build_args rw
- #build_args=(args) rw
- #plain_specs rw
- #plain_specs=(specs) rw
- #supports_bundler_trampolining? ⇒ Boolean readonly
- #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.
- #all_specs
- #bin_path(gem, bin, ver)
- #build(spec, skip_validation = false)
- #build_gem(gem_dir, spec)
- #clear_paths
- #default_specs
- #default_stubs
- #download_gem(spec, uri, cache_dir, fetcher)
- #ext_lock
- #fetch_all_remote_specs(remote, gem_remote_fetcher)
- #fetch_specs(remote, name, fetcher)
- #find_bundler(version)
- #find_name(name)
- #gem_bindir
- #gem_cache
- #gem_dir
- #gem_path
- #inflate(obj)
- #installed_specs
- #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)
- #reset
- #reverse_rubygems_kernel_mixin
- #ruby_engine
- #security_policies
- #security_policy_keys
- #spec_cache_dirs
- #spec_from_gem(path)
- #stub_rubygems(specs)
- #stub_set_spec(stub, spec)
- #suffix_pattern
- #undo_replacements
- #user_home
- #validate(spec)
- #version
Constructor Details
.new ⇒ RubygemsIntegration
# File 'lib/bundler/rubygems_integration.rb', line 11
def initialize @replaced_methods = {} end
Instance Attribute Details
#build_args (rw)
[ GitHub ]#build_args=(args) (rw)
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 32
def build_args=(args) require "rubygems/command" Gem::Command.build_args = args end
#plain_specs (rw)
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 385
def plain_specs Gem::Specification._all end
#plain_specs=(specs) (rw)
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 389
def plain_specs=(specs) Gem::Specification.all = specs end
#supports_bundler_trampolining? ⇒ Boolean
(readonly)
[ GitHub ]
# File 'lib/bundler/rubygems_integration.rb', line 23
def supports_bundler_trampolining? provides?(">= 3.3.0.a") 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 312
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
#all_specs
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 449
def all_specs SharedHelpers.major_deprecation 2, "Bundler.rubygems.all_specs has been removed in favor of Bundler.rubygems.installed_specs" Gem::Specification.stubs.map do |stub| StubSpecification.from_stub(stub) end end
#bin_path(gem, bin, ver)
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 128
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 124
def clear_paths Gem.clear_paths end
#default_specs
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 463
def default_specs Gem::Specification.default_stubs.map do |stub| StubSpecification.from_stub(stub) end end
#default_stubs
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 477
def default_stubs Gem::Specification.default_stubs("*.gemspec") end
#download_gem(spec, uri, cache_dir, fetcher)
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 412
def download_gem(spec, uri, cache_dir, fetcher) require "rubygems/remote_fetcher" uri = Bundler.settings.mirror_for(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}" 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 141
def ext_lock EXT_LOCK end
#fetch_all_remote_specs(remote, gem_remote_fetcher)
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 405
def fetch_all_remote_specs(remote, gem_remote_fetcher) specs = fetch_specs(remote, "specs", gem_remote_fetcher) pres = fetch_specs(remote, "prerelease_specs", gem_remote_fetcher) || [] specs.concat(pres) end
#fetch_specs(remote, name, fetcher)
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 393
def fetch_specs(remote, name, fetcher) require "rubygems/remote_fetcher" path = remote.uri.to_s + "#{name}.#{Gem.marshal_version}.gz" string = fetcher.fetch_path(path) specs = Bundler.safe_load_marshal(string) raise MarshalError, "Specs #{name} from #{remote} is expected to be an Array but was unexpected class #{specs.class}" unless specs.is_a?(Array) specs rescue Gem::RemoteFetcher::FetchError # it's okay for prerelease to fail raise unless name == "prerelease_specs" end
#find_bundler(version)
[ GitHub ]#find_name(name)
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 473
def find_name(name) Gem::Specification.stubs_for(name).map(&:to_spec) end
#gem_bindir
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 84
def gem_bindir Gem.bindir end
#gem_cache
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 108
def gem_cache gem_path.map {|p| File. ("cache", p) } end
#gem_dir
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 80
def gem_dir Gem.dir end
#gem_path
[ GitHub ]#inflate(obj)
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 76
def inflate(obj) Gem::Util.inflate(obj) end
#installed_specs
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 457
def installed_specs Gem::Specification.stubs.reject(&:default_gem?).map do |stub| StubSpecification.from_stub(stub) end end
#loaded_gem_paths
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 132
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 37
def loaded_specs(name) Gem.loaded_specs[name] end
#mark_loaded(spec)
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 41
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 120
def marshal_spec_dir Gem::MARSHAL_SPEC_DIR end
#method_visibility(klass, method)
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 363
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 64
def path(obj) obj.to_s end
#path_separator
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 445
def path_separator Gem.path_separator end
#post_reset_hooks
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 100
def post_reset_hooks Gem.post_reset_hooks end
#provides?(req_str) ⇒ Boolean
# File 'lib/bundler/rubygems_integration.rb', line 19
def provides?(req_str) Gem::Requirement.new(req_str).satisfied_by?(version) end
#read_binary(path)
[ GitHub ]#redefine_method(klass, method, unbound_method = nil, &block)
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 342
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 226
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 293
def replace_entrypoints(specs) specs_by_name = add_default_gems_to(specs) reverse_rubygems_kernel_mixin begin # bundled_gems only provide with Ruby 3.3 or later require "bundled_gems" rescue LoadError else Gem::BUNDLED_GEMS.replace_require(specs) if Gem::BUNDLED_GEMS.respond_to?(:replace_require) end 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 180
def replace_gem(specs, specs_by_name) executables = nil [::Kernel.singleton_class, ::Kernel].each do |kernel_class| redefine_method(kernel_class, :gem) do |dep, *reqs| if executables&.include?(File.basename(caller_locations(1, 1).first.path)) 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 e.requirement = dep.requirement 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
#reset
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 96
def reset Gem::Specification.reset end
#reverse_rubygems_kernel_mixin
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 167
def reverse_rubygems_kernel_mixin # Disable rubygems' gem activation system if Gem.respond_to?(:discover_gems_on_require=) Gem.discover_gems_on_require = false else [::Kernel.singleton_class, ::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 end
#ruby_engine
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 68
def ruby_engine Gem.ruby_engine end
#security_policies
[ GitHub ]#security_policy_keys
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 154
def security_policy_keys %w[High Medium Low AlmostNo No].map {|level| "#{level}Security" } end
#spec_cache_dirs
[ GitHub ]#spec_from_gem(path)
[ GitHub ]#stub_rubygems(specs)
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 373
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 60
def stub_set_spec(stub, spec) stub.instance_variable_set(:@spec, spec) end
#suffix_pattern
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 104
def suffix_pattern Gem.suffix_pattern end
#undo_replacements
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 330
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
#user_home
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 88
def user_home Gem.user_home end
#validate(spec)
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 50
def validate(spec) Bundler.ui.silence { spec.validate_for_resolution } 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 15
def version @version ||= Gem.rubygems_version end