Class: Bundler::RubygemsIntegration
Relationships & Source Files | |
Namespace Children | |
Classes:
| |
Extension / Inclusion / Inheritance Descendants | |
Subclasses:
|
|
Inherits: | Object |
Defined in: | lib/bundler/rubygems_integration.rb |
Constant Summary
-
EXT_LOCK =
# File 'lib/bundler/rubygems_integration.rb', line 10Monitor.new
Class Method Summary
Instance Attribute Summary
- #binstubs_call_gem? ⇒ Boolean readonly
- #build_args rw
- #build_args=(args) rw
- #sources rw
- #sources=(val) rw
- #stubs_provide_full_functionality? ⇒ Boolean readonly
- #ui=(obj) writeonly
Instance Method Summary
-
#backport_base_dir
This backports base_dir which replaces installation path RubyGems 1.8+.
- #backport_cache_file
-
#backport_segment_generation
This backports the correct segment generation code from RubyGems 1.4+ by monkeypatching it into the method in RubyGems 1.3.6 and 1.3.7.
- #backport_spec_file
-
#backport_yaml_initialize
This backport fixes the marshaling of @segments.
- #bin_path(gem, bin, ver)
- #build(spec, skip_validation = false)
- #build_gem(gem_dir, spec)
- #clear_paths
- #config_map
- #configuration
- #download_gem(spec, uri, path)
- #ext_lock
-
#fetch_all_remote_specs(remote)
TODO: This is for older versions of RubyGems…
- #fetch_prerelease_specs
- #fetch_specs(all, pre, &blk)
- #gem_bindir
- #gem_cache
- #gem_dir
- #gem_from_path(path, policy = nil)
- #gem_path
- #inflate(obj)
- #install_with_build_args(args)
- #load_path_insert_index
- #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
- #platforms
- #post_reset_hooks
- #preserve_paths
- #provides?(req_str) ⇒ Boolean
- #read_binary(path)
- #redefine_method(klass, method, unbound_method = nil, &block)
-
#replace_bin_path(specs, 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)
-
#replace_refresh
Because Bundler has a static view of what specs are available, we don’t
#refresh
, so stub it out. - #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_default_gem?(spec) ⇒ Boolean
- #spec_extension_dir(spec)
- #spec_from_gem(path, policy = nil)
- #spec_matches_for_glob(spec, glob)
- #spec_missing_extensions?(spec, default = true) ⇒ Boolean
- #stub_set_spec(stub, spec)
- #stub_source_index(specs)
- #suffix_pattern
- #undo_replacements
- #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 = {} 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
#binstubs_call_gem? ⇒ Boolean
(readonly)
[ GitHub ]
# File 'lib/bundler/rubygems_integration.rb', line 362
def binstubs_call_gem? true end
#build_args (rw)
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 35
def build_args Gem::Command.build_args end
#build_args=(args) (rw)
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 39
def build_args=(args) Gem::Command.build_args = args end
#sources (rw)
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 151
def sources Gem.sources end
#sources=(val) (rw)
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 142
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
#stubs_provide_full_functionality? ⇒ Boolean
(readonly)
[ GitHub ]
# File 'lib/bundler/rubygems_integration.rb', line 366
def stubs_provide_full_functionality? false end
#ui=(obj) (writeonly)
[ GitHub ]Instance Method Details
#backport_base_dir
This backports base_dir which replaces installation path RubyGems 1.8+
# File 'lib/bundler/rubygems_integration.rb', line 546
def backport_base_dir redefine_method(Gem::Specification, :base_dir) do return Gem.dir unless loaded_from File.dirname File.dirname loaded_from end end
#backport_cache_file
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 553
def backport_cache_file redefine_method(Gem::Specification, :cache_dir) do @cache_dir ||= File.join base_dir, "cache" end redefine_method(Gem::Specification, :cache_file) do @cache_file ||= File.join cache_dir, "#{full_name}.gem" end end
#backport_segment_generation
This backports the correct segment generation code from RubyGems 1.4+ by monkeypatching it into the method in RubyGems 1.3.6 and 1.3.7.
# File 'lib/bundler/rubygems_integration.rb', line 527
def backport_segment_generation redefine_method(Gem::Version, :segments) do @segments ||= @version.scan(/[0-9]|[a-z]/i).map do |s| /^\d+$/ =~ s ? s.to_i : s end end end
#backport_spec_file
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 563
def backport_spec_file redefine_method(Gem::Specification, :spec_dir) do @spec_dir ||= File.join base_dir, "specifications" end redefine_method(Gem::Specification, :spec_file) do @spec_file ||= File.join spec_dir, "#{full_name}.gemspec" end end
#backport_yaml_initialize
This backport fixes the marshaling of @segments.
# File 'lib/bundler/rubygems_integration.rb', line 536
def backport_yaml_initialize redefine_method(Gem::Version, :yaml_initialize) do |_, map| @version = map["version"] @segments = nil @hash = nil end end
#bin_path(gem, bin, ver)
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 211
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 207
def clear_paths Gem.clear_paths end
#config_map
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 199
def config_map Gem::ConfigMap end
#configuration
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 114
def configuration require "bundler/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
#download_gem(spec, uri, path)
[ GitHub ]#ext_lock
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 249
def ext_lock EXT_LOCK end
#fetch_all_remote_specs(remote)
TODO: This is for older versions of RubyGems… should we support the X-Gemfile-Source header on these old versions? Maybe the newer implementation will work on older RubyGems? It seems difficult to keep this implementation and still send the header.
# File 'lib/bundler/rubygems_integration.rb', line 270
def fetch_all_remote_specs(remote) old_sources = Bundler.rubygems.sources Bundler.rubygems.sources = [remote.uri.to_s] # Fetch all specs, minus prerelease specs spec_list = fetch_specs(true, false) # Then fetch the prerelease specs fetch_prerelease_specs.each {|k, v| spec_list[k].concat(v) } spec_list.values.first ensure Bundler.rubygems.sources = old_sources end
#fetch_prerelease_specs
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 260
def fetch_prerelease_specs fetch_specs(false, true) rescue Gem::RemoteFetcher::FetchError {} # if we can't download them, there aren't any end
#fetch_specs(all, pre, &blk)
[ GitHub ]#gem_bindir
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 159
def gem_bindir Gem.bindir end
#gem_cache
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 183
def gem_cache gem_path.map {|p| File. ("cache", p) } end
#gem_dir
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 155
def gem_dir Gem.dir end
#gem_from_path(path, policy = nil)
[ GitHub ]#gem_path
[ GitHub ]#inflate(obj)
[ GitHub ]#install_with_build_args(args)
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 295
def install_with_build_args(args) with_build_args(args) { yield } end
#load_path_insert_index
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 43
def load_path_insert_index Gem.load_path_insert_index end
#load_plugin_files(files)
[ GitHub ]#load_plugins
[ GitHub ]#loaded_gem_paths
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 224
def loaded_gem_paths # RubyGems 2.2+ can put binary extension into dedicated folders, # therefore use RubyGems facilities to obtain their load paths. if Gem::Specification.method_defined? :full_require_paths loaded_gem_paths = Gem.loaded_specs.map {|_, s| s.full_require_paths } loaded_gem_paths.flatten else $LOAD_PATH.select do |p| Bundler.rubygems.gem_path.any? {|gp| p =~ /^#{Regexp.escape(gp)}/ } end end end
#loaded_specs(name)
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 47
def loaded_specs(name) Gem.loaded_specs[name] end
#mark_loaded(spec)
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 51
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 195
def marshal_spec_dir Gem::MARSHAL_SPEC_DIR end
#method_visibility(klass, method)
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 606
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 105
def path(obj) obj.to_s end
#path_separator
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 215
def path_separator File::PATH_SEPARATOR end
#platforms
[ GitHub ]#post_reset_hooks
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 175
def post_reset_hooks Gem.post_reset_hooks end
#preserve_paths
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 219
def preserve_paths # this is a no-op outside of RubyGems 1.8 yield end
#provides?(req_str) ⇒ Boolean
# File 'lib/bundler/rubygems_integration.rb', line 31
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 585
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, 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 439
def replace_bin_path(specs, 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 spec_with_name = specs_by_name[gem_name] spec = if exec_name if spec_with_name && spec_with_name.executables.include?(exec_name) spec_with_name else specs.find {|s| s.executables.include?(exec_name) } end else spec_with_name end unless spec = "can't find executable #{exec_name} for gem #{gem_name}" if !exec_name || 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 raise Gem::Exception, "no default executable for #{spec.full_name}" unless exec_name ||= spec.default_executable unless spec.name == gem_name Bundler::SharedHelpers.major_deprecation 2, "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 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 511
def replace_entrypoints(specs) specs_by_name = specs.reduce({}) do |h, s| h[s.name] = s h end replace_gem(specs, specs_by_name) stub_rubygems(specs) replace_bin_path(specs, specs_by_name) replace_refresh Gem.clear_paths end
#replace_gem(specs, specs_by_name)
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 370
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| executables ||= specs.map(&:executables).flatten if ::Bundler.rubygems.binstubs_call_gem? 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? "#{dep.name} is not part of the bundle." \ " Add it to your #{Bundler.default_gemfile.basename}." 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/bundler/bundler/issues/5102 kernel_class.send(:public, :gem) if Bundler.feature_flag.setup_makes_kernel_gem_public? end end
#replace_refresh
Because Bundler has a static view of what specs are available, we don’t #refresh
, so stub it out.
# File 'lib/bundler/rubygems_integration.rb', line 504
def replace_refresh gem_class = (class << Gem; self; end) redefine_method(gem_class, :refresh) {} end
#repository_subdirectories
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 203
def repository_subdirectories %w[cache doc gems specifications] end
#reset
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 171
def reset Gem::Specification.reset end
#reverse_rubygems_kernel_mixin
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 352
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 126
def ruby_engine Gem.ruby_engine end
#security_policies
[ GitHub ]#security_policy_keys
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 339
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 187
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_default_gem?(spec) ⇒ Boolean
# File 'lib/bundler/rubygems_integration.rb', line 84
def spec_default_gem?(spec) spec.respond_to?(:default_gem?) && spec.default_gem? end
#spec_extension_dir(spec)
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 96
def spec_extension_dir(spec) return unless spec.respond_to?(:extension_dir) spec.extension_dir end
#spec_from_gem(path, policy = nil)
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 304
def spec_from_gem(path, policy = nil) require "rubygems/security" require "bundler/psyched_yaml" gem_from_path(path, security_policies[policy]).spec rescue Gem::Package::FormatError raise GemspecError, "Could not read gem at #{path}. It may be corrupted." rescue Exception, Gem::Exception, Gem::Security::Exception => e 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 88
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 75
def spec_missing_extensions?(spec, default = true) return spec.missing_extensions? if spec.respond_to?(:missing_extensions?) return false if spec_default_gem?(spec) return false if spec.extensions.empty? default end
#stub_set_spec(stub, spec)
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 101
def stub_set_spec(stub, spec) stub.instance_variable_set(:@spec, spec) end
#stub_source_index(specs)
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 416
def stub_source_index(specs) Gem::SourceIndex.send(:alias_method, :old_initialize, :initialize) redefine_method(Gem::SourceIndex, :initialize) do |*args| @gems = {} # You're looking at this thinking: Oh! This is how I make those # rubygems deprecations go away! # # You'd be correct BUT using of this method in production code # must be approved by the rubygems team itself! # # This is your warning. If you use this and don't have approval # we can't protect you. # Deprecate.skip_during do self.spec_dirs = *args add_specs(*specs) end end end
#suffix_pattern
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 179
def suffix_pattern Gem.suffix_pattern end
#undo_replacements
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 573
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 163
def user_home Gem.user_home end
#validate(spec)
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 60
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 27
def version self.class.version end
#with_build_args(args)
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 283
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