Module: Bundler

Defined in:
lib/bundler.rb,
lib/bundler/ui.rb,
lib/bundler/cli.rb,
lib/bundler/dsl.rb,
lib/bundler/env.rb,
lib/bundler/graph.rb,
lib/bundler/index.rb,
lib/bundler/retry.rb,
lib/bundler/digest.rb,
lib/bundler/errors.rb,
lib/bundler/mirror.rb,
lib/bundler/plugin.rb,
lib/bundler/source.rb,
lib/bundler/worker.rb,
lib/bundler/cli/add.rb,
lib/bundler/cli/gem.rb,
lib/bundler/cli/viz.rb,
lib/bundler/fetcher.rb,
lib/bundler/runtime.rb,
lib/bundler/version.rb,
lib/bundler/checksum.rb,
lib/bundler/cli/exec.rb,
lib/bundler/cli/fund.rb,
lib/bundler/cli/info.rb,
lib/bundler/cli/init.rb,
lib/bundler/cli/list.rb,
lib/bundler/cli/lock.rb,
lib/bundler/cli/open.rb,
lib/bundler/cli/show.rb,
lib/bundler/injector.rb,
lib/bundler/resolver.rb,
lib/bundler/ruby_dsl.rb,
lib/bundler/settings.rb,
lib/bundler/spec_set.rb,
lib/bundler/ui/shell.rb,
lib/bundler/cli/cache.rb,
lib/bundler/cli/check.rb,
lib/bundler/cli/clean.rb,
lib/bundler/cli/issue.rb,
lib/bundler/constants.rb,
lib/bundler/deprecate.rb,
lib/bundler/installer.rb,
lib/bundler/ui/silent.rb,
lib/bundler/cli/common.rb,
lib/bundler/cli/config.rb,
lib/bundler/cli/doctor.rb,
lib/bundler/cli/inject.rb,
lib/bundler/cli/plugin.rb,
lib/bundler/cli/remove.rb,
lib/bundler/cli/update.rb,
lib/bundler/definition.rb,
lib/bundler/dependency.rb,
lib/bundler/deployment.rb,
lib/bundler/gem_helper.rb,
lib/bundler/plugin/api.rb,
lib/bundler/plugin/dsl.rb,
lib/bundler/source/git.rb,
lib/bundler/source_map.rb,
lib/bundler/ci_detector.rb,
lib/bundler/cli/console.rb,
lib/bundler/cli/install.rb,
lib/bundler/gem_helpers.rb,
lib/bundler/source/path.rb,
lib/bundler/source_list.rb,
lib/bundler/ui/rg_proxy.rb,
lib/bundler/cli/binstubs.rb,
lib/bundler/cli/outdated.rb,
lib/bundler/cli/platform.rb,
lib/bundler/cli/pristine.rb,
lib/bundler/current_ruby.rb,
lib/bundler/feature_flag.rb,
lib/bundler/fetcher/base.rb,
lib/bundler/plugin/index.rb,
lib/bundler/process_lock.rb,
lib/bundler/ruby_version.rb,
lib/bundler/safe_marshal.rb,
lib/bundler/self_manager.rb,
lib/bundler/vendored_uri.rb,
lib/bundler/fetcher/index.rb,
lib/bundler/plugin/events.rb,
lib/bundler/resolver/base.rb,
lib/bundler/resolver/root.rb,
lib/bundler/vendored_thor.rb,
lib/bundler/build_metadata.rb,
lib/bundler/force_platform.rb,
lib/bundler/match_metadata.rb,
lib/bundler/match_platform.rb,
lib/bundler/shared_helpers.rb,
lib/bundler/source/gemspec.rb,
lib/bundler/uri_normalizer.rb,
lib/bundler/vendored_tsort.rb,
lib/bundler/friendly_errors.rb,
lib/bundler/lockfile_parser.rb,
lib/bundler/source/metadata.rb,
lib/bundler/source/rubygems.rb,
lib/bundler/yaml_serializer.rb,
lib/bundler/plugin/installer.rb,
lib/bundler/resolver/package.rb,
lib/bundler/plugin/api/source.rb,
lib/bundler/vendored_pub_grub.rb,
lib/bundler/fetcher/dependency.rb,
lib/bundler/fetcher/downloader.rb,
lib/bundler/lazy_specification.rb,
lib/bundler/lockfile_generator.rb,
lib/bundler/plugin/source_list.rb,
lib/bundler/resolver/candidate.rb,
lib/bundler/settings/validator.rb,
lib/bundler/stub_specification.rb,
lib/bundler/vendored_fileutils.rb,
lib/bundler/resolver/spec_group.rb,
lib/bundler/similarity_detector.rb,
lib/bundler/vendored_persistent.rb,
lib/bundler/compact_index_client.rb,
lib/bundler/gem_version_promoter.rb,
lib/bundler/installer/standalone.rb,
lib/bundler/plugin/installer/git.rb,
lib/bundler/remote_specification.rb,
lib/bundler/rubygems_integration.rb,
lib/bundler/source/git/git_proxy.rb,
lib/bundler/environment_preserver.rb,
lib/bundler/fetcher/compact_index.rb,
lib/bundler/match_remote_metadata.rb,
lib/bundler/source/path/installer.rb,
lib/bundler/endpoint_specification.rb,
lib/bundler/rubygems_gem_installer.rb,
lib/bundler/source/rubygems/remote.rb,
lib/bundler/uri_credentials_filter.rb,
lib/bundler/installer/gem_installer.rb,
lib/bundler/resolver/incompatibility.rb,
lib/bundler/plugin/installer/rubygems.rb,
lib/bundler/source/rubygems_aggregate.rb,
lib/bundler/vendor/uri/lib/uri/common.rb,
lib/bundler/compact_index_client/cache.rb,
lib/bundler/fetcher/gem_remote_fetcher.rb,
lib/bundler/compact_index_client/updater.rb,
lib/bundler/installer/parallel_installer.rb,
lib/bundler/compact_index_client/cache_file.rb,
lib/bundler/compact_index_client/gem_parser.rb

Overview

module Bundler::URI

Defined Under Namespace

Modules: BuildMetadata, CIDetector, Digest, FetchMetadata, FileUtils, ForcePlatform, FriendlyErrors, GemHelpers, MatchMetadata, MatchPlatform, MatchRemoteMetadata, Persistent, Plugin, PubGrub, RubyDsl, SafeMarshal, SharedHelpers, TSort, UI, URI, URICredentialsFilter, URINormalizer, YAMLSerializer Classes: APIResponseInvalidDependenciesError, APIResponseMismatchError, BundlerError, CLI, Checksum, ChecksumMismatchError, CompactIndexClient, ConnectionPool, CurrentRuby, CyclicDependencyError, Definition, Dependency, Deployment, Deprecate, DeprecatedError, DirectoryRemovalError, Dsl, EndpointSpecification, Env, EnvironmentPreserver, FeatureFlag, Fetcher, GemHelper, GemInstaller, GemNotFound, GemRequireError, GemVersionPromoter, GemfileError, GemfileEvalError, GemfileLockNotFound, GemfileNotFound, GemspecError, GenericSystemCallError, GitError, Graph, HTTPError, Index, Injector, InsecureInstallPathError, InstallError, InstallHookError, Installer, InvalidOption, LazySpecification, LockfileError, LockfileGenerator, LockfileParser, MarshalError, MirrorSockets, NoSpaceOnDeviceError, OperationNotSupportedError, ParallelInstaller, PathError, PermissionError, PluginError, ProcessLock, ProductionError, RemoteSpecification, Resolver, Retry, RubyGemsGemInstaller, RubyVersion, RubyVersionMismatch, RubygemsIntegration, Runtime, SecurityError, SelfManager, Settings, SimilarityDetector, SocketAddress, SolveFailure, Source, SourceList, SourceMap, SpecSet, Standalone, StubSpecification, TemporaryResourceError, Thor, ThreadCreationError, VirtualProtocolError, Worker, YamlSyntaxError

Constant Summary collapse

ORIGINAL_ENV =
environment_preserver.restore
SUDO_MUTEX =
Thread::Mutex.new
VERSION =
"2.5.6".freeze
WINDOWS =
RbConfig::CONFIG["host_os"] =~ /(msdos|mswin|djgpp|mingw)/
FREEBSD =
RbConfig::CONFIG["host_os"].to_s.include?("bsd")
NULL =
File::NULL

Class Method Summary collapse

Class Method Details

.app_cache(custom_path = nil) ⇒ Object



322
323
324
325
# File 'lib/bundler.rb', line 322

def app_cache(custom_path = nil)
  path = custom_path || root
  Pathname.new(path).join(settings.app_cache_path)
end

.app_config_pathObject



308
309
310
311
312
313
314
315
316
317
318
319
320
# File 'lib/bundler.rb', line 308

def app_config_path
  if app_config = ENV["BUNDLE_APP_CONFIG"]
    app_config_pathname = Pathname.new(app_config)

    if app_config_pathname.absolute?
      app_config_pathname
    else
      app_config_pathname.expand_path(root)
    end
  else
    root.join(".bundle")
  end
end

.bin_pathObject

Returns absolute location of where binstubs are installed to.



116
117
118
119
120
121
122
123
# File 'lib/bundler.rb', line 116

def bin_path
  @bin_path ||= begin
    path = settings[:bin] || "bin"
    path = Pathname.new(path).expand_path(root).expand_path
    mkdir_p(path)
    path
  end
end

.bundle_pathObject

Returns absolute path of where gems are installed on the filesystem.



98
99
100
# File 'lib/bundler.rb', line 98

def bundle_path
  @bundle_path ||= Pathname.new(configured_bundle_path.path).expand_path(root)
end

.bundler_major_versionObject



6
7
8
# File 'lib/bundler/version.rb', line 6

def self.bundler_major_version
  @bundler_major_version ||= VERSION.split(".").first.to_i
end

.clean_envObject

Deprecated.

Use ‘unbundled_env` instead



348
349
350
351
352
353
354
355
356
357
# File 'lib/bundler.rb', line 348

def clean_env
  message =
    "`Bundler.clean_env` has been deprecated in favor of `Bundler.unbundled_env`. " \
    "If you instead want the environment before bundler was originally loaded, use `Bundler.original_env`"
  removed_message =
    "`Bundler.clean_env` has been removed in favor of `Bundler.unbundled_env`. " \
    "If you instead want the environment before bundler was originally loaded, use `Bundler.original_env`"
  Bundler::SharedHelpers.major_deprecation(2, message, removed_message: removed_message, print_caller_location: true)
  unbundled_env
end

.clean_exec(*args) ⇒ Object

Deprecated.

Use ‘unbundled_exec` instead



435
436
437
438
439
440
441
442
443
444
# File 'lib/bundler.rb', line 435

def clean_exec(*args)
  message =
    "`Bundler.clean_exec` has been deprecated in favor of `Bundler.unbundled_exec`. " \
    "If you instead want to exec to a command in the environment before bundler was originally loaded, use `Bundler.original_exec`"
  removed_message =
    "`Bundler.clean_exec` has been removed in favor of `Bundler.unbundled_exec`. " \
    "If you instead want to exec to a command in the environment before bundler was originally loaded, use `Bundler.original_exec`"
  Bundler::SharedHelpers.major_deprecation(2, message, removed_message: removed_message, print_caller_location: true)
  with_env(unbundled_env) { Kernel.exec(*args) }
end

.clean_system(*args) ⇒ Object

Deprecated.

Use ‘unbundled_system` instead



413
414
415
416
417
418
419
420
421
422
# File 'lib/bundler.rb', line 413

def clean_system(*args)
  message =
    "`Bundler.clean_system` has been deprecated in favor of `Bundler.unbundled_system`. " \
    "If you instead want to run the command in the environment before bundler was originally loaded, use `Bundler.original_system`"
  removed_message =
    "`Bundler.clean_system` has been removed in favor of `Bundler.unbundled_system`. " \
    "If you instead want to run the command in the environment before bundler was originally loaded, use `Bundler.original_system`"
  Bundler::SharedHelpers.major_deprecation(2, message, removed_message: removed_message, print_caller_location: true)
  with_env(unbundled_env) { Kernel.system(*args) }
end

.clear_gemspec_cacheObject



550
551
552
# File 'lib/bundler.rb', line 550

def clear_gemspec_cache
  @gemspec_cache = {}
end

.configureObject



84
85
86
# File 'lib/bundler.rb', line 84

def configure
  @configure ||= configure_gem_home_and_path
end

.configure_gem_home_and_path(path = bundle_path) ⇒ Object



596
597
598
599
600
# File 'lib/bundler.rb', line 596

def configure_gem_home_and_path(path = bundle_path)
  configure_gem_path
  configure_gem_home(path)
  Bundler.rubygems.clear_paths
end

.configured_bundle_pathObject



111
112
113
# File 'lib/bundler.rb', line 111

def configured_bundle_path
  @configured_bundle_path ||= settings.path.tap(&:validate!)
end

.create_bundle_pathObject



102
103
104
105
106
107
108
109
# File 'lib/bundler.rb', line 102

def create_bundle_path
  mkdir_p(bundle_path) unless bundle_path.exist?

  @bundle_path = bundle_path.realpath
rescue Errno::EEXIST
  raise PathError, "Could not install to path `#{bundle_path}` " \
    "because a file already exists at that path. Either remove or rename the file so the directory can be created."
end

.current_rubyCurrentRuby

Returns current version of Ruby

Returns:



7
8
9
# File 'lib/bundler/current_ruby.rb', line 7

def self.current_ruby
  @current_ruby ||= CurrentRuby.new
end

.default_bundle_dirObject



464
465
466
# File 'lib/bundler.rb', line 464

def default_bundle_dir
  SharedHelpers.default_bundle_dir
end

.default_gemfileObject



456
457
458
# File 'lib/bundler.rb', line 456

def default_gemfile
  SharedHelpers.default_gemfile
end

.default_lockfileObject



460
461
462
# File 'lib/bundler.rb', line 460

def default_lockfile
  SharedHelpers.default_lockfile
end

.definition(unlock = nil, lockfile = default_lockfile) ⇒ Bundler::Definition

Returns an instance of Bundler::Definition for given Gemfile and lockfile

Parameters:

  • unlock (Hash, Boolean, nil) (defaults to: nil)

    Gems that have been requested to be updated or true if all gems should be updated

  • lockfile (Pathname) (defaults to: default_lockfile)

    Path to Gemfile.lock

Returns:



205
206
207
208
209
210
211
# File 'lib/bundler.rb', line 205

def definition(unlock = nil, lockfile = default_lockfile)
  @definition = nil if unlock
  @definition ||= begin
    configure
    Definition.build(default_gemfile, lockfile, unlock)
  end
end

.environmentObject



194
195
196
197
# File 'lib/bundler.rb', line 194

def environment
  SharedHelpers.major_deprecation 2, "Bundler.environment has been removed in favor of Bundler.load", print_caller_location: true
  load
end

.feature_flagObject



559
560
561
# File 'lib/bundler.rb', line 559

def feature_flag
  @feature_flag ||= FeatureFlag.new(VERSION)
end

.frozen_bundle?Boolean

Returns:

  • (Boolean)


213
214
215
216
217
218
# File 'lib/bundler.rb', line 213

def frozen_bundle?
  frozen = settings[:frozen]
  return frozen unless frozen.nil?

  settings[:deployment]
end

.gem_versionObject



10
11
12
# File 'lib/bundler/version.rb', line 10

def self.gem_version
  @gem_version ||= Gem::Version.create(VERSION)
end

.git_present?Boolean

Returns:

  • (Boolean)


554
555
556
557
# File 'lib/bundler.rb', line 554

def git_present?
  return @git_present if defined?(@git_present)
  @git_present = Bundler.which("git#{RbConfig::CONFIG["EXEEXT"]}")
end

.homeObject



286
287
288
# File 'lib/bundler.rb', line 286

def home
  bundle_path.join("bundler")
end

.install_pathObject



290
291
292
# File 'lib/bundler.rb', line 290

def install_path
  home.join("gems")
end

.loadObject



190
191
192
# File 'lib/bundler.rb', line 190

def load
  @load ||= Runtime.new(root, definition)
end

.load_gemspec(file, validate = false) ⇒ Object



523
524
525
526
527
528
529
530
# File 'lib/bundler.rb', line 523

def load_gemspec(file, validate = false)
  @gemspec_cache ||= {}
  key = File.expand_path(file)
  @gemspec_cache[key] ||= load_gemspec_uncached(file, validate)
  # Protect against caching side-effected gemspecs by returning a
  # new instance each time.
  @gemspec_cache[key]&.dup
end

.load_gemspec_uncached(file, validate = false) ⇒ Object



532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
# File 'lib/bundler.rb', line 532

def load_gemspec_uncached(file, validate = false)
  path = Pathname.new(file)
  contents = read_file(file)
  spec = if contents.start_with?("---") # YAML header
    eval_yaml_gemspec(path, contents)
  else
    # Eval the gemspec from its parent directory, because some gemspecs
    # depend on "./" relative paths.
    SharedHelpers.chdir(path.dirname.to_s) do
      eval_gemspec(path, contents)
    end
  end
  return unless spec
  spec.loaded_from = path.expand_path.to_s
  Bundler.rubygems.validate(spec) if validate
  spec
end

.local_platformObject



451
452
453
454
# File 'lib/bundler.rb', line 451

def local_platform
  return Gem::Platform::RUBY if settings[:force_ruby_platform]
  Gem::Platform.local
end

.locked_gemsObject



220
221
222
223
224
225
226
227
228
# File 'lib/bundler.rb', line 220

def locked_gems
  @locked_gems ||=
    if defined?(@definition) && @definition
      definition.locked_gems
    elsif Bundler.default_lockfile.file?
      lock = Bundler.read_file(Bundler.default_lockfile)
      LockfileParser.new(lock)
    end
end

.mkdir_p(path) ⇒ Object



485
486
487
488
489
# File 'lib/bundler.rb', line 485

def mkdir_p(path)
  SharedHelpers.filesystem_access(path, :write) do |p|
    FileUtils.mkdir_p(p)
  end
end

.most_specific_locked_platform?(platform) ⇒ Boolean

Returns:

  • (Boolean)


230
231
232
233
234
# File 'lib/bundler.rb', line 230

def most_specific_locked_platform?(platform)
  return false unless defined?(@definition) && @definition

  definition.most_specific_locked_platform == platform
end

.original_envHash

Returns Environment present before Bundler was activated.

Returns:

  • (Hash)

    Environment present before Bundler was activated



343
344
345
# File 'lib/bundler.rb', line 343

def original_env
  ORIGINAL_ENV.clone
end

.original_exec(*args) ⇒ Object

Run a ‘Kernel.exec` to a subcommand with the environment present before Bundler was activated



430
431
432
# File 'lib/bundler.rb', line 430

def original_exec(*args)
  with_original_env { Kernel.exec(*args) }
end

.original_system(*args) ⇒ Object

Run subcommand with the environment present before Bundler was activated



408
409
410
# File 'lib/bundler.rb', line 408

def original_system(*args)
  with_original_env { Kernel.system(*args) }
end

.preferred_gemfile_nameObject



477
478
479
# File 'lib/bundler.rb', line 477

def preferred_gemfile_name
  Bundler.settings[:init_gems_rb] ? "gems.rb" : "Gemfile"
end

.read_file(file) ⇒ Object



504
505
506
507
508
# File 'lib/bundler.rb', line 504

def read_file(file)
  SharedHelpers.filesystem_access(file, :read) do
    File.open(file, "r:UTF-8", &:read)
  end
end

.require(*groups) ⇒ Object

Setups Bundler environment (see Bundler.setup) if it is not already set, and loads all gems from groups specified. Unlike ::setup, can be called multiple times with different groups (if they were allowed by setup).

Assuming Gemfile

gem 'first_gem', '= 1.0'
group :test do
  gem 'second_gem', '= 1.0'
end

The code will work as follows:

Bundler.setup # allow all groups
Bundler.require(:default) # requires only first_gem
# ...later
Bundler.require(:test)   # requires second_gem


186
187
188
# File 'lib/bundler.rb', line 186

def require(*groups)
  setup(*groups).require(*groups)
end

.require_thor_actionsObject



4
5
6
# File 'lib/bundler/vendored_thor.rb', line 4

def self.require_thor_actions
  require_relative "vendor/thor/lib/thor/actions"
end

.reset!Object



563
564
565
566
567
# File 'lib/bundler.rb', line 563

def reset!
  reset_paths!
  Plugin.reset!
  reset_rubygems!
end

.reset_paths!Object



574
575
576
577
578
579
580
581
582
583
584
585
586
587
# File 'lib/bundler.rb', line 574

def reset_paths!
  @bin_path = nil
  @bundler_major_version = nil
  @bundle_path = nil
  @configure = nil
  @configured_bundle_path = nil
  @definition = nil
  @load = nil
  @locked_gems = nil
  @root = nil
  @settings = nil
  @setup = nil
  @user_home = nil
end

.reset_rubygems!Object



589
590
591
592
593
594
# File 'lib/bundler.rb', line 589

def reset_rubygems!
  return unless defined?(@rubygems) && @rubygems
  rubygems.undo_replacements
  rubygems.reset
  @rubygems = nil
end

.reset_settings_and_root!Object



569
570
571
572
# File 'lib/bundler.rb', line 569

def reset_settings_and_root!
  @settings = nil
  @root = nil
end

.rm_rf(path) ⇒ Object



332
333
334
# File 'lib/bundler.rb', line 332

def rm_rf(path)
  FileUtils.remove_entry_secure(path) if path && File.exist?(path)
end

.rootObject



298
299
300
301
302
303
304
305
306
# File 'lib/bundler.rb', line 298

def root
  @root ||= begin
              SharedHelpers.root
            rescue GemfileNotFound
              bundle_dir = default_bundle_dir
              raise GemfileNotFound, "Could not locate Gemfile or .bundle/ directory" unless bundle_dir
              Pathname.new(File.expand_path("..", bundle_dir))
            end
end

.ruby_scopeObject



236
237
238
# File 'lib/bundler.rb', line 236

def ruby_scope
  "#{Bundler.rubygems.ruby_engine}/#{RbConfig::CONFIG["ruby_version"]}"
end

.rubygemsObject



490
491
492
# File 'lib/bundler/rubygems_integration.rb', line 490

def self.rubygems
  @rubygems ||= RubygemsIntegration.new
end

.safe_load_marshal(data) ⇒ Object



510
511
512
513
514
515
516
517
518
519
520
521
# File 'lib/bundler.rb', line 510

def safe_load_marshal(data)
  if Gem.respond_to?(:load_safe_marshal)
    Gem.load_safe_marshal
    begin
      Gem::SafeMarshal.safe_load(data)
    rescue Gem::SafeMarshal::Reader::Error, Gem::SafeMarshal::Visitors::ToRuby::Error => e
      raise MarshalError, "#{e.class}: #{e.message}"
    end
  else
    load_marshal(data, marshal_proc: SafeMarshal.proc)
  end
end

.self_managerObject



602
603
604
605
606
607
# File 'lib/bundler.rb', line 602

def self_manager
  @self_manager ||= begin
                      require_relative "bundler/self_manager"
                      Bundler::SelfManager.new
                    end
end

.settingsObject



336
337
338
339
340
# File 'lib/bundler.rb', line 336

def settings
  @settings ||= Settings.new(app_config_path)
rescue GemfileNotFound
  @settings = Settings.new(Pathname.new(".bundle").expand_path)
end

.setup(*groups) ⇒ Object

Turns on the Bundler runtime. After Bundler.setup call, all load or require of the gems would be allowed only if they are part of the Gemfile or Ruby’s standard library. If the versions specified in Gemfile, only those versions would be loaded.

Assuming Gemfile

gem 'first_gem', '= 1.0'
group :test do
  gem 'second_gem', '= 1.0'
end

The code using Bundler.setup works as follows:

require 'third_gem' # allowed, required from global gems
require 'first_gem' # allowed, loads the last installed version
Bundler.setup
require 'fourth_gem' # fails with LoadError
require 'second_gem' # loads exactly version 1.0

Bundler.setup can be called only once, all subsequent calls are no-op.

If groups list is provided, only gems from specified groups would be allowed (gems specified outside groups belong to special :default group).

To require all gems from Gemfile (or only some groups), see Bundler.require.



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
# File 'lib/bundler.rb', line 152

def setup(*groups)
  # Return if all groups are already loaded
  return @setup if defined?(@setup) && @setup

  definition.validate_runtime!

  SharedHelpers.print_major_deprecations!

  if groups.empty?
    # Load all groups, but only once
    @setup = load.setup
  else
    load.setup(*groups)
  end
end

.specs_pathObject



294
295
296
# File 'lib/bundler.rb', line 294

def specs_path
  bundle_path.join("specifications")
end

.system_bindirObject



468
469
470
471
472
473
474
475
# File 'lib/bundler.rb', line 468

def system_bindir
  # Gem.bindir doesn't always return the location that RubyGems will install
  # system binaries. If you put '-n foo' in your .gemrc, RubyGems will
  # install binstubs there instead. Unfortunately, RubyGems doesn't expose
  # that directory at all, so rather than parse .gemrc ourselves, we allow
  # the directory to be set as well, via `bundle config set --local bindir foo`.
  Bundler.settings[:system_bindir] || Bundler.rubygems.gem_bindir
end

.tmp(name = Process.pid.to_s) ⇒ Object



327
328
329
330
# File 'lib/bundler.rb', line 327

def tmp(name = Process.pid.to_s)
  Kernel.send(:require, "tmpdir")
  Pathname.new(Dir.mktmpdir(["bundler", name]))
end

.uiObject



88
89
90
# File 'lib/bundler.rb', line 88

def ui
  (defined?(@ui) && @ui) || (self.ui = UI::Shell.new)
end

.ui=(ui) ⇒ Object



92
93
94
95
# File 'lib/bundler.rb', line 92

def ui=(ui)
  Bundler.rubygems.ui = UI::RGProxy.new(ui)
  @ui = ui
end

.unbundled_envHash

Returns Environment with all bundler-related variables removed.

Returns:

  • (Hash)

    Environment with all bundler-related variables removed



360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
# File 'lib/bundler.rb', line 360

def unbundled_env
  env = original_env

  if env.key?("BUNDLER_ORIG_MANPATH")
    env["MANPATH"] = env["BUNDLER_ORIG_MANPATH"]
  end

  env.delete_if {|k, _| k[0, 7] == "BUNDLE_" }

  if env.key?("RUBYOPT")
    rubyopt = env["RUBYOPT"].split(" ")
    rubyopt.delete("-r#{File.expand_path("bundler/setup", __dir__)}")
    rubyopt.delete("-rbundler/setup")
    env["RUBYOPT"] = rubyopt.join(" ")
  end

  if env.key?("RUBYLIB")
    rubylib = env["RUBYLIB"].split(File::PATH_SEPARATOR)
    rubylib.delete(__dir__)
    env["RUBYLIB"] = rubylib.join(File::PATH_SEPARATOR)
  end

  env
end

.unbundled_exec(*args) ⇒ Object

Run a ‘Kernel.exec` to a subcommand in an environment with all bundler related variables removed



447
448
449
# File 'lib/bundler.rb', line 447

def unbundled_exec(*args)
  with_env(unbundled_env) { Kernel.exec(*args) }
end

.unbundled_system(*args) ⇒ Object

Run subcommand in an environment with all bundler related variables removed



425
426
427
# File 'lib/bundler.rb', line 425

def unbundled_system(*args)
  with_unbundled_env { Kernel.system(*args) }
end

.URI(uri) ⇒ Object

Returns a Bundler::URI object derived from the given uri, which may be a Bundler::URI string or an existing Bundler::URI object:

# Returns a new Bundler::URI.
uri = Bundler::URI('http://github.com/ruby/ruby')
# => #<Bundler::URI::HTTP http://github.com/ruby/ruby>
# Returns the given Bundler::URI.
Bundler::URI(uri)
# => #<Bundler::URI::HTTP http://github.com/ruby/ruby>


842
843
844
845
846
847
848
849
850
851
# File 'lib/bundler/vendor/uri/lib/uri/common.rb', line 842

def URI(uri)
  if uri.is_a?(Bundler::URI::Generic)
    uri
  elsif uri = String.try_convert(uri)
    Bundler::URI.parse(uri)
  else
    raise ArgumentError,
      "bad argument (expected Bundler::URI object or Bundler::URI string)"
  end
end

.use_system_gems?Boolean

Returns:

  • (Boolean)


481
482
483
# File 'lib/bundler.rb', line 481

def use_system_gems?
  configured_bundle_path.use_system_gems?
end

.user_bundle_path(dir = "home") ⇒ Object



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
# File 'lib/bundler.rb', line 264

def user_bundle_path(dir = "home")
  env_var, fallback = case dir
                      when "home"
                        ["BUNDLE_USER_HOME", proc { Pathname.new(user_home).join(".bundle") }]
                      when "cache"
                        ["BUNDLE_USER_CACHE", proc { user_bundle_path.join("cache") }]
                      when "config"
                        ["BUNDLE_USER_CONFIG", proc { user_bundle_path.join("config") }]
                      when "plugin"
                        ["BUNDLE_USER_PLUGIN", proc { user_bundle_path.join("plugin") }]
                      else
                        raise BundlerError, "Unknown user path requested: #{dir}"
  end
  # `fallback` will already be a Pathname, but Pathname.new() is
  # idempotent so it's OK
  Pathname.new(ENV.fetch(env_var, &fallback))
end

.user_cacheObject



282
283
284
# File 'lib/bundler.rb', line 282

def user_cache
  user_bundle_path("cache")
end

.user_homeObject



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
# File 'lib/bundler.rb', line 240

def user_home
  @user_home ||= begin
    home = Bundler.rubygems.user_home
    bundle_home = home ? File.join(home, ".bundle") : nil

    warning = if home.nil?
      "Your home directory is not set."
    elsif !File.directory?(home)
      "`#{home}` is not a directory."
    elsif !File.writable?(home) && (!File.directory?(bundle_home) || !File.writable?(bundle_home))
      "`#{home}` is not writable."
    end

    if warning
      Bundler.ui.warn "#{warning}\n"
      user_home = tmp_home_path
      Bundler.ui.warn "Bundler will use `#{user_home}' as your home directory temporarily.\n"
      user_home
    else
      Pathname.new(home)
    end
  end
end

.which(executable) ⇒ Object



491
492
493
494
495
496
497
498
499
500
501
502
# File 'lib/bundler.rb', line 491

def which(executable)
  if File.file?(executable) && File.executable?(executable)
    executable
  elsif paths = ENV["PATH"]
    quote = '"'
    paths.split(File::PATH_SEPARATOR).find do |path|
      path = path[1..-2] if path.start_with?(quote) && path.end_with?(quote)
      executable_path = File.expand_path(executable, path)
      return executable_path if File.file?(executable_path) && File.executable?(executable_path)
    end
  end
end

.with_clean_envObject

Deprecated.

Use ‘with_unbundled_env` instead



391
392
393
394
395
396
397
398
399
400
# File 'lib/bundler.rb', line 391

def with_clean_env
  message =
    "`Bundler.with_clean_env` has been deprecated in favor of `Bundler.with_unbundled_env`. " \
    "If you instead want the environment before bundler was originally loaded, use `Bundler.with_original_env`"
  removed_message =
    "`Bundler.with_clean_env` has been removed in favor of `Bundler.with_unbundled_env`. " \
    "If you instead want the environment before bundler was originally loaded, use `Bundler.with_original_env`"
  Bundler::SharedHelpers.major_deprecation(2, message, removed_message: removed_message, print_caller_location: true)
  with_env(unbundled_env) { yield }
end

.with_friendly_errorsObject



115
116
117
118
119
120
121
122
123
124
125
# File 'lib/bundler/friendly_errors.rb', line 115

def self.with_friendly_errors
  FriendlyErrors.enable!
  yield
rescue SignalException
  raise
rescue Exception => e # rubocop:disable Lint/RescueException
  raise if FriendlyErrors.disabled?

  FriendlyErrors.log_error(e)
  exit FriendlyErrors.exit_status(e)
end

.with_original_envObject

Run block with environment present before Bundler was activated



386
387
388
# File 'lib/bundler.rb', line 386

def with_original_env
  with_env(original_env) { yield }
end

.with_unbundled_envObject

Run block with all bundler-related variables removed



403
404
405
# File 'lib/bundler.rb', line 403

def with_unbundled_env
  with_env(unbundled_env) { yield }
end