class Rake::PackageTask

Create a packaging task that will package the project into distributable files (e.g zip archive or tar files).

The PackageTask will create the following targets:

:package

Create all the requested package files.

:clobber_package

Delete all the package files. This target is automatically added to the main clobber target.

:repackage

Rebuild the package files from scratch, even if they are not out of date.

package_dir/name-version.tgz”

Create a gzipped tar package (if need_tar is true).

package_dir/name-version.tar.gz”

Create a gzipped tar package (if need_tar_gz is true).

package_dir/name-version.tar.bz2”

Create a bzip2'd tar package (if need_tar_bz2 is true).

package_dir/name-version.zip”

Create a zip package archive (if need_zip is true).

Example:

Rake::PackageTask.new("rake", "1.2.3") do |p|
  p.need_tar = true
  p.package_files.include("lib   /*.rb")
end

Attributes

name[RW]

Name of the package (from the GEM Spec).

need_tar[RW]

True if a gzipped tar file (tgz) should be produced (default is false).

need_tar_bz2[RW]

True if a bzip2'd tar file (tar.bz2) should be produced (default is false).

need_tar_gz[RW]

True if a gzipped tar file (tar.gz) should be produced (default is false).

need_zip[RW]

True if a zip file should be produced (default is false)

package_dir[RW]

Directory used to store the package files (default is 'pkg').

package_files[RW]

List of files to be included in the package.

tar_command[RW]

Tar command for gzipped or bzip2ed archives. The default is 'tar'.

version[RW]

Version of the package (e.g. '1.3.2').

zip_command[RW]

Zip command for zipped archives. The default is 'zip'.

Public Class Methods

new(name=nil, version=nil) { |self| ... } click to toggle source

Create a Package Task with the given name and version. Use :noversion as the version to build a package without a version or to provide a fully-versioned package name.

   # File lib/rake/packagetask.rb
79 def initialize(name=nil, version=nil)
80   init(name, version)
81   yield self if block_given?
82   define unless name.nil?
83 end

Public Instance Methods

define() click to toggle source

Create the tasks defined by this task library.

    # File lib/rake/packagetask.rb
100 def define
101   fail "Version required (or :noversion)" if @version.nil?
102   @version = nil if :noversion == @version
103 
104   desc "Build all the packages"
105   task :package
106 
107   desc "Force a rebuild of the package files"
108   task :repackage => [:clobber_package, :package]
109 
110   desc "Remove package products"
111   task :clobber_package do
112     rm_r package_dir rescue nil
113   end
114 
115   task :clobber => [:clobber_package]
116 
117   [
118     [need_tar, tgz_file, "z"],
119     [need_tar_gz, tar_gz_file, "z"],
120     [need_tar_bz2, tar_bz2_file, "j"]
121   ].each do |(need, file, flag)|
122     if need
123       task :package => ["#{package_dir}/#{file}"]
124       file "#{package_dir}/#{file}" => [package_dir_path] + package_files do
125         chdir(package_dir) do
126           sh %{#{@tar_command} #{flag}cvf #{file} #{package_name}}
127         end
128       end
129     end
130   end
131 
132   if need_zip
133     task :package => ["#{package_dir}/#{zip_file}"]
134     file "#{package_dir}/#{zip_file}" => [package_dir_path] + package_files do
135       chdir(package_dir) do
136         sh %{#{@zip_command} -r #{zip_file} #{package_name}}
137       end
138     end
139   end
140 
141   directory package_dir
142 
143   file package_dir_path => @package_files do
144     mkdir_p package_dir rescue nil
145     @package_files.each do |fn|
146       f = File.join(package_dir_path, fn)
147       fdir = File.dirname(f)
148       mkdir_p(fdir) if !File.exist?(fdir)
149       if File.directory?(fn)
150         mkdir_p(f)
151       else
152         rm_f f
153         safe_ln(fn, f)
154       end
155     end
156   end
157   self
158 end
init(name, version) click to toggle source

Initialization that bypasses the “yield self” and “define” step.

   # File lib/rake/packagetask.rb
86 def init(name, version)
87   @name = name
88   @version = version
89   @package_files = Rake::FileList.new
90   @package_dir = 'pkg'
91   @need_tar = false
92   @need_tar_gz = false
93   @need_tar_bz2 = false
94   @need_zip = false
95   @tar_command = 'tar'
96   @zip_command = 'zip'
97 end
package_dir_path() click to toggle source
    # File lib/rake/packagetask.rb
164 def package_dir_path
165   "#{package_dir}/#{package_name}"
166 end
package_name() click to toggle source
    # File lib/rake/packagetask.rb
160 def package_name
161   @version ? "#{@name}-#{@version}" : @name
162 end
tar_bz2_file() click to toggle source
    # File lib/rake/packagetask.rb
176 def tar_bz2_file
177   "#{package_name}.tar.bz2"
178 end
tar_gz_file() click to toggle source
    # File lib/rake/packagetask.rb
172 def tar_gz_file
173   "#{package_name}.tar.gz"
174 end
tgz_file() click to toggle source
    # File lib/rake/packagetask.rb
168 def tgz_file
169   "#{package_name}.tgz"
170 end
zip_file() click to toggle source
    # File lib/rake/packagetask.rb
180 def zip_file
181   "#{package_name}.zip"
182 end