Gem::Commands::ContentsCommand

Public Class Methods

new() click to toggle source

 
               # File rubygems/commands/contents_command.rb, line 8
def initialize
  super 'contents', 'Display the contents of the installed gems',
        :specdirs => [], :lib_only => false, :prefix => true

  add_version_option

  add_option(      '--all',
             "Contents for all gems") do |all, options|
    options[:all] = all
  end

  add_option('-s', '--spec-dir a,b,c', Array,
             "Search for gems under specific paths") do |spec_dirs, options|
    options[:specdirs] = spec_dirs
  end

  add_option('-l', '--[no-]lib-only',
             "Only return files in the Gem's lib_dirs") do |lib_only, options|
    options[:lib_only] = lib_only
  end

  add_option(      '--[no-]prefix',
             "Don't include installed path prefix") do |prefix, options|
    options[:prefix] = prefix
  end
end

Public Instance Methods

execute() click to toggle source

 
               # File rubygems/commands/contents_command.rb, line 47
def execute
  version = options[:version] || Gem::Requirement.default

  spec_dirs = options[:specdirs].map do |i|
    [i, File.join(i, "specifications")]
  end.flatten

  path_kind = if spec_dirs.empty? then
                spec_dirs = Gem::Specification.dirs
                "default gem paths"
              else
                "specified path"
              end

  gem_names = if options[:all] then
                Gem::Specification.map(&:name)
              else
                get_all_gem_names
              end

  gem_names.each do |name|
    # HACK: find_by_name fails for some reason... ARGH
    # How many places must we embed our resolve logic?
    spec = Gem::Specification.find_all_by_name(name, version).last

    unless spec then
      say "Unable to find gem '#{name}' in #{path_kind}"

      if Gem.configuration.verbose then
        say "\nDirectories searched:"
        spec_dirs.each { |dir| say dir }
      end

      terminate_interaction 1 if gem_names.length == 1
    end

    gem_path = spec.full_gem_path
    extra    = "/{#{spec.require_paths.join ','}}" if options[:lib_only]
    glob     = "#{gem_path}#{extra}/**/*"
    files    = Dir[glob]

    gem_path = File.join gem_path, '' # add trailing / if missing

    files.sort.each do |file|
      next if File.directory? file

      file = file.sub gem_path, '' unless options[:prefix]

      say file
    end
  end
end

Commenting is here to help enhance the documentation. For example, code samples, or clarification of the documentation.

If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.

If you wish to post a correction of the docs, please do so, but also file bug report so that it can be corrected for the next release. Thank you.

If you want to help improve the Ruby documentation, please visit Documenting-ruby.org.

Home Classes Methods

In Files

Parent

Methods

Included Modules

Class/Module Index

Gem::Commands::ContentsCommand

Public Class Methods

Public Instance Methods