rubygems-update 2.6.1 → 3.5.0

data/lib/rubygems/query_utils.rb

@@ -0,0 +1,349 @@
+# frozen_string_literal: true
+
+require_relative "local_remote_options"
+require_relative "spec_fetcher"
+require_relative "version_option"
+require_relative "text"
+
+module Gem::QueryUtils
+  include Gem::Text
+  include Gem::LocalRemoteOptions
+  include Gem::VersionOption
+
+  def add_query_options
+    add_option("-i", "--[no-]installed",
+               "Check for installed gem") do |value, options|
+      options[:installed] = value
+    end
+
+    add_option("-I", "Equivalent to --no-installed") do |_value, options|
+      options[:installed] = false
+    end
+
+    add_version_option command, "for use with --installed"
+
+    add_option("-d", "--[no-]details",
+               "Display detailed information of gem(s)") do |value, options|
+      options[:details] = value
+    end
+
+    add_option("--[no-]versions",
+               "Display only gem names") do |value, options|
+      options[:versions] = value
+      options[:details] = false unless value
+    end
+
+    add_option("-a", "--all",
+               "Display all gem versions") do |value, options|
+      options[:all] = value
+    end
+
+    add_option("-e", "--exact",
+               "Name of gem(s) to query on matches the",
+               "provided STRING") do |value, options|
+      options[:exact] = value
+    end
+
+    add_option("--[no-]prerelease",
+               "Display prerelease versions") do |value, options|
+      options[:prerelease] = value
+    end
+
+    add_local_remote_options
+  end
+
+  def defaults_str # :nodoc:
+    "--local --no-details --versions --no-installed"
+  end
+
+  def execute
+    gem_names = if args.empty?
+      [options[:name]]
+    else
+      options[:exact] ? args.map {|arg| /\A#{Regexp.escape(arg)}\Z/ } : args.map {|arg| /#{arg}/i }
+    end
+
+    terminate_interaction(check_installed_gems(gem_names)) if check_installed_gems?
+
+    gem_names.each {|n| show_gems(n) }
+  end
+
+  private
+
+  def check_installed_gems(gem_names)
+    exit_code = 0
+
+    if args.empty? && !gem_name?
+      alert_error "You must specify a gem name"
+      exit_code = 4
+    elsif gem_names.count > 1
+      alert_error "You must specify only ONE gem!"
+      exit_code = 4
+    else
+      installed = installed?(gem_names.first, options[:version])
+      installed = !installed unless options[:installed]
+
+      say(installed)
+      exit_code = 1 unless installed
+    end
+
+    exit_code
+  end
+
+  def check_installed_gems?
+    !options[:installed].nil?
+  end
+
+  def gem_name?
+    !options[:name].nil?
+  end
+
+  def prerelease
+    options[:prerelease]
+  end
+
+  def show_prereleases?
+    prerelease.nil? || prerelease
+  end
+
+  def args
+    options[:args].to_a
+  end
+
+  def display_header(type)
+    if (ui.outs.tty? && Gem.configuration.verbose) || both?
+      say
+      say "*** #{type} GEMS ***"
+      say
+    end
+  end
+
+  # Guts of original execute
+  def show_gems(name)
+    show_local_gems(name)  if local?
+    show_remote_gems(name) if remote?
+  end
+
+  def show_local_gems(name, req = Gem::Requirement.default)
+    display_header("LOCAL")
+
+    specs = Gem::Specification.find_all do |s|
+      name_matches = name ? s.name =~ name : true
+      version_matches = show_prereleases? || !s.version.prerelease?
+
+      name_matches && version_matches
+    end
+
+    spec_tuples = specs.map do |spec|
+      [spec.name_tuple, spec]
+    end
+
+    output_query_results(spec_tuples)
+  end
+
+  def show_remote_gems(name)
+    display_header("REMOTE")
+
+    fetcher = Gem::SpecFetcher.fetcher
+
+    spec_tuples = if name.nil?
+      fetcher.detect(specs_type) { true }
+    else
+      fetcher.detect(specs_type) do |name_tuple|
+        name === name_tuple.name && options[:version].satisfied_by?(name_tuple.version)
+      end
+    end
+
+    output_query_results(spec_tuples)
+  end
+
+  def specs_type
+    if options[:all] || options[:version].specific?
+      if options[:prerelease]
+        :complete
+      else
+        :released
+      end
+    elsif options[:prerelease]
+      :prerelease
+    else
+      :latest
+    end
+  end
+
+  ##
+  # Check if gem +name+ version +version+ is installed.
+
+  def installed?(name, req = Gem::Requirement.default)
+    Gem::Specification.any? {|s| s.name =~ name && req =~ s.version }
+  end
+
+  def output_query_results(spec_tuples)
+    output = []
+    versions = Hash.new {|h,name| h[name] = [] }
+
+    spec_tuples.each do |spec_tuple, source|
+      versions[spec_tuple.name] << [spec_tuple, source]
+    end
+
+    versions = versions.sort_by do |(n,_),_|
+      n.downcase
+    end
+
+    output_versions output, versions
+
+    say output.join(options[:details] ? "\n\n" : "\n")
+  end
+
+  def output_versions(output, versions)
+    versions.each do |_gem_name, matching_tuples|
+      matching_tuples = matching_tuples.sort_by {|n,_| n.version }.reverse
+
+      platforms = Hash.new {|h,version| h[version] = [] }
+
+      matching_tuples.each do |n, _|
+        platforms[n.version] << n.platform if n.platform
+      end
+
+      seen = {}
+
+      matching_tuples.delete_if do |n,_|
+        if seen[n.version]
+          true
+        else
+          seen[n.version] = true
+          false
+        end
+      end
+
+      output << clean_text(make_entry(matching_tuples, platforms))
+    end
+  end
+
+  def entry_details(entry, detail_tuple, specs, platforms)
+    return unless options[:details]
+
+    name_tuple, spec = detail_tuple
+
+    spec = spec.fetch_spec(name_tuple)if spec.respond_to?(:fetch_spec)
+
+    entry << "\n"
+
+    spec_platforms   entry, platforms
+    spec_authors     entry, spec
+    spec_homepage    entry, spec
+    spec_license     entry, spec
+    spec_loaded_from entry, spec, specs
+    spec_summary     entry, spec
+  end
+
+  def entry_versions(entry, name_tuples, platforms, specs)
+    return unless options[:versions]
+
+    list =
+      if platforms.empty? || options[:details]
+        name_tuples.map(&:version).uniq
+      else
+        platforms.sort.reverse.map do |version, pls|
+          out = version.to_s
+
+          if options[:domain] == :local
+            default = specs.any? do |s|
+              !s.is_a?(Gem::Source) && s.version == version && s.default_gem?
+            end
+            out = "default: #{out}" if default
+          end
+
+          if pls != [Gem::Platform::RUBY]
+            platform_list = [pls.delete(Gem::Platform::RUBY), *pls.sort].compact
+            out = platform_list.unshift(out).join(" ")
+          end
+
+          out
+        end
+      end
+
+    entry << " (#{list.join ", "})"
+  end
+
+  def make_entry(entry_tuples, platforms)
+    detail_tuple = entry_tuples.first
+
+    name_tuples, specs = entry_tuples.flatten.partition do |item|
+      Gem::NameTuple === item
+    end
+
+    entry = [name_tuples.first.name]
+
+    entry_versions(entry, name_tuples, platforms, specs)
+    entry_details(entry, detail_tuple, specs, platforms)
+
+    entry.join
+  end
+
+  def spec_authors(entry, spec)
+    authors = "Author#{spec.authors.length > 1 ? "s" : ""}: ".dup
+    authors << spec.authors.join(", ")
+    entry << format_text(authors, 68, 4)
+  end
+
+  def spec_homepage(entry, spec)
+    return if spec.homepage.nil? || spec.homepage.empty?
+
+    entry << "\n" << format_text("Homepage: #{spec.homepage}", 68, 4)
+  end
+
+  def spec_license(entry, spec)
+    return if spec.license.nil? || spec.license.empty?
+
+    licenses = "License#{spec.licenses.length > 1 ? "s" : ""}: ".dup
+    licenses << spec.licenses.join(", ")
+    entry << "\n" << format_text(licenses, 68, 4)
+  end
+
+  def spec_loaded_from(entry, spec, specs)
+    return unless spec.loaded_from
+
+    if specs.length == 1
+      default = spec.default_gem? ? " (default)" : nil
+      entry << "\n" << "    Installed at#{default}: #{spec.base_dir}"
+    else
+      label = "Installed at"
+      specs.each do |s|
+        version = s.version.to_s
+        default = ", default" if s.default_gem?
+        entry << "\n" << "    #{label} (#{version}#{default}): #{s.base_dir}"
+        label = " " * label.length
+      end
+    end
+  end
+
+  def spec_platforms(entry, platforms)
+    non_ruby = platforms.any? do |_, pls|
+      pls.any? {|pl| pl != Gem::Platform::RUBY }
+    end
+
+    return unless non_ruby
+
+    if platforms.length == 1
+      title = platforms.values.length == 1 ? "Platform" : "Platforms"
+      entry << "    #{title}: #{platforms.values.sort.join(", ")}\n"
+    else
+      entry << "    Platforms:\n"
+
+      sorted_platforms = platforms.sort
+
+      sorted_platforms.each do |version, pls|
+        label = "        #{version}: "
+        data = format_text pls.sort.join(", "), 68, label.length
+        data[0, label.length] = label
+        entry << data << "\n"
+      end
+    end
+  end
+
+  def spec_summary(entry, spec)
+    summary = truncate_text(spec.summary, "the summary for #{spec.full_name}")
+    entry << "\n\n" << format_text(summary, 68, 4)
+  end
+end

data/lib/rubygems/rdoc.rb

@@ -1,335 +1,13 @@
 # frozen_string_literal: true
-require 'rubygems'
-require 'rubygems/user_interaction'
-require 'fileutils'
 
-begin
-  gem 'rdoc'
-rescue Gem::LoadError
-  # swallow
-else
-  # This will force any deps that 'rdoc' might have
-  # (such as json) that are ambiguous to be activated, which
-  # is important because we end up using Specification.reset
-  # and we don't want the warning it pops out.
-  Gem.finish_resolve
-end
-
-loaded_hook = false
+require_relative "../rubygems"
 
 begin
-  require 'rdoc/rubygems_hook'
-  loaded_hook = true
+  require "rdoc/rubygems_hook"
   module Gem
     RDoc = ::RDoc::RubygemsHook
   end
+
+  Gem.done_installing(&Gem::RDoc.method(:generation_hook))
 rescue LoadError
 end
-
-##
-# Gem::RDoc provides methods to generate RDoc and ri data for installed gems.
-# It works for RDoc 1.0.1 (in Ruby 1.8) up to RDoc 3.6.
-#
-# This implementation is considered obsolete.  The RDoc project is the
-# appropriate location to find this functionality.  This file provides the
-# hooks to load RDoc generation code from the "rdoc" gem and a fallback in
-# case the installed version of RDoc does not have them.
-
-class Gem::RDoc # :nodoc: all
-
-  include Gem::UserInteraction
-  extend  Gem::UserInteraction
-
-  @rdoc_version = nil
-  @specs = []
-
-  ##
-  # Force installation of documentation?
-
-  attr_accessor :force
-
-  ##
-  # Generate rdoc?
-
-  attr_accessor :generate_rdoc
-
-  ##
-  # Generate ri data?
-
-  attr_accessor :generate_ri
-
-  class << self
-
-    ##
-    # Loaded version of RDoc.  Set by ::load_rdoc
-
-    attr_reader :rdoc_version
-
-  end
-
-  ##
-  # Post installs hook that generates documentation for each specification in
-  # +specs+
-
-  def self.generation_hook installer, specs
-    start = Time.now
-    types = installer.document
-
-    generate_rdoc = types.include? 'rdoc'
-    generate_ri   = types.include? 'ri'
-
-    specs.each do |spec|
-      new(spec, generate_rdoc, generate_ri).generate
-    end
-
-    return unless generate_rdoc or generate_ri
-
-    duration = (Time.now - start).to_i
-    names    = specs.map(&:name).join ', '
-
-    say "Done installing documentation for #{names} after #{duration} seconds"
-  end
-
-  ##
-  # Loads the RDoc generator
-
-  def self.load_rdoc
-    return if @rdoc_version
-
-    require 'rdoc/rdoc'
-
-    @rdoc_version = if ::RDoc.const_defined? :VERSION then
-                      Gem::Version.new ::RDoc::VERSION
-                    else
-                      Gem::Version.new '1.0.1'
-                    end
-
-  rescue LoadError => e
-    raise Gem::DocumentError, "RDoc is not installed: #{e}"
-  end
-
-  ##
-  # Creates a new documentation generator for +spec+.  RDoc and ri data
-  # generation can be enabled or disabled through +generate_rdoc+ and
-  # +generate_ri+ respectively.
-  #
-  # Only +generate_ri+ is enabled by default.
-
-  def initialize spec, generate_rdoc = true, generate_ri = true
-    @doc_dir   = spec.doc_dir
-    @file_info = nil
-    @force     = false
-    @rdoc      = nil
-    @spec      = spec
-
-    @generate_rdoc = generate_rdoc
-    @generate_ri   = generate_ri
-
-    @rdoc_dir = spec.doc_dir 'rdoc'
-    @ri_dir   = spec.doc_dir 'ri'
-  end
-
-  ##
-  # Removes legacy rdoc arguments from +args+
-  #--
-  # TODO move to RDoc::Options
-
-  def delete_legacy_args args
-    args.delete '--inline-source'
-    args.delete '--promiscuous'
-    args.delete '-p'
-    args.delete '--one-file'
-  end
-
-  ##
-  # Generates documentation using the named +generator+ ("darkfish" or "ri")
-  # and following the given +options+.
-  #
-  # Documentation will be generated into +destination+
-
-  def document generator, options, destination
-    generator_name = generator
-
-    options = options.dup
-    options.exclude ||= [] # TODO maybe move to RDoc::Options#finish
-    options.setup_generator generator
-    options.op_dir = destination
-    options.finish
-
-    generator = options.generator.new @rdoc.store, options
-
-    @rdoc.options = options
-    @rdoc.generator = generator
-
-    say "Installing #{generator_name} documentation for #{@spec.full_name}"
-
-    FileUtils.mkdir_p options.op_dir
-
-    Dir.chdir options.op_dir do
-      begin
-        @rdoc.class.current = @rdoc
-        @rdoc.generator.generate @file_info
-      ensure
-        @rdoc.class.current = nil
-      end
-    end
-  end
-
-  ##
-  # Generates RDoc and ri data
-
-  def generate
-    return unless @generate_ri or @generate_rdoc
-
-    setup
-
-    options = nil
-
-    if Gem::Requirement.new('< 3').satisfied_by? self.class.rdoc_version then
-      generate_legacy
-      return
-    end
-
-    ::RDoc::TopLevel.reset # TODO ::RDoc::RDoc.reset
-    ::RDoc::Parser::C.reset
-
-    args = @spec.rdoc_options
-    args.concat @spec.source_paths
-    args.concat @spec.extra_rdoc_files
-
-    case config_args = Gem.configuration[:rdoc]
-    when String then
-      args = args.concat config_args.split
-    when Array then
-      args = args.concat config_args
-    end
-
-    delete_legacy_args args
-
-    Dir.chdir @spec.full_gem_path do
-      options = ::RDoc::Options.new
-      options.default_title = "#{@spec.full_name} Documentation"
-      options.parse args
-    end
-
-    options.quiet = !Gem.configuration.really_verbose
-
-    @rdoc = new_rdoc
-    @rdoc.options = options
-
-    say "Parsing documentation for #{@spec.full_name}"
-
-    Dir.chdir @spec.full_gem_path do
-      @file_info = @rdoc.parse_files options.files
-    end
-
-    document 'ri',       options, @ri_dir if
-      @generate_ri   and (@force or not File.exist? @ri_dir)
-
-    document 'darkfish', options, @rdoc_dir if
-      @generate_rdoc and (@force or not File.exist? @rdoc_dir)
-  end
-
-  ##
-  # Generates RDoc and ri data for legacy RDoc versions.  This method will not
-  # exist in future versions.
-
-  def generate_legacy
-    if @generate_rdoc then
-      FileUtils.rm_rf @rdoc_dir
-      say "Installing RDoc documentation for #{@spec.full_name}"
-      legacy_rdoc '--op', @rdoc_dir
-    end
-
-    if @generate_ri then
-      FileUtils.rm_rf @ri_dir
-      say "Installing ri documentation for #{@spec.full_name}"
-      legacy_rdoc '--ri', '--op', @ri_dir
-    end
-  end
-
-  ##
-  # Generates RDoc using a legacy version of RDoc from the ARGV-like +args+.
-  # This method will not exist in future versions.
-
-  def legacy_rdoc *args
-    args << @spec.rdoc_options
-    args << '--quiet'
-    args << @spec.require_paths.clone
-    args << @spec.extra_rdoc_files
-    args << '--title' << "#{@spec.full_name} Documentation"
-    args = args.flatten.map do |arg| arg.to_s end
-
-    delete_legacy_args args if
-      Gem::Requirement.new('>= 2.4.0') =~ self.class.rdoc_version
-
-    r = new_rdoc
-    verbose { "rdoc #{args.join ' '}" }
-
-    Dir.chdir @spec.full_gem_path do
-      begin
-        r.document args
-      rescue Errno::EACCES => e
-        dirname = File.dirname e.message.split("-")[1].strip
-        raise Gem::FilePermissionError, dirname
-      rescue Interrupt => e
-        raise e
-      rescue Exception => ex
-        alert_error "While generating documentation for #{@spec.full_name}"
-        ui.errs.puts "... MESSAGE:   #{ex}"
-        ui.errs.puts "... RDOC args: #{args.join(' ')}"
-        ui.backtrace ex
-        ui.errs.puts "(continuing with the rest of the installation)"
-      end
-    end
-  end
-
-  ##
-  # #new_rdoc creates a new RDoc instance.  This method is provided only to
-  # make testing easier.
-
-  def new_rdoc # :nodoc:
-    ::RDoc::RDoc.new
-  end
-
-  ##
-  # Is rdoc documentation installed?
-
-  def rdoc_installed?
-    File.exist? @rdoc_dir
-  end
-
-  ##
-  # Removes generated RDoc and ri data
-
-  def remove
-    base_dir = @spec.base_dir
-
-    raise Gem::FilePermissionError, base_dir unless File.writable? base_dir
-
-    FileUtils.rm_rf @rdoc_dir
-    FileUtils.rm_rf @ri_dir
-  end
-
-  ##
-  # Is ri data installed?
-
-  def ri_installed?
-    File.exist? @ri_dir
-  end
-
-  ##
-  # Prepares the spec for documentation generation
-
-  def setup
-    self.class.load_rdoc
-
-    raise Gem::FilePermissionError, @doc_dir if
-      File.exist?(@doc_dir) and not File.writable?(@doc_dir)
-
-    FileUtils.mkdir_p @doc_dir unless File.exist? @doc_dir
-  end
-
-end unless loaded_hook
-
-Gem.done_installing(&Gem::RDoc.method(:generation_hook))