RakeFileUtils

Get/set the nowrite flag controlling output from the FileUtils utilities. If verbose is true, then the utility method is echoed to standard output.

Examples:

nowrite              # return the current value of the nowrite flag
nowrite(v)           # set the nowrite flag to _v_.
nowrite(v) { code }  # Execute code with the nowrite flag set temporarily to _v_.
                     # Return to the original value when code is done.

# File lib/rake.rb, line 1128
def nowrite(value=nil)
  oldvalue = RakeFileUtils.nowrite_flag
  RakeFileUtils.nowrite_flag = value unless value.nil?
  if block_given?
    begin
      yield
    ensure
      RakeFileUtils.nowrite_flag = oldvalue
    end
  end
  oldvalue
end

Get/set the verbose flag controlling output from the FileUtils utilities. If verbose is true, then the utility method is echoed to standard output.

Examples:

verbose              # return the current value of the verbose flag
verbose(v)           # set the verbose flag to _v_.
verbose(v) { code }  # Execute code with the verbose flag set temporarily to _v_.
                     # Return to the original value when code is done.

# File lib/rake.rb, line 1107
def verbose(value=nil)
  oldvalue = RakeFileUtils.verbose_flag
  RakeFileUtils.verbose_flag = value unless value.nil?
  if block_given?
    begin
      yield
    ensure
      RakeFileUtils.verbose_flag = oldvalue
    end
  end
  RakeFileUtils.verbose_flag
end

Use this function to prevent protentially destructive ruby code from running when the :nowrite flag is set.

Example:

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

The following code will build the project under normal conditions. If the nowrite(true) flag is set, then the example will print:

DRYRUN: Building Project

instead of actually building the project.

# File lib/rake.rb, line 1155
def when_writing(msg=nil)
  if RakeFileUtils.nowrite_flag
    puts "DRYRUN: #{msg}" if msg
  else
    yield
  end
end