Initial commit

Author: Michael Petri

.gitignore

@@ -0,0 +1,2 @@
+vendor
+composer.lock

.gitlab-ci.yml

@@ -0,0 +1,19 @@
+image: php:7
+
+cache:
+  paths:
+    - vendor/
+
+before_script:
+  - apt-get update -yqq
+  - apt-get install -yqq git zip gzip
+  # Install & enable Xdebug for code coverage reports
+  - pecl install xdebug
+  - docker-php-ext-enable xdebug
+  # Install and run Composer
+  - curl -sS https://getcomposer.org/installer | php
+  - php composer.phar install
+
+test:
+  script:
+    - vendor/bin/phpunit --configuration phpunit.xml --coverage-text --colors=never

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Michael Petri
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,14 @@
+# Typed Input
+
+Installation:
+```
+composer require michaelpetri/typed-input 
+```
+
+Usage:
+```
+$typedInput = TypedInput::fromInput($input);
+
+echo $typedInput->getOption('my-option')->asNonEmptyString();
+echo $typedInput->getArgument('my-argument')->asInteger();
+```

composer.json

@@ -0,0 +1,30 @@
+{
+    "name": "michaelpetri/typed-input",
+    "description": "Type safe input wrapper for symfony input",
+    "authors": [
+        {
+            "name": "Michael Petri",
+            "email": "[email protected]"
+        }
+    ],
+    "license": "MIT",
+    "require": {
+        "php": "^7.0",
+        "symfony/console": "^4.0",
+        "webmozart/assert": "^1.8"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^9.2",
+        "roave/security-advisories": "dev-master"
+    },
+    "autoload": {
+        "psr-4": {
+            "MichaelPetri\\TypedInput\\": "src/"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "MichaelPetri\\TypedInput\\Tests\\": "tests/"
+        }
+    }
+}

phpunit.xml

@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!-- https://phpunit.de/manual/current/en/appendixes.configuration.html -->
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
+         backupGlobals="false"
+         colors="true"
+         failOnWarning="true"
+         failOnRisky="true"
+>
+    <php>
+        <ini name="error_reporting" value="-1"/>
+    </php>
+
+    <testsuites>
+        <testsuite name="all">
+            <directory>tests/</directory>
+        </testsuite>
+    </testsuites>
+
+    <filter>
+        <whitelist>
+            <directory>src</directory>
+        </whitelist>
+    </filter>
+</phpunit>

src/TypedInput.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace MichaelPetri\TypedInput;
+
+use Symfony\Component\Console\Input\InputInterface;
+
+final class TypedInput
+{
+    /**
+     * @var InputInterface
+     */
+    private $input;
+
+    private function __construct(InputInterface $input)
+    {
+        $this->input = $input;
+    }
+
+    public static function fromInput(InputInterface $input): self
+    {
+        return new self($input);
+    }
+
+    public function getOption(string $name): Value
+    {
+        return new Value($this->input->getOption($name));
+    }
+
+    public function getArgument(string $name): Value
+    {
+        return new Value($this->input->getArgument($name));
+    }
+}

src/Value.php

@@ -0,0 +1,55 @@
+<?php
+
+namespace MichaelPetri\TypedInput;
+
+use Webmozart\Assert\Assert;
+
+final class Value
+{
+    private $value;
+
+    public function __construct($value)
+    {
+        $this->value = $value;
+    }
+
+    public function asInteger(): int
+    {
+        $value = (int) $this->value;
+        Assert::integer($value);
+
+        return $value;
+    }
+
+    /**
+     * @return array<int, string>|string[]
+     */
+    public function asNonEmptyStrings(): array
+    {
+        $values = array_map(
+            static function ($value): string {
+                return (string) $value;
+            },
+            $this->value
+        );
+        Assert::allStringNotEmpty($values);
+
+        return $values;
+    }
+
+    public function asNonEmptyString(): string
+    {
+        $value = (string) $this->value;
+        Assert::stringNotEmpty($value);
+
+        return $value;
+    }
+
+    public function asString(): string
+    {
+        $value = (string) $this->value;
+        Assert::string($value);
+
+        return $value;
+    }
+}

tests/ValueTest.php

@@ -0,0 +1,67 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MichaelPetri\TypedInput\Tests;
+
+use InvalidArgumentException;
+use MichaelPetri\TypedInput\Value;
+use PHPUnit\Framework\TestCase;
+
+final class ValueTest extends TestCase
+{
+
+    public function testAsNonEmptyString()
+    {
+        $raw = 'non-empty-string';
+        $value = new Value($raw);
+        self::assertEquals($raw, $value->asNonEmptyString());
+
+        $raw = ' ';
+        $value = new Value($raw);
+        self::assertEquals($raw, $value->asNonEmptyString());
+    }
+
+    public function testFailAsNonEmptyString()
+    {
+        $value = new Value('');
+        $this->expectException(InvalidArgumentException::class);
+        $value->asNonEmptyString();
+    }
+
+    public function testAsNonEmptyStrings()
+    {
+        $raws = ['non-empty-string-1', 'non-empty-string-2'];
+        $value = new Value($raws);
+        self::assertEquals($raws, $value->asNonEmptyStrings());
+    }
+
+    public function testFailAsNonEmptyStrings()
+    {
+        $value = new Value(['non-empty-string', '']);
+        $this->expectException(InvalidArgumentException::class);
+        $value->asNonEmptyStrings();
+    }
+
+    public function testAsString()
+    {
+        $raw = '';
+        $value = new Value($raw);
+        self::assertEquals($raw, $value->asString());
+
+        $raw = 'non-empty-string';
+        $value = new Value($raw);
+        self::assertEquals($raw, $value->asString());
+
+        $raw = 1;
+        $value = new Value($raw);
+        self::assertEquals((string) $raw, $value->asString());
+    }
+
+    public function testAsInteger()
+    {
+        $raw = 1;
+        $value = new Value($raw);
+        self::assertEquals($raw, $value->asInteger());
+    }
+}