strict types

broadway · Mar 5, 2020 · 1f49f8c · 1f49f8c
1 parent f14dbee
commit 1f49f8c
Show file tree

Hide file tree

Showing 11 changed files with 26 additions and 48 deletions.
diff --git a/examples/generate.php b/examples/generate.php
@@ -13,7 +13,7 @@
 
 require_once __DIR__.'/bootstrap.php';
 
-function generateAndOutput5(Broadway\UuidGenerator\UuidGeneratorInterface $generator)
+function generateAndOutput5(Broadway\UuidGenerator\UuidGeneratorInterface $generator): void
 {
     for ($i = 0; $i < 5; ++$i) {
         echo sprintf("[%d] %s\n", $i, $generator->generate());

diff --git a/src/Broadway/UuidGenerator/Converter/BinaryUuidConverter.php b/src/Broadway/UuidGenerator/Converter/BinaryUuidConverter.php
@@ -20,15 +20,15 @@ class BinaryUuidConverter implements BinaryUuidConverterInterface
     /**
      * {@inheritdoc}
      */
-    public static function fromString($uuid)
+    public static function fromString(string $uuid): string
     {
         return Uuid::fromString($uuid)->getBytes();
     }
 
     /**
      * {@inheritdoc}
      */
-    public static function fromBytes($bytes)
+    public static function fromBytes(string $bytes): string
     {
         return Uuid::fromBytes($bytes)->toString();
     }

diff --git a/src/Broadway/UuidGenerator/Converter/BinaryUuidConverterInterface.php b/src/Broadway/UuidGenerator/Converter/BinaryUuidConverterInterface.php
@@ -15,17 +15,7 @@
 
 interface BinaryUuidConverterInterface
 {
-    /**
-     * @param string $uuid
-     *
-     * @return string
-     */
-    public static function fromString($uuid);
+    public static function fromString(string $uuid): string;
 
-    /**
-     * @param string $bytes
-     *
-     * @return string
-     */
-    public static function fromBytes($bytes);
+    public static function fromBytes(string $bytes): string;
 }
diff --git a/src/Broadway/UuidGenerator/Rfc4122/Version4Generator.php b/src/Broadway/UuidGenerator/Rfc4122/Version4Generator.php
@@ -21,10 +21,7 @@
  */
 class Version4Generator implements UuidGeneratorInterface
 {
-    /**
-     * @return string
-     */
-    public function generate()
+    public function generate(): string
     {
         return Uuid::uuid4()->toString();
     }

diff --git a/src/Broadway/UuidGenerator/Testing/MockUuidGenerator.php b/src/Broadway/UuidGenerator/Testing/MockUuidGenerator.php
@@ -25,18 +25,12 @@ class MockUuidGenerator implements UuidGeneratorInterface
      */
     private $uuid;
 
-    /**
-     * @param string $uuid
-     */
-    public function __construct($uuid)
+    public function __construct(string $uuid)
     {
         $this->uuid = $uuid;
     }
 
-    /**
-     * @return string
-     */
-    public function generate()
+    public function generate(): string
     {
         return $this->uuid;
     }

diff --git a/src/Broadway/UuidGenerator/Testing/MockUuidSequenceGenerator.php b/src/Broadway/UuidGenerator/Testing/MockUuidSequenceGenerator.php
@@ -34,10 +34,7 @@ public function __construct(array $uuids)
         $this->uuids = (array) $uuids;
     }
 
-    /**
-     * @return string
-     */
-    public function generate()
+    public function generate(): string
     {
         if (0 === count($this->uuids)) {
             throw new RuntimeException('No more uuids in sequence');

diff --git a/src/Broadway/UuidGenerator/UuidGeneratorInterface.php b/src/Broadway/UuidGenerator/UuidGeneratorInterface.php
@@ -18,8 +18,5 @@
  */
 interface UuidGeneratorInterface
 {
-    /**
-     * @return string
-     */
-    public function generate();
+    public function generate(): string;
 }
diff --git a/test/Broadway/UuidGenerator/Converter/BinaryUuidConverterTest.php b/test/Broadway/UuidGenerator/Converter/BinaryUuidConverterTest.php
@@ -20,7 +20,7 @@ class BinaryUuidConverterTest extends TestCase
     /**
      * @test
      */
-    public function it_converts_string_uuid_to_binary_uuid()
+    public function it_converts_string_uuid_to_binary_uuid(): void
     {
         $binary = BinaryUuidConverter::fromString('260b70eb-a5b7-4fde-916a-4cc021745c13');
 
@@ -30,7 +30,7 @@ public function it_converts_string_uuid_to_binary_uuid()
     /**
      * @test
      */
-    public function it_throws_when_converting_invalid_string_uuid_to_binary_uuid()
+    public function it_throws_when_converting_invalid_string_uuid_to_binary_uuid(): void
     {
         $this->expectException('InvalidArgumentException');
         $this->expectExceptionMessage('Invalid UUID string: yolo');
@@ -40,7 +40,7 @@ public function it_throws_when_converting_invalid_string_uuid_to_binary_uuid()
     /**
      * @test
      */
-    public function it_converts_binary_uuid_to_string_uuid()
+    public function it_converts_binary_uuid_to_string_uuid(): void
     {
         $this->assertEquals(
             '260b70eb-a5b7-4fde-916a-4cc021745c13',
@@ -51,7 +51,7 @@ public function it_converts_binary_uuid_to_string_uuid()
     /**
      * @test
      */
-    public function it_throws_when_converting_invalid_binary_uuid_to_string_uuid()
+    public function it_throws_when_converting_invalid_binary_uuid_to_string_uuid(): void
     {
         $this->expectException('InvalidArgumentException');
         $this->expectExceptionMessage('$bytes string should contain 16 characters.');

diff --git a/test/Broadway/UuidGenerator/Rfc4122/Version4GeneratorTest.php b/test/Broadway/UuidGenerator/Rfc4122/Version4GeneratorTest.php
@@ -21,7 +21,7 @@ class Version4GeneratorTest extends TestCase
     /**
      * @test
      */
-    public function it_should_generate_a_string()
+    public function it_should_generate_a_string(): void
     {
         $generator = new Version4Generator();
         $uuid = $generator->generate();
@@ -32,7 +32,7 @@ public function it_should_generate_a_string()
     /**
      * @test
      */
-    public function it_should_generate_a_version_4_uuid()
+    public function it_should_generate_a_version_4_uuid(): void
     {
         $generator = new Version4Generator();
         $uuid = $generator->generate();

diff --git a/test/Broadway/UuidGenerator/Testing/MockUuidGeneratorTest.php b/test/Broadway/UuidGenerator/Testing/MockUuidGeneratorTest.php
@@ -20,7 +20,7 @@ class MockUuidGeneratorTest extends TestCase
     /**
      * @test
      */
-    public function it_generates_a_string()
+    public function it_generates_a_string(): void
     {
         $generator = $this->createMockUuidGenerator();
         $uuid = $generator->generate();
@@ -31,7 +31,7 @@ public function it_generates_a_string()
     /**
      * @test
      */
-    public function it_generates_the_same_string()
+    public function it_generates_the_same_string(): void
     {
         $generator = $this->createMockUuidGenerator();
 
@@ -40,7 +40,7 @@ public function it_generates_the_same_string()
         }
     }
 
-    private function createMockUuidGenerator()
+    private function createMockUuidGenerator(): \Broadway\UuidGenerator\Testing\MockUuidGenerator
     {
         return new MockUuidGenerator('e2d0c739-53ac-434c-8d7a-03e29b400566');
     }

diff --git a/test/Broadway/UuidGenerator/Testing/MockUuidSequenceGeneratorTest.php b/test/Broadway/UuidGenerator/Testing/MockUuidSequenceGeneratorTest.php
@@ -17,6 +17,9 @@
 
 class MockUuidSequenceGeneratorTest extends TestCase
 {
+    /**
+     * @var string[]
+     */
     private $uuids = [
         'e2d0c739-0001-434c-8d7a-03e29b400566',
         'e2d0c739-0002-434c-8d7a-03e29b400566',
@@ -27,7 +30,7 @@ class MockUuidSequenceGeneratorTest extends TestCase
     /**
      * @test
      */
-    public function it_generates_a_string()
+    public function it_generates_a_string(): void
     {
         $generator = $this->createMockUuidGenerator();
         $uuid = $generator->generate();
@@ -38,7 +41,7 @@ public function it_generates_a_string()
     /**
      * @test
      */
-    public function it_generates_the_same_string()
+    public function it_generates_the_same_string(): void
     {
         $generator = $this->createMockUuidGenerator();
 
@@ -50,7 +53,7 @@ public function it_generates_the_same_string()
     /**
      * @test
      */
-    public function it_throws_an_exception_when_pool_is_empty()
+    public function it_throws_an_exception_when_pool_is_empty(): void
     {
         $this->expectException('RuntimeException');
         $generator = $this->createMockUuidGenerator();
@@ -60,7 +63,7 @@ public function it_throws_an_exception_when_pool_is_empty()
         }
     }
 
-    private function createMockUuidGenerator()
+    private function createMockUuidGenerator(): \Broadway\UuidGenerator\Testing\MockUuidSequenceGenerator
     {
         return new MockUuidSequenceGenerator($this->uuids);
     }