Class: Gem::Validator
Relationships & Source Files | |
Namespace Children | |
Classes:
| |
Super Chains via Extension / Inclusion / Inheritance | |
Instance Chain:
|
|
Inherits: | Object |
Defined in: | lib/rubygems/validator.rb |
Overview
Validator
performs various gem file and gem database validation
Instance Attribute Summary
DefaultUserInteraction - Included
Instance Method Summary
-
#alien(gems = [])
Checks the gem directory for the following potential inconsistencies/problems:
-
#verify_gem(gem_data)
- Given a gem file's contents, validates against its own MD5 checksum gem_data
- String
Contents of the gem file.
-
#verify_gem_file(gem_path)
Given the path to a gem file, validates against its own MD5 checksum.
- #find_files_for_gem(gem_directory) private
UserInteraction - Included
#alert | Displays an alert |
#alert_error | Displays an error |
#alert_warning | Displays a warning |
#ask | Asks a |
#ask_for_password | Asks for a password with a |
#ask_yes_no | Asks a yes or no |
#choose_from_list | Asks the user to answer |
#say | Displays the given |
#terminate_interaction | Terminates the RubyGems process with the given |
#verbose | Calls |
DefaultUserInteraction - Included
Instance Method Details
#alien(gems = [])
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 Validator::ErrorData objects, keyed on the problem gem's name.
# File 'lib/rubygems/validator.rb', line 85
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. end end errors.each do |name, subhash| errors[name] = subhash.map do |path, msg| ErrorData.new path, msg end.sort end errors end
#find_files_for_gem(gem_directory) (private)
[ GitHub ]# File 'lib/rubygems/validator.rb', line 47
def find_files_for_gem(gem_directory) installed_files = [] Find.find gem_directory do |file_name| fn = file_name[gem_directory.size..file_name.size-1].sub(/^\//, "") installed_files << fn unless fn =~ /CVS/ || fn.empty? || File.directory?(file_name) end installed_files end
#verify_gem(gem_data)
Given a gem file's contents, validates against its own MD5 checksum
- gem_data
- String
-
Contents of the gem file
# File 'lib/rubygems/validator.rb', line 26
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)
Given the path to a gem file, validates against its own MD5 checksum
- gem_path
- String
-
Path to gem file
# File 'lib/rubygems/validator.rb', line 36
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