Merge pull request #1 from Potherca/feature/v0.6.0/namespace-cleanup

Potherca · web-flow · commit 4d4e6193a5ff · 2018-01-24T09:00:51.000+01:00
Namespace cleanup.
diff --git a/example/CreateDataProviderExample.php b/example/CreateDataProviderExample.php
@@ -4,7 +4,7 @@
 
 class ExampleTest extends \PHPUnit\Framework\TestCase
 {
-    use \Potherca\PhpUnit\CreateDataProviderTrait;
+    use \Potherca\PhpUnit\Traits\CreateDataProviderTrait;
 
     /** @var array */
     private $values = array(
diff --git a/example/CreateObjectFromAbstractClassExample.php b/example/CreateObjectFromAbstractClassExample.php
@@ -14,7 +14,7 @@ public function sayName()
 
 class ExampleTest extends \PHPUnit\Framework\TestCase
 {
-    use \Potherca\PhpUnit\CreateObjectFromAbstractClassTrait;
+    use \Potherca\PhpUnit\Traits\CreateObjectFromAbstractClassTrait;
 
     const MOCK_VALUE = 'mock-value';
 
diff --git a/example/GetCompatibleExceptionNameExample.php b/example/GetCompatibleExceptionNameExample.php
@@ -11,7 +11,7 @@ abstract class AbstractTestCase extends \PHPUnit\Framework\TestCase {}
 
 class ExampleTest extends AbstractTestCase
 {
-    use \Potherca\PhpUnit\GetCompatibleExceptionNameTrait;
+    use \Potherca\PhpUnit\Traits\GetCompatibleExceptionNameTrait;
 
     public function testException()
     {
diff --git a/example/GetNonPublicPropertyExample.php b/example/GetNonPublicPropertyExample.php
@@ -14,7 +14,7 @@ public function __construct($name)
 
 class ExampleTest extends \PHPUnit\Framework\TestCase
 {
-    use \Potherca\PhpUnit\GetNonPublicPropertyTrait;
+    use \Potherca\PhpUnit\Traits\GetNonPublicPropertyTrait;
 
     const MOCK_VALUE = 'mock-value';
 
diff --git a/example/PHP5.3/CreateDataProviderExample.php b/example/PHP5.3/CreateDataProviderExample.php
@@ -7,7 +7,7 @@ class ExampleTest extends \PHPUnit\Framework\TestCase
     /**
      * As PHP5.3 does not support traits, __call is (a)bused instead of the trait.
      *
-     use \Potherca\PhpUnit\CreateDataProviderTrait;
+     use \Potherca\PhpUnit\Traits\CreateDataProviderTrait;
      *
      * @param string $name
      * @param array $parameters
diff --git a/example/PHP5.3/CreateObjectFromAbstractClassExample.php b/example/PHP5.3/CreateObjectFromAbstractClassExample.php
@@ -17,7 +17,7 @@ class ExampleTest extends \PHPUnit\Framework\TestCase
     /**
      * As PHP5.3 does not support traits, __call is (a)bused instead of the trait.
      *
-     use \Potherca\PhpUnit\CreateObjectFromAbstractClassTrait;
+     use \Potherca\PhpUnit\Traits\CreateObjectFromAbstractClassTrait;
      *
      * @param string $name
      * @param array $parameters
diff --git a/example/PHP5.3/GetCompatibleExceptionNameExample.php b/example/PHP5.3/GetCompatibleExceptionNameExample.php
@@ -14,7 +14,7 @@ class ExampleTest extends AbstractTestCase
     /**
      * As PHP5.3 does not support traits, __call is (a)bused instead of the trait.
      *
-     use \Potherca\PhpUnit\GetCompatibleExceptionNameTrait;
+     use \Potherca\PhpUnit\Traits\GetCompatibleExceptionNameTrait;
      *
      * @param string $name
      * @param array $parameters
diff --git a/example/PHP5.3/GetNonPublicPropertyExample.php b/example/PHP5.3/GetNonPublicPropertyExample.php
@@ -17,7 +17,7 @@ class ExampleTest extends \PHPUnit\Framework\TestCase
     /**
      * As PHP5.3 does not support traits, __call is (a)bused instead of the trait.
      *
-     use \Potherca\PhpUnit\GetNonPublicPropertyTrait;
+     use \Potherca\PhpUnit\Traits\GetNonPublicPropertyTrait;
      *
      * @param string $name
      * @param array $parameters
diff --git a/example/PHP5.3/SetNonPublicPropertyExample.php b/example/PHP5.3/SetNonPublicPropertyExample.php
@@ -17,7 +17,7 @@ class ExampleTest extends \PHPUnit\Framework\TestCase
     /**
      * As PHP5.3 does not support traits, __call is (a)bused instead of the trait.
      *
-     use \Potherca\PhpUnit\SetNonPublicPropertyTrait;
+     use \Potherca\PhpUnit\Traits\SetNonPublicPropertyTrait;
      *
      * @param string $name
      * @param array $parameters
diff --git a/example/SetNonPublicPropertyExample.php b/example/SetNonPublicPropertyExample.php
@@ -14,7 +14,7 @@ public function getName()
 
 class ExampleTest extends \PHPUnit\Framework\TestCase
 {
-    use \Potherca\PhpUnit\SetNonPublicPropertyTrait;
+    use \Potherca\PhpUnit\Traits\SetNonPublicPropertyTrait;
 
     const MOCK_VALUE = 'mock-value';
 
diff --git a/src/InvalidArgumentException.php b/src/InvalidArgumentException.php
@@ -0,0 +1,7 @@
+<?php
+
+namespace Potherca\PhpUnit;
+
+class InvalidArgumentException extends \InvalidArgumentException {}
+
+/*EOF*/
diff --git a/src/Shim/AbstractTraitShim.php b/src/Shim/AbstractTraitShim.php
@@ -2,6 +2,8 @@
 
 namespace Potherca\PhpUnit\Shim;
 
+use Potherca\PhpUnit\InvalidArgumentException;
+
 abstract class AbstractTraitShim implements TraitShimInterface
 {
     ////////////////////////////// CLASS PROPERTIES \\\\\\\\\\\\\\\\\\\\\\\\\\\\
@@ -24,7 +26,7 @@ public function getTestcase()
     /**
      * @param $testcase \PHPUnit\Framework\TestCase | \PHPUnit_Framework_TestCase
      *
-     * @throws \InvalidArgumentException
+     * @throws InvalidArgumentException
      */
     final public function __construct($testcase)
     {
@@ -45,7 +47,7 @@ final public function __construct($testcase)
                     $type,
                 )
             );
-            throw new \InvalidArgumentException($message);
+            throw new InvalidArgumentException($message);
         }
 
         $this->testcase = $testcase;
@@ -75,7 +77,7 @@ final public function __invoke(array $parameter)
      *
      * @return string
      *
-     * @throws \InvalidArgumentException
+     * @throws InvalidArgumentException
      */
     final public function getExistingClassName($class, $alternative = '')
     {
@@ -99,10 +101,10 @@ final public function getExistingClassName($class, $alternative = '')
 
             if ($alternative === '') {
                 $message = vsprintf(
-                    'Could not find class for "%". Both "%s" and "%s" do not exist',
+                    'Could not find class for "%s". Both "%s" and "%s" do not exist',
                     array($class, $nonNamespacedClass, $namespacedClass)
                 );
-                throw new \InvalidArgumentException($message);
+                throw new InvalidArgumentException($message);
             }
 
             $existingClass = $this->getExistingClassName($alternative);
diff --git a/src/Shim/GetCompatibleExceptionName.php b/src/Shim/GetCompatibleExceptionName.php
@@ -2,6 +2,8 @@
 
 namespace Potherca\PhpUnit\Shim;
 
+use Potherca\PhpUnit\InvalidArgumentException;
+
 /**
  * @TODO: Add support for `ArithmeticError`
  *
@@ -18,7 +20,7 @@ class GetCompatibleExceptionName extends AbstractTraitShim
      *
      * @return string
      *
-     * @throws \InvalidArgumentException
+     * @throws InvalidArgumentException
      * @throws \PHPUnit_Framework_Exception | \PHPUnit\Framework\Exception
      * @throws \PHPUnit_Framework_AssertionFailedError|\PHPUnit\Framework\AssertionFailedError
      * @throws \PHPUnit_Framework_SkippedTestError|\PHPUnit\Framework\SkippedTestError
@@ -29,7 +31,7 @@ final public function getCompatibleExceptionName($exceptionName)
 
         try {
             $exceptionName = $this->getExistingClassName($exceptionName);
-        } catch (\InvalidArgumentException $e) {
+        } catch (InvalidArgumentException $e) {
             // Not an existing class, needs conversion
         }
 
@@ -38,7 +40,7 @@ final public function getCompatibleExceptionName($exceptionName)
         if ($this->isPhpUnitExceptionNeeded($exceptionName) === false) {
             if ($exceptionName === 'DivisionByZeroError') {
                 $this->getTestcase()->expectExceptionMessage('Division by zero');
-                $matchingExceptionName = '\PHPUnit_Framework_Error_Warning';
+                $matchingExceptionName = '\\PHPUnit_Framework_Error_Warning';
             } else {
                 $matchingExceptionName = '\\'.$exceptionName;
             }
@@ -57,8 +59,8 @@ final public function getCompatibleExceptionName($exceptionName)
                 $exceptionName = $this->getMatchingExceptionName($exceptionName);
 
                 $alternative = '';
-                if ($exceptionName === '\PHPUnit_Framework_Error') {
-                    $alternative = 'PHPUnit\Framework\Error\Error';
+                if ($exceptionName === '\\PHPUnit_Framework_Error') {
+                    $alternative = 'PHPUnit\\Framework\\Error\\Error';
                 }
 
                 $matchingExceptionName = $this->getExistingClassName($exceptionName, $alternative);
@@ -93,16 +95,16 @@ private function getMatchingExceptionName($exceptionName)
     {
         $matchingExceptions = array(
             // PHP 7.0 thrown when an assertion made via assert() fails.
-            'AssertionError' => '\PHPUnit_Framework_Error_Warning',
+            'AssertionError' => '\\PHPUnit_Framework_Error_Warning',
             // PHP 7.0 thrown when an attempt is made to divide a number by zero.
-            'DivisionByZeroError' => '\PHPUnit_Framework_Error_Warning',
+            'DivisionByZeroError' => '\\PHPUnit_Framework_Error_Warning',
             // PHP 7.0 base class for all internal PHP errors.
-            'Error' => '\PHPUnit_Framework_Error',
+            'Error' => '\\PHPUnit_Framework_Error',
             // PHP 7.0 thrown in one of three circumstances:
             // - an argument type passed to a function does not match the declared parameter type.
             // - a value returned from a function does not match the declared return type.
             // - an invalid number of arguments are passed to a built-in PHP function (strict mode only).
-            'TypeError' => '\PHPUnit_Framework_Error',
+            'TypeError' => '\\PHPUnit_Framework_Error',
         );
 
         if (array_key_exists($exceptionName, $matchingExceptions) === false) {
diff --git a/src/Shim/GetNonPublicProperty.php b/src/Shim/GetNonPublicProperty.php
@@ -2,6 +2,8 @@
 
 namespace Potherca\PhpUnit\Shim;
 
+use Potherca\PhpUnit\InvalidArgumentException;
+
 class GetNonPublicProperty extends AbstractTraitShim
 {
 
@@ -18,7 +20,7 @@ class GetNonPublicProperty extends AbstractTraitShim
      *
      * @return mixed
      *
-     * @throws \InvalidArgumentException
+     * @throws InvalidArgumentException
      */
     final public function getNonPublicProperty($subject, $name)
     {
@@ -35,7 +37,7 @@ final public function getNonPublicProperty($subject, $name)
      *
      * @return \ReflectionProperty
      *
-     * @throws \InvalidArgumentException
+     * @throws InvalidArgumentException
      */
     final public function getPropertyFromObject($subject, $name)
     {
@@ -49,7 +51,7 @@ final public function getPropertyFromObject($subject, $name)
 
         if ($reflectionProperty === null) {
             $message = vsprintf('Could not find non-public property "%s" in "%s"', array($name, get_class($subject)));
-            throw new \InvalidArgumentException($message);
+            throw new InvalidArgumentException($message);
         }
 
         $reflectionProperty->setAccessible(true);
diff --git a/src/Shim/SetNonPublicProperty.php b/src/Shim/SetNonPublicProperty.php
@@ -2,6 +2,8 @@
 
 namespace Potherca\PhpUnit\Shim;
 
+use Potherca\PhpUnit\InvalidArgumentException;
+
 class SetNonPublicProperty extends GetNonPublicProperty
 {
     //////////////////////////////// PUBLIC API \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
@@ -15,7 +17,7 @@ class SetNonPublicProperty extends GetNonPublicProperty
      *
      * @return mixed
      *
-     * @throws \InvalidArgumentException
+     * @throws InvalidArgumentException
      */
     final public function setNonPublicProperty($subject, $name, $value)
     {
diff --git a/src/Shim/TraitShimInterface.php b/src/Shim/TraitShimInterface.php
@@ -2,6 +2,8 @@
 
 namespace Potherca\PhpUnit\Shim;
 
+use Potherca\PhpUnit\InvalidArgumentException;
+
 interface TraitShimInterface
 {
     /**
@@ -12,7 +14,7 @@ public function getTestcase();
     /**
      * @param $testcase \PHPUnit\Framework\TestCase | \PHPUnit_Framework_TestCase
      *
-     * @throws \InvalidArgumentException
+     * @throws InvalidArgumentException
      */
     public function __construct($testcase);
 
@@ -31,7 +33,7 @@ public function __invoke(array $parameter);
      *
      * @return string
      *
-     * @throws \InvalidArgumentException
+     * @throws InvalidArgumentException
      */
     public function getExistingClassName($class);
 }
diff --git a/src/Shim/Util.php b/src/Shim/Util.php
@@ -2,8 +2,13 @@
 
 namespace Potherca\PhpUnit\Shim;
 
+use Potherca\PhpUnit\InvalidArgumentException;
+
 class Util
 {
+    const NAMESPACE_PREFIX_LENGTH = 24; // = strlen('Potherca\\PhpUnit\\Traits\\');
+    const NAMESPACE_SUFFIX_LENGTH = -5; // = strlen('Trait');
+
     /**
      * Traits were not introduced until PHP5.4 so for older versions (i.e. PHP5.3)
      * this method loads the trait's functionality. This function should be called
@@ -26,7 +31,7 @@ class Util
      *
      * @return mixed
      *
-     * @throws \InvalidArgumentException
+     * @throws InvalidArgumentException
      */
     final public static function traitShim($testcase, $functionName, array $parameters)
     {
@@ -49,7 +54,7 @@ final public static function traitShim($testcase, $functionName, array $paramete
                     $type,
                 )
             );
-            throw new \InvalidArgumentException($message);
+            throw new InvalidArgumentException($message);
         }
 
         $traitShimClass =  __NAMESPACE__.'\\'.ucfirst($functionName);
@@ -95,7 +100,7 @@ final public static function traitShim($testcase, $functionName, array $paramete
      * @param string $methodName
      * @param string $traitName
      *
-     * @throws \InvalidArgumentException If no Shim class can be found for a given trait
+     * @throws InvalidArgumentException If no Shim class can be found for a given trait
      *
      * @return Callable
      */
@@ -125,9 +130,7 @@ final public static function createShimForTrait($testCase, $methodName, $traitNa
             } else {
                 // Only create shim class if native function does not exist
 
-                $start = strlen('Potherca\PhpUnit')+1;
-                $end = -5;  // 5 = "Trait"
-                $name = substr($traitName, $start, $end);
+                $name = substr($traitName, self::NAMESPACE_PREFIX_LENGTH, self::NAMESPACE_SUFFIX_LENGTH);
 
                 $shimClass = vsprintf('%s\\%s', array(__NAMESPACE__, $name));
 
@@ -142,7 +145,7 @@ final public static function createShimForTrait($testCase, $methodName, $traitNa
 
                 if (class_exists($shimClass) === false) {
                     $message = vsprintf('Could not find class "%s" to create for trait "%s"', array($shimClass, $traitName));
-                    throw new \InvalidArgumentException($message);
+                    throw new InvalidArgumentException($message);
                 }
 
                 $implements = class_implements($shimClass);
@@ -153,7 +156,7 @@ final public static function createShimForTrait($testCase, $methodName, $traitNa
                         'Found class "%s" for trait "%s" but it does not implement "%s"',
                         array($shimClass, $traitName, $interface)
                     );
-                    throw new \InvalidArgumentException($message);
+                    throw new InvalidArgumentException($message);
                 }
 
                 $class[$key] = new $shimClass($testCase);
diff --git a/src/Traits/CreateDataProviderTrait.php b/src/Traits/CreateDataProviderTrait.php
@@ -15,7 +15,7 @@
  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
-namespace Potherca\PhpUnit;
+namespace Potherca\PhpUnit\Traits;
 
 /**
  * Creates a "key => [value]" pair from a given one-dimensional array of values,
@@ -33,7 +33,7 @@
  *
  *    class ExampleTest extends PHPUnit\Framework\TestCase
  *    {
- *        use \Potherca\PhpUnit\CreateDataProviderTrait;
+ *        use \Potherca\PhpUnit\Traits\CreateDataProviderTrait;
  *
  *        public function provideValidValues()
  *        {
diff --git a/src/Traits/CreateObjectFromAbstractClassTrait.php b/src/Traits/CreateObjectFromAbstractClassTrait.php
diff --git a/src/Traits/GetCompatibleExceptionNameTrait.php b/src/Traits/GetCompatibleExceptionNameTrait.php
diff --git a/src/Traits/GetNonPublicPropertyTrait.php b/src/Traits/GetNonPublicPropertyTrait.php
diff --git a/src/Traits/SetNonPublicPropertyTrait.php b/src/Traits/SetNonPublicPropertyTrait.php

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`
`5`	`5`	`class ExampleTest extends \PHPUnit\Framework\TestCase`
`6`	`6`	`{`
`7`		`- use \Potherca\PhpUnit\CreateDataProviderTrait;`
	`7`	`+ use \Potherca\PhpUnit\Traits\CreateDataProviderTrait;`
`8`	`8`
`9`	`9`	`/** @var array */`
`10`	`10`	`private $values = array(`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ public function sayName()`
`14`	`14`
`15`	`15`	`class ExampleTest extends \PHPUnit\Framework\TestCase`
`16`	`16`	`{`
`17`		`- use \Potherca\PhpUnit\CreateObjectFromAbstractClassTrait;`
	`17`	`+ use \Potherca\PhpUnit\Traits\CreateObjectFromAbstractClassTrait;`
`18`	`18`
`19`	`19`	`const MOCK_VALUE = 'mock-value';`
`20`	`20`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ abstract class AbstractTestCase extends \PHPUnit\Framework\TestCase {}`
`11`	`11`
`12`	`12`	`class ExampleTest extends AbstractTestCase`
`13`	`13`	`{`
`14`		`- use \Potherca\PhpUnit\GetCompatibleExceptionNameTrait;`
	`14`	`+ use \Potherca\PhpUnit\Traits\GetCompatibleExceptionNameTrait;`
`15`	`15`
`16`	`16`	`public function testException()`
`17`	`17`	`{`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ public function __construct($name)`
`14`	`14`
`15`	`15`	`class ExampleTest extends \PHPUnit\Framework\TestCase`
`16`	`16`	`{`
`17`		`- use \Potherca\PhpUnit\GetNonPublicPropertyTrait;`
	`17`	`+ use \Potherca\PhpUnit\Traits\GetNonPublicPropertyTrait;`
`18`	`18`
`19`	`19`	`const MOCK_VALUE = 'mock-value';`
`20`	`20`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ class ExampleTest extends \PHPUnit\Framework\TestCase`
`7`	`7`	`/**`
`8`	`8`	`* As PHP5.3 does not support traits, __call is (a)bused instead of the trait.`
`9`	`9`	`*`
`10`		`- use \Potherca\PhpUnit\CreateDataProviderTrait;`
	`10`	`+ use \Potherca\PhpUnit\Traits\CreateDataProviderTrait;`
`11`	`11`	`*`
`12`	`12`	`* @param string $name`
`13`	`13`	`* @param array $parameters`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ class ExampleTest extends \PHPUnit\Framework\TestCase`
`17`	`17`	`/**`
`18`	`18`	`* As PHP5.3 does not support traits, __call is (a)bused instead of the trait.`
`19`	`19`	`*`
`20`		`- use \Potherca\PhpUnit\CreateObjectFromAbstractClassTrait;`
	`20`	`+ use \Potherca\PhpUnit\Traits\CreateObjectFromAbstractClassTrait;`
`21`	`21`	`*`
`22`	`22`	`* @param string $name`
`23`	`23`	`* @param array $parameters`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ class ExampleTest extends AbstractTestCase`
`14`	`14`	`/**`
`15`	`15`	`* As PHP5.3 does not support traits, __call is (a)bused instead of the trait.`
`16`	`16`	`*`
`17`		`- use \Potherca\PhpUnit\GetCompatibleExceptionNameTrait;`
	`17`	`+ use \Potherca\PhpUnit\Traits\GetCompatibleExceptionNameTrait;`
`18`	`18`	`*`
`19`	`19`	`* @param string $name`
`20`	`20`	`* @param array $parameters`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ public function getName()`
`14`	`14`
`15`	`15`	`class ExampleTest extends \PHPUnit\Framework\TestCase`
`16`	`16`	`{`
`17`		`- use \Potherca\PhpUnit\SetNonPublicPropertyTrait;`
	`17`	`+ use \Potherca\PhpUnit\Traits\SetNonPublicPropertyTrait;`
`18`	`18`
`19`	`19`	`const MOCK_VALUE = 'mock-value';`
`20`	`20`