class Rake::PackageTask (Ruby 3.3 リファレンスマニュアル)

要約

配布するパッケージ (zip, tar, etc...) を作成するためのタスクを定義するクラスです。

継承しているメソッド

Rake::Cloneableから継承しているメソッド

clone
dup

特異メソッド

new(name = nil, version = nil) {|t| ... } -> Rake::PackageTask[permalink][rdoc][edit]

自身を初期化してタスクを定義します。

ブロックが与えられた場合は、自身をブロックパラメータとしてブロックを評価します。

[PARAM] name:: パッケージ名を指定します。
[PARAM] version:: パッケージのバージョンを指定します。 ':noversion' というシンボルを指定するとバージョン情報をセットしません。


# Rakefile での記載例とする
require 'rake/packagetask'

Rake::PackageTask.new("sample", "1.0.0") do |package_task|
  package_task.package_dir = "./pkg"
  package_task.package_files.include("lib/**/*")
end

# rake -T を実行すると以下になる
# => rake clobber_package  # Remove package products
#    rake package          # Build all the packages
#    rake repackage        # Force a rebuild of the package files

インスタンスメソッド

define -> self[permalink][rdoc][edit]

タスクを定義します。

[EXCEPTION] RuntimeError:: バージョン情報をセットしていない場合に発生します。初期化時に :noversion が指定されている場合は発生しません。

init(name, version)[permalink][rdoc][edit]

自身の各属性にデフォルト値をセットします。

[PARAM] name:: パッケージの名前を指定します。
[PARAM] version:: パッケージのバージョンを指定します。

name -> String[permalink][rdoc][edit]

バージョン情報を含まないパッケージの名前を返します。


# Rakefile での記載例とする
require 'rake/packagetask'

Rake::PackageTask.new("sample", "1.0.0") do |package_task|
  package_task.name # => "sample"
end

name=(name)[permalink][rdoc][edit]

バージョン情報を含まないパッケージの名前をセットします。

[PARAM] name:: パッケージの名前を指定します。


# Rakefile での記載例とする
require 'rake/packagetask'

Rake::PackageTask.new("sample", "1.0.0") do |package_task|
  package_task.name # => "sample"
  package_task.name = "update"
  package_task.name # => "update"
end

need_tar -> bool[permalink][rdoc][edit]

この値が真である場合は gzip した tar ファイル (tgz) を作成します。デフォルトは偽です。


# Rakefile での記載例とする
require 'rake/packagetask'

Rake::PackageTask.new("sample", "1.0.0") do |package_task|
  package_task.need_tar # => false
end

need_tar=(flag)[permalink][rdoc][edit]

gzip した tar ファイル (tgz) を作成するかどうかを設定します。

[PARAM] flag:: 真または偽を指定します。


# Rakefile での記載例とする
require 'rake/packagetask'

Rake::PackageTask.new("sample", "1.0.0") do |package_task|
  package_task.need_tar # => false
  package_task.need_tar = true
  package_task.need_tar # => true
end

need_tar_bz2 -> bool[permalink][rdoc][edit]

この値が真である場合は bzip2 した tar ファイル (tar.bz2) を作成します。デフォルトは偽です。


# Rakefile での記載例とする
require 'rake/packagetask'

Rake::PackageTask.new("sample", "1.0.0") do |package_task|
  package_task.need_tar_bz2 # => false
end

need_tar_bz2=(flag)[permalink][rdoc][edit]

bzip2 した tar ファイル (tar.bz2) を作成するかどうかを設定します。

[PARAM] flag:: 真または偽を指定します。


# Rakefile での記載例とする
require 'rake/packagetask'

Rake::PackageTask.new("sample", "1.0.0") do |package_task|
  package_task.need_tar_bz2 # => false
  package_task.need_tar_bz2 = true
  package_task.need_tar_bz2 # => true
end

need_tar_gz -> bool[permalink][rdoc][edit]

この値が真である場合は gzip した tar ファイル (tar.gz) を作成します。デフォルトは偽です。


# Rakefile での記載例とする
require 'rake/packagetask'

Rake::PackageTask.new("sample", "1.0.0") do |package_task|
  package_task.need_tar_gz # => false
end

need_tar_gz=(flag)[permalink][rdoc][edit]

gzip した tar ファイル (tar.gz) を作成するかどうかを設定します。

[PARAM] flag:: 真または偽を指定します。


# Rakefile での記載例とする
require 'rake/packagetask'

Rake::PackageTask.new("sample", "1.0.0") do |package_task|
  package_task.need_tar_gz # => false
  package_task.need_tar_gz = true
  package_task.need_tar_gz # => true
end

need_zip -> bool[permalink][rdoc][edit]

この値が真である場合は zip ファイルを作成します。デフォルトは偽です。


# Rakefile での記載例とする
require 'rake/packagetask'

Rake::PackageTask.new("sample", "1.0.0") do |package_task|
  package_task.need_zip # => false
end

need_zip=(flag)[permalink][rdoc][edit]

zip ファイル (tgz) を作成するかどうかを設定します。

[PARAM] flag:: 真または偽を指定します。


# Rakefile での記載例とする
require 'rake/packagetask'

Rake::PackageTask.new("sample", "1.0.0") do |package_task|
  package_task.need_zip # => false
  package_task.need_zip = true
  package_task.need_zip # => true
end

package_dir -> String[permalink][rdoc][edit]

パッケージに入れるファイルを保存するディレクトリ名を返します。


# Rakefile での記載例とする
require 'rake/packagetask'

Rake::PackageTask.new("sample", "1.0.0") do |package_task|
  package_task.package_dir # => "pkg"
end

package_dir=(dirname)[permalink][rdoc][edit]

パッケージに入れるファイルを保存するディレクトリ名をセットします。

[PARAM] dirname:: パッケージに入れるファイルを保存するディレクトリ名を指定します。


# Rakefile での記載例とする
require 'rake/packagetask'

Rake::PackageTask.new("sample", "1.0.0") do |package_task|
  package_task.package_dir # => "pkg"
  package_task.package_dir = "package"
  package_task.package_dir # => "package"
end

package_dir_path -> String[permalink][rdoc][edit]

パッケージに含むファイルを配置するディレクトリを返します。


# Rakefile での記載例とする
require 'rake/packagetask'

Rake::PackageTask.new("sample", "1.0.0") do |package_task|
  package_task.package_dir_path # => "pkg/sample-1.0.0"
end

package_files -> Rake::FileList[permalink][rdoc][edit]

パッケージに含むファイルリストを返します。


# Rakefile での記載例とする
require 'rake/packagetask'

IO.write("test1.rb", "test")
IO.write("test2.rb", "test")

Rake::PackageTask.new("sample", "1.0.0") do |package_task|
  package_task.package_files # => []
  package_task.package_files.include("*.rb")
  package_task.package_files # => ["test1.rb", "test2.rb"]
end

package_files=(file_list)[permalink][rdoc][edit]

パッケージに含むファイルリストを設定します。

[PARAM] file_list:: ファイルリストを指定します。


# Rakefile での記載例とする
require 'rake/packagetask'

IO.write("test1.rb", "test")
IO.write("test2.rb", "test")

Rake::PackageTask.new("sample", "1.0.0") do |package_task|
  package_task.package_files # => []
  package_task.package_files = FileList.new("test1.rb", "test2.rb")
  package_task.package_files # => ["test1.rb", "test2.rb"]
end

package_name -> String[permalink][rdoc][edit]

バージョン情報を含むパッケージ名を返します。

tar_bz2_file -> String[permalink][rdoc][edit]

tar.bz2 用のファイル名を返します。

tar_command -> String[permalink][rdoc][edit]

tar コマンドとして使用するコマンドを返します。

デフォルトは 'tar' です。

tar_command=(command)[permalink][rdoc][edit]

tar コマンドとして使用するコマンドを設定します。

[PARAM] command:: コマンドを文字列で指定します。

tar_gz_file -> String[permalink][rdoc][edit]

tar.gz 用のファイル名を返します。

tgz_file -> String[permalink][rdoc][edit]

tgz 用のファイル名を返します。

version -> String[permalink][rdoc][edit]

作成するパッケージのバージョンを表す文字列を返します。

version=(str)[permalink][rdoc][edit]

作成するパッケージのバージョンをセットします。

[PARAM] str:: バージョンを表す文字列を指定します。

zip_command -> String[permalink][rdoc][edit]

zip コマンドとして使用するコマンドを返します。

デフォルトは 'zip' です。

zip_command=(command)[permalink][rdoc][edit]

zip コマンドとして使用するコマンドを設定します。

[PARAM] command:: コマンドを文字列で指定します。

zip_file -> String[permalink][rdoc][edit]

zip ファイル用のファイル名を返します。

要約

目次

継承しているメソッド

特異メソッド

インスタンスメソッド