string_placeholder_replacer.rb 996 Bytes
Newer Older
1 2
# frozen_string_literal: true

3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
module Gitlab
  class StringPlaceholderReplacer
    # This method accepts the following paras
    # - string: the string to be analyzed
    # - placeholder_regex: i.e. /%{project_path|project_id|default_branch|commit_sha}/
    # - block: this block will be called with each placeholder found in the string using
    # the placeholder regex. If the result of the block is nil, the original
    # placeholder will be returned.

    def self.replace_string_placeholders(string, placeholder_regex = nil, &block)
      return string if string.blank? || placeholder_regex.blank? || !block_given?

      replace_placeholders(string, placeholder_regex, &block)
    end

    class << self
      private

      # If the result of the block is nil, then the placeholder is returned
      def replace_placeholders(string, placeholder_regex, &block)
        string.gsub(/%{(#{placeholder_regex})}/) do |arg|
          yield($~[1]) || arg
        end
      end
    end
  end
end