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

Methods
Included Modules
Attributes
[RW] nowrite_flag
[RW] verbose_flag
Public Instance methods
nowrite(value=nil) {|| ...}

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 694
694:   def nowrite(value=nil)
695:     oldvalue = RakeFileUtils.nowrite_flag
696:     RakeFileUtils.nowrite_flag = value unless value.nil?
697:     if block_given?
698:       begin
699:         yield
700:       ensure
701:         RakeFileUtils.nowrite_flag = oldvalue
702:       end
703:     end
704:     oldvalue
705:   end
verbose(value=nil) {|| ...}

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 672
672:   def verbose(value=nil)
673:     oldvalue = RakeFileUtils.verbose_flag
674:     RakeFileUtils.verbose_flag = value unless value.nil?
675:     if block_given?
676:       begin
677:         yield
678:       ensure
679:         RakeFileUtils.verbose_flag = oldvalue
680:       end
681:     end
682:     RakeFileUtils.verbose_flag
683:   end
when_writing(msg=nil) {|| ...}

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 721
721:   def when_writing(msg=nil)
722:     if RakeFileUtils.nowrite_flag
723:       puts "DRYRUN: #{msg}" if msg
724:     else
725:       yield
726:     end
727:   end