Merge pull request #8 from wmde/psr4

Make Diff PSR-4 compliant

Aliases.php

@@ -0,0 +1,106 @@
+<?php
+
+// This is a IDE helper to understand class aliasing.
+// It should not be included anywhere.
+// Actual aliasing happens in the entry point using class_alias.
+
+namespace { throw new Exception( 'This code is not meant to be executed' ); }
+
+namespace Diff {
+
+	/**
+	 * @deprecated since 1.0, use the base class instead.
+	 */
+	class CallbackListDiffer extends Differ\CallbackListDiffer {}
+
+	/**
+	 * @deprecated since 1.0, use the base interface instead.
+	 */
+	interface Differ extends Differ\Differ {}
+
+	/**
+	 * @deprecated since 1.0, use the base class instead.
+	 */
+	class ListDiffer extends Differ\ListDiffer {}
+
+	/**
+	 * @deprecated since 1.0, use the base class instead.
+	 */
+	class MapDiffer extends Differ\MapDiffer {}
+
+	/**
+	 * @deprecated since 1.0, use the base class instead.
+	 */
+	class OrderedListDiffer extends Differ\OrderedListDiffer {}
+
+	/**
+	 * @deprecated since 1.0, use the base class instead.
+	 */
+	class ListPatcher extends Patcher\ListPatcher {}
+
+	/**
+	 * @deprecated since 1.0, use the base class instead.
+	 */
+	class MapPatcher extends Patcher\MapPatcher {}
+
+	/**
+	 * @deprecated since 1.0, use the base interface instead.
+	 */
+	interface Patcher extends Patcher\Patcher {}
+
+	/**
+	 * @deprecated since 1.0, use the base class instead.
+	 */
+	class PatcherException extends Patcher\PatcherException {}
+
+	/**
+	 * @deprecated since 1.0, use the base interface instead.
+	 */
+	interface PreviewablePatcher extends Patcher\PreviewablePatcher {}
+
+	/**
+	 * @deprecated since 1.0, use the base class instead.
+	 */
+	abstract class ThrowingPatcher extends Patcher\ThrowingPatcher {}
+
+	/**
+	 * @deprecated since 1.0, use the base class instead.
+	 */
+	class Diff extends DiffOp\Diff\Diff {}
+
+	/**
+	 * @deprecated since 1.0, use the base class instead.
+	 */
+	class ListDiff extends DiffOp\Diff\ListDiff {}
+
+	/**
+	 * @deprecated since 1.0, use the base class instead.
+	 */
+	class MapDiff extends DiffOp\Diff\MapDiff {}
+
+	/**
+	 * @deprecated since 1.0, use the base class instead.
+	 */
+	abstract class AtomicDiffOp extends DiffOp\AtomicDiffOp {}
+
+	/**
+	 * @deprecated since 1.0, use the base interface instead.
+	 */
+	interface DiffOp extends DiffOp\DiffOp {}
+
+	/**
+	 * @deprecated since 1.0, use the base class instead.
+	 */
+	class DiffOpAdd extends DiffOp\DiffOpAdd {}
+
+	/**
+	 * @deprecated since 1.0, use the base class instead.
+	 */
+	class DiffOpChange extends DiffOp\DiffOpChange {}
+
+	/**
+	 * @deprecated since 1.0, use the base class instead.
+	 */
+	class DiffOpRemove extends DiffOp\DiffOpRemove {}
+
+}

Diff.php

@@ -11,4 +11,31 @@
 	call_user_func( function() {
 		require_once __DIR__ . '/Diff.mw.php';
 	} );
-}
+}
+
+// Aliasing of classes that got renamed.
+// For more details, see Aliases.php.
+
+// Aliases introduced in 1.0
+class_alias( 'Diff\Differ\CallbackListDiffer', 'Diff\CallbackListDiffer' );
+class_alias( 'Diff\Differ\Differ', 'Diff\Differ' );
+class_alias( 'Diff\Differ\ListDiffer', 'Diff\ListDiffer' );
+class_alias( 'Diff\Differ\MapDiffer', 'Diff\MapDiffer' );
+class_alias( 'Diff\Differ\OrderedListDiffer', 'Diff\OrderedListDiffer' );
+
+class_alias( 'Diff\Patcher\ListPatcher', 'Diff\ListPatcher' );
+class_alias( 'Diff\Patcher\MapPatcher', 'Diff\MapPatcher' );
+class_alias( 'Diff\Patcher\Patcher', 'Diff\Patcher' );
+class_alias( 'Diff\Patcher\PatcherException', 'Diff\PatcherException' );
+class_alias( 'Diff\Patcher\PreviewablePatcher', 'Diff\PreviewablePatcher' );
+class_alias( 'Diff\Patcher\ThrowingPatcher', 'Diff\ThrowingPatcher' );
+
+class_alias( 'Diff\DiffOp\Diff\Diff', 'Diff\Diff' );
+class_alias( 'Diff\DiffOp\Diff\ListDiff', 'Diff\ListDiff' );
+class_alias( 'Diff\DiffOp\Diff\MapDiff', 'Diff\MapDiff' );
+
+class_alias( 'Diff\DiffOp\AtomicDiffOp', 'Diff\AtomicDiffOp' );
+class_alias( 'Diff\DiffOp\DiffOp', 'Diff\DiffOp' );
+class_alias( 'Diff\DiffOp\DiffOpAdd', 'Diff\DiffOpAdd' );
+class_alias( 'Diff\DiffOp\DiffOpChange', 'Diff\DiffOpChange' );
+class_alias( 'Diff\DiffOp\DiffOpRemove', 'Diff\DiffOpRemove' );

RELEASE-NOTES.md

@@ -5,10 +5,23 @@ Latest release:
 
 ## Version 1.0 (dev)
 
+#### Improvements
+
+* Diff is now PSR-4 compliant
+
 #### Compatibility breaks
 
+* Removed the Diff\IDiff interface (deprecated since 0.5)
+* Removed the Diff\IDiffOp interface (deprecated since 0.4)
 * Replaced custom autoloader with PSR-4 based loading via Composer
 
+#### Deprecations
+
+* The classes that got moved into other namespace now have their old names as deprecated aliases:
+	* All Differ classes that resided directly in the Diff namespace are now in Diff\Differ.
+	* All DiffOp classes that resided directly in the Diff namespace are now in Diff\DiffOp.
+	* All Patcher classes that resided directly in the Diff namespace are now in Diff\Patcher.
+
 ## Version 0.9 (2013-10-04)
 
 #### Additions

composer.json

@@ -31,13 +31,11 @@
 		],
 		"psr-4": {
 			"Diff\\": "src/"
-		},
-		"classmap": [
-			"src/differ/",
-			"src/diffop/",
-			"src/patcher/",
-			"tests/phpunit/diffop/DiffOpTest.php",
-			"tests/phpunit/DiffTestCase.php"
-		]
+		}
+	},
+	"extra": {
+		"branch-alias": {
+			"dev-master": "1.0.x-dev"
+		}
 	}
 }

src/diffop/AtomicDiffOp.php → src/DiffOp/AtomicDiffOp.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Diff;
+namespace Diff\DiffOp;
 
 /**
  * Base class for diff operations. A diff operation

src/diffop/diff/Diff.php → src/DiffOp/Diff/Diff.php

@@ -1,7 +1,11 @@
 <?php
 
-namespace Diff;
+namespace Diff\DiffOp\Diff;
 
+use Diff\DiffOp\DiffOp;
+use Diff\DiffOp\DiffOpAdd;
+use Diff\DiffOp\DiffOpChange;
+use Diff\DiffOp\DiffOpRemove;
 use InvalidArgumentException;
 
 /**
@@ -14,7 +18,7 @@
  * @author Jeroen De Dauw < [email protected] >
  * @author Daniel Kinzler
  */
-class Diff extends \ArrayObject implements IDiff {
+class Diff extends \ArrayObject implements DiffOp {
 
 	/**
 	 * @since 0.4
@@ -47,8 +51,6 @@ class Diff extends \ArrayObject implements IDiff {
 	protected $indexOffset = 0;
 
 	/**
-	 * @see Diff::__construct
-	 *
 	 * @since 0.1
 	 *
 	 * @param DiffOp[] $operations
@@ -82,7 +84,7 @@ public function __construct( array $operations = array(), $isAssociative = null
 	 * @return string
 	 */
 	private function getObjectType() {
-		return '\Diff\DiffOp';
+		return '\Diff\DiffOp\DiffOp';
 	}
 
 	/**
@@ -194,8 +196,6 @@ public function unserialize( $serialization ) {
 	}
 
 	/**
-	 * Returns the add operations.
-	 *
 	 * @since 0.1
 	 *
 	 * @return DiffOpAdd[]
@@ -205,8 +205,6 @@ public function getAdditions() {
 	}
 
 	/**
-	 * Returns the remove operations.
-	 *
 	 * @since 0.1
 	 *
 	 * @return DiffOpRemove[]

src/diffop/diff/ListDiff.php → src/DiffOp/Diff/ListDiff.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Diff;
+namespace Diff\DiffOp\Diff;
 
 /**
  * Class representing the diff between to (non-associative) arrays.

src/diffop/diff/MapDiff.php → src/DiffOp/Diff/MapDiff.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Diff;
+namespace Diff\DiffOp\Diff;
 
 /**
  * Class representing the diff between to (associative) arrays.

src/diffop/DiffOp.php → src/DiffOp/DiffOp.php

@@ -1,15 +1,13 @@
 <?php
 
-namespace Diff;
+namespace Diff\DiffOp;
 
 /**
  * Interface for diff operations. A diff operation
  * represents a change to a single element.
  * In case the elements are maps or diffs, the resulting operation
  * can be a MapDiff or ListDiff, which contain their own list of DiffOp objects.
  *
- * Softly deprecated (since 0.4), use Diff instead.
- *
  * @since 0.1
  *
  * @licence GNU GPL v2+
@@ -59,8 +57,3 @@ public function isAtomic();
 	public function toArray( $valueConverter = null );
 
 }
-
-/**
- * @deprecated since 0.4
- */
-interface IDiffOp extends DiffOp {}

src/diffop/DiffOpAdd.php → src/DiffOp/DiffOpAdd.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Diff;
+namespace Diff\DiffOp;
 
 /**
  * Represents an addition.

src/diffop/DiffOpChange.php → src/DiffOp/DiffOpChange.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Diff;
+namespace Diff\DiffOp;
 
 /**
  * Represents a change.

src/diffop/DiffOpRemove.php → src/DiffOp/DiffOpRemove.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Diff;
+namespace Diff\DiffOp;
 
 /**
  * Represents a removal.

src/DiffOpFactory.php

@@ -5,8 +5,6 @@
 use InvalidArgumentException;
 
 /**
- * Factory for constructing DiffOp objects.
- *
  * @since 0.5
  *
  * @licence GNU GPL v2+
@@ -35,7 +33,7 @@ public function __construct( $valueConverter = null ) {
 	/**
 	 * Returns an instance of DiffOp constructed from the provided array.
 	 *
-	 * This roundtripes with @see DiffOp::toArray.
+	 * This roundtrips with @see DiffOp::toArray.
 	 *
 	 * @since 0.5
 	 *
@@ -95,7 +93,6 @@ protected function assertHasKey( $key, array $diffOp ) {
 		}
 	}
 
-
 	/**
 	 * Converts an array structure to an object using the value converter callback function
 	 * provided to the constructor, if any.

src/differ/CallbackListDiffer.php → src/Differ/CallbackListDiffer.php

@@ -1,9 +1,10 @@
 <?php
 
-namespace Diff;
+namespace Diff\Differ;
 
 use Diff\ArrayComparer\StrategicArrayComparer;
 use Diff\Comparer\CallbackComparer;
+use Diff\DiffOp\DiffOp;
 
 /**
  * Differ that only looks at the values of the arrays (and thus ignores key differences).

src/differ/Differ.php → src/Differ/Differ.php

@@ -1,6 +1,8 @@
 <?php
 
-namespace Diff;
+namespace Diff\Differ;
+
+use Diff\DiffOp\DiffOp;
 
 /**
  * Interface for objects that can diff two arrays to an array of DiffOp.

src/differ/ListDiffer.php → src/Differ/ListDiffer.php

@@ -1,10 +1,13 @@
 <?php
 
-namespace Diff;
+namespace Diff\Differ;
 
 use Diff\ArrayComparer\ArrayComparer;
 use Diff\ArrayComparer\NativeArrayComparer;
 use Diff\ArrayComparer\StrictArrayComparer;
+use Diff\DiffOp\DiffOp;
+use Diff\DiffOp\DiffOpAdd;
+use Diff\DiffOp\DiffOpRemove;
 use InvalidArgumentException;
 
 /**

src/differ/MapDiffer.php → src/Differ/MapDiffer.php

@@ -1,7 +1,12 @@
 <?php
 
-namespace Diff;
+namespace Diff\Differ;
 
+use Diff\DiffOp\Diff\Diff;
+use Diff\DiffOp\DiffOp;
+use Diff\DiffOp\DiffOpAdd;
+use Diff\DiffOp\DiffOpChange;
+use Diff\DiffOp\DiffOpRemove;
 use Exception;
 use LogicException;