96 lines
2.9 KiB
Ruby
96 lines
2.9 KiB
Ruby
# typed: true
|
|
# frozen_string_literal: true
|
|
|
|
require "utils/string_inreplace_extension"
|
|
|
|
module Utils
|
|
# Helper functions for replacing text in files in-place.
|
|
#
|
|
# @api private
|
|
module Inreplace
|
|
extend T::Sig
|
|
|
|
# Error during replacement.
|
|
class Error < RuntimeError
|
|
def initialize(errors)
|
|
formatted_errors = errors.reduce(+"inreplace failed\n") do |s, (path, errs)|
|
|
s << "#{path}:\n" << errs.map { |e| " #{e}\n" }.join
|
|
end
|
|
super formatted_errors.freeze
|
|
end
|
|
end
|
|
|
|
module_function
|
|
|
|
# Sometimes we have to change a bit before we install. Mostly we
|
|
# prefer a patch, but if you need the {Formula#prefix prefix} of
|
|
# this formula in the patch you have to resort to `inreplace`,
|
|
# because in the patch you don't have access to any variables
|
|
# defined by the formula, as only `HOMEBREW_PREFIX` is available
|
|
# in the {DATAPatch embedded patch}.
|
|
#
|
|
# `inreplace` supports regular expressions:
|
|
# <pre>inreplace "somefile.cfg", /look[for]what?/, "replace by #{bin}/tool"</pre>
|
|
#
|
|
# `inreplace` supports blocks:
|
|
# <pre>inreplace "Makefile" do |s|
|
|
# s.gsub! "/usr/local", HOMEBREW_PREFIX.to_s
|
|
# end
|
|
# </pre>
|
|
#
|
|
# @see StringInreplaceExtension
|
|
# @api public
|
|
sig {
|
|
params(
|
|
paths: T.any(T::Array[T.untyped], String, Pathname),
|
|
before: T.nilable(T.any(Regexp, String)),
|
|
after: T.nilable(T.any(String, Symbol)),
|
|
audit_result: T::Boolean,
|
|
).void
|
|
}
|
|
def inreplace(paths, before = nil, after = nil, audit_result = true) # rubocop:disable Style/OptionalBooleanParameter
|
|
after = after.to_s if after.is_a? Symbol
|
|
|
|
errors = {}
|
|
|
|
errors["`paths` (first) parameter"] = ["`paths` was empty"] if paths.blank?
|
|
|
|
Array(paths).each do |path|
|
|
str = File.open(path, "rb", &:read) || ""
|
|
s = StringInreplaceExtension.new(str)
|
|
|
|
if before.nil? && after.nil?
|
|
yield s
|
|
else
|
|
s.gsub!(T.must(before), after, audit_result)
|
|
end
|
|
|
|
errors[path] = s.errors unless s.errors.empty?
|
|
|
|
Pathname(path).atomic_write(s.inreplace_string)
|
|
end
|
|
|
|
raise Error, errors unless errors.empty?
|
|
end
|
|
|
|
# @api private
|
|
def inreplace_pairs(path, replacement_pairs, read_only_run: false, silent: false)
|
|
str = File.open(path, "rb", &:read) || ""
|
|
contents = StringInreplaceExtension.new(str)
|
|
replacement_pairs.each do |old, new|
|
|
ohai "replace #{old.inspect} with #{new.inspect}" unless silent
|
|
unless old
|
|
contents.errors << "No old value for new value #{new}! Did you pass the wrong arguments?"
|
|
next
|
|
end
|
|
|
|
contents.gsub!(old, new)
|
|
end
|
|
raise Error, path => contents.errors unless contents.errors.empty?
|
|
|
|
Pathname(path).atomic_write(contents.inreplace_string) unless read_only_run
|
|
contents.inreplace_string
|
|
end
|
|
end
|
|
end
|