updated

Author: phossa

.codeclimate.yml

@@ -0,0 +1,30 @@
+---
+engines:
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - javascript
+      - php
+  eslint:
+    enabled: true
+  fixme:
+    enabled: true
+  phpmd:
+    enabled: true
+    checks:
+      Naming/ShortVariable:
+        enabled: false
+      CleanCode/ElseExpression:
+        enabled: false
+      CleanCode/BooleanArgumentFlag:
+        enabled: false
+      CleanCode/StaticAccess:
+        enabled: false
+ratings:
+  paths:
+  - "**.js"
+  - "**.php"
+exclude_paths:
+  - tests/
+  - build/

.editorconfig

@@ -0,0 +1,16 @@
+# More info at http://editorconfig.org
+
+# top-most editorconfig file
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+indent_size = 2
+trim_trailing_whitespace = false

.gitattributes

@@ -0,0 +1,15 @@
+# Path-based git attributes
+# https://www.kernel.org/pub/software/scm/git/docs/gitattributes.html
+
+# Ignore all test and documentation with "export-ignore".
+/.gitattributes     export-ignore
+/.gitignore         export-ignore
+/.travis.yml        export-ignore
+/phpunit.xml.dist   export-ignore
+/.scrutinizer.yml   export-ignore
+/.codeclimate.yml   export-ignore
+/.editorconfig      export-ignore
+/tests              export-ignore
+/build              export-ignore
+.gitkeep            export-ignore
+.phpunit.result.cache export-ignore

.gitignore

@@ -0,0 +1,11 @@
+# git stuff
+.git
+
+# composer files
+composer.phar
+composer.lock
+vendor
+
+# phpunit files
+phpunit.phar
+.phpunit.result.cache

.scrutinizer.yml

@@ -0,0 +1,18 @@
+filter:
+    excluded_paths: [tests/*]
+
+checks:
+    php:
+        code_rating: true
+        remove_extra_empty_lines: true
+        remove_php_closing_tag: true
+        remove_trailing_whitespace: true
+        fix_use_statements:
+            remove_unused: true
+            preserve_multiple: false
+            preserve_blanklines: true
+        fix_php_opening_tag: true
+        fix_linefeed: true
+        fix_line_ending: true
+        fix_identation_4spaces: true
+        fix_doc_comments: true

.travis.yml

@@ -0,0 +1,9 @@
+language: php
+
+php:
+  - 7.2
+
+before_script:
+  - composer self-update
+  - composer update nothing
+  - composer --prefer-source --dev install

README.md

@@ -1,2 +1,9 @@
 # config
-Configuration package for Phoole
+[![Build Status](https://travis-ci.com/phoole/config.svg?branch=master)](https://travis-ci.com/phoole/config)
+[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/phoole/config/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/phoole/config/?branch=master)
+[![Code Climate](https://codeclimate.com/github/phoole/config/badges/gpa.svg)](https://codeclimate.com/github/phoole/config)
+[![PHP 7](https://img.shields.io/packagist/php-v/phoole/config)](https://packagist.org/packages/phoole/config)
+[![Latest Stable Version](https://img.shields.io/github/v/release/phoole/config)](https://packagist.org/packages/phoole/config)
+[![License](https://img.shields.io/github/license/phoole/config)]()
+
+A slim and fast configuration loader lib using PHP, JSON, YAML files

composer.json

@@ -0,0 +1,36 @@
+{
+    "name": "phoole/config",
+    "type": "library",
+    "license": "Apache-2.0",
+    "version": "1.0.0",
+    "description": "Config library for Phoole",
+    "keywords": ["phoole", "library", "php", "config"],
+    "authors": [
+        {
+            "name": "Hong Zhang",
+            "homepage": "https://github.com/phoole"
+        }
+    ],
+    "require": {
+        "php": ">=7.2.0",
+        "phoole/base": "~1.0.6"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^8"
+    },
+    "autoload": {
+        "psr-4": {
+            "Phoole\\Config\\": "src/"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Phoole\\Tests\\": "tests/"
+        }
+    },
+    "scripts": {
+        "test": "phpunit",
+        "check": "phpcs --standard=psr12 src/",
+        "format": "phpcbf --standard=psr12 src/"
+    }
+}

phpunit.xml

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit backupGlobals="false"
+         backupStaticAttributes="false"
+         colors="true"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true"
+         processIsolation="false"
+         stopOnFailure="false"
+         bootstrap="vendor/autoload.php"
+>
+    <testsuites>
+        <testsuite name="test suite">
+            <directory>./tests/</directory>
+        </testsuite>
+    </testsuites>
+</phpunit>

src/Config.php

@@ -0,0 +1,21 @@
+<?php
+
+/**
+ * Phoole (PHP7.2+)
+ *
+ * @category  Library
+ * @package   Phoole\Config
+ * @copyright Copyright (c) 2019 Hong Zhang
+ */
+declare(strict_types=1);
+
+namespace Phoole\Config;
+
+/**
+ * Config
+ *
+ * @package Phoole\Config
+ */
+class Config implements ConfigInterface
+{
+}

src/ConfigInterface.php

@@ -0,0 +1,55 @@
+<?php
+
+/**
+ * Phoole (PHP7.2+)
+ *
+ * @category  Library
+ * @package   Phoole\Config
+ * @copyright Copyright (c) 2019 Hong Zhang
+ */
+declare(strict_types=1);
+
+namespace Phoole\Config;
+
+/**
+ * ConfigInterface
+ *
+ * @package Phoole\Config
+ */
+interface ConfigInterface
+{
+    /**
+     * Get a configure value. NUll return if not found
+     *
+     * If you want a default value,
+     * ```php
+     * $user = $conf->get('user) ?? 'dummy';
+     * ```
+     *
+     * @param  string $id
+     * @return mixed
+     */
+    public function get(string $id);
+
+    /**
+     * Has a configure key
+     *
+     * @param  string $id
+     * @return bool
+     */
+    public function has(string $id): bool;
+
+    /**
+     * Config object is supposed to be IMMUTABLE once created.
+     *
+     * Set new value will return a new copy
+     * ```php
+     * $newconf = $conf->with('db.user', 'system');
+     * ```
+     *
+     * @param  string $id
+     * @param  mixed  $value
+     * @return ConfigInterface
+     */
+    public function with(string $id, $value): ConfigInterface;
+}

src/Loader/LoaderInterface.php

@@ -0,0 +1,37 @@
+<?php
+
+/**
+ * Phoole (PHP7.2+)
+ *
+ * @category  Library
+ * @package   Phoole\Config
+ * @copyright Copyright (c) 2019 Hong Zhang
+ */
+declare(strict_types=1);
+
+namespace Phoole\Config\Loader;
+
+/**
+ * LoaderInterface
+ *
+ * @package Phoole\Config
+ */
+interface LoaderInterface
+{
+    /**
+     * Load group(specific) config(s) base on environment value.
+     *
+     * - if $environment == '', use the default environment
+     * - if $group == '', load all avaiable groups
+     *
+     * ```php
+     * $this->load('db');
+     * $this->load('db', 'production/host1');
+     * ```
+     *
+     * @param  string $group
+     * @param  string $environment
+     * @return array
+     */
+    public function load(string $group, string $environment = ''): array;
+}