Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bircher/php-merge

Php library to merge text. 3 way merge like git in php.
https://github.com/bircher/php-merge

3-way-merge composer git merge merge-text php php-library

Last synced: 9 days ago
JSON representation

Php library to merge text. 3 way merge like git in php.

Host: GitHub
URL: https://github.com/bircher/php-merge
Owner: bircher
License: mit
Created: 2015-11-28T17:20:20.000Z (almost 9 years ago)
Default Branch: 4.x
Last Pushed: 2022-01-04T21:09:51.000Z (almost 3 years ago)
Last Synced: 2024-10-15T14:32:18.215Z (21 days ago)
Topics: 3-way-merge, composer, git, merge, merge-text, php, php-library
Language: PHP
Homepage:
Size: 69.3 KB
Stars: 31
Watchers: 5
Forks: 5
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        # php-merge

[![Build Status](https://travis-ci.org/bircher/php-merge.svg?branch=master)](https://travis-ci.org/bircher/php-merge)

[![Coverage Status](https://coveralls.io/repos/github/bircher/php-merge/badge.svg?branch=master)](https://coveralls.io/github/bircher/php-merge?branch=master)

[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/bircher/php-merge/master/LICENSE.txt)

## Introduction

When working with revisions of text one sometimes faces the problem that there

are several revisions based off the same original text. Rather than choosing

one and discarding the other we want to merge the two revisions.

Git does that already wonderfully. In a php application we want a simple tool

that does the same. There is the [xdiff PECL extension](http://php.net/manual/en/book.xdiff.php)

which has the [xdiff_string_merge3](http://php.net/manual/en/function.xdiff-string-merge3.php)

function. But `xdiff_string_merge3` does not behave the same way as git and

xdiff may not be available on your system.

PhpMerge is a small library that solves this problem. There are two classes:

`\PhpMerge\PhpMerge` and `\PhpMerge\GitMerge` that implement the

`\PhpMerge\PhpMergeInterface` which has just a `merge` method.

`PhpMerge` uses `SebastianBergmann\Diff\Differ` to get the differences between

the different versions and calculates the merged text from it.

`GitMerge` uses `Symplify\GitWrapper\GitWrapper`, writes the text to a temporary file

and uses the command line git to merge the text.

## Usage

Simple example:

```php

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;

```

With merge conflicts:

```php

// 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 === ["normal\n"];

    

    $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.

}

```

Using the command line git to perform the merge:

```php

use PhpMerge\GitMerge;

$merger = new GitMerge();

// Use as the previous example.

```

## Installation

PhpMerge can be installed with [Composer](http://getcomposer.org) by adding

the library as a dependency to your composer.json file.

```json

{

    "require": {

        "bircher/php-merge": "~4.0"

    }

}

```

To use the command line git with `GitMerge`:

```json

{

    "require": {

        "bircher/php-merge": "~4.0",

        "symplify/git-wrapper": "^9.1|^10.0"

    }

}

```

Please refer to [Composer's documentation](https://github.com/composer/composer/blob/master/doc/00-intro.md#introduction)

for installation and usage instructions.

## Difference to ~3.0

In the ~4.0 version we switch from `cpliakas/git-wrapper` to `symplify/git-wrapper` since the former is deprecated.

This update means that there is no change when only using `PhpMerge\PhpMerge`.