Gitility.Repository (Gitility v0.3.0)

A repository is just an ODB plus an optional RefDB.

It exists to resolve selectors — names for commits — into pinned Gitility.Snapshots. Nothing else in the library takes a repository: every query takes a snapshot, and a snapshot needs only an ODB and a commit ID.

Selectors

Safe selectors resolve a name through the repository's stores:

{:oid, oid_or_hex}       # no refs needed
{:ref, "refs/pull/481/head"}
{:branch, "main"}        # expands to refs/heads/main
{:tag, "v1.2.0"}         # expands to refs/tags/…, peels annotated tags
:head

{:revspec, string} is reserved for a future opt-in advanced selector. Gitility 0.x always rejects it with :unsupported_operation.

Summary

Types

selector()

A commit selector — see the moduledoc.

t()

A repository handle: object store plus optional ref store.

Functions

from_stores(stores)

Composes independently-created stores into a repository. The stores must share a runtime (:runtime_mismatch otherwise).

open(path, opts \\ [])

Opens a local repository directory — bare or normal, though queries never read worktree files either way.

snapshot(repo, selector, opts \\ [])

Resolves a selector and pins it as an immutable snapshot.

Types

selector()

@type selector() ::
  {:oid, Gitility.OID.t() | String.t()}
  | {:ref, binary()}
  | {:branch, binary()}
  | {:tag, binary()}
  | :head
  | {:revspec, String.t()}

A commit selector — see the moduledoc.

t()

@type t() :: %Gitility.Repository{
  odb: Gitility.ODB.t(),
  ref_error: Gitility.Error.t() | nil,
  refs: Gitility.RefDB.t() | nil
}

A repository handle: object store plus optional ref store.

Functions

from_stores(stores)

@spec from_stores(keyword()) :: {:ok, t()} | {:error, Gitility.Error.t()}

Composes independently-created stores into a repository. The stores must share a runtime (:runtime_mismatch otherwise).

Store identity is otherwise deliberately not compared. Cross-repository composition — for example, refs from one repository with an ODB from another — is the caller's responsibility and is not detected by Gitility.

Options

:odb (required) — a Gitility.ODB handle.
:refs — a Gitility.RefDB handle; omit for an ODB-only repository (only {:oid, _} selectors will resolve).

open(path, opts \\ [])

@spec open(
  Path.t(),
  keyword()
) :: {:ok, t()} | {:error, Gitility.Error.t()}

Opens a local repository directory — bare or normal, though queries never read worktree files either way.

Options

:require_bare — reject a non-bare repository (default false).
:object_cache_bytes — native object cache ceiling (default 64 MiB).
:verify_pack_checksums — deep-check pack and index checksums before the first object read (default false).
:runtime — the Gitility.Runtime to attach to (default: shared).

Example

{:ok, repo} =
  Gitility.Repository.open("/srv/git/acme/widgets.git", require_bare: true)

{:ok, snapshot} = Gitility.Repository.snapshot(repo, {:branch, "main"})

snapshot(repo, selector, opts \\ [])

@spec snapshot(t(), selector(), keyword()) ::
  {:ok, Gitility.Snapshot.t()} | {:error, Gitility.Error.t()}

Resolves a selector and pins it as an immutable snapshot.

Resolution happens once, here: the returned snapshot records the commit and root tree IDs and never moves, no matter what the underlying refs do afterwards.