v1.0 release

Asisyas · Asisyas · commit a10116e57cb6 · 2022-11-24T06:26:52.000+04:00
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1 @@
+/vendor/
diff --git a/composer.json b/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": "stanislau_komar@epam.com"
+        }
+    ]
+}
diff --git a/src/Boot/ConfigurationProviderBootLoader.php b/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);
+    }
+}
diff --git a/src/Configuration/ApplicationConfigurationFactoryInterface.php b/src/Configuration/ApplicationConfigurationFactoryInterface.php
@@ -0,0 +1,11 @@
+<?php
+
+namespace Micro\Framework\Kernel\Configuration;
+
+interface ApplicationConfigurationFactoryInterface
+{
+    /**
+     * @return ApplicationConfigurationInterface
+     */
+    public function create(): ApplicationConfigurationInterface;
+}
diff --git a/src/Configuration/ApplicationConfigurationInterface.php b/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;
+}
diff --git a/src/Configuration/DefaultApplicationConfiguration.php b/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;
+    }
+}
diff --git a/src/Configuration/DefaultApplicationConfigurationFactory.php b/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);
+    }
+}
diff --git a/src/Configuration/Exception/InvalidConfigurationException.php b/src/Configuration/Exception/InvalidConfigurationException.php
@@ -0,0 +1,7 @@
+<?php
+
+namespace Micro\Framework\Kernel\Configuration\Exception;
+
+class InvalidConfigurationException extends \RuntimeException
+{
+}
diff --git a/src/Configuration/PluginConfiguration.php b/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);
+    }
+}
diff --git a/src/Configuration/PluginConfigurationInterface.php b/src/Configuration/PluginConfigurationInterface.php
@@ -0,0 +1,7 @@
+<?php
+
+namespace Micro\Framework\Kernel\Configuration;
+
+interface PluginConfigurationInterface
+{
+}
diff --git a/src/Configuration/PluginRoutingKeyConfiguration.php b/src/Configuration/PluginRoutingKeyConfiguration.php
@@ -0,0 +1,42 @@
+<?php
+
+namespace Micro\Framework\Kernel\Configuration;
+
+class PluginRoutingKeyConfiguration extends PluginConfiguration
+{
+    /**
+     * @param ApplicationConfigurationInterface $configuration
+     * @param string $configRoutingKey
+     */
+    public function __construct(
+        ApplicationConfigurationInterface $configuration,
+        protected readonly string $configRoutingKey
+    )
+    {
+        parent::__construct($configuration);
+    }
+
+    /**
+     * @param  string $key
+     * @return string
+     */
+    protected function cfg(string $key): string
+    {
+        return sprintf($key, mb_strtoupper($this->configRoutingKey));
+    }
+
+    /**
+     * @param  string $key
+     * @param  mixed $default
+     * @param bool $nullable
+     * @return mixed
+     */
+    protected function get(string $key, mixed $default = null, bool $nullable = true): mixed
+    {
+        return $this->configuration->get(
+            $this->cfg($key),
+            $default,
+            $nullable
+        );
+    }
+}
diff --git a/src/Configuration/Resolver/PluginConfigurationClassResolver.php b/src/Configuration/Resolver/PluginConfigurationClassResolver.php
@@ -0,0 +1,66 @@
+<?php
+
+namespace Micro\Framework\Kernel\Configuration\Resolver;
+
+use Micro\Framework\Kernel\Configuration\ApplicationConfigurationInterface;
+use Micro\Framework\Kernel\Configuration\PluginConfiguration;
+use Micro\Framework\Kernel\Configuration\PluginConfigurationInterface;
+
+class PluginConfigurationClassResolver
+{
+    /**
+     * @param string $pluginClass
+     * @param ApplicationConfigurationInterface $applicationConfiguration
+     */
+    public function __construct(
+        private readonly string $pluginClass,
+        private readonly ApplicationConfigurationInterface $applicationConfiguration
+    )
+    {
+    }
+
+    /**
+     * @return PluginConfigurationInterface
+     */
+    public function resolve(): PluginConfigurationInterface
+    {
+        $configClassDefault = PluginConfiguration::class;
+        $configClasses      = [];
+
+        foreach ($this->getPluginClassResolvers() as $resolver) {
+            $configClass = $resolver->resolve($this->pluginClass);
+
+            if(!class_exists($configClass)) {
+                continue;
+            }
+
+            $configClasses[] = $configClass;
+        }
+
+        if(count($configClasses) > 1) {
+            throw new \RuntimeException(
+                sprintf(
+                    'Too many configuration classes for Application plugin "%s". [%s]',
+                    $this->pluginClass,
+                    implode(", ", $configClasses)
+                )
+            );
+        }
+
+        /** @var class-string<PluginConfigurationInterface> $configClass */
+        $configClass = $configClasses[0] ?? $configClassDefault;
+
+        return new $configClass($this->applicationConfiguration);
+    }
+
+    /**
+     * @return PluginConfigurationClassResolverInterface[]
+     */
+    protected function getPluginClassResolvers(): array
+    {
+        return [
+            new PluginNameResolver(),
+            new PluginNameShortResolver(),
+        ];
+    }
+}
diff --git a/src/Configuration/Resolver/PluginConfigurationClassResolverInterface.php b/src/Configuration/Resolver/PluginConfigurationClassResolverInterface.php
@@ -0,0 +1,12 @@
+<?php
+
+namespace Micro\Framework\Kernel\Configuration\Resolver;
+
+interface PluginConfigurationClassResolverInterface
+{
+    /**
+     * @param  string $pluginClass
+     * @return string
+     */
+    public function resolve(string $pluginClass): string;
+}
diff --git a/src/Configuration/Resolver/PluginNameResolver.php b/src/Configuration/Resolver/PluginNameResolver.php
@@ -0,0 +1,14 @@
+<?php
+
+namespace Micro\Framework\Kernel\Configuration\Resolver;
+
+class PluginNameResolver implements PluginConfigurationClassResolverInterface
+{
+    /**
+     * {@inheritDoc}
+     */
+    public function resolve(string $pluginClass): string
+    {
+        return $pluginClass . 'Configuration';
+    }
+}
diff --git a/src/Configuration/Resolver/PluginNameShortResolver.php b/src/Configuration/Resolver/PluginNameShortResolver.php
@@ -0,0 +1,14 @@
+<?php
+
+namespace Micro\Framework\Kernel\Configuration\Resolver;
+
+class PluginNameShortResolver implements PluginConfigurationClassResolverInterface
+{
+    /**
+     * {@inheritDoc}
+     */
+    public function resolve(string $pluginClass): string
+    {
+        return $pluginClass . 'Config';
+    }
+}
diff --git a/src/Plugin/ConfigurableInterface.php b/src/Plugin/ConfigurableInterface.php

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