Module: JumpStart::FileTools

Defined in:
lib/jumpstart/filetools.rb

Instance Method Summary collapse

Instance Method Details

#append_after_line(target_file, target_line, new_line) ⇒ Object

For inserting a line after a specific line in a file. Note that this method will match only the first line it finds.



4
5
6
7
8
9
10
11
12
13
14
15
16
 
# File 'lib/jumpstart/filetools.rb', line 4

def append_after_line(target_file, target_line, new_line)
  file = IO.readlines(target_file)
  new_file = file.dup
  file.each do |line|
    if line.chomp == target_line.chomp && new_line != nil
      new_file.insert((file.find_index(line) + 1), new_line)
      new_line = nil
    end
  end
  File.open(target_file, "w") do |x|
    x.puts new_file
  end
end

#append_to_end_of_file(source, target_file, remove_last_line = false) ⇒ Object

For appending text provided as a sring or a target file (source) to the end of another file (target_file). Takes an optional true/false as a third argument to remove the last line of the target file.



19
20
21
22
23
24
25
26
27
 
# File 'lib/jumpstart/filetools.rb', line 19

def append_to_end_of_file(source, target_file, remove_last_line=false)
  t_file = IO.readlines(target_file)
  t_file.pop if remove_last_line == true
  new_file = []
  new_file << t_file << check_source_type(source)
  File.open(target_file, "w") do |x|
    x.puts new_file
  end
end

#check_source_type(source) ⇒ Object

Checks to see if the source type is a file or a string. If it’s a file it reads the lines of the file and returns them as an array. If it’s a string it returns unaltered.



250
251
252
253
254
255
256
257
 
# File 'lib/jumpstart/filetools.rb', line 250

def check_source_type(source)
  if File.file?(source)
    source_file = IO.readlines(source)
  else
    source_file = source
  end
  source_file
end

#config_hosts(target_file, app_name) ⇒ Object

For configuring /etc/hosts. Necessary under OS X for NginX configuration to work.



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/jumpstart/filetools.rb', line 211

def config_hosts(target_file, app_name)
  puts
  puts "******************************************************************************************************************************************"
  puts
  puts "Configuring /etc/hosts"
  puts
  begin
    if File.writable?(target_file)
      etc_hosts = IO.readlines(target_file)
      etc_hosts << "127.0.0.1 #{app_name}.local"
      etc_hosts.compact!
      File.open(target_file, "w") do |file|
        file.puts etc_hosts
      end
      puts "Success! #{app_name.green} has been added to #{target_file.green}"
      puts
    else
      puts "It doesn't look like you have write access for #{target_file}. Would you like to use sudo to change them?".yellow
      puts "Type yes (" + "y".yellow + ") or no (" + "n".yellow + ")"
      puts
      input = gets.chomp
      if input == "yes" || input == "y"
        puts "Setting permissions for #{target_file.green}"
        puts
        system "sudo chmod 755 #{target_file}"
        config_etc_hosts(app_name)
      else
        puts "Skipping automatic #{target_file} config."
      end
    end
  rescue
    puts "There was a problem accessing the file #{target_file.red}, you may need to adjust the privileges."
    puts
  end
  puts "******************************************************************************************************************************************"
  puts
end

#config_nginx(source_file, target_file, app_name) ⇒ Object

For setting up app in Nginx



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/jumpstart/filetools.rb', line 161

def config_nginx(source_file, target_file, app_name)
  if source_file == nil || target_file == nil || app_name == nil
    puts
    puts "******************************************************************************************************************************************"
    puts
    puts "You need to specify three paramters to use this script:\n\n1: The Source File.\n2: The Target File.\n3: The App Name.".yellow
    puts
    puts "e.g. nginx_auto_config /Users/i0n/Sites/bin/templates/rails/config/nginx.local.conf /usr/local/nginx/conf/nginx.conf test_app"
    puts
    puts "******************************************************************************************************************************************"
    puts
  else
    puts
    puts "******************************************************************************************************************************************"
    puts
    puts "Configuring NginX at: #{target_file}"
    puts
    if File.writable?(target_file)
      nginx_config = IO.readlines(target_file)
      while nginx_config.last !~ /^\}[\n]*/
        nginx_config.pop
      end
      @nginx_last_line = nginx_config.pop
      source_config = IO.read(source_file)
      nginx_config.push source_config
      nginx_config.push @nginx_last_line
      nginx_config.each {|line| line.gsub!(/PROJECT_NAME/, "#{app_name}")}
      File.open(target_file, "w") do |file|
        file.puts nginx_config
      end
      puts "Success! NginX config for #{app_name.green} has been added to #{target_file.green}"
      puts
      puts "******************************************************************************************************************************************"
      puts
    else
      puts "It doesn't look like you have write access for #{target_file}. Would you like to use sudo to change them?".yellow
      puts "Type yes (" + "y".green + ") or no (" + "n".red + ")"
      input = gets.chomp
      if input == "yes" || input == "y"
        puts "Setting permissions for #{target_file.green}"
        system "sudo chmod 755 #{target_file}"
        config_nginx(source_file, target_file, app_name)
      else
        puts "Skipping automatic NginX config."
      end
    end
  end
end

#delete_dir_contents(target_dir) ⇒ Object

Deletes all files and folders in a directory. Leaves target_dir intact.



44
45
46
47
48
49
50
51
52
 
# File 'lib/jumpstart/filetools.rb', line 44

def delete_dir_contents(target_dir)
  Find.find(target_dir) do |x|
    if File.file?(x)
      FileUtils.rm(x)
    elsif File.directory?(x) && x != target_dir
      FileUtils.remove_dir(x)
    end
  end
end

#insert_text_at_line_number(source, target_file, line_number) ⇒ Object

For inserting text provided as a string or a target file (source) to a specific line number (line_number) of another file (target_file)



30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/jumpstart/filetools.rb', line 30

def insert_text_at_line_number(source, target_file, line_number)
  if line_number > 0
    line_number -= 1
    file = IO.readlines(target_file)
    file.insert((line_number), check_source_type(source))
    File.open(target_file, "w") do |x|
      x.puts file
    end
  else
    raise ArgumentError, "Line number must be 1 or higher.".red
  end
end

#join_paths(*args) ⇒ Object

Method for joining paths together. Paths can be supplied as a mixture of strings and arrays. If too many or not enough forward slashes are provided at the start/end of the paths, this will be corrected. Accidentally passing nil values mixed with strings/arrays will be corrected. Whitespace and line breaks mixed with the path will be corrected. If the path is an absolute path (starting with /) this will be preserved.



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/jumpstart/filetools.rb', line 264

def join_paths(*args)
  paths = []
  full_path = []
  temp_paths = []
  args.each {|x| temp_paths << x }
  temp_paths.flatten!
  temp_paths.each do |x|
    unless x.nil?
      paths << x.to_s.dup
    end
  end
  if paths[0].start_with?('/')
    absolute_path = true
  else
    absolute_path = false
  end
  paths.each do |path|
    unless path.nil?
      path.strip!
      path.slice!(0) while path.start_with?('/')
      path.chop! while path.end_with?('/')
      full_path << path
    end
  end
  full_path_string = full_path.join('/')
  full_path_string.slice!(0) while full_path_string.start_with?('/')
  full_path_string.chop! while full_path_string.end_with?('/')
  full_path_string.insert(0, '/') if absolute_path == true
  full_path_string
end

#remove_files(file_array) ⇒ Object

Removes files provided as an array.



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/jumpstart/filetools.rb', line 55

def remove_files(file_array)
  file_array.each do |x|
    begin
      if File.exists?(x)
        if File.writable?(x)
          puts
          puts "Removing the unwanted file: #{x.green}"
          File.delete(x)
        else
          puts
          puts "You do not have the correct privileges to delete #{x.red}. It has NOT been deleted."
        end
      else
        puts
        puts "The file #{x.red} could not be deleted as it could not be found."
      end
    rescue
      puts
      puts "Uh-oh, we've hit a snag with the remove_files method.".red
      puts "The file #{x.red} could not be deleted, do you have the correct privileges to access it?"
    end
  end
end

#remove_lines(target_file, args) ⇒ Object

For removing lines in a file that (A) match a specific pattern, and/or (B) or are specified by line number. Both types of removal are passed to the method via the arguments hash. e.g. remove lines macthing a pattern, do FileUtils.remove_lines(target_file, :pattern => “Hello!”) e.g. remove lines by line number, do FileUtils.remove_lines(target_file, :lines => [1,2,3,4,99]) e.g. You can also remove a single line by line number by passing :line. (FileUtils.remove_lines(target_file, :line => 2)) You can remove lines using :lines/:line and :pattern at the same time. In Ruby 1.9+ you can also pass a hash like this: FileUtils.remove_lines(target_file, pattern: “hello!”, lines: [1,2,3,4,99])



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/jumpstart/filetools.rb', line 86

def remove_lines(target_file, args)
  new_file = []
  original_lines = IO.readlines(target_file)
  if args[:line] != nil && args[:lines] == nil
    args[:line] -= 1
    original_lines.slice!(args[:line])
  elsif args[:lines] != nil && args[:line] == nil
    args[:lines].map! {|x| x -= 1}
    args[:lines].each do |y|
      original_lines[y] = nil
    end
  elsif args[:lines] != nil && args[:line] != nil
    puts
    puts "You have used an incorrect syntax for the FileUtils.remove_lines method.".red
    puts "You have specified a" + " :line".red_bold + " argument at the same time as a " + ":lines".red_bold + " argument, only one can be used at a time."
    raise ArgumentError
  end
  if args[:pattern] != nil then
    original_lines.each do |line|
      if line =~ /#{args[:pattern]}/
        original_lines[original_lines.find_index(line)] = nil
      end
    end
  end
  original_lines.compact!
  new_file += original_lines
  File.open(target_file, "w") do |x|
    x.puts new_file
  end
end

#replace_strings(target_file, args) ⇒ Object

TODO Write test for new file permissions functionality This method generates string replacements via a hash passed to the method, this enables versatile string replacement. To replace values in the target file, simply add the name of the key for that replacement in CAPS. e.g. You might call the method with something like: FileUtils.replace_strings(target_file, :name => “Ian”, :country => “England”) … and in the template it would look like this: Hello there NAME from COUNTRY Will also replace strings present in the target_file path. so if the method call looked like: FileUtils.replace_strings(target_file, :name => “Ian”, :country => “England”) and target_file was: /Users/name/Sites/country the strings matching NAME and COUNTRY inside the file would be swapped out and then a new file at the path: /Users/Ian/Sites/England would be created and populated with the contents. The file at the previous path would be deleted. Finally if you specify a symbol and append _CLASS in the template, that instance will be replace with a capitalized version of the string.



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/jumpstart/filetools.rb', line 126

def replace_strings(target_file, args)
  if File.file?(target_file)
    permissions = File.executable?(target_file)
    original_txt = IO.read(target_file)
    old_dir = target_file.sub(/\/\w+\.*\w*$/, '')
    new_file = target_file.gsub(/#{old_dir}\//, '')
    new_dir = old_dir.dup
    new_txt = original_txt.dup
    args.each do |x, y|
      new_txt.gsub!(/#{x.to_s.upcase}_CLASS/, y.capitalize)
      new_txt.gsub!(/#{x.to_s.upcase}/, y)
      new_dir.gsub!(/#{x.to_s.downcase}/, y)
      new_file.gsub!(/#{x.to_s.downcase}/, y)
    end
    if (old_dir <=> new_dir) != 0 && !File.directory?(new_dir)
      FileUtils.mkdir_p(new_dir)
    end
    File.open("#{new_dir}/#{new_file}", "w") do |file|
      file.puts new_txt
      file.chmod(0755) if permissions
    end
    if (target_file <=> "#{new_dir}/#{new_file}") != 0
      FileUtils.rm(target_file)
      if File.directory?(old_dir)
        if (Dir.entries(old_dir) - ['.', '..']).empty?
          FileUtils.remove_dir(old_dir)
        end
      end
    end    
  else
    puts "#{target_file} is NOT a file"
  end
end

#sort_contained_files_and_dirs(path) ⇒ Object

Sorts files and dirs in a path and then returns the result as a hash of two arrays, :files and :dirs



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/jumpstart/filetools.rb', line 296

def sort_contained_files_and_dirs(path)
  dirs, files = [], []
  if path != nil && File.directory?(path)
    Find.find(path) do |x|
      case
      when File.directory?(x)
        x.sub!(path, '')
        dirs << x unless x.length == 0
      when File.file?(x)
        x.sub!(path, '')
        files << x unless x.length == 0
      end
    end
  end
  {:files => files, :dirs => dirs}
end