composer.json - bump version

Details: https://github.com/phingofficial/phing/issues/716

.docker/config/Dockerfile

@@ -0,0 +1,64 @@
+FROM php:5.5-cli
+
+#
+# Tools & libraries
+#
+RUN apt-get update \
+    && apt-get install -y --no-install-recommends \
+        vim \
+        git \
+        zip \
+        unzip \
+        zlib1g-dev \
+        libicu-dev \
+    && apt-get clean \
+    && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
+
+#
+# PHP extensions
+#
+RUN docker-php-ext-install \
+    zip \
+    intl \
+    mbstring
+
+#
+# PHP configuration:
+# - default configuration
+# - timezone
+#
+COPY php.ini /usr/local/etc/php/php.ini
+ARG TIMEZONE
+RUN echo "\n""date.timezone = $TIMEZONE""\n" >> /usr/local/etc/php/php.ini
+
+#
+# Xdebug
+#
+RUN pecl install xdebug \
+    && docker-php-ext-enable xdebug
+COPY xdebug.ini /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini
+
+#
+# Phing
+#
+RUN pear channel-discover pear.phing.info \
+    && pear install [--alldeps] phing/phing
+
+#
+# Composer + https://packagist.org/packages/hirak/prestissimo package
+#
+RUN php -r "copy('https://getcomposer.org/installer', 'composer-setup.php');" \
+    && php -r "if (hash_file('SHA384', 'composer-setup.php') === \
+    '544e09ee996cdf60ece3804abc52599c22b1f40f4323403c44d44fdfdd586475ca9813a858088ffbc1f233e9b180f061') { echo \
+    'Installer verified'; } else { echo 'Installer corrupt'; unlink('composer-setup.php'); } echo PHP_EOL;" \
+    && php composer-setup.php --install-dir=/usr/local/bin --filename=composer \
+    && php -r "unlink('composer-setup.php');" \
+    && composer global require --no-plugins --no-scripts hirak/prestissimo \
+    && rm -rf /root/.composer/cache/*
+
+#
+# Bash
+#
+RUN sed -i 's/^# export/export/g' /root/.bashrc \
+    && sed -i 's/^# alias/alias/g' /root/.bashrc \
+    && echo "\n"'export PATH=/project/vendor/bin:$PATH'"\n" >> /root/.bashrc

.docker/config/php.ini

@@ -0,0 +1,3 @@
+display_errors = On
+display_startup_errors = On
+error_reporting = E_ALL

.docker/config/xdebug.ini

@@ -0,0 +1,6 @@
+[xdebug]
+zend_extension=xdebug.so
+
+xdebug.remote_enable=1
+xdebug.remote_port=9001
+xdebug.remote_host=10.254.254.254

.env

@@ -0,0 +1 @@
+TIMEZONE=Europe/Warsaw

.gitignore

@@ -14,7 +14,7 @@
 # ----------------------------------------------------------------------------------------------------------------------
 ### Phing
 # ----------------------------------------------------------------------------------------------------------------------
-/phing/properties
+/.phing/properties
 
 
 # ----------------------------------------------------------------------------------------------------------------------
@@ -32,13 +32,13 @@
 # ----------------------------------------------------------------------------------------------------------------------
 ### Build files
 # ----------------------------------------------------------------------------------------------------------------------
-/build/
+/.build/
 
 
 # ----------------------------------------------------------------------------------------------------------------------
 ### Generated databases
 # ----------------------------------------------------------------------------------------------------------------------
-/data/tmp
+/.data/tmp
 *.sql
 *.sqlite
 

.phing/app.xml

@@ -2,12 +2,12 @@
 <project name="Meritoo Package" basedir="." default="build:main" phingVersion="2.14.0">
     <!-- Properties -->
     <if>
-        <available file="phing/properties" property="custom.properties.available"/>
+        <available file=".phing/properties" property="custom.properties.available"/>
         <then>
-            <property file="phing/properties" />
+            <property file=".phing/properties" />
         </then>
         <else>
-            <property file="phing/properties.dist" />
+            <property file=".phing/properties.dist" />
         </else>
     </if>
 

.phing/properties.dist

@@ -28,7 +28,13 @@ assets.installWithSymlink = true
 
 # Clear cache with the "warmup" option
 #
-cache.clearWithWarmup = true
+# The cache:clear command should always be called with the --no-warmup option. Warmup should be done via the cache:warmup command.
+# https://github.com/symfony/symfony/blob/master/UPGRADE-3.3.md#frameworkbundle
+#
+# Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+# 2017-06-06
+#
+cache.clearWithWarmup = false
 
 # --------------------------------------------------------------------------------
 # Composer
@@ -59,7 +65,7 @@ composer.validate = false
 
 # System directories
 #
-dir.data = ${project.basedir}/data
+dir.data = ${project.basedir}/.data
 dir.src = ${project.basedir}/src
 dir.tests = ${project.basedir}/tests
 
@@ -67,7 +73,7 @@ dir.tests = ${project.basedir}/tests
 # Build directories
 # --------------------------------------------------------------------------------
 
-dir.build = ${project.basedir}/build
+dir.build = ${project.basedir}/.build
 dir.reports = ${dir.build}/logs
 dir.reports.pdepend = ${dir.reports}/pdepend
 dir.reports.coverage = ${dir.reports}/phpunit_coverage

.phing/tests.xml

@@ -11,12 +11,12 @@
 
     <!-- Properties -->
     <if>
-        <available file="phing/properties" property="custom.properties.available"/>
+        <available file=".phing/properties" property="custom.properties.available"/>
         <then>
-            <property file="phing/properties" />
+            <property file=".phing/properties" />
         </then>
         <else>
-            <property file="phing/properties.dist" />
+            <property file=".phing/properties.dist" />
         </else>
     </if>
 

README.md

@@ -13,6 +13,15 @@ $ composer require meritoo/common-library
 
 > How to install Composer: https://getcomposer.org/download
 
+## Rebuilding project and tests running
+
+```bash
+$ docker-compose up -d
+$ docker-compose exec php-cli phing
+```
+
+> What is Docker? https://www.docker.com/what-docker
+
 ## Static methods
 
 This package contains a lot of class with static methods, so usage is not so complicated. Just run the static method who would you like to use. Example:

build.xml

@@ -2,12 +2,12 @@
 <project name="Meritoo Package" basedir="." default="build:main" phingVersion="2.14.0">
     <!-- Properties -->
     <if>
-        <available file="phing/properties" property="custom.properties.available"/>
+        <available file=".phing/properties" property="custom.properties.available"/>
         <then>
-            <property file="phing/properties" />
+            <property file=".phing/properties" />
         </then>
         <else>
-            <property file="phing/properties.dist" />
+            <property file=".phing/properties.dist" />
         </else>
     </if>
 
@@ -18,12 +18,12 @@
 
     <!-- Build app -->
     <target name="build:app" description="Prepares app to build and tests">
-        <phing phingfile="phing/app.xml" haltonfailure="true" />
+        <phing phingfile=".phing/app.xml" haltonfailure="true" />
     </target>
 
     <!-- Build tests -->
     <target name="build:tests" description="Runs all tests, checks and creates docs">
-        <phing phingfile="phing/tests.xml" haltonfailure="true" />
+        <phing phingfile=".phing/tests.xml" haltonfailure="true" />
 
         <!--
         Conditional running of tests.
@@ -35,7 +35,7 @@
         <if>
             <equals arg1="${env}" arg2="test" />
             <then>
-                <phing phingfile="phing/tests.xml" haltonfailure="true" />
+                <phing phingfile=".phing/tests.xml" haltonfailure="true" />
             </then>
             <else>
                 <echo message="[Skipped] Running tests, checks and creating docs, because it's a not 'test' environment..." />

composer.json

@@ -2,7 +2,7 @@
     "name": "meritoo/common-library",
     "description": "Useful classes, methods, extensions etc.",
     "license": "MIT",
-    "version": "0.0.14",
+    "version": "0.0.16",
     "authors": [
         {
             "name": "Meritoo.pl",
@@ -11,18 +11,18 @@
         }
     ],
     "require": {
-        "php": ">=5.6.0",
+        "php": ">=5.5.9",
         "doctrine/orm": "^2.5",
         "gedmo/doctrine-extensions": "^2.4",
         "symfony/http-foundation": "^3.3"
     },
     "require-dev": {
-        "friendsofphp/php-cs-fixer": "^2.6",
+        "friendsofphp/php-cs-fixer": "^2.2",
         "pdepend/pdepend": "^2.5",
-        "phploc/phploc": "^4.0",
+        "phploc/phploc": "^2.1",
         "phpmd/phpmd": "^2.6",
-        "phpunit/phpunit": "^5.7",
-        "sebastian/phpcpd": "^3.0",
+        "phpunit/phpunit": "^4.8",
+        "sebastian/phpcpd": "^2.0",
         "squizlabs/php_codesniffer": "^2.9"
     },
     "autoload": {
@@ -34,5 +34,8 @@
         "psr-4": {
             "Meritoo\\Common\\Test\\": "tests/"
         }
+    },
+    "config": {
+        "sort-packages": true
     }
 }

docker-compose.yml

@@ -0,0 +1,15 @@
+version: '3'
+
+services:
+    php-cli:
+        image: meritoo/common-library
+        container_name: meritoo-common-library
+        working_dir: /project
+        entrypoint: php
+        command: -S 0.0.0.0:9999
+        build:
+            context: ./.docker/config
+            args:
+                - TIMEZONE=$TIMEZONE
+        volumes:
+            - .:/project

phpunit.xml.dist

@@ -30,6 +30,6 @@
     </groups>
 
     <logging>
-        <log type="coverage-html" target="./build/logs/phpunit_coverage/html" />
+        <log type="coverage-html" target="./.build/logs/phpunit_coverage/html" />
     </logging>
 </phpunit>

src/Test/Base/BaseTestCase.php

@@ -25,6 +25,13 @@ use ReflectionMethod;
  */
 abstract class BaseTestCase extends TestCase
 {
+    /**
+     * Path of directory with data used by test cases
+     *
+     * @var string
+     */
+    private static $testsDataDirPath = '.data/tests';
+
     /**
      * Provides an empty value
      *
@@ -98,19 +105,19 @@ abstract class BaseTestCase extends TestCase
 
     /**
      * Returns path of file used by tests.
-     * It should be placed in /data/tests directory of this project.
+     * It should be placed in /.data/tests directory of this project.
      *
      * @param string $fileName      Name of file
      * @param string $directoryPath (optional) Path of directory containing the file
      * @return string
      */
-    public function getFilePathToTests($fileName, $directoryPath = '')
+    public function getFilePathForTesting($fileName, $directoryPath = '')
     {
         $rootPath = Miscellaneous::getProjectRootPath();
 
         $paths = [
             $rootPath,
-            'data/tests',
+            self::$testsDataDirPath,
             $directoryPath,
             $fileName,
         ];
@@ -218,4 +225,14 @@ abstract class BaseTestCase extends TestCase
 
         static::assertNull($constructor);
     }
+
+    /**
+     * Sets path of directory with data used by test cases
+     *
+     * @param string $testsDataDirPath Path of directory with data used by test cases
+     */
+    protected static function setTestsDataDirPath($testsDataDirPath)
+    {
+        static::$testsDataDirPath = $testsDataDirPath;
+    }
 }

src/Test/Base/BaseTypeTestCase.php

@@ -1,5 +1,11 @@
 <?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\Test\Base;
 
 use Generator;

tests/Exception/Base/UnknownTypeExceptionTest.php

@@ -33,7 +33,7 @@ class UnknownTypeExceptionTest extends BaseTestCase
 
     public function testTheException()
     {
-        $this->expectException(UnknownTestTypeException::class);
+        $this->setExpectedException(UnknownTestTypeException::class);
         self::assertEmpty((new TestService())->getTranslatedType('test_3'));
     }
 }

tests/Test/Base/BaseTestCaseTest.php

@@ -0,0 +1,156 @@
+<?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\Test\Test\Base;
+
+use DateTime;
+use Generator;
+use Meritoo\Common\Test\Base\BaseTestCase;
+use Meritoo\Common\Type\OopVisibilityType;
+use Meritoo\Common\Utilities\GeneratorUtility;
+
+/**
+ * Test case of the base test case with common methods and data providers
+ *
+ * @author    Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+ * @copyright Meritoo.pl
+ */
+class BaseTestCaseTest extends BaseTestCase
+{
+    public function testConstructor()
+    {
+        static::assertConstructorVisibilityAndArguments(BaseTestCase::class, OopVisibilityType::IS_PUBLIC, 3);
+    }
+
+    public function testProvideEmptyValue()
+    {
+        $elements = [
+            [''],
+            ['   '],
+            [null],
+            [0],
+            [false],
+            [[]],
+        ];
+
+        $generator = (new SimpleTestCase())->provideEmptyValue();
+        self::assertEquals($elements, GeneratorUtility::getGeneratorElements($generator));
+    }
+
+    public function testProvideBooleanValue()
+    {
+        $elements = [
+            [false],
+            [true],
+        ];
+
+        $generator = (new SimpleTestCase())->provideBooleanValue();
+        self::assertEquals($elements, GeneratorUtility::getGeneratorElements($generator));
+    }
+
+    public function testProvideDateTimeInstance()
+    {
+        $elements = [
+            [new DateTime()],
+            [new DateTime('yesterday')],
+            [new DateTime('now')],
+            [new DateTime('tomorrow')],
+        ];
+
+        $generator = (new SimpleTestCase())->provideDateTimeInstance();
+        self::assertEquals($elements, GeneratorUtility::getGeneratorElements($generator));
+    }
+
+    public function testProvideDateTimeRelativeFormat()
+    {
+        $elements = [
+            ['now'],
+            ['yesterday'],
+            ['tomorrow'],
+            ['back of 10'],
+            ['front of 10'],
+            ['last day of February'],
+            ['first day of next month'],
+            ['last day of previous month'],
+            ['last day of next month'],
+            ['Y-m-d'],
+            ['Y-m-d 10:00'],
+        ];
+
+        $generator = (new SimpleTestCase())->provideDateTimeRelativeFormat();
+        self::assertEquals($elements, GeneratorUtility::getGeneratorElements($generator));
+    }
+
+    public function testProvideNotExistingFilePath()
+    {
+        $elements = [
+            ['lets-test.doc'],
+            ['lorem/ipsum.jpg'],
+            ['surprise/me/one/more/time.txt'],
+        ];
+
+        $generator = (new SimpleTestCase())->provideNotExistingFilePath();
+        self::assertEquals($elements, GeneratorUtility::getGeneratorElements($generator));
+    }
+
+    /**
+     * @param string $fileName      Name of file
+     * @param string $directoryPath Path of directory containing the file
+     *
+     * @dataProvider provideFileNameAndDirectoryPath
+     */
+    public function testGetFilePathForTesting($fileName, $directoryPath)
+    {
+        $path = (new SimpleTestCase())->getFilePathForTesting($fileName, $directoryPath);
+
+        if (!empty($directoryPath)) {
+            $directoryPath .= '/';
+        }
+
+        $expectedContains = sprintf('/.data/tests/%s%s', $directoryPath, $fileName);
+        static::assertContains($expectedContains, $path);
+    }
+
+    /**
+     * Provides name of file and path of directory containing the file
+     *
+     * @return Generator
+     */
+    public function provideFileNameAndDirectoryPath()
+    {
+        yield[
+            'abc.jpg',
+            '',
+        ];
+
+        yield[
+            'abc.def.jpg',
+            '',
+        ];
+
+        yield[
+            'abc.jpg',
+            'def',
+        ];
+
+        yield[
+            'abc.def.jpg',
+            'def',
+        ];
+    }
+}
+
+/**
+ * Simple test case
+ *
+ * @author    Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+ * @copyright Meritoo.pl
+ */
+class SimpleTestCase extends BaseTestCase
+{
+}

tests/Type/Base/BaseTypeTest.php

@@ -9,8 +9,8 @@
 namespace Meritoo\Common\Test\Type\Base;
 
 use Generator;
+use Meritoo\Common\Test\Base\BaseTestCase;
 use Meritoo\Common\Type\Base\BaseType;
-use PHPUnit\Framework\TestCase;
 
 /**
  * Test case of the base / abstract type of something
@@ -18,8 +18,13 @@ use PHPUnit\Framework\TestCase;
  * @author    Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
  * @copyright Meritoo.pl
  */
-class BaseTypeTest extends TestCase
+class BaseTypeTest extends BaseTestCase
 {
+    public function testConstructor()
+    {
+        static::assertHasNoConstructor(BaseType::class);
+    }
+
     /**
      * @param BaseType $type          Type of something
      * @param array    $expectedTypes Expected concrete types of given instance of type

tests/Utilities/ComposerTest.php

@@ -88,6 +88,6 @@ class ComposerTest extends BaseTestCase
     {
         parent::setUp();
 
-        $this->composerJsonPath = $this->getFilePathToTests(Composer::FILE_NAME_MAIN);
+        $this->composerJsonPath = $this->getFilePathForTesting(Composer::FILE_NAME_MAIN);
     }
 }

tests/Utilities/DateTest.php

@@ -223,7 +223,7 @@ class DateTest extends BaseTestCase
      */
     public function testGetDayOfWeekIncorrectValues($year, $month, $day)
     {
-        $this->expectException(UnknownDatePartTypeException::class);
+        $this->setExpectedException(UnknownDatePartTypeException::class);
         self::assertEmpty(Date::getDayOfWeek($year, $month, $day));
     }
 

tests/Utilities/MimeTypesTest.php

@@ -447,12 +447,12 @@ class MimeTypesTest extends BaseTestCase
     public function provideFilePathToGetMimeTypeOfRealFile()
     {
         yield[
-            $this->getFilePathToTests('minion.jpg'),
+            $this->getFilePathForTesting('minion.jpg'),
             'image/jpeg',
         ];
 
         yield[
-            $this->getFilePathToTests('lorem-ipsum.txt'),
+            $this->getFilePathForTesting('lorem-ipsum.txt'),
             'text/plain',
         ];
     }
@@ -465,12 +465,12 @@ class MimeTypesTest extends BaseTestCase
     public function provideExistingFilePathToCheckIsImagePath()
     {
         yield[
-            $this->getFilePathToTests('minion.jpg'),
+            $this->getFilePathForTesting('minion.jpg'),
             true,
         ];
 
         yield[
-            $this->getFilePathToTests('lorem-ipsum.txt'),
+            $this->getFilePathForTesting('lorem-ipsum.txt'),
             false,
         ];
     }

tests/Utilities/MiscellaneousTest.php

@@ -663,7 +663,8 @@ class MiscellaneousTest extends BaseTestCase
 
     public function testGetInvertedColorWithIncorrectLength()
     {
-        $this->expectException(IncorrectColorHexLengthException::class);
+        $this->setExpectedException(IncorrectColorHexLengthException::class);
+
         Miscellaneous::getInvertedColor(null);
         Miscellaneous::getInvertedColor('');
         Miscellaneous::getInvertedColor(1);
@@ -676,7 +677,8 @@ class MiscellaneousTest extends BaseTestCase
 
     public function testGetInvertedColorWithInvalidValue()
     {
-        $this->expectException(InvalidColorHexValueException::class);
+        $this->setExpectedException(InvalidColorHexValueException::class);
+
         Miscellaneous::getInvertedColor('0011zz');
         Miscellaneous::getInvertedColor('001#zz');
         Miscellaneous::getInvertedColor('001!zz');

tests/Utilities/ReflectionTest.php

@@ -122,7 +122,7 @@ class ReflectionTest extends BaseTestCase
      */
     public function testGetChildClassesInvalidClass($invalidClass)
     {
-        $this->expectException(CannotResolveClassNameException::class);
+        $this->setExpectedException(CannotResolveClassNameException::class);
 
         self::assertNull(Reflection::getChildClasses($invalidClass));
         self::assertNull(Reflection::getChildClasses(123));
@@ -130,7 +130,7 @@ class ReflectionTest extends BaseTestCase
 
     public function testGetChildClassesNotExistingClass()
     {
-        $this->expectException(CannotResolveClassNameException::class);
+        $this->setExpectedException(CannotResolveClassNameException::class);
         self::assertEquals('', Reflection::getChildClasses('xyz'));
     }
 
@@ -161,13 +161,13 @@ class ReflectionTest extends BaseTestCase
 
     public function testGetOneChildClassWithMissingChildClasses()
     {
-        $this->expectException(MissingChildClassesException::class);
+        $this->setExpectedException(MissingChildClassesException::class);
         self::assertEquals('LoremIpsum', Reflection::getOneChildClass(C::class));
     }
 
     public function testGetOneChildClassWithTooManyChildClasses()
     {
-        $this->expectException(TooManyChildClassesException::class);
+        $this->setExpectedException(TooManyChildClassesException::class);
 
         self::assertEquals(B::class, Reflection::getOneChildClass(A::class));
         self::assertEquals(C::class, Reflection::getOneChildClass(A::class));
@@ -195,7 +195,7 @@ class ReflectionTest extends BaseTestCase
      */
     public function testUsesTraitInvalidClass($class, $trait)
     {
-        $this->expectException(CannotResolveClassNameException::class);
+        $this->setExpectedException(CannotResolveClassNameException::class);
         self::assertNull(Reflection::usesTrait($class, $trait));
     }
 
@@ -205,7 +205,7 @@ class ReflectionTest extends BaseTestCase
      */
     public function testUsesTraitInvalidTrait($trait)
     {
-        $this->expectException(CannotResolveClassNameException::class);
+        $this->setExpectedException(CannotResolveClassNameException::class);
         self::assertNull(Reflection::usesTrait(DateTime::class, $trait));
     }