Ruby 2.1.0 リファレンスマニュアル > ライブラリ一覧 > rakeライブラリ > RakeFileUtilsモジュール

module RakeFileUtils

クラスの継承リスト: RakeFileUtils < FileUtils
extend: RakeFileUtils

要約

カスタムバージョンの FileUtils のメソッドを提供します。

FileUtils で定義されているメソッドのうち、:verbose, :noop の二つの オプションのいずれかに反応するメソッドの動作を変更します。

このモジュールはトップレベルでインクルードされます。 その際、FileUtils, RakeFileUtils に定義されているメソッドの 可視性はプライベートに変更されます。

@see FileUtils

目次

特異メソッド
nowrite_flag nowrite_flag= verbose_flag verbose_flag=
インスタンスメソッド
nowrite verbose when_writing

特異メソッド

nowrite_flag -> bool[permalink][rdoc]

この値が真の場合、実際のファイル書き込みをともなう操作は行いません。 そうでない場合、ファイル書き込みを行います。

nowrite_flag=(flag)[permalink][rdoc]

実際に動作を行うかどうか設定します。

[PARAM] flag:
実際に動作を行うかどうかを指定します。真を指定すると動作を実行しません。
verbose_flag -> bool[permalink][rdoc]

この値が真の場合、詳細を表示します。

verbose_flag=(flag)[permalink][rdoc]

詳細を表示するかどうか設定します。

[PARAM] flag:
詳細を表示するかどうか指定します。真を指定すると詳細を表示します。

インスタンスメソッド

nowrite(value = nil) { ... }[permalink][rdoc]

ファイルを書き込むかどうかを制御します。

[PARAM] value:
真を指定するとファイルを書き込みません。

例:

nowrite              # 現在の状態を返します。
nowrite(v)           # 与えられた状態に変更します。
nowrite(v) { code }  # ブロックを評価する間だけ与えられた状態に変更します。
                     # ブロックの評価が終わると元の値に戻します。
verbose(value = nil) { ... }[permalink][rdoc]

詳細を出力するかどうかを制御します。

[PARAM] value:
真を指定すると詳細を出力します。

verbose              # 現在の状態を返します。
verbose(v)           # 与えられた状態に変更します。
verbose(v) { code }  # ブロックを評価する間だけ与えられた状態に変更します。
                     # ブロックの評価が終わると元の値に戻します。
when_writing(msg = nil) { ... }[permalink][rdoc]

RakeFileUtils.nowrite_flag が真である場合与えられたブロックを実行せずに、 与えられたメッセージを表示します。

そうでない場合は、与えられたブロックを実行します。

[PARAM] msg:
表示するメッセージを指定します。

例:

when_writing("Building Project") do
  project.build
end