Apply fixes from StyleCI

.coveralls.yml

@@ -1,2 +0,0 @@
-coverage_clover: build/reports/coveralls/clover.xml
-json_path: build/reports/coveralls/upload.json

.env

@@ -1,15 +0,0 @@
-# ------------------------------------------------------------------------------
-### Docker
-# ------------------------------------------------------------------------------
-
-#
-# All containers
-#
-DOCKER_CONTAINER_OWNER=meritoo
-DOCKER_CONTAINER_PROJECT=common-library
-
-#
-# PHP configuration:
-# - timezone
-#
-PHP_DATE_TIMEZONE=Europe/London

.gitignore

@@ -1,25 +1,79 @@
-# ------------------------------------------------------------------------------
-### Linux template
-# ------------------------------------------------------------------------------
-*~
-
-# temporary files which can be created if a process still has a handle open of a deleted file
-.fuse_hidden*
-
-# KDE directory preferences
-.directory
-
-# Linux trash folder which might appear on any partition or disk
-.Trash-*
-
-# .nfs files are created when an open file is removed but is still being accessed
-.nfs*
+# ----------------------------------------------------------------------------------------------------------------------
+### Vendors
+# ----------------------------------------------------------------------------------------------------------------------
+/vendor/
 
 
-# ------------------------------------------------------------------------------
-### macOS template
-# ------------------------------------------------------------------------------
-# General
+# ----------------------------------------------------------------------------------------------------------------------
+### Composer
+# ----------------------------------------------------------------------------------------------------------------------
+/composer.phar
+
+
+# ----------------------------------------------------------------------------------------------------------------------
+### Phing
+# ----------------------------------------------------------------------------------------------------------------------
+/phing/properties
+
+
+# ----------------------------------------------------------------------------------------------------------------------
+### PHPUnit
+# ----------------------------------------------------------------------------------------------------------------------
+/phpunit.xml
+
+
+# ----------------------------------------------------------------------------------------------------------------------
+### PHP Coding Standards Fixer generated files
+# ----------------------------------------------------------------------------------------------------------------------
+/.php_cs.cache
+
+
+# ----------------------------------------------------------------------------------------------------------------------
+### Generated databases
+# ----------------------------------------------------------------------------------------------------------------------
+/data/tmp
+*.sql
+*.sqlite
+
+
+# ----------------------------------------------------------------------------------------------------------------------
+### Compiled source
+# ----------------------------------------------------------------------------------------------------------------------
+*.com
+*.class
+*.dll
+*.exe
+*.o
+*.so
+
+
+# ----------------------------------------------------------------------------------------------------------------------
+### Shell scripts
+# ----------------------------------------------------------------------------------------------------------------------
+/*.sh
+
+
+# ----------------------------------------------------------------------------------------------------------------------
+### JetBrains
+# ----------------------------------------------------------------------------------------------------------------------
+/.idea
+
+
+# ----------------------------------------------------------------------------------------------------------------------
+### NetBeans template
+# ----------------------------------------------------------------------------------------------------------------------
+nbproject/private/
+build/
+nbbuild/
+dist/
+nbdist/
+nbactions.xml
+.nb-gradle/
+
+
+# ----------------------------------------------------------------------------------------------------------------------
+### OSX template
+# ----------------------------------------------------------------------------------------------------------------------
 .DS_Store
 .AppleDouble
 .LSOverride
@@ -37,7 +91,6 @@ Icon
 .TemporaryItems
 .Trashes
 .VolumeIcon.icns
-.com.apple.timemachine.donotpresent
 
 # Directories potentially created on remote AFP share
 .AppleDB
@@ -47,20 +100,30 @@ Temporary Items
 .apdisk
 
 
-# ------------------------------------------------------------------------------
-### Windows template
-# ------------------------------------------------------------------------------
-# Windows thumbnail cache files
-Thumbs.db
-Thumbs.db:encryptable
-ehthumbs.db
-ehthumbs_vista.db
+# ----------------------------------------------------------------------------------------------------------------------
+### Linux template
+# ----------------------------------------------------------------------------------------------------------------------
+*~
 
-# Dump file
-*.stackdump
+# temporary files which can be created if a process still has a handle open of a deleted file
+.fuse_hidden*
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+
+# ----------------------------------------------------------------------------------------------------------------------
+### Windows template
+# ----------------------------------------------------------------------------------------------------------------------
+# Windows image file caches
+Thumbs.db
+ehthumbs.db
 
 # Folder config file
-[Dd]esktop.ini
+Desktop.ini
 
 # Recycle Bin used on file shares
 $RECYCLE.BIN/
@@ -68,137 +131,8 @@ $RECYCLE.BIN/
 # Windows Installer files
 *.cab
 *.msi
-*.msix
 *.msm
 *.msp
 
 # Windows shortcuts
 *.lnk
-
-
-# ------------------------------------------------------------------------------
-### JetBrains template
-# ------------------------------------------------------------------------------
-# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and WebStorm
-# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
-
-# User-specific stuff
-.idea/**/workspace.xml
-.idea/**/tasks.xml
-.idea/**/usage.statistics.xml
-.idea/**/dictionaries
-.idea/**/shelf
-
-# Generated files
-.idea/**/contentModel.xml
-
-# Sensitive or high-churn files
-.idea/**/dataSources/
-.idea/**/dataSources.ids
-.idea/**/dataSources.local.xml
-.idea/**/sqlDataSources.xml
-.idea/**/dynamic.xml
-.idea/**/uiDesigner.xml
-.idea/**/dbnavigator.xml
-
-# Gradle
-.idea/**/gradle.xml
-.idea/**/libraries
-
-# Gradle and Maven with auto-import
-# When using Gradle or Maven with auto-import, you should exclude module files,
-# since they will be recreated, and may cause churn.  Uncomment if using
-# auto-import.
-# .idea/modules.xml
-# .idea/*.iml
-# .idea/modules
-# *.iml
-# *.ipr
-
-# CMake
-cmake-build-*/
-
-# Mongo Explorer plugin
-.idea/**/mongoSettings.xml
-
-# File-based project format
-*.iws
-
-# IntelliJ
-out/
-
-# mpeltonen/sbt-idea plugin
-.idea_modules/
-
-# JIRA plugin
-atlassian-ide-plugin.xml
-
-# Cursive Clojure plugin
-.idea/replstate.xml
-
-# Crashlytics plugin (for Android Studio and IntelliJ)
-com_crashlytics_export_strings.xml
-crashlytics.properties
-crashlytics-build.properties
-fabric.properties
-
-# Editor-based Rest Client
-.idea/httpRequests
-
-# Android studio 3.1+ serialized cache file
-.idea/caches/build_file_checksums.ser
-
-
-# ------------------------------------------------------------------------------
-### Build files
-# ------------------------------------------------------------------------------
-/build/
-
-
-# ------------------------------------------------------------------------------
-### Phing
-# ------------------------------------------------------------------------------
-/phing/properties
-
-
-# ------------------------------------------------------------------------------
-### Infection
-# ------------------------------------------------------------------------------
-/infection.json
-
-
-# ------------------------------------------------------------------------------
-### Temporary data & databases
-# ------------------------------------------------------------------------------
-/data/tmp
-*.sqlite
-
-
-# ------------------------------------------------------------------------------
-### Composer & vendors
-# ------------------------------------------------------------------------------
-/composer.lock
-/composer.phar
-/vendor/
-
-
-# ------------------------------------------------------------------------------
-### PHPUnit
-# ------------------------------------------------------------------------------
-/phpunit.xml
-/.phpunit.result.cache
-/tests/Resources/var
-
-
-# ------------------------------------------------------------------------------
-### PHP Coding Standards Fixer
-# ------------------------------------------------------------------------------
-/.php_cs
-/.php_cs.cache
-
-
-# ------------------------------------------------------------------------------
-### PHP_CodeSniffer
-# ------------------------------------------------------------------------------
-/.phpcs-cache
-/phpcs.xml

.php_cs.dist

@@ -1,52 +1,30 @@
 <?php
 
 $finder = PhpCsFixer\Finder::create()
-    ->in(__DIR__)
-    ->exclude([
-        'build',
-        'vendor',
-    ])
-    ->notPath([
-        'tests/Resources/var/',
+    /*
+     * Do not verify:
+     * - all DependencyInjection/Configuration classes: the Configuration.php files
+     * - autoloader from /app directory: autoload.php
+     */
+    ->notPath('/DependencyInjection\/Configuration\.php/')
+    ->notPath('/autoload\.php/')
+    ->in([
+        __DIR__ . '/src',
+        __DIR__ . '/tests',
     ]);
 
 return PhpCsFixer\Config::create()
     ->setRules([
-        '@Symfony' => true,
-        '@PhpCsFixer' => true,
-        '@PHP71Migration' => true,
-        'array_syntax' => ['syntax' => 'short'],
+        '@Symfony'               => true,
+        'phpdoc_summary'         => false,
+        'phpdoc_separation'      => false,
+        'phpdoc_align'           => false,
+        'cast_spaces'            => false,
         'binary_operator_spaces' => [
             'align_double_arrow' => true,
         ],
-        'blank_line_before_return' => false,
-        'cast_spaces' => false,
-        'concat_space' => [
+        'concat_space'           => [
             'spacing' => 'one',
         ],
-        'ordered_class_elements' => [
-            'order' => [
-                'use_trait',
-                'constant_public',
-                'constant_protected',
-                'constant_private',
-                'property_public',
-                'property_protected',
-                'property_private',
-                'construct',
-                'destruct',
-                'magic',
-                'method_public',
-                'method_protected',
-                'method_private',
-            ],
-        ],
-        'phpdoc_add_missing_param_annotation' => true,
-        'phpdoc_align' => false,
-        'phpdoc_order' => true,
-        'phpdoc_separation' => false,
-        'phpdoc_summary' => false,
-        'trim_array_spaces' => false,
     ])
-    ->setFinder($finder)
-;
+    ->setFinder($finder);

.styleci.yml

@@ -0,0 +1 @@
+preset: symfony

.travis-php-config.ini

@@ -1,2 +0,0 @@
-date.timezone   = Europe/London
-memory_limit    = 2G

.travis.yml

@@ -1,23 +1,12 @@
 language: php
 
 php:
-  - 7.2
-  - 7.3
-  - 7.4
-
-before_install:
-  - sudo locale-gen de_DE.UTF-8 es_ES.UTF-8 en_GB.UTF-8 en_US.UTF-8 fr_FR.UTF-8 it_IT.UTF-8 pl_PL.UTF-8 ru_RU.UTF-8
-  - pear channel-discover pear.phing.info
+  - 5.6
+  - 7.0
+  - 7.1
 
 install:
-  - pear install phing/phing
-  - phpenv rehash
-
-before_script:
-  - phpenv config-add .travis-php-config.ini
+  - composer install
 
 script:
-  - phing
-
-after_success:
-  - travis_retry php vendor/bin/php-coveralls -v
+  - php ./vendor/bin/phpunit

CHANGELOG.md

@@ -1,185 +0,0 @@
-# Meritoo Common Library
-
-Common and useful classes, methods, exceptions etc.
-
-# 1.1.8
-
-1. [Composer] Upgrade all dev packages (to the latest, stable versions for PHP `7.4`)
-2. [BaseCollection] Interfaces of different types of collections. May be used to build specific collections.
-
-# 1.1.7
-
-1. [Arrays] Allow to define a key of next level elements in a function that returns elements from given level
-
-# 1.1.6
-
-1. [Arrays] Function that returns elements from given level
-
-# 1.1.5
-
-1. [BaseCollection] Prepare elements while adding them by `addMultiple()` method in the same way as passing them in
-   constructor.
-
-# 1.1.4
-
-1. [BaseCollection] Fix incorrectly working limit() method
-
-# 1.1.3
-
-1. Move `Renderable` class: `Meritoo\Common` -> `Meritoo\Common\Contract`
-2. Create and implement `CollectionInterface` as contract of all collections (e.g. based on the `BaseCollection` class)
-
-# 1.1.2
-
-1. Change mode of `Xdebug` to `coverage` in Docker's configuration to make it possible to generate code coverage by
-   `PHPUnit`
-2. Mark PHPUnit test as risky when it does not have a `@covers` annotation
-
-# 1.1.1
-
-1. [BaseCollection] Treat the `null` index as "no index" only while adding new element, iow. do not treat empty string
-   as "no index" behaviour.
-2. [Miscellaneous] [Regex] Use simpler & stronger pattern to match name of file
-3. Do not install `hirak/prestissimo` package while running Travis CI (incompatible with your PHP version, PHP
-   extensions and Composer version)
-4. Use PHP `7.4` while running build in Travis CI
-
-# 1.1.0
-
-1. Rename Meritoo\Common\Collection\Collection class to Meritoo\Common\Collection\BaseCollection. Add BaseCollection::
-   isValidType() method to validate type of element before add it to collection. Add BaseCollection ::prepareElements()
-   method to allow preparation of elements in custom way.
-
-# 1.0.6
-
-1. Use `.env` instead of `.env.dist`
-2. Docker > use images (instead of Dockerfiles)
-3. composer > squizlabs/php_codesniffer package > use ^3.4 (instead of ^2.9)
-4. Do not require name of class by BaseTestCaseTrait::assertMethodVisibilityAndArguments() method
-5. PHP CS Fixer > configuration > make more readable & remove unnecessary code
-6. Update .gitignore, docker-compose.yml, phpunit.xml.dist
-
-# 1.0.5
-
-1. Collection > trait > return "void" where "self" causes type hinting problem and is not required
-
-# 1.0.4
-
-1. PHP Coding Standards Fixer > update configuration
-2. Phing > tests > add task for Psalm (https://psalm.dev)
-3. Collection > trait > split into smaller traits (to make it more flexible)
-
-# 1.0.3
-
-1. Travis CI > run many tasks using Phing > update configuration
-2. Template with placeholders > verification of placeholders without values > make stronger and point out which are
-   missing
-3. Reflection > getPropertyValue() method > look for the property in parent classes
-
-# 1.0.2
-
-1. Phing > remove old and unused tools
-2. Phing > configuration > minor updates
-3. Implement Mutation Testing Framework (infection/infection package)
-4. Travis CI > run many tasks using Phing (instead of PHPUnit only)
-5. Fix integration with [Coveralls](https://www.coveralls.io) (available as the badge in [README.md](README.md))
-6. Implement [PHPStan](https://github.com/phpstan/phpstan)
-7. PHPUnit > execute tests in random order
-8. Implement [Psalm](https://github.com/vimeo/psalm)
-9. Infection (Mutation Testing Framework) > fix bugs while running (generate proper code coverage, bugs while running
-   tests randomly)
-10. Phing > php-coveralls > add task
-
-# 1.0.1
-
-1. Regex > make compatible with PHP 7.3 Tests > Regex > fix "preg_match(): Compilation failed: invalid range in
-   character class at offset 4" bug
-2. Collection/storage of templates
-3. Template with placeholders that may be filled by real data
-4. RenderableInterface > something that may be rendered
-
-# 1.0.0
-
-1. Composer > support/require PHP 7.2+ (instead of 5.6+)
-
-# 0.1.8
-
-1. Size, e.g. of image
-
-# 0.1.7
-
-1. Collection > create trait (to make it more flexible)
-
-# 0.1.6
-
-1. Arrays > refactoring & more tests
-2. ValueObject > Human > represents a human
-3. Tests > use `Meritoo\Test\Common` namespace (instead of `Meritoo\Common\Test`)
-4. Tests > use @dataProvider
-
-# 0.1.5
-
-1. Tests > Date > one more test case
-2. Phing > update configuration
-3. Miscellaneous > variableDump() method > remove, because unnecessary
-4. Regex > createSlug() method > returns slug for given value
-5. Arrays > getNonEmptyValues() method > returns non-empty values, e.g. without "" (empty string), null or []
-6. Arrays > getNonEmptyValuesAsString() method > returns non-empty values concatenated by given separator
-7. ValueObject > Company > represents a company
-8. ValueObject > BankAccount > represents bank account
-9. ValueObject > Address > represents address of company, institution, user etc.
-
-# 0.1.4
-
-1. Phing > update configuration
-2. Utilities > Date > update descriptions of methods
-3. Docker > docker-compose.yml > add "phpunit" service > used to run PHPUnit's tests
-4. Reflection > setPropertiesValues() method > sets values of properties in given object
-
-# 0.1.3
-
-1. Tests > refactoring & minor improvements
-2. Utilities > CssSelector > useful methods related to CSS selectors
-3. Utilities > Bootstrap4CssSelector > useful methods related to CSS selectors and the Bootstrap4 (front-end component
-   library)
-
-# 0.1.2
-
-1. Documentation > Value Objects
-2. Docker > improve performance
-3. Utilities > Reflection > setPropertyValue() method > sets value of given property
-
-# 0.1.1
-
-1. TravisCI > run using PHP 7.2 too
-2. ValueObject > class Version > represents version of software
-3. Move version of this package to `VERSION` file (from `composer.json` file)
-
-# 0.1.0
-
-1. Composer > support/require PHP 5.6+ (instead of 5.5.9+)
-2. Docker > rename `php-cli` service to `php`
-3. Exceptions > create instance of exception using static `create()` method (instead of constructor)
-4. Documentation > Exceptions
-
-# 0.0.21
-
-1. Composer > require ext-pcre
-2. Arrays > minor refactoring
-3. Update @author and @copyright in classes' descriptions
-
-# 0.0.20
-
-1. Collection > add() method > treat empty string as not provided index (same as null)
-
-# 0.0.19
-
-1. Add this changelog
-2. Reorganize documentation & update [Readme](README.md)
-3. Docker: use project-related binaries globally
-4. StyleCI & PHP Coding Standards Fixer: update configuration
-5. Documentation > Docker > add paragraph for PHP Coding Standards Fixer
-6. Coding standard > fix automatically
-7. StyleCI configuration > fix bug "The provided fixer 'binary_operator_spaces' cannot be enabled again because it was
-   already enabled"
-8. StyleCI > disable & remove

README.md

@@ -1,49 +1,103 @@
-# Meritoo Common Library
+# Meritoo Common Library [![Travis](https://img.shields.io/travis/rust-lang/rust.svg?style=flat-square)](https://travis-ci.org/meritoo/common-library) [![Packagist](https://img.shields.io/packagist/v/meritoo/common-library.svg?style=flat-square)](https://packagist.org/packages/meritoo/common-library) [![StyleCI](https://styleci.io/repos/101790028/shield?branch=master)](https://styleci.io/repos/101790028) [![license](https://img.shields.io/github/license/meritoo/common-library.svg?style=flat-square)](https://github.com/meritoo/common-library) [![GitHub commits](https://img.shields.io/github/commits-since/meritoo/common-library/0.0.1.svg?style=flat-square)](https://github.com/meritoo/common-library) [![Coverage Status](https://coveralls.io/repos/github/meritoo/common-library/badge.svg?branch=master)](https://coveralls.io/github/meritoo/common-library?branch=master)
+Useful classes, methods, extensions etc.
 
-Common and useful classes, methods, exceptions etc.
+## Installation
 
-![PHP from Packagist](https://img.shields.io/packagist/php-v/meritoo/common-library.svg?style=flat-square)
-[![Build Status](https://travis-ci.com/meritoo/common-library.svg?branch=master&style=flat-square)](https://travis-ci.com/meritoo/common-library)
-[![Packagist](https://img.shields.io/packagist/v/meritoo/common-library.svg?style=flat-square)](https://packagist.org/packages/meritoo/common-library)
-[![license](https://img.shields.io/github/license/meritoo/common-library.svg?style=flat-square)](https://github.com/meritoo/common-library)
-[![GitHub commits](https://img.shields.io/github/commits-since/meritoo/common-library/0.0.1.svg?style=flat-square)](https://github.com/meritoo/common-library)
-[![Coverage Status](https://coveralls.io/repos/github/meritoo/common-library/badge.svg?branch=master&style=flat-square)](https://coveralls.io/github/meritoo/common-library)
+Run [Composer](https://getcomposer.org) to install new package:
 
-# Installation
+    ```bash
+    $ composer require meritoo/common-library
+    ```
 
-In your `composer.json` add address of repository into `repositories` section:
+> How to install Composer: https://getcomposer.org/download
 
-```json
-"repositories": [
-    (...)
+## 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:
+
+```php
+use Meritoo\Common\Utilities\Arrays;
+
+$firstElement = Arrays::getFirstElement(['lorem', 'ipsum']);
+var_dump($firstElement); // string(5) "lorem"
+```
+
+## Base test case with common methods and data providers
+
+Located here: `Meritoo\Common\Test\Base\BaseTestCase`. Just extend the `BaseTestCase` class and use it like in `Meritoo\Common\Test\Utilities\DateTest` class:
+
+```php
+class DateTest extends BaseTestCase
+{
+    /**
+     * @param mixed $value Empty value, e.g. ""
+     * @dataProvider provideEmptyValue
+     */
+    public function testGetDateTimeEmptyValue($value)
     {
-        "type": "vcs",
-        "url": "https://github.com/wiosna-dev/common-library"
+        self::assertFalse(Date::getDateTime($value));
     }
-]
+
+	(...)
+}
 ```
 
-Run [Composer](https://getcomposer.org) to install this package in your project:
+or in `Meritoo\Common\Test\Utilities\MimeTypesTest` class:
 
-```bash
-composer require wiosna-dev/common-library
+```php
+class MimeTypesTest extends BaseTestCase
+{
+	(...)
+
+    /**
+     * @param bool $mimeType The mime type, e.g. "video/mpeg"
+     * @dataProvider provideBooleanValue
+     */
+    public function testGetExtensionBooleanMimeType($mimeType)
+    {
+        self::assertEquals('', MimeTypes::getExtension($mimeType));
+    }
+
+	(...)
+}
 ```
 
-> [How to install Composer?](https://getcomposer.org/download)
+## Collection of elements
 
-# Usage
+Located here: `Meritoo\Common\Collection\Collection`. It's a set of some elements, e.g. objects. It's iterable and countable. Provides very useful methods. Some of them:
+- `getFirst()` - returns the first element in the collection
+- `getLast()` - returns the last element in the collection
+- `isEmpty()` - returns information if collection is empty
+- `add($element, $index = null)` - adds given element (at the end of collection)
+- `addMultiple($elements, $useIndexes = false)` - adds given elements (at the end of collection)
+- `prepend($element)` - prepends given element (adds given element at the beginning of collection)
+- `remove($element)` - removes given element
 
-1. [Base test case (with common methods and data providers)](docs/Base-test-case.md)
-2. [Collection of elements](docs/Collection/BaseCollection.md)
-3. [Exceptions](docs/Static-methods.md)
-4. [Static methods](docs/Static-methods.md)
-    1. [Arrays](docs/Static-methods/Arrays.md)
-    2. [Regex](docs/Static-methods/Regex.md)
-    3. [Uri](docs/Static-methods/Uri.md)
-5. [Value Objects](docs/Value-Objects.md)
+Examples of usage below.
 
-# Development
+#### An empty collection
 
-More information [you can find here](docs/Development.md)
+```php
+use Meritoo\Common\Collection\Collection;
+
+$emptyCollection = new Collection();
+var_dump($emptyCollection->isEmpty()); // bool(true)
+```
+
+#### Simple collection
+
+```php
+use Meritoo\Common\Collection\Collection;
+
+$elements = [
+    'lorem',
+    'ipsum',
+    123 => 'dolor',
+    345 => 'sit',
+];
+
+$simpleCollection = new Collection($elements);
+var_dump($simpleCollection->has('dolor')); // bool(true)
+```
 
 Enjoy!

VERSION

@@ -1 +0,0 @@
-1.1.8

build.xml

@@ -1,30 +1,46 @@
 <?xml version="1.0" encoding="UTF-8"?>
-
 <project name="Meritoo Package" basedir="." default="build:main" phingVersion="2.14.0">
     <!-- Properties -->
     <if>
-        <available file="${project.basedir}/phing/properties" property="custom.properties.available" />
+        <available file="phing/properties" property="custom.properties.available"/>
         <then>
-            <property file="${project.basedir}/phing/properties" />
+            <property file="phing/properties" />
         </then>
         <else>
-            <property file="${project.basedir}/phing/properties.dist" />
+            <property file="phing/properties.dist" />
         </else>
     </if>
 
     <!-- Default / main target -->
     <target name="build:main"
-            depends="build:app,
-                    build:tests"
-    />
+            depends="build:app, build:tests"
+            description="Builds everything and runs all tests" />
 
     <!-- Build app -->
-    <target name="build:app">
-        <phing phingfile="${project.basedir}/phing/app.xml" haltonfailure="true" />
+    <target name="build:app" description="Prepares app to build and tests">
+        <phing phingfile="phing/app.xml" haltonfailure="true" />
     </target>
 
     <!-- Build tests -->
-    <target name="build:tests">
-        <phing phingfile="${project.basedir}/phing/tests.xml" haltonfailure="true" />
+    <target name="build:tests" description="Runs all tests, checks and creates docs">
+        <phing phingfile="phing/tests.xml" haltonfailure="true" />
+
+        <!--
+        Conditional running of tests.
+        Disabled, because not required.
+
+        Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+        2017-02-22
+
+        <if>
+            <equals arg1="${env}" arg2="test" />
+            <then>
+                <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..." />
+            </else>
+        </if>
+        -->
     </target>
 </project>

composer.json

@@ -1,7 +1,8 @@
 {
-    "name": "wiosna-dev/common-library",
+    "name": "meritoo/common-library",
     "description": "Useful classes, methods, extensions etc.",
     "license": "MIT",
+    "version": "0.0.7",
     "authors": [
         {
             "name": "Meritoo.pl",
@@ -10,37 +11,24 @@
         }
     ],
     "require": {
-        "php": "^7.4 || ^8.0",
-        "ext-dom": "*",
-        "ext-fileinfo": "*",
-        "ext-intl": "*",
-        "ext-json": "*",
-        "ext-pcre": "*",
-        "ext-simplexml": "*",
-        "doctrine/orm": "^2.6",
-        "gedmo/doctrine-extensions": "^3.0"
+        "php": ">=5.6.0",
+        "doctrine/orm": "^2.5",
+        "gedmo/doctrine-extensions": "^2.4",
+        "symfony/http-foundation": "^3.3"
     },
     "require-dev": {
-        "friendsofphp/php-cs-fixer": "^3.11",
-        "infection/infection": "^0.26",
-        "php-coveralls/php-coveralls": "^2.5",
-        "phpstan/phpstan": "^1.8",
-        "phpunit/phpunit": "^9",
-        "sebastian/phpcpd": "^6.0",
-        "squizlabs/php_codesniffer": "^3.7",
-        "vimeo/psalm": "^4.0"
+        "phpunit/phpunit": "^4.8 || ^5.0",
+        "squizlabs/php_codesniffer": "^2.8",
+        "phpmd/phpmd": "^2.6",
+        "sebastian/phpcpd": "^3.0",
+        "pdepend/pdepend": "^2.5",
+        "phploc/phploc": "^3.0",
+        "friendsofphp/php-cs-fixer": "^2.1"
     },
     "autoload": {
         "psr-4": {
-            "Meritoo\\Common\\": "src/"
+            "Meritoo\\Common\\": "src/Meritoo/Common/",
+            "Meritoo\\Common\\Test\\": "tests/Meritoo/Common/Test/"
         }
-    },
-    "autoload-dev": {
-        "psr-4": {
-            "Meritoo\\Test\\Common\\": "tests/"
-        }
-    },
-    "config": {
-        "sort-packages": true
     }
 }

docker-compose.yml

@@ -1,33 +0,0 @@
-version: '3'
-
-services:
-    #
-    # Required to run project
-    #
-    php:
-        image: meritoo/php:7.4
-        container_name: ${DOCKER_CONTAINER_OWNER}-${DOCKER_CONTAINER_PROJECT}-php
-        entrypoint: php
-        command: -S 0.0.0.0:9999
-        environment:
-            PHP_DATE_TIMEZONE: ${PHP_DATE_TIMEZONE}
-        volumes:
-            - .:/var/www/application:cached
-    composer:
-        image: meritoo/php:7.4
-        container_name: ${DOCKER_CONTAINER_OWNER}-${DOCKER_CONTAINER_PROJECT}-composer
-        entrypoint: php -d memory_limit=-1 /usr/local/bin/composer
-        volumes:
-            - .:/var/www/application:cached
-    #
-    # Required to run PHPUnit's tests
-    #
-    phpunit:
-        image: meritoo/php:7.4
-        container_name: ${DOCKER_CONTAINER_OWNER}-${DOCKER_CONTAINER_PROJECT}-phpunit
-        entrypoint: ./vendor/bin/phpunit
-        command: --version
-        volumes:
-            - .:/var/www/application:cached
-        environment:
-            XDEBUG_MODE: coverage

docs/Base-test-case.md

@@ -1,63 +0,0 @@
-# Meritoo Common Library
-
-Common and useful classes, methods, exceptions etc.
-
-# Base test case (with common methods and data providers)
-
-Located here: `Meritoo\Common\Test\Base\BaseTestCase`.
-
-##### Usage
-
-1. Just extend the `BaseTestCase` class or implement `Meritoo\Common\Traits\Test\Base\BaseTestCaseTrait` trait.
-2. Use one of available data providers, e.g. `@dataProvider provideEmptyValue`, or asserts,
-   e.g. `static::assertMethodVisibility($method, $visibilityType);`
-
-##### Examples
-
-```php
-class DateTest extends BaseTestCase
-{
-    /**
-     * @param mixed $value Empty value, e.g. ""
-     * @dataProvider provideEmptyValue
-     */
-    public function testGetDateTimeEmptyValue($value)
-    {
-        self::assertFalse(Date::getDateTime($value));
-    }
-
-	(...)
-}
-```
-
-```php
-class MimeTypesTest extends BaseTestCase
-{
-	(...)
-
-    /**
-     * @param bool $mimeType The mime type, e.g. "video/mpeg"
-     * @dataProvider provideBooleanValue
-     */
-    public function testGetExtensionBooleanMimeType($mimeType)
-    {
-        self::assertEquals('', MimeTypes::getExtension($mimeType));
-    }
-
-	(...)
-}
-```
-
-# More
-
-1. [**Base test case (with common methods and data providers)**](Base-test-case.md)
-2. [Collection of elements](Collection/BaseCollection.md)
-3. [Templates](Collection/Templates.md)
-4. [Exceptions](Exceptions.md)
-5. [Static methods](Static-methods.md)
-    1. [Arrays](Static-methods/Arrays.md)
-    2. [Regex](Static-methods/Regex.md)
-    3. [Uri](Static-methods/Uri.md)
-6. [Value Objects](Value-Objects.md)
-
-[‹ Back to `Readme`](../README.md)

docs/Collection/BaseCollection.md

@@ -1,90 +0,0 @@
-# Meritoo Common Library
-
-Common and useful classes, methods, exceptions etc.
-
-# BaseCollection
-
-### Namespace
-
-`Meritoo\Common\Collection\BaseCollection`
-
-### Info
-
-It's a set of some elements with the same type, e.g. objects. It's iterable and countable. Provides very useful methods.
-Some of them:
-
-- `getFirst()` - returns the first element in the collection
-- `getLast()` - returns the last element in the collection
-- `isEmpty()` - returns information if collection is empty
-- `add($element, $index = null)` - adds given element (at the end of collection)
-- `addMultiple($elements, $useIndexes = false)` - adds given elements (at the end of collection)
-- `prepend($element)` - prepends given element (adds given element at the beginning of collection)
-- `remove($element)` - removes given element
-
-### Implementation
-
-You have to implement:
-
-```php
-abstract protected function isValidType($element): bool;
-```
-
-This method verifies 1 element before it will be added to collection. Returns information if the element has valid,
-expected type.
-
-Example (from `Meritoo\Common\Collection\Templates` class):
-
-```php
-protected function isValidType($element): bool
-{
-    return $element instanceof Template;
-}
-```
-
-### Methods to overwrite
-
-You can, if you wish, overwrite these methods:
-
-1. To prepare elements used to initialize the collection in your own way:
-
-    ```php
-    protected function prepareElements(array $elements): array
-    ```
-
-2. To validate type of elements in your own way:
-
-    ```php
-    protected function getElementsWithValidType(array $elements): array
-    ```
-
-### Examples of usage
-
-```php
-use Meritoo\Common\Collection\StringCollection;
-
-$emptyCollection = new StringCollection();
-var_dump($emptyCollection->isEmpty()); // bool(true)
-
-$elements = [
-    'lorem',
-    'ipsum',
-    123 => 'dolor',
-    345 => 'sit',
-];
-
-$simpleCollection = new StringCollection($elements);
-var_dump($simpleCollection->has('dolor')); // bool(true)
-```
-
-# More
-
-1. [Base test case (with common methods and data providers)](../Base-test-case.md)
-2. [**Collection of elements**](BaseCollection.md)
-3. [Templates](Templates.md)
-4. [Exceptions](../Exceptions.md)
-5. [Static methods](../Static-methods.md)
-    1. [Arrays](../Static-methods/Arrays.md)
-    2. [Regex](../Static-methods/Regex.md)
-6. [Value Objects](../Value-Objects.md)
-
-[‹ Back to `Readme`](../../README.md)

docs/Collection/Templates.md

@@ -1,67 +0,0 @@
-# Meritoo Common Library
-
-Common and useful classes, methods, exceptions etc.
-
-# Templates
-
-### Namespace
-
-`Meritoo\Common\Collection\Templates`
-
-### Info
-
-Collection/storage of templates, instance of `Meritoo\Common\ValueObject\Template` class.
-
-##### New instance
-
-New instance can be created using:
-
-1. Constructor:
-
-   ```php
-   new Templates([
-       'first' => new Template('First name: %first_name%'),
-       'last'  => new Template('Last name: %last_name%'),
-   ]);
-   ```
-
-2. Static method `fromArray(array $templates)` - creates and returns the collection from given array
-
-   ```php
-   Templates::fromArray([
-       'first' => 'First name: %first_name%',
-       'last'  => 'Last name: %last_name%',
-   ]);
-   ```
-
-##### Methods
-
-Has all methods of parent class `Meritoo\Common\Collection\Collection` + `findTemplate(string $index)` method that finds
-and returns template with given index.
-
-Example of usage:
-
-```php
-$templates = new Templates([
-	'first' => new Template('First name: %first_name%'),
-    'last'  => new Template('Last name: %last_name%'),
-]);
-
-$template = $templates->findTemplate('first'); // new Template('First name: %first_name%')
-```
-
-Throws an `Meritoo\Common\Exception\ValueObject\Template\TemplateNotFoundException` exception if template with given
-index was not found.
-
-# More
-
-1. [Base test case (with common methods and data providers)](../Base-test-case.md)
-2. [Collection of elements](BaseCollection.md)
-3. [**Templates**](Templates.md)
-4. [Exceptions](../Exceptions.md)
-5. [Static methods](../Static-methods.md)
-    1. [Arrays](../Static-methods/Arrays.md)
-    2. [Regex](../Static-methods/Regex.md)
-6. [Value Objects](../Value-Objects.md)
-
-[‹ Back to `Readme`](../../README.md)

docs/Development.md

@@ -1,159 +0,0 @@
-# Meritoo Common Library
-
-Development-related information
-
-# Requirements
-
-* [Docker](https://www.docker.com)
-* Your favourite IDE :)
-
-# Getting started
-
-1. Build, create and start Docker's containers by running command:
-
-    ```bash
-    docker-compose up -d
-    ```
-
-2. Rebuild project by running command (installs packages, prepares required directories and runs tests):
-
-   ```bash
-   docker-compose exec php phing
-   ```
-
-> [What is Docker?](https://www.docker.com/what-docker)
-
-# Composer
-
-Available as `composer` service. You can run any Composer's command using the `composer` service:
-
-```bash
-docker-compose run --rm composer [command]
-```
-
-Examples below.
-
-##### Install packages
-
-```bash
-docker-compose run --rm composer install
-```
-
-##### Update packages
-
-```bash
-docker-compose run --rm composer update
-```
-
-##### Add package
-
-```bash
-docker-compose run --rm composer require [vendor]/[package]
-```
-
-##### Remove package
-
-```bash
-docker-compose run --rm composer remove [vendor]/[package]
-```
-
-# Coding Standards Fixer
-
-Fix coding standard by running command:
-
-```bash
-docker-compose exec php php-cs-fixer fix
-```
-
-or
-
-```bash
-docker-compose exec php phing -f phing/tests.xml build:fix-coding-standards
-```
-
-Omit cache and run the Fixer from scratch by running command:
-
-```bash
-docker-compose exec php rm .php_cs.cache && docker-compose exec php php-cs-fixer fix
-```
-
-> [Want more?](https://cs.sensiolabs.org)
-
-# Tests
-
-### Prerequisites
-
-Install required packages by running command: `docker-compose run --rm composer install`.
-
-### Running [PHPUnit](https://phpunit.de) tests
-
-##### Easy (with code coverage)
-
-```bash
-docker-compose run --rm phpunit --verbose
-```
-
-or
-
-```bash
-docker-compose exec php phing -f phing/tests.xml test:phpunit
-```
-
-##### Quick (without code coverage)
-
-```bash
-docker-compose run --rm phpunit --verbose --no-coverage
-```
-
-# Infection - Mutation Testing
-
-Served by [Infection — Mutation Testing Framework](https://infection.github.io).
-
-### Running tests
-
-```bash
-$ docker-compose exec php bash
-root@18f2f0cfaa5d:/var/www/application# XDEBUG_MODE=coverage ./vendor/bin/infection --threads=$(nproc)
-```
-
-or
-
-```bash
-$ docker-compose exec php bash
-root@18f2f0cfaa5d:/var/www/application# XDEBUG_MODE=coverage phing -f phing/tests.xml test:infection
-```
-
-### Result of testing
-
-##### Terminal
-
-Example of output:
-
-```bash
-125 mutations were generated:
-     105 mutants were killed
-       3 mutants were not covered by tests
-       5 covered mutants were not detected
-       0 errors were encountered
-      12 time outs were encountered
-
-Metrics:
-         Mutation Score Indicator (MSI): 93%
-         Mutation Code Coverage: 97%
-         Covered Code MSI: 95%
-```
-
-##### Stored in `build/reports/infection` directory
-
-* `build/reports/infection/infection-log.txt`
-* `build/reports/infection/summary-log.txt`
-
-# Other
-
-Rebuild project and run tests by running command:
-
-```bash
-docker-compose exec php phing
-```
-
-[‹ Back to `Readme`](../README.md)

docs/Exceptions.md

@@ -1,70 +0,0 @@
-# Meritoo Common Library
-
-Common and useful classes, methods, exceptions etc.
-
-# Exceptions
-
-### Create instance of exception
-
-This package contains a lot of exceptions. Each of them contains static method `create()` with proper arguments that is
-used to create instance of the exception. Example:
-
-```php
-use Meritoo\Common\Exception\Bundle\IncorrectBundleNameException;
-throw IncorrectBundleNameException::create('RisusIpsum');
-```
-
-### Base exception for unknown type of something
-
-##### Short description
-
-It's a `Meritoo\Common\Exception\Base\UnknownTypeException` class. Related to `Meritoo\Common\Type\Base\BaseType` class
-that represents type of something, e.g. type of button, order.
-
-##### Usage
-
-You can extend `Meritoo\Common\Exception\Base\UnknownTypeException` class and create your own static method,
-e.g. `createException()`, which will be used create instance of the exception. Inside the `createException()` method you
-can call `parent::create()` method.
-
-##### Example
-
-```php
-<?php
-
-namespace Your\Package\Exception\Type;
-
-use Meritoo\Common\Exception\Base\UnknownTypeException;
-use Your\Package\Type\SimpleType;
-
-class UnknownSimpleTypeException extends UnknownTypeException
-{
-    /**
-     * Creates exception
-     *
-     * @param string $unknownType Unknown and simple type
-     * @return UnknownSimpleTypeException
-     */
-    public static function createException($unknownType)
-    {
-        /* @var UnknownSimpleTypeException $exception */
-        $exception = parent::create($unknownType, new SimpleType(), 'my simple type of something');
-
-        return $exception;
-    }
-}
-```
-
-# More
-
-1. [Base test case (with common methods and data providers)](Base-test-case.md)
-2. [Collection of elements](Collection/BaseCollection.md)
-3. [Templates](Collection/Templates.md)
-4. [**Exceptions**](Exceptions.md)
-5. [Static methods](Static-methods.md)
-    1. [Arrays](Static-methods/Arrays.md)
-    2. [Regex](Static-methods/Regex.md)
-    3. [Uri](Static-methods/Uri.md)
-6. [Value Objects](Value-Objects.md)
-
-[&lsaquo; Back to `Readme`](../README.md)

docs/Static-methods.md

@@ -1,29 +0,0 @@
-# Meritoo Common Library
-
-Common and useful classes, methods, exceptions etc.
-
-# 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:
-
-```php
-use Meritoo\Common\Utilities\Arrays;
-
-$firstElement = Arrays::getFirstElement(['lorem', 'ipsum']);
-var_dump($firstElement); // string(5) "lorem"
-```
-
-# More
-
-1. [Base test case (with common methods and data providers)](Base-test-case.md)
-2. [Collection of elements](Collection/BaseCollection.md)
-3. [Templates](Collection/Templates.md)
-4. [Exceptions](Exceptions.md)
-5. [**Static methods**](Static-methods.md)
-    1. [Arrays](Static-methods/Arrays.md)
-    2. [Regex](Static-methods/Regex.md)
-    3. [Uri](Static-methods/Uri.md)
-6. [Value Objects](Value-Objects.md)
-
-[‹ Back to `Readme`](../README.md)

docs/Static-methods/Arrays.md

@@ -1,109 +0,0 @@
-# Meritoo Common Library
-
-Common and useful classes, methods, exceptions etc.
-
-# Arrays
-
-> Useful methods related to arrays
-
-Class: `Meritoo\Common\Utilities\Arrays`
-File: `src/Utilities/Arrays.php`
-
-### containsEmptyStringsOnly(array): bool
-
-> Returns information if given array contains an empty strings only
-
-##### Arguments
-
-- `array $array` - The array to verify
-
-##### Examples
-
-1)
-
-- array: `[]` (an empty array)
-- result: `false`
-
-2)
-
-- array: `["", -1]`
-- result: `false`
-
-3)
-
-- array: `["", null, ""]`
-- result: `true`
-
-### getNonEmptyValues(array $values)
-
-> Returns non-empty values, e.g. without "" (empty string), null or []
-
-##### Arguments
-
-- `array $values` - The values to filter
-
-##### Examples
-
-1)
-
-- values: `[]` (no values)
-- result: `[]` (an empty array)
-
-2)
-
-- values: `[null, ""]` (all empty values)
-- result: `[]` (an empty array)
-
-3)
-
-- values: `["test 1", "", 123, null, 0]`
-- result: `["test 1", 123, 0]`
-
-### getNonEmptyValuesAsString(array $values, $separator = ', ')
-
-> Returns non-empty values concatenated by given separator
-
-##### Arguments
-
-- `array $values` - The values to filter
-- `[string $separator]` - (optional) Separator used to implode the values. Default: ", ".
-
-##### Examples
-
-1)
-
-- values: `[]` (no values)
-- separator: default or any other string
-- result: `""` (an empty string)
-
-2)
-
-- values: `[null, ""]` (all empty values)
-- separator: default or any other string
-- result: `""` (an empty string)
-
-3)
-
-- values: `["test 1", "", 123, null, 0]`
-- separator: `", "` (default)
-- result: `"test 1, 123, 0"`
-
-4)
-
-- values: `["test 1", "", 123, null, 0]`
-- separator: `" | "`
-- result: `"test 1 | 123 | 0"`
-
-# More
-
-1. [Base test case (with common methods and data providers)](../Base-test-case.md)
-2. [Collection of elements](../Collection/BaseCollection.md)
-3. [Templates](../Collection/Templates.md)
-4. [Exceptions](../Exceptions.md)
-5. [Static methods](../Static-methods.md)
-    1. [**Arrays**](Arrays.md)
-    2. [Regex](Regex.md)
-    3. [Uri](Uri.md)
-6. [Value Objects](../Value-Objects.md)
-
-[‹ Back to `Readme`](../../README.md)

docs/Static-methods/Regex.md

@@ -1,99 +0,0 @@
-# Meritoo Common Library
-
-Common and useful classes, methods, exceptions etc.
-
-# Regex
-
-> Useful methods related to regular expressions
-
-Class: `Meritoo\Common\Utilities\Regex`
-File: `src/Utilities/Regex.php`
-
-### createSlug($value)
-
-> Returns slug for given value
-
-##### Arguments
-
-- `string $value` - Value that should be transformed to slug
-
-##### Examples
-
-1)
-
-- value: non-scalar or `null`
-- result: `false`
-
-2)
-
-- value: `""` (an empty string)
-- result: `""` (an empty string)
-
-3)
-
-- value: `"Lorem ipsum. Dolor sit 12.34 amet."`
-- result: `"lorem-ipsum-dolor-sit-1234-amet"`
-
-### clearBeginningSlash(string): string
-
-> Clears, removes slash from the beginning of given string
-
-##### Arguments
-
-- `string $string` - String that may contains slash as the 1st character
-
-##### Examples
-
-1)
-
-- string: `"lorem ipsum"`
-- result: `"lorem ipsum"`
-
-2)
-
-- string: `"/lorem ipsum"`
-- result: `"lorem ipsum"`
-
-3)
-
-- string: `"/ lorem 123 ipsum"`
-- result: `" lorem 123 ipsum"`
-
-### clearEndingSlash(string): string
-
-> Clears, removes slash from the end of given string
-
-##### Arguments
-
-- `string $string` - String that may contains slash as the last character
-
-##### Examples
-
-1)
-
-- string: `"lorem ipsum"`
-- result: `"lorem ipsum"`
-
-2)
-
-- string: `"lorem ipsum/"`
-- result: `"lorem ipsum"`
-
-3)
-
-- string: `"lorem 123 ipsum /"`
-- result: `"lorem 123 ipsum "`
-
-# More
-
-1. [Base test case (with common methods and data providers)](../Base-test-case.md)
-2. [Collection of elements](../Collection/BaseCollection.md)
-3. [Templates](../Collection/Templates.md)
-4. [Exceptions](../Exceptions.md)
-5. [Static methods](../Static-methods.md)
-    1. [Arrays](../Static-methods/Arrays.md)
-    2. [**Regex**](Regex.md)
-    3. [Uri](Uri.md)
-6. [Value Objects](../Value-Objects.md)
-
-[‹ Back to `Readme`](../../README.md)

docs/Static-methods/Uri.md

@@ -1,47 +0,0 @@
-# Meritoo Common Library
-
-Common and useful classes, methods, exceptions etc.
-
-# Uri
-
-> Useful methods related to uri
-
-Class: `Meritoo\Common\Utilities\Uri`
-File: `src/Utilities/Uri.php`
-
-### buildUrl(string, string ...): string
-
-> Builds url with given root url and parts of url (concatenates them using "/")
-
-##### Arguments
-
-- `string $rootUrl` - Protocol and domain (or domain only)
-- `string ...$urlParts` - Parts of url that will be concatenated with the rool url by "/"
-
-##### Examples
-
-1)
-
-- rootUrl: `"http://my.example"`
-- urlParts: `""` (an empty string)
-- result: `"http://my.example"`
-
-2)
-
-- rootUrl: `"http://my.example"`
-- urlParts: `"/test", "/123"`
-- result: `"http://my.example/test/123"`
-
-# More
-
-1. [Base test case (with common methods and data providers)](../Base-test-case.md)
-2. [Collection of elements](../Collection/BaseCollection.md)
-3. [Templates](../Collection/Templates.md)
-4. [Exceptions](../Exceptions.md)
-5. [Static methods](../Static-methods.md)
-    1. [Arrays](Arrays.md)
-    2. [Regex](Regex.md)
-    3. [**Uri**](Uri.md)
-6. [Value Objects](../Value-Objects.md)
-
-[‹ Back to `Readme`](../../README.md)

docs/Value-Objects.md

@@ -1,365 +0,0 @@
-# Meritoo Common Library
-
-Common and useful classes, methods, exceptions etc.
-
-# Value Objects
-
-Located in `Meritoo\Common\ValueObject` namespace and in `src/ValueObject/` directory.
-
-### Address
-
-##### Namespace
-
-`Meritoo\Common\ValueObject\Address`
-
-##### Info
-
-Represents address of company, institution, user etc. Contains properties:
-
-1. `$street` - the street
-2. `$buildingNumber` - the number of building
-3. `$flatNumber` - the number of flat
-4. `$zipCode` - the zip code
-5. `$city` - the city, location
-
-##### New instance
-
-New instance can be created using constructor
-
-```php
-new Address('New York', '00123', '4th Avenue', '10', '200');
-```
-
-##### Methods
-
-Has getters for each property, e.g. `getFlatNumber()` or `getZipCode()`, and 1 extra method:
-
-```php
-getFullStreet()
-```
-
-that returns name of street with related numbers (building & flat number).
-
-Example:
-
-```php
-$address = new Address('New York', '00123', '4th Avenue', '10', '200');
-$fullStreet = $address->getFullStreet(); // "4th Avenue 10/200"
-```
-
-##### Conversion to string (the `__toString()` method)
-
-Instance of `Address` may be represented as string that contains all non-empty properties separated by `, `.
-
-Example:
-
-```php
-$address = new Address('New York', '00123', '4th Avenue', '10', '200');
-$asString = (string)$address; // "4th Avenue 10/200, 00123, New York"
-```
-
-### BankAccount
-
-##### Namespace
-
-`Meritoo\Common\ValueObject\BankAccount`
-
-##### Info
-
-Represents bank account. Contains properties:
-
-1. `$bankName` - name of bank
-2. `$accountNumber` - number of bank's account
-
-##### New instance
-
-New instance can be created using constructor
-
-```php
-new BankAccount('Bank of America', '1234567890')
-```
-
-##### Methods
-
-Has getters for each property `getBankName()` and `getAccountNumber()`.
-
-##### Conversion to string (the `__toString()` method)
-
-Instance of `BankAccount` may be represented as string that contains all non-empty properties separated by `, `.
-
-Example:
-
-```php
-$bank = new BankAccount('Bank of America', '1234567890');
-$asString = (string)$bank; // "Bank of America, 1234567890"
-```
-
-### Company
-
-##### Namespace
-
-`Meritoo\Common\ValueObject\Company`
-
-##### Info
-
-Represents a company. Contains properties:
-
-1. `$name` - name of company
-2. `$address` - address of company
-3. `$bankAccount` - bank account of company
-
-##### New instance
-
-New instance can be created using constructor:
-
-```php
-new Company(
-    'Test 1',
-    new Address('New York', '00123', '4th Avenue', '10', '200'),
-    new BankAccount('Bank 1', '12345')
-);
-```
-
-##### Methods
-
-Has getters for each property `getName()`, `getAddress()` and `getBankAccount()`.
-
-##### Conversion to string (the `__toString()` method)
-
-Instance of `Company` may be represented as string that contains all non-empty properties separated by `, `.
-
-Example:
-
-```php
-$company = new Company(
-    'Test 1',
-    new Address('New York', '00123', '4th Avenue', '10', '200'),
-    new BankAccount('Bank 1', '12345')
-);
-
-$asString = (string)$company; // "Test 1, 4th Avenue 10/200, 00123, New York, Bank 1, 12345"
-```
-
-### Human
-
-##### Namespace
-
-`Meritoo\Common\ValueObject\Human`
-
-##### Info
-
-Represents human. Based on `\Meritoo\Common\Traits\ValueObject\HumanTrait` trait. Contains properties same
-as `HumanTrait` trait:
-
-1. `$firstName` - first name
-2. `$lastName` - last name
-3. `$email` - email address
-4. `$birthDate` - birth date
-
-##### New instance
-
-New instance can be created using constructor:
-
-```php
-new Human('John', 'Scott', 'john@scott.com', new \DateTime('2001-01-01'));
-```
-
-##### Methods
-
-Has getters for each property, e.g. `getFirstName()`, `getEmail()` etc.
-
-##### Conversion to string (the `__toString()` method)
-
-Instance of `Human` may be represented as string that contains first name, last name and email address (if provided).
-
-Example:
-
-```php
-$human1 = new Human('John', 'Scott');
-$asString1 = (string)$human1; // "John Scott"
-
-$human2 = new Human('John', 'Scott', 'john@scott.com', new \DateTime('2001-01-01'));
-$asString2 = (string)$human2; // "John Scott <john@scott.com>"
-```
-
-### Size
-
-##### Namespace
-
-`Meritoo\Common\ValueObject\Size`
-
-##### Info
-
-Size, e.g. of image. Contains properties:
-
-1. `width` - the width
-2. `height` - the height
-3. `unit` - unit used when width or height should be returned with unit, default: `"px"`
-4. `separator` - separator used when converting to string, default: `" x "`
-
-##### New instance
-
-New instance can be created using static methods:
-
-1. `fromArray()` - creates new instance from given array
-
-    ```php
-    // Using default "px" unit
-    Size::fromArray([200, 100]);
-
-    // With custom "mm" unit
-    Size::fromArray([200, 100], 'mm');
-    ```
-
-2. `fromString()` - creates new instance from given string
-
-    ```php
-    // Using default "px" unit and default " x " separator
-    Size::fromString('200 x 100');
-
-	// With custom "mm" unit and " X " separator
-    Size::fromString('200 X 100', 'mm', ' X ');
-    ```
-
-##### Methods
-
-Has:
-
-- getters and setters for `width` and `height` properties.
-- setter for `separator` property
-- `toString()` and `toArray()` methods that returns size represented as string and array
-
-##### Conversion to string (using `__toString()` method)
-
-Instance of `Size` may be represented as string that contains width and height separated by separator (default: `" x "`)
-.
-
-Example:
-
-```php
-$size = Size::fromArray([200, 100]);
-
-// With default separator
-$asString1 = (string)$size; // "200 x 100"
-
-// With custom separator
-$size->setSeparator('X');
-$asString2 = (string)$size; // "200X100"
-```
-
-### Template
-
-##### Namespace
-
-`Meritoo\Common\ValueObject\Template`
-
-##### Info
-
-Template with placeholders that may be filled by real data. Contains properties:
-
-1. `$content` - raw string with placeholders (content of the template)
-
-##### New instance
-
-New instance can be created using constructor:
-
-```php
-new Template('First name: %first_name%');
-```
-
-Each placeholder should be wrapped by `%` character, e.g. `%first_name%`. If content of template is an empty string or
-does not contain 1 placeholder at least, an `Meritoo\Common\Exception\ValueObject\Template\InvalidContentException`
-exception will be thrown.
-
-Examples of invalid content of template:
-
-```php
-new Template(''); // An empty string
-new Template('test'); // Without placeholders
-new Template('This is %test'); // With starting tag only (invalid placeholder)
-```
-
-##### Methods
-
-Has 1 public method: `fill(array $values)`. Returns content of the template filled with given values (by replacing
-placeholders with their proper values).
-
-Example of usage:
-
-```php
-$template = new Template('My name is %name% and I am %profession%');
-$result = $template->fill([
-	'name'       => 'Jane',
-    'profession' => 'photographer',
-]); // "My name is Jane and I am photographer"
-```
-
-Throws an `Meritoo\Common\Exception\ValueObject\Template\NotEnoughValuesException` exception if there is not enough
-values (iow. more placeholders than values).
-
-### Version
-
-##### Namespace
-
-`Meritoo\Common\ValueObject\Version`
-
-##### Info
-
-Represents version of software. Contains properties:
-
-1. `$majorPart` - the "major" part of version
-2. `$minorPart` - the "minor" part of version
-3. `$patchPart` - the "patch" part of version
-
-##### New instance
-
-New instance can be created using:
-
-1. Constructor:
-
-   ```php
-   new Version(1, 0, 2);
-   ```
-
-2. Static methods:
-    1. `fromArray(array $version)` - creates new instance using given version as array
-
-   ```php
-   Version::fromArray([1, 0, 2]);
-   ```
-
-    2. `fromString(string $version)` - creates new instance using given version as string:
-
-   ```php
-   Version::fromString('1.0.2');
-   ```
-
-##### Methods
-
-Has getters for each property: `getMajorPart()`, `getMinorPart()`, `getPatchPart()`.
-
-##### Conversion to string (using `__toString()` method)
-
-Instance of `Version` may be represented as string that contains all properties separated by `.` (`$majorPart`
-.`$minorPart`.`$patchPart`).
-
-Example:
-
-```php
-$version = new Version(1, 0, 2);
-$asString = (string)$version; // "1.0.2"
-```
-
-# More
-
-1. [Base test case (with common methods and data providers)](Base-test-case.md)
-2. [Collection of elements](Collection/BaseCollection.md)
-3. [Templates](Collection/Templates.md)
-4. [Exceptions](Exceptions.md)
-5. [Static methods](Static-methods.md)
-    1. [Arrays](Static-methods/Arrays.md)
-    2. [Regex](Static-methods/Regex.md)
-    3. [Uri](Static-methods/Uri.md)
-6. [**Value Objects**](Value-Objects.md)
-
-[&lsaquo; Back to `Readme`](../README.md)

infection.json.dist

@@ -1,13 +0,0 @@
-{
-    "timeout": 10,
-    "source": {
-        "directories": [
-            "src"
-        ]
-    },
-    "logs": {
-        "text": "build/reports/infection/infection-log.txt",
-        "summary": "build/reports/infection/summary-log.txt",
-        "debug": "build/reports/infection/debug-log.txt"
-    }
-}

phing/app.xml

@@ -1,169 +1,79 @@
 <?xml version="1.0" encoding="UTF-8"?>
-
-<project name="Meritoo Package" basedir="." default="build:main" phingVersion="2.16.0">
+<project name="Meritoo Package" basedir="." default="build:main" phingVersion="2.14.0">
     <!-- Properties -->
     <if>
-        <available file="${project.basedir}/phing/properties" property="custom.properties.available" />
+        <available file="phing/properties" property="custom.properties.available"/>
         <then>
-            <property file="${project.basedir}/phing/properties" />
+            <property file="phing/properties" />
         </then>
         <else>
-            <property file="${project.basedir}/phing/properties.dist" />
+            <property file="phing/properties.dist" />
         </else>
     </if>
 
-    <!-- Filesets -->
-    <import file="${project.basedir}/phing/filesets.xml" />
-
     <!-- Default / main target -->
     <target name="build:main"
             depends="build:app"
-    />
+            description="Builds the application" />
 
     <!-- App target -->
     <target name="build:app"
-            depends="app:clean,
-                    app:composer:self-update,
-                    app:composer:install,
-                    app:composer:validate,
-                    app:checkout"
-    />
+            depends="app:composer, app:vendors, app:checkout"
+            description="Prepares app to build." />
+
+    <!-- Check / update composer -->
+    <target name="app:composer" description="Checks / updates composer">
+        <echo msg="Checking / updating composer..." />
 
-    <!-- Updates Composer -->
-    <target name="app:composer:self-update">
         <if>
-            <not>
-                <available file="${composer.path}" property="composer.local.unavailable" />
-            </not>
+            <available file="composer.phar" />
             <then>
+                <echo msg="[Skipped] Downloading of Composer skipped, because exist in the project..." />
+            </then>
+            <else>
                 <if>
                     <os family="windows" />
                     <then>
                         <fail message="Composer not found! Go to http://getcomposer.org/download and download the Composer." />
                     </then>
                     <else>
-                        <exec command="${composer.download_command}" checkreturn="true" passthru="true" />
+                        <exec command="${composer.download_command}" checkreturn="true" />
                     </else>
                 </if>
+            </else>
+        </if>
+        <composer command="selfupdate" />
+    </target>
+
+    <!-- Project Install/update vendors -->
+    <target name="app:vendors" description="Installs / updates vendors">
+        <echo msg="Installing / updating vendors..." />
+
+        <if>
+            <istrue value="${composer.self-update}"/>
+            <then>
+                <composer php="${composer.php}" composer="${composer.path}" command="self-update"/>
             </then>
         </if>
 
-        <!-- Update Composer -->
-        <composer php="${composer.php}" composer="${composer.path}" command="selfupdate">
-            <arg value="--ansi" />
-        </composer>
-    </target>
+        <if>
+            <istrue value="${composer.validate}"/>
+            <then>
+                <composer php="${composer.php}" composer="${composer.path}" command="validate"/>
+            </then>
+        </if>
 
-    <!-- Validates composer.* files -->
-    <target name="app:composer:validate" depends="app:composer:install">
-        <composer php="${composer.php}" composer="${composer.path}" command="validate">
-            <arg value="--no-check-all" />
-            <arg value="--strict" />
-            <arg value="--ansi" />
-        </composer>
-    </target>
-
-    <!-- Project clean -->
-    <target name="app:clean">
         <if>
             <equals arg1="${env}" arg2="prod" />
             <then>
-                <echo message="[Skipped] Cleaning project (and directories cleanup) -> 'prod' environment" />
+                <composer php="${composer.php}" composer="${composer.path}" command="install">
+                    <arg value="--optimize-autoloader" />
+                </composer>
             </then>
             <else>
-                <foreach list="${directoriesToEmpty}" param="directory" target="app:clean:empty" />
+                <composer php="${composer.php}" composer="${composer.path}" command="install" />
             </else>
         </if>
-
-        <foreach list="${directoriesToCheck}" param="directory" target="app:clean:check" />
-        <foreach list="${directoriesToEmpty}" param="directory" target="app:permissions" />
-    </target>
-
-    <!-- Cleaning directory (making empty) directory -->
-    <target name="app:clean:empty">
-        <if>
-            <available file="${directory}" type="dir" property="dir_is_available" />
-            <then>
-                <delete includeemptydirs="true" dir="${directory}" />
-            </then>
-        </if>
-    </target>
-
-    <!-- Checking if directory exists -->
-    <target name="app:clean:check">
-        <if>
-            <not>
-                <available file="${directory}" type="dir" property="dir_is_available" />
-            </not>
-            <then>
-                <if>
-                    <or>
-                        <contains string="${directory}" substring="cache" />
-                        <contains string="${directory}" substring="logs" />
-                        <contains string="${directory}" substring="sessions" />
-                    </or>
-                    <then>
-                        <mkdir dir="${directory}" mode="0777" />
-                    </then>
-                    <else>
-                        <mkdir dir="${directory}" mode="0775" />
-                    </else>
-                </if>
-            </then>
-        </if>
-    </target>
-
-    <!-- Installs vendors -->
-    <target name="app:composer:install" depends="app:composer:self-update">
-        <composer php="${composer.php}" composer="${composer.path}" command="install">
-            <arg value="--optimize-autoloader" />
-            <arg value="--ansi" />
-        </composer>
-    </target>
-
-    <!-- Clearing cache -->
-    <target name="app:cache">
-        <if>
-            <istrue value="${cache.clearWithWarmup}" />
-            <then>
-                <SymfonyConsole console="bin/console" command="cache:clear">
-                    <arg name="env" value="${env}" />
-                </SymfonyConsole>
-            </then>
-            <else>
-                <SymfonyConsole console="bin/console" command="cache:clear">
-                    <arg name="env" value="${env}" />
-                    <arg name="no-warmup" />
-                </SymfonyConsole>
-            </else>
-        </if>
-    </target>
-
-    <!-- Clearing cache (faster) -->
-    <target name="app:cache:faster">
-        <SymfonyConsole console="bin/console" command="cache:clear">
-            <arg name="env" value="${env}" />
-            <arg name="no-optional-warmers" />
-        </SymfonyConsole>
-    </target>
-
-    <!-- Warming up cache -->
-    <target name="app:cache:warmup">
-        <SymfonyConsole console="bin/console" command="cache:warmup">
-            <arg name="env" value="${env}" />
-        </SymfonyConsole>
-    </target>
-
-    <!-- Setting permissions of given directory -->
-    <target name="app:permissions">
-        <if>
-            <not>
-                <os family="windows" />
-            </not>
-            <then>
-                <exec command="chmod -R 777 ${directory}/*" />
-            </then>
-        </if>
     </target>
 
     <!-- Checkout and finalization -->

phing/composer-install.sh

@@ -1,20 +0,0 @@
-#!/bin/sh
-
-EXPECTED_SIGNATURE="$(curl -L https://composer.github.io/installer.sig)"
-# Original line (with wget):
-# EXPECTED_SIGNATURE="$(wget -q -O - https://composer.github.io/installer.sig)"
-
-php -r "copy('https://getcomposer.org/installer', 'composer-setup.php');"
-ACTUAL_SIGNATURE="$(php -r "echo hash_file('SHA384', 'composer-setup.php');")"
-
-if [[ "$EXPECTED_SIGNATURE" != "$ACTUAL_SIGNATURE" ]]
-then
-    >&2 echo 'ERROR: Invalid installer signature'
-    rm composer-setup.php
-    exit 1
-fi
-
-php composer-setup.php --quiet
-RESULT=$?
-rm composer-setup.php
-exit ${RESULT}

phing/filesets.xml

@@ -1,14 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-
-<project name="Meritoo Package" basedir="." default="build:main" phingVersion="2.16.0">
-    <!-- Directories to check -->
-    <property name="directoriesToCheck" value="
-        ${dir.data.tests},
-        ${dir.data.temporary}"
-    />
-
-    <!-- Directories to empty -->
-    <property name="directoriesToEmpty" value="
-        ${dir.data.temporary}"
-    />
-</project>

phing/properties.dist

@@ -1,3 +1,19 @@
+# --------------------------------------------------------------------------------
+# Information
+# --------------------------------------------------------------------------------
+
+# Property files contain key/value pairs
+# key = value
+#
+# Property keys may contain alphanumeric chars and colons, but
+# not special chars. This way you can create pseudo-namespaces
+#
+# You can refer to values of other properties by enclosing their keys in "${}".
+# Example: dir.js = ${dir.web}/js
+#
+# Everything behind the equal sign is the value, you do
+# not have to enclose strings: text=This is some text, Your OS is ${php.os}
+
 # --------------------------------------------------------------------------------
 # Common, e.g. default environment
 # --------------------------------------------------------------------------------
@@ -6,84 +22,104 @@
 #
 env = dev
 
+# Install assets using symlinks
+#
+assets.installWithSymlink = true
+
 # Clear cache with the "warmup" option
 #
-# 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
-#
-# Meritoo <github@meritoo.pl>
-# 2017-06-06
-#
-cache.clearWithWarmup = false
+cache.clearWithWarmup = true
 
 # --------------------------------------------------------------------------------
 # Composer
 # --------------------------------------------------------------------------------
 
-# Command used to download Composer
-#
-composer.download_command = bash ${project.basedir}/phing/composer-install.sh
+composer.download_command = php -r "eval('?>'.file_get_contents('https://getcomposer.org/installer'));"
 
-# Path to Composer executable or downloaded composer.phar file
+# Path to composer executable or composer.phar file
 #
-composer.path = ${project.basedir}/composer.phar
+composer.path = composer.phar
+#composer.path = /usr/local/bin/composer
 
-# Path to PHP executable used by Composer
+# Path to php executable used by composer
 #
 composer.php = php
 
+# Self update of the composer
+#
+composer.self-update = false
+
+# Validate the composer.json file
+#
+composer.validate = false
+
 # --------------------------------------------------------------------------------
 # Directories
 # --------------------------------------------------------------------------------
 
 # System directories
 #
-dir.src = ${project.basedir}/src
 dir.data = ${project.basedir}/data
+dir.src = ${project.basedir}/src
 dir.tests = ${project.basedir}/tests
 
+# --------------------------------------------------------------------------------
 # Build directories
-#
-dir.build = ${project.basedir}/build
-dir.reports = ${dir.build}/reports
-dir.reports.coverage = ${dir.reports}/phpunit-coverage
-dir.reports.code_sniffer = ${dir.reports}/code_sniffer
+# --------------------------------------------------------------------------------
 
-# Data directories
+dir.build = ${project.basedir}/build
+dir.reports = ${dir.build}/logs
+dir.reports.pdepend = ${dir.reports}/pdepend
+dir.reports.coverage = ${dir.reports}/phpunit_coverage
 #
+# Disabled, because unnecessary right now
+# phpdocumentor/phpdocumentor cannot be installed via Composer
+#
+# Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+# 2017-02-22
+#
+#dir.docs = ${dir.build}/docs
+#dir.docs.phpdoc2 = ${dir.docs}/phpdoc2
+
+# --------------------------------------------------------------------------------
+# Data directories
+# --------------------------------------------------------------------------------
+
 dir.data.tests = ${dir.data}/tests
 dir.data.temporary = ${dir.data}/tmp
 
-# --------------------------------------------------------------------------------
-# Static Analysis
-# --------------------------------------------------------------------------------
-
-# Paths of frameworks used to run analysis:
-# - PHPStan
-#
-check.phpstan.command = ./vendor/bin/phpstan analyse
-check.psalm.command = ./vendor/bin/psalm --report=build/reports/psalm.json
-check.php_coveralls.command = ./vendor/bin/php-coveralls --ansi -v
-
 # --------------------------------------------------------------------------------
 # Testing
 # --------------------------------------------------------------------------------
 
-# Path of the PHP Coding Standards Fixer (http://cs.sensiolabs.org)
-#
-tests.cs_fixer.command = ./vendor/bin/php-cs-fixer fix --verbose
-
-# Path of the PHP_CodeSniffer (https://github.com/squizlabs/PHP_CodeSniffer)
-#
-tests.code_sniffer.command = ./vendor/bin/phpcs --report-full=${dir.reports.code_sniffer}/full.txt --report-summary=${dir.reports.code_sniffer}/summary.txt --report-checkstyle=${dir.reports.code_sniffer}/checkstyle.xml
-
 # Test database path
 #
 tests.database = ${dir.data.temporary}/database.sqlite
 
-# Paths of frameworks used to run tests:
-# - PHPUnit (unit tests)
-# - Infection (mutation tests)
 #
-tests.phpunit.command = ./vendor/bin/phpunit --verbose
-tests.mutation.command = ./vendor/bin/infection --ansi --threads=$(nproc) --coverage=build/reports/infection
+# Disabled, because unnecessary right now
+# PHPUnit is installed and loaded by Composer
+#
+# Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+# 2017-02-22
+#
+# Run PHPUnit using exec task instead of phpunitTask
+#phpunit.useExec = false
+
+#
+# Disabled, because unnecessary right now
+# We want generate code coverage always
+#
+# Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+# 2017-02-22
+#
+# Collect coverage data during tests
+#phpunit.withCoverage = true
+
+# Path of the PHPUnit (https://phpunit.de)
+#
+phpUnit.path = ./vendor/bin/phpunit
+
+# Path of the PHP Coding Standards Fixer (http://cs.sensiolabs.org)
+#
+phpCsFixer.path = ./vendor/bin/php-cs-fixer

phing/tests.xml

@@ -1,16 +1,22 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<project name="Meritoo Package" basedir="." default="build:main" phingVersion="2.14.0">
+    <!--
+    The AutoloaderTask is required to load binaries installed by Composer.
+    The "autoloaderpath" attribute of this task is not required, because it's default value is: vendor/autoload.php.
 
-<project name="Meritoo Package" basedir="." default="build:main" phingVersion="2.16.0">
+    Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+    2017-02-23
+    -->
     <autoloader />
 
     <!-- Properties -->
     <if>
-        <available file="${project.basedir}/phing/properties" property="custom.properties.available" />
+        <available file="phing/properties" property="custom.properties.available"/>
         <then>
-            <property file="${project.basedir}/phing/properties" />
+            <property file="phing/properties" />
         </then>
         <else>
-            <property file="${project.basedir}/phing/properties.dist" />
+            <property file="phing/properties.dist" />
         </else>
     </if>
 
@@ -29,85 +35,271 @@
 
     <!-- Default / main target -->
     <target name="build:main"
-            depends="build:fix-coding-standards,
-                    build:check,
-                    build:test,
-                    app:checkout"
-    />
+            depends="build:fix-coding-standards, build:clean, build:prepare, build:check, build:test, app:checkout"
+            description="Runs all tests and builds everything" />
+    <!--
+    Before:
+    depends="build:fix-coding-standards, build:clean, build:prepare, build:check, build:test, build:doc, app:checkout"
+
+    After:
+    depends="build:fix-coding-standards, build:clean, build:prepare, build:check, build:test, app:checkout"
+
+    The "build:doc" task is disabled, because it cannot be installed via Composer:
+    a) phpdocumentor/phpdocumentor v2.9.0 requires symfony/validator ~2.2
+    b) symfony/validator ~2.2 causes to remove symfony/symfony 3.*
+
+    Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+    2017-02-22
+    -->
 
     <!-- Fixing coding standards using the PHP Coding Standards Fixer (http://cs.sensiolabs.org) -->
-    <target name="build:fix-coding-standards">
-        <exec command="${tests.cs_fixer.command}" passthru="true" />
+    <target name="build:fix-coding-standards" description="Fixes coding standards using the PHP Coding Standards Fixer">
+        <echo msg="Fixing coding standards using the PHP Coding Standards Fixer (http://cs.sensiolabs.org)..." />
+
+        <!--
+        Attention.
+        Rules for formatting are defined in /.php_cs.dist file.
+        -->
+
+        <exec
+            passthru="true"
+            command="${phpCsFixer.path} fix --verbose"
+        />
     </target>
 
+    <!-- Doc target -->
+    <!--
+    Disabled, because it cannot be installed via Composer:
+    a) phpdocumentor/phpdocumentor v2.9.0 requires symfony/validator ~2.2
+    b) symfony/validator ~2.2 causes to remove symfony/symfony 3.*
+
+    Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+    2017-02-22
+    -->
+    <!--<target name="build:doc"-->
+            <!--depends="build:prepare, doc:phpdoc2"-->
+            <!--description="Generates API documentation" />-->
+
     <!-- Check target -->
     <target name="build:check"
-            depends="check:cs,
-                    check:cpd,
-                    check:phpstan,
-                    check:psalm,
-                    check:coveralls"
-    />
+            depends="check:cs, check:md, check:cpd, check:depend, check:loc"
+            description="Analyzes code" />
 
     <!-- Test target -->
     <target name="build:test"
-            depends="test:phpunit,
-                    test:infection"
-    />
-
-    <!-- PHP_CodeSniffer -->
-    <target name="check:cs" depends="build:prepare">
-        <exec command="${tests.code_sniffer.command}" passthru="true" />
-    </target>
-
-    <!-- copy/paste detector -->
-    <target name="check:cpd" depends="build:prepare">
-        <phpcpd>
-            <fileset refid="sourcecode" />
-            <formatter type="pmd" outfile="${dir.reports}/copy-paste-detector.xml" />
-        </phpcpd>
-    </target>
-
-    <!-- Run static analysis -->
-    <target name="check:phpstan" depends="build:prepare">
-        <exec command="${check.phpstan.command}" passthru="true" />
-    </target>
-
-    <!-- Run static analysis -->
-    <target name="check:psalm" depends="build:prepare">
-        <exec command="${check.psalm.command}" passthru="true" />
-    </target>
-
-    <!-- Run analysis of code coverage -->
-    <target name="check:coveralls" depends="test:phpunit">
-        <exec command="${check.php_coveralls.command}" passthru="true" />
-    </target>
-
-    <!-- PHPUnit tests -->
-    <target name="test:phpunit" depends="build:prepare">
-        <exec command="${tests.phpunit.command}" passthru="true" />
-    </target>
-
-    <!-- Run mutation testing -->
-    <target name="test:infection" depends="test:phpunit">
-        <exec command="${tests.mutation.command}" passthru="true" />
-    </target>
+            depends="test:phpunit"
+            description="Executes all tests" />
 
     <!-- Project build clean -->
-    <target name="build:clean">
-        <if>
-            <available file="${dir.reports}" type="dir" property="dir_is_available" />
-            <then>
-                <delete dir="${dir.reports}" />
-            </then>
-        </if>
+    <target name="build:clean" description="Cleans up build directories">
+        <echo msg="Cleaning docs and reports directories..." />
+        <!--<delete dir="${dir.docs}" />-->
+        <delete dir="${dir.reports}" />
     </target>
 
     <!-- Project build prepare -->
-    <target name="build:prepare" depends="build:clean">
+    <target name="build:prepare" description="Create build directories">
+        <echo msg="Creating build directories..." />
+        <!--<mkdir dir="${dir.docs}" />-->
+        <!--<mkdir dir="${dir.docs.phpdoc2}" />-->
         <mkdir dir="${dir.reports}" />
         <mkdir dir="${dir.reports.coverage}" />
-        <mkdir dir="${dir.reports.code_sniffer}" />
+        <mkdir dir="${dir.reports.pdepend}" />
+    </target>
+
+    <!-- PHPDocumentor2 API documentation target -->
+    <!--
+    Disabled, because it cannot be installed via Composer:
+    a) phpdocumentor/phpdocumentor v2.9.0 requires symfony/validator ~2.2
+    b) symfony/validator ~2.2 causes to remove symfony/symfony 3.*
+
+    Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+    2017-02-22
+
+    <target name="doc:phpdoc2" description="Generates API documentations">
+        <echo msg="Generating API Documentation with phpDocumentor 2..." />
+        <phpdoc2 title="${phing.project.name}"
+                 destdir="${dir.docs.phpdoc2}"
+                 template="responsive">
+            <fileset refid="sourcecode" />
+        </phpdoc2>
+    </target>
+    -->
+
+    <!-- Symfony2 code sniffer -->
+    <!--
+    Attention 1.
+    To use Symfony2 standards to check coding you have to:
+    copy, symlink or check out repo to a folder called Symfony2 inside the phpcs Standards directory.
+
+    Example:
+    $ pear config-show | grep php_dir
+    $ cd /path/to/pear/PHP/CodeSniffer/Standards
+    $ git clone git://github.com/opensky/Symfony2-coding-standard.git Symfony2
+
+    Attention 2.
+    PSR2 standard is used instead of Symfony2 standard, because after installation squizlabs/php_codesniffer package
+    via Composer the Symfony2 standard is not included / available in this package. In this case the PHP Coding
+    Standards Fixer (http://cs.sensiolabs.org) is used.
+
+    Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+    2017-02-22
+    -->
+    <target name="check:cs" description="Checks coding standard">
+        <echo msg="Checking coding standard..." />
+        <phpcodesniffer standard="PSR2" showWarnings="true">
+            <fileset refid="sourcecode" />
+            <formatter type="checkstyle" outfile="${dir.reports}/checkstyle.xml" />
+            <formatter type="csv" outfile="${dir.reports}/checkstyle.csv" />
+            <formatter type="summary" outfile="${dir.reports}/checkstyle_summary.txt" />
+        </phpcodesniffer>
+    </target>
+
+    <!-- copy/paste detector -->
+    <target name="check:cpd" description="Checks similar code blocks.">
+        <echo msg="Checking similar code blocks..." />
+        <phpcpd>
+            <fileset refid="sourcecode" />
+            <formatter type="pmd" outfile="${dir.reports}/pmd-cpd.xml" />
+        </phpcpd>
+
+        <!--
+        Previous / old version
+
+        Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+        2017-02-22
+
+        <exec command="phpcpd \-\-log-pmd=${dir.reports}/pmd-cpd.xml ${dir.src}" />
+        -->
+    </target>
+
+    <!-- Mess detector -->
+    <target name="check:md" description="Generate code metrics">
+        <echo msg="Generating code metrics..." />
+        <phpmd rulesets="codesize,controversial,design,naming,unusedcode">
+            <fileset refid="sourcecode" />
+            <formatter type="html" outfile="${dir.reports}/phpmd.html" />
+            <formatter type="text" outfile="${dir.reports}/phpmd.txt" />
+        </phpmd>
+    </target>
+
+    <!-- Code dependency -->
+    <target name="check:depend" description="Checks coupling and dependency">
+        <echo msg="Checking coupling and dependency..." />
+        <phpdepend>
+            <fileset refid="sourcecode" />
+            <logger type="jdepend-xml" outfile="${dir.reports.pdepend}/jdepend.xml" />
+            <logger type="jdepend-chart" outfile="${dir.reports.pdepend}/dependencies.svg" />
+            <logger type="overview-pyramid" outfile="${dir.reports.pdepend}/overview-pyramid.svg" />
+        </phpdepend>
+    </target>
+
+    <!-- Measure the size and analyzing the structure of a project -->
+    <target name="check:loc" description="Measures the size and analyzes the structure of a project">
+        <echo msg="Measuring the size and analyzing the structure of a project..." />
+        <phploc reportType="txt" reportName="phploc" reportDirectory="${dir.reports}">
+            <fileset refid="sourcecode" />
+        </phploc>
+
+        <!--
+        Previous / old version
+
+        Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+        2017-02-22
+
+        <exec command="phploc \-\-log-csv=${dir.reports}/phploc.csv ${dir.src}" />
+        -->
+    </target>
+
+    <!-- Unit tests -->
+    <target name="test:phpunit" description="Executes PHPUnit tests">
+        <!-- Check test database -->
+        <if>
+            <not>
+                <available file="${dir.data.tests}" type="dir" property="dir.data.tests.available" />
+            </not>
+            <then>
+                <mkdir dir="${dir.data.tests}" />
+            </then>
+        </if>
+        <if>
+            <not>
+                <available file="${tests.database}" property="tests.database.available" />
+            </not>
+            <then>
+                <touch file="${tests.database}" />
+            </then>
+        </if>
+        <echo msg="Running unit tests..." />
+        <coverage-setup database="${dir.reports.coverage}/coverage.db">
+            <fileset refid="sourcecode" />
+        </coverage-setup>
+        <exec command="${phpUnit.path} --verbose --configuration ${project.basedir}/phpunit.xml.dist" passthru="true" />
+        <!--
+        I have to use ExecTask to run PHPUnit instead of PHPUnitTask, because tests are not running if PHPUnitTask is
+        used (don't know why):
+        Total tests run: 0, Failures: 0, Errors: 0, Incomplete: 0, Skipped: 0
+
+        Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+        2017-02-23
+
+        <phpunit configuration="${project.basedir}/phpunit.xml.dist" printsummary="true">
+            <formatter type="xml" todir="${dir.reports}" outfile="phpunit.xml" />
+            <formatter type="plain" todir="${dir.reports}" outfile="phpunit.txt" />
+            <formatter type="clover" todir="${dir.reports.coverage}" />
+            <formatter type="summary" todir="${dir.reports}" outfile="phpunit_summary.txt" />
+        </phpunit>
+        -->
+
+        <!--
+        Previous / old version
+
+        Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+        2017-02-22
+
+        <if>
+            <istrue value="${phpunit.useExec}" />
+            <then>
+                <if>
+                    <istrue value="${phpunit.withCoverage}" />
+                    <then>
+                        <echo message="Running tests with code coverage..." />
+                        <exec command="phpunit \-\-log-junit ${dir.reports}/phpunit.xml \-\-coverage-clover ${dir.reports.coverage}/clover-coverage.xml \-\-coverage-crap4j ${dir.reports.coverage}/crap4j-coverage.xml \-\-coverage-html ${dir.reports.coverage}/ -c ${project.basedir} \-\-colors" passthru="true" checkreturn="true" />
+                    </then>
+                    <else>
+                        <echo message="Running tests without code coverage..." />
+                        <exec command="phpunit \-\-log-junit ${dir.reports}/phpunit.xml -c ${project.basedir} \-\-colors" passthru="true" checkreturn="true" />
+                    </else>
+                </if>
+            </then>
+            <else>
+                <if>
+                    <istrue value="${phpunit.withCoverage}" />
+                    <then>
+                        <echo message="Running tests with code coverage..." />
+                        <coverage-setup database="${dir.reports.coverage}/coverage.db">
+                            <fileset refid="sourcecode" />
+                        </coverage-setup>
+                        <phpunit printsummary="true" codecoverage="true">
+                            <formatter type="xml" todir="${dir.reports}" outfile="phpunit.xml" />
+                            <formatter type="plain" todir="${dir.reports}" outfile="phpunit.txt" />
+                            <formatter type="clover" todir="${dir.reports.coverage}" />
+                            <formatter type="summary" todir="${dir.reports}" outfile="phpunit_summary.txt" />
+                        </phpunit>
+                    </then>
+                    <else>
+                        <echo message="Running tests without code coverage..." />
+                        <phpunit printsummary="true">
+                            <formatter todir="${dir.reports}" type="xml" outfile="phpunit.xml" />
+                            <batchtest>
+                                <fileset refid="tests" />
+                            </batchtest>
+                        </phpunit>
+                    </else>
+                </if>
+            </else>
+        </if>
+        -->
     </target>
 
     <!-- Checkout and finalization -->

phpcs.xml.dist

@@ -1,16 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-
-<ruleset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:noNamespaceSchemaLocation="vendor/squizlabs/php_codesniffer/phpcs.xsd">
-
-    <arg name="basepath" value="."/>
-    <arg name="cache" value=".phpcs-cache"/>
-    <arg name="colors"/>
-    <arg name="extensions" value="php"/>
-
-    <rule ref="PSR2"/>
-
-    <file>src/</file>
-    <file>tests/</file>
-
-</ruleset>

phpstan.neon.dist

@@ -1,5 +0,0 @@
-parameters:
-    level: 1
-    paths:
-        - src
-        - tests

phpunit.xml.dist

@@ -1,37 +1,35 @@
 <?xml version="1.0" encoding="UTF-8"?>
 
-<!-- https://phpunit.readthedocs.io/en/8.2/configuration.html -->
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd"
-         backupGlobals="false"
-         bootstrap="vendor/autoload.php"
+<phpunit backupGlobals="false"
+         backupStaticAttributes="false"
          colors="true"
-         executionOrder="random"
-         forceCoversAnnotation="true"
-         verbose="true"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true"
+         processIsolation="false"
+         stopOnFailure="false"
+         syntaxCheck="true"
+         bootstrap="./vendor/autoload.php"
 >
-    <coverage>
-        <include>
-            <directory>src</directory>
-        </include>
-        <report>
-            <clover outputFile="build/reports/coveralls/clover.xml" />
-            <html outputDirectory="build/reports/phpunit-coverage/html" />
-            <xml outputDirectory="build/reports/infection/coverage-xml" />
-        </report>
-    </coverage>
-    <php>
-        <ini name="error_reporting" value="-1" />
-    </php>
     <testsuites>
         <testsuite name="Meritoo Package - Main Test Suite">
-            <directory>tests</directory>
-        </testsuite>
-        <testsuite name="Collection">
-            <directory>tests/Collection</directory>
+            <directory>./tests/</directory>
         </testsuite>
     </testsuites>
+
+    <filter>
+        <whitelist>
+            <directory>./src/</directory>
+        </whitelist>
+    </filter>
+
+    <groups>
+        <exclude>
+            <group>performance</group>
+        </exclude>
+    </groups>
+
     <logging>
-        <junit outputFile="build/reports/infection/phpunit.junit.xml" />
+        <log type="coverage-html" target="./build/logs/phpunit_coverage/html" />
     </logging>
 </phpunit>

psalm.xml

@@ -1,53 +0,0 @@
-<?xml version="1.0"?>
-<psalm
-        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-        totallyTyped="false"
-        xmlns="https://getpsalm.org/schema/config"
-        xsi:schemaLocation="https://getpsalm.org/schema/config file:///project/vendor/vimeo/psalm/config.xsd"
->
-    <projectFiles>
-        <directory name="src" />
-        <ignoreFiles>
-            <directory name="vendor" />
-        </ignoreFiles>
-    </projectFiles>
-
-    <issueHandlers>
-        <LessSpecificReturnType errorLevel="info" />
-
-        <!-- level 3 issues - slightly lazy code writing, but provably low false-negatives -->
-
-        <DeprecatedMethod errorLevel="info" />
-        <DeprecatedProperty errorLevel="info" />
-        <DeprecatedClass errorLevel="info" />
-        <DeprecatedConstant errorLevel="info" />
-        <DeprecatedInterface errorLevel="info" />
-        <DeprecatedTrait errorLevel="info" />
-
-        <InternalMethod errorLevel="info" />
-        <InternalProperty errorLevel="info" />
-        <InternalClass errorLevel="info" />
-
-        <MissingClosureReturnType errorLevel="info" />
-        <MissingReturnType errorLevel="info" />
-        <MissingPropertyType errorLevel="info" />
-        <InvalidDocblock errorLevel="info" />
-        <MisplacedRequiredParam errorLevel="info" />
-
-        <PropertyNotSetInConstructor errorLevel="info" />
-        <MissingConstructor errorLevel="info" />
-        <MissingClosureParamType errorLevel="info" />
-        <MissingParamType errorLevel="info" />
-
-        <RedundantCondition errorLevel="info" />
-
-        <DocblockTypeContradiction errorLevel="info" />
-        <RedundantConditionGivenDocblockType errorLevel="info" />
-
-        <UnresolvableInclude errorLevel="info" />
-
-        <RawObjectIteration errorLevel="info" />
-
-        <InvalidStringClass errorLevel="info" />
-    </issueHandlers>
-</psalm>

src/Collection/BaseCollection.php

@@ -1,349 +0,0 @@
-<?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.
- */
-
-declare(strict_types=1);
-
-namespace Meritoo\Common\Collection;
-
-use ArrayIterator;
-use Meritoo\Common\Contract\Collection\CollectionInterface;
-use Meritoo\Common\Utilities\Arrays;
-
-/**
- * Collection of elements with the same type
- *
- * @author    Meritoo <github@meritoo.pl>
- * @copyright Meritoo <http://www.meritoo.pl>
- */
-abstract class BaseCollection implements CollectionInterface
-{
-    /**
-     * The elements of collection
-     *
-     * @var array
-     */
-    private array $elements;
-
-    /**
-     * Class constructor
-     *
-     * @param array $elements (optional) Elements of collection
-     */
-    public function __construct(array $elements = [])
-    {
-        $validated = $this->getElementsWithValidType($elements);
-        $this->elements = $this->prepareElements($validated);
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function add($element, $index = null): void
-    {
-        if (!$this->isValidType($element)) {
-            return;
-        }
-
-        if (null === $index) {
-            $this->elements[] = $element;
-
-            return;
-        }
-
-        $this->elements[$index] = $element;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function addMultiple($elements, bool $useIndexes = false): void
-    {
-        if (empty($elements)) {
-            return;
-        }
-
-        $prepared = $this->prepareElements($elements);
-
-        foreach ($prepared as $index => $element) {
-            if ($useIndexes) {
-                $this->add($element, $index);
-
-                continue;
-            }
-
-            $this->add($element);
-        }
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function append($element): void
-    {
-        $this->elements[] = $element;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function clear(): void
-    {
-        $this->elements = [];
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function count(): int
-    {
-        return count($this->elements);
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function getByIndex($index)
-    {
-        return $this->elements[$index] ?? null;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function getFirst()
-    {
-        return Arrays::getFirstElement($this->elements);
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function getIterator(): ArrayIterator
-    {
-        return new ArrayIterator($this->elements);
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function getLast()
-    {
-        return Arrays::getLastElement($this->elements);
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function getNext($element)
-    {
-        return Arrays::getNextElement($this->elements, $element);
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function getPrevious($element)
-    {
-        return Arrays::getPreviousElement($this->elements, $element);
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function has($element): bool
-    {
-        $index = Arrays::getIndexOf($this->elements, $element);
-
-        return null !== $index && false !== $index;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function isEmpty(): bool
-    {
-        return empty($this->elements);
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function isFirst($element): bool
-    {
-        return reset($this->elements) === $element;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function isLast($element): bool
-    {
-        return end($this->elements) === $element;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function limit(int $max, int $offset = 0): self
-    {
-        $result = clone $this;
-
-        $negativeMax = $max <= 0;
-        $exceededMax = $max >= $this->count();
-
-        if ($negativeMax || $exceededMax) {
-            if ($negativeMax) {
-                $result->clear();
-            }
-
-            return $result;
-        }
-
-        $iteration = -1;
-
-        foreach ($result as $index => $element) {
-            $iteration++;
-
-            if ($iteration >= $offset && $iteration < $offset + $max) {
-                continue;
-            }
-
-            unset($result[$index]);
-        }
-
-        return $result;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function offsetExists($offset): bool
-    {
-        return $this->exists($offset);
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function offsetGet($offset)
-    {
-        if ($this->exists($offset)) {
-            return $this->elements[$offset];
-        }
-
-        return null;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function offsetSet($offset, $value): void
-    {
-        $this->elements[$offset] = $value;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function offsetUnset($offset): void
-    {
-        if ($this->exists($offset)) {
-            unset($this->elements[$offset]);
-        }
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function prepend($element): void
-    {
-        array_unshift($this->elements, $element);
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function remove($element): void
-    {
-        if (0 === $this->count()) {
-            return;
-        }
-
-        foreach ($this->elements as $index => $existing) {
-            if ($element === $existing) {
-                unset($this->elements[$index]);
-
-                break;
-            }
-        }
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function toArray(): array
-    {
-        return $this->elements;
-    }
-
-    /**
-     * Returns information if given element has valid type
-     *
-     * @param mixed $element Element of collection
-     * @return bool
-     */
-    abstract protected function isValidType($element): bool;
-
-    /**
-     * Prepares elements to initialize the collection.
-     * Feel free to override and prepare elements in your way.
-     *
-     * @param array $elements The elements of collection to prepare
-     * @return array
-     */
-    protected function prepareElements(array $elements): array
-    {
-        return $elements;
-    }
-
-    /**
-     * Returns information if element with given index/key exists
-     *
-     * @param int|string $index The index/key of element
-     * @return bool
-     */
-    private function exists($index): bool
-    {
-        return isset($this->elements[$index]) || array_key_exists($index, $this->elements);
-    }
-
-    /**
-     * Returns elements of collection with valid types
-     *
-     * @param array $elements The elements of collection to verify
-     * @return array
-     */
-    private function getElementsWithValidType(array $elements): array
-    {
-        if (empty($elements)) {
-            return [];
-        }
-
-        $result = [];
-
-        foreach ($elements as $index => $element) {
-            if (!$this->isValidType($element)) {
-                continue;
-            }
-
-            $result[$index] = $element;
-        }
-
-        return $result;
-    }
-}

src/Collection/DateTimeCollection.php

@@ -1,27 +0,0 @@
-<?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.
- */
-
-declare(strict_types=1);
-
-namespace Meritoo\Common\Collection;
-
-use DateTime;
-
-/**
- * Collection of DateTime instances
- *
- * @author    Meritoo <github@meritoo.pl>
- * @copyright Meritoo <http://www.meritoo.pl>
- */
-class DateTimeCollection extends BaseCollection
-{
-    protected function isValidType($element): bool
-    {
-        return $element instanceof DateTime;
-    }
-}

src/Collection/IntegerCollection.php

@@ -1,25 +0,0 @@
-<?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.
- */
-
-declare(strict_types=1);
-
-namespace Meritoo\Common\Collection;
-
-/**
- * Collection of integers
- *
- * @author    Meritoo <github@meritoo.pl>
- * @copyright Meritoo <http://www.meritoo.pl>
- */
-class IntegerCollection extends BaseCollection
-{
-    protected function isValidType($element): bool
-    {
-        return is_int($element);
-    }
-}

src/Collection/StringCollection.php

@@ -1,25 +0,0 @@
-<?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.
- */
-
-declare(strict_types=1);
-
-namespace Meritoo\Common\Collection;
-
-/**
- * Collection of strings
- *
- * @author    Meritoo <github@meritoo.pl>
- * @copyright Meritoo <http://www.meritoo.pl>
- */
-class StringCollection extends BaseCollection
-{
-    protected function isValidType($element): bool
-    {
-        return is_string($element);
-    }
-}

src/Collection/Templates.php

@@ -1,72 +0,0 @@
-<?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.
- */
-
-declare(strict_types=1);
-
-namespace Meritoo\Common\Collection;
-
-use Meritoo\Common\Exception\ValueObject\Template\TemplateNotFoundException;
-use Meritoo\Common\ValueObject\Template;
-
-/**
- * Collection/storage of templates
- *
- * @author    Meritoo <github@meritoo.pl>
- * @copyright Meritoo <http://www.meritoo.pl>
- */
-class Templates extends BaseCollection
-{
-    /**
-     * Finds and returns template with given index
-     *
-     * @param string $index Index that contains required template
-     * @return Template
-     * @throws TemplateNotFoundException
-     */
-    public function findTemplate(string $index): Template
-    {
-        $template = $this->getByIndex($index);
-
-        if ($template instanceof Template) {
-            return $template;
-        }
-
-        // Oops, template not found
-        throw TemplateNotFoundException::create($index);
-    }
-
-    /**
-     * Creates and returns the collection from given array
-     *
-     * @param array $templates Pairs of key-value where: key - template's index, value - template's content
-     * @return Templates
-     */
-    public static function fromArray(array $templates): Templates
-    {
-        // No templates. Nothing to do.
-        if (empty($templates)) {
-            return new static();
-        }
-
-        $result = new static();
-
-        foreach ($templates as $index => $template) {
-            $result->add(new Template($template), $index);
-        }
-
-        return $result;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    protected function isValidType($element): bool
-    {
-        return $element instanceof Template;
-    }
-}

src/Contract/Collection/AddableCollectionInterface.php

@@ -1,55 +0,0 @@
-<?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.
- */
-
-declare(strict_types=1);
-
-namespace Meritoo\Common\Contract\Collection;
-
-/**
- * Contract for collection that may add elements
- *
- * @author    Meritoo <github@meritoo.pl>
- * @copyright Meritoo <http://www.meritoo.pl>
- */
-interface AddableCollectionInterface
-{
-    /**
-     * Adds given element (at the end of collection)
-     *
-     * @param mixed $element The element to add
-     * @param mixed $index   (optional) Index / key of the element
-     * @return void
-     */
-    public function add($element, $index = null): void;
-
-    /**
-     * Adds given elements (at the end of collection)
-     *
-     * @param array|CollectionInterface $elements   The elements to add
-     * @param bool                      $useIndexes (optional) If is set to true, indexes of given elements will be
-     *                                              used in this collection. Otherwise - not.
-     * @return void
-     */
-    public function addMultiple(array $elements, bool $useIndexes = false): void;
-
-    /**
-     * Appends given element (adds given element at the end of collection)
-     *
-     * @param mixed $element The element to add at the end
-     * @return void
-     */
-    public function append($element): void;
-
-    /**
-     * Prepends given element (adds given element at the beginning of collection)
-     *
-     * @param mixed $element The element to add at the beginning
-     * @return void
-     */
-    public function prepend($element): void;
-}

src/Contract/Collection/ClearableCollectionInterface.php

@@ -1,27 +0,0 @@
-<?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.
- */
-
-declare(strict_types=1);
-
-namespace Meritoo\Common\Contract\Collection;
-
-/**
- * Contract for collection that may be cleared (all its elements may be removed)
- *
- * @author    Meritoo <github@meritoo.pl>
- * @copyright Meritoo <http://www.meritoo.pl>
- */
-interface ClearableCollectionInterface
-{
-    /**
-     * Removes all elements of the collection
-     *
-     * @return void
-     */
-    public function clear(): void;
-}

src/Contract/Collection/CollectionInterface.php

@@ -1,32 +0,0 @@
-<?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.
- */
-
-declare(strict_types=1);
-
-namespace Meritoo\Common\Contract\Collection;
-
-use ArrayAccess;
-use IteratorAggregate;
-
-/**
- * Contract for collection of elements with the same type
- *
- * @author    Meritoo <github@meritoo.pl>
- * @copyright Meritoo <http://www.meritoo.pl>
- */
-interface CollectionInterface extends ArrayAccess, IteratorAggregate, AddableCollectionInterface,
-    RemovableCollectionInterface, CountableCollectionInterface, ClearableCollectionInterface,
-    GettableCollectionInterface, VerifiableCollectionInterface, ReducibleCollectionInterface
-{
-    /**
-     * Returns representation of object as array
-     *
-     * @return array
-     */
-    public function toArray(): array;
-}

src/Contract/Collection/CountableCollectionInterface.php

@@ -1,23 +0,0 @@
-<?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.
- */
-
-declare(strict_types=1);
-
-namespace Meritoo\Common\Contract\Collection;
-
-use Countable;
-
-/**
- * Contract for collection that may count its elements
- *
- * @author    Meritoo <github@meritoo.pl>
- * @copyright Meritoo <http://www.meritoo.pl>
- */
-interface CountableCollectionInterface extends Countable
-{
-}

src/Contract/Collection/GettableCollectionInterface.php

@@ -1,58 +0,0 @@
-<?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.
- */
-
-declare(strict_types=1);
-
-namespace Meritoo\Common\Contract\Collection;
-
-/**
- * Contract for collection that returns first, last element etc.
- *
- * @author    Meritoo <github@meritoo.pl>
- * @copyright Meritoo <http://www.meritoo.pl>
- */
-interface GettableCollectionInterface
-{
-    /**
-     * Returns element with given index
-     *
-     * @param mixed $index Index / key of element to return
-     * @return mixed
-     */
-    public function getByIndex($index);
-
-    /**
-     * Returns first element
-     *
-     * @return mixed
-     */
-    public function getFirst();
-
-    /**
-     * Returns last element
-     *
-     * @return mixed
-     */
-    public function getLast();
-
-    /**
-     * Returns element next after given element
-     *
-     * @param mixed $element The element whose next element should be returned
-     * @return mixed
-     */
-    public function getNext($element);
-
-    /**
-     * Returns element preceding given element
-     *
-     * @param mixed $element The element whose previous element should be returned
-     * @return mixed
-     */
-    public function getPrevious($element);
-}

src/Contract/Collection/ReducibleCollectionInterface.php

@@ -1,29 +0,0 @@
-<?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.
- */
-
-declare(strict_types=1);
-
-namespace Meritoo\Common\Contract\Collection;
-
-/**
- * Contract for collection that may reduce its elements
- *
- * @author    Meritoo <github@meritoo.pl>
- * @copyright Meritoo <http://www.meritoo.pl>
- */
-interface ReducibleCollectionInterface
-{
-    /**
-     * Returns new instance of this collection with limited elements
-     *
-     * @param int $max    Maximum elements to return
-     * @param int $offset (optional) Position of element from which limitation should start
-     * @return $this
-     */
-    public function limit(int $max, int $offset = 0): self;
-}

src/Contract/Collection/RemovableCollectionInterface.php

@@ -1,28 +0,0 @@
-<?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.
- */
-
-declare(strict_types=1);
-
-namespace Meritoo\Common\Contract\Collection;
-
-/**
- * Contract for collection that may remove elements
- *
- * @author    Meritoo <github@meritoo.pl>
- * @copyright Meritoo <http://www.meritoo.pl>
- */
-interface RemovableCollectionInterface
-{
-    /**
-     * Removes given element
-     *
-     * @param mixed $element The element to remove
-     * @return void
-     */
-    public function remove($element): void;
-}

src/Contract/Collection/VerifiableCollectionInterface.php

@@ -1,51 +0,0 @@
-<?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.
- */
-
-declare(strict_types=1);
-
-namespace Meritoo\Common\Contract\Collection;
-
-/**
- * Contract for collection that may verify its elements
- *
- * @author    Meritoo <github@meritoo.pl>
- * @copyright Meritoo <http://www.meritoo.pl>
- */
-interface VerifiableCollectionInterface
-{
-    /**
-     * Returns information if given element exists in collection
-     *
-     * @param mixed $element The element to verify
-     * @return bool
-     */
-    public function has($element): bool;
-
-    /**
-     * Returns information if collection is empty (has not any element)
-     *
-     * @return bool
-     */
-    public function isEmpty(): bool;
-
-    /**
-     * Returns information if given element is the first element in collection
-     *
-     * @param mixed $element The element to verify
-     * @return bool
-     */
-    public function isFirst($element): bool;
-
-    /**
-     * Returns information if given element is the last element in collection
-     *
-     * @param mixed $element The element to verify
-     * @return bool
-     */
-    public function isLast($element): bool;
-}

src/Contract/Renderable/RenderableInterface.php

@@ -1,31 +0,0 @@
-<?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.
- */
-
-declare(strict_types=1);
-
-namespace Meritoo\Common\Contract\Renderable;
-
-use Meritoo\Common\Collection\Templates;
-
-/**
- * Interface/Contract of something that may be rendered
- *
- * @author    Meritoo <github@meritoo.pl>
- * @copyright Meritoo <http://www.meritoo.pl>
- */
-interface RenderableInterface
-{
-    /**
-     * Renders this object using given templates
-     *
-     * @param Templates $templates Collection/storage of templates that will be required while rendering this and
-     *                             related objects, e.g. children of this object
-     * @return string
-     */
-    public function render(Templates $templates): string;
-}

src/Exception/Base/UnknownTypeException.php

@@ -1,42 +0,0 @@
-<?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\Base;
-
-use Exception;
-use Meritoo\Common\Type\Base\BaseType;
-use Meritoo\Common\Utilities\Arrays;
-
-/**
- * An exception used while type of something is unknown
- *
- * @author    Meritoo <github@meritoo.pl>
- * @copyright Meritoo <http://www.meritoo.pl>
- */
-abstract class UnknownTypeException extends Exception
-{
-    /**
-     * Creates exception
-     *
-     * @param mixed    $unknownType  The unknown type of something (value of constant)
-     * @param BaseType $typeInstance An instance of class that contains type of the something
-     * @param string   $typeName     Name of the something
-     * @return UnknownTypeException
-     */
-    public static function create($unknownType, BaseType $typeInstance, string $typeName): UnknownTypeException
-    {
-        $template = 'The \'%s\' type of %s is unknown. Probably doesn\'t exist or there is a typo. You should use one'
-            .' of these types: %s.';
-
-        $allTypes = $typeInstance->getAll();
-        $types = Arrays::values2string($allTypes, '', ', ') ?? '[types not found]';
-        $message = sprintf($template, $unknownType, $typeName, $types);
-
-        return new static($message);
-    }
-}

src/Exception/Bundle/IncorrectBundleNameException.php

@@ -1,36 +0,0 @@
-<?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\Bundle;
-
-use Exception;
-
-/**
- * An exception used while name of bundle is incorrect
- *
- * @author    Meritoo <github@meritoo.pl>
- * @copyright Meritoo <http://www.meritoo.pl>
- */
-class IncorrectBundleNameException extends Exception
-{
-    /**
-     * Creates exception
-     *
-     * @param string $bundleName Incorrect name of bundle
-     * @return IncorrectBundleNameException
-     */
-    public static function create($bundleName)
-    {
-        $template = 'Name of bundle \'%s\' is incorrect. It should start with big letter and end with "Bundle". Is'
-            .' there everything ok?';
-
-        $message = sprintf($template, $bundleName);
-
-        return new static($message);
-    }
-}

src/Exception/File/EmptyFileException.php

@@ -1,34 +0,0 @@
-<?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;
-
-use Exception;
-
-/**
- * An exception used while file with given path is empty (has no content)
- *
- * @author    Meritoo <github@meritoo.pl>
- * @copyright Meritoo <http://www.meritoo.pl>
- */
-class EmptyFileException extends Exception
-{
-    /**
-     * Creates exception
-     *
-     * @param string $emptyFilePath Path of the empty file
-     * @return EmptyFileException
-     */
-    public static function create($emptyFilePath)
-    {
-        $template = 'File with path \'%s\' is empty (has no content). Did you provide path of proper file?';
-        $message = sprintf($template, $emptyFilePath);
-
-        return new static($message);
-    }
-}

src/Exception/File/EmptyFilePathException.php

@@ -1,30 +0,0 @@
-<?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;
-
-use Exception;
-
-/**
- * An exception used while path of given file is empty
- *
- * @author    Meritoo <github@meritoo.pl>
- * @copyright Meritoo <http://www.meritoo.pl>
- */
-class EmptyFilePathException extends Exception
-{
-    /**
-     * Creates exception
-     *
-     * @return EmptyFilePathException
-     */
-    public static function create(): EmptyFilePathException
-    {
-        return new static('Path of the file is empty. Did you provide path of proper file?');
-    }
-}

src/Exception/File/NotExistingFileException.php

@@ -1,34 +0,0 @@
-<?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;
-
-use Exception;
-
-/**
- * An exception used while file with given path does not exist
- *
- * @author    Meritoo <github@meritoo.pl>
- * @copyright Meritoo <http://www.meritoo.pl>
- */
-class NotExistingFileException extends Exception
-{
-    /**
-     * Creates exception
-     *
-     * @param string $notExistingFilePath Path of not existing (or not readable) file
-     * @return NotExistingFileException
-     */
-    public static function create($notExistingFilePath)
-    {
-        $template = 'File with path \'%s\' does not exist (or is not readable). Did you provide path of proper file?';
-        $message = sprintf($template, $notExistingFilePath);
-
-        return new static($message);
-    }
-}

src/Exception/Method/DisabledMethodException.php

@@ -1,40 +0,0 @@
-<?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\Method;
-
-use Exception;
-
-/**
- * An exception used while method cannot be called, because is disabled
- *
- * @author    Meritoo <github@meritoo.pl>
- * @copyright Meritoo <http://www.meritoo.pl>
- */
-class DisabledMethodException extends Exception
-{
-    /**
-     * Creates exception
-     *
-     * @param string $disabledMethod    Name of the disabled method
-     * @param string $alternativeMethod (optional) Name of the alternative method
-     * @return DisabledMethodException
-     */
-    public static function create($disabledMethod, $alternativeMethod = '')
-    {
-        $template = 'Method %s() cannot be called, because is disabled.';
-        $message = sprintf($template, $disabledMethod);
-
-        if (!empty($alternativeMethod)) {
-            $template = '%s Use %s() instead.';
-            $message = sprintf($template, $message, $alternativeMethod);
-        }
-
-        return new static($message);
-    }
-}

src/Exception/Reflection/ClassWithoutConstructorException.php

@@ -1,34 +0,0 @@
-<?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\Reflection;
-
-use Exception;
-
-/**
- * An exception used while given class hasn't constructor
- *
- * @author    Meritoo <github@meritoo.pl>
- * @copyright Meritoo <http://www.meritoo.pl>
- */
-class ClassWithoutConstructorException extends Exception
-{
-    /**
-     * Creates exception
-     *
-     * @param string $className Fully-qualified name of class that hasn't constructor
-     * @return ClassWithoutConstructorException
-     */
-    public static function create(string $className): ClassWithoutConstructorException
-    {
-        $template = 'Oops, class \'%s\' hasn\'t constructor. Did you use proper class?';
-        $message = sprintf($template, $className);
-
-        return new static($message);
-    }
-}

src/Exception/Reflection/NotExistingPropertyException.php

@@ -1,35 +0,0 @@
-<?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\Reflection;
-
-use Exception;
-
-/**
- * An exception used while property does not exist in instance of class
- *
- * @author    Meritoo <github@meritoo.pl>
- * @copyright Meritoo <http://www.meritoo.pl>
- */
-class NotExistingPropertyException extends Exception
-{
-    /**
-     * Creates exception
-     *
-     * @param mixed       $object   Object that should contains given property
-     * @param null|string $property Name of the property
-     * @return NotExistingPropertyException
-     */
-    public static function create($object, ?string $property): NotExistingPropertyException
-    {
-        $template = 'Property \'%s\' does not exist in instance of class \'%s\'. Did you use proper name of property?';
-        $message = sprintf($template, $property, get_class($object));
-
-        return new static($message);
-    }
-}

src/Exception/Regex/InvalidHtmlAttributesException.php

@@ -1,33 +0,0 @@
-<?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\Regex;
-
-use Exception;
-
-/**
- * An exception used while html attributes are invalid
- *
- * @author    Meritoo <github@meritoo.pl>
- * @copyright Meritoo <http://www.meritoo.pl>
- */
-class InvalidHtmlAttributesException extends Exception
-{
-    /**
-     * Creates exception
-     *
-     * @param string $htmlAttributes Invalid html attributes
-     * @return InvalidHtmlAttributesException
-     */
-    public static function create($htmlAttributes)
-    {
-        $message = sprintf('HTML attributes \'%s\' are invalid. Is there everything ok?', $htmlAttributes);
-
-        return new static($message);
-    }
-}

src/Exception/Regex/InvalidUrlException.php

@@ -1,33 +0,0 @@
-<?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\Regex;
-
-use Exception;
-
-/**
- * An exception used while url is invalid
- *
- * @author    Meritoo <github@meritoo.pl>
- * @copyright Meritoo <http://www.meritoo.pl>
- */
-class InvalidUrlException extends Exception
-{
-    /**
-     * Creates exception
-     *
-     * @param string $url Invalid url
-     * @return InvalidUrlException
-     */
-    public static function create($url)
-    {
-        $message = sprintf('Url \'%s\' is invalid. Is there everything ok?', $url);
-
-        return new static($message);
-    }
-}

src/Exception/Type/UnknownOopVisibilityTypeException.php

@@ -1,32 +0,0 @@
-<?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\Type;
-
-use Meritoo\Common\Exception\Base\UnknownTypeException;
-use Meritoo\Common\Type\OopVisibilityType;
-
-/**
- * An exception used while the visibility of a property, a method or (as of PHP 7.1.0) a constant is unknown
- *
- * @author    Meritoo <github@meritoo.pl>
- * @copyright Meritoo <http://www.meritoo.pl>
- */
-class UnknownOopVisibilityTypeException extends UnknownTypeException
-{
-    /**
-     * Creates exception
-     *
-     * @param string $unknownType Unknown visibility of a property, a method or (as of PHP 7.1.0) a constant
-     * @return UnknownOopVisibilityTypeException
-     */
-    public static function createException(string $unknownType): UnknownOopVisibilityTypeException
-    {
-        return parent::create($unknownType, new OopVisibilityType(), 'OOP-related visibility');
-    }
-}

src/Exception/ValueObject/InvalidSizeDimensionsException.php

@@ -1,35 +0,0 @@
-<?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\ValueObject;
-
-use Exception;
-
-/**
- * An exception used while dimensions of size, passed to the instance of Size class, are invalid
- *
- * @author    Meritoo <github@meritoo.pl>
- * @copyright Meritoo <http://www.meritoo.pl>
- */
-class InvalidSizeDimensionsException extends Exception
-{
-    /**
-     * Creates exception
-     *
-     * @param int $width  The width
-     * @param int $height The height
-     * @return InvalidSizeDimensionsException
-     */
-    public static function create($width, $height)
-    {
-        $template = 'Dimensions of size should be positive, but they are not: %d, %d. Is there everything ok?';
-        $message = sprintf($template, $width, $height);
-
-        return new static($message);
-    }
-}

src/Exception/ValueObject/Template/InvalidContentException.php

@@ -1,36 +0,0 @@
-<?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.
- */
-
-declare(strict_types=1);
-
-namespace Meritoo\Common\Exception\ValueObject\Template;
-
-use Exception;
-
-/**
- * An exception used while content of template is invalid
- *
- * @author    Meritoo <github@meritoo.pl>
- * @copyright Meritoo <http://www.meritoo.pl>
- */
-class InvalidContentException extends Exception
-{
-    /**
-     * Creates an exception
-     *
-     * @param string $content Invalid content of template
-     * @return InvalidContentException
-     */
-    public static function create(string $content): InvalidContentException
-    {
-        $template = 'Content of template \'%s\' is invalid. Did you use string with 1 placeholder at least?';
-        $message = sprintf($template, $content);
-
-        return new static($message);
-    }
-}

src/Exception/ValueObject/Template/MissingPlaceholdersInValuesException.php

@@ -1,36 +0,0 @@
-<?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\ValueObject\Template;
-
-use Exception;
-
-/**
- * An exception used while there are missing values required to fill all placeholders in template
- *
- * @author    Meritoo <github@meritoo.pl>
- * @copyright Meritoo <http://www.meritoo.pl>
- */
-class MissingPlaceholdersInValuesException extends Exception
-{
-    /**
-     * Creates an exception
-     *
-     * @param string $content             Content of template
-     * @param array  $missingPlaceholders Missing placeholders in provided values, iow. placeholders without values
-     * @return MissingPlaceholdersInValuesException
-     */
-    public static function create(string $content, array $missingPlaceholders): MissingPlaceholdersInValuesException
-    {
-        $template = 'Cannot fill template \'%s\', because of missing values for placeholder(s): %s. Did you provide all'
-            .' required values?';
-        $message = sprintf($template, $content, implode(', ', $missingPlaceholders));
-
-        return new static($message);
-    }
-}

src/Exception/ValueObject/Template/TemplateNotFoundException.php

@@ -1,36 +0,0 @@
-<?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.
- */
-
-declare(strict_types=1);
-
-namespace Meritoo\Common\Exception\ValueObject\Template;
-
-use Exception;
-
-/**
- * An exception used while template with given index was not found
- *
- * @author    Meritoo <github@meritoo.pl>
- * @copyright Meritoo <http://www.meritoo.pl>
- */
-class TemplateNotFoundException extends Exception
-{
-    /**
-     * Creates the exception
-     *
-     * @param string $index Index that should contain template, but it was not found
-     * @return TemplateNotFoundException
-     */
-    public static function create(string $index): TemplateNotFoundException
-    {
-        $template = 'Template with \'%s\' index was not found. Did you provide all required templates?';
-        $message = sprintf($template, $index);
-
-        return new static($message);
-    }
-}

src/Meritoo/Common/Collection/Collection.php

@@ -0,0 +1,295 @@
+<?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\Collection;
+
+use ArrayAccess;
+use ArrayIterator;
+use Countable;
+use IteratorAggregate;
+use Meritoo\Common\Utilities\Arrays;
+
+/**
+ * Collection of elements.
+ * It's a set of some elements, e.g. objects.
+ *
+ * @author    Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+ * @copyright Meritoo.pl
+ */
+class Collection implements Countable, ArrayAccess, IteratorAggregate
+{
+    /**
+     * The elements of collection.
+     *
+     * @var array
+     */
+    private $elements;
+
+    /**
+     * Class constructor.
+     *
+     * @param array $elements (optional) The elements of collection
+     */
+    public function __construct(array $elements = [])
+    {
+        $this->elements = $elements;
+    }
+
+    /**
+     * {@inheritdoc}
+     * Required by interface Countable.
+     */
+    public function count()
+    {
+        return count($this->elements);
+    }
+
+    /**
+     * {@inheritdoc}
+     * Required by interface ArrayAccess.
+     */
+    public function offsetExists($offset)
+    {
+        return $this->exists($offset);
+    }
+
+    /**
+     * {@inheritdoc}
+     * Required by interface ArrayAccess.
+     */
+    public function offsetGet($offset)
+    {
+        if ($this->exists($offset)) {
+            return $this->elements[$offset];
+        }
+
+        return null;
+    }
+
+    /**
+     * {@inheritdoc}
+     * Required by interface ArrayAccess.
+     */
+    public function offsetSet($offset, $value)
+    {
+        $this->elements[$offset] = $value;
+    }
+
+    /**
+     * {@inheritdoc}
+     * Required by interface ArrayAccess.
+     */
+    public function offsetUnset($offset)
+    {
+        if ($this->exists($offset)) {
+            unset($this->elements[$offset]);
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     * Required by interface IteratorAggregate.
+     */
+    public function getIterator()
+    {
+        return new ArrayIterator($this->elements);
+    }
+
+    /**
+     * Adds given element (at the end of collection).
+     *
+     * @param mixed $element The element to add
+     * @param mixed $index   (optional) Index / key of the element
+     *
+     * @return $this
+     */
+    public function add($element, $index = null)
+    {
+        if ($index === null) {
+            $this->elements[] = $element;
+        } else {
+            $this->elements[$index] = $element;
+        }
+
+        return $this;
+    }
+
+    /**
+     * Adds given elements (at the end of collection).
+     *
+     * @param array|Collection $elements   The elements to add
+     * @param bool|false       $useIndexes (optional) If is set to true, indexes of given elements will be used in
+     *                                     this collection. Otherwise - not.
+     *
+     * @return $this
+     */
+    public function addMultiple($elements, $useIndexes = false)
+    {
+        if (!empty($elements)) {
+            foreach ($elements as $index => $element) {
+                if (!$useIndexes) {
+                    $index = null;
+                }
+
+                $this->add($element, $index);
+            }
+        }
+
+        return $this;
+    }
+
+    /**
+     * Prepends given element (adds given element at the beginning of collection).
+     *
+     * @param mixed $element The element to prepend
+     *
+     * @return $this
+     */
+    public function prepend($element)
+    {
+        array_unshift($this->elements, $element);
+
+        return $this;
+    }
+
+    /**
+     * Removes given element.
+     *
+     * @param mixed $element The element to remove
+     *
+     * @return $this
+     */
+    public function remove($element)
+    {
+        if ($this->count() > 0) {
+            foreach ($this->elements as $index => $existing) {
+                if ($element === $existing) {
+                    unset($this->elements[$index]);
+
+                    break;
+                }
+            }
+        }
+
+        return $this;
+    }
+
+    /**
+     * Returns information if collection is empty.
+     *
+     * @return bool
+     */
+    public function isEmpty()
+    {
+        return empty($this->elements);
+    }
+
+    /**
+     * Returns information if given element is first in the collection.
+     *
+     * @param mixed $element The element to verify
+     *
+     * @return bool
+     */
+    public function isFirst($element)
+    {
+        return reset($this->elements) === $element;
+    }
+
+    /**
+     * Returns information if given element is last in the collection.
+     *
+     * @param mixed $element The element to verify
+     *
+     * @return bool
+     */
+    public function isLast($element)
+    {
+        return end($this->elements) === $element;
+    }
+
+    /**
+     * Returns information if the collection has given element, iow. if given element exists in the collection.
+     *
+     * @param mixed $element The element to verify
+     *
+     * @return bool
+     */
+    public function has($element)
+    {
+        $index = Arrays::getIndexOf($this->elements, $element);
+
+        return $index !== null && $index !== false;
+    }
+
+    /**
+     * Returns previous element for given element.
+     *
+     * @param mixed $element The element to verify
+     *
+     * @return mixed|null
+     */
+    public function getPrevious($element)
+    {
+        return Arrays::getPreviousElement($this->elements, $element);
+    }
+
+    /**
+     * Returns next element for given element.
+     *
+     * @param mixed $element The element to verify
+     *
+     * @return mixed|null
+     */
+    public function getNext($element)
+    {
+        return Arrays::getNextElement($this->elements, $element);
+    }
+
+    /**
+     * Returns the first element in the collection.
+     *
+     * @return mixed
+     */
+    public function getFirst()
+    {
+        return Arrays::getFirstElement($this->elements);
+    }
+
+    /**
+     * Returns the last element in the collection.
+     *
+     * @return mixed
+     */
+    public function getLast()
+    {
+        return Arrays::getLastElement($this->elements);
+    }
+
+    /**
+     * Returns an array representation of the collection.
+     *
+     * @return array
+     */
+    public function toArray()
+    {
+        return $this->elements;
+    }
+
+    /**
+     * Returns information if element with given index/key exists.
+     *
+     * @param string|int $index The index/key of element
+     *
+     * @return bool
+     */
+    private function exists($index)
+    {
+        return isset($this->elements[$index]) || array_key_exists($index, $this->elements);
+    }
+}

src/Meritoo/Common/Exception/Base/UnknownTypeException.php

@@ -0,0 +1,41 @@
+<?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\Base;
+
+use Exception;
+use Meritoo\Common\Type\Base\BaseType;
+use Meritoo\Common\Utilities\Arrays;
+
+/**
+ * An exception used while type of something is unknown.
+ *
+ * @author    Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+ * @copyright Meritoo.pl
+ */
+abstract class UnknownTypeException extends Exception
+{
+    /**
+     * Class constructor.
+     *
+     * @param string|int $unknownType  The unknown type of something (value of constant)
+     * @param BaseType   $typeInstance An instance of class that contains type of the something
+     * @param string     $typeName     Name of the something
+     */
+    public function __construct($unknownType, BaseType $typeInstance, $typeName)
+    {
+        $allTypes = $typeInstance->getAll();
+        $types = Arrays::values2string($allTypes, '', ', ');
+
+        $template = 'The \'%s\' type of %s is unknown. Probably doesn\'t exist or there is a typo. You should use one'
+            .' of these types: %s.';
+
+        $message = sprintf(sprintf($template, $unknownType, $typeName, $types));
+        parent::__construct($message);
+    }
+}

src/Meritoo/Common/Exception/Date/UnknownDatePartTypeException.php

@@ -6,28 +6,27 @@
  * file that was distributed with this source code.
  */
 
-namespace Meritoo\Common\Exception\Type;
+namespace Meritoo\Common\Exception\Date;
 
 use Meritoo\Common\Exception\Base\UnknownTypeException;
 use Meritoo\Common\Type\DatePartType;
 
 /**
- * An exception used while type of date part, e.g. "year", is unknown
+ * An exception used while type of date part, e.g. "year", is unknown.
  *
- * @author    Meritoo <github@meritoo.pl>
- * @copyright Meritoo <http://www.meritoo.pl>
+ * @author    Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+ * @copyright Meritoo.pl
  */
 class UnknownDatePartTypeException extends UnknownTypeException
 {
     /**
-     * Creates exception
+     * Class constructor.
      *
-     * @param string $unknownDatePart Unknown type of date part
+     * @param string $unknownDatePart Type of date part, e.g. "year". One of DatePartType class constants.
      * @param string $value           Incorrect value
-     * @return UnknownDatePartTypeException
      */
-    public static function createException(string $unknownDatePart, string $value): UnknownDatePartTypeException
+    public function __construct($unknownDatePart, $value)
     {
-        return parent::create($unknownDatePart, new DatePartType(), sprintf('date part (with value %s)', $value));
+        parent::__construct($unknownDatePart, new DatePartType(), sprintf('date part (with value %s)', $value));
     }
 }

src/Meritoo/Common/Exception/Reflection/CannotResolveClassNameException.php

@@ -11,22 +11,22 @@ namespace Meritoo\Common\Exception\Reflection;
 use Exception;
 
 /**
- * An exception used while name of class or trait cannot be resolved
+ * An exception used while name of class or trait cannot be resolved.
  *
- * @author    Meritoo <github@meritoo.pl>
- * @copyright Meritoo <http://www.meritoo.pl>
+ * @author    Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+ * @copyright Meritoo.pl
  */
 class CannotResolveClassNameException extends Exception
 {
     /**
-     * Creates exception
+     * Class constructor.
      *
-     * @param string $source   Source of name of the class or trait
-     * @param bool   $forClass (optional) If is set to true, message of this exception for class is prepared. Otherwise
-     *                         - for trait.
-     * @return CannotResolveClassNameException
+     * @param array|object|string $source   Source of the class's / trait's name. It cane be an array of objects,
+     *                                      namespaces, object or namespace.
+     * @param bool                $forClass (optional) If is set to true, message of this exception for class is
+     *                                      prepared. Otherwise - for trait.
      */
-    public static function create(string $source, bool $forClass = true): CannotResolveClassNameException
+    public function __construct($source, $forClass = true)
     {
         $forWho = 'trait';
         $value = '';
@@ -36,12 +36,12 @@ class CannotResolveClassNameException extends Exception
         }
 
         if (is_scalar($source)) {
-            $value = sprintf(' %s', $source);
+            $value = sprintf(' %s', (string) $source);
         }
 
         $template = 'Name of %s from given \'%s\'%s cannot be resolved. Is there everything ok?';
         $message = sprintf($template, $forWho, gettype($source), $value);
 
-        return new static($message);
+        parent::__construct($message);
     }
 }

src/Meritoo/Common/Exception/Reflection/MissingChildClassesException.php

@@ -12,28 +12,27 @@ use Exception;
 use Meritoo\Common\Utilities\Reflection;
 
 /**
- * An exception used while given class has no child classes
+ * An exception used while given class has no child classes.
  *
- * @author    Meritoo <github@meritoo.pl>
- * @copyright Meritoo <http://www.meritoo.pl>
+ * @author    Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+ * @copyright Meritoo.pl
  */
 class MissingChildClassesException extends Exception
 {
     /**
-     * Creates exception
+     * Class constructor.
      *
      * @param array|object|string $parentClass Class that hasn't child classes, but it should. An array of objects,
      *                                         strings, object or string.
-     * @return MissingChildClassesException
      */
-    public static function create($parentClass): MissingChildClassesException
+    public function __construct($parentClass)
     {
         $template = 'The \'%s\' class requires one child class at least who will extend her (maybe is an abstract'
             .' class), but the child classes are missing. Did you forget to extend this class?';
 
-        $parentClassName = Reflection::getClassName($parentClass) ?? '[unknown class]';
+        $parentClassName = Reflection::getClassName($parentClass);
         $message = sprintf($template, $parentClassName);
 
-        return new static($message);
+        parent::__construct($message);
     }
 }

src/Meritoo/Common/Exception/Reflection/TooManyChildClassesException.php

@@ -12,29 +12,28 @@ use Exception;
 use Meritoo\Common\Utilities\Reflection;
 
 /**
- * An exception used while given class has more than one child class
+ * An exception used while given class has more than one child class.
  *
- * @author    Meritoo <github@meritoo.pl>
- * @copyright Meritoo <http://www.meritoo.pl>
+ * @author    Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+ * @copyright Meritoo.pl
  */
 class TooManyChildClassesException extends Exception
 {
     /**
-     * Creates exception
+     * Class constructor.
      *
      * @param array|object|string $parentClass  Class that has more than one child class, but it shouldn't. An array
      *                                          of objects, strings, object or string.
      * @param array               $childClasses Child classes
-     * @return TooManyChildClassesException
      */
-    public static function create($parentClass, array $childClasses): TooManyChildClassesException
+    public function __construct($parentClass, array $childClasses)
     {
         $template = "The '%s' class requires one child class at most who will extend her, but more than one child"
             ." class was found:\n- %s\n\nWhy did you create more than one classes that extend '%s' class?";
 
-        $parentClassName = Reflection::getClassName($parentClass) ?? '[unknown class]';
+        $parentClassName = Reflection::getClassName($parentClass);
         $message = sprintf($template, $parentClassName, implode("\n- ", $childClasses), $parentClassName);
 
-        return new static($message);
+        parent::__construct($message);
     }
 }

src/Meritoo/Common/Exception/Regex/IncorrectColorHexLengthException.php

@@ -8,29 +8,25 @@
 
 namespace Meritoo\Common\Exception\Regex;
 
-use Exception;
-
 /**
- * An exception used while length of given hexadecimal value of color is incorrect
+ * An exception used while length of given hexadecimal value of color is incorrect.
  *
- * @author    Meritoo <github@meritoo.pl>
- * @copyright Meritoo <http://www.meritoo.pl>
+ * @author    Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+ * @copyright Meritoo.pl
  */
-class IncorrectColorHexLengthException extends Exception
+class IncorrectColorHexLengthException extends \Exception
 {
     /**
-     * Creates exception
+     * Class constructor.
      *
      * @param string $color Incorrect hexadecimal value of color
-     * @return IncorrectColorHexLengthException
      */
-    public static function create($color)
+    public function __construct($color)
     {
         $template = 'Length of hexadecimal value of color \'%s\' is incorrect. It\'s %d, but it should be 3 or 6.'
             .' Is there everything ok?';
 
         $message = sprintf($template, $color, strlen($color));
-
-        return new static($message);
+        parent::__construct($message);
     }
 }

src/Meritoo/Common/Exception/Regex/InvalidColorHexValueException.php

@@ -8,26 +8,22 @@
 
 namespace Meritoo\Common\Exception\Regex;
 
-use Exception;
-
 /**
- * An exception used while given hexadecimal value of color is invalid
+ * An exception used while given hexadecimal value of color is invalid.
  *
- * @author    Meritoo <github@meritoo.pl>
- * @copyright Meritoo <http://www.meritoo.pl>
+ * @author    Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+ * @copyright Meritoo.pl
  */
-class InvalidColorHexValueException extends Exception
+class InvalidColorHexValueException extends \Exception
 {
     /**
-     * Creates exception
+     * Class constructor.
      *
      * @param string $color Invalid hexadecimal value of color
-     * @return InvalidColorHexValueException
      */
-    public static function create($color)
+    public function __construct($color)
     {
         $message = sprintf('Hexadecimal value of color \'%s\' is invalid. Is there everything ok?', $color);
-
-        return new static($message);
+        parent::__construct($message);
     }
 }

src/Meritoo/Common/Exception/Regex/InvalidUrlException.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace Meritoo\Common\Exception\Regex;
+
+/**
+ * An exception used while url is invalid.
+ *
+ * @author    Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+ * @copyright Meritoo.pl
+ */
+class InvalidUrlException extends \Exception
+{
+    /**
+     * Class constructor.
+     *
+     * @param string $url Invalid url
+     */
+    public function __construct($url)
+    {
+        $message = sprintf('Url \'%s\' is invalid. Is there everything ok?', $url);
+        parent::__construct($message);
+    }
+}

src/Meritoo/Common/Exception/Type/UnknownOopVisibilityTypeException.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace Meritoo\Common\Exception\Type;
+
+use Meritoo\Common\Exception\Base\UnknownTypeException;
+use Meritoo\Common\Type\OopVisibilityType;
+
+/**
+ * An exception used while the visibility of a property, a method or (as of PHP 7.1.0) a constant is unknown.
+ *
+ * @author    Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+ * @copyright Meritoo.pl
+ */
+class UnknownOopVisibilityTypeException extends UnknownTypeException
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function __construct($unknownType)
+    {
+        parent::__construct($unknownType, new OopVisibilityType(), 'OOP-related visibility');
+    }
+}

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

@@ -0,0 +1,205 @@
+<?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 DateTime;
+use Generator;
+use Meritoo\Common\Exception\Type\UnknownOopVisibilityTypeException;
+use Meritoo\Common\Type\OopVisibilityType;
+use PHPUnit_Framework_TestCase;
+use ReflectionClass;
+use ReflectionMethod;
+
+/**
+ * Base test case with common methods and data providers.
+ *
+ * @author    Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+ * @copyright Meritoo.pl
+ */
+abstract class BaseTestCase extends PHPUnit_Framework_TestCase
+{
+    /**
+     * Provides an empty value.
+     *
+     * @return Generator
+     */
+    public function provideEmptyValue()
+    {
+        yield[''];
+        yield['   '];
+        yield[null];
+        yield[0];
+        yield[false];
+        yield[[]];
+    }
+
+    /**
+     * Provides boolean value.
+     *
+     * @return Generator
+     */
+    public function provideBooleanValue()
+    {
+        yield[false];
+        yield[true];
+    }
+
+    /**
+     * Provides instance of DateTime class.
+     *
+     * @return Generator
+     */
+    public function provideDateTimeInstance()
+    {
+        yield[new DateTime()];
+        yield[new DateTime('yesterday')];
+        yield[new DateTime('now')];
+        yield[new DateTime('tomorrow')];
+    }
+
+    /**
+     * Provides relative / compound format of DateTime.
+     *
+     * @return Generator
+     */
+    public function provideDateTimeRelativeFormat()
+    {
+        yield['now'];
+        yield['yesterday'];
+        yield['tomorrow'];
+        yield['back of 10'];
+        yield['front of 10'];
+        yield['last day of February'];
+        yield['first day of next month'];
+        yield['last day of previous month'];
+        yield['last day of next month'];
+        yield['Y-m-d'];
+        yield['Y-m-d 10:00'];
+    }
+
+    /**
+     * Provides path of not existing file, e.g. "lorem/ipsum.jpg".
+     *
+     * @return Generator
+     */
+    public function provideNotExistingFilePath()
+    {
+        yield['lets-test.doc'];
+        yield['lorem/ipsum.jpg'];
+        yield['surprise/me/one/more/time.txt'];
+    }
+
+    /**
+     * Returns path of file used by tests.
+     * 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 = '')
+    {
+        if (!empty($directoryPath)) {
+            $directoryPath = '/'.$directoryPath;
+        }
+
+        return sprintf('%s/../../../../../data/tests/%s%s', __DIR__, $fileName, $directoryPath);
+    }
+
+    /**
+     * Verifies visibility and arguments of method.
+     *
+     * @param string                  $classNamespace         Namespace of class that contains method to verify
+     * @param string|ReflectionMethod $method                 Name of method or just the method 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
+     * @param int                     $requiredArgumentsCount (optional) Expected count/amount of required arguments
+     *                                                        of the verified method
+     *
+     * @throws UnknownOopVisibilityTypeException
+     *
+     * Attention. 2nd argument, the $method, may be:
+     * - string - name of the method
+     * - instance of ReflectionMethod - just the method (provided by ReflectionClass::getMethod() method)
+     */
+    protected function verifyMethodVisibilityAndArguments(
+        $classNamespace,
+        $method,
+        $visibilityType,
+        $argumentsCount = 0,
+        $requiredArgumentsCount = 0
+    ) {
+        /*
+         * Type of visibility is correct?
+         */
+        if (!(new OopVisibilityType())->isCorrectType($visibilityType)) {
+            throw new UnknownOopVisibilityTypeException($visibilityType);
+        }
+
+        $reflection = new ReflectionClass($classNamespace);
+
+        /*
+         * Name of method provided only?
+         * Let's find instance of the method (based on reflection)
+         */
+        if (!$method instanceof ReflectionMethod) {
+            $method = $reflection->getMethod($method);
+        }
+
+        switch ($visibilityType) {
+            case OopVisibilityType::IS_PUBLIC:
+                static::assertTrue($method->isPublic());
+
+                break;
+
+            case OopVisibilityType::IS_PROTECTED:
+                static::assertTrue($method->isProtected());
+
+                break;
+
+            case OopVisibilityType::IS_PRIVATE:
+                static::assertTrue($method->isPrivate());
+
+                break;
+        }
+
+        static::assertEquals($argumentsCount, $method->getNumberOfParameters());
+        static::assertEquals($requiredArgumentsCount, $method->getNumberOfRequiredParameters());
+    }
+
+    /**
+     * Verifies visibility and arguments of class constructor.
+     *
+     * @param string $classNamespace         Namespace of class that contains method 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
+     * @param int    $requiredArgumentsCount (optional) Expected count/amount of required arguments of the verified
+     *                                       method
+     *
+     * @throws UnknownOopVisibilityTypeException
+     */
+    protected function verifyConstructorVisibilityAndArguments(
+        $classNamespace,
+        $visibilityType,
+        $argumentsCount = 0,
+        $requiredArgumentsCount = 0
+    ) {
+        /*
+         * Let's grab the constructor
+         */
+        $reflection = new ReflectionClass($classNamespace);
+        $method = $reflection->getConstructor();
+
+        return $this->verifyMethodVisibilityAndArguments($classNamespace, $method, $visibilityType, $argumentsCount, $requiredArgumentsCount);
+    }
+}

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

@@ -0,0 +1,60 @@
+<?php
+
+namespace Meritoo\Common\Test\Base;
+
+use Generator;
+use Meritoo\Common\Type\Base\BaseType;
+
+/**
+ * Base test case for the type of something.
+ *
+ * @author    Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+ * @copyright Meritoo.pl
+ */
+abstract class BaseTypeTestCase extends BaseTestCase
+{
+    /**
+     * Verifies availability of all types.
+     */
+    public function testAvailabilityOfAllTypes()
+    {
+        $available = $this->getTestedTypeInstance()->getAll();
+        $all = $this->getAllExpectedTypes();
+
+        static::assertEquals($all, $available);
+    }
+
+    /**
+     * Verifies whether given type is correct or not.
+     *
+     * @param string $type     Type to verify
+     * @param bool   $expected Information if given type is correct or not
+     *
+     * @dataProvider provideTypeToVerify
+     */
+    public function testIfGivenTypeIsCorrect($type, $expected)
+    {
+        static::assertEquals($expected, $this->getTestedTypeInstance()->isCorrectType($type));
+    }
+
+    /**
+     * Provides type to verify and information if it's correct.
+     *
+     * @return Generator
+     */
+    abstract public function provideTypeToVerify();
+
+    /**
+     * Returns instance of the tested type.
+     *
+     * @return BaseType
+     */
+    abstract protected function getTestedTypeInstance();
+
+    /**
+     * Returns all expected types of the tested type.
+     *
+     * @return array
+     */
+    abstract protected function getAllExpectedTypes();
+}

src/Meritoo/Common/Type/Base/BaseType.php

@@ -14,26 +14,26 @@ use Meritoo\Common\Utilities\Reflection;
  * Base / abstract type of something, e.g. type of button, order, date etc.
  * Child class should contain constants - each of them represent one type.
  *
- * @author    Meritoo <github@meritoo.pl>
- * @copyright Meritoo <http://www.meritoo.pl>
+ * @author    Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+ * @copyright Meritoo.pl
  */
 abstract class BaseType
 {
     /**
-     * All types
+     * All types.
      *
-     * @var null|array
+     * @var array
      */
     private $all;
 
     /**
-     * Returns all types
+     * Returns all types.
      *
      * @return array
      */
-    public function getAll(): array
+    public function getAll()
     {
-        if (null === $this->all) {
+        if ($this->all === null) {
             $this->all = Reflection::getConstants($this);
         }
 
@@ -41,13 +41,14 @@ abstract class BaseType
     }
 
     /**
-     * Returns information if given type is correct
+     * Returns information if given type is correct.
+     *
+     * @param string $type The type to check
      *
-     * @param null|string $type The type to check
      * @return bool
      */
-    public static function isCorrectType(?string $type): bool
+    public function isCorrectType($type)
     {
-        return in_array($type, (new static())->getAll());
+        return in_array($type, $this->getAll(), true);
     }
 }

src/Meritoo/Common/Type/DatePartType.php

@@ -11,52 +11,52 @@ namespace Meritoo\Common\Type;
 use Meritoo\Common\Type\Base\BaseType;
 
 /**
- * Type of date part, e.g. "year"
+ * Type of date part, e.g. "year".
  *
- * @author    Meritoo <github@meritoo.pl>
- * @copyright Meritoo <http://www.meritoo.pl>
+ * @author    Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+ * @copyright Meritoo.pl
  */
 class DatePartType extends BaseType
 {
     /**
-     * The "day" date part
+     * The "day" date part.
      *
      * @var string
      */
-    public const DAY = 'day';
+    const DAY = 'day';
 
     /**
-     * The "hour" date part
+     * The "hour" date part.
      *
      * @var string
      */
-    public const HOUR = 'hour';
+    const HOUR = 'hour';
 
     /**
-     * The "minute" date part
+     * The "minute" date part.
      *
      * @var string
      */
-    public const MINUTE = 'minute';
+    const MINUTE = 'minute';
 
     /**
-     * The "month" date part
+     * The "month" date part.
      *
      * @var string
      */
-    public const MONTH = 'month';
+    const MONTH = 'month';
 
     /**
-     * The "second" date part
+     * The "second" date part.
      *
      * @var string
      */
-    public const SECOND = 'second';
+    const SECOND = 'second';
 
     /**
-     * The "year" date part
+     * The "year" date part.
      *
      * @var string
      */
-    public const YEAR = 'year';
+    const YEAR = 'year';
 }

src/Meritoo/Common/Type/OopVisibilityType.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace Meritoo\Common\Type;
+
+use Meritoo\Common\Type\Base\BaseType;
+
+/**
+ * The visibility of a property, a method or (as of PHP 7.1.0) a constant.
+ *
+ * @author    Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+ * @copyright Meritoo.pl
+ *
+ * @see       http://php.net/manual/en/language.oop5.visibility.php
+ */
+class OopVisibilityType extends BaseType
+{
+    /**
+     * The "private" visibility of OOP.
+     *
+     * @var int
+     */
+    const IS_PRIVATE = 3;
+
+    /**
+     * The "protected" visibility of OOP.
+     *
+     * @var int
+     */
+    const IS_PROTECTED = 2;
+
+    /**
+     * The "public" visibility of OOP.
+     *
+     * @var int
+     */
+    const IS_PUBLIC = 1;
+}

src/Meritoo/Common/Utilities/Bundle.php

@@ -0,0 +1,47 @@
+<?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\Utilities;
+
+/**
+ * Useful methods for bundle.
+ *
+ * @author     Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+ * @copyright  Meritoo.pl
+ */
+class Bundle
+{
+    /**
+     * Returns path to view / template of given bundle.
+     *
+     * @param string $viewPath   Path of the view / template, e.g. "MyDirectory/my-template"
+     * @param string $bundleName Name of the bundle, e.g. "MyExtraBundle"
+     * @param string $extension  (optional) Extension of the view / template
+     *
+     * @return string|null
+     */
+    public static function getBundleViewPath($viewPath, $bundleName, $extension = 'html.twig')
+    {
+        /*
+         * Unknown path, extension of the view / template or name of the bundle?
+         * Nothing to do
+         */
+        if (empty($viewPath) || empty($bundleName) || empty($extension)) {
+            return null;
+        }
+
+        /*
+         * Path of the view / template doesn't end with given extension?
+         */
+        if (!Regex::endsWith($viewPath, $extension)) {
+            $viewPath = sprintf('%s.%s', $viewPath, $extension);
+        }
+
+        return sprintf('%s:%s', $bundleName, $viewPath);
+    }
+}

src/Meritoo/Common/Utilities/Composer.php

@@ -8,31 +8,39 @@
 
 namespace Meritoo\Common\Utilities;
 
+use stdClass;
+
 /**
- * Useful Composer-related methods (only static functions)
+ * Useful Composer-related methods (only static functions).
  *
- * @author    Meritoo <github@meritoo.pl>
- * @copyright Meritoo <http://www.meritoo.pl>
+ * @author    Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+ * @copyright Meritoo.pl
  */
 class Composer
 {
     /**
-     * Name of the Composer's main file with configuration in Json format
+     * Name of the Composer's main file with configuration in Json format.
      *
      * @var string
      */
-    public const FILE_NAME_MAIN = 'composer.json';
+    const FILE_NAME_MAIN = 'composer.json';
 
     /**
-     * Returns value from composer.json file
+     * Returns value from composer.json file.
      *
      * @param string $composerJsonPath Path of composer.json file
      * @param string $nodeName         Name of node who value should be returned
-     * @return null|string
+     *
+     * @return string|null
      */
-    public static function getValue(string $composerJsonPath, string $nodeName): ?string
+    public static function getValue($composerJsonPath, $nodeName)
     {
-        $composerJsonReadable = is_readable($composerJsonPath);
+        $composerJsonString = is_string($composerJsonPath);
+        $composerJsonReadable = false;
+
+        if ($composerJsonString) {
+            $composerJsonReadable = is_readable($composerJsonPath);
+        }
 
         /*
          * Provided path or name of node are invalid?
@@ -41,21 +49,22 @@ class Composer
          *
          * Nothing to do
          */
-        if (!$composerJsonReadable || empty($nodeName)) {
+        if (!$composerJsonString || !is_string($nodeName) || !$composerJsonReadable || empty($nodeName)) {
             return null;
         }
 
         $content = file_get_contents($composerJsonPath);
-        $data = json_decode($content, false);
+        $data = json_decode($content);
 
         /*
          * Unknown data from the composer.json file or there is no node with given name?
          * Nothing to do
          */
-        if (null === $data || !isset($data->{$nodeName})) {
+        if ($data === null || !isset($data->{$nodeName})) {
             return null;
         }
 
+        /* @var stdClass $data */
         return $data->{$nodeName};
     }
 }

src/Meritoo/Common/Utilities/DatePeriod.php

@@ -0,0 +1,199 @@
+<?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\Utilities;
+
+use DateTime;
+
+/**
+ * A date's period.
+ * Contains start and end date of the period.
+ *
+ * @author     Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+ * @copyright  Meritoo.pl
+ */
+class DatePeriod
+{
+    /**
+     * The period constant: last month.
+     *
+     * @var int
+     */
+    const LAST_MONTH = 4;
+
+    /**
+     * The period constant: last week.
+     *
+     * @var int
+     */
+    const LAST_WEEK = 1;
+
+    /**
+     * The period constant: last year.
+     *
+     * @var int
+     */
+    const LAST_YEAR = 7;
+
+    /**
+     * The period constant: next month.
+     *
+     * @var int
+     */
+    const NEXT_MONTH = 6;
+
+    /**
+     * The period constant: next week.
+     *
+     * @var int
+     */
+    const NEXT_WEEK = 3;
+
+    /**
+     * The period constant: next year.
+     *
+     * @var int
+     */
+    const NEXT_YEAR = 9;
+
+    /**
+     * The period constant: this month.
+     *
+     * @var int
+     */
+    const THIS_MONTH = 5;
+
+    /**
+     * The period constant: this week.
+     *
+     * @var int
+     */
+    const THIS_WEEK = 2;
+
+    /**
+     * The period constant: this year.
+     *
+     * @var int
+     */
+    const THIS_YEAR = 8;
+
+    /**
+     * The start date of period.
+     *
+     * @var DateTime
+     */
+    private $startDate;
+
+    /**
+     * The end date of period.
+     *
+     * @var DateTime
+     */
+    private $endDate;
+
+    /**
+     * Class constructor.
+     *
+     * @param DateTime $startDate (optional) The start date of period
+     * @param DateTime $endDate   (optional) The end date of period
+     */
+    public function __construct(DateTime $startDate = null, DateTime $endDate = null)
+    {
+        $this->startDate = $startDate;
+        $this->endDate = $endDate;
+    }
+
+    /**
+     * Returns information if given period is correct.
+     *
+     * @param int $period The period to verify
+     *
+     * @return bool
+     */
+    public static function isCorrectPeriod($period)
+    {
+        return in_array($period, Reflection::getConstants(__CLASS__));
+    }
+
+    /**
+     * Returns formatted one of the period's date: start date or end date.
+     *
+     * @param string $format    Format used to format the date
+     * @param bool   $startDate (optional) If is set to true, start date is formatted. Otherwise - end date.
+     *
+     * @return string
+     */
+    public function getFormattedDate($format, $startDate = true)
+    {
+        $date = $this->getEndDate();
+
+        /*
+         * Start date should be formatted?
+         */
+        if ($startDate) {
+            $date = $this->getStartDate();
+        }
+
+        /*
+         * Unknown date or format is invalid?
+         */
+        if ($date === null || !Date::isValidDateFormat($format)) {
+            return '';
+        }
+
+        return $date->format($format);
+    }
+
+    /**
+     * Returns the end date of period.
+     *
+     * @return DateTime
+     */
+    public function getEndDate()
+    {
+        return $this->endDate;
+    }
+
+    /**
+     * Sets the end date of period.
+     *
+     * @param DateTime $endDate (optional) The end date of period
+     *
+     * @return $this
+     */
+    public function setEndDate(DateTime $endDate = null)
+    {
+        $this->endDate = $endDate;
+
+        return $this;
+    }
+
+    /**
+     * Returns the start date of period.
+     *
+     * @return DateTime
+     */
+    public function getStartDate()
+    {
+        return $this->startDate;
+    }
+
+    /**
+     * Sets the start date of period.
+     *
+     * @param DateTime $startDate (optional) The start date of period
+     *
+     * @return $this
+     */
+    public function setStartDate(DateTime $startDate = null)
+    {
+        $this->startDate = $startDate;
+
+        return $this;
+    }
+}

src/Meritoo/Common/Utilities/GeneratorUtility.php

@@ -11,17 +11,18 @@ namespace Meritoo\Common\Utilities;
 use Generator;
 
 /**
- * Useful methods for the Generator class (only static functions)
+ * Useful methods for the Generator class (only static functions).
  *
- * @author    Meritoo <github@meritoo.pl>
- * @copyright Meritoo <http://www.meritoo.pl>
+ * @author    Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+ * @copyright Meritoo.pl
  */
 class GeneratorUtility
 {
     /**
-     * Returns elements of generator
+     * Returns elements of generator.
      *
      * @param Generator $generator The generator who elements should be returned
+     *
      * @return array
      */
     public static function getGeneratorElements(Generator $generator)

src/Meritoo/Common/Utilities/Locale.php

@@ -9,19 +9,22 @@
 namespace Meritoo\Common\Utilities;
 
 /**
- * Useful locale methods
+ * Useful locale methods.
  *
- * @author    Meritoo <github@meritoo.pl>
- * @copyright Meritoo <http://www.meritoo.pl>
+ * @author     Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+ * @copyright  Meritoo.pl
  */
 class Locale
 {
     /**
-     * Returns locale for given category
+     * Sets locale for given category using given language and country code.
      *
-     * @param int $category Named constant specifying the category of the functions affected by the locale setting.
-     *                      It's the same constant as required by setlocale() function.
-     * @return string
+     * @param int    $category     Named constant specifying the category of the functions affected by the locale
+     *                             setting. It's the same constant as required by setlocale() function.
+     * @param string $languageCode Language code, in ISO 639-1 format. Short form of the locale, e.g. "fr".
+     * @param string $countryCode  (optional) Country code, in ISO 3166-1 alpha-2 format, e.g. "FR"
+     *
+     * @return bool
      *
      * Available categories (values of $category argument):
      * - LC_ALL for all of the below
@@ -32,17 +35,41 @@ class Locale
      * - LC_TIME for date and time formatting with strftime()
      * - LC_MESSAGES for system responses (available if PHP was compiled with libintl)
      */
-    public static function getLocale($category)
+    public static function setLocale($category, $languageCode, $countryCode = '')
     {
-        return setlocale($category, '0');
+        $category = (int) $category;
+
+        if (is_string($languageCode)) {
+            $languageCode = trim($languageCode);
+        }
+
+        $availableCategories = [
+            LC_ALL,
+            LC_COLLATE,
+            LC_CTYPE,
+            LC_MONETARY,
+            LC_NUMERIC,
+            LC_TIME,
+            LC_MESSAGES,
+        ];
+
+        if (empty($languageCode) || !in_array($category, $availableCategories)) {
+            return false;
+        }
+
+        $localeLongForm = self::getLongForm($languageCode, $countryCode);
+        setlocale($category, $localeLongForm);
+
+        return true;
     }
 
     /**
-     * Returns long form of the locale
+     * Returns long form of the locale.
      *
      * @param string $languageCode Language code, in ISO 639-1 format. Short form of the locale, e.g. "fr".
      * @param string $countryCode  (optional) Country code, in ISO 3166-1 alpha-2 format, e.g. "FR"
      * @param string $encoding     (optional) Encoding of the final locale
+     *
      * @return string
      *
      * Example:
@@ -78,49 +105,4 @@ class Locale
 
         return sprintf('%s_%s%s', $languageCode, strtoupper($countryCode), $encoding);
     }
-
-    /**
-     * Sets locale for given category using given language and country code
-     *
-     * @param int    $category     Named constant specifying the category of the functions affected by the locale
-     *                             setting. It's the same constant as required by setlocale() function.
-     * @param string $languageCode Language code, in ISO 639-1 format. Short form of the locale, e.g. "fr".
-     * @param string $countryCode  (optional) Country code, in ISO 3166-1 alpha-2 format, e.g. "FR"
-     * @return false|string
-     *
-     * Available categories (values of $category argument):
-     * - LC_ALL for all of the below
-     * - LC_COLLATE for string comparison, see strcoll()
-     * - LC_CTYPE for character classification and conversion, for example strtoupper()
-     * - LC_MONETARY for localeconv()
-     * - LC_NUMERIC for decimal separator (See also localeconv())
-     * - LC_TIME for date and time formatting with strftime()
-     * - LC_MESSAGES for system responses (available if PHP was compiled with libintl)
-     */
-    public static function setLocale($category, $languageCode, $countryCode = '')
-    {
-        $category = (int) $category;
-
-        if (is_string($languageCode)) {
-            $languageCode = trim($languageCode);
-        }
-
-        $availableCategories = [
-            LC_ALL,
-            LC_COLLATE,
-            LC_CTYPE,
-            LC_MONETARY,
-            LC_NUMERIC,
-            LC_TIME,
-            LC_MESSAGES,
-        ];
-
-        if (empty($languageCode) || !in_array($category, $availableCategories, true)) {
-            return false;
-        }
-
-        $localeLongForm = self::getLongForm($languageCode, $countryCode);
-
-        return setlocale($category, $localeLongForm);
-    }
 }

src/Meritoo/Common/Utilities/MimeTypes.php

@@ -8,19 +8,16 @@
 
 namespace Meritoo\Common\Utilities;
 
-use finfo;
-use RuntimeException;
-
 /**
- * Useful methods for mime types of files
+ * Useful methods for mime types of files.
  *
- * @author    Meritoo <github@meritoo.pl>
- * @copyright Meritoo <http://www.meritoo.pl>
+ * @author     Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+ * @copyright  Meritoo.pl
  */
 class MimeTypes
 {
     /**
-     * Mime types data
+     * Mime types data.
      *
      * @var array
      */
@@ -683,28 +680,12 @@ class MimeTypes
     ];
 
     /**
-     * Returns extension for given mime type
-     *
-     * @param string $mimeType The mime type, e.g. "video/mpeg"
-     * @return array|string
-     */
-    public static function getExtension($mimeType)
-    {
-        if (is_string($mimeType) && in_array($mimeType, self::$mimeTypes, true)) {
-            $data = Arrays::setKeysAsValues(self::$mimeTypes, false);
-
-            return $data[$mimeType];
-        }
-
-        return '';
-    }
-
-    /**
-     * Returns extensions for given mimes types
+     * Returns extensions for given mimes types.
      *
      * @param array $mimesTypes  The mimes types, e.g. ['video/mpeg', 'image/jpeg']
      * @param bool  $asUpperCase (optional) If is set to true, extensions are returned as upper case. Otherwise - lower
      *                           case.
+     *
      * @return array
      */
     public static function getExtensions(array $mimesTypes, $asUpperCase = false)
@@ -726,6 +707,9 @@ class MimeTypes
                 continue;
             }
 
+            /*
+             * Extensions should be returned as upper case?
+             */
             if ($asUpperCase) {
                 if (is_array($extension)) {
                     array_walk($extension, function (&$value) {
@@ -743,11 +727,45 @@ class MimeTypes
     }
 
     /**
-     * Returns mime type of given file
+     * Returns extension for given mime type.
+     *
+     * @param string $mimeType The mime type, e.g. "video/mpeg"
+     *
+     * @return string|array
+     */
+    public static function getExtension($mimeType)
+    {
+        if (is_string($mimeType) && in_array($mimeType, self::$mimeTypes)) {
+            $data = Arrays::setKeysAsValues(self::$mimeTypes, false);
+
+            return $data[$mimeType];
+        }
+
+        return '';
+    }
+
+    /**
+     * Returns information whether file with the given path is an image.
+     *
+     * @param string $path Path of the file to check
+     *
+     * @return bool
+     */
+    public static function isImagePath($path)
+    {
+        $mimeType = self::getMimeType($path);
+
+        return self::isImage($mimeType);
+    }
+
+    /**
+     * Returns mime type of given file.
      *
      * @param string $filePath Path of the file to check
+     *
      * @return string
-     * @throws RuntimeException
+     *
+     * @throws \RuntimeException
      */
     public static function getMimeType($filePath)
     {
@@ -759,52 +777,46 @@ class MimeTypes
             return '';
         }
 
-        // 1st possibility: the finfo class
+        /*
+         * 1st possibility: the finfo class
+         */
         if (class_exists('finfo')) {
-            $finfo = new finfo();
+            $finfo = new \finfo();
 
             return $finfo->file($filePath, FILEINFO_MIME_TYPE);
         }
 
-        // 2nd possibility: the mime_content_type function
+        /*
+         * 2nd possibility: the mime_content_type function
+         */
         if (function_exists('mime_content_type')) {
             return mime_content_type($filePath);
         }
 
-        // Oops, there is no possibility to read the mime type
+        /*
+         * Oops, there is no possibility to read the mime type
+         */
         $template = 'Neither \'finfo\' class nor \'mime_content_type\' function exists. There is no way to read the'
             .' mime type of file \'%s\'.';
 
         $message = sprintf($template, $filePath);
 
-        throw new RuntimeException($message);
+        throw new \RuntimeException($message);
     }
 
     /**
-     * Returns information whether the given file type is an image
+     * Returns information whether the given file type is an image.
      *
      * @param string $mimeType The mime type of file
+     *
      * @return bool
      */
     public static function isImage($mimeType)
     {
-        if (in_array($mimeType, self::$mimeTypes, true)) {
+        if (in_array($mimeType, self::$mimeTypes)) {
             return (bool) preg_match('|^image/.+$|', $mimeType);
         }
 
         return false;
     }
-
-    /**
-     * Returns information whether file with the given path is an image
-     *
-     * @param string $path Path of the file to check
-     * @return bool
-     */
-    public static function isImagePath($path)
-    {
-        $mimeType = self::getMimeType($path);
-
-        return self::isImage($mimeType);
-    }
 }

src/Meritoo/Common/Utilities/QueryBuilderUtility.php

@@ -15,96 +15,46 @@ use Doctrine\ORM\Query\Parameter;
 use Doctrine\ORM\QueryBuilder;
 
 /**
- * Useful methods for query builder (the Doctrine's QueryBuilder class)
+ * Useful methods for query builder (the Doctrine's QueryBuilder class).
  *
- * @author    Meritoo <github@meritoo.pl>
- * @copyright Meritoo <http://www.meritoo.pl>
+ * @author     Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+ * @copyright  Meritoo.pl
  */
 class QueryBuilderUtility
 {
     /**
-     * Adds given parameters to given query builder.
-     * Attention. Existing parameters will be overridden.
+     * Returns root alias of given query builder.
+     * If null is returned, alias was not found.
      *
-     * @param QueryBuilder          $queryBuilder The query builder
-     * @param array|ArrayCollection $parameters   Parameters to add. Collection of Doctrine\ORM\Query\Parameter
-     *                                            instances or an array with key-value pairs.
-     * @return QueryBuilder
-     */
-    public static function addParameters(QueryBuilder $queryBuilder, $parameters)
-    {
-        /*
-         * No parameters?
-         * Nothing to do
-         */
-        if (empty($parameters)) {
-            return $queryBuilder;
-        }
-
-        foreach ($parameters as $key => $parameter) {
-            $name = $key;
-            $value = $parameter;
-
-            if ($parameter instanceof Parameter) {
-                $name = $parameter->getName();
-                $value = $parameter->getValue();
-            }
-
-            $queryBuilder->setParameter($name, $value);
-        }
-
-        return $queryBuilder;
-    }
-
-    /**
-     * Deletes given entities
+     * @param QueryBuilder $queryBuilder The query builder to retrieve root alias
      *
-     * @param EntityManager         $entityManager The entity manager
-     * @param array|ArrayCollection $entities      The entities to delete
-     * @param bool                  $flushDeleted  (optional) If is set to true, flushes the deleted objects (default
-     *                                             behaviour). Otherwise - not.
-     * @return bool
+     * @return null|string
      */
-    public static function deleteEntities(EntityManager $entityManager, $entities, $flushDeleted = true)
+    public static function getRootAlias(QueryBuilder $queryBuilder)
     {
-        /*
-         * No entities provided?
-         * Nothing to do
-         */
-        if (empty($entities)) {
-            return false;
+        $aliases = $queryBuilder->getRootAliases();
+
+        if (empty($aliases)) {
+            return null;
         }
 
-        foreach ($entities as $entity) {
-            $entityManager->remove($entity);
-        }
-
-        // The deleted objects should be flushed?
-        if ($flushDeleted) {
-            $entityManager->flush();
-        }
-
-        return true;
+        return Arrays::getFirstElement($aliases);
     }
 
     /**
      * Returns alias of given property joined in given query builder
-     *
-     * If there are no joins or the join does not exist, null is returned.
+     * If the join does not exist, null is returned.
      * It's also information if given property is already joined in given query builder.
      *
      * @param QueryBuilder $queryBuilder The query builder to verify
      * @param string       $property     Name of property that maybe is joined
+     *
      * @return null|string
      */
     public static function getJoinedPropertyAlias(QueryBuilder $queryBuilder, $property)
     {
         $joins = $queryBuilder->getDQLPart('join');
 
-        /*
-         * No joins?
-         * Nothing to do
-         */
         if (empty($joins)) {
             return null;
         }
@@ -113,7 +63,7 @@ class QueryBuilderUtility
         $pattern = sprintf($patternTemplate, $property);
 
         foreach ($joins as $joinExpressions) {
-            /** @var Join $expression */
+            /* @var $expression Join */
             foreach ($joinExpressions as $expression) {
                 $joinedProperty = $expression->getJoin();
 
@@ -127,35 +77,14 @@ class QueryBuilderUtility
     }
 
     /**
-     * Returns root alias of given query builder.
-     * If null is returned, alias was not found.
-     *
-     * @param QueryBuilder $queryBuilder The query builder to retrieve root alias
-     * @return null|string
-     */
-    public static function getRootAlias(QueryBuilder $queryBuilder)
-    {
-        $aliases = $queryBuilder->getRootAliases();
-
-        /*
-         * No aliases?
-         * Nothing to do
-         */
-        if (empty($aliases)) {
-            return null;
-        }
-
-        return Arrays::getFirstElement($aliases);
-    }
-
-    /**
-     * Sets the WHERE criteria in given query builder
+     * Sets the WHERE criteria in given query builder.
      *
      * @param QueryBuilder $queryBuilder The query builder
      * @param array        $criteria     (optional) The criteria used in WHERE clause. It may simple array with pairs
      *                                   key-value or an array of arrays where second element of sub-array is the
      *                                   comparison operator. Example below.
-     * @param null|string  $alias        (optional) Alias used in the query
+     * @param string       $alias        (optional) Alias used in the query
+     *
      * @return QueryBuilder
      *
      * Example of the $criteria argument:
@@ -171,45 +100,98 @@ class QueryBuilderUtility
      *      'position' => 5,
      * ]
      */
-    public static function setCriteria(QueryBuilder $queryBuilder, array $criteria = [], $alias = null)
+    public static function setCriteria(QueryBuilder $queryBuilder, array $criteria = [], $alias = '')
     {
-        /*
-         * No criteria used in WHERE clause?
-         * Nothing to do
-         */
-        if (empty($criteria)) {
-            return $queryBuilder;
-        }
+        if (!empty($criteria)) {
+            if (empty($alias)) {
+                $alias = self::getRootAlias($queryBuilder);
+            }
 
-        /*
-         * No alias provided?
-         * Let's use root alias
-         */
-        if (null === $alias || '' === $alias) {
-            $alias = self::getRootAlias($queryBuilder);
-        }
+            foreach ($criteria as $column => $value) {
+                $compareOperator = '=';
 
-        foreach ($criteria as $column => $value) {
-            $compareOperator = '=';
+                if (is_array($value) && !empty($value)) {
+                    if (count($value) == 2) {
+                        $compareOperator = $value[1];
+                    }
 
-            if (is_array($value) && !empty($value)) {
-                if (2 === count($value)) {
-                    $compareOperator = $value[1];
+                    $value = $value[0];
                 }
 
-                $value = $value[0];
+                $predicate = sprintf('%s.%s %s :%s', $alias, $column, $compareOperator, $column);
+
+                if ($value === null) {
+                    $predicate = $queryBuilder->expr()->isNull(sprintf('%s.%s', $alias, $column));
+                    unset($criteria[$column]);
+                } else {
+                    $queryBuilder->setParameter($column, $value);
+                }
+
+                $queryBuilder = $queryBuilder->andWhere($predicate);
             }
+        }
 
-            $predicate = sprintf('%s.%s %s :%s', $alias, $column, $compareOperator, $column);
+        return $queryBuilder;
+    }
 
-            if (null === $value) {
-                $predicate = $queryBuilder->expr()->isNull(sprintf('%s.%s', $alias, $column));
-                unset($criteria[$column]);
-            } else {
-                $queryBuilder->setParameter($column, $value);
+    /**
+     * Deletes given entities.
+     *
+     * @param EntityManager         $entityManager The entity manager
+     * @param array|ArrayCollection $entities      The entities to delete
+     * @param bool                  $flushDeleted  (optional) If is set to true, flushes the deleted objects.
+     *                                             Otherwise - not.
+     *
+     * @return bool
+     */
+    public static function deleteEntities(EntityManager $entityManager, $entities, $flushDeleted = true)
+    {
+        /*
+         * No entities found?
+         * Nothing to do
+         */
+        if (empty($entities)) {
+            return false;
+        }
+
+        foreach ($entities as $entity) {
+            $entityManager->remove($entity);
+        }
+
+        /*
+         * The deleted objects should be flushed?
+         */
+        if ($flushDeleted) {
+            $entityManager->flush();
+        }
+
+        return true;
+    }
+
+    /**
+     * Adds given parameters to given query builder.
+     * Attention. Existing parameters will be overridden.
+     *
+     * @param QueryBuilder          $queryBuilder The query builder
+     * @param array|ArrayCollection $parameters   Parameters to add. Collection of instances of
+     *                                            Doctrine\ORM\Query\Parameter class or an array with key-value pairs.
+     *
+     * @return QueryBuilder
+     */
+    public static function addParameters(QueryBuilder $queryBuilder, $parameters)
+    {
+        if (!empty($parameters)) {
+            foreach ($parameters as $key => $parameter) {
+                $name = $key;
+                $value = $parameter;
+
+                if ($parameter instanceof Parameter) {
+                    $name = $parameter->getName();
+                    $value = $parameter->getValue();
+                }
+
+                $queryBuilder->setParameter($name, $value);
             }
-
-            $queryBuilder = $queryBuilder->andWhere($predicate);
         }
 
         return $queryBuilder;

src/Meritoo/Common/Utilities/Reflection.php

@@ -0,0 +1,656 @@
+<?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\Utilities;
+
+use Doctrine\Common\Collections\Collection;
+use Doctrine\Common\Util\ClassUtils;
+use Doctrine\Common\Util\Inflector;
+use Meritoo\Common\Exception\Reflection\CannotResolveClassNameException;
+use Meritoo\Common\Exception\Reflection\MissingChildClassesException;
+use Meritoo\Common\Exception\Reflection\TooManyChildClassesException;
+use ReflectionClass;
+use ReflectionException;
+use ReflectionMethod;
+use ReflectionObject;
+use ReflectionProperty;
+
+/**
+ * Useful reflection methods.
+ *
+ * @author     Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+ * @copyright  Meritoo.pl
+ */
+class Reflection
+{
+    /**
+     * Returns names of methods for given class / object.
+     *
+     * @param object|string $class              The object or name of object's class
+     * @param bool          $withoutInheritance (optional) If is set to true, only methods for given class are returned.
+     *                                          Otherwise - all methods, with inherited methods too.
+     *
+     * @return array
+     */
+    public static function getMethods($class, $withoutInheritance = false)
+    {
+        $effect = [];
+
+        $reflection = new ReflectionClass($class);
+        $methods = $reflection->getMethods();
+
+        if (!empty($methods)) {
+            $className = self::getClassName($class);
+
+            foreach ($methods as $method) {
+                if ($method instanceof ReflectionMethod) {
+                    if ($withoutInheritance && $className !== $method->class) {
+                        continue;
+                    }
+
+                    $effect[] = $method->name;
+                }
+            }
+        }
+
+        return $effect;
+    }
+
+    /**
+     * Returns constants of given class / object.
+     *
+     * @param object|string $class The object or name of object's class
+     *
+     * @return array
+     */
+    public static function getConstants($class)
+    {
+        $reflection = new ReflectionClass($class);
+
+        return $reflection->getConstants();
+    }
+
+    /**
+     * Returns maximum constant from all constants of given class / object.
+     * Values of constants should be integers.
+     *
+     * @param object|string $class The object or name of object's class
+     *
+     * @return int|null
+     */
+    public static function getMaxNumberConstant($class)
+    {
+        $constants = self::getConstants($class);
+
+        if (empty($constants)) {
+            return null;
+        }
+
+        $maxNumber = 0;
+
+        foreach ($constants as $constant) {
+            if (is_numeric($constant) && $constant > $maxNumber) {
+                $maxNumber = $constant;
+            }
+        }
+
+        return $maxNumber;
+    }
+
+    /**
+     * Returns information if given class / object has given method.
+     *
+     * @param object|string $class  The object or name of object's class
+     * @param string        $method Name of the method to find
+     *
+     * @return bool
+     */
+    public static function hasMethod($class, $method)
+    {
+        $reflection = new ReflectionClass($class);
+
+        return $reflection->hasMethod($method);
+    }
+
+    /**
+     * Returns information if given class / object has given property.
+     *
+     * @param object|string $class    The object or name of object's class
+     * @param string        $property Name of the property to find
+     *
+     * @return bool
+     */
+    public static function hasProperty($class, $property)
+    {
+        $reflection = new ReflectionClass($class);
+
+        return $reflection->hasProperty($property);
+    }
+
+    /**
+     * Returns information if given class / object has given constant.
+     *
+     * @param object|string $class    The object or name of object's class
+     * @param string        $constant Name of the constant to find
+     *
+     * @return bool
+     */
+    public static function hasConstant($class, $constant)
+    {
+        $reflection = new ReflectionClass($class);
+
+        return $reflection->hasConstant($constant);
+    }
+
+    /**
+     * Returns value of given constant.
+     *
+     * @param object|string $class    The object or name of object's class
+     * @param string        $constant Name of the constant that contains a value
+     *
+     * @return mixed
+     */
+    public static function getConstantValue($class, $constant)
+    {
+        $reflection = new ReflectionClass($class);
+
+        if (self::hasConstant($class, $constant)) {
+            return $reflection->getConstant($constant);
+        }
+
+        return null;
+    }
+
+    /**
+     * Returns value of given property.
+     * Looks for proper getter for the property.
+     *
+     * @param mixed  $object   Object that should contains given property
+     * @param string $property Name of the property that contains a value. It may be also multiple properties
+     *                         dot-separated, e.g. "invoice.user.email".
+     * @param bool   $force    (optional) If is set to true, try to retrieve value even if the object doesn't have
+     *                         property. Otherwise - not.
+     *
+     * @return mixed
+     */
+    public static function getPropertyValue($object, $property, $force = false)
+    {
+        $value = null;
+
+        /*
+         * Property is a dot-separated string?
+         * Let's find all values of the chain, of the dot-separated properties
+         */
+        if (Regex::contains($property, '.')) {
+            $exploded = explode('.', $property);
+
+            $property = $exploded[0];
+            $object = self::getPropertyValue($object, $property, $force);
+
+            /*
+             * Value of processed property from the chain is not null?
+             * Let's dig more and get proper value
+             *
+             * Required to avoid bug:
+             * ReflectionObject::__construct() expects parameter 1 to be object, null given
+             * (...)
+             * 4. at ReflectionObject->__construct (null)
+             * 5. at Reflection ::getPropertyValue (null, 'name', true)
+             * 6. at ListService->getItemValue (object(Deal), 'project.name', '0')
+             *
+             * while using "project.name" as property - $project has $name property ($project exists in the Deal class)
+             * and the $project equals null
+             *
+             * Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+             * 2016-11-07
+             */
+            if ($object !== null) {
+                unset($exploded[0]);
+
+                $property = implode('.', $exploded);
+                $value = self::getPropertyValue($object, $property, $force);
+            }
+        } else {
+            $className = self::getClassName($object);
+            $reflectionProperty = null;
+
+            /*
+             * 1st try:
+             * Use \ReflectionObject class
+             */
+            try {
+                $reflectionProperty = new ReflectionProperty($className, $property);
+                $value = $reflectionProperty->getValue($object);
+            } catch (ReflectionException $exception) {
+                /*
+                 * 2nd try:
+                 * Look for the get / has / is methods
+                 */
+                $class = new ReflectionObject($object);
+                $valueFound = false;
+
+                if ($class->hasProperty($property) || $force) {
+                    $property = Inflector::classify($property);
+
+                    $methodPrefixes = [
+                        'get',
+                        'has',
+                        'is',
+                    ];
+
+                    foreach ($methodPrefixes as $prefix) {
+                        $method = sprintf('%s%s', $prefix, $property);
+
+                        if ($class->hasMethod($method)) {
+                            $value = $object->{$method}();
+                            $valueFound = true;
+
+                            break;
+                        }
+                    }
+                }
+
+                if (!$valueFound && $reflectionProperty !== null) {
+                    /*
+                     * Oops, we have got exception.
+                     *
+                     * 3rd try:
+                     * Let's try modify accessibility of the property and try again to get value.
+                     */
+                    $reflectionProperty->setAccessible(true);
+                    $value = $reflectionProperty->getValue($object);
+                }
+            }
+        }
+
+        return $value;
+    }
+
+    /**
+     * Returns values of given property for given objects.
+     * Looks for proper getter for the property.
+     *
+     * @param Collection|object|array $objects  The objects that should contain given property. It may be also one
+     *                                          object.
+     * @param string                  $property Name of the property that contains a value
+     * @param bool                    $force    (optional) If is set to true, try to retrieve value even if the
+     *                                          object does not have property. Otherwise - not.
+     *
+     * @return array
+     */
+    public static function getPropertyValues($objects, $property, $force = false)
+    {
+        if ($objects instanceof Collection) {
+            $objects = $objects->toArray();
+        }
+
+        $values = [];
+        $objects = Arrays::makeArray($objects);
+
+        foreach ($objects as $entity) {
+            $value = self::getPropertyValue($entity, $property, $force);
+
+            if ($value !== null) {
+                $values[] = $value;
+            }
+        }
+
+        return $values;
+    }
+
+    /**
+     * Returns a class name for given source.
+     *
+     * @param array|object|string $source           An array of objects, namespaces, object or namespace
+     * @param bool                $withoutNamespace (optional) If is set to true, namespace is omitted. Otherwise -
+     *                                              not, full name of class is returned, with namespace.
+     *
+     * @return string|null
+     */
+    public static function getClassName($source, $withoutNamespace = false)
+    {
+        /*
+         * First argument is not proper source of class?
+         * Nothing to do
+         */
+        if (empty($source) || (!is_array($source) && !is_object($source) && !is_string($source))) {
+            return null;
+        }
+
+        $name = '';
+
+        /*
+         * An array of objects was provided?
+         * Let's use first of them
+         */
+        if (is_array($source)) {
+            $source = Arrays::getFirstElement($source);
+        }
+
+        /*
+         * Let's prepare name of class
+         */
+        if (is_object($source)) {
+            $name = get_class($source);
+        } elseif (is_string($source) && (class_exists($source) || trait_exists($source))) {
+            $name = $source;
+        }
+
+        /*
+         * Name of class is still unknown?
+         * Nothing to do
+         */
+        if (empty($name)) {
+            return null;
+        }
+
+        /*
+         * Namespace is not required?
+         * Let's return name of class only
+         */
+        if ($withoutNamespace) {
+            $classOnly = Miscellaneous::getLastElementOfString($name, '\\');
+
+            if ($classOnly !== null) {
+                $name = $classOnly;
+            }
+
+            return $name;
+        }
+
+        return ClassUtils::getRealClass($name);
+    }
+
+    /**
+     * Returns namespace of class for given source.
+     *
+     * @param array|object|string $source An array of objects, namespaces, object or namespace
+     *
+     * @return string
+     */
+    public static function getClassNamespace($source)
+    {
+        $fullClassName = self::getClassName($source);
+
+        if (empty($fullClassName)) {
+            return '';
+        }
+
+        $className = self::getClassName($source, true);
+
+        if ($className == $fullClassName) {
+            return $className;
+        }
+
+        return Miscellaneous::getStringWithoutLastElement($fullClassName, '\\');
+    }
+
+    /**
+     * Returns information if given interface is implemented by given class / object.
+     *
+     * @param array|object|string $source    An array of objects, namespaces, object or namespace
+     * @param string              $interface The interface that should be implemented
+     *
+     * @return bool
+     */
+    public static function isInterfaceImplemented($source, $interface)
+    {
+        $className = self::getClassName($source);
+        $interfaces = class_implements($className);
+
+        return in_array($interface, $interfaces);
+    }
+
+    /**
+     * Returns information if given child class is a subclass of given parent class.
+     *
+     * @param array|object|string $childClass  The child class. An array of objects, namespaces, object or namespace.
+     * @param array|object|string $parentClass The parent class. An array of objects, namespaces, object or namespace.
+     *
+     * @return bool
+     */
+    public static function isChildOfClass($childClass, $parentClass)
+    {
+        $childClassName = self::getClassName($childClass);
+        $parentClassName = self::getClassName($parentClass);
+
+        $parents = class_parents($childClassName);
+
+        if (is_array($parents)) {
+            return in_array($parentClassName, $parents);
+        }
+
+        return false;
+    }
+
+    /**
+     * Returns given object properties.
+     *
+     * @param array|object|string $source An array of objects, namespaces, object or namespace
+     * @param int                 $filter (optional) Filter of properties. Uses ReflectionProperty class constants.
+     *                                    By default all properties are returned.
+     *
+     * @return array|ReflectionProperty
+     */
+    public static function getProperties($source, $filter = null)
+    {
+        $className = self::getClassName($source);
+        $reflection = new ReflectionClass($className);
+
+        if ($filter === null) {
+            $filter = ReflectionProperty::IS_PRIVATE
+                + ReflectionProperty::IS_PROTECTED
+                + ReflectionProperty::IS_PUBLIC
+                + ReflectionProperty::IS_STATIC;
+        }
+
+        return $reflection->getProperties($filter);
+    }
+
+    /**
+     * Returns a parent class.
+     *
+     * @param array|object|string $source An array of objects, namespaces, object or namespace
+     *
+     * @return ReflectionClass
+     */
+    public static function getParentClass($source)
+    {
+        $className = self::getClassName($source);
+        $reflection = new ReflectionClass($className);
+
+        return $reflection->getParentClass();
+    }
+
+    /**
+     * Returns child classes of given class.
+     * It's an array of namespaces of the child classes or null (if given class has not child classes).
+     *
+     * @param array|object|string $class Class who child classes should be returned. An array of objects, strings,
+     *                                   object or string.
+     *
+     * @return array|null
+     *
+     * @throws CannotResolveClassNameException
+     */
+    public static function getChildClasses($class)
+    {
+        $allClasses = get_declared_classes();
+
+        /*
+         * No classes?
+         * Nothing to do
+         */
+        if (empty($allClasses)) {
+            return null;
+        }
+
+        $className = self::getClassName($class);
+
+        /*
+         * Oops, cannot resolve class
+         */
+        if ($className === null) {
+            throw new CannotResolveClassNameException($class);
+        }
+
+        $childClasses = [];
+
+        foreach ($allClasses as $oneClass) {
+            if (self::isChildOfClass($oneClass, $className)) {
+                /*
+                 * Attention. I have to use ClassUtils::getRealClass() method to avoid problem with the proxy / cache
+                 * classes. Example:
+                 * - My\ExtraBundle\Entity\MyEntity
+                 * - Proxies\__CG__\My\ExtraBundle\Entity\MyEntity
+                 *
+                 * It's actually the same class, so I have to skip it.
+                 */
+                $realClass = ClassUtils::getRealClass($oneClass);
+
+                if (in_array($realClass, $childClasses)) {
+                    continue;
+                }
+
+                $childClasses[] = $realClass;
+            }
+        }
+
+        return $childClasses;
+    }
+
+    /**
+     * Returns namespace of one child class which extends given class.
+     * Extended class should has only one child class.
+     *
+     * @param array|object|string $parentClass Class who child class should be returned. An array of objects,
+     *                                         namespaces, object or namespace.
+     *
+     * @return mixed
+     *
+     * @throws MissingChildClassesException
+     * @throws TooManyChildClassesException
+     */
+    public static function getOneChildClass($parentClass)
+    {
+        $childClasses = self::getChildClasses($parentClass);
+
+        /*
+         * No child classes?
+         * Oops, the base / parent class hasn't child class
+         */
+        if (empty($childClasses)) {
+            throw new MissingChildClassesException($parentClass);
+        }
+
+        /*
+         * More than 1 child class?
+         * Oops, the base / parent class has too many child classes
+         */
+        if (count($childClasses) > 1) {
+            throw new TooManyChildClassesException($parentClass, $childClasses);
+        }
+
+        return trim($childClasses[0]);
+    }
+
+    /**
+     * Returns property, the ReflectionProperty instance, of given object.
+     *
+     * @param array|object|string $class    An array of objects, namespaces, object or namespace
+     * @param string              $property Name of the property
+     * @param int                 $filter   (optional) Filter of properties. Uses ReflectionProperty class constants.
+     *                                      By default all properties are allowed / processed.
+     *
+     * @return null|ReflectionProperty
+     */
+    public static function getProperty($class, $property, $filter = null)
+    {
+        $className = self::getClassName($class);
+        $properties = self::getProperties($className, $filter);
+
+        if (!empty($properties)) {
+            /* @var $reflectionProperty ReflectionProperty */
+            foreach ($properties as $reflectionProperty) {
+                if ($reflectionProperty->getName() == $property) {
+                    return $reflectionProperty;
+                }
+            }
+        }
+
+        return null;
+    }
+
+    /**
+     * Returns information if given class / object uses / implements given trait.
+     *
+     * @param array|object|string $class         An array of objects, namespaces, object or namespace
+     * @param array|string        $trait         An array of strings or string
+     * @param bool                $verifyParents If is set to true, parent classes are verified if they use given
+     *                                           trait. Otherwise - not.
+     *
+     * @return bool|null
+     *
+     * @throws CannotResolveClassNameException
+     */
+    public static function usesTrait($class, $trait, $verifyParents = false)
+    {
+        $className = self::getClassName($class);
+        $traitName = self::getClassName($trait);
+
+        /*
+         * Oops, cannot resolve class
+         */
+        if (empty($className)) {
+            throw new CannotResolveClassNameException($class);
+        }
+
+        /*
+         * Oops, cannot resolve trait
+         */
+        if (empty($traitName)) {
+            throw new CannotResolveClassNameException($class, false);
+        }
+
+        $reflection = new ReflectionClass($className);
+        $traitsNames = $reflection->getTraitNames();
+
+        $uses = in_array($traitName, $traitsNames);
+
+        if (!$uses && $verifyParents) {
+            $parentClassName = self::getParentClassName($className);
+
+            if ($parentClassName !== null) {
+                return self::usesTrait($parentClassName, $trait, true);
+            }
+        }
+
+        return $uses;
+    }
+
+    /**
+     * Returns name of the parent class.
+     * If given class does not extend another, returns null.
+     *
+     * @param array|object|string $class An array of objects, namespaces, object or namespace
+     *
+     * @return string|null
+     */
+    public static function getParentClassName($class)
+    {
+        $className = self::getClassName($class);
+        $reflection = new ReflectionClass($className);
+        $parentClass = $reflection->getParentClass();
+
+        if ($parentClass === null || $parentClass === false) {
+            return null;
+        }
+
+        return $parentClass->getName();
+    }
+}

src/Meritoo/Common/Utilities/Repository.php

@@ -0,0 +1,111 @@
+<?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\Utilities;
+
+use Doctrine\ORM\EntityRepository;
+use Doctrine\ORM\QueryBuilder;
+
+/**
+ * Useful methods for repository.
+ *
+ * @author     Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+ * @copyright  Meritoo.pl
+ */
+class Repository
+{
+    /**
+     * Replenishes positions of given items.
+     *
+     * @param array $items  The items
+     * @param bool  $asLast (optional) If is set to true, items are placed at the end. Otherwise - at the top.
+     * @param bool  $force  (optional) If is set to true, positions are set even there is no extreme position.
+     *                      Otherwise - if extreme position is not found (is null) replenishment is stopped / skipped.
+     */
+    public static function replenishPositions($items, $asLast = true, $force = false)
+    {
+        $position = self::getExtremePosition($items, $asLast);
+
+        if ($position === null && $force) {
+            $position = 0;
+        }
+
+        if ($position !== null && !empty($items)) {
+            foreach ($items as $item) {
+                if (method_exists($item, 'getPosition')) {
+                    if ($item->getPosition() === null) {
+                        if ($asLast) {
+                            ++$position;
+                        } else {
+                            --$position;
+                        }
+
+                        if (method_exists($item, 'setPosition')) {
+                            $item->setPosition($position);
+                        }
+                    }
+                }
+            }
+        }
+    }
+
+    /**
+     * Returns extreme position (max or min) of given items.
+     *
+     * @param array $items The items
+     * @param bool  $max   (optional) If is set to true, maximum value is returned. Otherwise - minimum.
+     *
+     * @return int
+     */
+    public static function getExtremePosition($items, $max = true)
+    {
+        $extreme = null;
+
+        if (!empty($items)) {
+            foreach ($items as $item) {
+                if (Reflection::hasMethod($item, 'getPosition')) {
+                    $position = $item->getPosition();
+
+                    if ($max) {
+                        if ($position > $extreme) {
+                            $extreme = $position;
+                        }
+                    } else {
+                        if ($position < $extreme) {
+                            $extreme = $position;
+                        }
+                    }
+                }
+            }
+        }
+
+        return $extreme;
+    }
+
+    /**
+     * Returns query builder for given entity's repository.
+     * The entity should contain given property, e.g. "name".
+     *
+     * @param EntityRepository $repository Repository of the entity
+     * @param string           $property   (optional) Name of property used by the ORDER BY clause
+     * @param string           $direction  (optional) Direction used by the ORDER BY clause ("ASC" or "DESC")
+     *
+     * @return QueryBuilder
+     */
+    public static function getEntityOrderedQueryBuilder(
+        EntityRepository $repository,
+        $property = 'name',
+        $direction = 'ASC'
+    ) {
+        $alias = 'qb';
+
+        return $repository
+            ->createQueryBuilder($alias)
+            ->orderBy(sprintf('%s.%s', $alias, $property), $direction);
+    }
+}

src/Meritoo/Common/Utilities/Uri.php

@@ -9,88 +9,58 @@
 namespace Meritoo\Common\Utilities;
 
 /**
- * Useful methods related to uri
+ * Useful uri methods (only static functions).
  *
- * @author    Meritoo <github@meritoo.pl>
- * @copyright Meritoo <http://www.meritoo.pl>
+ * @author     Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+ * @copyright  Meritoo.pl
  */
 class Uri
 {
     /**
-     * Adds protocol to given url, if the url does not contain given protocol.
-     * Returns the new url.
-     *
-     * @param string $url      Url string
-     * @param string $protocol (optional) Protocol string
-     * @return string
-     */
-    public static function addProtocolToUrl($url, $protocol = 'http')
-    {
-        $pattern = sprintf('/^%s.*/', $protocol);
-
-        if ((bool) preg_match($pattern, $url)) {
-            return $url;
-        }
-
-        return sprintf('%s://%s', $protocol, $url);
-    }
-
-    public static function buildUrl(string $rootUrl, string ...$urlParts): string
-    {
-        $rootUrl = Regex::clearEndingSlash($rootUrl);
-
-        if (empty($urlParts) || Arrays::containsEmptyStringsOnly($urlParts)) {
-            return $rootUrl;
-        }
-
-        array_walk($urlParts, static function (&$part) {
-            $part = Regex::clearBeginningSlash($part);
-            $part = Regex::clearEndingSlash($part);
-        });
-
-        return sprintf(
-            '%s/%s',
-            $rootUrl,
-            implode('/', $urlParts)
-        );
-    }
-
-    /**
-     * Returns full uri string
+     * Returns full uri string.
      *
      * @param bool $withoutHost (optional) If is set to true, means that host / server name is omitted
+     *
      * @return string
      */
     public static function getFullUri($withoutHost = false)
     {
-        $requestedUrl = Miscellaneous::getSafelyGlobalVariable(INPUT_SERVER, 'REQUEST_URI');
+        $effect = Miscellaneous::getSafelyGlobalVariable(INPUT_SERVER, 'REQUEST_URI');
 
-        /*
-         * Unknown requested url?
-         * Nothing to do
-         */
-        if (empty($requestedUrl)) {
-            return '';
-        }
-
-        /*
-         * Without host / server name?
-         * All is done
-         */
         if ($withoutHost) {
-            return $requestedUrl;
+            return $effect;
         }
 
-        return self::getServerNameOrIp(true).$requestedUrl;
+        return self::getServerNameOrIp(true).$effect;
     }
 
     /**
-     * Returns protocol name
+     * Returns server name or IP address.
+     *
+     * @param bool $withProtocol (optional) If is set to true, protocol name is included. Otherwise isn't.
+     *
+     * @return string
+     */
+    public static function getServerNameOrIp($withProtocol = false)
+    {
+        $protocol = '';
+
+        if ($withProtocol) {
+            $protocol .= self::getProtocolName().'://';
+        }
+
+        return $protocol.Miscellaneous::getSafelyGlobalVariable(INPUT_SERVER, 'HTTP_HOST');
+    }
+
+    /**
+     * Returns protocol name.
      *
      * @return string
      */
     public static function getProtocolName()
     {
+        $effect = '';
+
         $matches = [];
         $protocolData = Miscellaneous::getSafelyGlobalVariable(INPUT_SERVER, 'SERVER_PROTOCOL'); // e.g. HTTP/1.1
         $matchCount = preg_match('|(.+)\/(.+)|', $protocolData, $matches);
@@ -100,89 +70,31 @@ class Uri
          * $matches[2] - protocol version, e.g. 1.1
          */
 
-        // Oops, cannot match protocol
-        if (0 === $matchCount) {
-            return '';
+        if ($matchCount > 0) {
+            $effect = strtolower($matches[1]);
         }
 
-        return strtolower($matches[1]);
+        return $effect;
     }
 
     /**
-     * Returns http referer uri
+     * Returns http referer uri.
      *
      * @return string
      */
     public static function getRefererUri()
     {
-        return Miscellaneous::getSafelyGlobalVariable(INPUT_SERVER, 'HTTP_REFERER');
+        $effect = '';
+
+        if (filter_has_var(INPUT_SERVER, 'HTTP_REFERER')) {
+            $effect = Miscellaneous::getSafelyGlobalVariable(INPUT_SERVER, 'HTTP_REFERER');
+        }
+
+        return $effect;
     }
 
     /**
-     * Returns url to resource secured by given htpasswd login and password
-     *
-     * @param string $url      A path / url to some resource, e.g. page, image, css file
-     * @param string $user     (optional) User name used to log in
-     * @param string $password (optional) User password used to log in
-     * @return string
-     */
-    public static function getSecuredUrl($url, $user = '', $password = '')
-    {
-        /*
-         * Url is not provided?
-         * Nothing to do
-         */
-        if (empty($url)) {
-            return '';
-        }
-
-        $protocol = self::getProtocolName();
-        $host = self::getServerNameOrIp();
-
-        if (!Regex::startsWith($url, '/')) {
-            $url = sprintf('/%s', $url);
-        }
-
-        $url = $host.$url;
-
-        if (!empty($user) && !empty($password)) {
-            $url = sprintf('%s:%s@%s', $user, $password, $url);
-        }
-
-        return sprintf('%s://%s', $protocol, $url);
-    }
-
-    /**
-     * Returns server name or IP address
-     *
-     * @param bool $withProtocol (optional) If is set to true, protocol name is included. Otherwise isn't.
-     * @return string
-     */
-    public static function getServerNameOrIp($withProtocol = false)
-    {
-        $host = Miscellaneous::getSafelyGlobalVariable(INPUT_SERVER, 'HTTP_HOST');
-
-        /*
-         * Unknown host / server?
-         * Nothing to do
-         */
-        if (empty($host)) {
-            return '';
-        }
-
-        /*
-         * With protocol?
-         * Let's include the protocol
-         */
-        if ($withProtocol) {
-            return sprintf('%s://%s', self::getProtocolName(), $host);
-        }
-
-        return $host;
-    }
-
-    /**
-     * Returns user's IP address
+     * Returns user's IP address.
      *
      * @return string
      */
@@ -192,63 +104,11 @@ class Uri
     }
 
     /**
-     * Returns name of user's operating system
-     *
-     * @return string
-     */
-    public static function getUserOperatingSystemName()
-    {
-        $info = self::getUserWebBrowserInfo();
-
-        $knownSystems = [
-            'Linux' => 'Linux',
-            'Win' => 'Windows',
-            'Mac' => 'Mac OS',
-        ];
-
-        foreach ($knownSystems as $pattern => $systemName) {
-            $matches = [];
-            $matchCount = preg_match(sprintf('|%s|', $pattern), $info, $matches);
-
-            if ($matchCount > 0) {
-                return $systemName;
-            }
-        }
-
-        return '';
-    }
-
-    /**
-     * Returns user's web browser information
-     *
-     * @return string
-     *
-     * Examples:
-     * - Mozilla Firefox:
-     * 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10.10; rv:34.0) Gecko/20100101 Firefox/34.0'
-     *
-     * - Google Chrome:
-     * 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/39.0.2171.95
-     * Safari/537.36'
-     *
-     * - Opera:
-     * 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/39.0.2171.65
-     * Safari/537.36 OPR/26.0.1656.24'
-     *
-     * - Apple Safari:
-     * 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_1) AppleWebKit/600.2.5 (KHTML, like Gecko) Version/8.0.2
-     * Safari/600.2.5'
-     */
-    public static function getUserWebBrowserInfo()
-    {
-        return Miscellaneous::getSafelyGlobalVariable(INPUT_SERVER, 'HTTP_USER_AGENT');
-    }
-
-    /**
-     * Returns name and version of user's web browser
+     * Returns name and version of user's web browser.
      *
      * @param bool $withVersion (optional) If is set to true, version of the browser is returned too. Otherwise -
      *                          name only.
+     *
      * @return string
      */
     public static function getUserWebBrowserName($withVersion = false)
@@ -281,44 +141,60 @@ class Uri
     }
 
     /**
-     * Returns information if given url is external, from another server / domain
+     * Returns user's web browser information.
      *
-     * @param string $url The url to check
-     * @return bool
+     * @return string
+     *
+     * Examples:
+     * - Mozilla Firefox:
+     * 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10.10; rv:34.0) Gecko/20100101 Firefox/34.0'
+     *
+     * - Google Chrome:
+     * 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/39.0.2171.95
+     * Safari/537.36'
+     *
+     * - Opera:
+     * 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/39.0.2171.65
+     * Safari/537.36 OPR/26.0.1656.24'
+     *
+     * - Apple Safari:
+     * 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_1) AppleWebKit/600.2.5 (KHTML, like Gecko) Version/8.0.2
+     * Safari/600.2.5'
      */
-    public static function isExternalUrl($url)
+    public static function getUserWebBrowserInfo()
     {
-        /*
-         * Unknown url or it's just slash?
-         * Nothing to do
-         */
-        if (empty($url) || '/' === $url) {
-            return false;
-        }
-
-        $currentUrl = self::getServerNameOrIp(true);
-        $url = self::replenishProtocol($url);
-
-        // Let's prepare pattern of current url
-        $search = [
-            ':',
-            '/',
-            '.',
-        ];
-
-        $replace = [
-            '\:',
-            '\/',
-            '\.',
-        ];
-
-        $currentUrlPattern = str_replace($search, $replace, $currentUrl);
-
-        return !Regex::contains($url, $currentUrlPattern);
+        return Miscellaneous::getSafelyGlobalVariable(INPUT_SERVER, 'HTTP_USER_AGENT');
     }
 
     /**
-     * Returns information if running server is localhost
+     * Returns name of user's operating system.
+     *
+     * @return string
+     */
+    public static function getUserOperatingSystemName()
+    {
+        $info = self::getUserWebBrowserInfo();
+
+        $knownSystems = [
+            'Linux' => 'Linux',
+            'Win' => 'Windows',
+            'Mac' => 'Mac OS',
+        ];
+
+        foreach ($knownSystems as $pattern => $systemName) {
+            $matches = [];
+            $matchCount = preg_match(sprintf('|%s|', $pattern), $info, $matches);
+
+            if ($matchCount > 0) {
+                return $systemName;
+            }
+        }
+
+        return '';
+    }
+
+    /**
+     * Returns information if running server is localhost.
      *
      * @return bool
      */
@@ -334,16 +210,34 @@ class Uri
     }
 
     /**
-     * Replenishes protocol in the given url
+     * Returns information if given url is external, from another server / domain.
+     *
+     * @param string $url The url to check
+     *
+     * @return bool
+     */
+    public static function isExternalUrl($url)
+    {
+        $currentUrl = self::getServerNameOrIp(true);
+        $url = self::replenishProtocol($url);
+
+        return !Regex::contains($currentUrl, $url);
+    }
+
+    /**
+     * Replenishes protocol in the given url.
      *
      * @param string $url      The url to check and replenish
      * @param string $protocol (optional) The protocol which is replenished. If is empty, protocol of current request
      *                         is used.
+     *
      * @return string
      */
     public static function replenishProtocol($url, $protocol = '')
     {
-        // Let's trim the url
+        /*
+         * Let's trim the url
+         */
         if (is_string($url)) {
             $url = trim($url);
         }
@@ -364,11 +258,60 @@ class Uri
             return $url;
         }
 
-        // Protocol is not provided?
+        /*
+         * Protocol is not provided?
+         */
         if (empty($protocol)) {
             $protocol = self::getProtocolName();
         }
 
         return sprintf('%s://%s', $protocol, $url);
     }
+
+    /**
+     * Returns url to resource secured by given htpasswd login and password.
+     *
+     * @param string $url      A path / url to some resource, e.g. page, image, css file
+     * @param string $user     (optional) User name used to log in
+     * @param string $password (optional) User password used to log in
+     *
+     * @return string
+     */
+    public static function getSecuredUrl($url, $user = '', $password = '')
+    {
+        $protocol = self::getProtocolName();
+        $host = self::getServerNameOrIp();
+
+        if (!Regex::startsWith($url, '/')) {
+            $url = sprintf('/%s', $url);
+        }
+
+        $url = $host.$url;
+
+        if (!empty($user) && !empty($password)) {
+            $url = sprintf('%s:%s@%s', $user, $password, $url);
+        }
+
+        return sprintf('%s://%s', $protocol, $url);
+    }
+
+    /**
+     * Adds protocol to given url, if the url does not contain given protocol.
+     * Returns the new url.
+     *
+     * @param string $url      Url string
+     * @param string $protocol (optional) Protocol string
+     *
+     * @return string
+     */
+    public static function addProtocolToUrl($url, $protocol = 'http')
+    {
+        $pattern = sprintf('/^%s.*/', $protocol);
+
+        if ((bool) preg_match($pattern, $url)) {
+            return $url;
+        }
+
+        return sprintf('%s://%s', $protocol, $url);
+    }
 }

src/Meritoo/Common/Utilities/Xml.php

@@ -13,10 +13,10 @@ use DOMXPath;
 use SimpleXMLElement;
 
 /**
- * Useful XML-related methods (only static functions)
+ * Useful XML-related methods (only static functions).
  *
- * @author    Meritoo <github@meritoo.pl>
- * @copyright Meritoo <http://www.meritoo.pl>
+ * @author     Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+ * @copyright  Meritoo.pl
  */
 class Xml
 {
@@ -26,6 +26,7 @@ class Xml
      *
      * @param SimpleXMLElement $element1 First element to merge
      * @param SimpleXMLElement $element2 Second element to merge
+     *
      * @return SimpleXMLElement
      */
     public static function mergeNodes(SimpleXMLElement $element1, SimpleXMLElement $element2)
@@ -40,7 +41,7 @@ class Xml
         $query = $path->query('/*/*');
         $nodesCount = $query->length;
 
-        if (0 === $nodesCount) {
+        if ($nodesCount == 0) {
             return $element1;
         }
 

src/Test/Base/BaseTestCase.php

@@ -1,23 +0,0 @@
-<?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 Meritoo\Common\Traits\Test\Base\BaseTestCaseTrait;
-use PHPUnit\Framework\TestCase;
-
-/**
- * Base test case with common methods and data providers
- *
- * @author    Meritoo <github@meritoo.pl>
- * @copyright Meritoo <http://www.meritoo.pl>
- */
-abstract class BaseTestCase extends TestCase
-{
-    use BaseTestCaseTrait;
-}

src/Test/Base/BaseTypeTestCase.php

@@ -1,22 +0,0 @@
-<?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 Meritoo\Common\Traits\Test\Base\BaseTypeTestCaseTrait;
-
-/**
- * Base test case for the type of something
- *
- * @author    Meritoo <github@meritoo.pl>
- * @copyright Meritoo <http://www.meritoo.pl>
- */
-abstract class BaseTypeTestCase extends BaseTestCase
-{
-    use BaseTypeTestCaseTrait;
-}

src/Traits/CssSelector/FormCssSelector.php

@@ -1,110 +0,0 @@
-<?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\Traits\CssSelector;
-
-/**
- * Useful methods related to CSS selectors of form
- *
- * @author    Meritoo <github@meritoo.pl>
- * @copyright Meritoo <http://www.meritoo.pl>
- */
-trait FormCssSelector
-{
-    /**
-     * Returns selector of field-set using index/position of the field-set
-     *
-     * @param string $formName      Name of form (value of the "name" attribute)
-     * @param int    $fieldSetIndex Index/Position of the field-set
-     * @return string
-     */
-    public static function getFieldSetByIndexSelector($formName, $fieldSetIndex)
-    {
-        $formSelector = static::getFormByNameSelector($formName);
-
-        if (empty($formSelector) || 0 > $fieldSetIndex) {
-            return '';
-        }
-
-        return sprintf('%s fieldset:nth-of-type(%d)', $formSelector, $fieldSetIndex);
-    }
-
-    /**
-     * Returns selector of form based on its name
-     *
-     * @param string $formName Name of form (value of the "name" attribute)
-     * @return string
-     */
-    public static function getFormByNameSelector($formName)
-    {
-        $formName = trim($formName);
-
-        if (empty($formName)) {
-            return '';
-        }
-
-        return sprintf('form[name="%s"]', $formName);
-    }
-
-    /**
-     * Returns selector of the input field based on its ID
-     *
-     * @param string $formName Name of form (value of the "name" attribute)
-     * @param string $fieldId  ID of field (value of the "id" attribute)
-     * @return string
-     */
-    public static function getInputByIdSelector($formName, $fieldId)
-    {
-        $formSelector = static::getFormByNameSelector($formName);
-        $fieldId = trim($fieldId);
-
-        if (empty($formSelector) || empty($fieldId)) {
-            return '';
-        }
-
-        return sprintf('%s input#%s', $formSelector, $fieldId);
-    }
-
-    /**
-     * Returns selector of the input field based on its name
-     *
-     * @param string $formName  Name of form (value of the "name" attribute)
-     * @param string $fieldName Name of field (value of the "name" attribute)
-     * @return string
-     */
-    public static function getInputByNameSelector($formName, $fieldName)
-    {
-        $formSelector = static::getFormByNameSelector($formName);
-        $fieldName = trim($fieldName);
-
-        if (empty($formSelector) || empty($fieldName)) {
-            return '';
-        }
-
-        return sprintf('%s input[name="%s"]', $formSelector, $fieldName);
-    }
-
-    /**
-     * Returns selector of label
-     *
-     * @param string $formName Name of form (value of the "name" attribute)
-     * @param string $fieldId  ID of field (value of the "id" attribute)
-     * @return string
-     */
-    public static function getLabelSelector($formName, $fieldId)
-    {
-        $formSelector = static::getFormByNameSelector($formName);
-        $fieldId = trim($fieldId);
-
-        if (empty($formSelector) || empty($fieldId)) {
-            return '';
-        }
-
-        return sprintf('%s label[for="%s"]', $formSelector, $fieldId);
-    }
-}

src/Traits/Test/Base/BaseTestCaseTrait.php

@@ -1,258 +0,0 @@
-<?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.
- */
-
-declare(strict_types=1);
-
-namespace Meritoo\Common\Traits\Test\Base;
-
-use DateTime;
-use Generator;
-use Meritoo\Common\Exception\Reflection\ClassWithoutConstructorException;
-use Meritoo\Common\Exception\Type\UnknownOopVisibilityTypeException;
-use Meritoo\Common\Type\OopVisibilityType;
-use Meritoo\Common\Utilities\Miscellaneous;
-use ReflectionClass;
-use ReflectionMethod;
-use RuntimeException;
-use stdClass;
-
-/**
- * Trait for the base test case
- *
- * @author    Meritoo <github@meritoo.pl>
- * @copyright Meritoo <http://www.meritoo.pl>
- */
-trait BaseTestCaseTrait
-{
-    /**
-     * Path of directory with data used by test cases
-     *
-     * @var string
-     */
-    private static $testsDataDirPath = 'data/tests';
-
-    /**
-     * Provides boolean value
-     *
-     * @return Generator
-     */
-    public function provideBooleanValue(): ?Generator
-    {
-        yield [false];
-        yield [true];
-    }
-
-    /**
-     * Provides instance of DateTime class
-     *
-     * @return Generator
-     */
-    public function provideDateTimeInstance(): ?Generator
-    {
-        yield [new DateTime()];
-        yield [new DateTime('yesterday')];
-        yield [new DateTime('now')];
-        yield [new DateTime('tomorrow')];
-    }
-
-    /**
-     * Provides relative / compound format of DateTime
-     *
-     * @return Generator
-     */
-    public function provideDateTimeRelativeFormat(): ?Generator
-    {
-        yield ['now'];
-        yield ['yesterday'];
-        yield ['tomorrow'];
-        yield ['back of 10'];
-        yield ['front of 10'];
-        yield ['last day of February'];
-        yield ['first day of next month'];
-        yield ['last day of previous month'];
-        yield ['last day of next month'];
-        yield ['Y-m-d'];
-        yield ['Y-m-d 10:00'];
-    }
-
-    /**
-     * Provides an empty scalar value
-     *
-     * @return Generator
-     */
-    public function provideEmptyScalarValue(): ?Generator
-    {
-        yield [''];
-        yield ['   '];
-        yield [null];
-        yield [0];
-        yield [false];
-    }
-
-    /**
-     * Provides an empty value
-     *
-     * @return Generator
-     */
-    public function provideEmptyValue(): ?Generator
-    {
-        yield [''];
-        yield ['   '];
-        yield [null];
-        yield [0];
-        yield [false];
-        yield [[]];
-    }
-
-    /**
-     * Provides non scalar value, e.g. [] or null
-     *
-     * @return Generator
-     */
-    public function provideNonScalarValue(): ?Generator
-    {
-        yield [[]];
-        yield [null];
-        yield [new stdClass()];
-    }
-
-    /**
-     * Provides path of not existing file, e.g. "lorem/ipsum.jpg"
-     *
-     * @return Generator
-     */
-    public function provideNotExistingFilePath(): ?Generator
-    {
-        yield ['lets-test.doc'];
-        yield ['lorem/ipsum.jpg'];
-        yield ['surprise/me/one/more/time.txt'];
-    }
-
-    /**
-     * Verifies visibility and arguments of class constructor
-     *
-     * @param string $className              Fully-qualified name 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
-     * @param int    $requiredArgumentsCount (optional) Expected count/amount of required arguments of the verified
-     *                                       method
-     * @throws ClassWithoutConstructorException
-     */
-    protected static function assertConstructorVisibilityAndArguments(
-        string $className,
-        string $visibilityType,
-        int $argumentsCount = 0,
-        int $requiredArgumentsCount = 0
-    ): void {
-        $reflection = new ReflectionClass($className);
-        $method = $reflection->getConstructor();
-
-        if (null === $method) {
-            throw ClassWithoutConstructorException::create($className);
-        }
-
-        static::assertMethodVisibility($method, $visibilityType);
-        static::assertMethodArgumentsCount($method, $argumentsCount, $requiredArgumentsCount);
-    }
-
-    /**
-     * Asserts that class with given namespace has no constructor
-     *
-     * @param string $className Fully-qualified name of class that contains constructor to verify
-     */
-    protected static function assertHasNoConstructor(string $className): void
-    {
-        $reflection = new ReflectionClass($className);
-        $constructor = $reflection->getConstructor();
-
-        static::assertNull($constructor);
-    }
-
-    /**
-     * Verifies count of method's arguments
-     *
-     * @param ReflectionMethod $method         Name of method or just the method to verify
-     * @param int              $argumentsCount (optional) Expected count/amount of arguments of the verified method
-     * @param int              $requiredCount  (optional) Expected count/amount of required arguments of the verified
-     *                                         method
-     * @throws RuntimeException
-     */
-    protected static function assertMethodArgumentsCount(
-        ReflectionMethod $method,
-        int $argumentsCount = 0,
-        int $requiredCount = 0
-    ): void {
-        static::assertSame($argumentsCount, $method->getNumberOfParameters());
-        static::assertSame($requiredCount, $method->getNumberOfRequiredParameters());
-    }
-
-    /**
-     * Verifies visibility of method
-     *
-     * @param ReflectionMethod $method                 Name of method or just the method to verify
-     * @param string           $visibilityType         Expected visibility of verified method. One of OopVisibilityType
-     *                                                 class constants.
-     * @throws UnknownOopVisibilityTypeException
-     * @throws RuntimeException
-     */
-    protected static function assertMethodVisibility(ReflectionMethod $method, string $visibilityType): void
-    {
-        // Type of visibility is not correct?
-        if (!OopVisibilityType::isCorrectType($visibilityType)) {
-            throw UnknownOopVisibilityTypeException::createException($visibilityType);
-        }
-
-        switch ($visibilityType) {
-            case OopVisibilityType::IS_PUBLIC:
-                static::assertTrue($method->isPublic());
-
-                break;
-            case OopVisibilityType::IS_PROTECTED:
-                static::assertTrue($method->isProtected());
-
-                break;
-            case OopVisibilityType::IS_PRIVATE:
-                static::assertTrue($method->isPrivate());
-
-                break;
-        }
-    }
-
-    /**
-     * Returns path of file used by tests.
-     * 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
-     */
-    protected function getFilePathForTesting(string $fileName, string $directoryPath = ''): string
-    {
-        $rootPath = Miscellaneous::getProjectRootPath();
-
-        $paths = [
-            $rootPath,
-            self::$testsDataDirPath,
-            $directoryPath,
-            $fileName,
-        ];
-
-        return Miscellaneous::concatenatePaths($paths);
-    }
-
-    /**
-     * 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(string $testsDataDirPath): void
-    {
-        static::$testsDataDirPath = $testsDataDirPath;
-    }
-}

src/Traits/Test/Base/BaseTypeTestCaseTrait.php

@@ -1,68 +0,0 @@
-<?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.
- */
-
-declare(strict_types=1);
-
-namespace Meritoo\Common\Traits\Test\Base;
-
-use Generator;
-use Meritoo\Common\Type\Base\BaseType;
-
-/**
- * Trait for the base test case for the type of something
- *
- * @author    Meritoo <github@meritoo.pl>
- * @copyright Meritoo <http://www.meritoo.pl>
- */
-trait BaseTypeTestCaseTrait
-{
-    /**
-     * Provides type to verify and information if it's correct
-     *
-     * @return Generator
-     */
-    abstract public function provideTypeToVerify(): Generator;
-
-    /**
-     * Verifies availability of all types
-     */
-    public function testAvailabilityOfAllTypes(): void
-    {
-        $available = $this->getTestedTypeInstance()->getAll();
-        $all = $this->getAllExpectedTypes();
-
-        static::assertEquals($all, $available);
-    }
-
-    /**
-     * Verifies whether given type is correct or not
-     *
-     * @param bool $isCorrect Information if processed type is correct
-     * @param bool $expected  Expected information if processed type is correct
-     *
-     * @dataProvider provideTypeToVerify
-     */
-    public function testIfGivenTypeIsCorrect(bool $isCorrect, bool $expected): void
-    {
-        static::assertEquals($expected, $isCorrect);
-    }
-
-    /**
-     * Returns all expected types of the tested type
-     *
-     * @return array
-     */
-    abstract protected function getAllExpectedTypes(): array;
-
-    /**
-     * Returns instance of the tested type
-     *
-     * @return BaseType
-     */
-    abstract protected function getTestedTypeInstance(): BaseType;
-}

src/Traits/ValueObject/HumanTrait.php

@@ -1,144 +0,0 @@
-<?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.
- */
-
-declare(strict_types=1);
-
-namespace Meritoo\Common\Traits\ValueObject;
-
-use DateTime;
-
-/**
- * Methods and properties related to human
- *
- * @author    Meritoo <github@meritoo.pl>
- * @copyright Meritoo <http://www.meritoo.pl>
- */
-trait HumanTrait
-{
-    /**
-     * First name
-     *
-     * @var string
-     */
-    protected $firstName;
-
-    /**
-     * Last name
-     *
-     * @var string
-     */
-    protected $lastName;
-
-    /**
-     * Email address
-     *
-     * @var null|string
-     */
-    protected $email;
-
-    /**
-     * Birth date
-     *
-     * @var null|DateTime
-     */
-    protected $birthDate;
-
-    /**
-     * Class constructor
-     *
-     * @param string        $firstName First name
-     * @param string        $lastName  Last name
-     * @param null|string   $email     (optional) Email address. Default: null.
-     * @param null|DateTime $birthDate (optional) Birth date. Default: null.
-     */
-    public function __construct(string $firstName, string $lastName, ?string $email = null, ?DateTime $birthDate = null)
-    {
-        $this->firstName = $firstName;
-        $this->lastName = $lastName;
-        $this->email = $email;
-        $this->birthDate = $birthDate;
-    }
-
-    /**
-     * Returns representation of object as string
-     *
-     * @return string
-     */
-    public function __toString()
-    {
-        $template = '%s';
-        $email = '';
-
-        if ('' !== $this->email && null !== $this->email) {
-            $template .= ' <%s>';
-            $email = $this->email;
-        }
-
-        return sprintf($template, $this->getFullName(), $email);
-    }
-
-    /**
-     * Returns birth date
-     *
-     * @return null|DateTime
-     */
-    public function getBirthDate(): ?DateTime
-    {
-        return $this->birthDate;
-    }
-
-    /**
-     * Returns email address
-     *
-     * @return null|string
-     */
-    public function getEmail(): ?string
-    {
-        return $this->email;
-    }
-
-    /**
-     * Returns first name
-     *
-     * @return string
-     */
-    public function getFirstName(): string
-    {
-        return $this->firstName;
-    }
-
-    /**
-     * Returns the full name
-     *
-     * @param bool $firstNameFirst (optional) If is set to true, first name is the first part (default behaviour).
-     *                             Otherwise - name.
-     * @return string
-     */
-    public function getFullName(bool $firstNameFirst = true): string
-    {
-        $beginning = $this->lastName;
-        $finish = $this->firstName;
-
-        if ($firstNameFirst) {
-            $beginning = $this->firstName;
-            $finish = $this->lastName;
-        }
-
-        return trim(sprintf('%s %s', $beginning, $finish));
-    }
-
-    /**
-     * Returns last name
-     *
-     * @return string
-     */
-    public function getLastName(): string
-    {
-        return $this->lastName;
-    }
-}

src/Type/DatePeriod.php

@@ -1,184 +0,0 @@
-<?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\Type;
-
-use DateTime;
-use Meritoo\Common\Type\Base\BaseType;
-use Meritoo\Common\Utilities\Date;
-
-/**
- * A date's period.
- * Contains start and end date of the period.
- *
- * @author    Meritoo <github@meritoo.pl>
- * @copyright Meritoo <http://www.meritoo.pl>
- */
-class DatePeriod extends BaseType
-{
-    /**
-     * The period constant: last month
-     *
-     * @var string
-     */
-    public const LAST_MONTH = '4';
-
-    /**
-     * The period constant: last week
-     *
-     * @var string
-     */
-    public const LAST_WEEK = '1';
-
-    /**
-     * The period constant: last year
-     *
-     * @var string
-     */
-    public const LAST_YEAR = '7';
-
-    /**
-     * The period constant: next month
-     *
-     * @var string
-     */
-    public const NEXT_MONTH = '6';
-
-    /**
-     * The period constant: next week
-     *
-     * @var string
-     */
-    public const NEXT_WEEK = '3';
-
-    /**
-     * The period constant: next year
-     *
-     * @var string
-     */
-    public const NEXT_YEAR = '9';
-
-    /**
-     * The period constant: this month
-     *
-     * @var string
-     */
-    public const THIS_MONTH = '5';
-
-    /**
-     * The period constant: this week
-     *
-     * @var string
-     */
-    public const THIS_WEEK = '2';
-
-    /**
-     * The period constant: this year
-     *
-     * @var string
-     */
-    public const THIS_YEAR = '8';
-
-    /**
-     * The start date of period
-     *
-     * @var null|DateTime
-     */
-    private $startDate;
-
-    /**
-     * The end date of period
-     *
-     * @var null|DateTime
-     */
-    private $endDate;
-
-    /**
-     * Class constructor
-     *
-     * @param null|DateTime $startDate (optional) The start date of period
-     * @param null|DateTime $endDate   (optional) The end date of period
-     */
-    public function __construct(?DateTime $startDate = null, ?DateTime $endDate = null)
-    {
-        $this->startDate = $startDate;
-        $this->endDate = $endDate;
-    }
-
-    /**
-     * Returns the end date of period
-     *
-     * @return null|DateTime
-     */
-    public function getEndDate(): ?DateTime
-    {
-        return $this->endDate;
-    }
-
-    /**
-     * Sets the end date of period
-     *
-     * @param null|DateTime $endDate (optional) The end date of period. Default: null.
-     * @return $this
-     */
-    public function setEndDate(?DateTime $endDate = null): self
-    {
-        $this->endDate = $endDate;
-
-        return $this;
-    }
-
-    /**
-     * Returns formatted one of the period's date: start date or end date
-     *
-     * @param string $format    Format used to format the date
-     * @param bool   $startDate (optional) If is set to true, start date will be formatted (default behaviour).
-     *                          Otherwise - end date.
-     * @return string
-     */
-    public function getFormattedDate(string $format, bool $startDate = true): string
-    {
-        $date = $this->getEndDate();
-
-        // Start date should be formatted?
-        if ($startDate) {
-            $date = $this->getStartDate();
-        }
-
-        // Unknown date or format is invalid?
-        // Nothing to do
-        if (null === $date || !Date::isValidDateFormat($format)) {
-            return '';
-        }
-
-        return $date->format($format);
-    }
-
-    /**
-     * Returns the start date of period
-     *
-     * @return null|DateTime
-     */
-    public function getStartDate(): ?DateTime
-    {
-        return $this->startDate;
-    }
-
-    /**
-     * Sets the start date of period
-     *
-     * @param null|DateTime $startDate (optional) The start date of period. Default: null.
-     * @return $this
-     */
-    public function setStartDate(?DateTime $startDate = null): self
-    {
-        $this->startDate = $startDate;
-
-        return $this;
-    }
-}