Class: Gem::Commands::SetupCommand

Inherits:
Gem::Command show all
Defined in:
lib/rubygems/commands/setup_command.rb

Overview

Installs RubyGems itself. This command is ordinarily only available from a RubyGems checkout or tarball.

Defined Under Namespace

Modules: MakeDirs

Constant Summary collapse

HISTORY_HEADER = 
%r{^#\s*[\d.a-zA-Z]+\s*/\s*\d{4}-\d{2}-\d{2}\s*$}.freeze
VERSION_MATCHER = 
%r{^#\s*([\d.a-zA-Z]+)\s*/\s*\d{4}-\d{2}-\d{2}\s*$}.freeze
ENV_PATHS = 
%w[/usr/bin/env /bin/env].freeze

Instance Attribute Summary

Attributes inherited from Gem::Command

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

Instance Method Summary collapse

Methods inherited from Gem::Command

add_common_option, #add_extra_args, #add_option, add_specific_extra_args, #arguments, #begins?, build_args, build_args=, #check_deprecated_options, common_options, #deprecate_option, #deprecated?, extra_args, extra_args=, #extract_gem_name_and_version, #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, #usage, #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

Methods included from Text

#clean_text, #format_text, #levenshtein_distance, #min3, #truncate_text

Constructor Details

#initialize ⇒ SetupCommand

Returns a new instance of SetupCommand.



15
16
17
18
19
20
21
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
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
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/rubygems/commands/setup_command.rb', line 15

def initialize
  super "setup", "Install RubyGems",
        :format_executable => false, :document => %w[ri],
        :force => true,
        :site_or_vendor => "sitelibdir",
        :destdir => "", :prefix => "", :previous_version => "",
        :regenerate_binstubs => true,
        :regenerate_plugins => true

  add_option "--previous-version=VERSION",
             "Previous version of RubyGems",
             "Used for changelog processing" do |version, options|
    options[:previous_version] = version
  end

  add_option "--prefix=PREFIX",
             "Prefix path for installing RubyGems",
             "Will not affect gem repository location" do |prefix, options|
    options[:prefix] = File.expand_path prefix
  end

  add_option "--destdir=DESTDIR",
             "Root directory to install RubyGems into",
             "Mainly used for packaging RubyGems" do |destdir, options|
    options[:destdir] = File.expand_path destdir
  end

  add_option "--[no-]vendor",
             "Install into vendorlibdir not sitelibdir" do |vendor, options|
    options[:site_or_vendor] = vendor ? "vendorlibdir" : "sitelibdir"
  end

  add_option "--[no-]format-executable",
             "Makes `gem` match ruby",
             "If Ruby is ruby18, gem will be gem18" do |value, options|
    options[:format_executable] = value
  end

  add_option "--[no-]document [TYPES]", Array,
             "Generate documentation for RubyGems",
             "List the documentation types you wish to",
             "generate.  For example: rdoc,ri" do |value, options|
    options[:document] = case value
                         when nil   then %w[rdoc ri]
                         when false then []
                         else value
    end
  end

  add_option "--[no-]rdoc",
             "Generate RDoc documentation for RubyGems" do |value, options|
    if value
      options[:document] << "rdoc"
    else
      options[:document].delete "rdoc"
    end

    options[:document].uniq!
  end

  add_option "--[no-]ri",
             "Generate RI documentation for RubyGems" do |value, options|
    if value
      options[:document] << "ri"
    else
      options[:document].delete "ri"
    end

    options[:document].uniq!
  end

  add_option "--[no-]regenerate-binstubs",
             "Regenerate gem binstubs" do |value, options|
    options[:regenerate_binstubs] = value
  end

  add_option "--[no-]regenerate-plugins",
             "Regenerate gem plugins" do |value, options|
    options[:regenerate_plugins] = value
  end

  add_option "-f", "--[no-]force",
             "Forcefully overwrite binstubs" do |value, options|
    options[:force] = value
  end

  add_option("-E", "--[no-]env-shebang",
             "Rewrite executables with a shebang",
             "of /usr/bin/env") do |value, options|
    options[:env_shebang] = value
  end

  @verbose = nil
end

Instance Method Details

#check_ruby_version ⇒ Object 



110
111
112
113
114
115
116
117
 
# File 'lib/rubygems/commands/setup_command.rb', line 110

def check_ruby_version
  required_version = Gem::Requirement.new ">= 2.6.0"

  unless required_version.satisfied_by? Gem.ruby_version
    alert_error "Expected Ruby version #{required_version}, is #{Gem.ruby_version}"
    terminate_interaction 1
  end
end

#defaults_str ⇒ Object

:nodoc:



119
120
121
 
# File 'lib/rubygems/commands/setup_command.rb', line 119

def defaults_str # :nodoc:
  "--format-executable --document ri --regenerate-binstubs"
end

#description ⇒ Object

:nodoc:



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/rubygems/commands/setup_command.rb', line 123

def description # :nodoc:
  <<-EOF
Installs RubyGems itself.

RubyGems installs RDoc for itself in GEM_HOME.  By default this is:
#{Gem.dir}

If you prefer a different directory, set the GEM_HOME environment variable.

RubyGems will install the gem command with a name matching ruby's
prefix and suffix.  If ruby was installed as `ruby18`, gem will be
installed as `gem18`.

By default, this RubyGems will install gem as:
#{Gem.default_exec_format % "gem"}
  EOF
end

#execute ⇒ Object 



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
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
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/rubygems/commands/setup_command.rb', line 148

def execute
  @verbose = Gem.configuration.really_verbose

  check_ruby_version

  require "fileutils"
  if Gem.configuration.really_verbose
    extend FileUtils::Verbose
  else
    extend FileUtils
  end
  extend MakeDirs

  lib_dir, bin_dir = make_destination_dirs
  man_dir = generate_default_man_dir

  install_lib lib_dir

  install_executables bin_dir

  remove_old_bin_files bin_dir

  remove_old_lib_files lib_dir

  # Can be removed one we drop support for bundler 2.2.3 (the last version installing man files to man_dir)
  remove_old_man_files man_dir if man_dir && File.exist?(man_dir)

  install_default_bundler_gem bin_dir

  if mode = options[:dir_mode]
    @mkdirs.uniq!
    File.chmod(mode, @mkdirs)
  end

  say "RubyGems #{Gem::VERSION} installed"

  regenerate_binstubs(bin_dir) if options[:regenerate_binstubs]
  regenerate_plugins(bin_dir) if options[:regenerate_plugins]

  uninstall_old_gemcutter

  documentation_success = install_rdoc

  say
  if @verbose
    say "-" * 78
    say
  end

  if options[:previous_version].empty?
    options[:previous_version] = Gem::VERSION.sub(/[0-9]+$/, "0")
  end

  options[:previous_version] = Gem::Version.new(options[:previous_version])

  show_release_notes

  say
  say "-" * 78
  say

  say "RubyGems installed the following executables:"
  say bin_file_names.map {|name| "\t#{name}\n" }
  say

  unless bin_file_names.grep(/#{File::SEPARATOR}gem$/)
    say "If `gem` was installed by a previous RubyGems installation, you may need"
    say "to remove it by hand."
    say
  end

  if documentation_success
    if options[:document].include? "rdoc"
      say "Rdoc documentation was installed. You may now invoke:"
      say "  gem server"
      say "and then peruse beautifully formatted documentation for your gems"
      say "with your web browser."
      say "If you do not wish to install this documentation in the future, use the"
      say "--no-document flag, or set it as the default in your ~/.gemrc file. See"
      say "'gem help env' for details."
      say
    end

    if options[:document].include? "ri"
      say "Ruby Interactive (ri) documentation was installed. ri is kind of like man "
      say "pages for Ruby libraries. You may access it like this:"
      say "  ri Classname"
      say "  ri Classname.class_method"
      say "  ri Classname#instance_method"
      say "If you do not wish to install this documentation in the future, use the"
      say "--no-document flag, or set it as the default in your ~/.gemrc file. See"
      say "'gem help env' for details."
      say
    end
  end
end

#files_in(dir) ⇒ Object 



467
468
469
470
471
472
 
# File 'lib/rubygems/commands/setup_command.rb', line 467

def files_in(dir)
  Dir.chdir dir do
    Dir.glob(File.join("**", "*"), File::FNM_DOTMATCH).
      select {|f| !File.directory?(f) }
  end
end

#generate_default_dirs ⇒ Object 



452
453
454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'lib/rubygems/commands/setup_command.rb', line 452

def generate_default_dirs
  prefix = options[:prefix]
  site_or_vendor = options[:site_or_vendor]

  if prefix.empty?
    lib_dir = RbConfig::CONFIG[site_or_vendor]
    bin_dir = RbConfig::CONFIG["bindir"]
  else
    lib_dir = File.join prefix, "lib"
    bin_dir = File.join prefix, "bin"
  end

  [prepend_destdir_if_present(lib_dir), prepend_destdir_if_present(bin_dir)]
end

#generate_default_man_dir ⇒ Object 



439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'lib/rubygems/commands/setup_command.rb', line 439

def generate_default_man_dir
  prefix = options[:prefix]

  if prefix.empty?
    man_dir = RbConfig::CONFIG["mandir"]
    return unless man_dir
  else
    man_dir = File.join prefix, "man"
  end

  prepend_destdir_if_present(man_dir)
end

#install_default_bundler_gem(bin_dir) ⇒ Object 



363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
 
# File 'lib/rubygems/commands/setup_command.rb', line 363

def install_default_bundler_gem(bin_dir)
  current_default_spec = Gem::Specification.default_stubs.find {|s| s.name == "bundler" }
  specs_dir = if current_default_spec && default_dir == Gem.default_dir
    Gem::Specification.remove_spec current_default_spec
    loaded_from = current_default_spec.loaded_from
    File.delete(loaded_from)
    File.dirname(loaded_from)
  else
    target_specs_dir = File.join(default_dir, "specifications", "default")
    mkdir_p target_specs_dir, :mode => 0o755
    target_specs_dir
  end

  bundler_spec = Dir.chdir("bundler") { Gem::Specification.load("bundler.gemspec") }
  default_spec_path = File.join(specs_dir, "#{bundler_spec.full_name}.gemspec")
  Gem.write_binary(default_spec_path, bundler_spec.to_ruby)

  bundler_spec = Gem::Specification.load(default_spec_path)

  # Remove gemspec that was same version of vendored bundler.
  normal_gemspec = File.join(default_dir, "specifications", "bundler-#{bundler_spec.version}.gemspec")
  if File.file? normal_gemspec
    File.delete normal_gemspec
  end

  # Remove gem files that were same version of vendored bundler.
  if File.directory? bundler_spec.gems_dir
    Dir.entries(bundler_spec.gems_dir).
      select {|default_gem| File.basename(default_gem) == "bundler-#{bundler_spec.version}" }.
      each {|default_gem| rm_r File.join(bundler_spec.gems_dir, default_gem) }
  end

  bundler_bin_dir = bundler_spec.bin_dir
  mkdir_p bundler_bin_dir, :mode => 0o755
  bundler_spec.executables.each do |e|
    cp File.join("bundler", bundler_spec.bindir, e), File.join(bundler_bin_dir, e)
  end

  require_relative "../installer"

  Dir.chdir("bundler") do
    built_gem = Gem::Package.build(bundler_spec)
    begin
      Gem::Installer.at(
        built_gem,
        env_shebang: options[:env_shebang],
        format_executable: options[:format_executable],
        force: options[:force],
        install_as_default: true,
        bin_dir: bin_dir,
        install_dir: default_dir,
        wrappers: true
      ).install
    ensure
      FileUtils.rm_f built_gem
    end
  end

  bundler_spec.executables.each {|executable| bin_file_names << target_bin_path(bin_dir, executable) }

  say "Bundler #{bundler_spec.version} installed"
end

#install_executables(bin_dir) ⇒ Object 



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/rubygems/commands/setup_command.rb', line 245

def install_executables(bin_dir)
  prog_mode = options[:prog_mode] || 0o755

  executables = { "gem" => "exe" }
  executables.each do |tool, path|
    say "Installing #{tool} executable" if @verbose

    Dir.chdir path do
      bin_file = "gem"

      require "tmpdir"

      dest_file = target_bin_path(bin_dir, bin_file)
      bin_tmp_file = File.join Dir.tmpdir, "#{bin_file}.#{$$}"

      begin
        bin = File.readlines bin_file
        bin[0] = shebang

        File.open bin_tmp_file, "w" do |fp|
          fp.puts bin.join
        end

        install bin_tmp_file, dest_file, :mode => prog_mode
        bin_file_names << dest_file
      ensure
        rm bin_tmp_file
      end

      next unless Gem.win_platform?

      begin
        bin_cmd_file = File.join Dir.tmpdir, "#{bin_file}.bat"

        File.open bin_cmd_file, "w" do |file|
          file.puts <<-TEXT
@ECHO OFF
IF NOT "%~f0" == "~f0" GOTO :WinNT
@"#{File.basename(Gem.ruby).chomp('"')}" "#{dest_file}" %1 %2 %3 %4 %5 %6 %7 %8 %9
GOTO :EOF
:WinNT
@"#{File.basename(Gem.ruby).chomp('"')}" "%~dpn0" %*
TEXT
        end

        install bin_cmd_file, "#{dest_file}.bat", :mode => prog_mode
      ensure
        rm bin_cmd_file
      end
    end
  end
end

#install_lib(lib_dir) ⇒ Object 



308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/rubygems/commands/setup_command.rb', line 308

def install_lib(lib_dir)
  libs = { "RubyGems" => "lib" }
  libs["Bundler"] = "bundler/lib"
  libs.each do |tool, path|
    say "Installing #{tool}" if @verbose

    lib_files = files_in path

    Dir.chdir path do
      install_file_list(lib_files, lib_dir)
    end
  end
end

#install_rdoc ⇒ Object 



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/rubygems/commands/setup_command.rb', line 322

def install_rdoc
  gem_doc_dir = File.join Gem.dir, "doc"
  rubygems_name = "rubygems-#{Gem::VERSION}"
  rubygems_doc_dir = File.join gem_doc_dir, rubygems_name

  begin
    Gem.ensure_gem_subdirectories Gem.dir
  rescue SystemCallError
    # ignore
  end

  if File.writable?(gem_doc_dir) &&
     (!File.exist?(rubygems_doc_dir) ||
      File.writable?(rubygems_doc_dir))
    say "Removing old RubyGems RDoc and ri" if @verbose
    Dir[File.join(Gem.dir, "doc", "rubygems-[0-9]*")].each do |dir|
      rm_rf dir
    end

    require_relative "../rdoc"

    fake_spec = Gem::Specification.new "rubygems", Gem::VERSION
    def fake_spec.full_gem_path
      File.expand_path "../../..", __dir__
    end

    generate_ri   = options[:document].include? "ri"
    generate_rdoc = options[:document].include? "rdoc"

    rdoc = Gem::RDoc.new fake_spec, generate_rdoc, generate_ri
    rdoc.generate

    return true
  elsif @verbose
    say "Skipping RDoc generation, #{gem_doc_dir} not writable"
    say "Set the GEM_HOME environment variable if you want RDoc generated"
  end

  false
end

#make_destination_dirs ⇒ Object 



426
427
428
429
430
431
432
433
434
435
436
437
 
# File 'lib/rubygems/commands/setup_command.rb', line 426

def make_destination_dirs
  lib_dir, bin_dir = Gem.default_rubygems_dirs

  unless lib_dir
    lib_dir, bin_dir = generate_default_dirs
  end

  mkdir_p lib_dir, :mode => 0o755
  mkdir_p bin_dir, :mode => 0o755

  [lib_dir, bin_dir]
end

#regenerate_binstubs(bindir) ⇒ Object 



585
586
587
588
589
590
591
592
593
594
595
596
597
 
# File 'lib/rubygems/commands/setup_command.rb', line 585

def regenerate_binstubs(bindir)
  require_relative "pristine_command"
  say "Regenerating binstubs"

  args = %w[--all --only-executables --silent]
  args << "--bindir=#{bindir}"
  if options[:env_shebang]
    args << "--env-shebang"
  end

  command = Gem::Commands::PristineCommand.new
  command.invoke(*args)
end

#regenerate_plugins(bindir) ⇒ Object 



599
600
601
602
603
604
605
606
607
608
609
 
# File 'lib/rubygems/commands/setup_command.rb', line 599

def regenerate_plugins(bindir)
  require_relative "pristine_command"
  say "Regenerating plugins"

  args = %w[--all --only-plugins --silent]
  args << "--bindir=#{bindir}"
  args << "--install-dir=#{default_dir}"

  command = Gem::Commands::PristineCommand.new
  command.invoke(*args)
end

#remove_old_bin_files(bin_dir) ⇒ Object 



474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
 
# File 'lib/rubygems/commands/setup_command.rb', line 474

def remove_old_bin_files(bin_dir)
  old_bin_files = {
    "gem_mirror" => "gem mirror",
    "gem_server" => "gem server",
    "gemlock" => "gem lock",
    "gemri" => "ri",
    "gemwhich" => "gem which",
    "index_gem_repository.rb" => "gem generate_index",
  }

  old_bin_files.each do |old_bin_file, new_name|
    old_bin_path = File.join bin_dir, old_bin_file
    next unless File.exist? old_bin_path

    deprecation_message = "`#{old_bin_file}` has been deprecated. Use `#{new_name}` instead."

    File.open old_bin_path, "w" do |fp|
      fp.write <<-EOF
#!#{Gem.ruby}

abort "#{deprecation_message}"
  EOF
    end

    next unless Gem.win_platform?

    File.open "#{old_bin_path}.bat", "w" do |fp|
      fp.puts %(@ECHO.#{deprecation_message})
    end
  end
end

#remove_old_lib_files(lib_dir) ⇒ Object 



506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
 
# File 'lib/rubygems/commands/setup_command.rb', line 506

def remove_old_lib_files(lib_dir)
  lib_dirs = { File.join(lib_dir, "rubygems") => "lib/rubygems" }
  lib_dirs[File.join(lib_dir, "bundler")] = "bundler/lib/bundler"
  lib_dirs.each do |old_lib_dir, new_lib_dir|
    lib_files = files_in(new_lib_dir)

    old_lib_files = files_in(old_lib_dir)

    to_remove = old_lib_files - lib_files

    gauntlet_rubygems = File.join(lib_dir, "gauntlet_rubygems.rb")
    to_remove << gauntlet_rubygems if File.exist? gauntlet_rubygems

    to_remove.delete_if do |file|
      file.start_with? "defaults"
    end

    remove_file_list(to_remove, old_lib_dir)
  end
end

#remove_old_man_files(old_man_dir) ⇒ Object 



527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
 
# File 'lib/rubygems/commands/setup_command.rb', line 527

def remove_old_man_files(old_man_dir)
  old_man1_dir = "#{old_man_dir}/man1"

  if File.exist?(old_man1_dir)
    man1_to_remove = Dir.chdir(old_man1_dir) { Dir["bundle*.1{,.txt,.ronn}"] }

    remove_file_list(man1_to_remove, old_man1_dir)
  end

  old_man5_dir = "#{old_man_dir}/man5"

  if File.exist?(old_man5_dir)
    man5_to_remove = Dir.chdir(old_man5_dir) { Dir["gemfile.5{,.txt,.ronn}"] }

    remove_file_list(man5_to_remove, old_man5_dir)
  end
end

#shebang ⇒ Object 



298
299
300
301
302
303
304
305
306
 
# File 'lib/rubygems/commands/setup_command.rb', line 298

def shebang
  if options[:env_shebang]
    ruby_name = RbConfig::CONFIG["ruby_install_name"]
    @env_path ||= ENV_PATHS.find {|env_path| File.executable? env_path }
    "#!#{@env_path} #{ruby_name}\n"
  else
    "#!#{Gem.ruby}\n"
  end
end

#show_release_notes ⇒ Object 



545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
 
# File 'lib/rubygems/commands/setup_command.rb', line 545

def show_release_notes
  release_notes = File.join Dir.pwd, "CHANGELOG.md"

  release_notes =
    if File.exist? release_notes
      history = File.read release_notes

      history.force_encoding Encoding::UTF_8

      text = history.split(HISTORY_HEADER)
      text.shift # correct an off-by-one generated by split
      version_lines = history.scan(HISTORY_HEADER)
      versions = history.scan(VERSION_MATCHER).flatten.map do |x|
        Gem::Version.new(x)
      end

      history_string = ""

      until versions.length == 0 ||
            versions.shift <= options[:previous_version] do
        history_string += version_lines.shift + text.shift
      end

      history_string
    else
      "Oh-no! Unable to find release notes!"
    end

  say release_notes
end

#uninstall_old_gemcutter ⇒ Object 



576
577
578
579
580
581
582
583
 
# File 'lib/rubygems/commands/setup_command.rb', line 576

def uninstall_old_gemcutter
  require_relative "../uninstaller"

  ui = Gem::Uninstaller.new("gemcutter", :all => true, :ignore => true,
                                         :version => "< 0.4")
  ui.uninstall
rescue Gem::InstallError
end