########################################################################### 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 1020
1020: def nowrite(value=nil)
1021: oldvalue = RakeFileUtils.nowrite_flag
1022: RakeFileUtils.nowrite_flag = value unless value.nil?
1023: if block_given?
1024: begin
1025: yield
1026: ensure
1027: RakeFileUtils.nowrite_flag = oldvalue
1028: end
1029: end
1030: oldvalue
1031: 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 999
999: def verbose(value=nil)
1000: oldvalue = RakeFileUtils.verbose_flag
1001: RakeFileUtils.verbose_flag = value unless value.nil?
1002: if block_given?
1003: begin
1004: yield
1005: ensure
1006: RakeFileUtils.verbose_flag = oldvalue
1007: end
1008: end
1009: RakeFileUtils.verbose_flag
1010: 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 1047
1047: def when_writing(msg=nil)
1048: if RakeFileUtils.nowrite_flag
1049: puts "DRYRUN: #{msg}" if msg
1050: else
1051: yield
1052: end
1053: end