v1.0 release

Author: Asisyas

.gitignore

@@ -0,0 +1 @@
+/vendor/

composer.json

@@ -0,0 +1,24 @@
+{
+    "name": "micro/kernel-boot-configuration",
+    "description": "Micro Framework: Kernel Boot loader - component to provide plugin configuration",
+    "type": "library",
+    "version": "1.0",
+    "require": {
+        "micro/kernel": "^1"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^9"
+    },
+    "license": "MIT",
+    "autoload": {
+        "psr-4": {
+            "Micro\\Framework\\Kernel\\": "src/"
+        }
+    },
+    "authors": [
+        {
+            "name": "Stanislau Komar",
+            "email": "[email protected]"
+        }
+    ]
+}

src/Boot/ConfigurationProviderBootLoader.php

@@ -0,0 +1,46 @@
+<?php
+
+namespace Micro\Framework\Kernel\Boot;
+
+use Micro\Framework\Kernel\Configuration\ApplicationConfigurationFactoryInterface;
+use Micro\Framework\Kernel\Configuration\ApplicationConfigurationInterface;
+use Micro\Framework\Kernel\Configuration\DefaultApplicationConfigurationFactory;
+use Micro\Framework\Kernel\Configuration\Plugin\ConfigurableInterface;
+use Micro\Framework\Kernel\Plugin\PluginBootLoaderInterface;
+
+class ConfigurationProviderBootLoader implements PluginBootLoaderInterface
+{
+    private readonly ApplicationConfigurationInterface $configuration;
+
+    /**
+     * @param array|ApplicationConfigurationInterface|ApplicationConfigurationFactoryInterface $config
+     */
+    public function __construct(
+        array|ApplicationConfigurationInterface|ApplicationConfigurationFactoryInterface $config
+    )
+    {
+        $applicationConfig = $config;
+
+        if(is_array($config)) {
+            $applicationConfig = (new DefaultApplicationConfigurationFactory($config));
+        }
+
+        if(($applicationConfig instanceof ApplicationConfigurationFactoryInterface)) {
+            $applicationConfig = $applicationConfig->create();
+        }
+
+        $this->configuration = $applicationConfig;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function boot(object $applicationPlugin): void
+    {
+       if(!($applicationPlugin instanceof ConfigurableInterface)) {
+            return;
+       }
+
+       $applicationPlugin->setConfiguration($this->configuration);
+    }
+}

src/Configuration/ApplicationConfigurationFactoryInterface.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Micro\Framework\Kernel\Configuration;
+
+interface ApplicationConfigurationFactoryInterface
+{
+    /**
+     * @return ApplicationConfigurationInterface
+     */
+    public function create(): ApplicationConfigurationInterface;
+}

src/Configuration/ApplicationConfigurationInterface.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace Micro\Framework\Kernel\Configuration;
+
+interface ApplicationConfigurationInterface
+{
+    /**
+     * @param string $key
+     * @param mixed|null $default
+     * @param bool $nullable
+     *
+     * @return mixed
+     */
+    public function get(string $key, mixed $default = null, bool $nullable = true): mixed;
+}

src/Configuration/DefaultApplicationConfiguration.php

@@ -0,0 +1,64 @@
+<?php
+
+namespace Micro\Framework\Kernel\Configuration;
+
+use Micro\Framework\Kernel\Configuration\Exception\InvalidConfigurationException;
+
+class DefaultApplicationConfiguration implements ApplicationConfigurationInterface
+{
+    private const BOOLEAN_TRUE = [
+        'true', 'on', '1', 'yes'
+    ];
+
+    /**
+     * @param array<string, mixed> $configuration
+     */
+    public function __construct(private readonly array $configuration)
+    {
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function get(string $key, $default = null, bool $nullable = true): mixed
+    {
+        if(is_bool($default)) {
+            return $this->getBooleanValue($key, $default);
+        }
+
+        $value = $this->getValue($key, $default);
+
+        if($nullable === false && !$value && !is_numeric($value)) {
+            throw new InvalidConfigurationException(sprintf('Configuration key "%s" can not be NULL', $key));
+        }
+
+        return $value;
+    }
+
+    /**
+     * @param string $key
+     * @param bool $default
+     *
+     * @return bool
+     */
+    protected function getBooleanValue(string $key, bool $default): bool
+    {
+        $value = $this->getValue($key, $default);
+        if($value === null) {
+            return $default;
+        }
+
+        return in_array(mb_strtolower($value), self::BOOLEAN_TRUE, true);
+    }
+
+    /**
+     * @param string $key
+     * @param mixed $default
+     *
+     * @return mixed
+     */
+    protected function getValue(string $key, mixed $default): mixed
+    {
+        return $this->configuration[$key] ?? $default;
+    }
+}

src/Configuration/DefaultApplicationConfigurationFactory.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Micro\Framework\Kernel\Configuration;
+
+class DefaultApplicationConfigurationFactory implements ApplicationConfigurationFactoryInterface
+{
+    /**
+     * @param array<string, mixed> $configuration
+     */
+    public function __construct(private readonly array $configuration)
+    {
+    }
+
+    /**
+     * @return ApplicationConfigurationInterface
+     */
+    public function create(): ApplicationConfigurationInterface
+    {
+        return new DefaultApplicationConfiguration($this->configuration);
+    }
+}

src/Configuration/Exception/InvalidConfigurationException.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace Micro\Framework\Kernel\Configuration\Exception;
+
+class InvalidConfigurationException extends \RuntimeException
+{
+}

src/Configuration/PluginConfiguration.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace Micro\Framework\Kernel\Configuration;
+
+class PluginConfiguration implements PluginConfigurationInterface
+{
+    /**
+     * @param ApplicationConfigurationInterface $configuration
+     */
+    public function __construct(
+        protected readonly ApplicationConfigurationInterface $configuration
+    )
+    {
+    }
+
+    /**
+     * @param  string|array $list
+     * @param  string $separator
+     * @return string[]
+     */
+    protected function explodeStringToArray(string|array $list, string $separator = ','): array
+    {
+        if(is_array($list)) {
+            return $list;
+        }
+
+        if($separator === '') {
+            return [$list];
+        }
+
+        $itemsColl = explode($separator, $list);
+
+        return array_map('trim', $itemsColl);
+    }
+}

src/Configuration/PluginConfigurationInterface.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace Micro\Framework\Kernel\Configuration;
+
+interface PluginConfigurationInterface
+{
+}