Class: Gem::Commands::UpdateCommand

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

Instance Attribute Summary collapse

Attributes inherited from Gem::Command

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

Instance Method Summary collapse

Methods included from VersionOption

#add_platform_option, #add_prerelease_option, #add_version_option

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 InstallUpdateOptions

#add_install_update_options, #install_update_defaults_str

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_all_gem_names_and_versions, #get_one_gem_name, #get_one_optional_argument, #handle_options, #handles?, #invoke, #invoke_with_build_args, #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, #verbose

Methods included from DefaultUserInteraction

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

Constructor Details

#initialize ⇒ UpdateCommand

Returns a new instance of UpdateCommand.



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/rubygems/commands/update_command.rb', line 22

def initialize
  super 'update', 'Update installed gems to the latest version',
    :document => %w[rdoc ri],
    :force    => false

  add_install_update_options

  OptionParser.accept Gem::Version do |value|
    Gem::Version.new value

    value
  end

  add_option('--system [VERSION]', Gem::Version,
             'Update the RubyGems system software') do |value, options|
    value = true unless value

    options[:system] = value
  end

  add_local_remote_options
  add_platform_option
  add_prerelease_option "as update targets"

  @updated   = []
  @installer = nil
end

Instance Attribute Details

#installer ⇒ Object (readonly)

:nodoc:



18
19
20
 
# File 'lib/rubygems/commands/update_command.rb', line 18

def installer
  @installer
end

#updated ⇒ Object (readonly)

:nodoc:



20
21
22
 
# File 'lib/rubygems/commands/update_command.rb', line 20

def updated
  @updated
end

Instance Method Details

#arguments ⇒ Object

:nodoc:



50
51
52
 
# File 'lib/rubygems/commands/update_command.rb', line 50

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

#check_latest_rubygems(version) ⇒ Object

:nodoc:



71
72
73
74
75
76
77
78
 
# File 'lib/rubygems/commands/update_command.rb', line 71

def check_latest_rubygems version # :nodoc:
  if Gem.rubygems_version == version then
    say "Latest version currently installed. Aborting."
    terminate_interaction
  end

  options[:user_install] = false
end

#check_update_arguments ⇒ Object

:nodoc:



80
81
82
83
84
85
 
# File 'lib/rubygems/commands/update_command.rb', line 80

def check_update_arguments # :nodoc:
  unless options[:args].empty? then
    alert_error "Gem names are not allowed with the --system option"
    terminate_interaction 1
  end
end

#defaults_str ⇒ Object

:nodoc:



54
55
56
 
# File 'lib/rubygems/commands/update_command.rb', line 54

def defaults_str # :nodoc:
  "--document --no-force --install-dir #{Gem.dir}"
end

#description ⇒ Object

:nodoc:



58
59
60
61
62
63
64
65
 
# File 'lib/rubygems/commands/update_command.rb', line 58

def description # :nodoc:
  <<-EOF
The update command will update your gems to the latest version.

The update command does not remove the previous version. Use the cleanup
command to remove old versions.
  EOF
end

#execute ⇒ Object 



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/rubygems/commands/update_command.rb', line 87

def execute

  if options[:system] then
    update_rubygems
    return
  end

  say "Updating installed gems"

  hig = highest_installed_gems

  gems_to_update = which_to_update hig, options[:args].uniq

  updated = update_gems gems_to_update

  updated_names = updated.map { |spec| spec.name }
  not_updated_names = options[:args].uniq - updated_names

  if updated.empty? then
    say "Nothing to update"
  else
    say "Gems updated: #{updated_names.join(' ')}"
    say "Gems already up-to-date: #{not_updated_names.join(' ')}" unless not_updated_names.empty?
  end
end

#fetch_remote_gems(spec) ⇒ Object

:nodoc:



113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/rubygems/commands/update_command.rb', line 113

def fetch_remote_gems spec # :nodoc:
  dependency = Gem::Dependency.new spec.name, "> #{spec.version}"
  dependency.prerelease = options[:prerelease]

  fetcher = Gem::SpecFetcher.fetcher

  spec_tuples, errors = fetcher.search_for_dependency dependency

  error = errors.find { |e| e.respond_to? :exception }

  raise error if error

  spec_tuples
end

#highest_installed_gems ⇒ Object

:nodoc:



128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/rubygems/commands/update_command.rb', line 128

def highest_installed_gems # :nodoc:
  hig = {} # highest installed gems

  Gem::Specification.each do |spec|
    if hig[spec.name].nil? or hig[spec.name].version < spec.version then
      hig[spec.name] = spec
    end
  end

  hig
end

#highest_remote_version(spec) ⇒ Object

:nodoc:



140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/rubygems/commands/update_command.rb', line 140

def highest_remote_version spec # :nodoc:
  spec_tuples = fetch_remote_gems spec

  matching_gems = spec_tuples.select do |g,_|
    g.name == spec.name and g.match_platform?
  end

  highest_remote_gem = matching_gems.max_by { |g,_| g.version }

  highest_remote_gem ||= [Gem::NameTuple.null]

  highest_remote_gem.first.version
end

#install_rubygems(version) ⇒ Object

:nodoc:



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/rubygems/commands/update_command.rb', line 154

def install_rubygems version # :nodoc:
  args = update_rubygems_arguments

  update_dir = File.join Gem.dir, 'gems', "rubygems-update-#{version}"

  Dir.chdir update_dir do
    say "Installing RubyGems #{version}"

    # Make sure old rubygems isn't loaded
    old = ENV["RUBYOPT"]
    ENV.delete("RUBYOPT") if old
    installed = system Gem.ruby, 'setup.rb', *args
    say "RubyGems system software updated" if installed
    ENV["RUBYOPT"] = old if old
  end
end

#rubygems_target_version ⇒ Object 



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/rubygems/commands/update_command.rb', line 171

def rubygems_target_version
  version = options[:system]
  update_latest = version == true

  if update_latest then
    version     = Gem::Version.new     Gem::VERSION
    requirement = Gem::Requirement.new ">= #{Gem::VERSION}"
  else
    version     = Gem::Version.new     version
    requirement = Gem::Requirement.new version
  end

  rubygems_update         = Gem::Specification.new
  rubygems_update.name    = 'rubygems-update'
  rubygems_update.version = version

  hig = {
    'rubygems-update' => rubygems_update
  }

  gems_to_update = which_to_update hig, options[:args], :system
  _, up_ver   = gems_to_update.first

  target = if update_latest then
             up_ver
           else
             version
           end

  return target, requirement
end

#update_gem(name, version = Gem::Requirement.default) ⇒ Object 



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/rubygems/commands/update_command.rb', line 203

def update_gem name, version = Gem::Requirement.default
  return if @updated.any? { |spec| spec.name == name }

  update_options = options.dup
  update_options[:prerelease] = version.prerelease?

  @installer = Gem::DependencyInstaller.new update_options

  say "Updating #{name}"
  begin
    @installer.install name, Gem::Requirement.new(version)
  rescue Gem::InstallError, Gem::DependencyError => e
    alert_error "Error installing #{name}:\n\t#{e.message}"
  end

  @installer.installed_gems.each do |spec|
    @updated << spec
  end
end

#update_gems(gems_to_update) ⇒ Object 



223
224
225
226
227
228
229
 
# File 'lib/rubygems/commands/update_command.rb', line 223

def update_gems gems_to_update
  gems_to_update.uniq.sort.each do |(name, version)|
    update_gem name, version
  end

  @updated
end

#update_rubygems ⇒ Object

Update RubyGems software to the latest version.



234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/rubygems/commands/update_command.rb', line 234

def update_rubygems
  check_update_arguments

  version, requirement = rubygems_target_version

  check_latest_rubygems version

  update_gem 'rubygems-update', version

  installed_gems = Gem::Specification.find_all_by_name 'rubygems-update', requirement
  version        = installed_gems.first.version

  install_rubygems version
end

#update_rubygems_arguments ⇒ Object

:nodoc:



249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/rubygems/commands/update_command.rb', line 249

def update_rubygems_arguments # :nodoc:
  args = []
  args << '--prefix' << Gem.prefix if Gem.prefix
  # TODO use --document for >= 1.9 , --no-rdoc --no-ri < 1.9
  args << '--no-rdoc' unless options[:document].include? 'rdoc'
  args << '--no-ri'   unless options[:document].include? 'ri'
  args << '--no-format-executable' if options[:no_format_executable]
  args << '--previous-version' << Gem::VERSION if
    options[:system] == true or
      Gem::Version.new(options[:system]) >= Gem::Version.new(2)
  args
end

#usage ⇒ Object

:nodoc:



67
68
69
 
# File 'lib/rubygems/commands/update_command.rb', line 67

def usage # :nodoc:
  "#{program_name} GEMNAME [GEMNAME ...]"
end

#which_to_update(highest_installed_gems, gem_names, system = false) ⇒ Object 



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/rubygems/commands/update_command.rb', line 262

def which_to_update highest_installed_gems, gem_names, system = false
  result = []

  highest_installed_gems.each do |l_name, l_spec|
    next if not gem_names.empty? and
            gem_names.none? { |name| name == l_spec.name }

    highest_remote_ver = highest_remote_version l_spec

    if system or (l_spec.version < highest_remote_ver) then
      result << [l_spec.name, [l_spec.version, highest_remote_ver].max]
    end
  end

  result
end