Pular para o conteúdo

Leitura de repositórios

Ver como Markdown Editar no GitHub Documentação em bfe242f

Pitmaster lê repositórios git analisando diretamente os formatos no disco: objetos soltos (arquivos compactados com zlib em .git/objects/), arquivos pack (.git/objects/pack/), refs (arquivos em .git/refs/ e packed-refs) e o índice (.git/index).

Abrindo um repositório

PHP
use Pitmaster\Pitmaster;

$repo = Pitmaster::open('/path/to/project');

Pitmaster é compatível com três layouts de repositório:

  1. Repositórios regulares: .git é um diretório na raiz do projeto.
  2. Árvores de trabalho vinculadas: .git é um arquivo que contém gitdir: <path> apontando para .git/worktrees/<name>/.
  3. Repositórios bare: o próprio caminho contém HEAD, objects/ etc.
PHP
// Detection helpers
Pitmaster::isRepository('/path');  // true for any of the above
Pitmaster::isWorktree('/path');    // true only for linked worktrees

Lendo objetos

Cada dado em um repositório git é armazenado como um objeto identificado pelo próprio hash: SHA-1 (40 caracteres hexadecimais) por padrão ou SHA-256 (64 caracteres hexadecimais) em repositórios criados com Pitmaster::init($path, 'sha256'). Há quatro tipos de objeto: blob, árvore, commit e tag.

Os métodos baseados em hash abaixo exigem o hash hexadecimal completo; hashes abreviados não são aceitos.

readObject

PHP
use Pitmaster\Object\Blob;
use Pitmaster\Object\Tree;
use Pitmaster\Object\Commit;
use Pitmaster\Object\Tag;

$object = $repo->readObject('a1b2c3d4e5f6...');

match (true) {
    $object instanceof Blob   => handleBlob($object),
    $object instanceof Tree   => handleTree($object),
    $object instanceof Commit => handleCommit($object),
    $object instanceof Tag    => handleTag($object),
};

Os objetos são pesquisados primeiro no armazenamento solto e depois nos arquivos pack. As consultas em arquivos pack usam a tabela de dispersão .idx para pesquisa binária em O(log n).

catFile

Para recuperar conteúdo sem verificar o tipo:

PHP
$content = $repo->catFile('a1b2c3d4e5f6...');
echo $content;

objectExists

PHP
if ($repo->objectExists('a1b2c3d4e5f6...')) {
    // Object is in the repository
}

listObjects

PHP
$hashes = $repo->listObjects();
// ['a1b2c3d4...', 'f6e5d4c3...', ...]

Retorna hashes hexadecimais de todos os objetos (soltos e empacotados).

Trabalhando com blobs

Um blob contém conteúdo bruto de arquivo.

PHP
$blob = $repo->readObject($hash);
echo $blob->content;     // Raw file bytes
echo $blob->size();      // Content length
echo $blob->id->hex;     // Object hash

Trabalhando com árvores

Uma árvore é uma listagem de diretório. Cada entrada tem um modo, nome e hash.

PHP
$tree = $repo->readObject($hash);

foreach ($tree->entries as $entry) {
    echo "{$entry->mode} {$entry->name} {$entry->hash->hex}\n";
    // 100644 README.md abc123...
    // 40000 src def456...
    // 100755 deploy.sh 789012...

    if ($entry->isTree()) {
        // Recurse into subdirectory (mode 40000)
    } elseif ($entry->isExecutable()) {
        // Executable file (mode 100755)
    } elseif ($entry->isBlob()) {
        // Regular file (any 10xxxx mode, so executables match too)
    } elseif ($entry->isSymlink()) {
        // Symbolic link (mode 120000)
    } elseif ($entry->isGitlink()) {
        // Submodule (mode 160000)
    }
}

Trabalhando com commits

Um commit vincula um instantâneo da árvore aos pais e aos metadados.

PHP
$commit = $repo->head();

echo $commit->id->hex;      // Full object hash
echo $commit->tree->hex;    // Tree object hash
echo $commit->author;       // "Name <email> timestamp tz"
echo $commit->committer;    // "Name <email> timestamp tz"
echo $commit->message;      // Full commit message

// Parent commits
foreach ($commit->parents as $parentId) {
    $parent = $repo->readObject($parentId->hex);
}

// Merge detection
if ($commit->isMerge()) {
    // Two or more parents
}

Trabalhando com tags

Tags anotadas são objetos com um destino, tipo, nome, criador da tag e mensagem.

PHP
$tag = $repo->readObject($hash);

echo $tag->object->hex;           // Target object hash
echo $tag->objectType->value;     // 'commit', 'tree', 'blob', or 'tag'
echo $tag->name;            // Tag name
echo $tag->tagger;          // "Name <email> timestamp tz"
echo $tag->message;         // Tag message

Lendo refs

HEAD atual

PHP
$commit = $repo->head();

Resolve o HEAD (seguindo refs simbólicas como HEAD -> refs/heads/main -> commit hash) e retorna o objeto de commit.

Branch atual

PHP
$branch = $repo->branch();  // 'main' or null if detached

Listando branches e tags

PHP
$branches = $repo->branches();  // ['bugfix/typo', 'feature/login', 'main']
$tags = $repo->tags();          // ['v1.0.0', 'v1.1.0']

Todas as refs

PHP
$refs = $repo->allRefs();
// [
//     'refs/heads/main' => 'abc123...',
//     'refs/heads/feature' => 'def456...',
//     'refs/tags/v1.0.0' => '789012...',
//     'refs/remotes/origin/main' => 'abc123...',
// ]

Resolvendo revisões

PHP
$id = $repo->resolve('HEAD');
$id = $repo->resolve('main');
$id = $repo->resolve('v1.0.0');
$id = $repo->resolve('HEAD~3');
$id = $repo->resolve('main^2');
$id = $repo->resolve('3f2c1e0b9d6a4f8e7c5b2a1d0e9f8c7b6a5d4e3f');

O analisador de revisões aceita os operadores ~N (ancestral) e ^N (pai), combinados sem limite. Os hashes devem ser informados completos.

Percorrendo o histórico de commits

log

Os commits são retornados do mais recente para o mais antigo, ordenados pelo registro de data e hora do committer.

PHP
// Last 20 commits from HEAD
$commits = $repo->log(20);

foreach ($commits as $commit) {
    $short = substr($commit->id->hex, 0, 7);
    echo "{$short} {$commit->message}\n";
}

log a partir de um commit específico

PHP
$from = $repo->resolve('feature/login');
$commits = $repo->log(10, $from);

log filtrado por caminho de arquivo

PHP
$commits = $repo->logPath('src/Repository.php', 20);

Retorna apenas commits em que o arquivo especificado foi alterado (adicionado, modificado, excluído ou renomeado) em comparação com o primeiro pai. O caminho deve corresponder exatamente ao arquivo; diretórios não correspondem. Apenas os 5 * $limit commits mais recentes são examinados, então correspondências mais antigas podem não aparecer (#7).

show

PHP
$result = $repo->show('HEAD');
$commit = $result['commit'];
$diffs = $result['diff'];

echo "Author: {$commit->author}\n";
echo "Message: {$commit->message}\n\n";

foreach ($diffs as $diff) {
    echo $diff->format();
}

Detecção da branch padrão

PHP
$default = $repo->defaultBranch();
// Checks: remote HEAD symref -> local HEAD -> main/master fallback

Quando remote.origin.url está definido e os processos estão habilitados, a primeira verificação faz uma solicitação inteligente de HTTP ao remoto. Erros de rede são ignorados e as verificações locais são realizadas em seguida.

Ancestralidade de mesclagem

PHP
// Is feature fully merged into main?
$merged = $repo->isBranchMerged('feature/done', 'main');

// Find the merge base of two commits
$base = $repo->mergeBase(
    $repo->resolve('main'),
    $repo->resolve('feature/login'),
);