Merge pull request #5 from minicli/input-layer-initial

Input Layer - Initial Implementation

.github/workflows/tests.yml

@@ -17,7 +17,6 @@ jobs:
         dependencies:
           - "highest"
         php-version:
-          - "8.1"
           - "8.2"
         operating-system:
           - "ubuntu-latest"
@@ -48,8 +47,11 @@ jobs:
       - name: "Validate Composer dependencies"
         run: "composer validate"
 
+      - name: "Check Style"
+        run: "composer test:lint"
+
       - name: "Check Static Analysis"
-        run: "composer stan"
+        run: "composer test:stan"
 
       - name: "Run Test suite"
-        run: "composer test"
+        run: "composer test:unit"

composer.json

@@ -30,20 +30,22 @@
     }
   },
   "scripts": {
-    "pint": [
-      "./vendor/bin/pint"
-    ],
-    "stan": [
-      "./vendor/bin/phpstan analyse --memory-limit=3G"
-    ],
+    "lint": ["pint"],
+    "test:lint": ["pint --test"],
+    "test:stan": ["phpstan analyse --memory-limit=3G"],
+    "test:unit": ["pest"],
     "test": [
-      "./vendor/bin/pest"
+      "@test:lint",
+      "@test:stan",
+      "@test:unit"
     ]
   },
   "scripts-descriptions": {
-    "pint": "Run Laravel Pint code styling.",
-    "stan": "Run PHPStan against code base.",
-    "test": "Run test suite."
+    "lint": "Run Laravel Pint code styling.",
+    "test:lint": "Run Laravel Pint code styling check.",
+    "test:stan": "Run PHPStan against code base.",
+    "test:unit": "Run test suite.",
+    "test": "Run all tests."
   },
   "minimum-stability": "dev",
   "prefer-stable": true,

src/Commands/AbstractCommand.php

@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Minicli\Framework\Commands;
+
+use Minicli\Framework\Contracts\Commands\CommandContract;
+use Minicli\Framework\Exceptions\MissingParametersException;
+use Minicli\Framework\Input\Input;
+
+abstract class AbstractCommand implements CommandContract
+{
+    /**
+     * @throws MissingParametersException
+     */
+    public function boot(Input $input): void
+    {
+        $missing = array_diff($this->required(), array_keys($input->params()));
+
+        if ([] !== $missing) {
+            throw new MissingParametersException($missing);
+        }
+    }
+
+    /**
+     * @return array<int,string>
+     */
+    public function required(): array
+    {
+        return [];
+    }
+
+    public function teardown(): void
+    {
+    }
+}

src/Commands/DefaultCommand.php

@@ -4,7 +4,14 @@
 
 namespace Minicli\Framework\Commands;
 
-final class DefaultCommand
+use Minicli\Framework\Input\Input;
+
+final class DefaultCommand extends AbstractCommand
 {
     public string $signature = 'default';
+
+    public function handle(Input $input): void
+    {
+        // TODO: Implement handle() method.
+    }
 }

src/Contracts/Commands/CommandContract.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Minicli\Framework\Contracts\Commands;
+
+use Minicli\Framework\Input\Input;
+
+interface CommandContract
+{
+    /**
+     * Executes the command logic.
+     */
+    public function handle(Input $input): void;
+
+    /**
+     * The list of parameters required by the command.
+     *
+     * @return array<int,string>
+     */
+    public function required(): array;
+
+    /**
+     * Called after the command is executed successfully.
+     */
+    public function teardown(): void;
+}

src/Contracts/Theme/MiniEnum.php

@@ -6,5 +6,4 @@
 
 interface MiniEnum
 {
-    //
 }

src/DI/Container.php

@@ -5,6 +5,7 @@
 namespace Minicli\Framework\DI;
 
 use ArrayAccess;
+use Closure;
 use Minicli\Framework\Exceptions\BindingResolutionException;
 use ReflectionClass;
 use ReflectionException;
@@ -14,7 +15,7 @@
 /**
  * @implements ArrayAccess<string,mixed>
  */
-class Container implements ArrayAccess
+abstract class Container implements ArrayAccess
 {
     protected static null|Container $instance = null;
 
@@ -26,12 +27,12 @@ class Container implements ArrayAccess
     /**
      * @var array<string,mixed>
      */
-    private array $instances = [];
+    protected array $instances = [];
 
     /**
      * @return void
      */
-    protected function __construct()
+    public function __construct()
     {
     }
 
@@ -136,19 +137,19 @@ public function build(Closure|string $concrete): mixed
             return $concrete($this);
         }
 
-        if (!class_exists($concrete)) {
-            throw new BindingResolutionException("Target class [$concrete] does not exist.", 0);
+        if ( ! class_exists($concrete)) {
+            throw new BindingResolutionException("Target class [{$concrete}] does not exist.", 0);
         }
 
         $reflector = new ReflectionClass($concrete);
 
-        if (!$reflector->isInstantiable()) {
-            throw new BindingResolutionException("Target [$concrete] is not instantiable.");
+        if ( ! $reflector->isInstantiable()) {
+            throw new BindingResolutionException("Target [{$concrete}] is not instantiable.");
         }
 
         $constructor = $reflector->getConstructor();
 
-        if (is_null($constructor)) {
+        if (null === $constructor) {
             return new $concrete();
         }
 
@@ -164,17 +165,17 @@ public function build(Closure|string $concrete): mixed
      * @return array<int,mixed>
      * @throws BindingResolutionException|ReflectionException
      */
-    protected function resolveDependencies(array $dependencies): array
+    private function resolveDependencies(array $dependencies): array
     {
         $results = [];
 
         foreach ($dependencies as $dependency) {
             // This is a much simpler version of what Laravel does
             $type = $dependency->getType(); // ReflectionType|null
 
-            if (!$type instanceof ReflectionNamedType || $type->isBuiltin()) {
-                $declaringClass = is_null($dependency->getDeclaringClass()) ? '' : $dependency->getDeclaringClass()->getName();
-                throw new BindingResolutionException("Unresolvable dependency resolving [$dependency] in class {$declaringClass}");
+            if ( ! $type instanceof ReflectionNamedType || $type->isBuiltin()) {
+                $declaringClass = null === $dependency->getDeclaringClass() ? '' : $dependency->getDeclaringClass()->getName();
+                throw new BindingResolutionException("Unresolvable dependency resolving [{$dependency}] in class {$declaringClass}");
             }
 
             $results[] = $this->make($type->getName());

src/Exceptions/BindingResolutionException.php

@@ -8,5 +8,4 @@
 
 final class BindingResolutionException extends Exception
 {
-    //
 }

src/Exceptions/MinicliNamingException.php

@@ -8,5 +8,4 @@
 
 final class MinicliNamingException extends InvalidArgumentException
 {
-    //
 }

src/Exceptions/MissingParametersException.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Minicli\Framework\Exceptions;
+
+use Exception;
+
+final class MissingParametersException extends Exception
+{
+    public function __construct(array $missing)
+    {
+        parent::__construct(sprintf(
+            'Missing required parameters: %s',
+            implode(', ', $missing)
+        ));
+    }
+}