Class: Gem::Commands::InstallCommand

Inherits:
Gem::Command show all
Includes:
InstallUpdateOptions, LocalRemoteOptions, VersionOption
Defined in:
lib/rubygems/commands/install_command.rb

Overview

Gem installer command line tool

See 'gem help install`

Instance Attribute Summary

Attributes inherited from Gem::Command

#command, #defaults, #options, #program_name, #summary

Instance Method Summary collapse

Methods included from InstallUpdateOptions

#add_install_update_options, #install_update_defaults_str

Methods included from LocalRemoteOptions

#accept_uri_http, #add_bulk_threshold_option, #add_clear_sources_option, #add_local_remote_options, #add_proxy_option, #add_source_option, #add_update_sources_option, #both?, #local?, #remote?

Methods included from VersionOption

#add_platform_option, #add_prerelease_option, #add_version_option

Methods inherited from Gem::Command

add_common_option, #add_extra_args, #add_option, add_specific_extra_args, #begins?, build_args, build_args=, common_options, extra_args, extra_args=, #get_all_gem_names, #get_one_gem_name, #get_one_optional_argument, #handle_options, #handles?, #invoke, #merge_options, #remove_option, #show_help, #show_lookup_failure, specific_extra_args, specific_extra_args_hash, #when_invoked

Methods included from UserInteraction

#alert, #alert_error, #alert_warning, #ask, #ask_for_password, #ask_yes_no, #choose_from_list, #say, #terminate_interaction

Methods included from DefaultUserInteraction

ui, #ui, ui=, #ui=, use_ui, #use_ui

Constructor Details

#initialize ⇒ InstallCommand

Returns a new instance of InstallCommand.



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/rubygems/commands/install_command.rb', line 20

def initialize
  defaults = Gem::DependencyInstaller::DEFAULT_OPTIONS.merge({
    :generate_rdoc     => true,
    :generate_ri       => true,
    :format_executable => false,
    :version           => Gem::Requirement.default,
  })

  super 'install', 'Install a gem into the local repository', defaults

  add_install_update_options
  add_local_remote_options
  add_platform_option
  add_version_option
  add_prerelease_option "to be installed. (Only for listed gems)"
end

Instance Method Details

#arguments ⇒ Object

:nodoc:



37
38
39
 
# File 'lib/rubygems/commands/install_command.rb', line 37

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

#defaults_str ⇒ Object

:nodoc:



41
42
43
44
 
# File 'lib/rubygems/commands/install_command.rb', line 41

def defaults_str # :nodoc:
  "--both --version '#{Gem::Requirement.default}' --rdoc --ri --no-force\n" \
  "--install-dir #{Gem.dir}"
end

#description ⇒ Object

:nodoc:



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/rubygems/commands/install_command.rb', line 46

def description # :nodoc:
  <<-EOF
The install command installs local or remote gem into a gem repository.

For gems with executables ruby installs a wrapper file into the executable
directory by default.  This can be overridden with the --no-wrappers option.
The wrapper allows you to choose among alternate gem versions using _version_.

For example `rake _0.7.3_ --version` will run rake version 0.7.3 if a newer
version is also installed.

If an extension fails to compile during gem installation the gem
specification is not written out, but the gem remains unpacked in the
repository.  You may need to specify the path to the library's headers and
libraries to continue.  You can do this by adding a -- between RubyGems'
options and the extension's build options:

$ gem install some_extension_gem
[build fails]
Gem files will remain installed in \\
/path/to/gems/some_extension_gem-1.0 for inspection.
Results logged to /path/to/gems/some_extension_gem-1.0/gem_make.out
$ gem install some_extension_gem -- --with-extension-lib=/path/to/lib
[build succeeds]
$ gem list some_extension_gem

*** LOCAL GEMS ***

some_extension_gem (1.0)
$

If you correct the compilation errors by editing the gem files you will need
to write the specification by hand.  For example:

$ gem install some_extension_gem
[build fails]
Gem files will remain installed in \\
/path/to/gems/some_extension_gem-1.0 for inspection.
Results logged to /path/to/gems/some_extension_gem-1.0/gem_make.out
$ [cd /path/to/gems/some_extension_gem-1.0]
$ [edit files or what-have-you and run make]
$ gem spec ../../cache/some_extension_gem-1.0.gem --ruby > \\
           ../../specifications/some_extension_gem-1.0.gemspec
$ gem list some_extension_gem

*** LOCAL GEMS ***

some_extension_gem (1.0)
$

  EOF
end

#execute ⇒ Object

Raises:



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/rubygems/commands/install_command.rb', line 103

def execute
  if options[:include_dependencies] then
    alert "`gem install -y` is now default and will be removed"
    alert "use --ignore-dependencies to install only the gems you list"
  end

  installed_gems = []

  ENV.delete 'GEM_PATH' if options[:install_dir].nil? and RUBY_VERSION > '1.9'

  exit_code = 0

  get_all_gem_names.each do |gem_name|
    begin
      next if options[:conservative] and
        not Gem::Dependency.new(gem_name, options[:version]).matching_specs.empty?

      inst = Gem::DependencyInstaller.new options
      inst.install gem_name, options[:version]

      inst.installed_gems.each do |spec|
        say "Successfully installed #{spec.full_name}"
      end

      installed_gems.push(*inst.installed_gems)
    rescue Gem::InstallError => e
      alert_error "Error installing #{gem_name}:\n\t#{e.message}"
      exit_code |= 1
    rescue Gem::GemNotFoundException => e
      show_lookup_failure e.name, e.version, e.errors, options[:domain]

      exit_code |= 2
    end
  end

  unless installed_gems.empty? then
    gems = installed_gems.length == 1 ? 'gem' : 'gems'
    say "#{installed_gems.length} #{gems} installed"

    # NOTE: *All* of the RI documents must be generated first.  For some
    # reason, RI docs cannot be generated after any RDoc documents are
    # generated.

    if options[:generate_ri] then
      installed_gems.each do |gem|
        Gem::DocManager.new(gem, options[:rdoc_args]).generate_ri
      end

      Gem::DocManager.update_ri_cache
    end

    if options[:generate_rdoc] then
      installed_gems.each do |gem|
        Gem::DocManager.new(gem, options[:rdoc_args]).generate_rdoc
      end
    end
  end

  raise Gem::SystemExitException, exit_code
end

#usage ⇒ Object

:nodoc:



99
100
101
 
# File 'lib/rubygems/commands/install_command.rb', line 99

def usage # :nodoc:
  "#{program_name} GEMNAME [GEMNAME ...] [options] -- --build-flags"
end