Class: Gem::Commands::YankCommand

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain: self, ::Gem::Command
Instance Chain: self, ::Gem::GemcutterUtilities, ::Gem::VersionOption, ::Gem::LocalRemoteOptions, ::Gem::Command, ::Gem::UserInteraction, ::Gem::DefaultUserInteraction
Inherits:	Gem::Command Object Gem::Command Gem::Commands::YankCommand
Defined in:	lib/rubygems/commands/yank_command.rb

Class Attribute Summary

::Gem::Command - Inherited

.build_args	Arguments used when building gems.
.build_args=, .extra_args, .extra_args=

Class Method Summary

.new ⇒ YankCommand constructor

::Gem::Command - Inherited

.add_common_option,
.add_specific_extra_args	Add a list of extra arguments for the given command.
.common_options,
.new	Initializes a generic gem command named `command`.
.specific_extra_args	Return an array of extra arguments for the command.
.specific_extra_args_hash	Accessor for the specific extra args hash (self initializing).

Instance Attribute Summary

::Gem::GemcutterUtilities - Included

#host	The host to connect to either from the RUBYGEMS_HOST environment variable or from the user's configuration.
#host=

::Gem::LocalRemoteOptions - Included

#both?	Is fetching of local and remote information enabled?
#local?	Is local fetching enabled?
#remote?	Is remote fetching enabled?

::Gem::Command - Inherited

#defaults	The default options for the command.
#program_name	The name of the command for command-line invocation.
#summary	A short description of the command.
#command	The name of the command.
#options	The options for the command.

::Gem::DefaultUserInteraction - Included

#ui	See DefaultUserInteraction.ui
#ui=	See DefaultUserInteraction.ui=

Instance Method Summary

#execute
#unyank_gem(version, platform)
#yank_gem(version, platform)
#get_platform_from_requirements(requirements) private
#get_version_from_requirements(requirements) private
#yank_api_request(method, version, platform, api) private

::Gem::GemcutterUtilities - Included

#add_key_option	Add the –key option.
#api_key	The API key from the command options or from the user's configuration.
#rubygems_api_request	Creates an RubyGems API to Gem.host and Gem.path with the given HTTP `method`.
#sign_in	Signs in with the RubyGems API at `sign_in_host` and sets the rubygems API key.
#verify_api_key	Retrieves the pre-configured API key `key` or terminates interaction with an error.
#with_response	If `response` is an HTTP Success (2XX) response, yields the response if a block was given or shows the response body to the user.

::Gem::VersionOption - Included

#add_platform_option	Add the –platform option to the option parser.
#add_prerelease_option	Add the –prerelease option to the option parser.
#add_version_option	Add the –version option to the option parser.

::Gem::LocalRemoteOptions - Included

#accept_uri_http	Allows OptionParser to handle HTTP URIs.
#add_bulk_threshold_option	Add the –bulk-threshold option.
#add_clear_sources_option	Add the –clear-sources option.
#add_local_remote_options	Add local/remote options to the command line parser.
#add_proxy_option	Add the –http-proxy option.
#add_source_option	Add the –source option.
#add_update_sources_option	Add the –update-sources option.

::Gem::Command - Inherited

#add_extra_args	Adds extra args from ~/.gemrc.
#add_option	Add a command-line option and handler to the command.
#arguments	Override to provide details of the arguments a command takes.
#begins?	True if `long` begins with the characters from `short`.
#defaults_str	Override to display the default values of the command options.
#description	Override to display a longer description of what this command does.
#execute	Override to provide command handling.
#get_all_gem_names	Get all gem names from the command line.
#get_all_gem_names_and_versions	Get all [gem, version] from the command line.
#get_one_gem_name	Get a single gem name from the command line.
#get_one_optional_argument	Get a single optional argument from the command line.
#handle_options	Handle the given list of arguments by parsing them and recording the results.
#handles?	True if the command handles the given argument list.
#invoke	Invoke the command with the given list of arguments.
#invoke_with_build_args	Invoke the command with the given list of normal arguments and additional build arguments.
#merge_options	Merge a set of command options with the set of default options (without modifying the default option hash).
#remove_option	Remove previously defined command-line argument `name`.
#show_help	Display the help message for the command.
#show_lookup_failure	Display to the user that a gem couldn't be found and reasons why.
#usage	Override to display the usage for an individual gem command.
#when_invoked	Call the given block when invoked.
#add_parser_run_info	Adds a section with `title` and `content` to the parser help view.
#configure_options,
#create_option_parser	Creates an option parser and fills it in with the help info for the command.
#parser	Create on demand parser.
#wrap	Wraps `text` to `width`

::Gem::UserInteraction - Included

#alert	Displays an alert `statement`.
#alert_error	Displays an error `statement` to the error output location.
#alert_warning	Displays a warning `statement` to the warning output location.
#ask	Asks a `question` and returns the answer.
#ask_for_password	Asks for a password with a `prompt`
#ask_yes_no	Asks a yes or no `question`.
#choose_from_list	Asks the user to answer `question` with an answer from the given `list`.
#say	Displays the given `statement` on the standard output (or equivalent).
#terminate_interaction	Terminates the RubyGems process with the given `exit_code`
#verbose	Calls `say` with `msg` or the results of the block if really_verbose is true.

::Gem::DefaultUserInteraction - Included

#use_ui

See DefaultUserInteraction.use_ui

Constructor Details

.new ⇒ `YankCommand`

[ GitHub ]

# File 'lib/rubygems/commands/yank_command.rb', line 37


def initialize
  super 'yank', 'Remove a pushed gem from the index'

  add_version_option("remove")
  add_platform_option("remove")

  add_option('--undo') do |value, options|
    options[:undo] = true
  end

  add_key_option
end

Instance Method Details

#execute

[ GitHub ]

# File 'lib/rubygems/commands/yank_command.rb', line 50


def execute
  sign_in

  version   = get_version_from_requirements(options[:version])
  platform  = get_platform_from_requirements(options)

  if version then
    if options[:undo] then
      unyank_gem(version, platform)
    else
      yank_gem(version, platform)
    end
  else
    say "A version argument is required: #{usage}"
    terminate_interaction
  end
end

#get_platform_from_requirements(requirements) (private)

[ GitHub ]

# File 'lib/rubygems/commands/yank_command.rb', line 102


def get_platform_from_requirements(requirements)
  Gem.platforms[1].to_s if requirements.key? :added_platform
end

#get_version_from_requirements(requirements) (private)

[ GitHub ]

# File 'lib/rubygems/commands/yank_command.rb', line 96


def get_version_from_requirements(requirements)
  requirements.requirements.first[1].version
rescue
  nil
end

#unyank_gem(version, platform)

[ GitHub ]

# File 'lib/rubygems/commands/yank_command.rb', line 73


def unyank_gem(version, platform)
  say "Unyanking gem from #{host}..."
  yank_api_request(:put, version, platform, "api/v1/gems/unyank")
end

#yank_api_request(method, version, platform, api) (private)

[ GitHub ]

# File 'lib/rubygems/commands/yank_command.rb', line 80


def yank_api_request(method, version, platform, api)
  name = get_one_gem_name
  response = rubygems_api_request(method, api) do |request|
    request.add_field("Authorization", api_key)

    data = {
      'gem_name' => name,
      'version' => version,
    }
    data['platform'] = platform if platform

    request.set_form_data data
  end
  say response.body
end

#yank_gem(version, platform)

[ GitHub ]

# File 'lib/rubygems/commands/yank_command.rb', line 68


def yank_gem(version, platform)
  say "Yanking gem from #{self.host}..."
  yank_api_request(:delete, version, platform, "api/v1/gems/yank")
end

Class: Gem::Commands::YankCommand

Class Attribute Summary

::Gem::Command - Inherited

Class Method Summary

::Gem::Command - Inherited

Instance Attribute Summary

::Gem::GemcutterUtilities - Included

::Gem::LocalRemoteOptions - Included

::Gem::Command - Inherited

::Gem::DefaultUserInteraction - Included

Instance Method Summary

::Gem::GemcutterUtilities - Included

::Gem::VersionOption - Included

::Gem::LocalRemoteOptions - Included

::Gem::Command - Inherited

::Gem::UserInteraction - Included

::Gem::DefaultUserInteraction - Included

Constructor Details

.new ⇒ YankCommand

Instance Method Details

#execute

#get_platform_from_requirements(requirements) (private)

#get_version_from_requirements(requirements) (private)

#unyank_gem(version, platform)

#yank_api_request(method, version, platform, api) (private)

#yank_gem(version, platform)

.new ⇒ `YankCommand`