BaseTestCase - make static and rename methods (start names of methods with "assert" instead of "verify")

This reverts commit 204e879

README.md

@@ -7,9 +7,9 @@ Common and useful classes, methods, exceptions etc.
 
 Run [Composer](https://getcomposer.org) to install this package in your project:
 
-    ```bash
+```bash
-    $ composer require meritoo/common-library
+$ composer require meritoo/common-library
-    ```
+```
 
 > How to install Composer: https://getcomposer.org/download
 

composer.json

@@ -2,7 +2,7 @@
     "name": "meritoo/common-library",
     "description": "Useful classes, methods, extensions etc.",
     "license": "MIT",
-    "version": "0.0.8",
+    "version": "0.0.11",
     "authors": [
         {
             "name": "Meritoo.pl",

src/Meritoo/Common/Exception/File/EmptyFileException.php

@@ -0,0 +1,31 @@
+<?php
+
+/**
+ * (c) Meritoo.pl, http://www.meritoo.pl
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Meritoo\Common\Exception\File;
+
+/**
+ * An exception used while file with given path is empty (has no content)
+ *
+ * @author    Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+ * @copyright Meritoo.pl
+ */
+class EmptyFileException extends \Exception
+{
+    /**
+     * Class constructor
+     *
+     * @param string $emptyFilePath Path of the empty file
+     */
+    public function __construct($emptyFilePath)
+    {
+        $template = 'File with path \'%s\' is empty (has no content). Did you provide path of proper file?';
+        $message = sprintf($template, $emptyFilePath);
+
+        parent::__construct($message);
+    }
+}

src/Meritoo/Common/Exception/File/EmptyFilePathException.php

@@ -0,0 +1,26 @@
+<?php
+
+/**
+ * (c) Meritoo.pl, http://www.meritoo.pl
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Meritoo\Common\Exception\File;
+
+/**
+ * An exception used while path of given file is empty
+ *
+ * @author    Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+ * @copyright Meritoo.pl
+ */
+class EmptyFilePathException extends \Exception
+{
+    /**
+     * Class constructor
+     */
+    public function __construct()
+    {
+        parent::__construct('Path of the file is empty. Did you provide path of proper file?');
+    }
+}

src/Meritoo/Common/Exception/File/NotExistingFileException.php

@@ -0,0 +1,31 @@
+<?php
+
+/**
+ * (c) Meritoo.pl, http://www.meritoo.pl
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Meritoo\Common\Exception\File;
+
+/**
+ * An exception used while file with given path does not exist
+ *
+ * @author    Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+ * @copyright Meritoo.pl
+ */
+class NotExistingFileException extends \Exception
+{
+    /**
+     * Class constructor
+     *
+     * @param string $notExistingFilePath Path of not existing (or not readable) file
+     */
+    public function __construct($notExistingFilePath)
+    {
+        $template = 'File with path \'%s\' does not exist (or is not readable). Did you provide proper path of file?';
+        $message = sprintf($template, $notExistingFilePath);
+
+        parent::__construct($message);
+    }
+}

src/Meritoo/Common/Test/Base/BaseTestCase.php

@@ -12,6 +12,7 @@ use DateTime;
 use Generator;
 use Meritoo\Common\Exception\Type\UnknownOopVisibilityTypeException;
 use Meritoo\Common\Type\OopVisibilityType;
+use Meritoo\Common\Utilities\Miscellaneous;
 use PHPUnit\Framework\TestCase;
 use ReflectionClass;
 use ReflectionMethod;
@@ -105,11 +106,16 @@ abstract class BaseTestCase extends TestCase
      */
     public function getFilePathToTests($fileName, $directoryPath = '')
     {
-        if (!empty($directoryPath)) {
+        $rootPath = Miscellaneous::getProjectRootPath();
-            $directoryPath = '/' . $directoryPath;
-        }
 
-        return sprintf('%s/../../../../../data/tests/%s%s', __DIR__, $fileName, $directoryPath);
+        $paths = [
+            $rootPath,
+            'data/tests',
+            $directoryPath,
+            $fileName,
+        ];
+
+        return Miscellaneous::concatenatePaths($paths);
     }
 
     /**
@@ -129,7 +135,7 @@ abstract class BaseTestCase extends TestCase
      * - string - name of the method
      * - instance of ReflectionMethod - just the method (provided by ReflectionClass::getMethod() method)
      */
-    protected function verifyMethodVisibilityAndArguments(
+    protected static function assertMethodVisibilityAndArguments(
         $classNamespace,
         $method,
         $visibilityType,
@@ -174,7 +180,7 @@ abstract class BaseTestCase extends TestCase
     /**
      * Verifies visibility and arguments of class constructor
      *
-     * @param string $classNamespace         Namespace of class that contains method to verify
+     * @param string $classNamespace         Namespace of class that contains constructor to verify
      * @param string $visibilityType         Expected visibility of verified method. One of OopVisibilityType class
      *                                       constants.
      * @param int    $argumentsCount         (optional) Expected count/amount of arguments of the verified method
@@ -182,7 +188,7 @@ abstract class BaseTestCase extends TestCase
      *                                       method
      * @throws UnknownOopVisibilityTypeException
      */
-    protected function verifyConstructorVisibilityAndArguments(
+    protected static function assertConstructorVisibilityAndArguments(
         $classNamespace,
         $visibilityType,
         $argumentsCount = 0,
@@ -194,6 +200,22 @@ abstract class BaseTestCase extends TestCase
         $reflection = new ReflectionClass($classNamespace);
         $method = $reflection->getConstructor();
 
-        return $this->verifyMethodVisibilityAndArguments($classNamespace, $method, $visibilityType, $argumentsCount, $requiredArgumentsCount);
+        return static::assertMethodVisibilityAndArguments($classNamespace, $method, $visibilityType, $argumentsCount, $requiredArgumentsCount);
+    }
+
+    /**
+     * Asserts that class with given namespace has no constructor
+     *
+     * @param string $classNamespace Namespace of class that contains constructor to verify
+     */
+    protected static function assertHasNoConstructor($classNamespace)
+    {
+        /*
+         * Let's grab the constructor
+         */
+        $reflection = new ReflectionClass($classNamespace);
+        $constructor = $reflection->getConstructor();
+
+        static::assertNull($constructor);
     }
 }

src/Meritoo/Common/Utilities/Miscellaneous.php

@@ -1032,6 +1032,8 @@ class Miscellaneous
         $separator = DIRECTORY_SEPARATOR;
 
         foreach ($paths as $path) {
+            $path = trim($path);
+
             /*
              * Empty paths are useless
              */
@@ -1471,4 +1473,37 @@ class Miscellaneous
 
         return $invertedColor;
     }
+
+    /**
+     * Returns project's root path.
+     * Looks for directory that contains composer.json.
+     *
+     * @return string
+     */
+    public static function getProjectRootPath()
+    {
+        $projectRootPath = '';
+
+        $fileName = 'composer.json';
+        $directoryPath = __DIR__;
+
+        /*
+         * Path of directory it's not the path of last directory?
+         */
+        while (DIRECTORY_SEPARATOR !== $directoryPath) {
+            $filePath = static::concatenatePaths($directoryPath, $fileName);
+
+            /*
+             * Is here file we are looking for?
+             * Maybe it's a project's root path
+             */
+            if (file_exists($filePath)) {
+                $projectRootPath = $directoryPath;
+            }
+
+            $directoryPath = dirname($directoryPath);
+        }
+
+        return $projectRootPath;
+    }
 }

tests/Meritoo/Common/Test/Collection/CollectionTest.php

@@ -306,7 +306,7 @@ class CollectionTest extends BaseTestCase
 
     public function testExistsVisibilityAndArguments()
     {
-        $this->verifyMethodVisibilityAndArguments(Collection::class, 'exists', OopVisibilityType::IS_PRIVATE, 1, 1);
+        static::assertMethodVisibilityAndArguments(Collection::class, 'exists', OopVisibilityType::IS_PRIVATE, 1, 1);
     }
 
     /**

tests/Meritoo/Common/Test/Utilities/ArraysTest.php

@@ -8,8 +8,8 @@
 
 namespace Meritoo\Common\Test\Utilities;
 
+use Meritoo\Common\Test\Base\BaseTestCase;
 use Meritoo\Common\Utilities\Arrays;
-use PHPUnit\Framework\TestCase;
 
 /**
  * Tests of the useful arrays methods
@@ -17,7 +17,7 @@ use PHPUnit\Framework\TestCase;
  * @author    Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
  * @copyright Meritoo.pl
  */
-class ArraysTest extends TestCase
+class ArraysTest extends BaseTestCase
 {
     private $simpleArray;
     private $simpleArrayWithKeys;
@@ -25,6 +25,11 @@ class ArraysTest extends TestCase
     private $complexArray;
     private $superComplexArray;
 
+    public function verifyConstructor()
+    {
+        static::assertHasNoConstructor(Arrays::class);
+    }
+
     public function testValues2string()
     {
         /*

tests/Meritoo/Common/Test/Utilities/BundleTest.php

@@ -8,8 +8,8 @@
 
 namespace Meritoo\Common\Test\Utilities;
 
+use Meritoo\Common\Test\Base\BaseTestCase;
 use Meritoo\Common\Utilities\Bundle;
-use PHPUnit\Framework\TestCase;
 
 /**
  * Tests of the useful methods for bundle
@@ -17,8 +17,13 @@ use PHPUnit\Framework\TestCase;
  * @author    Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
  * @copyright Meritoo.pl
  */
-class BundleTest extends TestCase
+class BundleTest extends BaseTestCase
 {
+    public function verifyConstructor()
+    {
+        static::assertHasNoConstructor(Bundle::class);
+    }
+
     public function testGetBundleViewPathEmptyPathAndBundle()
     {
         self::assertNull(Bundle::getBundleViewPath('', ''));

tests/Meritoo/Common/Test/Utilities/ComposerTest.php

@@ -27,6 +27,11 @@ class ComposerTest extends BaseTestCase
      */
     private $composerJsonPath;
 
+    public function verifyConstructor()
+    {
+        static::assertHasNoConstructor(Composer::class);
+    }
+
     /**
      * @param string $composerJsonPath Empty value, e.g. ""
      * @dataProvider provideEmptyValue

tests/Meritoo/Common/Test/Utilities/DatePeriodTest.php

@@ -24,7 +24,7 @@ class DatePeriodTest extends BaseTestCase
 {
     public function testConstructorVisibilityAndArguments()
     {
-        $this->verifyConstructorVisibilityAndArguments(DatePeriod::class, OopVisibilityType::IS_PUBLIC, 2, 0);
+        static::assertConstructorVisibilityAndArguments(DatePeriod::class, OopVisibilityType::IS_PUBLIC, 2, 0);
     }
 
     /**

tests/Meritoo/Common/Test/Utilities/DateTest.php

@@ -23,6 +23,11 @@ use Meritoo\Common\Utilities\Date;
  */
 class DateTest extends BaseTestCase
 {
+    public function verifyConstructor()
+    {
+        static::assertHasNoConstructor(Date::class);
+    }
+
     /**
      * @param mixed $value Empty value, e.g. ""
      * @dataProvider provideEmptyValue

tests/Meritoo/Common/Test/Utilities/GeneratorUtilityTest.php

@@ -19,6 +19,11 @@ use Meritoo\Common\Utilities\GeneratorUtility;
  */
 class GeneratorUtilityTest extends BaseTestCase
 {
+    public function verifyConstructor()
+    {
+        static::assertHasNoConstructor(GeneratorUtility::class);
+    }
+
     public function testGetGeneratorElements()
     {
         /*

tests/Meritoo/Common/Test/Utilities/LocaleTest.php

@@ -20,6 +20,11 @@ use Meritoo\Common\Utilities\Locale;
  */
 class LocaleTest extends BaseTestCase
 {
+    public function verifyConstructor()
+    {
+        static::assertHasNoConstructor(Locale::class);
+    }
+
     /**
      * @param mixed $languageCode Empty value, e.g. ""
      * @dataProvider provideEmptyValue

tests/Meritoo/Common/Test/Utilities/MimeTypesTest.php

@@ -20,6 +20,11 @@ use Meritoo\Common\Utilities\MimeTypes;
  */
 class MimeTypesTest extends BaseTestCase
 {
+    public function verifyConstructor()
+    {
+        static::assertHasNoConstructor(MimeTypes::class);
+    }
+
     /**
      * @param mixed $mimeType Empty value, e.g. ""
      * @dataProvider provideEmptyValue

tests/Meritoo/Common/Test/Utilities/MiscellaneousTest.php

@@ -28,6 +28,11 @@ class MiscellaneousTest extends BaseTestCase
     private $stringCommaSeparated;
     private $stringDotSeparated;
 
+    public function verifyConstructor()
+    {
+        static::assertHasNoConstructor(Miscellaneous::class);
+    }
+
     public function testGetDirectoryContent()
     {
         $directoryPath = __DIR__ . '/../';
@@ -503,16 +508,35 @@ class MiscellaneousTest extends BaseTestCase
         self::assertEquals('lorem ipsum', Miscellaneous::trimSmart(' lorem ipsum     '));
     }
 
-    public function testConcatenatePaths()
+    /**
+     * @param mixed $emptyPaths Empty paths co concatenate
+     * @dataProvider provideEmptyValue
+     */
+    public function testConcatenatePathsWithEmptyPaths($emptyPaths)
+    {
+        self::assertEquals('', Miscellaneous::concatenatePaths($emptyPaths));
+    }
+
+    public function testConcatenatePathsWithOneEmptyPath()
+    {
+        $paths = [
+            'first/directory',
+            'second/one',
+            '',
+            'and/the/third',
+        ];
+
+        $concatenated = Miscellaneous::concatenatePaths($paths);
+        unset($paths[2]);
+        $imploded = implode('/', $paths);
+
+        self::assertEquals('/' . $imploded, $concatenated);
+    }
+
+    public function testConcatenatePathsInNixOs()
     {
         /*
-         * Common cases
+         * For *nix operating system
-         */
-        self::assertEquals('', Miscellaneous::concatenatePaths(null));
-        self::assertEquals('', Miscellaneous::concatenatePaths([]));
-
-        /*
-         * *nix operating system
          */
         $paths1 = [
             'first/directory',
@@ -522,7 +546,10 @@ class MiscellaneousTest extends BaseTestCase
 
         self::assertEquals('/' . implode('/', $paths1), Miscellaneous::concatenatePaths($paths1));
         self::assertEquals('/' . implode('/', $paths1), Miscellaneous::concatenatePaths($paths1[0], $paths1[1], $paths1[2]));
+    }
 
+    public function testConcatenatePathsInWindowsOs()
+    {
         /*
          * For Windows operating system
          */
@@ -720,6 +747,11 @@ class MiscellaneousTest extends BaseTestCase
         self::assertSame($expected, Miscellaneous::fillMissingZeros($number, $length, $before));
     }
 
+    public function testGetProjectRootPath()
+    {
+        self::assertNotEmpty(Miscellaneous::getProjectRootPath());
+    }
+
     /**
      * Provides string to convert characters to latin characters and not lower cased and not human-readable
      *

tests/Meritoo/Common/Test/Utilities/ReflectionTest.php

@@ -29,6 +29,11 @@ use Meritoo\Common\Utilities\Reflection;
  */
 class ReflectionTest extends BaseTestCase
 {
+    public function verifyConstructor()
+    {
+        static::assertHasNoConstructor(Reflection::class);
+    }
+
     /**
      * @param mixed $invalidClass Empty value, e.g. ""
      * @dataProvider provideEmptyValue

tests/Meritoo/Common/Test/Utilities/RegexTest.php

@@ -8,7 +8,7 @@
 
 namespace Meritoo\Common\Utilities;
 
-use PHPUnit\Framework\TestCase;
+use Meritoo\Common\Test\Base\BaseTestCase;
 
 /**
  * Tests of the useful regular expressions methods
@@ -16,11 +16,16 @@ use PHPUnit\Framework\TestCase;
  * @author    Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
  * @copyright Meritoo.pl
  */
-class RegexTest extends TestCase
+class RegexTest extends BaseTestCase
 {
     private $simpleText;
     private $camelCaseText;
 
+    public function verifyConstructor()
+    {
+        static::assertHasNoConstructor(Regex::class);
+    }
+
     public function testGetCamelCaseParts()
     {
         $parts = [];

tests/Meritoo/Common/Test/Utilities/UriTest.php

@@ -19,6 +19,11 @@ use Meritoo\Common\Utilities\Uri;
  */
 class UriTest extends BaseTestCase
 {
+    public function verifyConstructor()
+    {
+        static::assertHasNoConstructor(Uri::class);
+    }
+
     public function testAddProtocolToUrl()
     {
         $http = 'http';

tests/Meritoo/Common/Test/Utilities/XmlTest.php

@@ -8,8 +8,8 @@
 
 namespace Meritoo\Common\Test\Utilities;
 
+use Meritoo\Common\Test\Base\BaseTestCase;
 use Meritoo\Common\Utilities\Xml;
-use PHPUnit\Framework\TestCase;
 use SimpleXMLElement;
 
 /**
@@ -18,11 +18,16 @@ use SimpleXMLElement;
  * @author    Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
  * @copyright Meritoo.pl
  */
-class XmlTest extends TestCase
+class XmlTest extends BaseTestCase
 {
     private $simpleXml;
     private $advancedXml;
 
+    public function verifyConstructor()
+    {
+        static::assertHasNoConstructor(Xml::class);
+    }
+
     public function testMergeNodes()
     {
         /*