Class: Gem::Commands::ContentsCommand (Ruby 2.2.3)
Description: Class : Gem::Commands::ContentsCommand - Ruby 2.2.3

- Home
- Core 2.2.3
- Std-lib 2.2.3
- Downloads

Support for the Ruby 2.2 series has ended. See here for reference.

### Home Classes Methods

### In Files

- rubygems/commands/contents_command.rb

### Parent

Gem::Command

### Methods

- ::new
- #execute
- #files_in
- #files_in_default_gem
- #files_in_gem
- #gem_contents
- #gem_install_dir
- #show_files
- #spec_for

### Included Modules

- Gem::VersionOption

### Class/Module Index

Quicksearch

- Gem::AvailableSet
- Gem::BasicSpecification
- Gem::Command
- Gem::CommandLineError
- Gem::CommandManager
- Gem::Commands
- Gem::Commands::BuildCommand
- Gem::Commands::CertCommand
- Gem::Commands::CheckCommand
- Gem::Commands::CleanupCommand
- Gem::Commands::ContentsCommand
- Gem::Commands::DependencyCommand
- Gem::Commands::EnvironmentCommand
- Gem::Commands::FetchCommand
- Gem::Commands::GenerateIndexCommand
- Gem::Commands::HelpCommand
- Gem::Commands::InstallCommand
- Gem::Commands::ListCommand
- Gem::Commands::LockCommand
- Gem::Commands::MirrorCommand
- Gem::Commands::OpenCommand
- Gem::Commands::OutdatedCommand
- Gem::Commands::OwnerCommand
- Gem::Commands::PristineCommand
- Gem::Commands::PushCommand
- Gem::Commands::QueryCommand
- Gem::Commands::RdocCommand
- Gem::Commands::SearchCommand
- Gem::Commands::ServerCommand
- Gem::Commands::SetupCommand
- Gem::Commands::SourcesCommand
- Gem::Commands::SpecificationCommand
- Gem::Commands::StaleCommand
- Gem::Commands::UninstallCommand
- Gem::Commands::UnpackCommand
- Gem::Commands::UpdateCommand
- Gem::Commands::WhichCommand
- Gem::Commands::YankCommand
- Gem::ConfigFile
- Gem::ConfigFile::Psych
- Gem::ConflictError
- Gem::ConsoleUI
- Gem::DefaultUserInteraction
- Gem::Dependency
- Gem::DependencyError
- Gem::DependencyInstaller
- Gem::DependencyList
- Gem::DependencyRemovalException
- Gem::DependencyResolutionError
- Gem::Deprecate
- Gem::Doctor
- Gem::DocumentError
- Gem::EndOfYAMLException
- Gem::ErrorReason
- Gem::Exception
- Gem::Ext
- Gem::Ext::BuildError
- Gem::Ext::Builder
- Gem::Ext::CmakeBuilder
- Gem::Ext::ConfigureBuilder
- Gem::Ext::ExtConfBuilder
- Gem::Ext::RakeBuilder
- Gem::FakeFetcher
- Gem::FilePermissionError
- Gem::FormatException
- Gem::GemNotFoundException
- Gem::GemNotInHomeException
- Gem::GemRunner
- Gem::GemcutterUtilities
- Gem::ImpossibleDependenciesError
- Gem::Indexer
- Gem::InstallError
- Gem::InstallUpdateOptions
- Gem::Installer
- Gem::InstallerTestCase
- Gem::InvalidSpecificationException
- Gem::List
- Gem::LoadError
- Gem::LocalRemoteOptions
- Gem::MockGemUi
- Gem::MockGemUi::InputEOFError
- Gem::MockGemUi::SystemExitException
- Gem::MockGemUi::TTY
- Gem::MockGemUi::TermError
- Gem::NameTuple
- Gem::NoAliasYAMLTree
- Gem::OperationNotSupportedError
- Gem::Package::DigestIO
- Gem::Package::Error
- Gem::Package::FormatError
- Gem::Package::NonSeekableIO
- Gem::Package::Old
- Gem::Package::PathError
- Gem::Package::TarHeader
- Gem::Package::TarInvalidError
- Gem::Package::TarReader
- Gem::Package::TarReader::Entry
- Gem::Package::TarReader::UnexpectedEOF
- Gem::Package::TarTestCase
- Gem::Package::TarWriter
- Gem::Package::TarWriter::BoundedStream
- Gem::Package::TarWriter::FileOverflow
- Gem::Package::TarWriter::RestrictedStream
- Gem::Package::TooLongFileName
- Gem::PackageTask
- Gem::PathSupport
- Gem::Platform
- Gem::PlatformMismatch
- Gem::RemoteError
- Gem::RemoteFetcher
- Gem::RemoteFetcher::FetchError
- Gem::RemoteFetcher::UnknownHostError
- Gem::RemoteInstallationCancelled
- Gem::RemoteInstallationSkipped
- Gem::RemoteSourceException
- Gem::Request::ConnectionPools
- Gem::Request::ConnectionPools::Net
- Gem::RequestSet
- Gem::RequestSet::GemDependencyAPI
- Gem::RequestSet::Lockfile
- Gem::RequestSet::Lockfile::ParseError
- Gem::Requirement
- Gem::Requirement::BadRequirementError
- Gem::Resolver
- Gem::Resolver::APISet
- Gem::Resolver::APISpecification
- Gem::Resolver::ActivationRequest
- Gem::Resolver::BestSet
- Gem::Resolver::ComposedSet
- Gem::Resolver::Conflict
- Gem::Resolver::CurrentSet
- Gem::Resolver::DependencyRequest
- Gem::Resolver::GitSet
- Gem::Resolver::GitSpecification
- Gem::Resolver::IndexSet
- Gem::Resolver::IndexSpecification
- Gem::Resolver::InstalledSpecification
- Gem::Resolver::InstallerSet
- Gem::Resolver::LocalSpecification
- Gem::Resolver::LockSet
- Gem::Resolver::LockSpecification
- Gem::Resolver::RequirementList
- Gem::Resolver::Set
- Gem::Resolver::SpecSpecification
- Gem::Resolver::Specification
- Gem::Resolver::Stats
- Gem::Resolver::VendorSet
- Gem::Resolver::VendorSpecification
- Gem::RubyVersionMismatch
- Gem::Security
- Gem::Security::Exception
- Gem::Security::Policy
- Gem::Security::Signer
- Gem::Security::TrustDir
- Gem::Server
- Gem::SilentUI
- Gem::Source
- Gem::Source::Git
- Gem::Source::Installed
- Gem::Source::Local
- Gem::Source::Lock
- Gem::Source::SpecificFile
- Gem::Source::Vendor
- Gem::SourceFetchProblem
- Gem::SourceList
- Gem::SpecFetcher
- Gem::SpecificGemNotFoundException
- Gem::Specification
- Gem::StreamUI
- Gem::StreamUI::SilentDownloadReporter
- Gem::StreamUI::SilentProgressReporter
- Gem::StreamUI::SimpleProgressReporter
- Gem::StreamUI::VerboseDownloadReporter
- Gem::StreamUI::VerboseProgressReporter
- Gem::StringSink
- Gem::StringSource
- Gem::StubSpecification
- Gem::SystemExitException
- Gem::TestCase
- Gem::TestCase::SpecFetcherSetup
- Gem::TestCase::StaticSet
- Gem::Text
- Gem::Uninstaller
- Gem::UnsatisfiableDependencyError
- Gem::UriFormatter
- Gem::UserInteraction
- Gem::Util
- Gem::Validator
- Gem::VerificationError
- Gem::Version
- Gem::VersionOption
- Kernel
- Object
- OpenSSL
- TempIO
- YAML::Syck
- YAML::Syck

No matching classes.

# 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,
            :show_install_dir => false

      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

      add_option(      '--[no-]show-install-dir',
                 'Show only the gem install dir') do |show, options|
        options[:show_install_dir] = show
      end

      @path_kind = nil
      @spec_dirs = nil
      @version   = nil
    end

### Public Instance Methods

execute() click to toggle source

                   # File rubygems/commands/contents_command.rb, line 66
    def execute
      @version   = options[:version] || Gem::Requirement.default
      @spec_dirs = specification_directories
      @path_kind = path_description @spec_dirs

      names = gem_names

      names.each do |name|
        found =
          if options[:show_install_dir] then
            gem_install_dir name
          else
            gem_contents name
          end

        terminate_interaction 1 unless found or names.length > 1
      end
    end

files_in(spec) click to toggle source

                   # File rubygems/commands/contents_command.rb, line 85
    def files_in spec
      if spec.default_gem? then
        files_in_default_gem spec
      else
        files_in_gem spec
      end
    end

files_in_default_gem(spec) click to toggle source

                   # File rubygems/commands/contents_command.rb, line 104
    def files_in_default_gem spec
      spec.files.map do |file|
        case file
        when /\A#{spec.bindir}\//
          [RbConfig::CONFIG['bindir'], $POSTMATCH]
        when /\.so\z/
          [RbConfig::CONFIG['archdir'], file]
        else
          [RbConfig::CONFIG['rubylibdir'], file]
        end
      end
    end

files_in_gem(spec) click to toggle source

                   # File rubygems/commands/contents_command.rb, line 93
    def files_in_gem spec
      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)}\//

      Dir[glob].map do |file|
        [gem_path, file.sub(prefix_re, "")]
      end
    end

gem_contents(name) click to toggle source

                   # File rubygems/commands/contents_command.rb, line 117
    def gem_contents name
      spec = spec_for name

      return false unless spec

      files = files_in spec

      show_files files

      true
    end

gem_install_dir(name) click to toggle source

                   # File rubygems/commands/contents_command.rb, line 129
    def gem_install_dir name
      spec = spec_for name

      return false unless spec

      say spec.gem_dir

      true
    end

show_files(files) click to toggle source

                   # File rubygems/commands/contents_command.rb, line 155
    def show_files files
      files.sort.each do |prefix, basename|
        absolute_path = File.join(prefix, basename)
        next if File.directory? absolute_path

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

spec_for(name) click to toggle source

                   # File rubygems/commands/contents_command.rb, line 168
    def spec_for name
      spec = Gem::Specification.find_all_by_name(name, @version).last

      return spec if spec

      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

      return nil
    end