Merge pull request #5 from michael-rubel/feat/name

Add `Name` object

Author: michael-rubel

README.md

@@ -29,6 +29,7 @@ composer require michael-rubel/laravel-value-objects
 - [`Text`](https://github.com/michael-rubel/laravel-value-objects/blob/main/src/Collection/Primitive/Text.php)
 - [`ClassString`](https://github.com/michael-rubel/laravel-value-objects/blob/main/src/Collection/Complex/ClassString.php)
 - [`FullName`](https://github.com/michael-rubel/laravel-value-objects/blob/main/src/Collection/Complex/FullName.php)
+- [`Name`](https://github.com/michael-rubel/laravel-value-objects/blob/main/src/Collection/Complex/Name.php)
 - [`TaxNumber`](https://github.com/michael-rubel/laravel-value-objects/blob/main/src/Collection/Complex/TaxNumber.php)
 - [`Uuid`](https://github.com/michael-rubel/laravel-value-objects/blob/main/src/Collection/Complex/Uuid.php)
 
@@ -127,6 +128,19 @@ $name->lastName();  // 'Otwell'
 
 ---
 
+### Name
+```php
+$name = new Name(' Company name! ');
+$name = Name::make(' Company name! ');
+$name = Name::from(' Company name! ');
+
+$name->value();   // 'Company name!'
+(string) $name;   // 'Company name!'
+$name->toArray(); // ['Company name!']
+```
+
+---
+
 ### TaxNumber
 ```php
 $taxNumber = new TaxNumber('0123456789', 'PL');

composer.json

@@ -18,8 +18,8 @@
     "require": {
         "php": "^8.0",
         "illuminate/support": "^9.7",
-        "michael-rubel/laravel-formatters": "^6.1",
         "phpmath/bignumber": "^1.2",
+        "michael-rubel/laravel-formatters": "^6.2",
         "spatie/laravel-package-tools": "^1.12"
     },
     "require-dev": {

src/Collection/Complex/FullName.php

@@ -13,6 +13,7 @@
 namespace MichaelRubel\ValueObjects\Collection\Complex;
 
 use Illuminate\Support\Collection;
+use Illuminate\Support\Stringable;
 use InvalidArgumentException;
 use MichaelRubel\Formatters\Collection\FullNameFormatter;
 use MichaelRubel\ValueObjects\ValueObject;
@@ -25,9 +26,9 @@
  * @template TKey of array-key
  * @template TValue
  *
- * @method static static make(string $value)
- * @method static static from(string $value)
- * @method static static makeOrNull(string $value)
+ * @method static static make(string|Stringable $value)
+ * @method static static from(string|Stringable $value)
+ * @method static static makeOrNull(string|Stringable $value)
  *
  * @extends ValueObject<TKey, TValue>
  */
@@ -41,12 +42,12 @@ class FullName extends ValueObject
     /**
      * Create a new instance of the value object.
      *
-     * @param  string  $value
+     * @param  string|Stringable  $value
      */
-    public function __construct(protected string $value)
+    public function __construct(protected string|Stringable $value)
     {
         $this->split();
-        $this->format();
+        $this->sanitize();
         $this->validate();
     }
 
@@ -57,7 +58,7 @@ public function __construct(protected string $value)
      */
     public function fullName(): string
     {
-        return $this->value;
+        return $this->value();
     }
 
     /**
@@ -87,7 +88,7 @@ public function lastName(): string
      */
     public function value(): string
     {
-        return $this->fullName();
+        return (string) $this->value;
     }
 
     /**
@@ -121,11 +122,11 @@ protected function validate(): void
     }
 
     /**
-     * Format the value.
+     * Sanitize the value.
      *
      * @return void
      */
-    protected function format(): void
+    protected function sanitize(): void
     {
         $this->value = format(FullNameFormatter::class, $this->value());
     }

src/Collection/Complex/Name.php

@@ -0,0 +1,59 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * This file is part of michael-rubel/laravel-value-objects. (https://github.com/michael-rubel/laravel-value-objects)
+ *
+ * @link https://github.com/michael-rubel/laravel-value-objects for the canonical source repository
+ * @copyright Copyright (c) 2022 Michael Rubél. (https://github.com/michael-rubel/)
+ * @license https://raw.githubusercontent.com/michael-rubel/laravel-value-objects/main/LICENSE.md MIT
+ */
+
+namespace MichaelRubel\ValueObjects\Collection\Complex;
+
+use Illuminate\Support\Stringable;
+use MichaelRubel\ValueObjects\Collection\Primitive\Text;
+
+/**
+ * "Name" object presenting a generic name.
+ *
+ * @author Michael Rubél <michael@laravel.software>
+ *
+ * @template TKey of array-key
+ * @template TValue
+ *
+ * @method static static make(string|Stringable $value)
+ * @method static static from(string|Stringable $value)
+ * @method static static makeOrNull(string|Stringable $value)
+ *
+ * @extends Text<TKey, TValue>
+ */
+class Name extends Text
+{
+    /**
+     * Create a new instance of the value object.
+     *
+     * @param  string|Stringable  $value
+     */
+    public function __construct(protected string|Stringable $value)
+    {
+        parent::__construct($this->value);
+
+        $this->sanitize();
+    }
+
+    /**
+     * Sanitize the value.
+     *
+     * @return void
+     */
+    protected function sanitize(): void
+    {
+        $this->value = str($this->value())
+            ->replaceMatches('/\p{C}+/u', '')
+            ->replace(['\r', '\n', '\t'], '')
+            ->squish()
+            ->value();
+    }
+}

src/Collection/Complex/TaxNumber.php

@@ -43,7 +43,7 @@ public function __construct(
         protected ?string $prefix = null,
     ) {
         $this->validate();
-        $this->format();
+        $this->sanitize();
 
         if ($this->canSplit()) {
             $this->split();
@@ -131,11 +131,11 @@ protected function validate(): void
     }
 
     /**
-     * Format the value.
+     * Sanitize the value.
      *
      * @return void
      */
-    protected function format(): void
+    protected function sanitize(): void
     {
         $this->number = format(TaxNumberFormatter::class, $this->taxNumber(), $this->prefix());
     }

tests/Unit/Complex/FullNameTest.php

@@ -105,6 +105,11 @@
     $this->assertSame($valueObject->value(), (string) $valueObject);
 });
 
+test('full name accepts stringable', function () {
+    $valueObject = new FullName(str('Name Name'));
+    $this->assertSame('Name Name', $valueObject->value());
+});
+
 test('full name fails when passed only first name', function () {
     $this->expectException(\InvalidArgumentException::class);
 

tests/Unit/Complex/NameTest.php

@@ -0,0 +1,88 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Olsza\ValueObjects\Tests\Feature\ValueObjects;
+
+use MichaelRubel\ValueObjects\Collection\Complex\Name;
+
+test('name replaces invisible characters', function () {
+    $name = new Name(' Company Name ');
+    $this->assertSame('Company Name', $name->value());
+
+    $name = new Name('    Name!');
+    $this->assertSame('Name!', $name->value());
+
+    $name = new Name('Name@$    ');
+    $this->assertSame('Name@$', $name->value());
+
+    $name = new Name('HOTEL GOŁĘBIEWSKI TADEUSZ GOŁĘBIEWSKI,\r\nTAGO PRZEDSIĘBIORSTWO PRZEMYSŁU CUKIERNICZEGO TADEUSZ GOŁĘBIEWSKI');
+    $this->assertSame('HOTEL GOŁĘBIEWSKI TADEUSZ GOŁĘBIEWSKI,TAGO PRZEDSIĘBIORSTWO PRZEMYSŁU CUKIERNICZEGO TADEUSZ GOŁĘBIEWSKI', $name->value());
+
+    $name = new Name('HOTEL GOŁĘBIEWSKI TADEUSZ GOŁĘBIEWSKI,
+TAGO PRZEDSIĘBIORSTWO PRZEMYSŁU CUKIERNICZEGO TADEUSZ GOŁĘBIEWSKI');
+    $this->assertSame('HOTEL GOŁĘBIEWSKI TADEUSZ GOŁĘBIEWSKI,TAGO PRZEDSIĘBIORSTWO PRZEMYSŁU CUKIERNICZEGO TADEUSZ GOŁĘBIEWSKI', $name->value());
+});
+
+test('name cannot accept null', function () {
+    $this->expectException(\TypeError::class);
+
+    new Name(null);
+});
+
+test('name fails when no argument passed', function () {
+    $this->expectException(\TypeError::class);
+
+    new Name;
+});
+
+test('name fails when empty string passed', function () {
+    $this->expectException(\InvalidArgumentException::class);
+
+    new Name('');
+});
+
+test('name is makeable', function () {
+    $valueObject = Name::make('1');
+    $this->assertSame('1', $valueObject->value());
+
+    $valueObject = Name::from('1');
+    $this->assertSame('1', $valueObject->value());
+});
+
+test('name is macroable', function () {
+    Name::macro('str', function () {
+        return str($this->value());
+    });
+
+    $valueObject = new Name('Lorem ipsum');
+
+    $this->assertTrue($valueObject->str()->is('Lorem ipsum'));
+});
+
+test('text is conditionable', function () {
+    $valueObject = new Name('1');
+    $this->assertSame('1', $valueObject->when(true)->value());
+    $this->assertSame($valueObject, $valueObject->when(false)->value());
+});
+
+test('text is arrayable', function () {
+    $array = (new Name('Lorem Ipsum is simply dummy text.'))->toArray();
+    $this->assertSame(['Lorem Ipsum is simply dummy text.'], $array);
+});
+
+test('text is stringable', function () {
+    $valueObject = new Name('Lorem ipsum');
+    $this->assertSame('Lorem ipsum', (string) $valueObject);
+});
+
+test('text accepts stringable', function () {
+    $valueObject = new Name(str('Lorem ipsum'));
+    $this->assertSame('Lorem ipsum', $valueObject->value());
+});
+
+test('text fails when empty stringable passed', function () {
+    $this->expectException(\InvalidArgumentException::class);
+
+    new Name(str(''));
+});