Module: RakeFileUtils

Module | RakeFileUtils
In: | lib/rake.rb

RakeFileUtils provides a custom version of the FileUtils methods that respond to the `verbose` and `nowrite` commands.

### Methods

nowrite verbose when_writing

### Included Modules

FileUtils

### Attributes

nowrite_flag | [RW] |
verbose_flag | [RW] |

### Public Instance methods

nowrite(value=nil) {|| ...}

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.

verbose(value=nil) {|| ...}

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.

when_writing(msg=nil) {|| ...}

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.

[Validate]