Rename Id to Uuid

Author: Myks92

docs/usage/identity.md

@@ -1,14 +1,13 @@
 # Identity
 This groups Value Objects use for identity, e.g. for auth to users in your project. Or for another Entities.
 
-## Id
+## Uuid
 ```php
-use Myks92\ValueObjects\Identity\Id;
-use Ramsey\Uuid\Uuid;
+use Myks92\ValueObjects\Identity\Uuid;
 
-$id = new Id(Uuid::uuid4()->toString());
-$id->getValue(); //UUID4
-$id->isEqualTo(new Id(Uuid::uuid4()->toString())); //false
+$id = new Uuid('ccf4597-9d46-4bb4-b399-fdaf8db24bf0');
+$id->getValue(); //ccf4597-9d46-4bb4-b399-fdaf8db24bf0
+$id->isEqualTo(new Uuid('ccf4597-9d46-4bb4-b399-fdaf8db24bf0')); //true
 ```
 
 ## Email

src/Identity/Id.php src/Identity/Uuid.phpsrc/Identity/Id.php renamed to src/Identity/Uuid.php

@@ -8,15 +8,15 @@
 
 use Exception;
 use Myks92\ValueObjects\String\StringLiteral;
-use Ramsey\Uuid\Uuid;
+use Ramsey\Uuid\Uuid as UuidRamsey;
 use Webmozart\Assert\Assert;
 
 /**
  * Class Id
  *
  * @author Maxim Vorozhtsov <myks1992@mail.ru>
  */
-class Id extends StringLiteral
+class Uuid extends StringLiteral
 {
     /**
      * @param string $value
@@ -35,6 +35,6 @@ public function __construct(string $value)
      */
     public static function generate(): self
     {
-        return new self(Uuid::uuid4()->toString());
+        return new self(UuidRamsey::uuid4()->toString());
     }
 }

tests/Identity/IdTest.php tests/Identity/UuidTest.phptests/Identity/IdTest.php renamed to tests/Identity/UuidTest.php

@@ -8,45 +8,45 @@
 
 use Exception;
 use InvalidArgumentException;
-use Myks92\ValueObjects\Identity\Id;
+use Myks92\ValueObjects\Identity\Uuid;
 use PHPUnit\Framework\TestCase;
-use Ramsey\Uuid\Uuid;
+use Ramsey\Uuid\Uuid as UuidRamsey;
 
-class IdTest extends TestCase
+class UuidTest extends TestCase
 {
     public function testSuccess(): void
     {
-        $id = $this->createId($value = Uuid::uuid4()->toString());
+        $id = $this->createId($value = UuidRamsey::uuid4()->toString());
 
         self::assertEquals($value, $id->getValue());
     }
 
     public function testCase(): void
     {
-        $value = Uuid::uuid4()->toString();
+        $value = UuidRamsey::uuid4()->toString();
         $id = $this->createId(mb_strtoupper($value));
 
         self::assertEquals($value, $id->getValue());
     }
 
     public function testGenerate(): void
     {
-        $id = Id::generate();
+        $id = Uuid::generate();
 
         self::assertNotEmpty($id->getValue());
     }
 
     public function testToString(): void
     {
-        $id = $this->createId($value = Uuid::uuid4()->toString());
+        $id = $this->createId($value = UuidRamsey::uuid4()->toString());
 
         self::assertEquals($value, $id);
     }
 
     public function testEqual(): void
     {
         $id = $this->createId();
-        $id2 = Id::generate(); //other
+        $id2 = Uuid::generate(); //other
 
         self::assertTrue($id->isEqualTo($id));
         self::assertFalse($id->isEqualTo($id2));
@@ -55,26 +55,26 @@ public function testEqual(): void
     public function testIncorrect(): void
     {
         $this->expectException(InvalidArgumentException::class);
-        new Id('not-uuid');
+        new Uuid('not-uuid');
     }
 
     public function testEmpty(): void
     {
         $this->expectException(InvalidArgumentException::class);
-        new Id('');
+        new Uuid('');
     }
 
     /**
      * @param $value
      *
-     * @return Id
+     * @return Uuid
      * @throws Exception
      */
-    private function createId($value = null): Id
+    private function createId($value = null): Uuid
     {
         if (null === $value) {
-            $value = Uuid::uuid4()->toString();
+            $value = UuidRamsey::uuid4()->toString();
         }
-        return new Id($value);
+        return new Uuid($value);
     }
 }