Gem::InstallUpdateOptions

Mixin methods for install and update options for Gem::Commands

Public Instance Methods

add_install_update_options() click to toggle source

Add the install/update options to the option parser.

 
               # File rubygems/install_update_options.rb, line 24
def add_install_update_options
  OptionParser.accept Gem::Security::Policy do |value|
    require 'rubygems/security'

    value = Gem::Security::Policies[value]
    valid = Gem::Security::Policies.keys.sort
    message = "#{value} (#{valid.join ', '} are valid)"
    raise OptionParser::InvalidArgument, message if value.nil?
    value
  end

  add_option(:"Install/Update", '-i', '--install-dir DIR',
             'Gem repository directory to get installed',
             'gems') do |value, options|
    options[:install_dir] = File.expand_path(value)
  end

  add_option(:"Install/Update", '-n', '--bindir DIR',
             'Directory where binary files are',
             'located') do |value, options|
    options[:bin_dir] = File.expand_path(value)
  end

  add_option(:"Install/Update", '-d', '--[no-]rdoc',
             'Generate RDoc documentation for the gem on',
             'install') do |value, options|
    options[:generate_rdoc] = value
  end

  add_option(:"Install/Update", '--[no-]ri',
             'Generate RI documentation for the gem on',
             'install') do |value, options|
    options[:generate_ri] = value
  end

  add_option(:"Install/Update", '-E', '--[no-]env-shebang',
             "Rewrite the shebang line on installed",
             "scripts to use /usr/bin/env") do |value, options|
    options[:env_shebang] = value
  end

  add_option(:"Install/Update", '-f', '--[no-]force',
             'Force gem to install, bypassing dependency',
             'checks') do |value, options|
    options[:force] = value
  end

  add_option(:"Install/Update", '-w', '--[no-]wrappers',
             'Use bin wrappers for executables',
             'Not available on dosish platforms') do |value, options|
    options[:wrappers] = value
  end

  add_option(:"Install/Update", '-P', '--trust-policy POLICY',
             Gem::Security::Policy,
             'Specify gem trust policy') do |value, options|
    options[:security_policy] = value
  end

  add_option(:"Install/Update", '--ignore-dependencies',
             'Do not install any required dependent gems') do |value, options|
    options[:ignore_dependencies] = value
  end

  add_option(:"Install/Update", '-y', '--include-dependencies',
             'Unconditionally install the required',
             'dependent gems') do |value, options|
    options[:include_dependencies] = value
  end

  add_option(:"Install/Update",       '--[no-]format-executable',
             'Make installed executable names match ruby.',
             'If ruby is ruby18, foo_exec will be',
             'foo_exec18') do |value, options|
    options[:format_executable] = value
  end

  add_option(:"Install/Update",       '--[no-]user-install',
             'Install in user\s home directory instead',
             'of GEM_HOME.') do |value, options|
    options[:user_install] = value
  end

  add_option(:"Install/Update", "--development",
              "Install any additional development",
              "dependencies") do |value, options|
    options[:development] = true
  end

  add_option(:"Install/Update", "--conservative",
              "Don't attempt to upgrade gems already",
              "meeting version requirement") do |value, options|
    options[:conservative] = true
  end
end

install_update_defaults_str() click to toggle source

Default options for the gem install command.

 
               # File rubygems/install_update_options.rb, line 123
def install_update_defaults_str
  '--rdoc --no-force --wrappers'
end

Commenting is here to help enhance the documentation. For example, code samples, or clarification of the documentation.

If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.

If you wish to post a correction of the docs, please do so, but also file bug report so that it can be corrected for the next release. Thank you.

If you want to help improve the Ruby documentation, please visit Documenting-ruby.org.