Module: Freyia::Automations
- Included in:
- Setup
- Defined in:
- lib/freyia/automations.rb,
lib/freyia/automations/directory.rb,
lib/freyia/automations/create_file.rb,
lib/freyia/automations/create_link.rb,
lib/freyia/automations/empty_directory.rb,
lib/freyia/automations/inject_into_file.rb,
lib/freyia/automations/file_manipulation.rb
Defined Under Namespace
Classes: CapturableERB, CreateFile, CreateLink, Directory, EmptyDirectory, InjectIntoFile
Constant Summary collapse
- WARNINGS =
{ unchanged_no_flag: "File unchanged! Either the supplied flag value not found or the " \ "content has already been inserted!", }.freeze
Class Method Summary collapse
-
.escape_globs(path) ⇒ String
Returns a string that has had any glob characters escaped.
Instance Method Summary collapse
-
#append_to_file(path, *args) ⇒ Object
(also: #append_file)
Append text to a file.
-
#apply(path, config = {}) ⇒ Object
Loads an external file and execute it in the instance binding.
-
#chmod(path, mode, config = {}) ⇒ Object
Changes the mode of the given file or directory.
-
#comment_lines(path, flag) ⇒ Object
Comment all lines matching a given regex.
-
#copy_file(source, *args, &block) ⇒ Object
Copies the file from the relative source to the relative destination.
-
#create_file(destination, *args, &block) ⇒ Object
(also: #add_file)
Create a new file relative to the destination root with the given data, which is the return value of a block or a data string.
-
#create_link(destination, *args) ⇒ Object
(also: #add_link)
Create a new file relative to the destination root from the given source.
-
#destination_root ⇒ Object
Returns the root for this freyia class (also aliased as destination root).
-
#destination_root=(root) ⇒ Object
Sets the root for this freyia class.
-
#directory(source, *args) ⇒ Object
Copies recursively the files from source directory to root directory.
-
#empty_directory(destination, config = {}) ⇒ Object
Creates an empty directory.
-
#find_in_source_paths(file) ⇒ Object
Receives a file or directory and search for it in the source paths.
-
#get(source, *args, &block) ⇒ Object
Gets the content at the given address and places it at the given relative destination.
-
#gsub_file(path, flag, *args) ⇒ Object
Run a regular expression replacement on a file.
-
#gsub_file!(path, flag, *args) ⇒ Object
Run a regular expression replacement on a file, raising an error if the contents of the file are not changed.
-
#in_root ⇒ Object
Goes to the root and execute the given block.
-
#inject_into_class(path, klass, *args) ⇒ Object
Injects text right after the class definition.
-
#inject_into_module(path, module_name, *args) ⇒ Object
Injects text right after the module definition.
-
#insert_into_file(destination, *args, &block) ⇒ Object
(also: #inject_into_file)
Injects the given content into a file.
-
#insert_into_file!(destination, *args, &block) ⇒ Object
(also: #inject_into_file!)
Injects the given content into a file, raising an error if the contents of the file are not changed.
-
#inside(dir = "", config = {}, &block) ⇒ Object
Do something in the root or on a provided subfolder.
-
#link_file(source, *args) ⇒ Object
Links the file from the relative source to the relative destination.
-
#prepend_to_file(path, *args) ⇒ Object
(also: #prepend_file)
Prepend text to a file.
-
#relative_to_original_destination_root(path, remove_dot: true) ⇒ Object
Returns the given path relative to the absolute root (ie, root where the script started).
-
#remove_file(path, config = {}) ⇒ Object
(also: #remove_dir)
Removes a file at the given location.
-
#run(command, config = {}) ⇒ Object
Executes a command returning the contents of the command.
-
#template(source, *args, &block) ⇒ Object
Gets an ERB template at the relative source, executes it and makes a copy at the relative destination.
-
#uncomment_lines(path, flag) ⇒ Object
Uncomment all lines matching a given regex.
Class Method Details
.escape_globs(path) ⇒ String
Returns a string that has had any glob characters escaped. The glob characters are ‘* ? { } [ ]`.
20 21 22 |
# File 'lib/freyia/automations.rb', line 20 def self.escape_globs(path) path.to_s.gsub(%r{[*?{}\[\]]}, '\\\\\\&') end |
Instance Method Details
#append_to_file(path, *args) ⇒ Object Also known as: append_file
Append text to a file. Since it depends on insert_into_file, it’s reversible.
Parameters
- path<String>
-
path of the file to be changed
- data<String>
-
the data to append to the file, can be also given as a block.
- config<Hash>
-
give :verbose => false to not log the status.
Example
append_to_file 'config/environments/test.rb', 'config.gem "rspec"'
append_to_file 'config/environments/test.rb' do
'config.gem "rspec"'
end
196 197 198 199 200 |
# File 'lib/freyia/automations/file_manipulation.rb', line 196 def append_to_file(path, *args, &) config = args.last.is_a?(Hash) ? args.pop : {} config[:before] = %r{\z} insert_into_file(path, *(args << config), &) end |
#apply(path, config = {}) ⇒ Object
Loads an external file and execute it in the instance binding.
Parameters
- path<String>
-
The path to the file to execute. Can be a web address or a relative path from the source root.
Examples
apply "http://gist.github.com/103208"
apply "recipes/jquery.rb"
136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 |
# File 'lib/freyia/automations.rb', line 136 def apply(path, config = {}) verbose = config.fetch(:verbose, true) is_uri = path =~ %r{^https?://} path = find_in_source_paths(path) unless is_uri say_status :apply, path, verbose shell.padding += 1 if verbose contents = if is_uri require "open-uri" URI.open(path, "Accept" => "application/x-freyia-template", &:read) # rubocop:disable Security/Open else File.read(path) end instance_eval(contents, path) shell.padding -= 1 if verbose end |
#chmod(path, mode, config = {}) ⇒ Object
Changes the mode of the given file or directory.
Parameters
- mode<Integer>
-
the file mode
- path<String>
-
the name of the file to change mode
- config<Hash>
-
give :verbose => false to not log the status.
Example
chmod "script/server", 0755
150 151 152 153 154 155 156 157 |
# File 'lib/freyia/automations/file_manipulation.rb', line 150 def chmod(path, mode, config = {}) path = File.(path, destination_root) say_status :chmod, relative_to_original_destination_root(path), config.fetch(:verbose, true) return if [:pretend] require "fileutils" FileUtils.chmod_R(mode, path) end |
#comment_lines(path, flag) ⇒ Object
Comment all lines matching a given regex. It will leave the space which existed before the beginning of the line in tact and will insert a single space after the comment hash.
Parameters
- path<String>
-
path of the file to be changed
- flag<Regexp|String>
-
the regexp or string used to decide which lines to comment
- config<Hash>
-
give :verbose => false to not log the status.
Example
comment_lines 'config/initializers/session_store.rb', /cookie_store/
339 340 341 342 343 |
# File 'lib/freyia/automations/file_manipulation.rb', line 339 def comment_lines(path, flag, *) flag = flag.source if flag.respond_to?(:source) gsub_file(path, %r{^(\s*)([^#\n]*#{flag})}, '\1# \2', *) end |
#copy_file(source, *args, &block) ⇒ Object
Copies the file from the relative source to the relative destination. If the destination is not given it’s assumed to be equal to the source.
Parameters
- source<String>
-
the relative path to the source root.
- destination<String>
-
the relative path to the destination root.
- config<Hash>
-
give :verbose => false to not log the status, and :mode => :preserve, to preserve the file mode from the source.
Examples
copy_file "README", "doc/README"
copy_file "doc/README"
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 |
# File 'lib/freyia/automations/file_manipulation.rb', line 22 def copy_file(source, *args, &block) config = args.last.is_a?(Hash) ? args.pop : {} destination = args.first || source source = File.(find_in_source_paths(source.to_s)) resulting_destination = create_file destination, nil, config do content = File.binread(source) content = yield(content) if block content end return unless config[:mode] == :preserve mode = File.stat(source).mode chmod(resulting_destination, mode, config) end |
#create_file(destination, *args, &block) ⇒ Object Also known as: add_file
Create a new file relative to the destination root with the given data, which is the return value of a block or a data string.
Parameters
- destination<String>
-
the relative path to the destination root.
- data<String|NilClass>
-
the data to append to the file.
- config<Hash>
-
give :verbose => false to not log the status.
Examples
create_file "lib/fun_party.rb" do
hostname = ask("What is the virtual hostname I should use?")
"vhost.name = #{hostname}"
end
create_file "config/apache.conf", "your apache config"
24 25 26 27 28 |
# File 'lib/freyia/automations/create_file.rb', line 24 def create_file(destination, *args, &block) config = args.last.is_a?(Hash) ? args.pop : {} data = args.first CreateFile.new(self, destination, block || data.to_s, config).() end |
#create_link(destination, *args) ⇒ Object Also known as: add_link
Create a new file relative to the destination root from the given source.
Parameters
- destination<String>
-
the relative path to the destination root.
- source<String|NilClass>
-
the relative path to the source root.
- config<Hash>
-
give :verbose => false to not log the status.
-
give :symbolic => false for hard link.
Examples
create_link "config/apache.conf", "/etc/apache.conf"
19 20 21 22 23 |
# File 'lib/freyia/automations/create_link.rb', line 19 def create_link(destination, *args) config = args.last.is_a?(Hash) ? args.pop : {} source = args.first CreateLink.new(self, destination, source, config).() end |
#destination_root ⇒ Object
Returns the root for this freyia class (also aliased as destination root).
26 27 28 |
# File 'lib/freyia/automations.rb', line 26 def destination_root @destination_stack.last end |
#destination_root=(root) ⇒ Object
Sets the root for this freyia class. Relatives path are added to the directory where the script was invoked and expanded.
33 34 35 36 |
# File 'lib/freyia/automations.rb', line 33 def destination_root=(root) @destination_stack ||= [] @destination_stack[0] = File.(root || "") end |
#directory(source, *args) ⇒ Object
Copies recursively the files from source directory to root directory. If any of the files finishes with .tt, it’s considered to be a template and is placed in the destination without the extension .tt. If any empty directory is found, it’s copied and all .empty_directory files are ignored. If any file name is wrapped within % signs, the text within the % signs will be executed as a method and replaced with the returned value. Let’s suppose a doc directory with the following files:
doc/
components/.empty_directory
README
rdoc.rb.tt
%app_name%.rb
When invoked as:
directory "doc"
It will create a doc directory in the destination with the following files (assuming that the ‘app_name` method returns the value “blog”):
doc/
components/
README
rdoc.rb
blog.rb
Encoded path note: Since Freyia internals use Object#respond_to? to check if it can expand %something%, this ‘something` should be a public method in the class calling #directory. If a method is private, Freyia stack raises PrivateMethodEncodedError.
Parameters
- source<String>
-
the relative path to the source root.
- destination<String>
-
the relative path to the destination root.
- config<Hash>
-
give :verbose => false to not log the status. If :recursive => false, does not look for paths recursively. If :mode => :preserve, preserve the file mode from the source. If :exclude_pattern => /regexp/, prevents copying files that match that regexp.
Examples
directory "doc"
directory "doc", "docs", :recursive => false
51 52 53 54 55 |
# File 'lib/freyia/automations/directory.rb', line 51 def directory(source, *args, &) config = args.last.is_a?(Hash) ? args.pop : {} destination = args.first || source Directory.new(self, source, destination || source, config, &).() end |
#empty_directory(destination, config = {}) ⇒ Object
Creates an empty directory.
Parameters
- destination<String>
-
the relative path to the destination root.
- config<Hash>
-
give :verbose => false to not log the status.
Examples
empty_directory "doc"
15 16 17 |
# File 'lib/freyia/automations/empty_directory.rb', line 15 def empty_directory(destination, config = {}) EmptyDirectory.new(self, destination, config).() end |
#find_in_source_paths(file) ⇒ Object
Receives a file or directory and search for it in the source paths.
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 |
# File 'lib/freyia/automations.rb', line 55 def find_in_source_paths(file) possible_files = [file, file + TEMPLATE_EXTNAME] relative_root = relative_to_original_destination_root(destination_root, remove_dot: false) source_paths.each do |source| possible_files.each do |f| source_file = File.(f, File.join(source, relative_root)) return source_file if File.exist?(source_file) end end = "Could not find #{file.inspect} in any of your source paths. " << if source_paths.empty? "Currently you have no source paths." else "Your current source paths are: \n#{source_paths.join("\n")}" end raise Error, end |
#get(source, *args, &block) ⇒ Object
Gets the content at the given address and places it at the given relative destination. If a block is given instead of destination, the content of the url is yielded and used as location.
get relies on open-uri, so passing application user input would provide a command injection attack vector.
Parameters
- source<String>
-
the address of the given content.
- destination<String>
-
the relative path to the destination root.
- config<Hash>
-
give :verbose => false to not log the status, and :http_headers => <Hash> to add headers to an http request.
Examples
get "http://gist.github.com/103208", "doc/README"
get "http://gist.github.com/103208", "doc/README", :http_headers => {"Content-Type" => "application/json"}
get "http://gist.github.com/103208" do |content|
content.split("\n").first
end
83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 |
# File 'lib/freyia/automations/file_manipulation.rb', line 83 def get(source, *args, &block) # rubocop:todo Metrics config = args.last.is_a?(Hash) ? args.pop : {} destination = args.first render = if %r{^https?://}.match?(source) require "open-uri" URI.send(:open, source, config.fetch(:http_headers, {})) do |input| input.binmode.read end else source = File.(find_in_source_paths(source.to_s)) File.open(source) { |input| input.binmode.read } end destination ||= if block_given? block.arity == 1 ? yield(render) : yield else File.basename(source) end create_file destination, render, config end |
#gsub_file(path, flag, *args) ⇒ Object
Run a regular expression replacement on a file.
Parameters
- path<String>
-
path of the file to be changed
- flag<Regexp|String>
-
the regexp or string to be replaced
- replacement<String>
-
the replacement, can be also given as a block
- config<Hash>
-
give :verbose => false to not log the status, and :force => true, to force the replacement regardless of runner behavior.
Example
gsub_file 'app/controllers/application_controller.rb',
/#\s*(filter_parameter_logging :password)/, '\1'
gsub_file 'README', /rake/, :green do |match|
match << " no more. Use freyia!"
end
299 300 301 302 303 304 305 306 |
# File 'lib/freyia/automations/file_manipulation.rb', line 299 def gsub_file(path, flag, *args, &) config = args.last.is_a?(Hash) ? args.pop : {} path = File.(path, destination_root) say_status :gsub, relative_to_original_destination_root(path), config.fetch(:verbose, true) actually_gsub_file(path, flag, args, false, &) unless [:pretend] end |
#gsub_file!(path, flag, *args) ⇒ Object
Run a regular expression replacement on a file, raising an error if the contents of the file are not changed.
Parameters
- path<String>
-
path of the file to be changed
- flag<Regexp|String>
-
the regexp or string to be replaced
- replacement<String>
-
the replacement, can be also given as a block
- config<Hash>
-
give :verbose => false to not log the status, and :force => true, to force the replacement regardless of runner behavior.
Example
gsub_file! 'app/controllers/application_controller.rb',
/#\s*(filter_parameter_logging :password)/, '\1'
gsub_file! 'README', /rake/, :green do |match|
match << " no more. Use freyia!"
end
272 273 274 275 276 277 278 279 |
# File 'lib/freyia/automations/file_manipulation.rb', line 272 def gsub_file!(path, flag, *args, &) config = args.last.is_a?(Hash) ? args.pop : {} path = File.(path, destination_root) say_status :gsub, relative_to_original_destination_root(path), config.fetch(:verbose, true) actually_gsub_file(path, flag, args, true, &) unless [:pretend] end |
#in_root ⇒ Object
Goes to the root and execute the given block.
120 121 122 |
# File 'lib/freyia/automations.rb', line 120 def in_root(&) inside(@destination_stack.first, &) end |
#inject_into_class(path, klass, *args) ⇒ Object
Injects text right after the class definition. Since it depends on insert_into_file, it’s reversible.
Parameters
- path<String>
-
path of the file to be changed
- klass<String|Class>
-
the class to be manipulated
- data<String>
-
the data to append to the class, can be also given as a block.
- config<Hash>
-
give :verbose => false to not log the status.
Examples
inject_into_class "app/controllers/application_controller.rb",
"ApplicationController",
" filter_parameter :password\n"
inject_into_class "app/controllers/application_controller.rb", "ApplicationController" do
" filter_parameter :password\n"
end
222 223 224 225 226 |
# File 'lib/freyia/automations/file_manipulation.rb', line 222 def inject_into_class(path, klass, *args, &) config = args.last.is_a?(Hash) ? args.pop : {} config[:after] = %r{class #{klass}\n|class #{klass} .*\n} insert_into_file(path, *(args << config), &) end |
#inject_into_module(path, module_name, *args) ⇒ Object
Injects text right after the module definition. Since it depends on insert_into_file, it’s reversible.
Parameters
- path<String>
-
path of the file to be changed
- module_name<String|Class>
-
the module to be manipulated
- data<String>
-
the data to append to the class, can be also given as a block.
- config<Hash>
-
give :verbose => false to not log the status.
Examples
inject_into_module "app/helpers/application_helper.rb",
"ApplicationHelper",
" def help; 'help'; end\n"
inject_into_module "app/helpers/application_helper.rb", "ApplicationHelper" do
" def help; 'help'; end\n"
end
247 248 249 250 251 |
# File 'lib/freyia/automations/file_manipulation.rb', line 247 def inject_into_module(path, module_name, *args, &) config = args.last.is_a?(Hash) ? args.pop : {} config[:after] = %r{module #{module_name}\n|module #{module_name} .*\n} insert_into_file(path, *(args << config), &) end |
#insert_into_file(destination, *args, &block) ⇒ Object Also known as: inject_into_file
Injects the given content into a file. Different from gsub_file, this method is reversible.
Parameters
- destination<String>
-
Relative path to the destination root
- data<String>
-
Data to add to the file. Can be given as a block.
- config<Hash>
-
give :verbose => false to not log the status and the flag for injection (:after or :before) or :force => true for insert two or more times the same content.
Examples
insert_into_file "config/environment.rb", "config.gem :freyia",
after: "Rails::Initializer.run do |config|\n"
insert_into_file "config/environment.rb", after: "Rails::Initializer.run do |config|\n" do
gems = ask "Which gems would you like to add?"
gems.split(" ").map{ |gem| " config.gem :#{gem}" }.join("\n")
end
63 64 65 66 67 68 69 70 |
# File 'lib/freyia/automations/inject_into_file.rb', line 63 def insert_into_file(destination, *args, &block) data = block_given? ? block : args.shift config = args.shift || {} config[:after] = %r{\z} unless config.key?(:before) || config.key?(:after) InjectIntoFile.new(self, destination, data, config).() end |
#insert_into_file!(destination, *args, &block) ⇒ Object Also known as: inject_into_file!
Injects the given content into a file, raising an error if the contents of the file are not changed. Different from gsub_file, this method is reversible.
Parameters
- destination<String>
-
Relative path to the destination root
- data<String>
-
Data to add to the file. Can be given as a block.
- config<Hash>
-
give :verbose => false to not log the status and the flag for injection (:after or :before) or :force => true for insert two or more times the same content.
Examples
insert_into_file "config/environment.rb", "config.gem :freyia",
after: "Rails::Initializer.run do |config|\n"
insert_into_file "config/environment.rb", after: "Rails::Initializer.run do |config|\n" do
gems = ask "Which gems would you like to add?"
gems.split(" ").map{ |gem| " config.gem :#{gem}" }.join("\n")
end
32 33 34 35 36 37 38 39 40 |
# File 'lib/freyia/automations/inject_into_file.rb', line 32 def insert_into_file!(destination, *args, &block) data = block_given? ? block : args.shift config = args.shift || {} config[:after] = %r{\z} unless config.key?(:before) || config.key?(:after) config = config.merge({ error_on_no_change: true }) InjectIntoFile.new(self, destination, data, config).() end |
#inside(dir = "", config = {}, &block) ⇒ Object
Do something in the root or on a provided subfolder. If a relative path is given it’s referenced from the current root. The full path is yielded to the block you provide. The path is set back to the previous path when the method exits.
Returns the value yielded by the block.
Parameters
- dir<String>
-
the directory to move to.
- config<Hash>
-
give :verbose => true to log and use padding.
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 116 |
# File 'lib/freyia/automations.rb', line 88 def inside(dir = "", config = {}, &block) # rubocop:todo Metrics verbose = config.fetch(:verbose, false) pretend = [:pretend] say_status :inside, dir, verbose shell.padding += 1 if verbose @destination_stack.push File.(dir, destination_root) # If the directory doesn't exist and we're not pretending if !File.exist?(destination_root) && !pretend require "fileutils" FileUtils.mkdir_p(destination_root) end result = nil if pretend # In pretend mode, just yield down to the block result = block.arity == 1 ? yield(destination_root) : yield else require "fileutils" FileUtils.cd(destination_root) do result = block.arity == 1 ? yield(destination_root) : yield end end @destination_stack.pop shell.padding -= 1 if verbose result end |
#link_file(source, *args) ⇒ Object
Links the file from the relative source to the relative destination. If the destination is not given it’s assumed to be equal to the source.
Parameters
- source<String>
-
the relative path to the source root.
- destination<String>
-
the relative path to the destination root.
- config<Hash>
-
give :verbose => false to not log the status.
Examples
link_file "README", "doc/README"
link_file "doc/README"
52 53 54 55 56 57 58 |
# File 'lib/freyia/automations/file_manipulation.rb', line 52 def link_file(source, *args) config = args.last.is_a?(Hash) ? args.pop : {} destination = args.first || source source = File.(find_in_source_paths(source.to_s)) create_link destination, source, config end |
#prepend_to_file(path, *args) ⇒ Object Also known as: prepend_file
Prepend text to a file. Since it depends on insert_into_file, it’s reversible.
Parameters
- path<String>
-
path of the file to be changed
- data<String>
-
the data to prepend to the file, can be also given as a block.
- config<Hash>
-
give :verbose => false to not log the status.
Example
prepend_to_file 'config/environments/test.rb', 'config.gem "rspec"'
prepend_to_file 'config/environments/test.rb' do
'config.gem "rspec"'
end
174 175 176 177 178 |
# File 'lib/freyia/automations/file_manipulation.rb', line 174 def prepend_to_file(path, *args, &) config = args.last.is_a?(Hash) ? args.pop : {} config[:after] = %r{\A} insert_into_file(path, *(args << config), &) end |
#relative_to_original_destination_root(path, remove_dot: true) ⇒ Object
Returns the given path relative to the absolute root (ie, root where the script started).
41 42 43 44 45 46 47 48 49 50 51 |
# File 'lib/freyia/automations.rb', line 41 def relative_to_original_destination_root(path, remove_dot: true) root = @destination_stack[0] if path.start_with?(root) && [File::SEPARATOR, File::ALT_SEPARATOR, nil, "",].include?(path[root.size..root.size]) path = path.dup path[0...root.size] = "." remove_dot ? (path[2..] || "") : path else path end end |
#remove_file(path, config = {}) ⇒ Object Also known as: remove_dir
Removes a file at the given location.
Parameters
- path<String>
-
path of the file to be changed
- config<Hash>
-
give :verbose => false to not log the status.
Example
remove_file 'README'
remove_file 'app/controllers/application_controller.rb'
356 357 358 359 360 361 362 363 364 365 366 |
# File 'lib/freyia/automations/file_manipulation.rb', line 356 def remove_file(path, config = {}) return unless behavior == :invoke path = File.(path, destination_root) say_status :remove, relative_to_original_destination_root(path), config.fetch(:verbose, true) return unless ![:pretend] && (File.exist?(path) || File.symlink?(path)) require "fileutils" ::FileUtils.rm_rf(path) end |
#run(command, config = {}) ⇒ Object
Executes a command returning the contents of the command.
Parameters
- command<String>
-
the command to be executed.
- config<Hash>
-
give :verbose => false to not log the status, :capture => true to hide to output. Specify :with to append an executable to command execution.
Example
inside('vendor') do
run('ln -s ~/edge rails')
end
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 |
# File 'lib/freyia/automations.rb', line 168 def run(command, config = {}) # rubocop:todo Metrics destination = relative_to_original_destination_root(destination_root, remove_dot: false) desc = "#{command} from #{destination.inspect}" if config[:with] desc = "#{File.basename(config[:with].to_s)} #{desc}" command = "#{config[:with]} #{command}" end say_status :run, desc, config.fetch(:verbose, true) return if [:pretend] env_splat = [config[:env]] if config[:env] if config[:capture] require "open3" result, status = Open3.capture2e(*env_splat, command.to_s) success = status.success? else result = system(*env_splat, command.to_s) success = result end abort if !success && config.fetch(:abort_on_failure, self.class.respond_to?(:exit_on_failure?) && self.class.exit_on_failure?) result end |
#template(source, *args, &block) ⇒ Object
Gets an ERB template at the relative source, executes it and makes a copy at the relative destination. If the destination is not given it’s assumed to be equal to the source removing .tt from the filename.
Parameters
- source<String>
-
the relative path to the source root.
- destination<String>
-
the relative path to the destination root.
- config<Hash>
-
give :verbose => false to not log the status.
Examples
template "README", "doc/README"
template "doc/README"
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 |
# File 'lib/freyia/automations/file_manipulation.rb', line 121 def template(source, *args, &block) config = args.last.is_a?(Hash) ? args.pop : {} destination = args.first || source.sub(%r{#{TEMPLATE_EXTNAME}$}o, "") source = File.(find_in_source_paths(source.to_s)) context = config.delete(:context) || instance_eval("binding", __FILE__, __LINE__) create_file destination, nil, config do capturable_erb = CapturableERB.new(::File.binread(source), trim_mode: "-", eoutvar: "@output_buffer") content = capturable_erb.tap do |erb| erb.filename = source end.result(context) content = yield(content) if block content end end |
#uncomment_lines(path, flag) ⇒ Object
Uncomment all lines matching a given regex. Preserves indentation before the comment hash and removes the hash and any immediate following space.
Parameters
- path<String>
-
path of the file to be changed
- flag<Regexp|String>
-
the regexp or string used to decide which lines to uncomment
- config<Hash>
-
give :verbose => false to not log the status.
Example
uncomment_lines 'config/initializers/session_store.rb', /active_record/
320 321 322 323 324 |
# File 'lib/freyia/automations/file_manipulation.rb', line 320 def uncomment_lines(path, flag, *) flag = flag.source if flag.respond_to?(:source) gsub_file(path, %r{^(\s*)#[[:blank:]]?(.*#{flag})}, '\1\2', *) end |