Module: RakeFileUtils

Extended by:
RakeFileUtils
Includes:
FileUtils
Included in:
RakeFileUtils
Defined in:
lib/rake/rake_file_utils.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

Class Attribute Summary collapse

Instance Method Summary collapse

Methods included from FileUtils

#ruby, #safe_ln, #sh, #split_all

Class Attribute Details

.nowrite_flag ⇒ Object

Returns the value of attribute nowrite_flag.



11
12
13
 
# File 'lib/rake/rake_file_utils.rb', line 11

def nowrite_flag
  @nowrite_flag
end

.verbose_flag ⇒ Object

Returns the value of attribute verbose_flag.



11
12
13
 
# File 'lib/rake/rake_file_utils.rb', line 11

def verbose_flag
  @verbose_flag
end

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.



68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/rake/rake_file_utils.rb', line 68

def nowrite(value=nil)
  oldvalue = RakeFileUtils.nowrite_flag
  RakeFileUtils.nowrite_flag = value unless value.nil?
  if block_given?
    begin
      yield
    ensure
      RakeFileUtils.nowrite_flag = 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.



47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/rake/rake_file_utils.rb', line 47

def verbose(value=nil)
  oldvalue = RakeFileUtils.verbose_flag
  RakeFileUtils.verbose_flag = value unless value.nil?
  if block_given?
    begin
      yield
    ensure
      RakeFileUtils.verbose_flag = oldvalue
    end
  end
  RakeFileUtils.verbose_flag
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.



95
96
97
98
99
100
101
 
# File 'lib/rake/rake_file_utils.rb', line 95

def when_writing(msg=nil)
  if RakeFileUtils.nowrite_flag
    puts "DRYRUN: #{msg}" if msg
  else
    yield
  end
end