module RakeFileUtils

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][edit]

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

# Rakefile での記載例とする
task default: :sample_file_task

file :sample_file_task do |t|
  RakeFileUtils.nowrite_flag # => false
end

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

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

[PARAM] flag:

実際に動作を行うかどうかを指定します。真を指定すると動作を実行しません。

# Rakefile での記載例とする

task default: :sample_file_task

file :sample_file_task do |t|
  RakeFileUtils.nowrite_flag # => false
  RakeFileUtils.nowrite_flag = true
  RakeFileUtils.nowrite_flag # => true
end

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

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

# Rakefile での記載例とする

task default: :sample_file_task

file :sample_file_task do |t|
  # --verbose で rake を実行する
  RakeFileUtils.verbose_flag # => true
end

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

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

[PARAM] flag:

詳細を表示するかどうか指定します。真を指定すると詳細を表示します。

# Rakefile での記載例とする

task default: :sample_file_task

file :sample_file_task do |t|
  # --verbose で rake を実行する
  p RakeFileUtils.verbose_flag # => true
  RakeFileUtils.verbose_flag = false
  p RakeFileUtils.verbose_flag # => false
end

インスタンスメソッド

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

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

[PARAM] value:

真を指定するとファイルを書き込みません。

例:

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

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

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

[PARAM] value:

真を指定すると詳細を出力します。

例

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

when_writing(msg = nil) { ... }[permalink][rdoc][edit]

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

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

[PARAM] msg:

表示するメッセージを指定します。

例:

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