Merge pull request #3867 from rubygems/fix-cleanup-flag-name

Make --dry-run flag consistent across rubygems commands

lib/rubygems/commands/cleanup_command.rb

@@ -10,11 +10,17 @@ def initialize
           :force => false, :install_dir => Gem.dir,
           :check_dev => true
 
-    add_option('-n', '-d', '--dryrun',
+    add_option('-n', '-d', '--dry-run',
                'Do not uninstall gems') do |value, options|
       options[:dryrun] = true
     end
 
+    add_option(:Deprecated, '--dryrun',
+               'Do not uninstall gems') do |value, options|
+      options[:dryrun] = true
+    end
+    deprecate_option('--dryrun', extra_msg: 'Use --dry-run instead')
+
     add_option('-D', '--[no-]check-development',
                'Check development dependencies while uninstalling',
                '(default: true)') do |value, options|
@@ -41,7 +47,7 @@ def arguments # :nodoc:
   end
 
   def defaults_str # :nodoc:
-    "--no-dryrun"
+    "--no-dry-run"
   end
 
   def description # :nodoc:

test/rubygems/test_gem_commands_cleanup_command.rb

@@ -22,10 +22,21 @@ def test_handle_options_d
   end
 
   def test_handle_options_dry_run
-    @cmd.handle_options %w[--dryrun]
+    @cmd.handle_options %w[--dry-run]
     assert @cmd.options[:dryrun]
   end
 
+  def test_handle_options_deprecated_dry_run
+    use_ui @ui do
+      @cmd.handle_options %w[--dryrun]
+      assert @cmd.options[:dryrun]
+    end
+
+    assert_equal \
+      "WARNING:  The \"--dryrun\" option has been deprecated and will be removed in future versions of Rubygems. Use --dry-run instead\n",
+      @ui.error
+  end
+
   def test_handle_options_n
     @cmd.handle_options %w[-n]
     assert @cmd.options[:dryrun]