class Git::Commands::ShowRef::Verify

Strict per-ref verification command via ‘git show-ref –verify`

Verifies that refs exist by their full canonical name (e.g. ‘refs/heads/main`, `refs/tags/v1.0`). Unlike {ShowRef::List}, partial name matching is not performed. Every named ref must start with `refs/` (or be `HEAD`); anything else will cause git to exit non-zero.

When a ref cannot be resolved, git exits 1 and this class raises {Git::FailedError}. This strict behaviour makes the class suitable for validating that refs are fully qualified.

For pattern-based listing, use {ShowRef::List}. For stdin-based filtering, use {ShowRef::ExcludeExisting}. For a silent boolean check (git >= 2.43), use {ShowRef::Exists}.

@example Verify a single ref

cmd = Git::Commands::ShowRef::Verify.new(execution_context)
result = cmd.call('refs/heads/main')
result.stdout  # => "abc1234 refs/heads/main\n"

@example Verify with hash-only output

cmd = Git::Commands::ShowRef::Verify.new(execution_context)
result = cmd.call('refs/heads/main', hash: true)
result.stdout  # => "abc1234\n"

@example Silent existence check

cmd = Git::Commands::ShowRef::Verify.new(execution_context)
cmd.call('refs/heads/main', quiet: true)  # raises FailedError if not found

@note ‘arguments` block audited against git-scm.com/docs/git-show-ref/2.53.0

@see Git::Commands::ShowRef

@see git-scm.com/docs/git-show-ref git-show-ref documentation

@api private

Public Instance Methods

call (*, **)

Source

# File lib/git/commands/show_ref/verify.rb, line 116
def call(*, **)
  super
end

@overload call(*ref, **options)

Execute `git show-ref --verify` to verify refs by their full name

@param ref [Array<String>] one or more fully-qualified ref names

  Each name must begin with `refs/` (or be `HEAD`). At least one is required.

@param options [Hash] command options

@option options [Boolean, nil] :quiet (nil) suppress all output

  Useful when you only care whether the ref exists.

  Alias: `:q`

@option options [Boolean, nil] :dereference (nil) dereference annotated tags,
  emitting an extra `^{}` line per tag

  Alias: `:d`

@option options [Boolean, Integer, nil] :hash (nil) show only the SHA part

  Pass `true` for full-length SHAs or an integer for abbreviation length.

  Alias: `:s`

@option options [Boolean, Integer, nil] :abbrev (nil) abbreviate object names

  Pass `true` for the default length or an integer for a specific length.

@option options [Numeric] :timeout (nil) abort the command after this many
  seconds

@return [Git::CommandLine::Result] the result of calling `git show-ref --verify`

@raise [ArgumentError] if unsupported options are provided

@raise [Git::FailedError] if git exits with a non-zero exit status

@api public

Calls superclass method Git::Commands::Base::call