Add parameter value object

Author: dantleech

lib/Container.php

@@ -32,6 +32,8 @@ public function getServiceIdsForTag(string $tag): array;
      */
     public function getParameter(string $name);
 
+    public function parameter(string $name): Parameter;
+
     /**
      * @return array<string,mixed>
      */

lib/Parameter.php

@@ -0,0 +1,49 @@
+<?php
+
+namespace Phpactor\Container;
+
+use RuntimeException;
+
+final class Parameter
+{
+    public function __construct(private mixed $value)
+    {
+    }
+
+    public function value(): mixed
+    {
+        return $this->value;
+    }
+
+    public function int(): int
+    {
+        if (!is_int($this->value)) {
+            throw new RuntimeException(sprintf('Value is not an int, it is "%s"', gettype($this->value)));
+        }
+        return $this->value;
+    }
+
+    public function string(): string
+    {
+        if (!is_string($this->value)) {
+            throw new RuntimeException(sprintf('Value is not a string, it is "%s"', gettype($this->value)));
+        }
+        return $this->value;
+    }
+
+    public function bool(): bool
+    {
+        if (!is_bool($this->value)) {
+            throw new RuntimeException(sprintf('Value is not a bool, it is "%s"', gettype($this->value)));
+        }
+        return $this->value;
+    }
+
+    public function float(): float
+    {
+        if (!is_float($this->value)) {
+            throw new RuntimeException(sprintf('Value is not a float, it is "%s"', gettype($this->value)));
+        }
+        return $this->value;
+    }
+}

lib/PhpactorContainer.php

@@ -152,4 +152,9 @@ public function expect(string $id, string $expected): object
     {
         return $this->get($id);
     }
+
+    public function parameter(string $name): Parameter
+    {
+        return new Parameter($this->getParameter($name));
+    }
 }

tests/Unit/ParameterTest.php

@@ -0,0 +1,60 @@
+<?php
+
+namespace Phpactor\Container\Tests\Unit;
+
+use Closure;
+use Generator;
+use PHPUnit\Framework\TestCase;
+use Phpactor\Container\Parameter;
+use RuntimeException;
+
+class ParameterTest extends TestCase
+{
+    public function testCast(): void
+    {
+        self::assertSame(12, (new Parameter(12))->value());
+        self::assertSame(12, (new Parameter(12))->int());
+        self::assertSame('12', (new Parameter('12'))->string());
+        self::assertSame(true, (new Parameter(true))->bool());
+        self::assertSame(12.2, (new Parameter(12.2))->float());
+    }
+
+    /**
+     * @dataProvider provideCastException
+     * @param Closure(Parameter): mixed $invoker
+     */
+    public function testCastException(mixed $value, Closure $invoker, string $message): void
+    {
+        $this->expectException(RuntimeException::class);
+        $this->expectExceptionMessage($message);
+        $invoker(
+            new Parameter($value)
+        );
+    }
+    /**
+     * @return Generator<string,array{mixed,Closure(Parameter): mixed,string}>
+     */
+    public function provideCastException(): Generator
+    {
+        yield 'not an int' => [
+            '12',
+            fn (Parameter $p) => $p->int(),
+            'Value is not an int, it is "string"'
+        ];
+        yield 'not an string' => [
+            12,
+            fn (Parameter $p) => $p->string(),
+            'Value is not a string, it is "integer"'
+        ];
+        yield 'not a float' => [
+            '12',
+            fn (Parameter $p) => $p->float(),
+            'Value is not a float, it is "string"'
+        ];
+        yield 'not a bool' => [
+            '12',
+            fn (Parameter $p) => $p->bool(),
+            'Value is not a bool, it is "string"'
+        ];
+    }
+}

tests/Unit/PhpactorContainerTest.php

@@ -130,6 +130,12 @@ public function testReturnsParameter(): void
         $this->assertEquals('value1', $result);
     }
 
+    public function testReturnsParameterObject(): void
+    {
+        $result = $this->container->parameter('configKey1');
+        $this->assertEquals('value1', $result->value());
+    }
+
     public function testReturnsNullParameter(): void
     {
         $result = $this->container->getParameter('nullKey');