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 854
854: def nowrite(value=nil)
855: oldvalue = RakeFileUtils.nowrite_flag
856: RakeFileUtils.nowrite_flag = value unless value.nil?
857: if block_given?
858: begin
859: yield
860: ensure
861: RakeFileUtils.nowrite_flag = oldvalue
862: end
863: end
864: oldvalue
865: 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 832
832: def verbose(value=nil)
833: oldvalue = RakeFileUtils.verbose_flag
834: RakeFileUtils.verbose_flag = value unless value.nil?
835: if block_given?
836: begin
837: yield
838: ensure
839: RakeFileUtils.verbose_flag = oldvalue
840: end
841: end
842: RakeFileUtils.verbose_flag
843: 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 881
881: def when_writing(msg=nil)
882: if RakeFileUtils.nowrite_flag
883: puts "DRYRUN: #{msg}" if msg
884: else
885: yield
886: end
887: end