module Git::Parsers::Remote

Parser that builds {Git::RemoteInfo} objects from git config entries

Accepts ‘Array<Git::ConfigEntryInfo>` as returned by {Git::Configuring#config_list} and groups entries by remote name, collecting multi-value fields and coercing boolean values.

@api private

Constants

ARRAY_VARIABLES

Config variable names that hold arrays of strings

BOOLEAN_VARIABLES

Config variable names that hold boolean values

BOOL_FALSE_VALUES

False string values per git’s boolean rules

BOOL_TRUE_VALUES

True string values per git’s boolean rules

VARIABLE_TO_FIELD

Map from git config variable name to RemoteInfo field name (symbol)

All keys are lowercase because ‘git config –list` unconditionally lowercases section names and variable names (subsection names are case-preserved, but are never used as lookup keys here).

Public Instance Methods

apply_pair (attrs, variable, value)

Source

# File lib/git/parsers/remote.rb, line 126
def apply_pair(attrs, variable, value)
  field = VARIABLE_TO_FIELD[variable]
  return unless field # ignore unknown variables

  if ARRAY_VARIABLES.include?(variable)
    attrs[field] ||= []
    attrs[field] << value
  elsif BOOLEAN_VARIABLES.include?(variable)
    attrs[field] = coerce_boolean(variable, value)
  else
    attrs[field] = value
  end
end

Apply a single variable/value pair to an attrs hash

@param attrs [Hash] accumulator of RemoteInfo keyword arguments

@param variable [String] git config variable name (e.g. ‘url’, ‘tagopt’)

@param value [String] raw config value

@return [void]

@api private

build_remote_info (remote_name, pairs)

Source

# File lib/git/parsers/remote.rb, line 108
def build_remote_info(remote_name, pairs)
  attrs = { name: remote_name }
  pairs.each { |variable, value| apply_pair(attrs, variable, value) }
  Git::RemoteInfo.new(**attrs)
end

Build a RemoteInfo from grouped variable/value pairs

@param remote_name [String]

@param pairs [Array] variable/value pairs collected from config entries

@return [Git::RemoteInfo]

@api private

coerce_boolean (variable, value)

Source

# File lib/git/parsers/remote.rb, line 152
def coerce_boolean(variable, value)
  normalized = value.downcase
  return true  if BOOL_TRUE_VALUES.include?(normalized) || normalized == ''
  return false if BOOL_FALSE_VALUES.include?(normalized)

  raise ArgumentError,
        "unrecognized boolean value #{value.inspect} for config variable #{variable.inspect}"
end

Coerce a git config boolean string to a Ruby boolean

@param variable [String] the config variable name (for error messages)

@param value [String] the raw string value from git config

@return [Boolean] ‘true` or `false`

@raise [ArgumentError] if the value is not a recognized boolean

@api private

group_by_remote (config_entries)

Source

# File lib/git/parsers/remote.rb, line 48
def group_by_remote(config_entries)
  config_entries.each_with_object({}) do |entry, groups|
    next unless entry.section == 'remote' && !entry.subsection.empty?

    remote_name = entry.subsection
    variable    = entry.variable.downcase
    groups[remote_name] ||= []
    groups[remote_name] << [variable, entry.value]
  end
end

Group config entries by remote name, collecting variable/value pairs

@param config_entries [Array<Git::ConfigEntryInfo>]

@return [Hash{String => Array}] remote name to variable/value pairs

@api private

parse_list (config_entries)

Source

# File lib/git/parsers/remote.rb, line 36
def parse_list(config_entries)
  group_by_remote(config_entries).map { |name, pairs| build_remote_info(name, pairs) }
end

Parse an array of config entries into an array of RemoteInfo objects

Groups entries whose key matches ‘remote.<name>.<variable>` by remote name and builds one {Git::RemoteInfo} per unique remote name.

Non-remote config entries (keys that do not start with ‘remote.`) are silently ignored.

@param config_entries [Array<Git::ConfigEntryInfo>] all config entries

to inspect; may contain non-remote entries

@return [Array<Git::RemoteInfo>] one entry per unique remote name, in

the order the first entry for each name appeared in `config_entries`

@raise [ArgumentError] if a boolean config field carries an unrecognized

value (mirrors git's own fatal-error behavior)