Gem::Commands::ContentsCommand

Public Class Methods

new() click to toggle source

 
               # File rubygems/commands/contents_command.rb, line 9
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 48
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.sort.each { |dir| say dir }
      end

      terminate_interaction 1 if gem_names.length == 1
    end

    if spec.default_gem?
      files = spec.files.sort.map do |file|
        case file
        when /\A#{spec.bindir}\//
          [Gem::ConfigMap[:bindir], $POSTMATCH]
        when /\.so\z/
          [Gem::ConfigMap[:archdir], file]
        else
          [Gem::ConfigMap[:rubylibdir], file]
        end
      end
    else
      gem_path  = spec.full_gem_path
      extra     = "/{#{spec.require_paths.join ','}}" if options[:lib_only]
      glob      = "#{gem_path}#{extra}/**/*"
      prefix_re = /#{Regexp.escape(gem_path)}\//
      files     = Dir[glob].map do |file|
        [gem_path, file.sub(prefix_re, "")]
      end
    end

    files.sort.each do |prefix, basename|
      absolute_path = File.join(prefix, basename)
      next if File.directory? absolute_path

      if options[:prefix]
        say absolute_path
      else
        say basename
      end
    end
  end
end

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

If you are posting code samples in your comments, please wrap them in "<pre><code class="ruby" > ... </code></pre>" markup in order to get syntax highlighting.

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 a bug report so that it can be corrected for the next release. Thank you.

Home Classes Methods

In Files

Parent

Methods

Included Modules

Class/Module Index

Gem::Commands::ContentsCommand

Public Class Methods

Public Instance Methods