Module: Hanami::Utils::Files
- Defined in:
- gems/gems/hanami-utils-2.2.0.beta1/lib/hanami/utils/files.rb
Overview
Files utilities
Class Method Summary collapse
-
.append(path, contents) ⇒ Object
Adds a new line at the bottom of the file.
-
.cp(source, destination) ⇒ Object
Copies source into destination.
-
.delete(path) ⇒ Object
Deletes given path (file).
-
.delete_directory(path) ⇒ Object
Deletes given path (directory).
-
.directory?(path) ⇒ TrueClass, FalseClass
Checks if
path
is a directory. -
.exist?(path) ⇒ TrueClass, FalseClass
Checks if
path
exist. -
.inject_line_after(path, target, contents) ⇒ Object
Inject
contents
inpath
aftertarget
. -
.inject_line_after_last(path, target, contents) ⇒ Object
Inject
contents
inpath
after lasttarget
. -
.inject_line_before(path, target, contents) ⇒ Object
Inject
contents
inpath
beforetarget
. -
.inject_line_before_last(path, target, contents) ⇒ Object
Inject
contents
inpath
after lasttarget
. -
.mkdir(path) ⇒ Object
Creates a directory for the given path.
-
.mkdir_p(path) ⇒ Object
Creates a directory for the given path.
-
.remove_block(path, target) ⇒ Object
Removes
target
block frompath
. -
.remove_line(path, target) ⇒ Object
Removes line from
path
, matchingtarget
. -
.replace_first_line(path, target, replacement) ⇒ Object
Replace first line in
path
that containstarget
withreplacement
. -
.replace_last_line(path, target, replacement) ⇒ Object
Replace last line in
path
that containstarget
withreplacement
. -
.touch(path) ⇒ Object
Creates an empty file for the given path.
-
.unshift(path, line) ⇒ Object
Adds a new line at the top of the file.
-
.write(path, *content) ⇒ Object
Creates a new file for the given path and content.
Class Method Details
.append(path, contents) ⇒ Object
Adds a new line at the bottom of the file
Source: | on GitHub
def self.append(path, contents) mkdir_p(path) content = ::File.readlines(path) content << "\n" if _append_newline?(content) content << "#{contents}\n" write(path, content) end |
.cp(source, destination) ⇒ Object
Copies source into destination. All the intermediate directories are created. If the destination already exists, it overrides the contents.
Source: | on GitHub
def self.cp(source, destination) mkdir_p(destination) FileUtils.cp(source, destination) end |
.delete(path) ⇒ Object
Deletes given path (file).
Source: | on GitHub
def self.delete(path) FileUtils.rm(path) end |
.delete_directory(path) ⇒ Object
Deletes given path (directory).
Source: | on GitHub
def self.delete_directory(path) FileUtils.remove_entry_secure(path) end |
.directory?(path) ⇒ TrueClass, FalseClass
Checks if path
is a directory
Source: | on GitHub
def self.directory?(path) File.directory?(path) end |
.exist?(path) ⇒ TrueClass, FalseClass
Checks if path
exist
Source: | on GitHub
def self.exist?(path) File.exist?(path) end |
.inject_line_after(path, target, contents) ⇒ Object
Inject contents
in path
after target
.
Source: | on GitHub
def self.inject_line_after(path, target, contents) _inject_line_after(path, target, contents, method(:index)) end |
.inject_line_after_last(path, target, contents) ⇒ Object
Inject contents
in path
after last target
.
Source: | on GitHub
def self.inject_line_after_last(path, target, contents) _inject_line_after(path, target, contents, method(:rindex)) end |
.inject_line_before(path, target, contents) ⇒ Object
Inject contents
in path
before target
.
Source: | on GitHub
def self.inject_line_before(path, target, contents) _inject_line_before(path, target, contents, method(:index)) end |
.inject_line_before_last(path, target, contents) ⇒ Object
Inject contents
in path
after last target
.
Source: | on GitHub
def self.inject_line_before_last(path, target, contents) _inject_line_before(path, target, contents, method(:rindex)) end |
.mkdir(path) ⇒ Object
Creates a directory for the given path. It assumes that all the tokens in path
are meant to be a directory. All the intermediate directories are created.
Source: | on GitHub
def self.mkdir(path) FileUtils.mkdir_p(path) end |
.mkdir_p(path) ⇒ Object
Creates a directory for the given path. It assumes that all the tokens, but the last, in path
are meant to be a directory, whereas the last is meant to be a file. All the intermediate directories are created.
Source: | on GitHub
def self.mkdir_p(path) Pathname.new(path).dirname.mkpath end |
.remove_block(path, target) ⇒ Object
Removes target
block from path
Source: | on GitHub
def self.remove_block(path, target) content = ::File.readlines(path) starting = index(content, path, target) line = content[starting] size = line[/\A[[:space:]]*/].bytesize closing = (" " * size) + (/{/.match?(target) ? "}" : "end") ending = starting + index(content[starting..], path, closing) content.slice!(starting..ending) write(path, content) remove_block(path, target) if match?(content, target) end |
.remove_line(path, target) ⇒ Object
Removes line from path
, matching target
.
Source: | on GitHub
def self.remove_line(path, target) content = ::File.readlines(path) i = index(content, path, target) content.delete_at(i) write(path, content) end |
.replace_first_line(path, target, replacement) ⇒ Object
Replace first line in path
that contains target
with replacement
.
Source: | on GitHub
def self.replace_first_line(path, target, replacement) content = ::File.readlines(path) content[index(content, path, target)] = "#{replacement}\n" write(path, content) end |
.replace_last_line(path, target, replacement) ⇒ Object
Replace last line in path
that contains target
with replacement
.
Source: | on GitHub
def self.replace_last_line(path, target, replacement) content = ::File.readlines(path) content[-index(content.reverse, path, target) - 1] = "#{replacement}\n" write(path, content) end |
.touch(path) ⇒ Object
Creates an empty file for the given path. All the intermediate directories are created. If the path already exists, it doesn’t change the contents
Source: | on GitHub
def self.touch(path) mkdir_p(path) FileUtils.touch(path) end |
.unshift(path, line) ⇒ Object
Adds a new line at the top of the file
Source: | on GitHub
def self.unshift(path, line) content = ::File.readlines(path) content.unshift("#{line}\n") write(path, content) end |
.write(path, *content) ⇒ Object
Creates a new file for the given path and content. All the intermediate directories are created.
Source: | on GitHub
def self.write(path, *content) mkdir_p(path) open(path, ::File::CREAT | ::File::WRONLY | ::File::TRUNC, *content) # rubocop:disable Security/Open - this isn't a call to `::Kernel.open`, but to `self.open` end |