jQuery Merge for php-diff

A client side merge tool for Chris Boultons PHP DIFF. Example

Version

0.2.2

THIS IS A BETA RELEASE!
I had not the time to test this very much so if you rely on this script blindly you may get some unexpected results.
You may help me write some tests to be able to check things better.

Usage

This tool requires a side-by-side or inline diff from php-diff and the full content of the compared files as a line-by-line array.

I use something like this on the server side. Also have a look at the the php-diff examples.

$left = explode("\n", preg_replace('/\r\n|\r/', "\n", $THECONTENTOFFILE_A));
$right = explode("\n", preg_replace('/\r\n|\r/', "\n", $THECONTENTOFFILE_B));

$options = array(
    //'ignoreWhitespace' => true,
    //'ignoreCase' => true,
);

/* Initialize the diff class */
$Diff = new \Diff($left, $right, $options);

/* Initiate the SideBySide or Inline Html renderer */
$Renderer = new \Diff_Renderer_Html_SideBySide;
// $Renderer = new \Diff_Renderer_Html_Inline;

/* Render the Diff-table. */
echo $Diff->render($Renderer);

/* Pass $a and $b to javascript */
echo '<script type="text/javascript">var left='.json_encode($left).', right='.json_encode($right).';'</script>

And this as initiation on the client side. Have a look at this example.

$('.Differences').phpdiffmerge({
    left: left,
    right: right,
    merged: function(merge, left, right) {
    	/* Do something with the merge */
        $.post(
        	'ajax.php',
        	{
        		action: 'merge_completed',
        		merge: merge
        	},
        	function() {
        		console.log('done');
        	}
        );
    }
    /* Use your own "Merge now" button */
    // ,button: '#myButtonId'
    /* uncomment to see the complete merge in a pop-up window */
    // ,pupupResult: true
    /* uncomment to pass additional infos to the console. */
    // ,debug: true
});

Playground

I added an example folder. It should be pretty straight forward.
You have to run composer install inside it because i did not include the PHP DIFF Class itself.
There are a.txt and b.txt where you can change the compared files.
Inside the index.php you can change the DIFF Style from side-by-side to inline and play with the plugin-options.

Options

Can be set by passing an object into the initiation $('.Differences').phpdiffmerge({option: 'foo'});.
Or by passing an options object to an instance of PHPDiffMerge $('.Differences').phpdiffmerge('option', {option: 'bar'});.

left | string: ""
The full content of the left file as an JavaScript line-by-line array.

right | string: ""
The full content of the right file as an JavaScript line-by-line array.

merged | function: function(result, left, right) {}
A callback function that is called after the merge has completed.

button | mixed {optional}
A Selector or element that will be used as trigger for the final merge. If not set or invalid a button will be generated.

debug | boolean: false
Set true to log the steps made while merging into the console.

pupupResult | boolean: false
If true a pop-up window with the new merged content will be presented after merge.

pupupSources | boolean: false
If true two pup-up windows with the full left and right content will be presented after merge.

Methods

Called as string option on an instance: $('.Differences').phpdiffmerge('method', <arguments>);

useRight
Selects the right side of all conflicts.

useLeft
Selects the left side of all conflicts.

option Accepts an object, that will be extended into the current options.

merge The action called by the "Merge" Button

Support

Please use the github issue system to report bugs, feature request or just say hello :)
Keep in mind, that this plug-in is distributed without any warranty as described inside the LICENSE.

Special Thanks

To Chris Boulton for PHP-DIFF and mentioning my plugin in it's readme.
To Robert and Martin from jimdo.com for reviewing this plugin and giving me some verry useful hints.

Changelog

0.2.2

Add _id to PHPDiffMerge instances to make them comparable by QUnits deepEqual

0.2.1

bugfixes for multiline and inline issues
new example/sandbox

0.2

complete refactoring of the plugin structure.

0.1

initial release

Todo

write tests.
spellcheck please, im not native english as you may have noticed ;)

License

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

gufran / jquery-merge-for-php-diff Goto Github PK