Gem::Validator

Validator performs various gem file and gem database validation

Constants

ErrorData

Public Class Methods

new() click to toggle source

 
               # File rubygems/validator.rb, line 17
def initialize
  require 'find'
end

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 81
def alien(gems=[])
  errors = Hash.new { |h,k| h[k] = {} }

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

    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

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 see Improve the docs, or visit Documenting-ruby.org.

Home Classes Methods

In Files

Parent

Methods

Included Modules

Class/Module Index

Gem::Validator

Constants

Public Class Methods

Public Instance Methods