Class: Gem::Commands::FetchCommand

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

Constant Summary

`::Gem::Command` - Inherited

HELP

Class Attribute Summary

`::Gem::Command` - Inherited

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

Class Method Summary

.new ⇒ FetchCommand 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::LocalRemoteOptions` - Included

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

`::Gem::Command` - Inherited

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

`::Gem::DefaultUserInteraction` - Included

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

Instance Method Summary

#execute
#arguments Internal use only
#check_version Internal use only
#defaults_str Internal use only
#description Internal use only
#usage Internal use only

`::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.
#get_platform_from_requirements	Extract platform given on the command line.

`::Gem::LocalRemoteOptions` - Included

#accept_uri_http	Allows `::Gem::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`.
#check_deprecated_options,
#defaults_str	Override to display the default values of the command options.
#deprecate_option	Mark a command-line option as deprecated, and optionally specify a deprecation horizon.
#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.
#option_is_deprecated?,
#parser	Create on demand parser.
#wrap	Wraps `text` to `width`
#add_parser_description, #add_parser_options, #add_parser_summary

`::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

`::Gem::Text` - Included

#clean_text	Remove any non-printable characters and make the text suitable for printing.
#format_text	Wraps `text` to `wrap` characters and optionally indents by `indent` characters.
#levenshtein_distance	Returns a value representing the “cost” of transforming str1 into str2 Vendored version of `DidYouMean::Levenshtein.distance` from the ruby/did_you_mean gem @ 1.4.0 git.io/JJgZI.
#truncate_text, #min3

Constructor Details

.new ⇒ `FetchCommand`

[ GitHub ]

# File 'lib/rubygems/commands/fetch_command.rb', line 10


def initialize
  defaults = {
    :suggest_alternate => true,
    :version           => Gem::Requirement.default,
  }

  super "fetch", "Download a gem and place it in the current directory", defaults

  add_bulk_threshold_option
  add_proxy_option
  add_source_option
  add_clear_sources_option

  add_version_option
  add_platform_option
  add_prerelease_option

  add_option "--[no-]suggestions", "Suggest alternates when gems are not found" do |value, options|
    options[:suggest_alternate] = value
  end
end

Instance Method Details

#arguments

This method is for internal use only.

[ GitHub ]

# File 'lib/rubygems/commands/fetch_command.rb', line 32


def arguments # :nodoc:
  "GEMNAME       name of gem to download"
end

#check_version

This method is for internal use only.

[ GitHub ]

# File 'lib/rubygems/commands/fetch_command.rb', line 54


def check_version # :nodoc:
  if options[:version] != Gem::Requirement.default &&
     get_all_gem_names.size > 1
    alert_error "Can't use --version with multiple gems. You can specify multiple gems with" \
                " version requirements using `gem fetch 'my_gem:1.0.0' 'my_other_gem:~>2.0.0'`"
    terminate_interaction 1
  end
end

#defaults_str

This method is for internal use only.

[ GitHub ]

# File 'lib/rubygems/commands/fetch_command.rb', line 36


def defaults_str # :nodoc:
  "--version '#{Gem::Requirement.default}'"
end

#description

This method is for internal use only.

[ GitHub ]

# File 'lib/rubygems/commands/fetch_command.rb', line 40


def description # :nodoc:
  <<-EOF
The fetch command fetches gem files that can be stored for later use or
unpacked to examine their contents.

See the build command help for an example of unpacking a gem, modifying it,
then repackaging it.
  EOF
end

#execute

[ GitHub ]

# File 'lib/rubygems/commands/fetch_command.rb', line 63


def execute
  check_version
  version = options[:version]

  platform  = Gem.platforms.last
  gem_names = get_all_gem_names_and_versions

  gem_names.each do |gem_name, gem_version|
    gem_version ||= version
    dep = Gem::Dependency.new gem_name, gem_version
    dep.prerelease = options[:prerelease]
    suppress_suggestions = !options[:suggest_alternate]

    specs_and_sources, errors =
      Gem::SpecFetcher.fetcher.spec_for_dependency dep

    if platform
      filtered = specs_and_sources.select {|s,| s.platform == platform }
      specs_and_sources = filtered unless filtered.empty?
    end

    spec, source = specs_and_sources.max_by {|s,| s }

    if spec.nil?
      show_lookup_failure gem_name, gem_version, errors, suppress_suggestions, options[:domain]
      next
    end
    source.download spec
    say "Downloaded #{spec.full_name}"
  end
end

#usage

This method is for internal use only.

[ GitHub ]

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


def usage # :nodoc:
  "#{program_name} GEMNAME [GEMNAME ...]"
end

Class: Gem::Commands::FetchCommand

Constant Summary

::Gem::Command - Inherited

Class Attribute Summary

::Gem::Command - Inherited

Class Method Summary

::Gem::Command - Inherited

Instance Attribute Summary

::Gem::LocalRemoteOptions - Included

::Gem::Command - Inherited

::Gem::DefaultUserInteraction - Included

Instance Method Summary

::Gem::VersionOption - Included

::Gem::LocalRemoteOptions - Included

::Gem::Command - Inherited

::Gem::UserInteraction - Included

::Gem::DefaultUserInteraction - Included

::Gem::Text - Included

Constructor Details

.new ⇒ FetchCommand

Instance Method Details

#arguments

#check_version

#defaults_str

#description

#execute

#usage

`::Gem::Command` - Inherited

`::Gem::Command` - Inherited

`::Gem::Command` - Inherited

`::Gem::LocalRemoteOptions` - Included

`::Gem::Command` - Inherited

`::Gem::DefaultUserInteraction` - Included

`::Gem::VersionOption` - Included

`::Gem::LocalRemoteOptions` - Included

`::Gem::Command` - Inherited

`::Gem::UserInteraction` - Included

`::Gem::DefaultUserInteraction` - Included

`::Gem::Text` - Included

.new ⇒ `FetchCommand`