Class: Gem::Commands::ServerCommand

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::ServerCommand
Defined in:	lib/rubygems/commands/server_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 ⇒ ServerCommand 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.
#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`
#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	This code is based directly on the `::Gem::Text` gem implementation Returns a value representing the “cost” of transforming str1 into str2.
#truncate_text, #min3

Constructor Details

.new ⇒ `ServerCommand`

[ GitHub ]

# File 'lib/rubygems/commands/server_command.rb', line 7


def initialize
  super 'server', 'Documentation and gem repository HTTP server',
        :port => 8808, :gemdir => [], :daemon => false

  OptionParser.accept :Port do |port|
    if port =~ /\A\d+\z/
      port = Integer port
      raise OptionParser::InvalidArgument, "#{port}: not a port number" if
        port > 65535

      port
    else
      begin
        Socket.getservbyname port
      rescue SocketError
        raise OptionParser::InvalidArgument, "#{port}: no such named service"
      end
    end
  end

  add_option '-p', '--port=PORT', :Port,
             'port to listen on' do |port, options|
    options[:port] = port
  end

  add_option '-d', '--dir=GEMDIR',
             'directories from which to serve gems',
             'multiple directories may be provided' do |gemdir, options|
    options[:gemdir] << File.expand_path(gemdir)
  end

  add_option '--[no-]daemon', 'run as a daemon' do |daemon, options|
    options[:daemon] = daemon
  end

  add_option '-b', '--bind=HOST,HOST',
             'addresses to bind', Array do |address, options|
    options[:addresses] ||= []
    options[:addresses].push(*address)
  end

  add_option '-l', '--launch[=COMMAND]',
             'launches a browser window',
             "COMMAND defaults to 'start' on Windows",
             "and 'open' on all other platforms" do |launch, options|
    launch ||= Gem.win_platform? ? 'start' : 'open'
    options[:launch] = launch
  end
end

Instance Method Details

#defaults_str

This method is for internal use only.

[ GitHub ]

# File 'lib/rubygems/commands/server_command.rb', line 57


def defaults_str # :nodoc:
  "--port 8808 --dir #{Gem.dir} --no-daemon"
end

#description

This method is for internal use only.

[ GitHub ]

# File 'lib/rubygems/commands/server_command.rb', line 61


def description # :nodoc:
  <<-EOF
The server command starts up a web server that hosts the RDoc for your
installed gems and can operate as a server for installation of gems on other
machines.

The cache files for installed gems must exist to use the server as a source
for gem installation.

To install gems from a running server, use `gem install GEMNAME --source
http://gem_server_host:8808`

You can set up a shortcut to gem server documentation using the URL:

http://localhost:8808/rdoc?q=%s - Firefox
http://localhost:8808/rdoc?q=* - LaunchBar

  EOF
end

#execute

[ GitHub ]

# File 'lib/rubygems/commands/server_command.rb', line 81


def execute
  options[:gemdir] = Gem.path if options[:gemdir].empty?
  Gem::Server.run options
end

Class: Gem::Commands::ServerCommand

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 ⇒ ServerCommand

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 ⇒ `ServerCommand`