class Bundler::RubygemsIntegration
Constants
- EXT_LOCK
Public Class Methods
# File lib/bundler/rubygems_integration.rb, line 23 def initialize @replaced_methods = {} end
# File lib/bundler/rubygems_integration.rb, line 19 def self.provides?(req_str) Gem::Requirement.new(req_str).satisfied_by?(version) end
# File lib/bundler/rubygems_integration.rb, line 15 def self.version @version ||= Gem::Version.new(Gem::VERSION) end
Public Instance Methods
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
# 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
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
# 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
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
# File lib/bundler/rubygems_integration.rb, line 211 def bin_path(gem, bin, ver) Gem.bin_path(gem, bin, ver) end
# File lib/bundler/rubygems_integration.rb, line 362 def binstubs_call_gem? true end
# File lib/bundler/rubygems_integration.rb, line 322 def build(spec, skip_validation = false) require "rubygems/builder" Gem::Builder.new(spec).build end
# File lib/bundler/rubygems_integration.rb, line 35 def build_args Gem::Command.build_args end
# File lib/bundler/rubygems_integration.rb, line 39 def build_args=(args) Gem::Command.build_args = args end
# File lib/bundler/rubygems_integration.rb, line 327 def build_gem(gem_dir, spec) build(spec) end
# File lib/bundler/rubygems_integration.rb, line 207 def clear_paths Gem.clear_paths end
# File lib/bundler/rubygems_integration.rb, line 199 def config_map Gem::ConfigMap end
# 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.message}" 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
# File lib/bundler/rubygems_integration.rb, line 331 def download_gem(spec, uri, path) uri = Bundler.settings.mirror_for(uri) fetcher = Gem::RemoteFetcher.new(configuration[:http_proxy]) Bundler::Retry.new("download gem from #{uri}").attempts do fetcher.download(spec, uri, path) end end
# File lib/bundler/rubygems_integration.rb, line 249 def ext_lock EXT_LOCK end
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
# 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
# File lib/bundler/rubygems_integration.rb, line 253 def fetch_specs(all, pre, &blk) require "rubygems/spec_fetcher" specs = Gem::SpecFetcher.new.list(all, pre) specs.each { yield } if block_given? specs end
# File lib/bundler/rubygems_integration.rb, line 159 def gem_bindir Gem.bindir end
# File lib/bundler/rubygems_integration.rb, line 183 def gem_cache gem_path.map {|p| File.expand_path("cache", p) } end
# File lib/bundler/rubygems_integration.rb, line 155 def gem_dir Gem.dir end
# File lib/bundler/rubygems_integration.rb, line 299 def gem_from_path(path, policy = nil) require "rubygems/format" Gem::Format.from_file_by_path(path, policy) end
# File lib/bundler/rubygems_integration.rb, line 167 def gem_path Gem.path end
# File lib/bundler/rubygems_integration.rb, line 134 def inflate(obj) if defined?(Gem::Util) Gem::Util.inflate(obj) else Gem.inflate(obj) end end
# File lib/bundler/rubygems_integration.rb, line 295 def install_with_build_args(args) with_build_args(args) { yield } end
# File lib/bundler/rubygems_integration.rb, line 43 def load_path_insert_index Gem.load_path_insert_index end
# File lib/bundler/rubygems_integration.rb, line 241 def load_plugin_files(files) Gem.load_plugin_files(files) if Gem.respond_to?(:load_plugin_files) end
# File lib/bundler/rubygems_integration.rb, line 237 def load_plugins Gem.load_plugins if Gem.respond_to?(:load_plugins) end
# 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
# File lib/bundler/rubygems_integration.rb, line 47 def loaded_specs(name) Gem.loaded_specs[name] end
# 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
# File lib/bundler/rubygems_integration.rb, line 195 def marshal_spec_dir Gem::MARSHAL_SPEC_DIR end
# 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
# File lib/bundler/rubygems_integration.rb, line 105 def path(obj) obj.to_s end
# File lib/bundler/rubygems_integration.rb, line 215 def path_separator File::PATH_SEPARATOR end
# File lib/bundler/rubygems_integration.rb, line 109 def platforms return [Gem::Platform::RUBY] if Bundler.settings[:force_ruby_platform] Gem.platforms end
# File lib/bundler/rubygems_integration.rb, line 175 def post_reset_hooks Gem.post_reset_hooks end
# File lib/bundler/rubygems_integration.rb, line 219 def preserve_paths # this is a no-op outside of RubyGems 1.8 yield end
# File lib/bundler/rubygems_integration.rb, line 31 def provides?(req_str) self.class.provides?(req_str) end
# File lib/bundler/rubygems_integration.rb, line 130 def read_binary(path) Gem.read_binary(path) end
# 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
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 message = "can't find executable #{exec_name} for gem #{gem_name}" if !exec_name || spec_with_name.nil? message += ". #{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, message 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 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
# 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 message = 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(message) 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
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
# File lib/bundler/rubygems_integration.rb, line 203 def repository_subdirectories %w[cache doc gems specifications] end
# File lib/bundler/rubygems_integration.rb, line 171 def reset Gem::Specification.reset end
# 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
# File lib/bundler/rubygems_integration.rb, line 126 def ruby_engine Gem.ruby_engine end
# File lib/bundler/rubygems_integration.rb, line 343 def security_policies @security_policies ||= begin require "rubygems/security" Gem::Security::Policies rescue LoadError, NameError {} end end
# File lib/bundler/rubygems_integration.rb, line 339 def security_policy_keys %w[High Medium Low AlmostNo No].map {|level| "#{level}Security" } end
# File lib/bundler/rubygems_integration.rb, line 70 def set_installed_by_version(spec, installed_by_version = Gem::VERSION) return unless spec.respond_to?(:installed_by_version=) spec.installed_by_version = Gem::Version.create(installed_by_version) end
# File lib/bundler/rubygems_integration.rb, line 151 def sources Gem.sources end
# 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
# 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
# File lib/bundler/rubygems_integration.rb, line 84 def spec_default_gem?(spec) spec.respond_to?(:default_gem?) && spec.default_gem? end
# File lib/bundler/rubygems_integration.rb, line 96 def spec_extension_dir(spec) return unless spec.respond_to?(:extension_dir) spec.extension_dir end
# 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.message =~ /unknown trust policy|unsigned gem/i || e.message =~ /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.message}" else raise e end end
# 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
# 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
# File lib/bundler/rubygems_integration.rb, line 101 def stub_set_spec(stub, spec) stub.instance_variable_set(:@spec, spec) end
# 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
# File lib/bundler/rubygems_integration.rb, line 366 def stubs_provide_full_functionality? false end
# File lib/bundler/rubygems_integration.rb, line 179 def suffix_pattern Gem.suffix_pattern end
# File lib/bundler/rubygems_integration.rb, line 245 def ui=(obj) Gem::DefaultUserInteraction.ui = obj end
# 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
# File lib/bundler/rubygems_integration.rb, line 163 def user_home Gem.user_home end
# File lib/bundler/rubygems_integration.rb, line 60 def validate(spec) Bundler.ui.silence { spec.validate(false) } rescue Gem::InvalidSpecificationException => e error_message = "The gemspec at #{spec.loaded_from} is not valid. Please fix this gemspec.\n" \ "The validation error was '#{e.message}'\n" raise Gem::InvalidSpecificationException.new(error_message) rescue Errno::ENOENT nil end
# File lib/bundler/rubygems_integration.rb, line 27 def version self.class.version end
# 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