Module: Gem::InstallUpdateOptions
Relationships & Source Files | |
Extension / Inclusion / Inheritance Descendants | |
Included In:
| |
Super Chains via Extension / Inclusion / Inheritance | |
Instance Chain:
self,
SecurityOption
|
|
Defined in: | lib/rubygems/install_update_options.rb |
Overview
Mixin methods for install and update options for Commands
Instance Method Summary
-
#add_install_update_options
Add the install/update options to the option parser.
-
#install_update_defaults_str
Default options for the gem install command.
SecurityOption - Included
Instance Method Details
#add_install_update_options
Add the install/update options to the option parser.
# File 'lib/rubygems/install_update_options.rb', line 20
def add_option(:"Install/Update", '-i', '--install-dir DIR', 'Gem repository directory to get installed', 'gems') do |value, | [:install_dir] = File. (value) end add_option(:"Install/Update", '-n', '--bindir DIR', 'Directory where binary files are', 'located') do |value, | [:bin_dir] = File. (value) end add_option(:"Install/Update", '--[no-]document [TYPES]', Array, 'Generate documentation for installed gems', 'List the documentation types you wish to', 'generate. For example: rdoc,ri') do |value, | [:document] = case value when nil then %w[ri] when false then [] else value end end add_option(:"Install/Update", '--build-root DIR', 'Temporary installation root. Useful for building', 'packages. Do not use this when installing remote gems.') do |value, | [:build_root] = File. (value) end add_option(:"Install/Update", '--vendor', 'Install gem into the vendor directory.', 'Only for use by gem repackagers.') do |value, | unless Gem.vendor_dir then raise OptionParser::InvalidOption.new 'your platform is not supported' end [:vendor] = true [:install_dir] = Gem.vendor_dir end add_option(:"Install/Update", '-N', '--no-document', 'Disable documentation generation') do |value, | [:document] = [] end add_option(:Deprecated, '--[no-]rdoc', 'Generate RDoc for installed gems', 'Use --document instead') do |value, | if value then [:document] << 'rdoc' else [:document].delete 'rdoc' end [:document].uniq! end add_option(:Deprecated, '--[no-]ri', 'Generate ri data for installed gems.', 'Use --document instead') do |value, | if value then [:document] << 'ri' else [:document].delete 'ri' end [:document].uniq! end add_option(:"Install/Update", '-E', '--[no-]env-shebang', "Rewrite the shebang line on installed", "scripts to use /usr/bin/env") do |value, | [:env_shebang] = value end add_option(:"Install/Update", '-f', '--[no-]force', 'Force gem to install, bypassing dependency', 'checks') do |value, | [:force] = value end add_option(:"Install/Update", '-w', '--[no-]wrappers', 'Use bin wrappers for executables', 'Not available on dosish platforms') do |value, | [:wrappers] = value end add_security_option add_option(:"Install/Update", '--ignore-dependencies', 'Do not install any required dependent gems') do |value, | [:ignore_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, | [:format_executable] = value end add_option(:"Install/Update", '--[no-]user-install', 'Install in user\'s home directory instead', 'of GEM_HOME.') do |value, | [:user_install] = value end add_option(:"Install/Update", "--development", "Install additional development", "dependencies") do |value, | [:development] = true [:dev_shallow] = true end add_option(:"Install/Update", "--development-all", "Install development dependencies for all", "gems (including dev deps themselves)") do |value, | [:development] = true [:dev_shallow] = false end add_option(:"Install/Update", "--conservative", "Don't attempt to upgrade gems already", "meeting version requirement") do |value, | [:conservative] = true [:minimal_deps] = true end add_option(:"Install/Update", "--minimal-deps", "Don't upgrade any dependencies that already", "meet version requirements") do |value, | [:minimal_deps] = true end add_option(:"Install/Update", "--[no-]post-install-message", "Print post install message") do |value, | [: ] = value end add_option(:"Install/Update", '-g', '--file [FILE]', 'Read from a gem dependencies API file and', 'install the listed gems') do |v,o| v = Gem::GEM_DEP_FILES.find do |file| File.exist? file end unless v unless v then = v ? v : "(tried #{Gem::GEM_DEP_FILES.join ', '})" raise OptionParser::InvalidArgument, "cannot find gem dependencies file #{}" end [:gemdeps] = v end add_option(:"Install/Update", '--without GROUPS', Array, 'Omit the named groups (comma separated)', 'when installing from a gem dependencies', 'file') do |v,o| [:without_groups].concat v.map { |without| without.intern } end add_option(:"Install/Update", '--default', 'Add the gem\'s full specification to', 'specifications/default and extract only its bin') do |v,o| [:install_as_default] = v end add_option(:"Install/Update", '--explain', 'Rather than install the gems, indicate which would', 'be installed') do |v,o| [:explain] = v end add_option(:"Install/Update", '--[no-]lock', 'Create a lock file (when used with -g/--file)') do |v,o| [:lock] = v end add_option(:"Install/Update", '--[no-]suggestions', 'Suggest alternates when gems are not found') do |v,o| [:suggest_alternate] = v end end
#install_update_defaults_str
Default options for the gem install command.
# File 'lib/rubygems/install_update_options.rb', line 211
def install_update_defaults_str '--document=rdoc,ri --wrappers' end