Class: Gem::Validator (Ruby 2.2.4)
Description: Class : Gem::Validator - Ruby 2.2.4

- Home
- Core 2.2.4
- Std-lib 2.2.4
- Downloads

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

### Home Classes Methods

### In Files

- rubygems/validator.rb

### Parent

Object

### Methods

- #alien
- #verify_gem
- #verify_gem_file

### Included Modules

- Gem::UserInteraction

### 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::Validator

Validator performs various gem file and gem database validation

### Public Instance Methods

alien(gems=[]) click to toggle source

Checks the gem directory for the following potential inconsistencies/problems:

- Checksum gem itself

- For each file in each gem, check consistency of installed versions

- Check for files that aren't part of the gem but are in the gems directory

- 1 cache - 1 spec - 1 directory.

returns a hash of ErrorData objects, keyed on the problem gem's name.

                   # File rubygems/validator.rb, line 84
    def alien(gems=[])
      errors = Hash.new { |h,k| h[k] = {} }

      Gem::Specification.each do |spec|
        next unless gems.include? spec.name unless gems.empty?
        next if spec.default_gem?

        gem_name      = spec.file_name
        gem_path      = spec.cache_file
        spec_path     = spec.spec_file
        gem_directory = spec.full_gem_path

        unless File.directory? gem_directory then
          errors[gem_name][spec.full_name] =
            "Gem registered but doesn't exist at #{gem_directory}"
          next
        end

        unless File.exist? spec_path then
          errors[gem_name][spec_path] = "Spec file missing for installed gem"
        end

        begin
          verify_gem_file(gem_path)

          good, gone, unreadable = nil, nil, nil, nil

          open gem_path, Gem.binary_mode do |file|
            package = Gem::Package.new gem_path

            good, gone = package.contents.partition { |file_name|
              File.exist? File.join(gem_directory, file_name)
            }

            gone.sort.each do |path|
              errors[gem_name][path] = "Missing file"
            end

            good, unreadable = good.partition { |file_name|
              File.readable? File.join(gem_directory, file_name)
            }

            unreadable.sort.each do |path|
              errors[gem_name][path] = "Unreadable file"
            end

            good.each do |entry, data|
              begin
                next unless data # HACK `gem check -a mkrf`

                source = File.join gem_directory, entry['path']

                open source, Gem.binary_mode do |f|
                  unless f.read == data then
                    errors[gem_name][entry['path']] = "Modified from original"
                  end
                end
              end
            end
          end

          installed_files = find_files_for_gem(gem_directory)
          extras = installed_files - good - unreadable

          extras.each do |extra|
            errors[gem_name][extra] = "Extra file"
          end
        rescue Gem::VerificationError => e
          errors[gem_name][gem_path] = e.message
        end
      end

      errors.each do |name, subhash|
        errors[name] = subhash.map do |path, msg|
          ErrorData.new path, msg
        end.sort
      end

      errors
    end

verify_gem(gem_data) click to toggle source

Given a gem file's contents, validates against its own MD5 checksum

gem_data
  String

    Contents of the gem file

                   # File rubygems/validator.rb, line 25
    def verify_gem(gem_data)
      # TODO remove me? The code here only validate an MD5SUM that was
      # in some old formatted gems, but hasn't been for a long time.
    end

verify_gem_file(gem_path) click to toggle source

Given the path to a gem file, validates against its own MD5 checksum

gem_path
  String

    Path to gem file

                   # File rubygems/validator.rb, line 35
    def verify_gem_file(gem_path)
      open gem_path, Gem.binary_mode do |file|
        gem_data = file.read
        verify_gem gem_data
      end
    rescue Errno::ENOENT, Errno::EINVAL
      raise Gem::VerificationError, "missing gem file #{gem_path}"
    end