Merge #7389

7389: Wrap up `bundle cache` migration to current `bundle package` r=indirect a=deivid-rodriguez ### What was the end-user problem that led to this PR? The problem was that after #7249, we added the current `bundle package` functionality to the current `bundle cache` command, so that these commands are now aliases of each other. The initial plan was to do this in a more careful manner but we concluded that this was only _adding_ functionality to `bundle cache`, so not backwards incompatible. We still need to wrap up the original plan, where `bundle cache` is the preferred command. ### What is your fix for the problem, implemented in this PR? My fix is to migrate docs, tests and help text to use `bundle cache`, and to remove duplicated specs for `bundle cache` and `bundle package`, since they are testing the exact same code. Co-authored-by: David Rodríguez <[email protected]>
rubygems · Oct 30, 2019 · 5ba1360 · 5ba1360
2 parents 27a01a5 + c9f6d2b
commit 5ba1360
Show file tree

Hide file tree

Showing 19 changed files with 470 additions and 474 deletions.
diff --git a/Rakefile b/Rakefile
@@ -130,7 +130,10 @@ namespace :man do
     begin
       Spec::Rubygems.gem_require("ronn")
     rescue Gem::LoadError => e
+      desc "Build the man pages"
       task(:build) { abort "We couln't activate ronn (#{e.requirement}). Try `gem install ronn:'#{e.requirement}'` to be able to build the help pages" }
+
+      desc "Verify man pages are in sync"
       task(:check) { abort "We couln't activate ronn (#{e.requirement}). Try `gem install ronn:'#{e.requirement}'` to be able to build the help pages" }
     else
       directory "man"

diff --git a/lib/bundler/cli.rb b/lib/bundler/cli.rb
@@ -68,9 +68,7 @@ def cli_help
       version
       Bundler.ui.info "\n"
 
-      primary_commands = ["install", "update",
-                          Bundler.feature_flag.bundler_3_mode? ? "cache" : "package",
-                          "exec", "config", "help"]
+      primary_commands = ["install", "update", "cache", "exec", "config", "help"]
 
       list = self.class.printable_commands(true)
       by_name = list.group_by {|name, _message| name.match(/^bundle (\w+)/)[1] }
@@ -412,7 +410,7 @@ def outdated(*gems)
       Outdated.new(options, gems).run
     end
 
-    desc "#{Bundler.feature_flag.bundler_3_mode? ? :cache : :package} [OPTIONS]", "Locks and then caches all of the gems into vendor/cache"
+    desc "cache [OPTIONS]", "Locks and then caches all of the gems into vendor/cache"
     unless Bundler.feature_flag.cache_all?
       method_option "all",  :type => :boolean,
                             :banner => "Include all sources (including path and git)."
@@ -421,24 +419,24 @@ def outdated(*gems)
     method_option "cache-path", :type => :string, :banner =>
       "Specify a different cache path than the default (vendor/cache)."
     method_option "gemfile", :type => :string, :banner => "Use the specified gemfile instead of Gemfile"
-    method_option "no-install", :type => :boolean, :banner => "Don't install the gems, only the package."
+    method_option "no-install", :type => :boolean, :banner => "Don't install the gems, only update the cache."
     method_option "no-prune", :type => :boolean, :banner => "Don't remove stale gems from the cache."
     method_option "path", :type => :string, :banner =>
       "Specify a different path than the system default ($BUNDLE_PATH or $GEM_HOME).#{" Bundler will remember this value for future installs on this machine" unless Bundler.feature_flag.forget_cli_options?}"
     method_option "quiet", :type => :boolean, :banner => "Only output warnings and errors."
     method_option "frozen", :type => :boolean, :banner =>
-      "Do not allow the Gemfile.lock to be updated after this package operation's install"
+      "Do not allow the Gemfile.lock to be updated after this bundle cache operation's install"
     long_desc <<-D
-      The package command will copy the .gem files for every gem in the bundle into the
+      The cache command will copy the .gem files for every gem in the bundle into the
       directory ./vendor/cache. If you then check that directory into your source
       control repository, others who check out your source will be able to install the
       bundle without having to download any additional gems.
     D
-    def package
-      require_relative "cli/package"
-      Package.new(options).run
+    def cache
+      require_relative "cli/cache"
+      Cache.new(options).run
     end
-    map %w[cache pack] => :package
+    map %w[package pack] => :cache
 
     desc "exec [OPTIONS]", "Run the command in context of the bundle"
     method_option :keep_file_descriptors, :type => :boolean, :default => false

diff --git a/lib/bundler/cli/package.rb → lib/bundler/cli/cache.rb b/lib/bundler/cli/package.rb → lib/bundler/cli/cache.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Bundler
-  class CLI::Package
+  class CLI::Cache
     attr_reader :options
 
     def initialize(options)
@@ -40,7 +40,7 @@ def setup_cache_all
 
       if Bundler.definition.has_local_dependencies? && !Bundler.feature_flag.cache_all?
         Bundler.ui.warn "Your Gemfile contains path and git dependencies. If you want "    \
-          "to package them as well, please pass the --all flag. This will be the default " \
+          "to cache them as well, please pass the --all flag. This will be the default " \
           "on Bundler 3.0."
       end
     end

diff --git a/man/bundle-cache.1 b/man/bundle-cache.1
@@ -0,0 +1,55 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "BUNDLE\-CACHE" "1" "October 2019" "" ""
+.
+.SH "NAME"
+\fBbundle\-cache\fR \- Package your needed \fB\.gem\fR files into your application
+.
+.SH "SYNOPSIS"
+\fBbundle cache\fR
+.
+.SH "DESCRIPTION"
+Copy all of the \fB\.gem\fR files needed to run the application into the \fBvendor/cache\fR directory\. In the future, when running [bundle install(1)][bundle\-install], use the gems in the cache in preference to the ones on \fBrubygems\.org\fR\.
+.
+.SH "GIT AND PATH GEMS"
+The \fBbundle cache\fR command can also package \fB:git\fR and \fB:path\fR dependencies besides \.gem files\. This needs to be explicitly enabled via the \fB\-\-all\fR option\. Once used, the \fB\-\-all\fR option will be remembered\.
+.
+.SH "SUPPORT FOR MULTIPLE PLATFORMS"
+When using gems that have different packages for different platforms, Bundler supports caching of gems for other platforms where the Gemfile has been resolved (i\.e\. present in the lockfile) in \fBvendor/cache\fR\. This needs to be enabled via the \fB\-\-all\-platforms\fR option\. This setting will be remembered in your local bundler configuration\.
+.
+.SH "REMOTE FETCHING"
+By default, if you run \fBbundle install(1)\fR](bundle\-install\.1\.html) after running bundle cache(1) \fIbundle\-cache\.1\.html\fR, bundler will still connect to \fBrubygems\.org\fR to check whether a platform\-specific gem exists for any of the gems in \fBvendor/cache\fR\.
+.
+.P
+For instance, consider this Gemfile(5):
+.
+.IP "" 4
+.
+.nf
+
+source "https://rubygems\.org"
+
+gem "nokogiri"
+.
+.fi
+.
+.IP "" 0
+.
+.P
+If you run \fBbundle cache\fR under C Ruby, bundler will retrieve the version of \fBnokogiri\fR for the \fB"ruby"\fR platform\. If you deploy to JRuby and run \fBbundle install\fR, bundler is forced to check to see whether a \fB"java"\fR platformed \fBnokogiri\fR exists\.
+.
+.P
+Even though the \fBnokogiri\fR gem for the Ruby platform is \fItechnically\fR acceptable on JRuby, it has a C extension that does not run on JRuby\. As a result, bundler will, by default, still connect to \fBrubygems\.org\fR to check whether it has a version of one of your gems more specific to your platform\.
+.
+.P
+This problem is also not limited to the \fB"java"\fR platform\. A similar (common) problem can happen when developing on Windows and deploying to Linux, or even when developing on OSX and deploying to Linux\.
+.
+.P
+If you know for sure that the gems packaged in \fBvendor/cache\fR are appropriate for the platform you are on, you can run \fBbundle install \-\-local\fR to skip checking for more appropriate gems, and use the ones in \fBvendor/cache\fR\.
+.
+.P
+One way to be sure that you have the right platformed versions of all your gems is to run \fBbundle cache\fR on an identical machine and check in the gems\. For instance, you can run \fBbundle cache\fR on an identical staging box during your staging process, and check in the \fBvendor/cache\fR before deploying to production\.
+.
+.P
+By default, bundle cache(1) \fIbundle\-cache\.1\.html\fR fetches and also installs the gems to the default location\. To package the dependencies to \fBvendor/cache\fR without installing them to the local install location, you can run \fBbundle cache \-\-no\-install\fR\.
diff --git a/man/bundle-cache.1.txt b/man/bundle-cache.1.txt
@@ -0,0 +1,78 @@
+BUNDLE-CACHE(1) 					       BUNDLE-CACHE(1)
+
+
+
+NAME
+       bundle-cache - Package your needed .gem files into your application
+
+SYNOPSIS
+       bundle cache
+
+DESCRIPTION
+       Copy  all of the .gem files needed to run the application into the ven-
+       dor/cache   directory.	In   the   future,   when   running    [bundle
+       install(1)][bundle-install], use the gems in the cache in preference to
+       the ones on rubygems.org.
+
+GIT AND PATH GEMS
+       The bundle cache command can also package :git and  :path  dependencies
+       besides	.gem  files. This needs to be explicitly enabled via the --all
+       option. Once used, the --all option will be remembered.
+
+SUPPORT FOR MULTIPLE PLATFORMS
+       When using gems that have different packages for  different  platforms,
+       Bundler	supports caching of gems for other platforms where the Gemfile
+       has been resolved (i.e. present in the lockfile) in vendor/cache.  This
+       needs  to  be enabled via the --all-platforms option. This setting will
+       be remembered in your local bundler configuration.
+
+REMOTE FETCHING
+       By default, if you run bundle install(1)](bundle-install.1.html)  after
+       running bundle cache(1) bundle-cache.1.html, bundler will still connect
+       to rubygems.org to check whether a platform-specific gem exists for any
+       of the gems in vendor/cache.
+
+       For instance, consider this Gemfile(5):
+
+
+
+	   source "https://rubygems.org"
+
+	   gem "nokogiri"
+
+
+
+       If you run bundle cache under C Ruby, bundler will retrieve the version
+       of nokogiri for the "ruby" platform. If you deploy  to  JRuby  and  run
+       bundle  install,  bundler  is  forced  to check to see whether a "java"
+       platformed nokogiri exists.
+
+       Even though the nokogiri gem  for  the  Ruby  platform  is  technically
+       acceptable  on  JRuby, it has a C extension that does not run on JRuby.
+       As a result, bundler will, by default, still connect to rubygems.org to
+       check  whether  it  has	a version of one of your gems more specific to
+       your platform.
+
+       This problem is also not limited to  the  "java"  platform.  A  similar
+       (common) problem can happen when developing on Windows and deploying to
+       Linux, or even when developing on OSX and deploying to Linux.
+
+       If you know for sure that the gems packaged in vendor/cache are	appro-
+       priate  for the platform you are on, you can run bundle install --local
+       to skip checking for more appropriate gems, and use the	ones  in  ven-
+       dor/cache.
+
+       One  way  to be sure that you have the right platformed versions of all
+       your gems is to run bundle cache on an identical machine and  check  in
+       the  gems. For instance, you can run bundle cache on an identical stag-
+       ing box during your staging process,  and  check  in  the  vendor/cache
+       before deploying to production.
+
+       By  default,  bundle  cache(1)  bundle-cache.1.html  fetches  and  also
+       installs the gems to the default location. To package the  dependencies
+       to  vendor/cache without installing them to the local install location,
+       you can run bundle cache --no-install.
+
+
+
+				 October 2019		       BUNDLE-CACHE(1)
diff --git a/man/bundle-package.ronn → man/bundle-cache.ronn b/man/bundle-package.ronn → man/bundle-cache.ronn
@@ -1,9 +1,9 @@
-bundle-package(1) -- Package your needed `.gem` files into your application
+bundle-cache(1) -- Package your needed `.gem` files into your application
 ===========================================================================
 
 ## SYNOPSIS
 
-`bundle package`
+`bundle cache`
 
 ## DESCRIPTION
 
@@ -13,22 +13,22 @@ use the gems in the cache in preference to the ones on `rubygems.org`.
 
 ## GIT AND PATH GEMS
 
-Since Bundler 1.2, the `bundle package` command can also package `:git` and
-`:path` dependencies besides .gem files. This needs to be explicitly enabled
-via the `--all` option. Once used, the `--all` option will be remembered.
+The `bundle cache` command can also package `:git` and `:path` dependencies
+besides .gem files. This needs to be explicitly enabled via the `--all` option.
+Once used, the `--all` option will be remembered.
 
 ## SUPPORT FOR MULTIPLE PLATFORMS
 
 When using gems that have different packages for different platforms, Bundler
-1.8 and newer support caching of gems for other platforms where the Gemfile
-has been resolved (i.e. present in the lockfile) in `vendor/cache`.  This needs
-to be enabled via the `--all-platforms` option. This setting will be remembered
-in your local bundler configuration.
+supports caching of gems for other platforms where the Gemfile has been resolved
+(i.e. present in the lockfile) in `vendor/cache`.  This needs to be enabled via
+the `--all-platforms` option. This setting will be remembered in your local
+bundler configuration.
 
 ## REMOTE FETCHING
 
 By default, if you run `bundle install(1)`](bundle-install.1.html) after running
-[bundle package(1)](bundle-package.1.html), bundler will still connect to `rubygems.org`
+[bundle cache(1)](bundle-cache.1.html), bundler will still connect to `rubygems.org`
 to check whether a platform-specific gem exists for any of the gems
 in `vendor/cache`.
 
@@ -38,7 +38,7 @@ For instance, consider this Gemfile(5):
 
     gem "nokogiri"
 
-If you run `bundle package` under C Ruby, bundler will retrieve
+If you run `bundle cache` under C Ruby, bundler will retrieve
 the version of `nokogiri` for the `"ruby"` platform. If you deploy
 to JRuby and run `bundle install`, bundler is forced to check to
 see whether a `"java"` platformed `nokogiri` exists.
@@ -60,13 +60,13 @@ are appropriate for the platform you are on, you can run
 gems, and use the ones in `vendor/cache`.
 
 One way to be sure that you have the right platformed versions
-of all your gems is to run `bundle package` on an identical
+of all your gems is to run `bundle cache` on an identical
 machine and check in the gems. For instance, you can run
-`bundle package` on an identical staging box during your
+`bundle cache` on an identical staging box during your
 staging process, and check in the `vendor/cache` before
 deploying to production.
 
-By default, [bundle package(1)](bundle-package.1.html) fetches and also
+By default, [bundle cache(1)](bundle-cache.1.html) fetches and also
 installs the gems to the default location. To package the
 dependencies to `vendor/cache` without installing them to the
-local install location, you can run `bundle package --no-install`.
+local install location, you can run `bundle cache --no-install`.
diff --git a/man/bundle-package.1 b/man/bundle-package.1