RakeFileUtils provides a custom version of the FileUtils methods that respond to the verbose and nowrite commands.
| [RW] | nowrite_flag | |
| [RW] | verbose_flag |
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.
[ show source ]
# File lib/rake.rb, line 1129
1129: def nowrite(value=nil)
1130: oldvalue = RakeFileUtils.nowrite_flag
1131: RakeFileUtils.nowrite_flag = value unless value.nil?
1132: if block_given?
1133: begin
1134: yield
1135: ensure
1136: RakeFileUtils.nowrite_flag = oldvalue
1137: end
1138: end
1139: oldvalue
1140: 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.
[ show source ]
# File lib/rake.rb, line 1108
1108: def verbose(value=nil)
1109: oldvalue = RakeFileUtils.verbose_flag
1110: RakeFileUtils.verbose_flag = value unless value.nil?
1111: if block_given?
1112: begin
1113: yield
1114: ensure
1115: RakeFileUtils.verbose_flag = oldvalue
1116: end
1117: end
1118: RakeFileUtils.verbose_flag
1119: 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.
[ show source ]
# File lib/rake.rb, line 1156
1156: def when_writing(msg=nil)
1157: if RakeFileUtils.nowrite_flag
1158: puts "DRYRUN: #{msg}" if msg
1159: else
1160: yield
1161: end
1162: end