bundler 1.15.2 → 1.17.3

Sign up to get free protection for your applications and to get access to all the features.

Potentially problematic release.


This version of bundler might be problematic. Click here for more details.

Files changed (286) hide show
  1. checksums.yaml +5 -5
  2. data/CHANGELOG.md +302 -0
  3. data/README.md +17 -8
  4. data/bundler.gemspec +25 -9
  5. data/exe/bundle +1 -1
  6. data/exe/bundle_ruby +4 -3
  7. data/lib/bundler/build_metadata.rb +53 -0
  8. data/lib/bundler/capistrano.rb +5 -0
  9. data/lib/bundler/cli/add.rb +15 -6
  10. data/lib/bundler/cli/binstubs.rb +17 -9
  11. data/lib/bundler/cli/cache.rb +5 -4
  12. data/lib/bundler/cli/check.rb +3 -5
  13. data/lib/bundler/cli/clean.rb +5 -6
  14. data/lib/bundler/cli/common.rb +11 -2
  15. data/lib/bundler/cli/config.rb +2 -1
  16. data/lib/bundler/cli/console.rb +2 -1
  17. data/lib/bundler/cli/doctor.rb +48 -1
  18. data/lib/bundler/cli/exec.rb +6 -5
  19. data/lib/bundler/cli/gem.rb +13 -8
  20. data/lib/bundler/cli/info.rb +0 -1
  21. data/lib/bundler/cli/init.rb +18 -6
  22. data/lib/bundler/cli/inject.rb +1 -0
  23. data/lib/bundler/cli/install.rb +64 -61
  24. data/lib/bundler/cli/issue.rb +1 -1
  25. data/lib/bundler/cli/list.rb +58 -0
  26. data/lib/bundler/cli/lock.rb +0 -1
  27. data/lib/bundler/cli/open.rb +2 -2
  28. data/lib/bundler/cli/outdated.rb +20 -9
  29. data/lib/bundler/cli/package.rb +9 -6
  30. data/lib/bundler/cli/platform.rb +1 -0
  31. data/lib/bundler/cli/plugin.rb +1 -0
  32. data/lib/bundler/cli/pristine.rb +20 -6
  33. data/lib/bundler/cli/remove.rb +18 -0
  34. data/lib/bundler/cli/show.rb +0 -1
  35. data/lib/bundler/cli/update.rb +35 -7
  36. data/lib/bundler/cli/viz.rb +1 -0
  37. data/lib/bundler/cli.rb +227 -89
  38. data/lib/bundler/compact_index_client/cache.rb +1 -2
  39. data/lib/bundler/compact_index_client/updater.rb +14 -4
  40. data/lib/bundler/compact_index_client.rb +1 -0
  41. data/lib/bundler/compatibility_guard.rb +14 -0
  42. data/lib/bundler/constants.rb +1 -0
  43. data/lib/bundler/current_ruby.rb +13 -5
  44. data/lib/bundler/definition.rb +192 -139
  45. data/lib/bundler/dep_proxy.rb +3 -1
  46. data/lib/bundler/dependency.rb +9 -9
  47. data/lib/bundler/deployment.rb +1 -1
  48. data/lib/bundler/deprecate.rb +15 -3
  49. data/lib/bundler/dsl.rb +115 -64
  50. data/lib/bundler/endpoint_specification.rb +10 -1
  51. data/lib/bundler/env.rb +90 -29
  52. data/lib/bundler/environment_preserver.rb +27 -6
  53. data/lib/bundler/errors.rb +1 -0
  54. data/lib/bundler/feature_flag.rb +46 -4
  55. data/lib/bundler/fetcher/base.rb +1 -0
  56. data/lib/bundler/fetcher/compact_index.rb +2 -11
  57. data/lib/bundler/fetcher/dependency.rb +2 -1
  58. data/lib/bundler/fetcher/downloader.rb +11 -5
  59. data/lib/bundler/fetcher/index.rb +3 -2
  60. data/lib/bundler/fetcher.rb +18 -11
  61. data/lib/bundler/friendly_errors.rb +6 -1
  62. data/lib/bundler/gem_helper.rb +19 -10
  63. data/lib/bundler/gem_helpers.rb +1 -0
  64. data/lib/bundler/gem_remote_fetcher.rb +1 -0
  65. data/lib/bundler/gem_tasks.rb +1 -0
  66. data/lib/bundler/gem_version_promoter.rb +17 -2
  67. data/lib/bundler/gemdeps.rb +1 -0
  68. data/lib/bundler/graph.rb +1 -0
  69. data/lib/bundler/index.rb +8 -8
  70. data/lib/bundler/injector.rb +192 -30
  71. data/lib/bundler/inline.rb +5 -7
  72. data/lib/bundler/installer/gem_installer.rb +11 -2
  73. data/lib/bundler/installer/parallel_installer.rb +78 -42
  74. data/lib/bundler/installer/standalone.rb +1 -0
  75. data/lib/bundler/installer.rb +138 -53
  76. data/lib/bundler/lazy_specification.rb +3 -2
  77. data/lib/bundler/lockfile_generator.rb +95 -0
  78. data/lib/bundler/lockfile_parser.rb +10 -4
  79. data/lib/bundler/match_platform.rb +1 -0
  80. data/lib/bundler/mirror.rb +8 -5
  81. data/lib/bundler/plugin/api/source.rb +9 -2
  82. data/lib/bundler/plugin/events.rb +61 -0
  83. data/lib/bundler/plugin/index.rb +7 -2
  84. data/lib/bundler/plugin/installer.rb +7 -6
  85. data/lib/bundler/plugin/source_list.rb +7 -8
  86. data/lib/bundler/plugin.rb +13 -5
  87. data/lib/bundler/process_lock.rb +24 -0
  88. data/lib/bundler/psyched_yaml.rb +10 -0
  89. data/lib/bundler/remote_specification.rb +1 -0
  90. data/lib/bundler/resolver/spec_group.rb +106 -0
  91. data/lib/bundler/resolver.rb +158 -195
  92. data/lib/bundler/retry.rb +1 -0
  93. data/lib/bundler/ruby_dsl.rb +1 -0
  94. data/lib/bundler/ruby_version.rb +2 -1
  95. data/lib/bundler/rubygems_ext.rb +5 -4
  96. data/lib/bundler/rubygems_gem_installer.rb +31 -1
  97. data/lib/bundler/rubygems_integration.rb +71 -32
  98. data/lib/bundler/runtime.rb +11 -9
  99. data/lib/bundler/settings/validator.rb +102 -0
  100. data/lib/bundler/settings.rb +200 -77
  101. data/lib/bundler/setup.rb +1 -0
  102. data/lib/bundler/shared_helpers.rb +131 -26
  103. data/lib/bundler/similarity_detector.rb +1 -0
  104. data/lib/bundler/source/gemspec.rb +1 -0
  105. data/lib/bundler/source/git/git_proxy.rb +21 -11
  106. data/lib/bundler/source/git.rb +24 -19
  107. data/lib/bundler/source/metadata.rb +62 -0
  108. data/lib/bundler/source/path/installer.rb +2 -0
  109. data/lib/bundler/source/path.rb +8 -8
  110. data/lib/bundler/source/rubygems/remote.rb +8 -2
  111. data/lib/bundler/source/rubygems.rb +161 -84
  112. data/lib/bundler/source.rb +36 -0
  113. data/lib/bundler/source_list.rb +75 -15
  114. data/lib/bundler/spec_set.rb +10 -5
  115. data/lib/bundler/ssl_certs/certificate_manager.rb +2 -1
  116. data/lib/bundler/stub_specification.rb +1 -0
  117. data/lib/bundler/templates/.document +1 -0
  118. data/lib/bundler/templates/Executable +12 -0
  119. data/lib/bundler/templates/Executable.bundler +105 -0
  120. data/lib/bundler/templates/Gemfile +1 -0
  121. data/lib/bundler/templates/gems.rb +8 -0
  122. data/lib/bundler/templates/newgem/README.md.tt +1 -1
  123. data/lib/bundler/templates/newgem/gitignore.tt +0 -1
  124. data/lib/bundler/templates/newgem/lib/newgem.rb.tt +1 -0
  125. data/lib/bundler/templates/newgem/newgem.gemspec.tt +12 -3
  126. data/lib/bundler/templates/newgem/rspec.tt +1 -0
  127. data/lib/bundler/templates/newgem/spec/newgem_spec.rb.tt +0 -2
  128. data/lib/bundler/templates/newgem/{.travis.yml.tt → travis.yml.tt} +2 -0
  129. data/lib/bundler/ui/rg_proxy.rb +1 -0
  130. data/lib/bundler/ui/shell.rb +17 -4
  131. data/lib/bundler/ui/silent.rb +1 -0
  132. data/lib/bundler/ui.rb +1 -0
  133. data/lib/bundler/uri_credentials_filter.rb +1 -0
  134. data/lib/bundler/vendor/fileutils/lib/fileutils.rb +1638 -0
  135. data/lib/bundler/vendor/molinillo/lib/molinillo/compatibility.rb +26 -0
  136. data/lib/bundler/vendor/molinillo/lib/molinillo/delegates/resolution_state.rb +7 -0
  137. data/lib/bundler/vendor/molinillo/lib/molinillo/delegates/specification_provider.rb +1 -0
  138. data/lib/bundler/vendor/molinillo/lib/molinillo/dependency_graph/action.rb +1 -0
  139. data/lib/bundler/vendor/molinillo/lib/molinillo/dependency_graph/add_edge_no_circular.rb +1 -0
  140. data/lib/bundler/vendor/molinillo/lib/molinillo/dependency_graph/add_vertex.rb +1 -0
  141. data/lib/bundler/vendor/molinillo/lib/molinillo/dependency_graph/delete_edge.rb +1 -0
  142. data/lib/bundler/vendor/molinillo/lib/molinillo/dependency_graph/detach_vertex_named.rb +1 -0
  143. data/lib/bundler/vendor/molinillo/lib/molinillo/dependency_graph/log.rb +1 -0
  144. data/lib/bundler/vendor/molinillo/lib/molinillo/dependency_graph/set_payload.rb +1 -0
  145. data/lib/bundler/vendor/molinillo/lib/molinillo/dependency_graph/tag.rb +1 -0
  146. data/lib/bundler/vendor/molinillo/lib/molinillo/dependency_graph/vertex.rb +15 -4
  147. data/lib/bundler/vendor/molinillo/lib/molinillo/dependency_graph.rb +3 -2
  148. data/lib/bundler/vendor/molinillo/lib/molinillo/errors.rb +75 -7
  149. data/lib/bundler/vendor/molinillo/lib/molinillo/gem_metadata.rb +2 -1
  150. data/lib/bundler/vendor/molinillo/lib/molinillo/modules/specification_provider.rb +1 -0
  151. data/lib/bundler/vendor/molinillo/lib/molinillo/modules/ui.rb +3 -1
  152. data/lib/bundler/vendor/molinillo/lib/molinillo/resolution.rb +491 -148
  153. data/lib/bundler/vendor/molinillo/lib/molinillo/resolver.rb +1 -0
  154. data/lib/bundler/vendor/molinillo/lib/molinillo/state.rb +8 -4
  155. data/lib/bundler/vendor/molinillo/lib/molinillo.rb +2 -0
  156. data/lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb +1 -1
  157. data/lib/bundler/vendor/thor/lib/thor/actions/create_file.rb +1 -0
  158. data/lib/bundler/vendor/thor/lib/thor/actions/create_link.rb +1 -0
  159. data/lib/bundler/vendor/thor/lib/thor/actions/empty_directory.rb +9 -1
  160. data/lib/bundler/vendor/thor/lib/thor/actions/file_manipulation.rb +45 -8
  161. data/lib/bundler/vendor/thor/lib/thor/actions/inject_into_file.rb +9 -3
  162. data/lib/bundler/vendor/thor/lib/thor/actions.rb +6 -3
  163. data/lib/bundler/vendor/thor/lib/thor/base.rb +27 -4
  164. data/lib/bundler/vendor/thor/lib/thor/command.rb +9 -7
  165. data/lib/bundler/vendor/thor/lib/thor/core_ext/hash_with_indifferent_access.rb +12 -0
  166. data/lib/bundler/vendor/thor/lib/thor/group.rb +1 -1
  167. data/lib/bundler/vendor/thor/lib/thor/line_editor/basic.rb +2 -0
  168. data/lib/bundler/vendor/thor/lib/thor/parser/option.rb +5 -5
  169. data/lib/bundler/vendor/thor/lib/thor/parser/options.rb +6 -5
  170. data/lib/bundler/vendor/thor/lib/thor/runner.rb +6 -4
  171. data/lib/bundler/vendor/thor/lib/thor/shell/basic.rb +10 -9
  172. data/lib/bundler/vendor/thor/lib/thor/version.rb +1 -1
  173. data/lib/bundler/vendor/thor/lib/thor.rb +25 -8
  174. data/lib/bundler/vendored_fileutils.rb +9 -0
  175. data/lib/bundler/vendored_molinillo.rb +1 -0
  176. data/lib/bundler/vendored_persistent.rb +35 -0
  177. data/lib/bundler/vendored_thor.rb +1 -0
  178. data/lib/bundler/version.rb +6 -2
  179. data/lib/bundler/version_ranges.rb +1 -0
  180. data/lib/bundler/vlad.rb +5 -0
  181. data/lib/bundler/worker.rb +1 -0
  182. data/lib/bundler/yaml_serializer.rb +3 -3
  183. data/lib/bundler.rb +86 -52
  184. data/man/bundle-add.1 +18 -3
  185. data/man/bundle-add.1.txt +26 -14
  186. data/man/bundle-add.ronn +13 -2
  187. data/man/bundle-binstubs.1 +11 -1
  188. data/man/bundle-binstubs.1.txt +33 -18
  189. data/man/bundle-binstubs.ronn +15 -1
  190. data/man/bundle-check.1 +4 -4
  191. data/man/bundle-check.1.txt +15 -14
  192. data/man/bundle-check.ronn +3 -3
  193. data/man/bundle-clean.1 +1 -1
  194. data/man/bundle-clean.1.txt +10 -10
  195. data/man/bundle-config.1 +129 -29
  196. data/man/bundle-config.1.txt +285 -174
  197. data/man/bundle-config.ronn +167 -88
  198. data/man/bundle-doctor.1 +44 -0
  199. data/man/bundle-doctor.1.txt +44 -0
  200. data/man/bundle-doctor.ronn +33 -0
  201. data/man/bundle-exec.1 +6 -3
  202. data/man/bundle-exec.1.txt +78 -71
  203. data/man/bundle-exec.ronn +10 -3
  204. data/man/bundle-gem.1 +3 -3
  205. data/man/bundle-gem.1.txt +40 -39
  206. data/man/bundle-gem.ronn +2 -1
  207. data/man/bundle-info.1 +1 -1
  208. data/man/bundle-info.1.txt +8 -8
  209. data/man/bundle-init.1 +9 -4
  210. data/man/bundle-init.1.txt +23 -13
  211. data/man/bundle-init.ronn +15 -4
  212. data/man/bundle-inject.1 +4 -4
  213. data/man/bundle-inject.1.txt +10 -10
  214. data/man/bundle-inject.ronn +3 -3
  215. data/man/bundle-install.1 +31 -28
  216. data/man/bundle-install.1.txt +205 -194
  217. data/man/bundle-install.ronn +44 -35
  218. data/man/bundle-list.1 +50 -0
  219. data/man/bundle-list.1.txt +43 -0
  220. data/man/bundle-list.ronn +33 -0
  221. data/man/bundle-lock.1 +1 -1
  222. data/man/bundle-lock.1.txt +47 -47
  223. data/man/bundle-lock.ronn +1 -1
  224. data/man/bundle-open.1 +1 -1
  225. data/man/bundle-open.1.txt +7 -7
  226. data/man/bundle-outdated.1 +7 -3
  227. data/man/bundle-outdated.1.txt +40 -36
  228. data/man/bundle-outdated.ronn +6 -2
  229. data/man/bundle-package.1 +6 -3
  230. data/man/bundle-package.1.txt +44 -39
  231. data/man/bundle-package.ronn +7 -2
  232. data/man/bundle-platform.1 +1 -1
  233. data/man/bundle-platform.1.txt +13 -13
  234. data/man/bundle-pristine.1 +21 -3
  235. data/man/bundle-pristine.1.txt +33 -10
  236. data/man/bundle-pristine.ronn +24 -3
  237. data/man/bundle-remove.1 +31 -0
  238. data/man/bundle-remove.1.txt +34 -0
  239. data/man/bundle-remove.ronn +23 -0
  240. data/man/bundle-show.1 +3 -3
  241. data/man/bundle-show.1.txt +14 -12
  242. data/man/bundle-show.ronn +3 -2
  243. data/man/bundle-update.1 +13 -9
  244. data/man/bundle-update.1.txt +133 -130
  245. data/man/bundle-update.ronn +21 -17
  246. data/man/bundle-viz.1 +7 -7
  247. data/man/bundle-viz.1.txt +17 -15
  248. data/man/bundle-viz.ronn +6 -6
  249. data/man/bundle.1 +31 -23
  250. data/man/bundle.1.txt +63 -57
  251. data/man/bundle.ronn +35 -29
  252. data/man/gemfile.5 +44 -8
  253. data/man/gemfile.5.ronn +54 -8
  254. data/man/gemfile.5.txt +218 -165
  255. data/man/index.txt +25 -15
  256. metadata +36 -36
  257. data/.codeclimate.yml +0 -25
  258. data/.gitignore +0 -18
  259. data/.rspec +0 -3
  260. data/.rubocop.yml +0 -131
  261. data/.rubocop_todo.yml +0 -418
  262. data/.travis.yml +0 -122
  263. data/CODE_OF_CONDUCT.md +0 -42
  264. data/CONTRIBUTING.md +0 -17
  265. data/Rakefile +0 -338
  266. data/bin/rake +0 -19
  267. data/bin/rspec +0 -15
  268. data/bin/rubocop +0 -17
  269. data/bin/with_rubygems +0 -39
  270. data/doc/README.md +0 -30
  271. data/doc/TROUBLESHOOTING.md +0 -64
  272. data/doc/contributing/BUG_TRIAGE.md +0 -36
  273. data/doc/contributing/COMMUNITY.md +0 -13
  274. data/doc/contributing/GETTING_HELP.md +0 -11
  275. data/doc/contributing/HOW_YOU_CAN_HELP.md +0 -27
  276. data/doc/contributing/ISSUES.md +0 -51
  277. data/doc/contributing/README.md +0 -38
  278. data/doc/development/NEW_FEATURES.md +0 -10
  279. data/doc/development/PULL_REQUESTS.md +0 -40
  280. data/doc/development/README.md +0 -19
  281. data/doc/development/RELEASING.md +0 -9
  282. data/doc/development/SETUP.md +0 -27
  283. data/doc/documentation/README.md +0 -29
  284. data/doc/documentation/VISION.md +0 -26
  285. data/doc/documentation/WRITING.md +0 -54
  286. data/task/release.rake +0 -116
@@ -7,10 +7,14 @@ bundle-config(1) -- Set bundler configuration options
7
7
 
8
8
  ## DESCRIPTION
9
9
 
10
- This command allows you to interact with bundler's configuration system.
11
- Bundler retrieves its configuration from the local application (`app/.bundle/config`),
12
- environment variables, and the user's home directory (`~/.bundle/config`),
13
- in that order of priority.
10
+ This command allows you to interact with Bundler's configuration system.
11
+
12
+ Bundler loads configuration settings in this order:
13
+
14
+ 1. Local config (`app/.bundle/config`)
15
+ 2. Environmental variables (`ENV`)
16
+ 3. Global config (`~/.bundle/config`)
17
+ 4. Bundler default config
14
18
 
15
19
  Executing `bundle config` with no parameters will print a list of all
16
20
  bundler configuration for the current bundle, and where that configuration
@@ -49,31 +53,34 @@ If these options must be remembered,they must be set using `bundle config`
49
53
  The options that can be configured are:
50
54
 
51
55
  * `bin`:
52
- Creates a directory (defaults to `~/bin`) and place any executables from the
53
- gem there. These executables run in Bundler's context. If used, you might add
54
- this directory to your environment's `PATH` variable. For instance, if the
55
- `rails` gem comes with a `rails` executable, this flag will create a
56
- `bin/rails` executable that ensures that all referred dependencies will be
57
- resolved using the bundled gems.
56
+ Creates a directory (defaults to `~/bin`) and place any executables from the
57
+ gem there. These executables run in Bundler's context. If used, you might add
58
+ this directory to your environment's `PATH` variable. For instance, if the
59
+ `rails` gem comes with a `rails` executable, this flag will create a
60
+ `bin/rails` executable that ensures that all referred dependencies will be
61
+ resolved using the bundled gems.
58
62
 
59
63
  * `deployment`:
60
- In deployment mode, Bundler will 'roll-out' the bundle for
61
- `production` use. Please check carefully if you want to have this option
62
- enabled in `development` or `test` environments.
64
+ In deployment mode, Bundler will 'roll-out' the bundle for
65
+ `production` use. Please check carefully if you want to have this option
66
+ enabled in `development` or `test` environments.
63
67
 
64
68
  * `path`:
65
- The location to install the specified gems to. This defaults to Rubygems'
66
- setting. Bundler shares this location with Rubygems, `gem install ...` will
67
- have gem installed there, too. Therefore, gems installed without a
68
- `--path ...` setting will show up by calling `gem list`. Accordingly, gems
69
- installed to other locations will not get listed.
69
+ The location to install the specified gems to. This defaults to Rubygems'
70
+ setting. Bundler shares this location with Rubygems, `gem install ...` will
71
+ have gem installed there, too. Therefore, gems installed without a
72
+ `--path ...` setting will show up by calling `gem list`. Accordingly, gems
73
+ installed to other locations will not get listed.
70
74
 
71
75
  * `without`:
72
- A space-separated list of groups referencing gems to skip during installation.
76
+ A space-separated list of groups referencing gems to skip during installation.
77
+
78
+ * `with`:
79
+ A space-separated list of groups referencing gems to include during installation.
73
80
 
74
81
  ## BUILD OPTIONS
75
82
 
76
- You can use `bundle config` to give bundler the flags to pass to the gem
83
+ You can use `bundle config` to give Bundler the flags to pass to the gem
77
84
  installer every time bundler tries to install a particular gem.
78
85
 
79
86
  A very common example, the `mysql` gem, requires Snow Leopard users to
@@ -95,12 +102,12 @@ After running this command, every time bundler needs to install the
95
102
  Configuration keys in bundler have two forms: the canonical form and the
96
103
  environment variable form.
97
104
 
98
- For instance, passing the `--without` flag to [bundle install(1)][bundle-install]
105
+ For instance, passing the `--without` flag to [bundle install(1)](bundle-install.1.html)
99
106
  prevents Bundler from installing certain groups specified in the Gemfile(5). Bundler
100
107
  persists this value in `app/.bundle/config` so that calls to `Bundler.setup`
101
108
  do not try to find gems from the `Gemfile` that you didn't install. Additionally,
102
- subsequent calls to [bundle install(1)][bundle-install] remember this setting and skip those
103
- groups.
109
+ subsequent calls to [bundle install(1)](bundle-install.1.html) remember this setting
110
+ and skip those groups.
104
111
 
105
112
  The canonical form of this configuration is `"without"`. To convert the canonical
106
113
  form to the environment variable form, capitalize it, and prepend `BUNDLE_`. The
@@ -113,88 +120,96 @@ the environment variable `BUNDLE_LOCAL__RACK`.
113
120
  ## LIST OF AVAILABLE KEYS
114
121
 
115
122
  The following is a list of all configuration keys and their purpose. You can
116
- learn more about their operation in [bundle install(1)][bundle-install].
117
-
118
- * `path` (`BUNDLE_PATH`):
119
- The location on disk where all gems in your bundle will be located regardless
120
- of `$GEM_HOME` or `$GEM_PATH` values. Bundle gems not found in this location
121
- will be installed by `bundle install`. Defaults to `Gem.dir`. When --deployment is
122
- used, defaults to vendor/bundle.
123
- * `frozen` (`BUNDLE_FROZEN`):
124
- Disallow changes to the `Gemfile`. Defaults to `true` when `--deployment`
125
- is used.
126
- * `without` (`BUNDLE_WITHOUT`):
127
- A `:`-separated list of groups whose gems bundler should not install
128
- * `bin` (`BUNDLE_BIN`):
129
- Install executables from gems in the bundle to the specified directory.
130
- Defaults to `false`.
131
- * `gemfile` (`BUNDLE_GEMFILE`):
132
- The name of the file that bundler should use as the `Gemfile`. This location
133
- of this file also sets the root of the project, which is used to resolve
134
- relative paths in the `Gemfile`, among other things. By default, bundler
135
- will search up from the current working directory until it finds a
136
- `Gemfile`.
137
- * `ssl_ca_cert` (`BUNDLE_SSL_CA_CERT`):
138
- Path to a designated CA certificate file or folder containing multiple
139
- certificates for trusted CAs in PEM format.
140
- * `ssl_client_cert` (`BUNDLE_SSL_CLIENT_CERT`):
141
- Path to a designated file containing a X.509 client certificate
142
- and key in PEM format.
143
- * `cache_path` (`BUNDLE_CACHE_PATH`): The directory that bundler will place
144
- cached gems in when running <code>bundle package</code>, and that bundler
145
- will look in when installing gems. Defaults to `vendor/bundle`.
146
- * `disable_multisource` (`BUNDLE_DISABLE_MULTISOURCE`): When set, Gemfiles
147
- containing multiple sources will produce errors instead of warnings. Use
148
- `bundle config --delete disable_multisource` to unset.
149
- * `ignore_messages` (`BUNDLE_IGNORE_MESSAGES`): When set, no post install
150
- messages will be printed. To silence a single gem, use dot notation like
151
- `ignore_messages.httparty true`.
152
- * `retry` (`BUNDLE_RETRY`):
153
- The number of times to retry failed network requests. Defaults to `3`.
154
- * `redirect` (`BUNDLE_REDIRECT`):
155
- The number of redirects allowed for network requests. Defaults to `5`.
156
- * `timeout` (`BUNDLE_TIMEOUT`):
157
- The seconds allowed before timing out for network requests. Defaults to `10`.
158
- * `force_ruby_platform` (`BUNDLE_FORCE_RUBY_PLATFORM`):
159
- Ignore the current machine's platform and install only `ruby` platform gems.
160
- As a result, gems with native extensions will be compiled from source.
161
- * `specific_platform` (`BUNDLE_SPECIFIC_PLATFORM`):
162
- Allow bundler to resolve for the specific running platform and store it in
163
- the lockfile, instead of only using a generic platform.
164
- A specific platform is the exact platform triple reported by
165
- `Gem::Platform.local`, such as `x86_64-darwin-16` or `universal-java-1.8`.
166
- On the other hand, generic platforms are those such as `ruby`, `mswin`, or
167
- `java`. In this example, `x86_64-darwin-16` would map to `ruby` and
168
- `universal-java-1.8` to `java`.
169
- * `disable_checksum_validation` (`BUNDLE_DISABLE_CHECKSUM_VALIDATION`):
170
- Allow installing gems even if they do not match the checksum provided by
171
- RubyGems.
172
- * `disable_version_check` (`BUNDLE_DISABLE_VERSION_CHECK`):
173
- Stop Bundler from checking if a newer Bundler version is available on
174
- rubygems.org.
123
+ learn more about their operation in [bundle install(1)](bundle-install.1.html).
124
+
125
+ * `allow_bundler_dependency_conflicts` (`BUNDLE_ALLOW_BUNDLER_DEPENDENCY_CONFLICTS`):
126
+ Allow resolving to specifications that have dependencies on `bundler` that
127
+ are incompatible with the running Bundler version.
128
+ * `allow_deployment_source_credential_changes` (`BUNDLE_ALLOW_DEPLOYMENT_SOURCE_CREDENTIAL_CHANGES`):
129
+ When in deployment mode, allow changing the credentials to a gem's source.
130
+ Ex: `https://some.host.com/gems/path/` -> `https://user_name:password@some.host.com/gems/path`
175
131
  * `allow_offline_install` (`BUNDLE_ALLOW_OFFLINE_INSTALL`):
176
132
  Allow Bundler to use cached data when installing without network access.
133
+ * `auto_clean_without_path` (`BUNDLE_AUTO_CLEAN_WITHOUT_PATH`):
134
+ Automatically run `bundle clean` after installing when an explicit `path`
135
+ has not been set and Bundler is not installing into the system gems.
177
136
  * `auto_install` (`BUNDLE_AUTO_INSTALL`):
178
137
  Automatically run `bundle install` when gems are missing.
179
- * `cache_all_platforms` (`BUNDLE_CACHE_ALL_PLATFORMS`):
180
- Cache gems for all platforms.
138
+ * `bin` (`BUNDLE_BIN`):
139
+ Install executables from gems in the bundle to the specified directory.
140
+ Defaults to `false`.
181
141
  * `cache_all` (`BUNDLE_CACHE_ALL`):
182
142
  Cache all gems, including path and git gems.
143
+ * `cache_all_platforms` (`BUNDLE_CACHE_ALL_PLATFORMS`):
144
+ Cache gems for all platforms.
145
+ * `cache_path` (`BUNDLE_CACHE_PATH`):
146
+ The directory that bundler will place cached gems in when running
147
+ <code>bundle package</code>, and that bundler will look in when installing gems.
148
+ Defaults to `vendor/bundle`.
183
149
  * `clean` (`BUNDLE_CLEAN`):
184
150
  Whether Bundler should run `bundle clean` automatically after
185
151
  `bundle install`.
186
152
  * `console` (`BUNDLE_CONSOLE`):
187
153
  The console that `bundle console` starts. Defaults to `irb`.
154
+ * `default_install_uses_path` (`BUNDLE_DEFAULT_INSTALL_USES_PATH`):
155
+ Whether a `bundle install` without an explicit `--path` argument defaults
156
+ to installing gems in `.bundle`.
157
+ * `deployment` (`BUNDLE_DEPLOYMENT`):
158
+ Disallow changes to the `Gemfile`. When the `Gemfile` is changed and the
159
+ lockfile has not been updated, running Bundler commands will be blocked.
160
+ * `disable_checksum_validation` (`BUNDLE_DISABLE_CHECKSUM_VALIDATION`):
161
+ Allow installing gems even if they do not match the checksum provided by
162
+ RubyGems.
188
163
  * `disable_exec_load` (`BUNDLE_DISABLE_EXEC_LOAD`):
189
164
  Stop Bundler from using `load` to launch an executable in-process in
190
165
  `bundle exec`.
191
166
  * `disable_local_branch_check` (`BUNDLE_DISABLE_LOCAL_BRANCH_CHECK`):
192
167
  Allow Bundler to use a local git override without a branch specified in the
193
168
  Gemfile.
169
+ * `disable_multisource` (`BUNDLE_DISABLE_MULTISOURCE`):
170
+ When set, Gemfiles containing multiple sources will produce errors
171
+ instead of warnings.
172
+ Use `bundle config --delete disable_multisource` to unset.
173
+ * `disable_platform_warnings` (`BUNDLE_DISABLE_PLATFORM_WARNINGS`):
174
+ Disable warnings during bundle install when a dependency is unused on the current platform.
194
175
  * `disable_shared_gems` (`BUNDLE_DISABLE_SHARED_GEMS`):
195
176
  Stop Bundler from accessing gems installed to RubyGems' normal location.
177
+ * `disable_version_check` (`BUNDLE_DISABLE_VERSION_CHECK`):
178
+ Stop Bundler from checking if a newer Bundler version is available on
179
+ rubygems.org.
180
+ * `error_on_stderr` (`BUNDLE_ERROR_ON_STDERR`):
181
+ Print Bundler errors to stderr.
182
+ * `force_ruby_platform` (`BUNDLE_FORCE_RUBY_PLATFORM`):
183
+ Ignore the current machine's platform and install only `ruby` platform gems.
184
+ As a result, gems with native extensions will be compiled from source.
185
+ * `frozen` (`BUNDLE_FROZEN`):
186
+ Disallow changes to the `Gemfile`. When the `Gemfile` is changed and the
187
+ lockfile has not been updated, running Bundler commands will be blocked.
188
+ Defaults to `true` when `--deployment` is used.
189
+ * `gem.push_key` (`BUNDLE_GEM__PUSH_KEY`):
190
+ Sets the `--key` parameter for `gem push` when using the `rake release`
191
+ command with a private gemstash server.
192
+ * `gemfile` (`BUNDLE_GEMFILE`):
193
+ The name of the file that bundler should use as the `Gemfile`. This location
194
+ of this file also sets the root of the project, which is used to resolve
195
+ relative paths in the `Gemfile`, among other things. By default, bundler
196
+ will search up from the current working directory until it finds a
197
+ `Gemfile`.
198
+ * `global_gem_cache` (`BUNDLE_GLOBAL_GEM_CACHE`):
199
+ Whether Bundler should cache all gems globally, rather than locally to the
200
+ installing Ruby installation.
201
+ * `global_path_appends_ruby_scope` (`BUNDLE_GLOBAL_PATH_APPENDS_RUBY_SCOPE`):
202
+ Whether Bundler should append the Ruby scope (e.g. engine and ABI version)
203
+ to a globally-configured path.
204
+ * `ignore_messages` (`BUNDLE_IGNORE_MESSAGES`): When set, no post install
205
+ messages will be printed. To silence a single gem, use dot notation like
206
+ `ignore_messages.httparty true`.
207
+ * `init_gems_rb` (`BUNDLE_INIT_GEMS_RB`)
208
+ Generate a `gems.rb` instead of a `Gemfile` when running `bundle init`.
196
209
  * `jobs` (`BUNDLE_JOBS`):
197
210
  The number of gems Bundler can install in parallel. Defaults to 1.
211
+ * `list_command` (`BUNDLE_LIST_COMMAND`)
212
+ Enable new list command feature
198
213
  * `major_deprecations` (`BUNDLE_MAJOR_DEPRECATIONS`):
199
214
  Whether Bundler should print deprecation warnings for behavior that will
200
215
  be changed in the next major version.
@@ -205,26 +220,75 @@ learn more about their operation in [bundle install(1)][bundle-install].
205
220
  * `only_update_to_newer_versions` (`BUNDLE_ONLY_UPDATE_TO_NEWER_VERSIONS`):
206
221
  During `bundle update`, only resolve to newer versions of the gems in the
207
222
  lockfile.
223
+ * `path` (`BUNDLE_PATH`):
224
+ The location on disk where all gems in your bundle will be located regardless
225
+ of `$GEM_HOME` or `$GEM_PATH` values. Bundle gems not found in this location
226
+ will be installed by `bundle install`. Defaults to `Gem.dir`. When --deployment
227
+ is used, defaults to vendor/bundle.
228
+ * `path.system` (`BUNDLE_PATH__SYSTEM`):
229
+ Whether Bundler will install gems into the default system path (`Gem.dir`).
230
+ * `path_relative_to_cwd` (`PATH_RELATIVE_TO_CWD`)
231
+ Makes `--path` relative to the CWD instead of the `Gemfile`.
208
232
  * `plugins` (`BUNDLE_PLUGINS`):
209
233
  Enable Bundler's experimental plugin system.
234
+ * `prefer_gems_rb` (`BUNDLE_PREFER_GEMS_RB`)
235
+ Prefer `gems.rb` to `Gemfile` when Bundler is searching for a Gemfile.
236
+ * `print_only_version_number` (`BUNDLE_PRINT_ONLY_VERSION_NUMBER`)
237
+ Print only version number from `bundler --version`.
238
+ * `redirect` (`BUNDLE_REDIRECT`):
239
+ The number of redirects allowed for network requests. Defaults to `5`.
240
+ * `retry` (`BUNDLE_RETRY`):
241
+ The number of times to retry failed network requests. Defaults to `3`.
242
+ * `setup_makes_kernel_gem_public` (`BUNDLE_SETUP_MAKES_KERNEL_GEM_PUBLIC`):
243
+ Have `Bundler.setup` make the `Kernel#gem` method public, even though
244
+ RubyGems declares it as private.
210
245
  * `shebang` (`BUNDLE_SHEBANG`):
211
246
  The program name that should be invoked for generated binstubs. Defaults to
212
247
  the ruby install name used to generate the binstub.
213
248
  * `silence_root_warning` (`BUNDLE_SILENCE_ROOT_WARNING`):
214
249
  Silence the warning Bundler prints when installing gems as root.
250
+ * `skip_default_git_sources` (`BUNDLE_SKIP_DEFAULT_GIT_SOURCES`):
251
+ Whether Bundler should skip adding default git source shortcuts to the
252
+ Gemfile DSL.
253
+ * `specific_platform` (`BUNDLE_SPECIFIC_PLATFORM`):
254
+ Allow bundler to resolve for the specific running platform and store it in
255
+ the lockfile, instead of only using a generic platform.
256
+ A specific platform is the exact platform triple reported by
257
+ `Gem::Platform.local`, such as `x86_64-darwin-16` or `universal-java-1.8`.
258
+ On the other hand, generic platforms are those such as `ruby`, `mswin`, or
259
+ `java`. In this example, `x86_64-darwin-16` would map to `ruby` and
260
+ `universal-java-1.8` to `java`.
261
+ * `ssl_ca_cert` (`BUNDLE_SSL_CA_CERT`):
262
+ Path to a designated CA certificate file or folder containing multiple
263
+ certificates for trusted CAs in PEM format.
264
+ * `ssl_client_cert` (`BUNDLE_SSL_CLIENT_CERT`):
265
+ Path to a designated file containing a X.509 client certificate
266
+ and key in PEM format.
215
267
  * `ssl_verify_mode` (`BUNDLE_SSL_VERIFY_MODE`):
216
268
  The SSL verification mode Bundler uses when making HTTPS requests.
217
269
  Defaults to verify peer.
270
+ * `suppress_install_using_messages` (`BUNDLE_SUPPRESS_INSTALL_USING_MESSAGES`):
271
+ Avoid printing `Using ...` messages during installation when the version of
272
+ a gem has not changed.
218
273
  * `system_bindir` (`BUNDLE_SYSTEM_BINDIR`):
219
274
  The location where RubyGems installs binstubs. Defaults to `Gem.bindir`.
275
+ * `timeout` (`BUNDLE_TIMEOUT`):
276
+ The seconds allowed before timing out for network requests. Defaults to `10`.
277
+ * `unlock_source_unlocks_spec` (`BUNDLE_UNLOCK_SOURCE_UNLOCKS_SPEC`):
278
+ Whether running `bundle update --source NAME` unlocks a gem with the given
279
+ name. Defaults to `true`.
280
+ * `update_requires_all_flag` (`BUNDLE_UPDATE_REQUIRES_ALL_FLAG`)
281
+ Require passing `--all` to `bundle update` when everything should be updated,
282
+ and disallow passing no options to `bundle update`.
220
283
  * `user_agent` (`BUNDLE_USER_AGENT`):
221
284
  The custom user agent fragment Bundler includes in API requests.
222
- * `gem.push_key` (`BUNDLE_GEM__PUSH_KEY`):
223
- Sets the `--key` paramter for `gem push` when using the `rake release`
224
- command with a private gemstash server.
285
+ * `with` (`BUNDLE_WITH`):
286
+ A `:`-separated list of groups whose gems bundler should install.
287
+ * `without` (`BUNDLE_WITHOUT`):
288
+ A `:`-separated list of groups whose gems bundler should not install.
225
289
 
226
290
  In general, you should set these settings per-application by using the applicable
227
- flag to the [bundle install(1)][bundle-install] or [bundle package(1)][bundle-package] command.
291
+ flag to the [bundle install(1)](bundle-install.1.html) or [bundle package(1)](bundle-package.1.html) command.
228
292
 
229
293
  You can set them globally either via environment variables or `bundle config`,
230
294
  whichever is preferable for your setup. If you use both, environment variables
@@ -250,6 +314,7 @@ revision in the `Gemfile.lock` to the local git repo revision. This
250
314
  requires the same attention as git submodules. Before pushing to
251
315
  the remote, you need to ensure the local override was pushed, otherwise
252
316
  you may point to a commit that only exists in your local machine.
317
+ You'll also need to CGI escape your usernames and passwords as well.
253
318
 
254
319
  Bundler does many checks to ensure a developer won't work with
255
320
  invalid references. Particularly, we force a developer to specify
@@ -316,3 +381,17 @@ This is especially useful for private repositories on hosts such as Github,
316
381
  where you can use personal OAuth tokens:
317
382
 
318
383
  export BUNDLE_GITHUB__COM=abcd0123generatedtoken:x-oauth-basic
384
+
385
+
386
+ ## CONFIGURE BUNDLER DIRECTORIES
387
+
388
+ Bundler's home, config, cache and plugin directories are able to be configured
389
+ through environment variables. The default location for Bundler's home directory is
390
+ `~/.bundle`, which all directories inherit from by default. The following
391
+ outlines the available environment variables and their default values
392
+
393
+ BUNDLE_USER_HOME : $HOME/.bundle
394
+ BUNDLE_USER_CACHE : $BUNDLE_USER_HOME/cache
395
+ BUNDLE_USER_CONFIG : $BUNDLE_USER_HOME/config
396
+ BUNDLE_USER_PLUGIN : $BUNDLE_USER_HOME/plugin
397
+
@@ -0,0 +1,44 @@
1
+ .\" generated with Ronn/v0.7.3
2
+ .\" http://github.com/rtomayko/ronn/tree/0.7.3
3
+ .
4
+ .TH "BUNDLE\-DOCTOR" "1" "November 2018" "" ""
5
+ .
6
+ .SH "NAME"
7
+ \fBbundle\-doctor\fR \- Checks the bundle for common problems
8
+ .
9
+ .SH "SYNOPSIS"
10
+ \fBbundle doctor\fR [\-\-quiet] [\-\-gemfile=GEMFILE]
11
+ .
12
+ .SH "DESCRIPTION"
13
+ 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\.
14
+ .
15
+ .P
16
+ Examples of common problems caught by bundle\-doctor include:
17
+ .
18
+ .IP "\(bu" 4
19
+ Invalid Bundler settings
20
+ .
21
+ .IP "\(bu" 4
22
+ Mismatched Ruby versions
23
+ .
24
+ .IP "\(bu" 4
25
+ Mismatched platforms
26
+ .
27
+ .IP "\(bu" 4
28
+ Uninstalled gems
29
+ .
30
+ .IP "\(bu" 4
31
+ Missing dependencies
32
+ .
33
+ .IP "" 0
34
+ .
35
+ .SH "OPTIONS"
36
+ .
37
+ .TP
38
+ \fB\-\-quiet\fR
39
+ Only output warnings and errors\.
40
+ .
41
+ .TP
42
+ \fB\-\-gemfile=<gemfile>\fR
43
+ 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\.
44
+
@@ -0,0 +1,44 @@
1
+ BUNDLE-DOCTOR(1) BUNDLE-DOCTOR(1)
2
+
3
+
4
+
5
+ NAME
6
+ bundle-doctor - Checks the bundle for common problems
7
+
8
+ SYNOPSIS
9
+ bundle doctor [--quiet] [--gemfile=GEMFILE]
10
+
11
+ DESCRIPTION
12
+ Checks your Gemfile and gem environment for common problems. If issues
13
+ are detected, Bundler prints them and exits status 1. Otherwise,
14
+ Bundler prints a success message and exits status 0.
15
+
16
+ Examples of common problems caught by bundle-doctor include:
17
+
18
+ o Invalid Bundler settings
19
+
20
+ o Mismatched Ruby versions
21
+
22
+ o Mismatched platforms
23
+
24
+ o Uninstalled gems
25
+
26
+ o Missing dependencies
27
+
28
+
29
+
30
+ OPTIONS
31
+ --quiet
32
+ Only output warnings and errors.
33
+
34
+ --gemfile=<gemfile>
35
+ The location of the Gemfile(5) which Bundler should use. This
36
+ defaults to a Gemfile(5) in the current working directory. In
37
+ general, Bundler will assume that the location of the Gemfile(5)
38
+ is also the project's root and will try to find Gemfile.lock and
39
+ vendor/cache relative to this location.
40
+
41
+
42
+
43
+
44
+ November 2018 BUNDLE-DOCTOR(1)
@@ -0,0 +1,33 @@
1
+ bundle-doctor(1) -- Checks the bundle for common problems
2
+ =========================================================
3
+
4
+ ## SYNOPSIS
5
+
6
+ `bundle doctor` [--quiet]
7
+ [--gemfile=GEMFILE]
8
+
9
+ ## DESCRIPTION
10
+
11
+ Checks your Gemfile and gem environment for common problems. If issues
12
+ are detected, Bundler prints them and exits status 1. Otherwise,
13
+ Bundler prints a success message and exits status 0.
14
+
15
+ Examples of common problems caught by bundle-doctor include:
16
+
17
+ * Invalid Bundler settings
18
+ * Mismatched Ruby versions
19
+ * Mismatched platforms
20
+ * Uninstalled gems
21
+ * Missing dependencies
22
+
23
+ ## OPTIONS
24
+
25
+ * `--quiet`:
26
+ Only output warnings and errors.
27
+
28
+ * `--gemfile=<gemfile>`:
29
+ The location of the Gemfile(5) which Bundler should use. This defaults
30
+ to a Gemfile(5) in the current working directory. In general, Bundler
31
+ will assume that the location of the Gemfile(5) is also the project's
32
+ root and will try to find `Gemfile.lock` and `vendor/cache` relative
33
+ to this location.
data/man/bundle-exec.1 CHANGED
@@ -1,7 +1,7 @@
1
1
  .\" generated with Ronn/v0.7.3
2
2
  .\" http://github.com/rtomayko/ronn/tree/0.7.3
3
3
  .
4
- .TH "BUNDLE\-EXEC" "1" "June 2017" "" ""
4
+ .TH "BUNDLE\-EXEC" "1" "November 2018" "" ""
5
5
  .
6
6
  .SH "NAME"
7
7
  \fBbundle\-exec\fR \- Execute a command in the context of the bundle
@@ -10,10 +10,10 @@
10
10
  \fBbundle exec\fR [\-\-keep\-file\-descriptors] \fIcommand\fR
11
11
  .
12
12
  .SH "DESCRIPTION"
13
- This command executes the command, making all gems specified in the \fBGemfile(5)\fR available to \fBrequire\fR in Ruby programs\.
13
+ This command executes the command, making all gems specified in the [\fBGemfile(5)\fR][Gemfile(5)] available to \fBrequire\fR in Ruby programs\.
14
14
  .
15
15
  .P
16
- Essentially, if you would normally have run something like \fBrspec spec/my_spec\.rb\fR, and you want to use the gems specified in the \fBGemfile(5)\fR and installed via bundle install(1) \fIbundle\-install\.1\.html\fR, you should run \fBbundle exec rspec spec/my_spec\.rb\fR\.
16
+ Essentially, if you would normally have run something like \fBrspec spec/my_spec\.rb\fR, and you want to use the gems specified in the [\fBGemfile(5)\fR][Gemfile(5)] and installed via bundle install(1) \fIbundle\-install\.1\.html\fR, you should run \fBbundle exec rspec spec/my_spec\.rb\fR\.
17
17
  .
18
18
  .P
19
19
  Note that \fBbundle exec\fR does not require that an executable is available on your shell\'s \fB$PATH\fR\.
@@ -67,6 +67,9 @@ Add all gems in the bundle into Gem\.loaded_specs
67
67
  .
68
68
  .IP "" 0
69
69
  .
70
+ .P
71
+ Finally, \fBbundle exec\fR also implicitly modifies \fBGemfile\.lock\fR if the lockfile and the Gemfile do not match\. Bundler needs the Gemfile to determine things such as a gem\'s groups, \fBautorequire\fR, and platforms, etc\., and that information isn\'t stored in the lockfile\. The Gemfile and lockfile must be synced in order to \fBbundle exec\fR successfully, so \fBbundle exec\fR updates the lockfile beforehand\.
72
+ .
70
73
  .SS "Loading"
71
74
  By default, when attempting to \fBbundle exec\fR to a file with a ruby shebang, Bundler will \fBKernel\.load\fR that file instead of using \fBKernel\.exec\fR\. For the vast majority of cases, this is a performance improvement\. In a rare few cases, this could cause some subtle side\-effects (such as dependence on the exact contents of \fB$0\fR or \fB__FILE__\fR) and the optimization can be disabled by enabling the \fBdisable_exec_load\fR setting\.
72
75
  .