Class: StringInreplaceExtension Private

Inherits:
Object
  • Object
show all
Extended by:
T::Sig
Defined in:
utils/string_inreplace_extension.rb

Overview

This class is part of a private API. This class may only be used in the Homebrew/brew repository. Third parties should avoid using this class if possible, as it may be removed or changed without warning.

Used by the inreplace function (in utils.rb).

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(string) ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:



13
14
15
16
# File 'utils/string_inreplace_extension.rb', line 13

def initialize(string)
  @inreplace_string = string
  @errors = []
end

Instance Attribute Details

#errorsObject

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



10
11
12
# File 'utils/string_inreplace_extension.rb', line 10

def errors
  @errors
end

#inreplace_stringObject

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



10
11
12
# File 'utils/string_inreplace_extension.rb', line 10

def inreplace_string
  @inreplace_string
end

Instance Method Details

#change_make_var!(flag, new_value) ⇒ void

This method returns an undefined value.

Looks for Makefile style variable definitions and replaces the value with “new_value”, or removes the definition entirely.

Parameters:



46
47
48
49
50
# File 'utils/string_inreplace_extension.rb', line 46

def change_make_var!(flag, new_value)
  return if gsub!(/^#{Regexp.escape(flag)}[ \t]*[\\?+:!]?=[ \t]*((?:.*\\\n)*.*)$/, "#{flag}=#{new_value}", false)

  errors << "expected to change #{flag.inspect} to #{new_value.inspect}"
end

#get_make_var(flag) ⇒ String

Finds the specified variable.

Parameters:

Returns:



69
70
71
# File 'utils/string_inreplace_extension.rb', line 69

def get_make_var(flag)
  inreplace_string[/^#{Regexp.escape(flag)}[ \t]*[\\?+:!]?=[ \t]*((?:.*\\\n)*.*)$/, 1]
end

#gsub!(before, after, audit_result = true) ⇒ String?

Same as String#gsub!, but warns if nothing was replaced.

Parameters:

  • before (Regexp, String)
  • after (String, nil)
  • audit_result (Boolean) (defaults to: true)

Returns:



35
36
37
38
39
# File 'utils/string_inreplace_extension.rb', line 35

def gsub!(before, after, audit_result = true) # rubocop:disable Style/OptionalBooleanParameter
  result = inreplace_string.gsub!(before, after)
  errors << "expected replacement of #{before.inspect} with #{after.inspect}" if audit_result && result.nil?
  result
end

#remove_make_var!(flags) ⇒ void

This method returns an undefined value.

Removes variable assignments completely.

Parameters:



56
57
58
59
60
61
62
63
# File 'utils/string_inreplace_extension.rb', line 56

def remove_make_var!(flags)
  Array(flags).each do |flag|
    # Also remove trailing \n, if present.
    unless gsub!(/^#{Regexp.escape(flag)}[ \t]*[\\?+:!]?=(?:.*\\\n)*.*$\n?/, "", false)
      errors << "expected to remove #{flag.inspect}"
    end
  end
end

#sub!(before, after) ⇒ String?

Same as String#sub!, but warns if nothing was replaced.

Parameters:

Returns:



22
23
24
25
26
# File 'utils/string_inreplace_extension.rb', line 22

def sub!(before, after)
  result = inreplace_string.sub!(before, after)
  errors << "expected replacement of #{before.inspect} with #{after.inspect}" unless result
  result
end