Module RakeFileUtils
In: lib/rake.rb

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

Methods

Included Modules

FileUtils

Attributes

nowrite_flag  [RW] 
verbose_flag  [RW] 

Public Instance methods

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.

[Source]

     # File lib/rake.rb, line 853
853:   def nowrite(value=nil)
854:     oldvalue = RakeFileUtils.nowrite_flag
855:     RakeFileUtils.nowrite_flag = value unless value.nil?
856:     if block_given?
857:       begin
858:         yield
859:       ensure
860:         RakeFileUtils.nowrite_flag = oldvalue
861:       end
862:     end
863:     oldvalue
864:   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.

[Source]

     # File lib/rake.rb, line 831
831:   def verbose(value=nil)
832:     oldvalue = RakeFileUtils.verbose_flag
833:     RakeFileUtils.verbose_flag = value unless value.nil?
834:     if block_given?
835:       begin
836:         yield
837:       ensure
838:         RakeFileUtils.verbose_flag = oldvalue
839:       end
840:     end
841:     RakeFileUtils.verbose_flag
842:   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.

[Source]

     # File lib/rake.rb, line 880
880:   def when_writing(msg=nil)
881:     if RakeFileUtils.nowrite_flag
882:       puts "DRYRUN: #{msg}" if msg
883:     else
884:       yield
885:     end
886:   end

[Validate]