Add Config Package

Author: mohamed-samir907

.gitignore

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

README.md

@@ -0,0 +1,33 @@
+# HackPHP Config
+HackPHP Config Access.
+
+## Usage
+
+```bash
+composer require hackphp/config "1.0"
+```
+
+```php
+use Hackphp\Config\Config;
+use Hackphp\Config\Parsers\ArrayParser;
+
+$config = new Config([
+    "app" => [
+        "name" => "HackPHP"
+    ],
+    "server" => [
+        "host" => "127.0.0.1",
+        "port" => 8000
+    ],
+]);
+
+$configRootDir = __DIR__ . "/config";
+$config->addParser(new ArrayParser($configRootDir));
+$config->load();
+
+echo $config->get("server.host");
+// output: 127.0.0.1
+
+echo $config->get("file.key", "default value");
+// output: default value
+```

composer.json

@@ -0,0 +1,32 @@
+{
+    "name": "hackphp/config",
+    "description": "HackPHP Config Access.",
+    "type": "library",
+    "license": "MIT",
+    "autoload": {
+        "psr-4": {
+            "Hackphp\\Config\\": "src/"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Hackphp\\Tests\\Config\\": "tests/"
+        },
+        "files": [
+            "tests/helpers.php"
+        ]
+    },
+    "authors": [
+        {
+            "name": "Mohamed Samir",
+            "email": "gm.mohamedsamir@gmail.com"
+        }
+    ],
+    "minimum-stability": "dev",
+    "require-dev": {
+        "phpunit/phpunit": "9.5.x-dev"
+    },
+    "scripts": {
+        "test": "./vendor/bin/phpunit --do-not-cache-result --testdox"
+    }
+}

phpunit.xml

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<phpunit
+    bootstrap = "vendor/autoload.php"
+    backupGlobals = "false"
+    backupStaticAttributes = "false"
+    colors = "true"
+    convertErrorsToExceptions = "true"
+    convertNoticesToExceptions = "true"
+    convertWarningsToExceptions = "true"
+    processIsolation = "false"
+    stopOnFailure = "false">
+
+    <testsuites>
+        <testsuite name="Test Suite">
+            <directory>tests</directory>
+        </testsuite>
+    </testsuites>
+
+    <php>
+        <env name="APP_ENV" value="testing"/>
+    </php>
+
+</phpunit>

src/Config.php

@@ -0,0 +1,153 @@
+<?php
+
+namespace Hackphp\Config;
+
+use Hackphp\Config\Contracts\Parser;
+
+class Config
+{
+    /**
+     * The parsed config.
+     *
+     * @var array
+     */
+    protected array $config;
+
+    /**
+     * The parsers classes.
+     *
+     * @var Parser[]
+     */
+    protected array $parsers = [];
+
+    /**
+     * Create new Config.
+     *
+     * @param array $config
+     */
+    public function __construct(array $config = [])
+    {
+        $this->config = $config;
+    }
+
+    /**
+     * Add Config Parser.
+     *
+     * @param  Parser $parser
+     * @return $this
+     */
+    public function addParser(Parser $parser)
+    {
+        if (!in_array($parser, $this->parsers)) {
+            $this->parsers[] = $parser;
+        }
+
+        return $this;
+    }
+
+    /**
+     * Load the config loader.
+     *
+     * @return $this
+     */
+    public function load()
+    {
+        foreach ($this->parsers as $parser) {
+            $this->config = array_merge($this->config, $parser->parse());
+        }
+
+        return $this;
+    }
+
+    /**
+     * Get the given config value.
+     *
+     * @param  string $key
+     * @param  mixed|null $default
+     * @return mixed|null
+     */
+    public function get($key, $default = null)
+    {
+        $filtered = $this->config;
+
+        if (isset($filtered[$key])) {
+            return $filtered[$key];
+        }
+
+        $this->catchSearchFile($filtered, $key);
+
+        return $this->getFilteredValue($filtered, $key, $default);
+    }
+
+    /**
+     * Catch the file that has the key we search about it.
+     *
+     * @param  array $filtered
+     * @param  string $key
+     * @return array
+     */
+    private function catchSearchFile(array &$filtered, $key)
+    {
+        return array_reduce(explode(".", $key), function ($carry, $segment) use (&$filtered) {
+            if ($carry != null) {
+                $key = $carry . "." . $segment;
+            } else {
+                $key = $segment;
+            }
+
+            $values = $this->filterStartsWith($filtered, $key);
+
+            if ($values) {
+                $filtered = $values;
+            }
+
+            return $key;
+        });
+    }
+
+    /**
+     * Get the array items that it's key starts with the given name.
+     *
+     * @param  array $haystack
+     * @param  string $name
+     * @return array
+     */
+    private function filterStartsWith(array $haystack, string $name)
+    {
+        $filtered = [];
+
+        foreach ($haystack as $key => $value) {
+            if (strpos($key, $name) === 0) {
+                $filtered[$key] = $value;
+            }
+        }
+
+        return $filtered;
+    }
+
+    /**
+     * Get the given key value from the filtered configs.
+     *
+     * @param  array $filtered
+     * @param  string $key
+     * @param  mixed $default
+     * @return mixed
+     */
+    private function getFilteredValue($filtered, $key, $default)
+    {
+        if (empty($filtered)) {
+            return $default;
+        }
+
+        $file = array_keys($filtered)[0];
+        $filtered = array_values($filtered)[0];
+
+        $key = str_replace($file . ".", "", $key);
+
+        foreach (explode(".", $key) as $segment) {
+            $filtered = $filtered[$segment] ?? $default;
+        }
+
+        return $filtered ?? $default;
+    }
+}

src/Contracts/Parser.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Hackphp\Config\Contracts;
+
+interface Parser
+{
+    /**
+     * Parse the config files.
+     *
+     * @return void
+     */
+    public function parse();
+}

src/Parsers/ArrayParser.php

@@ -0,0 +1,77 @@
+<?php
+
+namespace Hackphp\Config\Parsers;
+
+use Hackphp\Config\Contracts\Parser;
+use Throwable;
+
+class ArrayParser implements Parser
+{
+    /**
+     * The config files directory path.
+     *
+     * @var string
+     */
+    protected string $directory;
+
+    /**
+     * Create new ArrayParser
+     *
+     * @param string $directory The config files directory path.
+     */
+    public function __construct(string $directory)
+    {
+        $this->directory = $directory;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function parse()
+    {
+        $parsed = [];
+
+        $files = $this->getConfigFiles($this->directory);
+
+        foreach ($files as $namespace => $filePath) {
+            try {
+                $parsed[$namespace] = require $filePath;
+            } catch (Throwable $e) {
+                // 
+            }
+        }
+
+        unset($files);
+
+        return $parsed;
+    }
+
+    /**
+     * Get the config files.
+     *
+     * @param  string $dir
+     * @return array
+     */
+    protected function getConfigFiles($dir)
+    {
+        $files = [];
+
+        foreach (getDirFiles($dir) as $file) {
+            $path = $dir . "/" . $file;
+
+            if (is_dir($path)) {
+                $files = array_merge($files, $this->getConfigFiles($path));
+                continue;
+            }
+
+            $configPath = str_replace($this->directory . "/", "", $path);
+
+            $parts = explode("/", $configPath);
+            $parts[count($parts) - 1] = str_replace(".php", "", end($parts));
+
+            $files[implode(".", $parts)] = $path;
+        }
+
+        return $files;
+    }
+}

tests/ConfigTest.php

@@ -0,0 +1,52 @@
+<?php
+
+namespace Hackphp\Config\Tests;
+
+use Hackphp\Config\Config;
+use Hackphp\Config\Parsers\ArrayParser;
+use PHPUnit\Framework\TestCase;
+
+class ConfigTest extends TestCase
+{
+    /** @test */
+    public function it_can_create_instance_with_default_configs()
+    {
+        $config = new Config([
+            "creator" => "Mohamed Samir",
+            "email" => "gm.mohamedsamir@gmail.com"
+        ]);
+
+        $creator = $config->get("creator");
+
+        $this->assertEquals("Mohamed Samir", $creator);
+    }
+
+    /** @test */
+    public function it_loads_and_parse_all_directory_files_successfully()
+    {
+        $parser = new ArrayParser(configPath());
+
+        $config = new Config();
+        $config->addParser($parser);
+        $config->load();
+
+        $value = $config->get("app.name");
+        $this->assertEquals("HackPHP", $value);
+    }
+
+    /** @test */
+    public function it_loads_the_default_value_if_the_key_not_found()
+    {
+        $parser = new ArrayParser(configPath());
+
+        $config = new Config();
+        $config->addParser($parser);
+        $config->load();
+
+        $value = $config->get("app.test");
+        $this->assertNull($value);
+
+        $value = $config->get("app.test", true);
+        $this->assertTrue($value);
+    }
+}