smc-get 0.2.0.beta1 → 0.3.0.beta1

data/lib/smc_get/package_archive.rb

@@ -1,80 +1,186 @@
-#Encoding: UTF-8
-################################################################################
-# This file is part of smc-get.
-# Copyright (C) 2010-2011 Entertaining Software, Inc.
-# Copyright (C) 2011 Marvin Gülker
-#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program. If not, see <http://www.gnu.org/licenses/>.
-################################################################################
-
-module SmcGet
-  
-  #This class allows for easy compression and decompression of .smcpak
-  #files. Please note that during this process no validations are performed,
-  #i.e. you have to ensure that the directory you want to compress is in
-  #smc package layout and the .smcpak files you want to decompress are
-  #really smc packages.
-  class PackageArchive
-    
-    #The location of this archive.
-    attr_reader :path
-    
-    #Compresses all files in +directory+ into a TAR.XZ file with the
-    #extension ".smcpak".
-    #Returns an object of this class.
-    #  smcpak = PackageArchive.compress("mypackage")
-    #  puts smcpak.path #=> mypackage.smcpak
-    def self.compress(directory, goal_file)
-      directory = Pathname.new(directory).expand_path
-      tar_file = Pathname.new("#{goal_file}.tar").expand_path
-      xz_file = Pathname.new(goal_file).expand_path
-      
-      Dir.chdir(directory.parent) do
-        tar_file.open("wb") do |file|
-          Archive::Tar::Minitar.pack(directory.relative_path_from(Pathname.new(".").expand_path).to_s, file)
-        end
-      end
-      XZ.compress_file(tar_file, xz_file)
-      
-      tar_file.delete #We don’t need it anymore
-      
-      new(xz_file)
-    end
-    
-    #Creates a new PackageArchive from an existing .smcpak file.
-    def initialize(archive)
-      @path = Pathname.new(archive)
-    end
-    
-    #Decompresses this archive into +directory+, creating a subdirectory
-    #named after the archive without the extension, and returns the path
-    #to that subdirectory (a Pathname object).
-    #  smcpak = PackageArchive.new("mypackage.smcpak")
-    #  puts smcpak.decompress #=> #<Pathname:mypackage>
-    def decompress(directory)
-      directory = Pathname.new(directory)
-      tar_file = directory + @path.basename.to_s.sub(/\.smcpak$/, ".tar")
-      dest_dir = directory + tar_file.basename.to_s.sub(/\.tar$/, "")
-      
-      XZ.decompress_file(@path.to_s, tar_file.to_s)
-      Archive::Tar::Minitar.unpack(tar_file.to_s, dest_dir.to_s)
-      
-      tar_file.delete #We don’ŧ need it anymore
-      
-      dest_dir
-    end
-    
-  end
-  
-end
+# -*- coding: utf-8 -*-
+################################################################################
+# This file is part of smc-get.
+# Copyright (C) 2010-2011 Entertaining Software, Inc.
+# Copyright (C) 2011 Marvin Gülker
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+################################################################################
+
+module SmcGet
+  
+  #This class allows for easy compression and decompression of .smcpak
+  #files. Please note that during this process no validations are performed,
+  #i.e. you have to ensure that the directory you want to compress is in
+  #smc package layout and the .smcpak files you want to decompress are
+  #really smc packages.
+  class PackageArchive
+
+    #Number of bytes to read from a file at a time when it’s being
+    #compressed.
+    CHUNK_SIZE = 4096
+    
+    #The location of this archive. A Pathname object.
+    attr_reader :path
+
+    class << self
+      
+      #Compresses all files in +directory+ into a TAR.XZ file with the
+      #extension ".smcpak".
+      #==Parameters
+      #[directory] The directory to compress. This will be the toplevel
+      #            directory in the resulting TAR file.
+      #[goal_file] Full path to where to place the TAR file.
+      #==Return value
+      #Returns an object of this class.
+      #==Examples
+      #  smcpak = PackageArchive.compress("/home/freak/packages/mypackage", "mypackage.smcpak")
+      #  puts smcpak.path #=> mypackage.smcpak
+      #  
+      #  smcpak = PackageArchive.compress("mypackage", "/home/freak/compressed_packages/mypackage.smcpak")
+      #  puts smcpak.path #=> /home/freak/compressed_packages/mypackage.smcpak
+      def compress(directory, goal_file)
+        directory = Pathname.new(directory).expand_path
+        tar_file = Pathname.new("#{goal_file}.tar").expand_path
+        xz_file = Pathname.new(goal_file).expand_path
+
+        tar_file.open("wb"){|file| compress_dir(directory, file)}
+        XZ.compress_file(tar_file, xz_file)
+        
+        tar_file.delete #We don’t need it anymore
+        
+        new(xz_file)
+      end
+
+      private
+
+      #This method creates a TAR archive inside the given +io+ by
+      #recursively packaging all files found in +path+ into it.
+      #
+      #Note that this method isn’t quite the same as <tt>Minitar.pack</tt>,
+      #because there is a big difference in how absolute paths are handled.
+      #Consider the following call:
+      #
+      #  Minitar.pack("/home/freak/foo", file)
+      #
+      #Inside the TAR you’ll get this:
+      #
+      #  /
+      #    home/
+      #      freak/
+      #        foo/
+      #          1.txt
+      #          2.rb
+      #
+      #Surely not what you wanted, plus a leading / that can be misinterpreted
+      #by some archiving programs (e.g. XFCE’s XArchiver). Now compare that
+      #to what this method does:
+      #
+      #  compress_dir("/home/freak/foo", file)
+      #
+      #Result in the TAR:
+      #
+      #  foo/
+      #    1.txt
+      #    2.txt
+      #
+      #It strippes off the unwanted prefix and just places the actual contents of
+      #the last element in +path+ (and it’s subdirectories) inside the TAR
+      #archive. For a +path+ relative to the current working directory however
+      #this method should behave the same as the usual <tt>Minitar.pack</tt>.
+      #
+      #Extra bonus: This method is threadsafe, as it doesn’t use +chdir+ to
+      #change the directory representation in the TAR file. It uses Minitar’s
+      #lowlevel methods instead.
+      def compress_dir(path, io)
+        raise(ArgumentError, "#{path} is not a directory!") unless path.directory?
+        
+        Archive::Tar::Minitar::Output.open(io) do |output|
+          tar = output.tar #Get the real Writer object
+          
+          path.find do |entry|
+            #This is the path as it will show up inside the tar
+            relative_path = entry.relative_path_from(path.parent) #parent b/c first entry must be the toplevel dirname, not "."
+            
+            #Copy permissions from the original file for the tar’ed file
+            stat = entry.stat
+            stats = {
+              :mode  => stat.mode,
+              :mtime => stat.mtime,
+              :size  => stat.size,
+              :uid   => stat.uid, #Should be nil on Windows
+              :gid   => stat.gid  #Should be nil on Windows
+            }
+            
+            if entry.directory?
+              tar.mkdir(relative_path.to_s, stats)
+            elsif entry.file?
+              tar.add_file_simple(relative_path.to_s, stats) do |stream|
+                File.open(entry, "rb") do |file|
+                  chunk = nil
+                  stream.write(chunk) while chunk = file.read(CHUNK_SIZE)
+                end
+              end
+            else
+              raise(Errors::CompressionError.new("Unsupported file type for #{entry}!", entry))
+            end #if
+          end #find
+        end #Output.new
+      end #compress_dir
+    
+    end
+    
+    #Creates a new PackageArchive from an existing .smcpak file.
+    #==Parameter
+    #[archive] The path to the file.
+    #==Return value
+    #A new instance of this class.
+    #==Example
+    #  archive = PackageArchive.new("/home/freak/compressed_packages/mypackage.smcpak")
+    def initialize(archive)
+      @path = Pathname.new(archive)
+    end
+
+    #Decompresses this archive, creating a subdirectory
+    #named after the archive without the extension.
+    #==Parameters
+    #[directory] Where to extract the archive to. Note a subdirectory
+    #            will be created below this path.
+    #==Return value
+    #The path to the subdirectory, a Pathname object.
+    #==Example
+    #  smcpak = PackageArchive.new("mypackage.smcpak")
+    #  puts smcpak.decompress #=> #<Pathname:mypackage>
+    def decompress(directory)
+      directory = Pathname.new(directory)
+      tar_file = directory + @path.basename.to_s.sub(/\.smcpak$/, ".tar")
+      dest_dir = directory + tar_file.basename.to_s.sub(/\.tar$/, "")
+      
+      XZ.decompress_file(@path.to_s, tar_file.to_s)
+      Archive::Tar::Minitar.unpack(tar_file.to_s, dest_dir.to_s)
+      
+      tar_file.delete #We don’t need it anymore
+      
+      dest_dir
+    end
+
+    #Human-readable description of form:
+    #  #<SmcGet::PackageArchive <path>>
+    def inspect
+      "#<#{self.class} #{@path.expand_path}>"
+    end
+    
+  end
+  
+end

data/lib/smc_get/package_specification.rb

@@ -1,253 +1,257 @@
-#Encoding: UTF-8
-################################################################################
-# This file is part of smc-get.
-# Copyright (C) 2010-2011 Entertaining Software, Inc.
-# Copyright (C) 2011 Marvin Gülker
-#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program. If not, see <http://www.gnu.org/licenses/>.
-################################################################################
-
-module SmcGet
-
-  #A PackageSpecification object is a mostly informational object
-  #directly related to Package objects. That is, each and every
-  #Package instance has a Package#spec method that will retrieve
-  #the PackageSpecification, an instance of this class, for you:
-  #
-  #  puts pkg.spec.title #=> Cool package
-  #
-  #Instances of this class can be understood as the parsed content of
-  #a package’s specification file. It has getter and setter methods
-  #reflecting the keys that are allowed in the specification (see
-  #the smcpak.rdoc file), but unless you want to build smc packages,
-  #there’s no need for you to use the setter methods.
-  class PackageSpecification
-    
-    #The keys listed here must be mentioned inside a package spec,
-    #otherwise the package is considered broken.
-    SPEC_MANDATORY_KEYS = [:title, :last_update, :authors, :difficulty, :description, :checksums].freeze
-    
-    ##
-    # :attr_accessor: title
-    #The package’s title.
-
-    ##
-    # :attr_accessor: last_update
-    #The time (an instance of class Time) indicating when the package
-    #was last updated.
-    
-    ##
-    # :attr_accessor: authors
-    #The authors of this package. An array.
-    
-    ##
-    # :attr_accessor: difficulty
-    #The difficulty of this package as a string.
-    
-    ##
-    # :attr_accessor: description
-    #The description of this package.
-    
-    ##
-    # :attr_accessor: install_message
-    #A message to display during installation of this package or nil if
-    #no message shall be displayed.
-    
-    ##
-    # :attr_accessor: remove_message
-    #A message to display during removing of this package or nil if no
-    #message shall be displayed.
-    
-    ##
-    # :attr_accessor: dependecies
-    #An array of package names this package depends on, i.e. packages that
-    #need to be installed before this one can be installed. The array is
-    #empty if no dependecies exist.
-    
-    ##
-    # :attr_accessor: levels
-    #An array of level file names (strings).
-    
-    ##
-    # :attr_accessor: music
-    #An array of music file names (strings).
-    
-    ##
-    # :attr_accessor: sounds
-    #An array of sound file names (strings).
-    
-    ##
-    # :attr_accessor: graphics
-    #An array of graphic file names (strings).
-    
-    ##
-    # :attr_accessor: worlds
-    #An array of graphic file names (strings).
-
-    ##
-    # :attr_accessor: checksums
-    #A hash that maps each filename in this package to it’s SHA1 checksum.
-    
-    #The name of the package this specification is used in, without any
-    #file extension.
-    attr_reader :name
-    
-    ##
-    # :attr_reader: compressed_file_name
-    #The name of the compressed file this specification should belong to.
-    #The same as name, but the extension .smcpak was appended.
-    
-    ##
-    # :attr_reader: spec_file_name
-    #The name of the specification file. The same as name, but
-    #the extension .yml was appended.
-
-    #Creates a PackageSpecification by directly reading a complete
-    #spec from a YAML file.
-    #==Parameter
-    #[path] The path to the file to read.
-    #==Return value
-    #An instance of this class.
-    #==Raises
-    #[InvalidSpecification] +path+ was not found or was malformatted.
-    #==Example
-    #  path = remote_repo.fetch_spec("cool_pkg.yml")
-    #  spec = SmcGet::PackageSpecification.from_file(path)
-    #  puts spec.title #=> "Cool package"
-    #==Remarks
-    #This method may be useful if you don’t need a full-blown
-    #Package object and just want to deal with it’s most important
-    #attributes.
-    def self.from_file(path)
-      info = nil
-      begin
-        info = YAML.load_file(path.to_s)
-      rescue Errno::ENOENT => e
-        raise(Errors::InvalidSpecification, "File '#{path}' doesn't exist!")
-      rescue => e
-        raise(Errors::InvalidSpecification, "Invalid YAML: #{e.message}")
-      end
-      
-      spec = new(File.basename(path).sub(/\.yml$/, ""))
-      info.each_pair do |key, value|
-        spec.send(:"#{key}=", value)
-      end
-      #TODO: Convert the strings in :checksums to strings, except the
-      #filenames, those should be strings. Anyone???
-      
-      raise(Errors::InvalidSpecification, spec.validate.first) unless spec.valid?
-      
-      spec
-    end
-    
-    #Returns the matching package name from the package specification’s name
-    #by replacing the .yml extension with .smcpak.
-    #==Return value
-    #A string ending in ".smcpak".
-    #==Example
-    #  p SmcGet::PackageSpecification.spec2pkg("cool_pkg.yml") #=> "cool_pkg.smcpak")
-    def self.spec2pkg(spec_file_name) # :nodoc:
-      spec_file_name.to_s.sub(/\.yml$/, ".smcpak")
-    end
-    
-    #Returns the matching specification file name from the package’s name
-    #by replacing the .smcpak extension with .yml.
-    #==Return value
-    #A string ending in ".yml"
-    #==Example
-    #  p SmcGet::PackageSpecification.pkg2spec("cool_pkg.smcpak") #=> "cool_pkg.yml"
-    def self.pkg2spec(package_file_name) # :nodoc:
-      package_file_name.to_s.sub(/\.smcpak$/, ".yml")
-    end
-    
-    def initialize(pkg_name)
-      @info = {:dependencies => [], :levels => [], :music => [], :sounds => [], :graphics => [], :worlds => []}
-      @name = pkg_name
-    end
-    
-    #See attribute.
-    def compressed_file_name # :nodoc:
-      "#@name.smcpak"
-    end
-    
-    #See attribute.
-    def spec_file_name # :nodoc:
-      "#@name.yml"
-    end
-    
-    [:title, :last_update, :authors, :difficulty, :description, :install_message, :remove_message, :dependencies, :levels, :music, :sounds, :graphics, :worlds, :checksums].each do |sym|
-      define_method(sym){@info[sym]}
-      define_method(:"#{sym}="){|val| @info[sym] = val}
-    end
-    
-    def [](sym)
-      if respond_to?(sym)
-        send(sym)
-      else
-        raise(IndexError, "No such specification key: #{sym}!")
-      end
-    end
-    
-    def valid?
-      validate.empty?
-    end
-    
-    def validate
-      errors = []
-      
-      SPEC_MANDATORY_KEYS.each do |sym|
-        errors << "Mandatory key #{sym} is missing!" unless @info.has_key?(sym)
-      end
-      
-      errors
-    end
-    
-    #Compares two specifications. They are considered equal if all their
-    #attributes (levels, difficulty, etc.) are equal.
-    def ==(other)
-      return false unless other.respond_to? :info
-      @info == other.info
-    end
-
-    #Saves the package specification in YAML format into a file.
-    #==Parameter
-    #[directory] The directory where to save the file to. The filename is automatically
-    #            detected from the attributes set for the specification.
-    #==Raises
-    #[InvalidSpecification] The specification was not valid, i.e. contained incorrect
-    #                       or missing values.
-    #==Example
-    #  p spec.name                  #=> "cool_pkg"
-    #  spec.save(".")
-    #  p File.file?("cool_pkg.yml") #=> true
-    def save(directory)
-      raise(Errors::InvalidSpecification, validate.first) unless valid?
-      
-      path = Pathname.new(directory) + "#{@name}.yml"
-      #Turn the spec keys for serialization into strings
-      hsh = {}
-      @info.each_pair{|k, v| hsh[k.to_s] = v}
-      path.open("w"){|f| YAML.dump(hsh, f)}
-    end
-    
-    protected
-
-    #Returns the complete internal information hash.
-    def info
-      @info
-    end
-    
-  end
-  
-end
+#Encoding: UTF-8
+################################################################################
+# This file is part of smc-get.
+# Copyright (C) 2010-2011 Entertaining Software, Inc.
+# Copyright (C) 2011 Marvin Gülker
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+################################################################################
+
+module SmcGet
+
+  #A PackageSpecification object is a mostly informational object
+  #directly related to Package objects. That is, each and every
+  #Package instance has a Package#spec method that will retrieve
+  #the PackageSpecification, an instance of this class, for you:
+  #
+  #  puts pkg.spec.title #=> Cool package
+  #
+  #Instances of this class can be understood as the parsed content of
+  #a package’s specification file. It has getter and setter methods
+  #reflecting the keys that are allowed in the specification (see
+  #the smcpak.rdoc file), but unless you want to build smc packages,
+  #there’s no need for you to use the setter methods.
+  class PackageSpecification
+    
+    #The keys listed here must be mentioned inside a package spec,
+    #otherwise the package is considered broken.
+    SPEC_MANDATORY_KEYS = [:title, :last_update, :authors, :difficulty, :description, :checksums].freeze
+    
+    ##
+    # :attr_accessor: title
+    #The package’s title.
+
+    ##
+    # :attr_accessor: last_update
+    #The time (an instance of class Time) indicating when the package
+    #was last updated.
+    
+    ##
+    # :attr_accessor: authors
+    #The authors of this package. An array.
+    
+    ##
+    # :attr_accessor: difficulty
+    #The difficulty of this package as a string.
+    
+    ##
+    # :attr_accessor: description
+    #The description of this package.
+    
+    ##
+    # :attr_accessor: install_message
+    #A message to display during installation of this package or nil if
+    #no message shall be displayed.
+    
+    ##
+    # :attr_accessor: remove_message
+    #A message to display during removing of this package or nil if no
+    #message shall be displayed.
+    
+    ##
+    # :attr_accessor: dependecies
+    #An array of package names this package depends on, i.e. packages that
+    #need to be installed before this one can be installed. The array is
+    #empty if no dependecies exist.
+    
+    ##
+    # :attr_accessor: levels
+    #An array of level file names (strings).
+    
+    ##
+    # :attr_accessor: music
+    #An array of music file names (strings).
+    
+    ##
+    # :attr_accessor: sounds
+    #An array of sound file names (strings).
+    
+    ##
+    # :attr_accessor: graphics
+    #An array of graphic file names (strings).
+    
+    ##
+    # :attr_accessor: worlds
+    #An array of graphic file names (strings).
+
+    ##
+    # :attr_accessor: checksums
+    #A hash that maps each filename in this package to it’s SHA1 checksum.
+    
+    #The name of the package this specification is used in, without any
+    #file extension.
+    attr_reader :name
+    
+    ##
+    # :attr_reader: compressed_file_name
+    #The name of the compressed file this specification should belong to.
+    #The same as name, but the extension .smcpak was appended.
+    
+    ##
+    # :attr_reader: spec_file_name
+    #The name of the specification file. The same as name, but
+    #the extension .yml was appended.
+
+    #Creates a PackageSpecification by directly reading a complete
+    #spec from a YAML file.
+    #==Parameter
+    #[path] The path to the file to read.
+    #==Return value
+    #An instance of this class.
+    #==Raises
+    #[InvalidSpecification] +path+ was not found or was malformatted.
+    #==Example
+    #  path = remote_repo.fetch_spec("cool_pkg.yml")
+    #  spec = SmcGet::PackageSpecification.from_file(path)
+    #  puts spec.title #=> "Cool package"
+    #==Remarks
+    #This method may be useful if you don’t need a full-blown
+    #Package object and just want to deal with it’s most important
+    #attributes.
+    def self.from_file(path)
+      info = nil
+      begin
+        info = YAML.load_file(path.to_s)
+      rescue Errno::ENOENT => e
+        raise(Errors::InvalidSpecification, "File '#{path}' doesn't exist!")
+      rescue => e
+        raise(Errors::InvalidSpecification, "Invalid YAML: #{e.message}")
+      end
+      
+      spec = new(File.basename(path).sub(/\.yml$/, ""))
+      info.each_pair do |key, value|
+        spec.send(:"#{key}=", value)
+      end
+      #TODO: Convert the strings in :checksums to strings, except the
+      #filenames, those should be strings. Anyone???
+      
+      raise(Errors::InvalidSpecification, spec.validate.first) unless spec.valid?
+      
+      spec
+    end
+    
+    #Returns the matching package name from the package specification’s name
+    #by replacing the .yml extension with .smcpak.
+    #==Return value
+    #A string ending in ".smcpak".
+    #==Example
+    #  p SmcGet::PackageSpecification.spec2pkg("cool_pkg.yml") #=> "cool_pkg.smcpak")
+    def self.spec2pkg(spec_file_name) # :nodoc:
+      spec_file_name.to_s.sub(/\.yml$/, ".smcpak")
+    end
+    
+    #Returns the matching specification file name from the package’s name
+    #by replacing the .smcpak extension with .yml.
+    #==Return value
+    #A string ending in ".yml"
+    #==Example
+    #  p SmcGet::PackageSpecification.pkg2spec("cool_pkg.smcpak") #=> "cool_pkg.yml"
+    def self.pkg2spec(package_file_name) # :nodoc:
+      package_file_name.to_s.sub(/\.smcpak$/, ".yml")
+    end
+    
+    def initialize(pkg_name)
+      @info = {:dependencies => [], :levels => [], :music => [], :sounds => [], :graphics => [], :worlds => []}
+      @name = pkg_name
+    end
+    
+    #See attribute.
+    def compressed_file_name # :nodoc:
+      "#@name.smcpak"
+    end
+    
+    #See attribute.
+    def spec_file_name # :nodoc:
+      "#@name.yml"
+    end
+    
+    [:title, :last_update, :authors, :difficulty, :description, :install_message, :remove_message, :dependencies, :levels, :music, :sounds, :graphics, :worlds, :checksums].each do |sym|
+      define_method(sym){@info[sym]}
+      define_method(:"#{sym}="){|val| @info[sym] = val}
+    end
+    
+    def [](sym)
+      if respond_to?(sym)
+        send(sym)
+      else
+        raise(IndexError, "No such specification key: #{sym}!")
+      end
+    end
+    
+    def valid?
+      validate.empty?
+    end
+    
+    def validate
+      errors = []
+      
+      SPEC_MANDATORY_KEYS.each do |sym|
+        errors << "Mandatory key #{sym} is missing!" unless @info.has_key?(sym)
+      end
+      
+      [:levels, :graphics, :music, :sounds, :worlds].each do |sym|
+        errors << "Mandatory checksum key #{sym} is missing!" unless @info[:checksums].has_key?(sym.to_s)
+      end
+
+      errors
+    end
+    
+    #Compares two specifications. They are considered equal if all their
+    #attributes (levels, difficulty, etc.) are equal.
+    def ==(other)
+      return false unless other.respond_to? :info
+      @info == other.info
+    end
+
+    #Saves the package specification in YAML format into a file.
+    #==Parameter
+    #[directory] The directory where to save the file to. The filename is automatically
+    #            detected from the attributes set for the specification.
+    #==Raises
+    #[InvalidSpecification] The specification was not valid, i.e. contained incorrect
+    #                       or missing values.
+    #==Example
+    #  p spec.name                  #=> "cool_pkg"
+    #  spec.save(".")
+    #  p File.file?("cool_pkg.yml") #=> true
+    def save(directory)
+      raise(Errors::InvalidSpecification, validate.first) unless valid?
+      
+      path = Pathname.new(directory) + "#{@name}.yml"
+      #Turn the spec keys for serialization into strings
+      hsh = {}
+      @info.each_pair{|k, v| hsh[k.to_s] = v}
+      path.open("w"){|f| YAML.dump(hsh, f)}
+    end
+    
+    protected
+
+    #Returns the complete internal information hash.
+    def info
+      @info
+    end
+    
+  end
+  
+end