Contents

#--
# Copyright 2006 by Chad Fowler, Rich Kilmer, Jim Weirich and others.
# All rights reserved.
# See LICENSE.txt for permissions.
#++

require 'rubygems/package'

module Gem

  ##
  # The format class knows the guts of the RubyGem .gem file format
  # and provides the capability to read gem files
  #
  class Format
    attr_accessor :spec, :file_entries, :gem_path
    extend Gem::UserInteraction
  
    ##
    # Constructs an instance of a Format object, representing the gem's
    # data structure.
    #
    # gem:: [String] The file name of the gem
    #
    def initialize(gem_path)
      @gem_path = gem_path
    end
    
    ##
    # Reads the named gem file and returns a Format object, representing 
    # the data from the gem file
    #
    # file_path:: [String] Path to the gem file
    #
    def self.from_file_by_path(file_path, security_policy = nil)
      unless File.exist?(file_path)
        raise Gem::Exception, "Cannot load gem at [#{file_path}]"
      end
      require 'fileutils'
      # check for old version gem
      if File.read(file_path, 20).include?("MD5SUM =")
        #alert_warning "Gem #{file_path} is in old format."
        require 'rubygems/old_format'
        return OldFormat.from_file_by_path(file_path)
      else
        f = File.open(file_path, 'rb')
        return from_io(f, file_path, security_policy)
      end
    end

    ##
    # Reads a gem from an io stream and returns a Format object, representing
    # the data from the gem file
    #
    # io:: [IO] Stream from which to read the gem
    #
    def self.from_io(io, gem_path="(io)", security_policy = nil)
      format = self.new(gem_path)
      Package.open_from_io(io, 'r', security_policy) do |pkg|
        format.spec = pkg.metadata
        format.file_entries = []
        pkg.each do |entry|
          format.file_entries << [{"size", entry.size, "mode", entry.mode,
              "path", entry.full_name}, entry.read]
        end
      end
      format
    end

  end
end

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
rubygems-update-0.9.2	lib/rubygems/format.rb
rubygems-update-0.9.1	lib/rubygems/format.rb
rubygems-update-0.9.0	lib/rubygems/format.rb