bundler-plus 4.0.15
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/CHANGELOG.md +5670 -0
- data/LICENSE.md +22 -0
- data/README.md +58 -0
- data/bundler.gemspec +46 -0
- data/exe/bundle +29 -0
- data/exe/bundler +4 -0
- data/lib/bundler/.document +1 -0
- data/lib/bundler/build_metadata.rb +44 -0
- data/lib/bundler/capistrano.rb +4 -0
- data/lib/bundler/checksum.rb +270 -0
- data/lib/bundler/ci_detector.rb +75 -0
- data/lib/bundler/cli/add.rb +62 -0
- data/lib/bundler/cli/binstubs.rb +57 -0
- data/lib/bundler/cli/cache.rb +32 -0
- data/lib/bundler/cli/check.rb +40 -0
- data/lib/bundler/cli/clean.rb +25 -0
- data/lib/bundler/cli/common.rb +161 -0
- data/lib/bundler/cli/config.rb +208 -0
- data/lib/bundler/cli/console.rb +47 -0
- data/lib/bundler/cli/doctor/diagnose.rb +167 -0
- data/lib/bundler/cli/doctor/ssl.rb +249 -0
- data/lib/bundler/cli/doctor.rb +33 -0
- data/lib/bundler/cli/exec.rb +114 -0
- data/lib/bundler/cli/fund.rb +36 -0
- data/lib/bundler/cli/gem.rb +493 -0
- data/lib/bundler/cli/info.rb +83 -0
- data/lib/bundler/cli/init.rb +51 -0
- data/lib/bundler/cli/install.rb +127 -0
- data/lib/bundler/cli/issue.rb +41 -0
- data/lib/bundler/cli/list.rb +97 -0
- data/lib/bundler/cli/lock.rb +94 -0
- data/lib/bundler/cli/open.rb +29 -0
- data/lib/bundler/cli/outdated.rb +337 -0
- data/lib/bundler/cli/platform.rb +48 -0
- data/lib/bundler/cli/plugin.rb +39 -0
- data/lib/bundler/cli/pristine.rb +64 -0
- data/lib/bundler/cli/remove.rb +17 -0
- data/lib/bundler/cli/show.rb +71 -0
- data/lib/bundler/cli/update.rb +125 -0
- data/lib/bundler/cli.rb +829 -0
- data/lib/bundler/compact_index_client/cache.rb +96 -0
- data/lib/bundler/compact_index_client/cache_file.rb +148 -0
- data/lib/bundler/compact_index_client/parser.rb +87 -0
- data/lib/bundler/compact_index_client/updater.rb +105 -0
- data/lib/bundler/compact_index_client.rb +92 -0
- data/lib/bundler/constants.rb +14 -0
- data/lib/bundler/current_ruby.rb +94 -0
- data/lib/bundler/definition.rb +1304 -0
- data/lib/bundler/dependency.rb +151 -0
- data/lib/bundler/deployment.rb +6 -0
- data/lib/bundler/deprecate.rb +44 -0
- data/lib/bundler/digest.rb +71 -0
- data/lib/bundler/dsl.rb +642 -0
- data/lib/bundler/endpoint_specification.rb +184 -0
- data/lib/bundler/env.rb +148 -0
- data/lib/bundler/environment_preserver.rb +69 -0
- data/lib/bundler/errors.rb +277 -0
- data/lib/bundler/feature_flag.rb +20 -0
- data/lib/bundler/fetcher/base.rb +55 -0
- data/lib/bundler/fetcher/compact_index.rb +133 -0
- data/lib/bundler/fetcher/dependency.rb +85 -0
- data/lib/bundler/fetcher/downloader.rb +116 -0
- data/lib/bundler/fetcher/gem_remote_fetcher.rb +24 -0
- data/lib/bundler/fetcher/index.rb +25 -0
- data/lib/bundler/fetcher.rb +365 -0
- data/lib/bundler/force_platform.rb +16 -0
- data/lib/bundler/friendly_errors.rb +127 -0
- data/lib/bundler/gem_helper.rb +237 -0
- data/lib/bundler/gem_tasks.rb +7 -0
- data/lib/bundler/gem_version_promoter.rb +147 -0
- data/lib/bundler/index.rb +203 -0
- data/lib/bundler/injector.rb +284 -0
- data/lib/bundler/inline.rb +106 -0
- data/lib/bundler/installer/gem_installer.rb +88 -0
- data/lib/bundler/installer/parallel_installer.rb +280 -0
- data/lib/bundler/installer/standalone.rb +113 -0
- data/lib/bundler/installer.rb +241 -0
- data/lib/bundler/lazy_specification.rb +270 -0
- data/lib/bundler/lockfile_generator.rb +119 -0
- data/lib/bundler/lockfile_parser.rb +328 -0
- data/lib/bundler/man/.document +1 -0
- data/lib/bundler/man/bundle-add.1 +79 -0
- data/lib/bundler/man/bundle-add.1.ronn +92 -0
- data/lib/bundler/man/bundle-binstubs.1 +30 -0
- data/lib/bundler/man/bundle-binstubs.1.ronn +42 -0
- data/lib/bundler/man/bundle-cache.1 +56 -0
- data/lib/bundler/man/bundle-cache.1.ronn +95 -0
- data/lib/bundler/man/bundle-check.1 +21 -0
- data/lib/bundler/man/bundle-check.1.ronn +26 -0
- data/lib/bundler/man/bundle-clean.1 +17 -0
- data/lib/bundler/man/bundle-clean.1.ronn +18 -0
- data/lib/bundler/man/bundle-config.1 +339 -0
- data/lib/bundler/man/bundle-config.1.ronn +455 -0
- data/lib/bundler/man/bundle-console.1 +33 -0
- data/lib/bundler/man/bundle-console.1.ronn +39 -0
- data/lib/bundler/man/bundle-doctor.1 +69 -0
- data/lib/bundler/man/bundle-doctor.1.ronn +77 -0
- data/lib/bundler/man/bundle-env.1 +9 -0
- data/lib/bundler/man/bundle-env.1.ronn +10 -0
- data/lib/bundler/man/bundle-exec.1 +104 -0
- data/lib/bundler/man/bundle-exec.1.ronn +150 -0
- data/lib/bundler/man/bundle-fund.1 +22 -0
- data/lib/bundler/man/bundle-fund.1.ronn +25 -0
- data/lib/bundler/man/bundle-gem.1 +107 -0
- data/lib/bundler/man/bundle-gem.1.ronn +150 -0
- data/lib/bundler/man/bundle-help.1 +9 -0
- data/lib/bundler/man/bundle-help.1.ronn +12 -0
- data/lib/bundler/man/bundle-info.1 +17 -0
- data/lib/bundler/man/bundle-info.1.ronn +21 -0
- data/lib/bundler/man/bundle-init.1 +20 -0
- data/lib/bundler/man/bundle-init.1.ronn +32 -0
- data/lib/bundler/man/bundle-install.1 +178 -0
- data/lib/bundler/man/bundle-install.1.ronn +314 -0
- data/lib/bundler/man/bundle-issue.1 +45 -0
- data/lib/bundler/man/bundle-issue.1.ronn +37 -0
- data/lib/bundler/man/bundle-licenses.1 +9 -0
- data/lib/bundler/man/bundle-licenses.1.ronn +10 -0
- data/lib/bundler/man/bundle-list.1 +40 -0
- data/lib/bundler/man/bundle-list.1.ronn +41 -0
- data/lib/bundler/man/bundle-lock.1 +75 -0
- data/lib/bundler/man/bundle-lock.1.ronn +115 -0
- data/lib/bundler/man/bundle-open.1 +32 -0
- data/lib/bundler/man/bundle-open.1.ronn +28 -0
- data/lib/bundler/man/bundle-outdated.1 +106 -0
- data/lib/bundler/man/bundle-outdated.1.ronn +117 -0
- data/lib/bundler/man/bundle-platform.1 +49 -0
- data/lib/bundler/man/bundle-platform.1.ronn +49 -0
- data/lib/bundler/man/bundle-plugin.1 +76 -0
- data/lib/bundler/man/bundle-plugin.1.ronn +84 -0
- data/lib/bundler/man/bundle-pristine.1 +23 -0
- data/lib/bundler/man/bundle-pristine.1.ronn +34 -0
- data/lib/bundler/man/bundle-remove.1 +15 -0
- data/lib/bundler/man/bundle-remove.1.ronn +16 -0
- data/lib/bundler/man/bundle-show.1 +16 -0
- data/lib/bundler/man/bundle-show.1.ronn +21 -0
- data/lib/bundler/man/bundle-update.1 +284 -0
- data/lib/bundler/man/bundle-update.1.ronn +367 -0
- data/lib/bundler/man/bundle-version.1 +22 -0
- data/lib/bundler/man/bundle-version.1.ronn +24 -0
- data/lib/bundler/man/bundle.1 +93 -0
- data/lib/bundler/man/bundle.1.ronn +107 -0
- data/lib/bundler/man/gemfile.5 +503 -0
- data/lib/bundler/man/gemfile.5.ronn +586 -0
- data/lib/bundler/man/index.txt +31 -0
- data/lib/bundler/match_metadata.rb +30 -0
- data/lib/bundler/match_platform.rb +42 -0
- data/lib/bundler/match_remote_metadata.rb +29 -0
- data/lib/bundler/materialization.rb +59 -0
- data/lib/bundler/mirror.rb +221 -0
- data/lib/bundler/plugin/api/source.rb +330 -0
- data/lib/bundler/plugin/api.rb +81 -0
- data/lib/bundler/plugin/dsl.rb +53 -0
- data/lib/bundler/plugin/events.rb +85 -0
- data/lib/bundler/plugin/index.rb +203 -0
- data/lib/bundler/plugin/installer/git.rb +34 -0
- data/lib/bundler/plugin/installer/path.rb +26 -0
- data/lib/bundler/plugin/installer/rubygems.rb +19 -0
- data/lib/bundler/plugin/installer.rb +123 -0
- data/lib/bundler/plugin/source_list.rb +31 -0
- data/lib/bundler/plugin/unloaded_source.rb +25 -0
- data/lib/bundler/plugin.rb +387 -0
- data/lib/bundler/process_lock.rb +20 -0
- data/lib/bundler/remote_specification.rb +126 -0
- data/lib/bundler/resolver/base.rb +127 -0
- data/lib/bundler/resolver/candidate.rb +85 -0
- data/lib/bundler/resolver/incompatibility.rb +15 -0
- data/lib/bundler/resolver/package.rb +95 -0
- data/lib/bundler/resolver/root.rb +25 -0
- data/lib/bundler/resolver/spec_group.rb +74 -0
- data/lib/bundler/resolver/strategy.rb +43 -0
- data/lib/bundler/resolver.rb +603 -0
- data/lib/bundler/retry.rb +92 -0
- data/lib/bundler/ruby_dsl.rb +67 -0
- data/lib/bundler/ruby_version.rb +135 -0
- data/lib/bundler/rubygems_ext.rb +503 -0
- data/lib/bundler/rubygems_gem_installer.rb +206 -0
- data/lib/bundler/rubygems_integration.rb +456 -0
- data/lib/bundler/runtime.rb +331 -0
- data/lib/bundler/safe_marshal.rb +31 -0
- data/lib/bundler/self_manager.rb +197 -0
- data/lib/bundler/settings/validator.rb +86 -0
- data/lib/bundler/settings.rb +585 -0
- data/lib/bundler/setup.rb +39 -0
- data/lib/bundler/shared_helpers.rb +392 -0
- data/lib/bundler/source/gemspec.rb +19 -0
- data/lib/bundler/source/git/git_proxy.rb +509 -0
- data/lib/bundler/source/git.rb +451 -0
- data/lib/bundler/source/metadata.rb +67 -0
- data/lib/bundler/source/path/installer.rb +53 -0
- data/lib/bundler/source/path.rb +256 -0
- data/lib/bundler/source/rubygems/remote.rb +86 -0
- data/lib/bundler/source/rubygems.rb +606 -0
- data/lib/bundler/source/rubygems_aggregate.rb +71 -0
- data/lib/bundler/source.rb +120 -0
- data/lib/bundler/source_list.rb +240 -0
- data/lib/bundler/source_map.rb +72 -0
- data/lib/bundler/spec_set.rb +390 -0
- data/lib/bundler/stub_specification.rb +147 -0
- data/lib/bundler/templates/.document +1 -0
- data/lib/bundler/templates/Executable +16 -0
- data/lib/bundler/templates/Executable.standalone +14 -0
- data/lib/bundler/templates/Gemfile +5 -0
- data/lib/bundler/templates/newgem/CHANGELOG.md.tt +5 -0
- data/lib/bundler/templates/newgem/CODE_OF_CONDUCT.md.tt +10 -0
- data/lib/bundler/templates/newgem/Cargo.toml.tt +13 -0
- data/lib/bundler/templates/newgem/Gemfile.tt +24 -0
- data/lib/bundler/templates/newgem/LICENSE.txt.tt +21 -0
- data/lib/bundler/templates/newgem/README.md.tt +49 -0
- data/lib/bundler/templates/newgem/Rakefile.tt +72 -0
- data/lib/bundler/templates/newgem/bin/console.tt +11 -0
- data/lib/bundler/templates/newgem/bin/setup.tt +8 -0
- data/lib/bundler/templates/newgem/circleci/config.yml.tt +37 -0
- data/lib/bundler/templates/newgem/exe/newgem.tt +3 -0
- data/lib/bundler/templates/newgem/ext/newgem/Cargo.toml.tt +22 -0
- data/lib/bundler/templates/newgem/ext/newgem/build.rs.tt +5 -0
- data/lib/bundler/templates/newgem/ext/newgem/extconf-c.rb.tt +10 -0
- data/lib/bundler/templates/newgem/ext/newgem/extconf-go.rb.tt +11 -0
- data/lib/bundler/templates/newgem/ext/newgem/extconf-rust.rb.tt +6 -0
- data/lib/bundler/templates/newgem/ext/newgem/go.mod.tt +5 -0
- data/lib/bundler/templates/newgem/ext/newgem/newgem-go.c.tt +2 -0
- data/lib/bundler/templates/newgem/ext/newgem/newgem.c.tt +9 -0
- data/lib/bundler/templates/newgem/ext/newgem/newgem.go.tt +31 -0
- data/lib/bundler/templates/newgem/ext/newgem/newgem.h.tt +6 -0
- data/lib/bundler/templates/newgem/ext/newgem/src/lib.rs.tt +23 -0
- data/lib/bundler/templates/newgem/github/workflows/build-gems.yml.tt +69 -0
- data/lib/bundler/templates/newgem/github/workflows/main.yml.tt +48 -0
- data/lib/bundler/templates/newgem/gitignore.tt +23 -0
- data/lib/bundler/templates/newgem/gitlab-ci.yml.tt +27 -0
- data/lib/bundler/templates/newgem/lib/newgem/version.rb.tt +9 -0
- data/lib/bundler/templates/newgem/lib/newgem.rb.tt +15 -0
- data/lib/bundler/templates/newgem/newgem.gemspec.tt +58 -0
- data/lib/bundler/templates/newgem/rspec.tt +3 -0
- data/lib/bundler/templates/newgem/rubocop.yml.tt +8 -0
- data/lib/bundler/templates/newgem/sig/newgem.rbs.tt +8 -0
- data/lib/bundler/templates/newgem/spec/newgem_spec.rb.tt +19 -0
- data/lib/bundler/templates/newgem/spec/spec_helper.rb.tt +15 -0
- data/lib/bundler/templates/newgem/standard.yml.tt +3 -0
- data/lib/bundler/templates/newgem/test/minitest/test_helper.rb.tt +6 -0
- data/lib/bundler/templates/newgem/test/minitest/test_newgem.rb.tt +19 -0
- data/lib/bundler/templates/newgem/test/test-unit/newgem_test.rb.tt +15 -0
- data/lib/bundler/templates/newgem/test/test-unit/test_helper.rb.tt +6 -0
- data/lib/bundler/ui/rg_proxy.rb +19 -0
- data/lib/bundler/ui/shell.rb +191 -0
- data/lib/bundler/ui/silent.rb +96 -0
- data/lib/bundler/ui.rb +9 -0
- data/lib/bundler/uri_credentials_filter.rb +43 -0
- data/lib/bundler/uri_normalizer.rb +23 -0
- data/lib/bundler/vendor/.document +1 -0
- data/lib/bundler/vendor/connection_pool/LICENSE +20 -0
- data/lib/bundler/vendor/connection_pool/lib/connection_pool/timed_stack.rb +227 -0
- data/lib/bundler/vendor/connection_pool/lib/connection_pool/version.rb +3 -0
- data/lib/bundler/vendor/connection_pool/lib/connection_pool/wrapper.rb +56 -0
- data/lib/bundler/vendor/connection_pool/lib/connection_pool.rb +230 -0
- data/lib/bundler/vendor/fileutils/COPYING +56 -0
- data/lib/bundler/vendor/fileutils/lib/fileutils.rb +2701 -0
- data/lib/bundler/vendor/net-http-persistent/README.rdoc +82 -0
- data/lib/bundler/vendor/net-http-persistent/lib/net/http/persistent/connection.rb +41 -0
- data/lib/bundler/vendor/net-http-persistent/lib/net/http/persistent/pool.rb +65 -0
- data/lib/bundler/vendor/net-http-persistent/lib/net/http/persistent/timed_stack_multi.rb +80 -0
- data/lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb +1153 -0
- data/lib/bundler/vendor/pub_grub/LICENSE.txt +21 -0
- data/lib/bundler/vendor/pub_grub/lib/pub_grub/assignment.rb +20 -0
- data/lib/bundler/vendor/pub_grub/lib/pub_grub/basic_package_source.rb +169 -0
- data/lib/bundler/vendor/pub_grub/lib/pub_grub/failure_writer.rb +182 -0
- data/lib/bundler/vendor/pub_grub/lib/pub_grub/incompatibility.rb +150 -0
- data/lib/bundler/vendor/pub_grub/lib/pub_grub/package.rb +43 -0
- data/lib/bundler/vendor/pub_grub/lib/pub_grub/partial_solution.rb +121 -0
- data/lib/bundler/vendor/pub_grub/lib/pub_grub/rubygems.rb +45 -0
- data/lib/bundler/vendor/pub_grub/lib/pub_grub/solve_failure.rb +19 -0
- data/lib/bundler/vendor/pub_grub/lib/pub_grub/static_package_source.rb +61 -0
- data/lib/bundler/vendor/pub_grub/lib/pub_grub/strategy.rb +42 -0
- data/lib/bundler/vendor/pub_grub/lib/pub_grub/term.rb +105 -0
- data/lib/bundler/vendor/pub_grub/lib/pub_grub/version.rb +3 -0
- data/lib/bundler/vendor/pub_grub/lib/pub_grub/version_constraint.rb +129 -0
- data/lib/bundler/vendor/pub_grub/lib/pub_grub/version_range.rb +423 -0
- data/lib/bundler/vendor/pub_grub/lib/pub_grub/version_solver.rb +236 -0
- data/lib/bundler/vendor/pub_grub/lib/pub_grub/version_union.rb +178 -0
- data/lib/bundler/vendor/pub_grub/lib/pub_grub.rb +31 -0
- data/lib/bundler/vendor/securerandom/COPYING +56 -0
- data/lib/bundler/vendor/securerandom/lib/securerandom.rb +102 -0
- data/lib/bundler/vendor/thor/LICENSE.md +20 -0
- data/lib/bundler/vendor/thor/lib/thor/actions/create_file.rb +105 -0
- data/lib/bundler/vendor/thor/lib/thor/actions/create_link.rb +61 -0
- data/lib/bundler/vendor/thor/lib/thor/actions/directory.rb +108 -0
- data/lib/bundler/vendor/thor/lib/thor/actions/empty_directory.rb +143 -0
- data/lib/bundler/vendor/thor/lib/thor/actions/file_manipulation.rb +407 -0
- data/lib/bundler/vendor/thor/lib/thor/actions/inject_into_file.rb +130 -0
- data/lib/bundler/vendor/thor/lib/thor/actions.rb +340 -0
- data/lib/bundler/vendor/thor/lib/thor/base.rb +825 -0
- data/lib/bundler/vendor/thor/lib/thor/command.rb +151 -0
- data/lib/bundler/vendor/thor/lib/thor/core_ext/hash_with_indifferent_access.rb +107 -0
- data/lib/bundler/vendor/thor/lib/thor/error.rb +106 -0
- data/lib/bundler/vendor/thor/lib/thor/group.rb +292 -0
- data/lib/bundler/vendor/thor/lib/thor/invocation.rb +178 -0
- data/lib/bundler/vendor/thor/lib/thor/line_editor/basic.rb +37 -0
- data/lib/bundler/vendor/thor/lib/thor/line_editor/readline.rb +88 -0
- data/lib/bundler/vendor/thor/lib/thor/line_editor.rb +17 -0
- data/lib/bundler/vendor/thor/lib/thor/nested_context.rb +29 -0
- data/lib/bundler/vendor/thor/lib/thor/parser/argument.rb +86 -0
- data/lib/bundler/vendor/thor/lib/thor/parser/arguments.rb +195 -0
- data/lib/bundler/vendor/thor/lib/thor/parser/option.rb +178 -0
- data/lib/bundler/vendor/thor/lib/thor/parser/options.rb +294 -0
- data/lib/bundler/vendor/thor/lib/thor/parser.rb +4 -0
- data/lib/bundler/vendor/thor/lib/thor/rake_compat.rb +72 -0
- data/lib/bundler/vendor/thor/lib/thor/runner.rb +335 -0
- data/lib/bundler/vendor/thor/lib/thor/shell/basic.rb +384 -0
- data/lib/bundler/vendor/thor/lib/thor/shell/color.rb +112 -0
- data/lib/bundler/vendor/thor/lib/thor/shell/column_printer.rb +29 -0
- data/lib/bundler/vendor/thor/lib/thor/shell/html.rb +81 -0
- data/lib/bundler/vendor/thor/lib/thor/shell/table_printer.rb +118 -0
- data/lib/bundler/vendor/thor/lib/thor/shell/terminal.rb +42 -0
- data/lib/bundler/vendor/thor/lib/thor/shell/wrapped_printer.rb +38 -0
- data/lib/bundler/vendor/thor/lib/thor/shell.rb +81 -0
- data/lib/bundler/vendor/thor/lib/thor/util.rb +285 -0
- data/lib/bundler/vendor/thor/lib/thor/version.rb +3 -0
- data/lib/bundler/vendor/thor/lib/thor.rb +674 -0
- data/lib/bundler/vendor/tsort/LICENSE.txt +22 -0
- data/lib/bundler/vendor/tsort/lib/tsort.rb +455 -0
- data/lib/bundler/vendor/uri/COPYING +56 -0
- data/lib/bundler/vendor/uri/lib/uri/common.rb +922 -0
- data/lib/bundler/vendor/uri/lib/uri/file.rb +100 -0
- data/lib/bundler/vendor/uri/lib/uri/ftp.rb +267 -0
- data/lib/bundler/vendor/uri/lib/uri/generic.rb +1592 -0
- data/lib/bundler/vendor/uri/lib/uri/http.rb +137 -0
- data/lib/bundler/vendor/uri/lib/uri/https.rb +23 -0
- data/lib/bundler/vendor/uri/lib/uri/ldap.rb +261 -0
- data/lib/bundler/vendor/uri/lib/uri/ldaps.rb +22 -0
- data/lib/bundler/vendor/uri/lib/uri/mailto.rb +293 -0
- data/lib/bundler/vendor/uri/lib/uri/rfc2396_parser.rb +547 -0
- data/lib/bundler/vendor/uri/lib/uri/rfc3986_parser.rb +206 -0
- data/lib/bundler/vendor/uri/lib/uri/version.rb +6 -0
- data/lib/bundler/vendor/uri/lib/uri/ws.rb +83 -0
- data/lib/bundler/vendor/uri/lib/uri/wss.rb +23 -0
- data/lib/bundler/vendor/uri/lib/uri.rb +104 -0
- data/lib/bundler/vendored_fileutils.rb +4 -0
- data/lib/bundler/vendored_net_http.rb +23 -0
- data/lib/bundler/vendored_persistent.rb +11 -0
- data/lib/bundler/vendored_pub_grub.rb +4 -0
- data/lib/bundler/vendored_securerandom.rb +12 -0
- data/lib/bundler/vendored_thor.rb +8 -0
- data/lib/bundler/vendored_timeout.rb +12 -0
- data/lib/bundler/vendored_tsort.rb +4 -0
- data/lib/bundler/vendored_uri.rb +21 -0
- data/lib/bundler/version.rb +21 -0
- data/lib/bundler/vlad.rb +4 -0
- data/lib/bundler/worker.rb +125 -0
- data/lib/bundler/yaml_serializer.rb +98 -0
- data/lib/bundler.rb +691 -0
- metadata +409 -0
|
@@ -0,0 +1,455 @@
|
|
|
1
|
+
bundle-config(1) -- Set bundler configuration options
|
|
2
|
+
=====================================================
|
|
3
|
+
|
|
4
|
+
## SYNOPSIS
|
|
5
|
+
|
|
6
|
+
`bundle config` [list]<br>
|
|
7
|
+
`bundle config` [get [--local|--global]] NAME<br>
|
|
8
|
+
`bundle config` [set [--local|--global]] NAME VALUE<br>
|
|
9
|
+
`bundle config` unset [--local|--global] NAME
|
|
10
|
+
|
|
11
|
+
## DESCRIPTION
|
|
12
|
+
|
|
13
|
+
This command allows you to interact with Bundler's configuration system.
|
|
14
|
+
|
|
15
|
+
Bundler loads configuration settings in this order:
|
|
16
|
+
|
|
17
|
+
1. Local config (`<project_root>/.bundle/config` or `$BUNDLE_APP_CONFIG/config`)
|
|
18
|
+
2. Environmental variables (`ENV`)
|
|
19
|
+
3. Global config (`~/.bundle/config`)
|
|
20
|
+
4. Bundler default config
|
|
21
|
+
|
|
22
|
+
Executing `bundle` with the `BUNDLE_IGNORE_CONFIG` environment variable set will
|
|
23
|
+
cause it to ignore all configuration.
|
|
24
|
+
|
|
25
|
+
## SUB-COMMANDS
|
|
26
|
+
|
|
27
|
+
### list (default command)
|
|
28
|
+
|
|
29
|
+
Executing `bundle config list` will print a list of all bundler
|
|
30
|
+
configuration for the current bundle, and where that configuration
|
|
31
|
+
was set.
|
|
32
|
+
|
|
33
|
+
### get
|
|
34
|
+
|
|
35
|
+
Executing `bundle config get <name>` will print the value of that configuration
|
|
36
|
+
setting, and all locations where it was set.
|
|
37
|
+
|
|
38
|
+
**OPTIONS**
|
|
39
|
+
|
|
40
|
+
* `--local`:
|
|
41
|
+
Get configuration from configuration file for the local application, namely,
|
|
42
|
+
`<project_root>/.bundle/config`, or `$BUNDLE_APP_CONFIG/config` if
|
|
43
|
+
`BUNDLE_APP_CONFIG` is set.
|
|
44
|
+
|
|
45
|
+
* `--global`:
|
|
46
|
+
Get configuration from configuration file global to all bundles executed as
|
|
47
|
+
the current user, namely, from `~/.bundle/config`.
|
|
48
|
+
|
|
49
|
+
### set
|
|
50
|
+
|
|
51
|
+
Executing `bundle config set <name> <value>` defaults to setting `local`
|
|
52
|
+
configuration if executing from within a local application, otherwise it will
|
|
53
|
+
set `global` configuration.
|
|
54
|
+
|
|
55
|
+
**OPTIONS**
|
|
56
|
+
|
|
57
|
+
* `--local`:
|
|
58
|
+
Executing `bundle config set --local <name> <value>` will set that configuration
|
|
59
|
+
in the directory for the local application. The configuration will be stored in
|
|
60
|
+
`<project_root>/.bundle/config`. If `BUNDLE_APP_CONFIG` is set, the configuration
|
|
61
|
+
will be stored in `$BUNDLE_APP_CONFIG/config`.
|
|
62
|
+
|
|
63
|
+
* `--global`:
|
|
64
|
+
Executing `bundle config set --global <name> <value>` will set that
|
|
65
|
+
configuration to the value specified for all bundles executed as the current
|
|
66
|
+
user. The configuration will be stored in `~/.bundle/config`. If <name> already
|
|
67
|
+
is set, <name> will be overridden and user will be warned.
|
|
68
|
+
|
|
69
|
+
### unset
|
|
70
|
+
|
|
71
|
+
Executing `bundle config unset <name>` will delete the configuration in both
|
|
72
|
+
local and global sources.
|
|
73
|
+
|
|
74
|
+
**OPTIONS**
|
|
75
|
+
|
|
76
|
+
* `--local`:
|
|
77
|
+
Executing `bundle config unset --local <name>` will delete the configuration
|
|
78
|
+
only from the local application.
|
|
79
|
+
|
|
80
|
+
* `--global`:
|
|
81
|
+
Executing `bundle config unset --global <name>` will delete the configuration
|
|
82
|
+
only from the user configuration.
|
|
83
|
+
|
|
84
|
+
## CONFIGURATION KEYS
|
|
85
|
+
|
|
86
|
+
Configuration keys in bundler have two forms: the canonical form and the
|
|
87
|
+
environment variable form.
|
|
88
|
+
|
|
89
|
+
For instance, passing the `--without` flag to [bundle install(1)](bundle-install.1.html)
|
|
90
|
+
prevents Bundler from installing certain groups specified in the Gemfile(5). Bundler
|
|
91
|
+
persists this value in `app/.bundle/config` so that calls to `Bundler.setup`
|
|
92
|
+
do not try to find gems from the `Gemfile` that you didn't install. Additionally,
|
|
93
|
+
subsequent calls to [bundle install(1)](bundle-install.1.html) remember this setting
|
|
94
|
+
and skip those groups.
|
|
95
|
+
|
|
96
|
+
The canonical form of this configuration is `"without"`. To convert the canonical
|
|
97
|
+
form to the environment variable form, capitalize it, and prepend `BUNDLE_`. The
|
|
98
|
+
environment variable form of `"without"` is `BUNDLE_WITHOUT`.
|
|
99
|
+
|
|
100
|
+
Any periods in the configuration keys must be replaced with two underscores when
|
|
101
|
+
setting it via environment variables. The configuration key `local.rack` becomes
|
|
102
|
+
the environment variable `BUNDLE_LOCAL__RACK`.
|
|
103
|
+
|
|
104
|
+
## LIST OF AVAILABLE KEYS
|
|
105
|
+
|
|
106
|
+
The following is a list of all configuration keys and their purpose. You can
|
|
107
|
+
learn more about their operation in [bundle install(1)](bundle-install.1.html).
|
|
108
|
+
|
|
109
|
+
* `api_request_size` (`BUNDLE_API_REQUEST_SIZE`):
|
|
110
|
+
Configure how many dependencies to fetch when resolving the specifications.
|
|
111
|
+
This configuration is only used when fetchig specifications from RubyGems
|
|
112
|
+
servers that didn't implement the Compact Index API.
|
|
113
|
+
Defaults to 100.
|
|
114
|
+
* `auto_install` (`BUNDLE_AUTO_INSTALL`):
|
|
115
|
+
Automatically run `bundle install` when gems are missing.
|
|
116
|
+
* `bin` (`BUNDLE_BIN`):
|
|
117
|
+
If configured, `bundle binstubs` will install executables from gems in the
|
|
118
|
+
bundle to the specified directory. Otherwise it will create them in a `bin`
|
|
119
|
+
directory relative to the Gemfile directory. These executables run in
|
|
120
|
+
Bundler's context. If used, you might add this directory to your
|
|
121
|
+
environment's `PATH` variable. For instance, if the `rails` gem comes with a
|
|
122
|
+
`rails` executable, `bundle binstubs` will create a `bin/rails` executable
|
|
123
|
+
that ensures that all referred dependencies will be resolved using the
|
|
124
|
+
bundled gems.
|
|
125
|
+
* `cache_all` (`BUNDLE_CACHE_ALL`):
|
|
126
|
+
Cache all gems, including path and git gems. This needs to be explicitly
|
|
127
|
+
before bundler 4, but will be the default on bundler 4.
|
|
128
|
+
* `cache_all_platforms` (`BUNDLE_CACHE_ALL_PLATFORMS`):
|
|
129
|
+
Cache gems for all platforms.
|
|
130
|
+
* `cache_path` (`BUNDLE_CACHE_PATH`):
|
|
131
|
+
The directory that bundler will place cached gems in when running
|
|
132
|
+
<code>bundle package</code>, and that bundler will look in when installing gems.
|
|
133
|
+
Defaults to `vendor/cache`.
|
|
134
|
+
* `clean` (`BUNDLE_CLEAN`):
|
|
135
|
+
Whether Bundler should run `bundle clean` automatically after
|
|
136
|
+
`bundle install`. Defaults to `true` in Bundler 4, as long as `path` is not
|
|
137
|
+
explicitly configured.
|
|
138
|
+
* `console` (`BUNDLE_CONSOLE`):
|
|
139
|
+
The console that `bundle console` starts. Defaults to `irb`.
|
|
140
|
+
* `cooldown` (`BUNDLE_COOLDOWN`):
|
|
141
|
+
Number of days a published gem version must age before bundler will
|
|
142
|
+
resolve to it. Defaults to unset (no cooldown). Pass `0` to disable
|
|
143
|
+
cooldown for an individual run.
|
|
144
|
+
|
|
145
|
+
The effective cooldown for any given gem is resolved from three
|
|
146
|
+
layers, highest precedence first:
|
|
147
|
+
|
|
148
|
+
1. CLI flag `--cooldown N` on `install`, `update`, `add`, and
|
|
149
|
+
`outdated`.
|
|
150
|
+
2. This setting (`bundle config set cooldown N` or
|
|
151
|
+
`BUNDLE_COOLDOWN=N`).
|
|
152
|
+
3. The per-source `cooldown:` keyword in the Gemfile, such as
|
|
153
|
+
`source "https://rubygems.org", cooldown: 7`.
|
|
154
|
+
|
|
155
|
+
The CLI flag and this setting apply uniformly to every source,
|
|
156
|
+
including ones declared with their own `cooldown:` value. To keep a
|
|
157
|
+
private registry permanently exempt while still cooling down public
|
|
158
|
+
gems, declare `source "https://internal", cooldown: 0` in the
|
|
159
|
+
Gemfile; remember that `--cooldown N` on the command line will
|
|
160
|
+
still override it for that single run.
|
|
161
|
+
|
|
162
|
+
Cooldown filtering depends on the gem server providing a per-version
|
|
163
|
+
`created_at` timestamp in the v2 compact-index format. Versions
|
|
164
|
+
without that metadata - older gem servers, historical entries that
|
|
165
|
+
predate the v2 cutover on `rubygems.org`, or private registries that
|
|
166
|
+
still emit the v1 format - are treated as outside the cooldown
|
|
167
|
+
window and remain resolvable. If you rely on cooldown for
|
|
168
|
+
supply-chain protection, confirm that the gem server emits
|
|
169
|
+
`created_at` in its `/info/<gem>` responses.
|
|
170
|
+
* `default_cli_command` (`BUNDLE_DEFAULT_CLI_COMMAND`):
|
|
171
|
+
The command that running `bundle` without arguments should run. Defaults to
|
|
172
|
+
`cli_help` since Bundler 4, but can also be `install` which was the previous
|
|
173
|
+
default.
|
|
174
|
+
* `deployment` (`BUNDLE_DEPLOYMENT`):
|
|
175
|
+
Equivalent to setting `frozen` to `true` and `path` to `vendor/bundle`.
|
|
176
|
+
* `disable_checksum_validation` (`BUNDLE_DISABLE_CHECKSUM_VALIDATION`):
|
|
177
|
+
Allow installing gems even if they do not match the checksum provided by
|
|
178
|
+
RubyGems.
|
|
179
|
+
* `disable_exec_load` (`BUNDLE_DISABLE_EXEC_LOAD`):
|
|
180
|
+
Stop Bundler from using `load` to launch an executable in-process in
|
|
181
|
+
`bundle exec`.
|
|
182
|
+
* `disable_local_branch_check` (`BUNDLE_DISABLE_LOCAL_BRANCH_CHECK`):
|
|
183
|
+
Allow Bundler to use a local git override without a branch specified in the
|
|
184
|
+
Gemfile.
|
|
185
|
+
* `disable_local_revision_check` (`BUNDLE_DISABLE_LOCAL_REVISION_CHECK`):
|
|
186
|
+
Allow Bundler to use a local git override without checking if the revision
|
|
187
|
+
present in the lockfile is present in the repository.
|
|
188
|
+
* `disable_shared_gems` (`BUNDLE_DISABLE_SHARED_GEMS`):
|
|
189
|
+
Stop Bundler from accessing gems installed to RubyGems' normal location.
|
|
190
|
+
* `disable_version_check` (`BUNDLE_DISABLE_VERSION_CHECK`):
|
|
191
|
+
Stop Bundler from checking if a newer Bundler version is available on
|
|
192
|
+
rubygems.org.
|
|
193
|
+
* `force_ruby_platform` (`BUNDLE_FORCE_RUBY_PLATFORM`):
|
|
194
|
+
Ignore the current machine's platform and install only `ruby` platform gems.
|
|
195
|
+
As a result, gems with native extensions will be compiled from source.
|
|
196
|
+
* `frozen` (`BUNDLE_FROZEN`):
|
|
197
|
+
Disallow any automatic changes to `Gemfile.lock`. Bundler commands will
|
|
198
|
+
be blocked unless the lockfile can be installed exactly as written.
|
|
199
|
+
Usually this will happen when changing the `Gemfile` manually and forgetting
|
|
200
|
+
to update the lockfile through `bundle lock` or `bundle install`.
|
|
201
|
+
* `gem.github_username` (`BUNDLE_GEM__GITHUB_USERNAME`):
|
|
202
|
+
Sets a GitHub username or organization to be used in the `README` and `.gemspec` files
|
|
203
|
+
when you create a new gem via `bundle gem` command. It can be overridden by passing an
|
|
204
|
+
explicit `--github-username` flag to `bundle gem`.
|
|
205
|
+
* `gem.push_key` (`BUNDLE_GEM__PUSH_KEY`):
|
|
206
|
+
Sets the `--key` parameter for `gem push` when using the `rake release`
|
|
207
|
+
command with a private gemstash server.
|
|
208
|
+
* `gemfile` (`BUNDLE_GEMFILE`):
|
|
209
|
+
The name of the file that bundler should use as the `Gemfile`. This location
|
|
210
|
+
of this file also sets the root of the project, which is used to resolve
|
|
211
|
+
relative paths in the `Gemfile`, among other things. By default, bundler
|
|
212
|
+
will search up from the current working directory until it finds a
|
|
213
|
+
`Gemfile`.
|
|
214
|
+
* `global_gem_cache` (`BUNDLE_GLOBAL_GEM_CACHE`):
|
|
215
|
+
Whether Bundler should cache all gems and compiled extensions globally,
|
|
216
|
+
rather than locally to the configured installation path.
|
|
217
|
+
* `ignore_funding_requests` (`BUNDLE_IGNORE_FUNDING_REQUESTS`):
|
|
218
|
+
When set, no funding requests will be printed.
|
|
219
|
+
* `ignore_messages` (`BUNDLE_IGNORE_MESSAGES`):
|
|
220
|
+
When set, no post install messages will be printed. To silence a single gem,
|
|
221
|
+
use dot notation like `ignore_messages.httparty true`.
|
|
222
|
+
* `init_gems_rb` (`BUNDLE_INIT_GEMS_RB`):
|
|
223
|
+
Generate a `gems.rb` instead of a `Gemfile` when running `bundle init`.
|
|
224
|
+
* `jobs` (`BUNDLE_JOBS`):
|
|
225
|
+
The number of gems Bundler can download and install in parallel.
|
|
226
|
+
Defaults to the number of available processors.
|
|
227
|
+
* `lockfile` (`BUNDLE_LOCKFILE`):
|
|
228
|
+
The path to the lockfile that bundler should use. By default, Bundler adds
|
|
229
|
+
`.lock` to the end of the `gemfile` entry. Can be set to `false` in the
|
|
230
|
+
Gemfile to disable lockfile creation entirely (see gemfile(5)).
|
|
231
|
+
* `lockfile_checksums` (`BUNDLE_LOCKFILE_CHECKSUMS`):
|
|
232
|
+
Whether Bundler should include a checksums section in new lockfiles, to protect from compromised gem sources. Defaults to true.
|
|
233
|
+
* `no_install` (`BUNDLE_NO_INSTALL`):
|
|
234
|
+
Whether `bundle package` should skip installing gems.
|
|
235
|
+
* `no_prune` (`BUNDLE_NO_PRUNE`):
|
|
236
|
+
Whether Bundler should leave outdated gems unpruned when caching.
|
|
237
|
+
* `only` (`BUNDLE_ONLY`):
|
|
238
|
+
A space-separated list of groups to install only gems of the specified groups.
|
|
239
|
+
Please check carefully if you want to install also gems without a group, because
|
|
240
|
+
they get put inside `default` group. For example `only test:default` will install
|
|
241
|
+
all gems specified in test group and without one.
|
|
242
|
+
* `path` (`BUNDLE_PATH`):
|
|
243
|
+
The location on disk where all gems in your bundle will be located regardless
|
|
244
|
+
of `$GEM_HOME` or `$GEM_PATH` values. Bundle gems not found in this location
|
|
245
|
+
will be installed by `bundle install`. When not set, Bundler install by
|
|
246
|
+
default to a `.bundle` directory relative to repository root in Bundler 4,
|
|
247
|
+
and to the default system path (`Gem.dir`) before Bundler 4. That means that
|
|
248
|
+
before Bundler 4, Bundler shares this location with Rubygems, and `gem
|
|
249
|
+
install ...` will have gems installed in the same location and therefore,
|
|
250
|
+
gems installed without `path` set will show up by calling `gem list`. This
|
|
251
|
+
will not be the case in Bundler 4.
|
|
252
|
+
* `path.system` (`BUNDLE_PATH__SYSTEM`):
|
|
253
|
+
Whether Bundler will install gems into the default system path (`Gem.dir`).
|
|
254
|
+
* `plugins` (`BUNDLE_PLUGINS`):
|
|
255
|
+
Enable Bundler's experimental plugin system.
|
|
256
|
+
* `prefer_patch` (`BUNDLE_PREFER_PATCH`):
|
|
257
|
+
Prefer updating only to next patch version during updates. Makes `bundle update` calls equivalent to `bundler update --patch`.
|
|
258
|
+
* `redirect` (`BUNDLE_REDIRECT`):
|
|
259
|
+
The number of redirects allowed for network requests. Defaults to `5`.
|
|
260
|
+
* `retry` (`BUNDLE_RETRY`):
|
|
261
|
+
The number of times to retry failed network requests. Defaults to `3`.
|
|
262
|
+
* `shebang` (`BUNDLE_SHEBANG`):
|
|
263
|
+
The program name that should be invoked for generated binstubs. Defaults to
|
|
264
|
+
the ruby install name used to generate the binstub.
|
|
265
|
+
* `silence_deprecations` (`BUNDLE_SILENCE_DEPRECATIONS`):
|
|
266
|
+
Whether Bundler should silence deprecation warnings for behavior that will
|
|
267
|
+
be changed in the next major version.
|
|
268
|
+
* `silence_root_warning` (`BUNDLE_SILENCE_ROOT_WARNING`):
|
|
269
|
+
Silence the warning Bundler prints when installing gems as root.
|
|
270
|
+
* `simulate_version` (`BUNDLE_SIMULATE_VERSION`):
|
|
271
|
+
The virtual version Bundler should use for activating feature flags. Can be
|
|
272
|
+
used to simulate all the new functionality that will be enabled in a future
|
|
273
|
+
major version.
|
|
274
|
+
* `ssl_ca_cert` (`BUNDLE_SSL_CA_CERT`):
|
|
275
|
+
Path to a designated CA certificate file or folder containing multiple
|
|
276
|
+
certificates for trusted CAs in PEM format.
|
|
277
|
+
* `ssl_client_cert` (`BUNDLE_SSL_CLIENT_CERT`):
|
|
278
|
+
Path to a designated file containing a X.509 client certificate
|
|
279
|
+
and key in PEM format.
|
|
280
|
+
* `ssl_verify_mode` (`BUNDLE_SSL_VERIFY_MODE`):
|
|
281
|
+
The SSL verification mode Bundler uses when making HTTPS requests.
|
|
282
|
+
Defaults to verify peer.
|
|
283
|
+
* `system_bindir` (`BUNDLE_SYSTEM_BINDIR`):
|
|
284
|
+
The location where RubyGems installs binstubs. Defaults to `Gem.bindir`.
|
|
285
|
+
* `timeout` (`BUNDLE_TIMEOUT`):
|
|
286
|
+
The seconds allowed before timing out for network requests. Defaults to `10`.
|
|
287
|
+
* `update_requires_all_flag` (`BUNDLE_UPDATE_REQUIRES_ALL_FLAG`):
|
|
288
|
+
Require passing `--all` to `bundle update` when everything should be updated,
|
|
289
|
+
and disallow passing no options to `bundle update`.
|
|
290
|
+
* `user_agent` (`BUNDLE_USER_AGENT`):
|
|
291
|
+
The custom user agent fragment Bundler includes in API requests.
|
|
292
|
+
* `verbose` (`BUNDLE_VERBOSE`):
|
|
293
|
+
Whether Bundler should print verbose output. Defaults to `false`, unless the
|
|
294
|
+
`--verbose` CLI flag is used.
|
|
295
|
+
* `version` (`BUNDLE_VERSION`):
|
|
296
|
+
The version of Bundler to use when running under Bundler environment.
|
|
297
|
+
Defaults to `lockfile`. You can also specify `system` or `x.y.z`.
|
|
298
|
+
`lockfile` will use the Bundler version specified in the `Gemfile.lock`,
|
|
299
|
+
`system` will use the system version of Bundler, and `x.y.z` will use
|
|
300
|
+
the specified version of Bundler.
|
|
301
|
+
* `with` (`BUNDLE_WITH`):
|
|
302
|
+
A space-separated or `:`-separated list of groups whose gems bundler should install.
|
|
303
|
+
* `without` (`BUNDLE_WITHOUT`):
|
|
304
|
+
A space-separated or `:`-separated list of groups whose gems bundler should not install.
|
|
305
|
+
|
|
306
|
+
## BUILD OPTIONS
|
|
307
|
+
|
|
308
|
+
You can use `bundle config` to give Bundler the flags to pass to the gem
|
|
309
|
+
installer every time bundler tries to install a particular gem.
|
|
310
|
+
|
|
311
|
+
A very common example, the `mysql` gem, requires Snow Leopard users to
|
|
312
|
+
pass configuration flags to `gem install` to specify where to find the
|
|
313
|
+
`mysql_config` executable.
|
|
314
|
+
|
|
315
|
+
gem install mysql -- --with-mysql-config=/usr/local/mysql/bin/mysql_config
|
|
316
|
+
|
|
317
|
+
Since the specific location of that executable can change from machine
|
|
318
|
+
to machine, you can specify these flags on a per-machine basis.
|
|
319
|
+
|
|
320
|
+
bundle config set --global build.mysql --with-mysql-config=/usr/local/mysql/bin/mysql_config
|
|
321
|
+
|
|
322
|
+
After running this command, every time bundler needs to install the
|
|
323
|
+
`mysql` gem, it will pass along the flags you specified.
|
|
324
|
+
|
|
325
|
+
## LOCAL GIT REPOS
|
|
326
|
+
|
|
327
|
+
Bundler also allows you to work against a git repository locally
|
|
328
|
+
instead of using the remote version. This can be achieved by setting
|
|
329
|
+
up a local override:
|
|
330
|
+
|
|
331
|
+
bundle config set --local local.GEM_NAME /path/to/local/git/repository
|
|
332
|
+
|
|
333
|
+
Important: This feature only works for gems that are specified with a git
|
|
334
|
+
source in your Gemfile. It does not work for gems installed from RubyGems
|
|
335
|
+
or other sources. The gem must be defined with `git:` option pointing to a
|
|
336
|
+
remote repository.
|
|
337
|
+
|
|
338
|
+
For example, if your Gemfile contains:
|
|
339
|
+
|
|
340
|
+
gem "rack", git: "https://github.com/rack/rack.git", branch: "main"
|
|
341
|
+
|
|
342
|
+
Then you can use a local Rack repository by running:
|
|
343
|
+
|
|
344
|
+
bundle config set --local local.rack ~/Work/git/rack
|
|
345
|
+
|
|
346
|
+
Now instead of checking out the remote git repository, the local
|
|
347
|
+
override will be used. Similar to a path source, every time the local
|
|
348
|
+
git repository change, changes will be automatically picked up by
|
|
349
|
+
Bundler. This means a commit in the local git repo will update the
|
|
350
|
+
revision in the `Gemfile.lock` to the local git repo revision. This
|
|
351
|
+
requires the same attention as git submodules. Before pushing to
|
|
352
|
+
the remote, you need to ensure the local override was pushed, otherwise
|
|
353
|
+
you may point to a commit that only exists in your local machine.
|
|
354
|
+
You'll also need to CGI escape your usernames and passwords as well.
|
|
355
|
+
|
|
356
|
+
Bundler does many checks to ensure a developer won't work with
|
|
357
|
+
invalid references. Particularly, we force a developer to specify
|
|
358
|
+
a branch in the `Gemfile` in order to use this feature. If the branch
|
|
359
|
+
specified in the `Gemfile` and the current branch in the local git
|
|
360
|
+
repository do not match, Bundler will abort. This ensures that
|
|
361
|
+
a developer is always working against the correct branches, and prevents
|
|
362
|
+
accidental locking to a different branch.
|
|
363
|
+
|
|
364
|
+
Finally, Bundler also ensures that the current revision in the
|
|
365
|
+
`Gemfile.lock` exists in the local git repository. By doing this, Bundler
|
|
366
|
+
forces you to fetch the latest changes in the remotes.
|
|
367
|
+
|
|
368
|
+
If you need to temporarily use a local version of a gem that is normally
|
|
369
|
+
installed from RubyGems (not from git), use a path source instead:
|
|
370
|
+
|
|
371
|
+
gem "rack", path: "~/Work/git/rack"
|
|
372
|
+
|
|
373
|
+
## MIRRORS OF GEM SOURCES
|
|
374
|
+
|
|
375
|
+
Bundler supports overriding gem sources with mirrors. This allows you to
|
|
376
|
+
configure rubygems.org as the gem source in your Gemfile while still using your
|
|
377
|
+
mirror to fetch gems.
|
|
378
|
+
|
|
379
|
+
bundle config set --global mirror.SOURCE_URL MIRROR_URL
|
|
380
|
+
|
|
381
|
+
For example, to use a mirror of https://rubygems.org hosted at https://example.org:
|
|
382
|
+
|
|
383
|
+
bundle config set --global mirror.https://rubygems.org https://example.org
|
|
384
|
+
|
|
385
|
+
Each mirror also provides a fallback timeout setting. If the mirror does not
|
|
386
|
+
respond within the fallback timeout, Bundler will try to use the original
|
|
387
|
+
server instead of the mirror.
|
|
388
|
+
|
|
389
|
+
bundle config set --global mirror.SOURCE_URL.fallback_timeout TIMEOUT
|
|
390
|
+
|
|
391
|
+
For example, to fall back to rubygems.org after 3 seconds:
|
|
392
|
+
|
|
393
|
+
bundle config set --global mirror.https://rubygems.org.fallback_timeout 3
|
|
394
|
+
|
|
395
|
+
The default fallback timeout is 0.1 seconds, but the setting can currently
|
|
396
|
+
only accept whole seconds (for example, 1, 15, or 30).
|
|
397
|
+
|
|
398
|
+
## CREDENTIALS FOR GEM SOURCES
|
|
399
|
+
|
|
400
|
+
Bundler allows you to configure credentials for any gem source, which allows
|
|
401
|
+
you to avoid putting secrets into your Gemfile.
|
|
402
|
+
|
|
403
|
+
bundle config set --global SOURCE_HOSTNAME USERNAME:PASSWORD
|
|
404
|
+
|
|
405
|
+
For example, to save the credentials of user `claudette` for the gem source at
|
|
406
|
+
`gems.longerous.com`, you would run:
|
|
407
|
+
|
|
408
|
+
bundle config set --global gems.longerous.com claudette:s00pers3krit
|
|
409
|
+
|
|
410
|
+
Or you can set the credentials as an environment variable like this:
|
|
411
|
+
|
|
412
|
+
export BUNDLE_GEMS__LONGEROUS__COM="claudette:s00pers3krit"
|
|
413
|
+
|
|
414
|
+
For gems with a git source with HTTP(S) URL you can specify credentials like so:
|
|
415
|
+
|
|
416
|
+
bundle config set --global https://github.com/ruby/rubygems.git username:password
|
|
417
|
+
|
|
418
|
+
Or you can set the credentials as an environment variable like so:
|
|
419
|
+
|
|
420
|
+
export BUNDLE_GITHUB__COM=username:password
|
|
421
|
+
|
|
422
|
+
This is especially useful for private repositories on hosts such as GitHub,
|
|
423
|
+
where you can use personal OAuth tokens:
|
|
424
|
+
|
|
425
|
+
export BUNDLE_GITHUB__COM=abcd0123generatedtoken:x-oauth-basic
|
|
426
|
+
|
|
427
|
+
Note that any configured credentials will be redacted by informative commands
|
|
428
|
+
such as `bundle config list` or `bundle config get`, unless you use the
|
|
429
|
+
`--parseable` flag. This is to avoid unintentionally leaking credentials when
|
|
430
|
+
copy-pasting bundler output.
|
|
431
|
+
|
|
432
|
+
Also note that to guarantee a sane mapping between valid environment variable
|
|
433
|
+
names and valid host names, bundler makes the following transformations:
|
|
434
|
+
|
|
435
|
+
* Any `-` characters in a host name are mapped to a triple underscore (`___`) in the
|
|
436
|
+
corresponding environment variable.
|
|
437
|
+
|
|
438
|
+
* Any `.` characters in a host name are mapped to a double underscore (`__`) in the
|
|
439
|
+
corresponding environment variable.
|
|
440
|
+
|
|
441
|
+
This means that if you have a gem server named `my.gem-host.com`, you'll need to
|
|
442
|
+
use the `BUNDLE_MY__GEM___HOST__COM` variable to configure credentials for it
|
|
443
|
+
through ENV.
|
|
444
|
+
|
|
445
|
+
## CONFIGURE BUNDLER DIRECTORIES
|
|
446
|
+
|
|
447
|
+
Bundler's home, cache and plugin directories and config file can be configured
|
|
448
|
+
through environment variables. The default location for Bundler's home directory is
|
|
449
|
+
`~/.bundle`, which all directories inherit from by default. The following
|
|
450
|
+
outlines the available environment variables and their default values
|
|
451
|
+
|
|
452
|
+
BUNDLE_USER_HOME : $HOME/.bundle
|
|
453
|
+
BUNDLE_USER_CACHE : $BUNDLE_USER_HOME/cache
|
|
454
|
+
BUNDLE_USER_CONFIG : $BUNDLE_USER_HOME/config
|
|
455
|
+
BUNDLE_USER_PLUGIN : $BUNDLE_USER_HOME/plugin
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
.\" generated with Ronn-NG/v0.10.1
|
|
2
|
+
.\" http://github.com/apjanke/ronn-ng/tree/0.10.1
|
|
3
|
+
.TH "BUNDLE\-CONSOLE" "1" "April 2026" ""
|
|
4
|
+
.SH "NAME"
|
|
5
|
+
\fBbundle\-console\fR \- Open an IRB session with the bundle pre\-loaded
|
|
6
|
+
.SH "SYNOPSIS"
|
|
7
|
+
\fBbundle console\fR [GROUP]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Starts an interactive Ruby console session in the context of the current bundle\.
|
|
10
|
+
.P
|
|
11
|
+
If no \fBGROUP\fR is specified, all gems in the \fBdefault\fR group in the Gemfile(5) \fIhttps://bundler\.io/man/gemfile\.5\.html\fR are preliminarily loaded\.
|
|
12
|
+
.P
|
|
13
|
+
If \fBGROUP\fR is specified, all gems in the given group in the Gemfile in addition to the gems in \fBdefault\fR group are loaded\. Even if the given group does not exist in the Gemfile, IRB console starts without any warning or error\.
|
|
14
|
+
.P
|
|
15
|
+
The environment variable \fBBUNDLE_CONSOLE\fR or \fBbundle config set console\fR can be used to change the shell from the following:
|
|
16
|
+
.IP "\(bu" 4
|
|
17
|
+
\fBirb\fR (default)
|
|
18
|
+
.IP "\(bu" 4
|
|
19
|
+
\fBpry\fR (https://github\.com/pry/pry)
|
|
20
|
+
.IP "\(bu" 4
|
|
21
|
+
\fBripl\fR (https://github\.com/cldwalker/ripl)
|
|
22
|
+
.IP "" 0
|
|
23
|
+
.P
|
|
24
|
+
\fBbundle console\fR uses irb by default\. An alternative Pry or Ripl can be used with \fBbundle console\fR by adjusting the \fBconsole\fR Bundler setting\. Also make sure that \fBpry\fR or \fBripl\fR is in your Gemfile\.
|
|
25
|
+
.SH "EXAMPLE"
|
|
26
|
+
.nf
|
|
27
|
+
$ bundle config set console pry
|
|
28
|
+
$ bundle console
|
|
29
|
+
Resolving dependencies\|\.\|\.\|\.
|
|
30
|
+
[1] pry(main)>
|
|
31
|
+
.fi
|
|
32
|
+
.SH "SEE ALSO"
|
|
33
|
+
Gemfile(5) \fIhttps://bundler\.io/man/gemfile\.5\.html\fR
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
bundle-console(1) -- Open an IRB session with the bundle pre-loaded
|
|
2
|
+
===================================================================
|
|
3
|
+
|
|
4
|
+
## SYNOPSIS
|
|
5
|
+
|
|
6
|
+
`bundle console` [GROUP]
|
|
7
|
+
|
|
8
|
+
## DESCRIPTION
|
|
9
|
+
|
|
10
|
+
Starts an interactive Ruby console session in the context of the current bundle.
|
|
11
|
+
|
|
12
|
+
If no `GROUP` is specified, all gems in the `default` group in the [Gemfile(5)](https://bundler.io/man/gemfile.5.html) are
|
|
13
|
+
preliminarily loaded.
|
|
14
|
+
|
|
15
|
+
If `GROUP` is specified, all gems in the given group in the Gemfile in addition
|
|
16
|
+
to the gems in `default` group are loaded. Even if the given group does not
|
|
17
|
+
exist in the Gemfile, IRB console starts without any warning or error.
|
|
18
|
+
|
|
19
|
+
The environment variable `BUNDLE_CONSOLE` or `bundle config set console` can be used to change
|
|
20
|
+
the shell from the following:
|
|
21
|
+
|
|
22
|
+
* `irb` (default)
|
|
23
|
+
* `pry` (https://github.com/pry/pry)
|
|
24
|
+
* `ripl` (https://github.com/cldwalker/ripl)
|
|
25
|
+
|
|
26
|
+
`bundle console` uses irb by default. An alternative Pry or Ripl can be used with
|
|
27
|
+
`bundle console` by adjusting the `console` Bundler setting. Also make sure that
|
|
28
|
+
`pry` or `ripl` is in your Gemfile.
|
|
29
|
+
|
|
30
|
+
## EXAMPLE
|
|
31
|
+
|
|
32
|
+
$ bundle config set console pry
|
|
33
|
+
$ bundle console
|
|
34
|
+
Resolving dependencies...
|
|
35
|
+
[1] pry(main)>
|
|
36
|
+
|
|
37
|
+
## SEE ALSO
|
|
38
|
+
|
|
39
|
+
[Gemfile(5)](https://bundler.io/man/gemfile.5.html)
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
.\" generated with Ronn-NG/v0.10.1
|
|
2
|
+
.\" http://github.com/apjanke/ronn-ng/tree/0.10.1
|
|
3
|
+
.TH "BUNDLE\-DOCTOR" "1" "April 2026" ""
|
|
4
|
+
.SH "NAME"
|
|
5
|
+
\fBbundle\-doctor\fR \- Checks the bundle for common problems
|
|
6
|
+
.SH "SYNOPSIS"
|
|
7
|
+
\fBbundle doctor [diagnose]\fR [\-\-quiet] [\-\-gemfile=GEMFILE] [\-\-ssl]
|
|
8
|
+
.br
|
|
9
|
+
\fBbundle doctor ssl\fR [\-\-host=HOST] [\-\-tls\-version=TLS\-VERSION] [\-\-verify\-mode=VERIFY\-MODE]
|
|
10
|
+
.br
|
|
11
|
+
\fBbundle doctor\fR help [COMMAND]
|
|
12
|
+
.SH "DESCRIPTION"
|
|
13
|
+
You can diagnose common Bundler problems with this command such as checking gem environment or SSL/TLS issue\.
|
|
14
|
+
.SH "SUB\-COMMANDS"
|
|
15
|
+
.SS "diagnose (default command)"
|
|
16
|
+
Checks your Gemfile and gem environment for common problems\. If issues are detected, Bundler prints them and exits status 1\. Otherwise, Bundler prints a success message and exits status 0\.
|
|
17
|
+
.P
|
|
18
|
+
Examples of common problems caught include:
|
|
19
|
+
.IP "\(bu" 4
|
|
20
|
+
Invalid Bundler settings
|
|
21
|
+
.IP "\(bu" 4
|
|
22
|
+
Mismatched Ruby versions
|
|
23
|
+
.IP "\(bu" 4
|
|
24
|
+
Mismatched platforms
|
|
25
|
+
.IP "\(bu" 4
|
|
26
|
+
Uninstalled gems
|
|
27
|
+
.IP "\(bu" 4
|
|
28
|
+
Missing dependencies
|
|
29
|
+
.IP "" 0
|
|
30
|
+
.P
|
|
31
|
+
\fBOPTIONS\fR
|
|
32
|
+
.TP
|
|
33
|
+
\fB\-\-quiet\fR
|
|
34
|
+
Only output warnings and errors\.
|
|
35
|
+
.TP
|
|
36
|
+
\fB\-\-gemfile=GEMFILE\fR
|
|
37
|
+
The location of the Gemfile(5) which Bundler should use\. This defaults to a Gemfile(5) in the current working directory\. In general, Bundler will assume that the location of the Gemfile(5) is also the project's root and will try to find \fBGemfile\.lock\fR and \fBvendor/cache\fR relative to this location\.
|
|
38
|
+
.TP
|
|
39
|
+
\fB\-\-ssl\fR
|
|
40
|
+
Diagnose common SSL problems when connecting to https://rubygems\.org\.
|
|
41
|
+
.IP
|
|
42
|
+
This flag runs the \fBbundle doctor ssl\fR subcommand with default values underneath\.
|
|
43
|
+
.SS "ssl"
|
|
44
|
+
If you've experienced issues related to SSL certificates and/or TLS versions while connecting to https://rubygems\.org, this command can help troubleshoot common problems\. The diagnostic will perform a few checks such as:
|
|
45
|
+
.IP "\(bu" 4
|
|
46
|
+
Verify the Ruby OpenSSL version installed on your system\.
|
|
47
|
+
.IP "\(bu" 4
|
|
48
|
+
Check the OpenSSL library version used for compilation\.
|
|
49
|
+
.IP "\(bu" 4
|
|
50
|
+
Ensure CA certificates are correctly setup on your machine\.
|
|
51
|
+
.IP "\(bu" 4
|
|
52
|
+
Open a TLS connection and verify the outcome\.
|
|
53
|
+
.IP "" 0
|
|
54
|
+
.P
|
|
55
|
+
\fBOPTIONS\fR
|
|
56
|
+
.TP
|
|
57
|
+
\fB\-\-host=HOST\fR
|
|
58
|
+
Perform the diagnostic on HOST\. Defaults to \fBrubygems\.org\fR\.
|
|
59
|
+
.TP
|
|
60
|
+
\fB\-\-tls\-version=TLS\-VERSION\fR
|
|
61
|
+
Specify the TLS version when opening the connection to HOST\.
|
|
62
|
+
.IP
|
|
63
|
+
Accepted values are: \fB1\.1\fR or \fB1\.2\fR\.
|
|
64
|
+
.TP
|
|
65
|
+
\fB\-\-verify\-mode=VERIFY\-MODE\fR
|
|
66
|
+
Specify the TLS verify mode when opening the connection to HOST\. Defaults to \fBSSL_VERIFY_PEER\fR\.
|
|
67
|
+
.IP
|
|
68
|
+
Accepted values are: \fBCLIENT_ONCE\fR, \fBFAIL_IF_NO_PEER_CERT\fR, \fBNONE\fR, \fBPEER\fR\.
|
|
69
|
+
|
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
bundle-doctor(1) -- Checks the bundle for common problems
|
|
2
|
+
=========================================================
|
|
3
|
+
|
|
4
|
+
## SYNOPSIS
|
|
5
|
+
|
|
6
|
+
`bundle doctor [diagnose]` [--quiet]
|
|
7
|
+
[--gemfile=GEMFILE]
|
|
8
|
+
[--ssl]<br>
|
|
9
|
+
`bundle doctor ssl` [--host=HOST]
|
|
10
|
+
[--tls-version=TLS-VERSION]
|
|
11
|
+
[--verify-mode=VERIFY-MODE]<br>
|
|
12
|
+
`bundle doctor` help [COMMAND]
|
|
13
|
+
|
|
14
|
+
## DESCRIPTION
|
|
15
|
+
|
|
16
|
+
You can diagnose common Bundler problems with this command such as checking gem environment or SSL/TLS issue.
|
|
17
|
+
|
|
18
|
+
## SUB-COMMANDS
|
|
19
|
+
|
|
20
|
+
### diagnose (default command)
|
|
21
|
+
|
|
22
|
+
Checks your Gemfile and gem environment for common problems. If issues
|
|
23
|
+
are detected, Bundler prints them and exits status 1. Otherwise,
|
|
24
|
+
Bundler prints a success message and exits status 0.
|
|
25
|
+
|
|
26
|
+
Examples of common problems caught include:
|
|
27
|
+
|
|
28
|
+
* Invalid Bundler settings
|
|
29
|
+
* Mismatched Ruby versions
|
|
30
|
+
* Mismatched platforms
|
|
31
|
+
* Uninstalled gems
|
|
32
|
+
* Missing dependencies
|
|
33
|
+
|
|
34
|
+
**OPTIONS**
|
|
35
|
+
|
|
36
|
+
* `--quiet`:
|
|
37
|
+
Only output warnings and errors.
|
|
38
|
+
|
|
39
|
+
* `--gemfile=GEMFILE`:
|
|
40
|
+
The location of the Gemfile(5) which Bundler should use. This defaults
|
|
41
|
+
to a Gemfile(5) in the current working directory. In general, Bundler
|
|
42
|
+
will assume that the location of the Gemfile(5) is also the project's
|
|
43
|
+
root and will try to find `Gemfile.lock` and `vendor/cache` relative
|
|
44
|
+
to this location.
|
|
45
|
+
|
|
46
|
+
* `--ssl`:
|
|
47
|
+
Diagnose common SSL problems when connecting to https://rubygems.org.
|
|
48
|
+
|
|
49
|
+
This flag runs the `bundle doctor ssl` subcommand with default values
|
|
50
|
+
underneath.
|
|
51
|
+
|
|
52
|
+
### ssl
|
|
53
|
+
|
|
54
|
+
If you've experienced issues related to SSL certificates and/or TLS versions while connecting
|
|
55
|
+
to https://rubygems.org, this command can help troubleshoot common problems.
|
|
56
|
+
The diagnostic will perform a few checks such as:
|
|
57
|
+
|
|
58
|
+
* Verify the Ruby OpenSSL version installed on your system.
|
|
59
|
+
* Check the OpenSSL library version used for compilation.
|
|
60
|
+
* Ensure CA certificates are correctly setup on your machine.
|
|
61
|
+
* Open a TLS connection and verify the outcome.
|
|
62
|
+
|
|
63
|
+
**OPTIONS**
|
|
64
|
+
|
|
65
|
+
* `--host=HOST`:
|
|
66
|
+
Perform the diagnostic on HOST. Defaults to `rubygems.org`.
|
|
67
|
+
|
|
68
|
+
* `--tls-version=TLS-VERSION`:
|
|
69
|
+
Specify the TLS version when opening the connection to HOST.
|
|
70
|
+
|
|
71
|
+
Accepted values are: `1.1` or `1.2`.
|
|
72
|
+
|
|
73
|
+
* `--verify-mode=VERIFY-MODE`:
|
|
74
|
+
Specify the TLS verify mode when opening the connection to HOST.
|
|
75
|
+
Defaults to `SSL_VERIFY_PEER`.
|
|
76
|
+
|
|
77
|
+
Accepted values are: `CLIENT_ONCE`, `FAIL_IF_NO_PEER_CERT`, `NONE`, `PEER`.
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
.\" generated with Ronn-NG/v0.10.1
|
|
2
|
+
.\" http://github.com/apjanke/ronn-ng/tree/0.10.1
|
|
3
|
+
.TH "BUNDLE\-ENV" "1" "April 2026" ""
|
|
4
|
+
.SH "NAME"
|
|
5
|
+
\fBbundle\-env\fR \- Print information about the environment Bundler is running under
|
|
6
|
+
.SH "SYNOPSIS"
|
|
7
|
+
\fBbundle env\fR
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Prints information about the environment Bundler is running under\.
|