Module: RakeFileUtils

Extended by:
RakeFileUtils
Includes:
FileUtils
Included in:
RakeFileUtils
Defined in:
lib/rake.rb

Overview

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

Constant Summary

Constants included from FileUtils

FileUtils::LN_SUPPORTED, FileUtils::RUBY

Instance Method Summary collapse

Methods included from FileUtils

#ruby, #safe_ln, #sh, #split_all

Instance Method Details

#nowrite(value = nil) ⇒ Object

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.



676
677
678
679
680
681
682
683
684
685
686
687
 
# File 'lib/rake.rb', line 676

def nowrite(value=nil)
  oldvalue = $fileutils_nowrite
  $fileutils_nowrite = value unless value.nil?
  if block_given?
    begin
      yield
    ensure
      $fileutils_nowrite = oldvalue
    end
  end
  oldvalue
end

#verbose(value = nil) ⇒ Object

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.



654
655
656
657
658
659
660
661
662
663
664
665
 
# File 'lib/rake.rb', line 654

def verbose(value=nil)
  oldvalue = $fileutils_verbose
  $fileutils_verbose = value unless value.nil?
  if block_given?
    begin
      yield
    ensure
      $fileutils_verbose = oldvalue
    end
  end
  $fileutils_verbose
end

#when_writing(msg = nil) ⇒ Object

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.



703
704
705
706
707
708
709
 
# File 'lib/rake.rb', line 703

def when_writing(msg=nil)
  if $fileutils_nowrite
    puts "DRYRUN: #{msg}" if msg
  else
    yield
  end
end