module Git::Repository::Staging::Private

deprecate_clean_option (key, message, opts)

Source

# File lib/git/repository/staging.rb, line 476
def deprecate_clean_option(key, message, opts)
  return opts unless opts.key?(key)

  opts = opts.dup
  deprecated_value = opts.delete(key)
  validate_deprecated_clean_option_value!(key, deprecated_value)

  Git::Deprecation.warn(message)
  return opts unless deprecated_value

  opts[:force] = merge_clean_force_option(opts[:force], force_specified: force_option_specified?(opts))
  opts
end

Translate a single deprecated clean option key onto ‘:force`

@param key [Symbol] the deprecated option key (‘:ff` or `:force_force`)

@param message [String] the deprecation message to emit

@param opts [Hash] the clean options

@option opts [Boolean, nil] :ff (nil) deprecated alias for requesting a

double-force clean

@option opts [Boolean, nil] :force_force (nil) deprecated alias for

requesting a double-force clean

@option opts [Boolean, Integer, nil] :force (nil) existing force value

updated when the deprecated key is true

@return [Hash] a new options hash with the deprecated key removed

@raise [ArgumentError] when the deprecated value is not ‘true`, `false`,

or `nil`

force_option_specified? (opts)

Source

# File lib/git/repository/staging.rb, line 500
def force_option_specified?(opts)
  opts.key?(:force) && !opts[:force].nil?
end

Whether the caller explicitly set a non-nil ‘:force` value

@param opts [Hash] the clean options

@option opts [Boolean, Integer, nil] :force (nil) the clean force value

to inspect

@return [Boolean] true if ‘:force` was set to a non-nil value, false

otherwise

merge_clean_force_option (existing_force, force_specified: false)

Source

# File lib/git/repository/staging.rb, line 528
def merge_clean_force_option(existing_force, force_specified: false)
  return 2 unless force_specified

  normalized_force = normalize_clean_force_option(existing_force)

  case normalized_force
  when Integer then merge_integer_clean_force_option(normalized_force)
  when false then 2
  else normalized_force
  end
end

Merge a deprecated force request into the existing ‘:force` value

@param existing_force [Boolean, Integer, nil] the caller’s ‘:force` value

@param force_specified [Boolean] whether the caller explicitly set ‘:force`

@return [Integer] the resolved ‘:force` value

merge_integer_clean_force_option (normalized_force)

Source

# File lib/git/repository/staging.rb, line 546
def merge_integer_clean_force_option(normalized_force)
  return normalized_force if normalized_force < 1

  [normalized_force, 2].max
end

Merge an integer ‘:force` value with the deprecated force request

@param normalized_force [Integer] the caller’s normalized ‘:force` value

@return [Integer] the resolved ‘:force` value

migrate_clean_legacy_options (opts)

Source

# File lib/git/repository/staging.rb, line 440
def migrate_clean_legacy_options(opts)
  opts = deprecate_clean_option(
    :ff,
    ':ff option is deprecated and will be removed in v6.0.0. Use force: 2 instead.',
    opts
  )

  deprecate_clean_option(
    :force_force,
    ':force_force option is deprecated and will be removed in v6.0.0. Use force: 2 instead.',
    opts
  )
end

Translate deprecated ‘git clean` option keys into their modern form

Maps the legacy ‘:ff` and `:force_force` boolean options onto the `:force` option, emitting a deprecation warning for each.

@param opts [Hash] the caller-provided clean options

@option opts [Boolean, nil] :ff (nil) deprecated alias for requesting a

double-force clean

@option opts [Boolean, nil] :force_force (nil) deprecated alias for

requesting a double-force clean

@option opts [Boolean, Integer, nil] :force (nil) existing force value

merged with deprecated options when present

@return [Hash] a new options hash with deprecated keys translated

@raise [ArgumentError] when a deprecated value is not ‘true`, `false`, or `nil`

normalize_clean_force_option (value)

Source

# File lib/git/repository/staging.rb, line 558
def normalize_clean_force_option(value)
  case value
  when true then 1
  else value
  end
end

Normalize a ‘:force` value, coercing `true` to the integer `1`

@param value [Boolean, Integer, nil] the ‘:force` value

@return [Integer, Boolean, nil] the normalized value

unescape_quoted_path (path)

Source

# File lib/git/repository/staging.rb, line 575
def unescape_quoted_path(path)
  if path.start_with?('"') && path.end_with?('"')
    Git::EscapedPath.new(path[1..-2]).unescape
  else
    path
  end
end

Unescape a git-quoted path

Git wraps paths containing non-ASCII or special characters in double-quotes and octal-escapes each byte. This method strips the surrounding quotes and delegates unescaping to {Git::EscapedPath}.

@param path [String] the path as it appears in git output

@return [String] the unescaped path

validate_deprecated_clean_option_value! (key, value)

Source

# File lib/git/repository/staging.rb, line 514
def validate_deprecated_clean_option_value!(key, value)
  return if value.nil? || value == true || value == false

  raise ArgumentError, "#{key} option only accepts true, false, or nil"
end

Validate the value passed to a deprecated clean option

@param key [Symbol] the deprecated option key

@param value [Object] the value provided for the deprecated key

@return [void]

@raise [ArgumentError] when ‘value` is not `true`, `false`, or `nil`