Class: Gem::Commands::QueryCommand

# File 'lib/rubygems/commands/query_command.rb', line 71

def description # :nodoc:
  <<-EOF
The query command is the basis for the list and search commands.

You should really use the list and search commands instead.  This command
is too hard to use.
  EOF
end

# File 'lib/rubygems/commands/query_command.rb', line 122

def display_header type
  if (ui.outs.tty? and Gem.configuration.verbose) or both? then
    say
    say "*** #{type} GEMS ***"
    say
  end
end

# File 'lib/rubygems/commands/query_command.rb', line 233

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

# File 'lib/rubygems/commands/query_command.rb', line 250

def entry_versions entry, name_tuples, platforms, specs
  return unless options[:versions]

  list =
    if platforms.empty? or options[:details] then
      name_tuples.map { |n| n.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] then
          platform_list = [pls.delete(Gem::Platform::RUBY), *pls.sort].compact
          out = platform_list.unshift(out).join(' ')
        end

        out
      end
    end

  entry << " (#{list.join ', '})"
end

# File 'lib/rubygems/commands/query_command.rb', line 80

def execute
  exit_code = 0
  if options[:args].to_a.empty? and options[:name].source.empty?
    name = options[:name]
    no_name = true
  elsif !options[:name].source.empty?
    name = Array(options[:name])
  else
    args = options[:args].to_a
    name = options[:exact] ? args.map{|arg| /\A#{Regexp.escape(arg)}\Z/ } : args.map{|arg| /#{arg}/i }
  end

  prerelease = options[:prerelease]

  unless options[:installed].nil? then
    if no_name then
      alert_error "You must specify a gem name"
      exit_code |= 4
    elsif name.count > 1
      alert_error "You must specify only ONE gem!"
      exit_code |= 4
    else
      installed = installed? name.first, options[:version]
      installed = !installed unless options[:installed]

      if installed then
        say "true"
      else
        say "false"
        exit_code |= 1
      end
    end

    terminate_interaction exit_code
  end

  names = Array(name)
  names.each { |n| show_gems n, prerelease }
end

# File 'lib/rubygems/commands/query_command.rb', line 187

def installed?(name, req = Gem::Requirement.default)
  Gem::Specification.any? { |s| s.name =~ name and req =~ s.version }
end

# File 'lib/rubygems/commands/query_command.rb', line 279

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

# File 'lib/rubygems/commands/query_command.rb', line 191

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

# File 'lib/rubygems/commands/query_command.rb', line 208

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] then
        true
      else
        seen[n.version] = true
        false
      end
    end

    output << clean_text(make_entry(matching_tuples, platforms))
  end
end

# File 'lib/rubygems/commands/query_command.rb', line 131

def show_gems name, prerelease
  req = Gem::Requirement.default
  # TODO: deprecate for real
  dep = Gem::Deprecate.skip_during { Gem::Dependency.new name, req }
  dep.prerelease = prerelease

  if local? then
    if prerelease and not both? then
      alert_warning "prereleases are always shown locally"
    end

    display_header 'LOCAL'

    specs = Gem::Specification.find_all { |s|
      s.name =~ name and req =~ s.version
    }

    spec_tuples = specs.map do |spec|
      [spec.name_tuple, spec]
    end

    output_query_results spec_tuples
  end

  if remote? then
    display_header 'REMOTE'

    fetcher = Gem::SpecFetcher.fetcher

    type = if options[:all]
             if options[:prerelease]
               :complete
             else
               :released
             end
           elsif options[:prerelease]
             :prerelease
           else
             :latest
           end

    if name.respond_to?(:source) && name.source.empty?
      spec_tuples = fetcher.detect(type) { true }
    else
      spec_tuples = fetcher.detect(type) do |name_tuple|
        name === name_tuple.name
      end
    end

    output_query_results spec_tuples
  end
end

# File 'lib/rubygems/commands/query_command.rb', line 294

def spec_authors entry, spec
  authors = "Author#{spec.authors.length > 1 ? 's' : ''}: ".dup
  authors << spec.authors.join(', ')
  entry << format_text(authors, 68, 4)
end

# File 'lib/rubygems/commands/query_command.rb', line 300

def spec_homepage entry, spec
  return if spec.homepage.nil? or spec.homepage.empty?

  entry << "\n" << format_text("Homepage: #{spec.homepage}", 68, 4)
end

# File 'lib/rubygems/commands/query_command.rb', line 306

def spec_license entry, spec
  return if spec.license.nil? or spec.license.empty?

  licenses = "License#{spec.licenses.length > 1 ? 's' : ''}: ".dup
  licenses << spec.licenses.join(', ')
  entry << "\n" << format_text(licenses, 68, 4)
end

# File 'lib/rubygems/commands/query_command.rb', line 314

def spec_loaded_from entry, spec, specs
  return unless spec.loaded_from

  if specs.length == 1 then
    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
      version << ', default' if s.default_gem?
      entry << "\n" << "    #{label} (#{version}): #{s.base_dir}"
      label = ' ' * label.length
    end
  end
end

# File 'lib/rubygems/commands/query_command.rb', line 331

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 then
    title = platforms.values.length == 1 ? 'Platform' : 'Platforms'
    entry << "    #{title}: #{platforms.values.sort.join ', '}\n"
  else
    entry << "    Platforms:\n"
    platforms.sort_by do |version,|
      version
    end.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

# File 'lib/rubygems/commands/query_command.rb', line 354

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