Module RakeFileUtils
In: lib/rake.rb

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

Methods

Included Modules

FileUtils

Attributes

nowrite_flag  [RW] 
verbose_flag  [RW] 

Public Instance methods

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.

[Source]

      # File lib/rake.rb, line 1105
1105:   def nowrite(value=nil)
1106:     oldvalue = RakeFileUtils.nowrite_flag
1107:     RakeFileUtils.nowrite_flag = value unless value.nil?
1108:     if block_given?
1109:       begin
1110:         yield
1111:       ensure
1112:         RakeFileUtils.nowrite_flag = oldvalue
1113:       end
1114:     end
1115:     oldvalue
1116:   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.

[Source]

      # File lib/rake.rb, line 1084
1084:   def verbose(value=nil)
1085:     oldvalue = RakeFileUtils.verbose_flag
1086:     RakeFileUtils.verbose_flag = value unless value.nil?
1087:     if block_given?
1088:       begin
1089:         yield
1090:       ensure
1091:         RakeFileUtils.verbose_flag = oldvalue
1092:       end
1093:     end
1094:     RakeFileUtils.verbose_flag
1095:   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.

[Source]

      # File lib/rake.rb, line 1132
1132:   def when_writing(msg=nil)
1133:     if RakeFileUtils.nowrite_flag
1134:       puts "DRYRUN: #{msg}" if msg
1135:     else
1136:       yield
1137:     end
1138:   end

[Validate]