Class: Gem::Commands::GenerateIndexCommand

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

Overview

Generates a index files for use as a gem server.

See gem help generate_index

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 ⇒ GenerateIndexCommand 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::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
#defaults_str Internal use only
#description Internal use only

`::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`
#extract_gem_name_and_version, #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 github.com/ruby/did_you_mean/blob/2ddf39b874808685965dbc47d344cf6c7651807c/lib/did_you_mean/levenshtein.rb#L7-L37.
#truncate_text, #min3

Constructor Details

.new ⇒ `GenerateIndexCommand`

[ GitHub ]

# File 'lib/rubygems/commands/generate_index_command.rb', line 12


def initialize
  super "generate_index",
        "Generates the index files for a gem server directory",
        :directory => ".", :build_modern => true

  add_option "-d", "--directory=DIRNAME",
             "repository base dir containing gems subdir" do |dir, options|
    options[:directory] = File.expand_path dir
  end

  add_option "--[no-]modern",
             "Generate indexes for RubyGems",
             "(always true)" do |value, options|
    options[:build_modern] = value
  end

  deprecate_option("--modern", version: "4.0", extra_msg: "Modern indexes (specs, latest_specs, and prerelease_specs) are always generated, so this option is not needed.")
  deprecate_option("--no-modern", version: "4.0", extra_msg: "The `--no-modern` option is currently ignored. Modern indexes (specs, latest_specs, and prerelease_specs) are always generated.")

  add_option "--update",
             "Update modern indexes with gems added",
             "since the last update" do |value, options|
    options[:update] = value
  end
end

Instance Method Details

#defaults_str

This method is for internal use only.

[ GitHub ]

# File 'lib/rubygems/commands/generate_index_command.rb', line 38


def defaults_str # :nodoc:
  "--directory . --modern"
end

#description

This method is for internal use only.

[ GitHub ]

# File 'lib/rubygems/commands/generate_index_command.rb', line 42


def description # :nodoc:
  <<-EOF
The generate_index command creates a set of indexes for serving gems
statically.  The command expects a 'gems' directory under the path given to
the --directory option.  The given directory will be the directory you serve
as the gem repository.

For `gem generate_index --directory /path/to/repo`, expose /path/to/repo via
your HTTP server configuration (not /path/to/repo/gems).

When done, it will generate a set of files like this:

gems/*.gem                                   # .gem files you want to
                                             # index

specs.<version>.gz                           # specs index
latest_specs.<version>.gz                    # latest specs index
prerelease_specs.<version>.gz                # prerelease specs index
quick/Marshal.<version>/<gemname>.gemspec.rz # Marshal quick index file

The .rz extension files are compressed with the inflate algorithm.
The Marshal version number comes from ruby's Marshal::MAJOR_VERSION and
Marshal::MINOR_VERSION constants.  It is used to ensure compatibility.
  EOF
end

#execute

[ GitHub ]

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


def execute
  # This is always true because it's the only way now.
  options[:build_modern] = true

  if !File.exist?(options[:directory]) ||
     !File.directory?(options[:directory])
    alert_error "unknown directory name #{options[:directory]}."
    terminate_interaction 1
  else
    indexer = Gem::Indexer.new options.delete(:directory), options

    if options[:update]
      indexer.update_index
    else
      indexer.generate_index
    end
  end
end

Class: Gem::Commands::GenerateIndexCommand

Overview

Constant Summary

::Gem::Command - Inherited

Class Attribute Summary

::Gem::Command - Inherited

Class Method Summary

::Gem::Command - Inherited

Instance Attribute Summary

::Gem::Command - Inherited

::Gem::DefaultUserInteraction - Included

Instance Method Summary

::Gem::Command - Inherited

::Gem::UserInteraction - Included

::Gem::DefaultUserInteraction - Included

::Gem::Text - Included

Constructor Details

.new ⇒ GenerateIndexCommand

Instance Method Details

#defaults_str

#description

#execute

`::Gem::Command` - Inherited

`::Gem::Command` - Inherited

`::Gem::Command` - Inherited

`::Gem::Command` - Inherited

`::Gem::DefaultUserInteraction` - Included

`::Gem::Command` - Inherited

`::Gem::UserInteraction` - Included

`::Gem::DefaultUserInteraction` - Included

`::Gem::Text` - Included

.new ⇒ `GenerateIndexCommand`