| Module | RakeFileUtils |
| In: |
lib/rake.rb
|
########################################################################### RakeFileUtils provides a custom version of the FileUtils methods that respond to the verbose and nowrite commands.
| nowrite_flag | [RW] | |
| verbose_flag | [RW] |
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.
# File lib/rake.rb, line 840
840: def nowrite(value=nil)
841: oldvalue = RakeFileUtils.nowrite_flag
842: RakeFileUtils.nowrite_flag = value unless value.nil?
843: if block_given?
844: begin
845: yield
846: ensure
847: RakeFileUtils.nowrite_flag = oldvalue
848: end
849: end
850: oldvalue
851: 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.
# File lib/rake.rb, line 819
819: def verbose(value=nil)
820: oldvalue = RakeFileUtils.verbose_flag
821: RakeFileUtils.verbose_flag = value unless value.nil?
822: if block_given?
823: begin
824: yield
825: ensure
826: RakeFileUtils.verbose_flag = oldvalue
827: end
828: end
829: RakeFileUtils.verbose_flag
830: 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.
# File lib/rake.rb, line 867
867: def when_writing(msg=nil)
868: if RakeFileUtils.nowrite_flag
869: puts "DRYRUN: #{msg}" if msg
870: else
871: yield
872: end
873: end