php merge

mesclagem de php

Introdução

Ao trabalhar com revisões de texto, às vezes enfrentamos o problema de haver várias revisões baseadas no mesmo texto original. Em vez de escolher uma e descartar a outra, queremos fundir as duas revisões.

Git já faz isso maravilhosamente. Em uma aplicação php queremos uma ferramenta simples que faça o mesmo. Existe a extensão xdiff PECL que possui a função xdiff_string_merge3. Mas xdiff_string_merge3 não se comporta da mesma maneira que git e xdiff pode não estar disponível em seu sistema.

PhpMerge é uma pequena biblioteca que resolve esse problema. Existem duas classes: PhpMergePhpMerge e PhpMergeGitMerge que implementam o PhpMergePhpMergeInterface que possui apenas um método de merge .

PhpMerge usa SebastianBergmannDiffDiffer para obter as diferenças entre as diferentes versões e calcula o texto mesclado a partir delas. GitMerge usa SymplifyGitWrapperGitWrapper , grava o texto em um arquivo temporário e usa a linha de comando git para mesclar o texto.

Uso

Exemplo simples:

 use PhpMerge  PhpMerge ;

// Create a merger instance.
$ merger = new PhpMerge ();

// Get the texts to merge.
$ original = <<<'EOD'
unchanged
replaced
unchanged
normal
unchanged
unchanged
removed

EOD;

$ version1 = <<<'EOD'
added
unchanged
replacement
unchanged
normal
unchanged
unchanged

EOD;

$ version2 = <<<'EOD'
unchanged
replaced
unchanged
normal??
unchanged
unchanged

EOD;

$ expected = <<<'EOD'
added
unchanged
replacement
unchanged
normal??
unchanged
unchanged

EOD;

$ result = $ merger -> merge ( $ original , $ version1 , $ version2 );
// $result === $expected;

Com conflitos de mesclagem:

 // Continuing from before with:
use Phpmerge  MergeException ;
use PhpMerge  MergeConflict ;


$ conflicting = <<<'EOD'
unchanged
replaced
unchanged
normal!!
unchanged
unchanged

EOD;

try {
    $ merger -> merge ( $ original , $ version2 , $ conflicting );
} catch ( MergeException $ exception ) {
    /** @var MergeConflict[] $conflicts */
    $ conflicts = $ exception -> getConflicts ();

    $ original_lines = $ conflicts [ 0 ]-> getBase ();
    // $original_lines === ["normaln"];
    
    $ version2_lines = $ conflicts [ 0 ]-> getRemote ();
    // $version2_lines === ["normal??n"];
    
    $ conflicting_lines = $ conflicts [ 0 ]-> getLocal ();
    // $conflicting_lines === ["normal!!n"];
    
    $ line_numer_of_conflict = $ conflicts [ 0 ]-> getBaseLine ();
    // $line_numer_of_conflict === 3; // Count starts with 0.
    
    // It is also possible to get the merged version using the first version
    // to resolve conflicts.
    $ merged = $ exception -> getMerged ();
    // $merged === $version2;
    // In this case, but in general there could be non-conflicting changes.
    
    $ line_in_merged = $ conflicts [ 0 ]-> getMergedLine ();
    // $line_in_merged === 3; // Count starts with 0.
}

Usando a linha de comando git para realizar a mesclagem:

 use PhpMerge  GitMerge ;

$ merger = new GitMerge ();

// Use as the previous example. 

Instalação

O PhpMerge pode ser instalado com o Composer adicionando a biblioteca como uma dependência ao seu arquivo compositor.json.

{
    "require" : {
        "bircher/php-merge" : " ~4.0 "
    }
}

Para usar a linha de comando git com GitMerge :

{
    "require" : {
        "bircher/php-merge" : " ~4.0 " ,
        "symplify/git-wrapper" : " ^9.1|^10.0 "
    }
}

Consulte a documentação do Composer para obter instruções de instalação e uso.

Diferença para ~3,0

Na versão ~ 4.0, mudamos de cpliakas/git-wrapper para symplify/git-wrapper pois o primeiro está obsoleto. Esta atualização significa que não há alterações ao usar apenas PhpMergePhpMerge .