Module: Sys

Extended by:
Sys
Included in:
Sys
Defined in:
lib/rake/contrib/sys.rb

Overview

Sys provides a number of file manipulation tools for the convenience of writing Rakefiles. All commands in this module will announce their activity on standard output if the $verbose flag is set ($verbose = true is the default). You can control this by globally setting $verbose or by using the verbose and quiet methods.

Sys has been deprecated in favor of the FileUtils module available in Ruby 1.8.

Constant Summary collapse

RUBY =
RbConfig::CONFIG['ruby_install_name']

Instance Method Summary collapse

Instance Method Details

#copy(file_name, dest_file) ⇒ Object

Copy a single file from file_name to dest_file.


47
48
49
50
# File 'lib/rake/contrib/sys.rb', line 47

def copy(file_name, dest_file)
  log "Copying file #{file_name} to #{dest_file}"
  File.copy(file_name, dest_file)
end

#copy_files(wildcard, dest_dir) ⇒ Object

Copy all files matching wildcard into the directory dest_dir.


53
54
55
# File 'lib/rake/contrib/sys.rb', line 53

def copy_files(wildcard, dest_dir)
  for_matching_files(wildcard, dest_dir) { |from, to| copy(from, to) }
end

#delete(*wildcards) ⇒ Object

Remove all files matching wildcard. If a matching file is a directory, it must be empty to be removed. used delete_all to recursively delete directories.


82
83
84
85
86
87
88
89
90
91
92
93
94
# File 'lib/rake/contrib/sys.rb', line 82

def delete(*wildcards)
  wildcards.each do |wildcard|
    Dir[wildcard].each do |fn|
      if File.directory?(fn)
        log "Deleting directory #{fn}"
        Dir.delete(fn)
      else
        log "Deleting file #{fn}"
        File.delete(fn)
      end
    end
  end
end

#delete_all(*wildcards) ⇒ Object

Recursively delete all files and directories matching wildcard.


97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
# File 'lib/rake/contrib/sys.rb', line 97

def delete_all(*wildcards)
  wildcards.each do |wildcard|
    Dir[wildcard].each do |fn|
      next if ! File.exist?(fn)
      if File.directory?(fn)
        Dir["#{fn}/*"].each do |subfn|
          next if subfn=='.' || subfn=='..'
          delete_all(subfn)
        end
        log "Deleting directory #{fn}"
        Dir.delete(fn)
      else
        log "Deleting file #{fn}"
        File.delete(fn)
      end
    end
  end
end

#for_files(*wildcards) ⇒ Object

Perform a block with each file matching a set of wildcards.


162
163
164
165
166
167
168
# File 'lib/rake/contrib/sys.rb', line 162

def for_files(*wildcards)
  wildcards.each do |wildcard|
    Dir[wildcard].each do |fn|
      yield(fn)
    end
  end
end

#indir(dir) ⇒ Object

Make dir the current working directory for the duration of executing the given block.


126
127
128
129
130
131
132
# File 'lib/rake/contrib/sys.rb', line 126

def indir(dir)
  olddir = Dir.pwd
  Dir.chdir(dir)
  yield
ensure
  Dir.chdir(olddir)
end

#install(wildcard, dest_dir, mode) ⇒ Object

Install all the files matching wildcard into the dest_dir directory. The permission mode is set to mode.


29
30
31
32
33
# File 'lib/rake/contrib/sys.rb', line 29

def install(wildcard, dest_dir, mode)
  Dir[wildcard].each do |fn|
    File.install(fn, dest_dir, mode, $verbose)
  end
end

Link file_name to dest_file.


58
59
60
61
# File 'lib/rake/contrib/sys.rb', line 58

def link(file_name, dest_file)
  log "Linking file #{file_name} to #{dest_file}"
  File.link(file_name, dest_file)
end

Link all files matching wildcard into the directory dest_dir.


64
65
66
# File 'lib/rake/contrib/sys.rb', line 64

def link_files(wildcard, dest_dir)
  for_matching_files(wildcard, dest_dir) { |from, to| link(from, to) }
end

#log(msg) ⇒ Object

Write a message to standard error if $verbose is enabled.


146
147
148
149
# File 'lib/rake/contrib/sys.rb', line 146

def log(msg)
  print "  " if $trace && $verbose
  $stderr.puts msg if $verbose
end

#makedirs(*dirs) ⇒ Object

Make the directories given in dirs.


117
118
119
120
121
122
# File 'lib/rake/contrib/sys.rb', line 117

def makedirs(*dirs)
  dirs.each do |fn|
    log "Making directory #{fn}"
    File.makedirs(fn)
  end
end

#quiet(&block) ⇒ Object

Perform a block with $verbose disabled.


152
153
154
# File 'lib/rake/contrib/sys.rb', line 152

def quiet(&block)
  with_verbose(false, &block)
end

#ruby(*args) ⇒ Object

Run a Ruby interpreter with the given arguments.


42
43
44
# File 'lib/rake/contrib/sys.rb', line 42

def ruby(*args)
  run "#{RUBY} #{args.join(' ')}"
end

#run(cmd) ⇒ Object

Run the system command cmd.


36
37
38
39
# File 'lib/rake/contrib/sys.rb', line 36

def run(cmd)
  log cmd
  system(cmd) or fail "Command Failed: [#{cmd}]"
end

#split_all(path) ⇒ Object

Split a file path into individual directory names.

For example:

split_all("a/b/c") =>  ['a', 'b', 'c']

138
139
140
141
142
143
# File 'lib/rake/contrib/sys.rb', line 138

def split_all(path)
  head, tail = File.split(path)
  return [tail] if head == '.' || tail == '/'
  return [head, tail] if head == '/'
  return split_all(head) + [tail]
end

Symlink file_name to dest_file.


69
70
71
72
# File 'lib/rake/contrib/sys.rb', line 69

def symlink(file_name, dest_file)
  log "Symlinking file #{file_name} to #{dest_file}"
  File.symlink(file_name, dest_file)
end

Symlink all files matching wildcard into the directory dest_dir.


75
76
77
# File 'lib/rake/contrib/sys.rb', line 75

def symlink_files(wildcard, dest_dir)
  for_matching_files(wildcard, dest_dir) { |from, to| link(from, to) }
end

#verbose(&block) ⇒ Object

Perform a block with $verbose enabled.


157
158
159
# File 'lib/rake/contrib/sys.rb', line 157

def verbose(&block)
  with_verbose(true, &block)
end