update immutability dependency

juliangut · juliangut · commit dcc292088bf2 · 2019-09-22T17:08:37.000+02:00
diff --git a/.scrutinizer.yml b/.scrutinizer.yml
@@ -1,13 +1,24 @@
 # language: php
 
+build:
+  dependencies:
+    before:
+      - 'composer self-update'
+      - 'composer update --prefer-stable --prefer-source --no-interaction --no-progress --no-suggest'
+  cache:
+    directories:
+      - vendor/
+  nodes:
+    analysis:
+      project_setup:
+        override: true
+      tests:
+        override: [php-scrutinizer-run]
+
 filter:
   paths: [src/*]
   excluded_paths: [tests/*, vendor/*]
 
-before_commands:
-  - 'composer self-update'
-  - 'composer update --prefer-stable --prefer-source --no-interaction --no-scripts --no-progress --no-suggest'
-
 coding_style:
   php:
     upper_lower_casing:
@@ -17,8 +28,8 @@ coding_style:
         true_false_null: lower
     spaces:
       around_operators:
-          concatenation: true
-          negation: false
+        concatenation: true
+        negation: false
       other:
         after_type_cast: true
 
@@ -34,7 +45,6 @@ tools:
     enabled: true
     config:
       ruleset: 'unusedcode,naming,design,controversial,codesize'
-
   php_cpd: true
   php_loc: true
   php_pdepend: true
diff --git a/.travis.yml b/.travis.yml
@@ -13,7 +13,9 @@ env:
   - COMPOSER_FLAGS="--prefer-stable --prefer-dist"
 
 php:
+  - 7.2
   - 7.3
+  - 7.4snapshot
   - nightly
 
 matrix:
@@ -22,25 +24,25 @@ matrix:
     - php: 7.1
       env:
         - COMPOSER_FLAGS="--prefer-lowest --prefer-stable --prefer-dist"
-    - php: 7.2
+    - php: 7.1
       env:
         - TEST_VERSION=true
         - COMPOSER_FLAGS="--prefer-stable --prefer-dist"
   allow_failures:
     - php: nightly
 
 before_install:
- - if [[ -z $TEST_VERSION && -f "/home/travis/.phpenv/versions/$(phpenv version-name)/etc/conf.d/xdebug.ini" ]]; then phpenv config-rm xdebug.ini; fi
- - composer global require hirak/prestissimo
- - composer self-update --stable --no-progress
+  - if [[ -z $TEST_VERSION && -f "/home/travis/.phpenv/versions/$(phpenv version-name)/etc/conf.d/xdebug.ini" ]]; then phpenv config-rm xdebug.ini; fi
+  - composer global require hirak/prestissimo
+  - composer self-update --stable --no-progress
 
 install:
- - travis_retry composer update $COMPOSER_FLAGS --no-interaction --no-scripts --no-progress
- - if [[ $TEST_VERSION ]]; then travis_retry composer require php-coveralls/php-coveralls $COMPOSER_FLAGS --no-interaction --no-scripts --no-progress ; fi
+  - travis_retry composer update $COMPOSER_FLAGS --no-interaction --no-progress
+  - if [[ $TEST_VERSION ]]; then travis_retry composer require php-coveralls/php-coveralls $COMPOSER_FLAGS --no-interaction --no-scripts --no-progress ; fi
 
 script:
- - if [[ $TEST_VERSION ]]; then composer qa && composer report-phpunit-clover ; fi
- - if [[ -z $TEST_VERSION ]]; then composer test-phpunit ; fi
+  - if [[ $TEST_VERSION ]]; then composer qa && composer report-phpunit-clover ; fi
+  - if [[ -z $TEST_VERSION ]]; then composer test-phpunit ; fi
 
 after_script:
- - if [[ $TEST_VERSION ]]; then travis_retry php vendor/bin/php-coveralls --verbose ; fi
+  - if [[ $TEST_VERSION ]]; then travis_retry php vendor/bin/php-coveralls --verbose ; fi
diff --git a/README.md b/README.md
@@ -14,7 +14,7 @@
 
 Event base classes and handling interfaces
 
-This package only provides the building blocks to Event
+This package only provides the building blocks to events
 
 ## Installation
 
@@ -34,9 +34,9 @@ require './vendor/autoload.php';
 
 ### Events
 
-Events are DTOs that carry all the information for an action to happen
+Events are DTOs that carry all the information of an already happened situation
 
-You can create your own by implementing `Gears\Event\Event` or extending from `Gears\Event\AbstractEvent` which ensures event immutability and payload and metadata is composed only of **scalar values** which is a very interesting capability. AbstractEvent has a private constructor forcing you to create events using the _occurred_ static method
+You can create your own by implementing `Gears\Event\Event` or extending from `Gears\Event\AbstractEvent` which ensures event immutability and payload and metadata is composed only of **scalar values** which is a very interesting capability. AbstractEvent has a private constructor forcing you to create events using _occurred_ static method on your named constructors
 
 ```php
 use Gears\Event\AbstractEvent;
@@ -48,7 +48,7 @@ class CreateUserEvent extends AbstractEvent
         string lastname,
         \DateTimeImmutable $birthDate
     ): self {
-        return new occurred([
+        return static::occurred([
             'name' => $name,
             'lastname' => $lastname,
             'birthDate' => $birthDate->format('U'),
@@ -72,7 +72,7 @@ class CreateUserEvent extends AbstractEmptyEvent
 
 ### Collection
 
-Events can be grouped into iterables implementing `Gears\Event\EventCollection` objects, `Gears\Event\EventArrayCollection` is provided accepting only instances of `Gears\Event\Event`
+Events can be grouped into iterables implementing `Gears\Event\EventCollection` objects, `Gears\Event\EventArrayCollection` and `Gears\Event\EventIteratorCollection` are provided accepting only instances of `Gears\Event\Event`
 
 #### Async events
 
diff --git a/composer.json b/composer.json
@@ -24,22 +24,23 @@
   "require": {
     "php": "^7.1",
     "myclabs/deep-copy": "^1.8",
-    "phpgears/dto": "~0.2"
+    "phpgears/dto": "~0.3"
   },
   "require-dev": {
     "brainmaestro/composer-git-hooks": "^2.1",
     "friendsofphp/php-cs-fixer": "^2.0",
     "infection/infection": "^0.9",
     "phpmd/phpmd": "^2.0",
-    "phpstan/phpstan": "^0.10",
-    "phpstan/phpstan-deprecation-rules": "^0.10",
-    "phpstan/phpstan-strict-rules": "^0.10",
-    "phpunit/phpunit": "^6.0|^7.0",
+    "phpstan/extension-installer": "^1.0",
+    "phpstan/phpstan": "~0.11.12",
+    "phpstan/phpstan-deprecation-rules": "~0.11.2",
+    "phpstan/phpstan-strict-rules": "~0.11.1",
+    "phpunit/phpunit": "^7.0|^8.0",
     "povils/phpmnd": "^2.0",
     "roave/security-advisories": "dev-master",
-    "sebastian/phpcpd": "^3.0|^4.0",
-    "squizlabs/php_codesniffer": "^2.0",
-    "thecodingmachine/phpstan-strict-rules": "^0.10.1"
+    "sebastian/phpcpd": "^4.0",
+    "squizlabs/php_codesniffer": "^3.0",
+    "thecodingmachine/phpstan-strict-rules": "^0.10.2"
   },
   "suggest": {
   },
diff --git a/phpstan.neon b/phpstan.neon
@@ -1,8 +1,3 @@
-includes:
-  - vendor/phpstan/phpstan-strict-rules/rules.neon
-  - vendor/phpstan/phpstan-deprecation-rules/rules.neon
-  - vendor/thecodingmachine/phpstan-strict-rules/phpstan-strict-rules.neon
-
 parameters:
   level: max
   paths:
diff --git a/src/AbstractEmptyEvent.php b/src/AbstractEmptyEvent.php
@@ -31,7 +31,7 @@ abstract class AbstractEmptyEvent implements Event
      */
     private function __construct(array $metadata, \DateTimeImmutable $createdAt)
     {
-        $this->checkImmutability();
+        $this->assertImmutable();
 
         $this->setMetadata($metadata);
         $this->createdAt = $createdAt->setTimezone(new \DateTimeZone('UTC'));
diff --git a/src/AbstractEvent.php b/src/AbstractEvent.php
@@ -32,7 +32,7 @@ abstract class AbstractEvent implements Event
      */
     private function __construct(array $payload, array $metadata, \DateTimeImmutable $createdAt)
     {
-        $this->checkImmutability();
+        $this->assertImmutable();
 
         $this->setPayload($payload);
         $this->setMetadata($metadata);
diff --git a/src/AbstractEventHandler.php b/src/AbstractEventHandler.php
@@ -26,7 +26,7 @@ final public function handle(Event $event): void
     {
         if (!$this->isEventSupported($event)) {
             throw new InvalidEventException(\sprintf(
-                'Event must be a %s, %s given',
+                'Event must be a "%s", "%s" given',
                 \implode('or ', $this->getSupportedEventTypes()),
                 \get_class($event)
             ));
diff --git a/src/EventArrayCollection.php b/src/EventArrayCollection.php
@@ -34,7 +34,7 @@ public function __construct(array $events)
         foreach ($events as $event) {
             if (!$event instanceof Event) {
                 throw new InvalidEventException(\sprintf(
-                    'Event collection only accepts %s, %s given',
+                    'Event collection only accepts "%s", "%s" given',
                     Event::class,
                     \is_object($event) ? \get_class($event) : \gettype($event)
                 ));
diff --git a/src/EventBehaviour.php b/src/EventBehaviour.php
@@ -83,7 +83,7 @@ private function setMetadata(array $parameters): void
             } catch (InvalidScalarParameterException $exception) {
                 throw new InvalidScalarParameterException(
                     \sprintf(
-                        'Class %s can only accept scalar metadata parameters, %s given',
+                        'Class "%s" can only accept scalar metadata parameters, "%s" given',
                         self::class,
                         \is_object($value) ? \get_class($value) : \gettype($value)
                     ),
diff --git a/src/EventIteratorCollection.php b/src/EventIteratorCollection.php
@@ -43,7 +43,7 @@ public function current(): Event
 
         if (!$event instanceof Event) {
             throw new InvalidEventException(\sprintf(
-                'Event collection only accepts %s, %s given',
+                'Event collection only accepts "%s", "%s" given',
                 Event::class,
                 \is_object($event) ? \get_class($event) : \gettype($event)
             ));
diff --git a/tests/Event/AbstractEmptyEventTest.php b/tests/Event/AbstractEmptyEventTest.php
@@ -25,7 +25,7 @@ public function testCreation(): void
     {
         $event = AbstractEmptyEventStub::instance();
 
-        $this->assertEquals([], $event->getPayload());
+        static::assertEquals([], $event->getPayload());
     }
 
     public function testReconstitute(): void
@@ -41,7 +41,7 @@ public function testReconstitute(): void
             ]
         );
 
-        $this->assertEquals($metadata, $event->getMetadata());
-        $this->assertEquals($createdAt, $event->getCreatedAt());
+        static::assertEquals($metadata, $event->getMetadata());
+        static::assertEquals($createdAt, $event->getCreatedAt());
     }
 }
diff --git a/tests/Event/AbstractEventHandlerTest.php b/tests/Event/AbstractEventHandlerTest.php
@@ -13,6 +13,7 @@
 
 namespace Gears\Event\Tests;
 
+use Gears\Event\Exception\InvalidEventException;
 use Gears\Event\Tests\Stub\AbstractEmptyEventStub;
 use Gears\Event\Tests\Stub\AbstractEventHandlerStub;
 use Gears\Event\Tests\Stub\AbstractEventStub;
@@ -23,12 +24,11 @@
  */
 class AbstractEventHandlerTest extends TestCase
 {
-    /**
-     * @expectedException \Gears\Event\Exception\InvalidEventException
-     * @expectedExceptionMessageRegExp /Event must be a .+\\AbstractEventStub, .+ given/
-     */
     public function testInvalidEventType(): void
     {
+        $this->expectException(InvalidEventException::class);
+        $this->expectExceptionMessageRegExp('/^Event must be a ".+\\\AbstractEventStub", ".+" given$/');
+
         $handler = new AbstractEventHandlerStub();
         $handler->handle(AbstractEmptyEventStub::instance());
     }
@@ -38,6 +38,6 @@ public function testHandling(): void
         $handler = new AbstractEventHandlerStub();
         $handler->handle(AbstractEventStub::instance([]));
 
-        $this->assertTrue(true);
+        static::assertTrue(true);
     }
 }
diff --git a/tests/Event/AbstractEventTest.php b/tests/Event/AbstractEventTest.php
@@ -26,8 +26,8 @@ public function testCreation(): void
         $payload = ['Parameter' => 'value'];
         $event = AbstractEventStub::instance($payload);
 
-        $this->assertEquals($payload, $event->getPayload());
-        $this->assertEquals($payload['Parameter'], $event->get('Parameter'));
+        static::assertEquals($payload, $event->getPayload());
+        static::assertEquals($payload['Parameter'], $event->get('Parameter'));
     }
 
     public function testReconstitute(): void
@@ -43,7 +43,7 @@ public function testReconstitute(): void
             ]
         );
 
-        $this->assertEquals($metadata, $event->getMetadata());
-        $this->assertEquals($createdAt, $event->getCreatedAt());
+        static::assertEquals($metadata, $event->getMetadata());
+        static::assertEquals($createdAt, $event->getCreatedAt());
     }
 }
diff --git a/tests/Event/EventArrayCollectionTest.php b/tests/Event/EventArrayCollectionTest.php
@@ -15,6 +15,7 @@
 
 use Gears\Event\Event;
 use Gears\Event\EventArrayCollection;
+use Gears\Event\Exception\InvalidEventException;
 use Gears\Event\Tests\Stub\AbstractEmptyEventStub;
 use PHPUnit\Framework\TestCase;
 
@@ -23,12 +24,11 @@
  */
 class EventArrayCollectionTest extends TestCase
 {
-    /**
-     * @expectedException \Gears\Event\Exception\InvalidEventException
-     * @expectedExceptionMessageRegExp /Event collection only accepts .+, string given/
-     */
     public function testInvalidTypeCollection(): void
     {
+        $this->expectException(InvalidEventException::class);
+        $this->expectExceptionMessageRegExp('/^Event collection only accepts ".+", "string" given$/');
+
         new EventArrayCollection(['event']);
     }
 
@@ -40,12 +40,12 @@ public function testCollection(): void
         ];
         $collection = new EventArrayCollection($events);
 
-        $this->assertCount(2, $collection);
+        static::assertCount(2, $collection);
 
         foreach ($collection as $event) {
-            $this->assertInstanceOf(Event::class, $event);
+            static::assertInstanceOf(Event::class, $event);
         }
 
-        $this->assertNull($collection->key());
+        static::assertNull($collection->key());
     }
 }
diff --git a/tests/Event/EventBehaviourTest.php b/tests/Event/EventBehaviourTest.php
@@ -13,6 +13,7 @@
 
 namespace Gears\Event\Tests;
 
+use Gears\DTO\Exception\InvalidScalarParameterException;
 use Gears\Event\Tests\Stub\EventBehaviourStub;
 use PHPUnit\Framework\TestCase;
 
@@ -21,12 +22,13 @@
  */
 class EventBehaviourTest extends TestCase
 {
-    /**
-     * @expectedException \Gears\DTO\Exception\InvalidScalarParameterException
-     * @expectedExceptionMessageRegExp /^Class .+ can only accept scalar metadata parameters, stdClass given$/
-     */
     public function testInvalidMetadata(): void
     {
+        $this->expectException(InvalidScalarParameterException::class);
+        $this->expectExceptionMessageRegExp(
+            '/^Class ".+" can only accept scalar metadata parameters, "stdClass" given$/'
+        );
+
         new EventBehaviourStub(['file' => new \stdClass()]);
     }
 
@@ -40,20 +42,20 @@ public function testMetadata(): void
         $createdAt = new \DateTimeImmutable('now');
         $stub = new EventBehaviourStub($metadata, $createdAt);
 
-        $this->assertEquals($metadata, $stub->getMetadata());
-        $this->assertEquals($createdAt, $stub->getCreatedAt());
+        static::assertEquals($metadata, $stub->getMetadata());
+        static::assertEquals($createdAt, $stub->getCreatedAt());
     }
 
     public function testMetadataSet(): void
     {
         $metadata = ['userId' => '123456'];
         $stub = new EventBehaviourStub([]);
 
-        $this->assertEmpty($stub->getMetadata());
+        static::assertEmpty($stub->getMetadata());
 
         $newStub = $stub->withMetadata($metadata);
 
-        $this->assertNotSame($stub, $newStub);
-        $this->assertEquals($metadata, $newStub->getMetadata());
+        static::assertNotSame($stub, $newStub);
+        static::assertEquals($metadata, $newStub->getMetadata());
     }
 }
diff --git a/tests/Event/EventIteratorCollectionTest.php b/tests/Event/EventIteratorCollectionTest.php
diff --git a/tests/Event/Stub/AbstractEmptyEventStub.php b/tests/Event/Stub/AbstractEmptyEventStub.php
diff --git a/tests/Event/Stub/AbstractEventStub.php b/tests/Event/Stub/AbstractEventStub.php
diff --git a/tests/Event/Time/FixedTimeProviderTest.php b/tests/Event/Time/FixedTimeProviderTest.php
diff --git a/tests/Event/Time/SystemTimeProviderTest.php b/tests/Event/Time/SystemTimeProviderTest.php

Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ abstract class AbstractEmptyEvent implements Event`
`31`	`31`	`*/`
`32`	`32`	`private function __construct(array $metadata, \DateTimeImmutable $createdAt)`
`33`	`33`	`{`
`34`		`- $this->checkImmutability();`
	`34`	`+ $this->assertImmutable();`
`35`	`35`
`36`	`36`	`$this->setMetadata($metadata);`
`37`	`37`	`$this->createdAt = $createdAt->setTimezone(new \DateTimeZone('UTC'));`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ abstract class AbstractEvent implements Event`
`32`	`32`	`*/`
`33`	`33`	`private function __construct(array $payload, array $metadata, \DateTimeImmutable $createdAt)`
`34`	`34`	`{`
`35`		`- $this->checkImmutability();`
	`35`	`+ $this->assertImmutable();`
`36`	`36`
`37`	`37`	`$this->setPayload($payload);`
`38`	`38`	`$this->setMetadata($metadata);`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ final public function handle(Event $event): void`
`26`	`26`	`{`
`27`	`27`	`if (!$this->isEventSupported($event)) {`
`28`	`28`	`throw new InvalidEventException(\sprintf(`
`29`		`- 'Event must be a %s, %s given',`
	`29`	`+ 'Event must be a "%s", "%s" given',`
`30`	`30`	`\implode('or ', $this->getSupportedEventTypes()),`
`31`	`31`	`\get_class($event)`
`32`	`32`	`));`