Merge pull request #7588 from ruby/deprecate-default-option

Deprecate `--default` option from install command

Author: hsbt

Manifest.txt

@@ -428,7 +428,6 @@ lib/rubygems/gemcutter_utilities/webauthn_listener.rb
 lib/rubygems/gemcutter_utilities/webauthn_listener/response.rb
 lib/rubygems/gemcutter_utilities/webauthn_poller.rb
 lib/rubygems/gemspec_helpers.rb
-lib/rubygems/install_default_message.rb
 lib/rubygems/install_message.rb
 lib/rubygems/install_update_options.rb
 lib/rubygems/installer.rb

bundler/spec/support/helpers.rb

@@ -333,9 +333,20 @@ def install_gem(path, install_dir, default = false)
       raise "OMG `#{path}` does not exist!" unless File.exist?(path)
 
       args = "--no-document --ignore-dependencies --verbose --local --install-dir #{install_dir}"
-      args += " --default" if default
 
       gem_command "install #{args} '#{path}'"
+
+      if default
+        gem = Pathname.new(path).basename.to_s.match(/(.*)\.gem/)[1]
+
+        # Revert Gem::Installer#write_spec and apply Gem::Installer#write_default_spec
+        FileUtils.mkdir_p File.join(install_dir, "specifications", "default")
+        File.rename File.join(install_dir, "specifications", gem + ".gemspec"),
+          File.join(install_dir, "specifications", "default", gem + ".gemspec")
+
+        # Revert Gem::Installer#write_cache_file
+        File.delete File.join(install_dir, "cache", gem + ".gem")
+      end
     end
 
     def with_built_bundler(version = nil, opts = {}, &block)

lib/rubygems/commands/install_command.rb

@@ -239,11 +239,7 @@ def install_gems # :nodoc:
   # Loads post-install hooks
 
   def load_hooks # :nodoc:
-    if options[:install_as_default]
-      require_relative "../install_default_message"
-    else
-      require_relative "../install_message"
-    end
+    require_relative "../install_message"
     require_relative "../rdoc"
   end
 

lib/rubygems/commands/setup_command.rb

@@ -393,16 +393,18 @@ def install_default_bundler_gem(bin_dir)
     Dir.chdir("bundler") do
       built_gem = Gem::Package.build(new_bundler_spec)
       begin
-        Gem::Installer.at(
+        installer = Gem::Installer.at(
           built_gem,
           env_shebang: options[:env_shebang],
           format_executable: options[:format_executable],
           force: options[:force],
-          install_as_default: true,
           bin_dir: bin_dir,
           install_dir: default_dir,
           wrappers: true
-        ).install
+        )
+        installer.install
+        File.delete installer.spec_file
+        installer.write_default_spec
       ensure
         FileUtils.rm_f built_gem
       end

lib/rubygems/dependency_installer.rb

@@ -28,7 +28,6 @@ class Gem::DependencyInstaller
     wrappers: true,
     build_args: nil,
     build_docs_in_background: false,
-    install_as_default: false,
   }.freeze
 
   ##
@@ -87,7 +86,6 @@ def initialize(options = {})
     @wrappers            = options[:wrappers]
     @build_args          = options[:build_args]
     @build_docs_in_background = options[:build_docs_in_background]
-    @install_as_default = options[:install_as_default]
     @dir_mode = options[:dir_mode]
     @data_mode = options[:data_mode]
     @prog_mode = options[:prog_mode]
@@ -240,7 +238,6 @@ def install(dep_or_name, version = Gem::Requirement.default)
       user_install: @user_install,
       wrappers: @wrappers,
       build_root: @build_root,
-      install_as_default: @install_as_default,
       dir_mode: @dir_mode,
       data_mode: @data_mode,
       prog_mode: @prog_mode,

lib/rubygems/install_default_message.rb

@@ -158,10 +158,9 @@ def add_install_update_options
       options[:without_groups].concat v.map(&:intern)
     end
 
-    add_option(:"Install/Update", "--default",
+    add_option(:Deprecated, "--default",
                "Add the gem's full specification to",
                "specifications/default and extract only its bin") do |v,_o|
-      options[:install_as_default] = v
     end
 
     add_option(:"Install/Update", "--explain",

lib/rubygems/install_update_options.rb

@@ -274,11 +274,7 @@ def install
     run_pre_install_hooks
 
     # Set loaded_from to ensure extension_dir is correct
-    if @options[:install_as_default]
-      spec.loaded_from = default_spec_file
-    else
-      spec.loaded_from = spec_file
-    end
+    spec.loaded_from = spec_file
 
     # Completely remove any previous gem files
     FileUtils.rm_rf gem_dir
@@ -287,24 +283,17 @@ def install
     dir_mode = options[:dir_mode]
     FileUtils.mkdir_p gem_dir, mode: dir_mode && 0o755
 
-    if @options[:install_as_default]
-      extract_bin
-      write_default_spec
-    else
-      extract_files
+    extract_files
 
-      build_extensions
-      write_build_info_file
-      run_post_build_hooks
-    end
+    build_extensions
+    write_build_info_file
+    run_post_build_hooks
 
     generate_bin
     generate_plugins
 
-    unless @options[:install_as_default]
-      write_spec
-      write_cache_file
-    end
+    write_spec
+    write_cache_file
 
     File.chmod(dir_mode, gem_dir) if dir_mode
 
@@ -409,12 +398,18 @@ def spec_file
     File.join gem_home, "specifications", "#{spec.full_name}.gemspec"
   end
 
+  def default_spec_dir
+    dir = File.join(gem_home, "specifications", "default")
+    FileUtils.mkdir_p dir
+    dir
+  end
+
   ##
   # The location of the default spec file for default gems.
   #
 
   def default_spec_file
-    File.join gem_home, "specifications", "default", "#{spec.full_name}.gemspec"
+    File.join default_spec_dir, "#{spec.full_name}.gemspec"
   end
 
   ##
@@ -889,11 +884,7 @@ def pre_install_checks
 
     ensure_loadable_spec
 
-    if options[:install_as_default]
-      Gem.ensure_default_gem_subdirectories gem_home
-    else
-      Gem.ensure_gem_subdirectories gem_home
-    end
+    Gem.ensure_gem_subdirectories gem_home
 
     return true if @force
 

lib/rubygems/installer.rb

@@ -60,6 +60,44 @@ def self.specific_extra_args_hash=(value)
   end
 end
 
+class Gem::Installer
+  # Copy from Gem::Installer#install with install_as_default option from old version
+  def install_default_gem
+    pre_install_checks
+
+    run_pre_install_hooks
+
+    spec.loaded_from = default_spec_file
+
+    FileUtils.rm_rf gem_dir
+    FileUtils.rm_rf spec.extension_dir
+
+    dir_mode = options[:dir_mode]
+    FileUtils.mkdir_p gem_dir, mode: dir_mode && 0o755
+
+    extract_bin
+    write_default_spec
+
+    generate_bin
+    generate_plugins
+
+    File.chmod(dir_mode, gem_dir) if dir_mode
+
+    say spec.post_install_message if options[:post_install_message] && !spec.post_install_message.nil?
+
+    Gem::Specification.add_spec(spec)
+
+    load_plugin
+
+    run_post_install_hooks
+
+    spec
+  rescue Errno::EACCES => e
+    # Permission denied - /path/to/foo
+    raise Gem::FilePermissionError, e.message.split(" - ").last
+  end
+end
+
 ##
 # RubyGemTestCase provides a variety of methods for testing rubygems and
 # gem-related behavior in a sandbox.  Through RubyGemTestCase you can install
@@ -811,8 +849,8 @@ def install_specs(*specs)
 
   def install_default_gems(*specs)
     specs.each do |spec|
-      installer = Gem::Installer.for_spec(spec, install_as_default: true)
-      installer.install
+      installer = Gem::Installer.for_spec(spec)
+      installer.install_default_gem
       Gem.register_default_spec(spec)
     end
   end

test/rubygems/helper.rb

@@ -2425,119 +2425,6 @@ def test_dir
     assert_match %r{/gemhome/gems/a-2$}, installer.dir
   end
 
-  def test_default_gem_loaded_from
-    spec = util_spec "a"
-    installer = Gem::Installer.for_spec spec, install_as_default: true
-    installer.install
-    assert_predicate spec, :default_gem?
-  end
-
-  def test_default_gem_without_wrappers
-    installer = setup_base_installer
-
-    FileUtils.rm_rf File.join(Gem.default_dir, "specifications")
-
-    installer.wrappers = false
-    installer.options[:install_as_default] = true
-    installer.gem_dir = @spec.gem_dir
-
-    use_ui @ui do
-      installer.install
-    end
-
-    assert_directory_exists File.join(@spec.gem_dir, "bin")
-    installed_exec = File.join @spec.gem_dir, "bin", "executable"
-    assert_path_exist installed_exec
-
-    assert_directory_exists File.join(Gem.default_dir, "specifications")
-    assert_directory_exists File.join(Gem.default_dir, "specifications", "default")
-
-    default_spec = eval File.read File.join(Gem.default_dir, "specifications", "default", "a-2.gemspec")
-    assert_equal Gem::Version.new("2"), default_spec.version
-    assert_equal ["bin/executable"], default_spec.files
-
-    assert_directory_exists util_inst_bindir
-
-    installed_exec = File.join util_inst_bindir, "executable"
-    assert_path_exist installed_exec
-
-    wrapper = File.read installed_exec
-
-    if symlink_supported?
-      refute_match(/generated by RubyGems/, wrapper)
-    else # when symlink not supported, it warns and fallbacks back to installing wrapper
-      assert_match(/Unable to use symlinks, installing wrapper/, @ui.error)
-      assert_match(/generated by RubyGems/, wrapper)
-    end
-  end
-
-  def test_default_gem_with_wrappers
-    installer = setup_base_installer
-
-    installer.wrappers = true
-    installer.options[:install_as_default] = true
-    installer.gem_dir = @spec.gem_dir
-
-    use_ui @ui do
-      installer.install
-    end
-
-    assert_directory_exists util_inst_bindir
-
-    installed_exec = File.join util_inst_bindir, "executable"
-    assert_path_exist installed_exec
-
-    wrapper = File.read installed_exec
-    assert_match(/generated by RubyGems/, wrapper)
-  end
-
-  def test_default_gem_with_exe_as_bindir
-    @spec = quick_gem "c" do |spec|
-      util_make_exec spec, "#!/usr/bin/ruby", "exe"
-    end
-
-    util_build_gem @spec
-
-    @spec.cache_file
-
-    installer = util_installer @spec, @gemhome
-
-    installer.options[:install_as_default] = true
-    installer.gem_dir = @spec.gem_dir
-
-    use_ui @ui do
-      installer.install
-    end
-
-    assert_directory_exists File.join(@spec.gem_dir, "exe")
-    installed_exec = File.join @spec.gem_dir, "exe", "executable"
-    assert_path_exist installed_exec
-
-    assert_directory_exists File.join(Gem.default_dir, "specifications")
-    assert_directory_exists File.join(Gem.default_dir, "specifications", "default")
-
-    default_spec = eval File.read File.join(Gem.default_dir, "specifications", "default", "c-2.gemspec")
-    assert_equal Gem::Version.new("2"), default_spec.version
-    assert_equal ["exe/executable"], default_spec.files
-  end
-
-  def test_default_gem_to_specific_install_dir
-    @gem = setup_base_gem
-    installer = util_installer @spec, "#{@gemhome}2"
-    installer.options[:install_as_default] = true
-
-    use_ui @ui do
-      installer.install
-    end
-
-    assert_directory_exists File.join("#{@gemhome}2", "specifications")
-    assert_directory_exists File.join("#{@gemhome}2", "specifications", "default")
-
-    default_spec = eval File.read File.join("#{@gemhome}2", "specifications", "default", "a-2.gemspec")
-    assert_equal Gem::Version.new("2"), default_spec.version
-    assert_equal ["bin/executable"], default_spec.files
-  end
-
   def test_package_attribute
     gem = quick_gem "c" do |spec|
       util_make_exec spec, "#!/usr/bin/ruby", "exe"