Prepare first release (#3)

* Bump version alias in composer.json

* Remove unnecessary folder

* Add PHP v7.3 to travis CI

* Update CHANGELOG

* Update phpunit to v7.5

* Update README

* Remove useless comments

* Add clarification to getIterator phpdoc

Author: slavcodev

.travis.yml

@@ -7,6 +7,7 @@ language: php
 php:
   - 7.1
   - 7.2
+  - 7.3
 
 ## Cache composer
 cache:
@@ -23,11 +24,12 @@ matrix:
   fast_finish: true
   include:
     - php: 7.1
+    - php: 7.2
       env:
         - EXECUTE_COVERAGE=true
-    - php: 7.2
+    - php: 7.3
   allow_failures:
-    - php: 7.2
+    - php: 7.3
 
 notifications:
   email: false
@@ -46,4 +48,4 @@ script:
   - if [[ $EXECUTE_COVERAGE != 'true' ]]; then ./vendor/bin/phpunit ; fi
 
 after_script:
-  - if [[ $EXECUTE_COVERAGE == 'true' ]]; then ./vendor/bin/ocular code-coverage:upload --format=php-clover $CLOVER_PATH ; fi
+  - if [[ $EXECUTE_COVERAGE == 'true' ]]; then ./vendor/bin/ocular code-coverage:upload --format=clover $CLOVER_PATH ; fi

CHANGELOG.md

@@ -18,6 +18,6 @@ Security - in case of vulnerabilities.
 
 _TBD_
 
-## [0.1.0] 2018-05-26
+## [1.0.0] 2019-01-10
 
 Initial release.

README.md

@@ -1,15 +1,14 @@
 # Errors Notification
 An easy to use, implementation of the [Notification Pattern][notification-pattern]
 
-[![Software License][ico-license]][link-license]
-[![Latest Version on Packagist][ico-version]][link-packagist]
 [![Build Status][ico-travis]][link-travis]
-[![Coverage Status][ico-scrutinizer]][link-scrutinizer]
+[![Code Coverage][ico-scrutinizer]][link-scrutinizer]
 [![Quality Score][ico-code-quality]][link-code-quality]
+[![GitHub issues][ico-issues]][link-issues]
 
-*TBD*
-
-## TL;DR
+[![Software License][ico-license]][link-license]
+[![Latest Version on Packagist][ico-version]][link-packagist]
+[![PHP Version][ico-php-version]][link-github]
 
 ## Install
 
@@ -19,39 +18,34 @@ Using [Composer](https://getcomposer.org)
 composer require zeeproject/errors-notification
 ~~~
 
+## TL;DR
+
+*TBD*
+
 ## Testing
 
 ~~~bash
-# install required files
-composer self-update
-composer install
-
-# run the test (from project root)
 phpunit
 ~~~
 
 ## Contributing
 
-Contributions are welcome and will be fully credited. Please see [CONTRIBUTING](CONTRIBUTING.md) and [CODE OF CONDUCT](CODE_OF_CONDUCT.md) for details.
-
-## Credits
-
-[To All Awesome Contributors](../../contributors)
-
-## License
-
-The BSD 2-Clause License. Please see [LICENSE][link-license] for more information.
+Please see [CONTRIBUTING](CONTRIBUTING.md) and [CODE OF CONDUCT](CODE_OF_CONDUCT.md) for more details.
 
 [notification-pattern]: https://martinfowler.com/eaaDev/Notification.html
 
-[ico-license]: https://img.shields.io/badge/License-BSD%202--Clause-blue.svg?style=flat-square
-[ico-version]: https://img.shields.io/packagist/v/zeeproject/errors-notification.svg?style=flat-square
-[ico-travis]: https://img.shields.io/travis/zee/errors-notification/master.svg?style=flat-square
-[ico-scrutinizer]: https://img.shields.io/scrutinizer/coverage/g/zee/errors-notification.svg?style=flat-square
-[ico-code-quality]: https://img.shields.io/scrutinizer/g/zee/errors-notification.svg?style=flat-square
+[ico-version]: https://img.shields.io/packagist/v/zeeproject/errors-notification.svg?style=for-the-badge&label=Latest
+[ico-php-version]: https://img.shields.io/packagist/php-v/zeeproject/errors-notification.svg?style=for-the-badge
+[ico-license]: https://img.shields.io/badge/License-BSD%202--Clause-blue.svg?style=for-the-badge
+[ico-issues]: https://img.shields.io/github/issues/zee/errors-notification.svg?style=for-the-badge&logo=github
+[ico-travis]: https://img.shields.io/travis/zee/errors-notification.svg?style=for-the-badge&logo=travis
+[ico-scrutinizer]: https://img.shields.io/scrutinizer/coverage/g/zee/errors-notification.svg?style=for-the-badge&logo=scrutinizer
+[ico-code-quality]: https://img.shields.io/scrutinizer/g/zee/errors-notification.svg?style=for-the-badge&logo=scrutinizer
 
-[link-license]: LICENSE
 [link-packagist]: https://packagist.org/packages/zeeproject/errors-notification
+[link-github]: https://github.com/zee/errors-notification
+[link-issues]: https://github.com/zee/errors-notification/issues
+[link-license]: LICENSE
 [link-travis]: https://travis-ci.org/zee/errors-notification
 [link-scrutinizer]: https://scrutinizer-ci.com/g/zee/errors-notification/code-structure
 [link-code-quality]: https://scrutinizer-ci.com/g/zee/errors-notification

build/.gitignore

@@ -13,7 +13,7 @@
     "php": "^7.1"
   },
   "require-dev": {
-    "phpunit/phpunit": "^7.1",
+    "phpunit/phpunit": "^7.5",
     "scrutinizer/ocular": "^1.5"
   },
   "autoload": {
@@ -37,7 +37,7 @@
   },
   "extra": {
     "branch-alias": {
-      "dev-master": "1.0.x-dev"
+      "dev-master": "1.1.x-dev"
     }
   }
 }

composer.json

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/7.1/phpunit.xsd"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/7.5/phpunit.xsd"
          bootstrap="vendor/autoload.php"
          colors="true"
          failOnRisky="true"

phpunit.xml.dist

@@ -1,58 +1,34 @@
 <?php
 /**
- * This file is part of Zee Project.
- *
- * @see https://github.com/zee/
+ * {@see https://github.com/zee/ Zee Project (c)}
  */
 
 declare(strict_types=1);
 
 namespace Zee\Errors;
 
-/**
- * Class Error.
- */
 final class Error
 {
-    /**
-     * @var string
-     */
     private $message;
 
-    /**
-     * @var array
-     */
     private $context;
 
-    /**
-     * @param string $message
-     * @param array $context
-     */
-    public function __construct(string $message, array $context)
+    public function __construct(string $message, array $context = [])
     {
         $this->message = $message;
         $this->context = $context;
     }
 
-    /**
-     * @inheritdoc
-     */
     public function __toString(): string
     {
         return $this->getMessage();
     }
 
-    /**
-     * @return string
-     */
     public function getMessage(): string
     {
         return $this->message;
     }
 
-    /**
-     * @return array
-     */
     public function getContext(): array
     {
         return $this->context;

src/Error.php

@@ -1,8 +1,6 @@
 <?php
 /**
- * This file is part of Zee Project.
- *
- * @see https://github.com/zee/
+ * {@see https://github.com/zee/ Zee Project (c)}
  */
 
 declare(strict_types=1);
@@ -14,18 +12,12 @@
 use IteratorAggregate;
 use Traversable;
 
-/**
- * Class Notification.
- */
 final class Notification implements Countable, IteratorAggregate
 {
     private $errors = [];
 
     /**
      * Adds new error to the notification.
-     *
-     * @param string $message
-     * @param array $context
      */
     public function addError(string $message, array $context = []): void
     {
@@ -34,8 +26,6 @@ public function addError(string $message, array $context = []): void
 
     /**
      * Returns whether the notification has any errors.
-     *
-     * @return bool
      */
     public function hasErrors(): bool
     {
@@ -54,7 +44,7 @@ public function flushErrors(): array
     }
 
     /**
-     * @return array
+     * Returns list of error messages only.
      */
     public function getErrorMessages(): array
     {
@@ -67,9 +57,7 @@ function (Error $error) {
     }
 
     /**
-     * Counts the errors.
-     *
-     * @inheritdoc
+     * Counts the errors in the notification.
      */
     public function count(): int
     {
@@ -79,8 +67,6 @@ public function count(): int
     /**
      * Builds the iterator by errors.
      *
-     * @inheritdoc
-     *
      * @return Traversable|Error[]
      */
     public function getIterator(): Traversable

src/Notification.php

@@ -1,8 +1,6 @@
 <?php
 /**
- * This file is part of Zee Project.
- *
- * @see https://github.com/zee/
+ * {@see https://github.com/zee/ Zee Project (c)}
  */
 
 declare(strict_types=1);
@@ -11,15 +9,10 @@
 
 use Zee\Errors\Error;
 
-/**
- * Class ErrorTest.
- */
 final class ErrorTest extends TestCase
 {
     /**
      * @test
-     *
-     * @return Error
      */
     public function errorContainsMessageAndItsContextData(): Error
     {
@@ -34,10 +27,8 @@ public function errorContainsMessageAndItsContextData(): Error
     /**
      * @test
      * @depends errorContainsMessageAndItsContextData
-     *
-     * @param Error $error
      */
-    public function canBeCastedToString(Error $error)
+    public function canBeCastedToString(Error $error): void
     {
         self::assertSame('Something went wrong', (string) $error);
     }

tests/ErrorTest.php

@@ -1,8 +1,6 @@
 <?php
 /**
- * This file is part of Zee Project.
- *
- * @see https://github.com/zee/
+ * {@see https://github.com/zee/ Zee Project (c)}
  */
 
 declare(strict_types=1);
@@ -12,15 +10,10 @@
 use Zee\Errors\Error;
 use Zee\Errors\Notification;
 
-/**
- * Class NotificationTest.
- */
 final class NotificationTest extends TestCase
 {
     /**
      * @test
-     *
-     * @return Notification
      */
     public function canAddMultipleErrorsAndCountThem(): Notification
     {
@@ -37,8 +30,6 @@ public function canAddMultipleErrorsAndCountThem(): Notification
     /**
      * @test
      * @depends canAddMultipleErrorsAndCountThem
-     *
-     * @param Notification $notification
      */
     public function canIterateErrors(Notification $notification): void
     {
@@ -50,8 +41,6 @@ public function canIterateErrors(Notification $notification): void
     /**
      * @test
      * @depends canAddMultipleErrorsAndCountThem
-     *
-     * @param Notification $notification
      */
     public function canGenerateListOfErrorMessages(Notification $notification): void
     {
@@ -61,8 +50,6 @@ public function canGenerateListOfErrorMessages(Notification $notification): void
     /**
      * @test
      * @depends canAddMultipleErrorsAndCountThem
-     *
-     * @param Notification $notification
      */
     public function canClearNotificationErrors(Notification $notification): void
     {