Implemented "soft" configuration

Author: Andrey Helldar

README.md

@@ -60,6 +60,14 @@ You can also specify the invocation when executing the `composer update` command
 
 Now, every time you run the `composer update` command, the environment settings file will be synchronized.
 
+If you want to define default values or specify which key values should be saved, publish the configuration file by running the artisan command:
+
+```bash
+php artisan vendor:publish --provider="Helldar\EnvSync\ServiceProvider"
+```
+
+Now you can change the file `config/env-sync.php`.
+
 ### Other using
 
 To call a command in your application, you need to do the following:
@@ -69,12 +77,14 @@ use Helldar\EnvSync\Services\Compiler;
 use Helldar\EnvSync\Services\Parser;
 use Helldar\EnvSync\Services\Stringify;
 use Helldar\EnvSync\Services\Syncer;
+use Helldar\EnvSync\Support\Config;
 
 protected function syncer(): Syncer
 {
     $parser    = new Parser();
     $stringify = new Stringify();
-    $compiler  = new Compiler($stringify);
+    $config    = new Config();
+    $compiler  = new Compiler($stringify, $config);
 
     return new Syncer($parser, $compiler);
 }
@@ -93,6 +103,31 @@ protected function sync()
 }
 ```
 
+If you want to define default values or specify which key values should be stored, you need to pass an array to the constructor of the `Config` class:
+
+```php
+use Helldar\EnvSync\Services\Compiler;
+use Helldar\EnvSync\Services\Parser;
+use Helldar\EnvSync\Services\Stringify;
+use Helldar\EnvSync\Services\Syncer;
+use Helldar\EnvSync\Support\Config;
+
+protected function syncer(): Syncer
+{
+    $parser    = new Parser();
+    $stringify = new Stringify();
+    $config    = new Config($this->config());
+    $compiler  = new Compiler($stringify, $config);
+
+    return new Syncer($parser, $compiler);
+}
+
+protected function config(): array
+{
+    return require realpath(__DIR__ . '/your-path/your-config.php');
+}
+```
+
 ### Example
 
 <p align="center">

config/env-sync.php

@@ -0,0 +1,33 @@
+<?php
+
+return [
+    'keep' => [
+        'APP_NAME',
+    ],
+
+    'forces' => [
+        'APP_ENV'   => 'production',
+        'APP_DEBUG' => false,
+        'APP_URL'   => 'http://localhost',
+
+        'LOG_CHANNEL' => 'daily',
+
+        'DB_CONNECTION' => 'mysql',
+        'DB_HOST'       => '127.0.0.1',
+        'DB_PORT'       => 3306,
+        'DB_DATABASE'   => 'default',
+
+        'BROADCAST_DRIVER' => 'redis',
+        'CACHE_DRIVER'     => 'redis',
+        'QUEUE_CONNECTION' => 'redis',
+        'SESSION_DRIVER'   => 'redis',
+        'SESSION_LIFETIME' => 120,
+
+        'REDIS_HOST' => '127.0.0.1',
+        'REDIS_PORT' => 6379,
+
+        'MAIL_MAILER' => 'smtp',
+        'MAIL_HOST'   => 'mailhog',
+        'MAIL_PORT'   => 1025,
+    ],
+];

src/ServiceProvider.php

@@ -3,6 +3,7 @@
 namespace Helldar\EnvSync;
 
 use Helldar\EnvSync\Console\Sync;
+use Helldar\EnvSync\Support\Config;
 use Illuminate\Support\ServiceProvider as BaseServiceProvider;
 
 final class ServiceProvider extends BaseServiceProvider
@@ -12,8 +13,29 @@ public function register()
         $this->registerCommands();
     }
 
+    public function boot()
+    {
+        $this->bootConfig();
+    }
+
     protected function registerCommands(): void
     {
         $this->commands(Sync::class);
     }
+
+    protected function registerConfig(): void
+    {
+        $this->mergeConfigFrom(__DIR__ . '/../config/env-sync.php', 'env-sync');
+
+        $this->app->singleton(Config::class, static function ($app) {
+            return new Config($app['config']->get('env-sync'));
+        });
+    }
+
+    protected function bootConfig(): void
+    {
+        $this->publishes([
+            __DIR__ . '/../config/env-sync.php' => $this->app->configPath('env-sync.php'),
+        ], 'config');
+    }
 }

src/Services/Compiler.php

@@ -2,47 +2,23 @@
 
 namespace Helldar\EnvSync\Services;
 
+use Helldar\EnvSync\Support\Config;
 use Helldar\Support\Facades\Helpers\Str;
 
 final class Compiler
 {
-    protected $keeping = ['APP_NAME'];
-
-    protected $forces = [
-        'APP_ENV'   => 'production',
-        'APP_DEBUG' => false,
-        'APP_URL'   => 'http://localhost',
-
-        'LOG_CHANNEL' => 'daily',
-
-        'DB_CONNECTION' => 'mysql',
-        'DB_HOST'       => '127.0.0.1',
-        'DB_PORT'       => 3306,
-        'DB_DATABASE'   => 'default',
-
-        'BROADCAST_DRIVER' => 'redis',
-        'CACHE_DRIVER'     => 'redis',
-        'QUEUE_CONNECTION' => 'redis',
-        'SESSION_DRIVER'   => 'redis',
-        'SESSION_LIFETIME' => 120,
-
-        'REDIS_HOST' => '127.0.0.1',
-        'REDIS_PORT' => 6379,
-
-        'MAIL_MAILER' => 'smtp',
-        'MAIL_HOST'   => 'mailhog',
-        'MAIL_PORT'   => 1025,
-    ];
-
     protected $separator = "\n";
 
     protected $stringify;
 
+    protected $config;
+
     protected $items;
 
-    public function __construct(Stringify $stringify)
+    public function __construct(Stringify $stringify, Config $config)
     {
         $this->stringify = $stringify;
+        $this->config    = $config;
     }
 
     public function items(array $items): self
@@ -78,12 +54,12 @@ protected function replace(string $key, $value)
 
     protected function isKeeping(string $key): bool
     {
-        return in_array($key, $this->keeping);
+        return in_array($key, $this->config->keep());
     }
 
     protected function value(string $key)
     {
-        foreach ($this->forces as $forced_key => $value) {
+        foreach ($this->config->forces() as $forced_key => $value) {
             if (Str::endsWith($key, $forced_key)) {
                 return $value;
             }

src/Support/Config.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace Helldar\EnvSync\Support;
+
+final class Config
+{
+    /** @var array */
+    protected $config;
+
+    public function __construct(array $config = null)
+    {
+        $this->config = $config ?: $this->load();
+    }
+
+    public function keep(): array
+    {
+        return $this->get('keep', []);
+    }
+
+    public function forces(): array
+    {
+        return $this->get('forces', []);
+    }
+
+    protected function get(string $key, $default = null)
+    {
+        return $this->config[$key] ?? $default;
+    }
+
+    protected function load(): array
+    {
+        return require realpath(__DIR__ . '/../../config/env-sync.php');
+    }
+}

tests/Concerns/Files.php

@@ -9,9 +9,11 @@ protected function source(): string
         return $this->fixtures('source');
     }
 
-    protected function expected(): string
+    protected function expected(bool $config = false): string
     {
-        return $this->fixtures('expected');
+        $filename = $config ? 'expected-config' : 'expected';
+
+        return $this->fixtures($filename);
     }
 
     protected function actual(): string

tests/Other/ConfigurableTest.php

@@ -0,0 +1,50 @@
+<?php
+
+namespace Tests\Other;
+
+use Helldar\EnvSync\Services\Compiler;
+use Helldar\EnvSync\Services\Parser;
+use Helldar\EnvSync\Services\Stringify;
+use Helldar\EnvSync\Services\Syncer;
+use Helldar\EnvSync\Support\Config;
+use Tests\Cases\OtherTestCase;
+
+final class ConfigurableTest extends OtherTestCase
+{
+    public function testContent()
+    {
+        $service = $this->service();
+
+        $service->from($this->source());
+
+        $this->assertStringEqualsFile($this->expected(true), $service->cleaned());
+    }
+
+    public function testStoring()
+    {
+        $service = $this->service();
+
+        $service->from($this->source());
+        $service->to($this->actual());
+
+        $service->store();
+
+        $this->assertFileExists($this->actual());
+        $this->assertFileEquals($this->expected(true), $this->actual());
+    }
+
+    protected function service(): Syncer
+    {
+        $parser    = new Parser();
+        $stringify = new Stringify();
+        $config    = new Config($this->config());
+        $compiler  = new Compiler($stringify, $config);
+
+        return new Syncer($parser, $compiler);
+    }
+
+    protected function config(): array
+    {
+        return require realpath(__DIR__ . '/../fixtures/config.php');
+    }
+}

tests/Other/OtherTest.php

@@ -6,6 +6,7 @@
 use Helldar\EnvSync\Services\Parser;
 use Helldar\EnvSync\Services\Stringify;
 use Helldar\EnvSync\Services\Syncer;
+use Helldar\EnvSync\Support\Config;
 use Tests\Cases\OtherTestCase;
 
 final class OtherTest extends OtherTestCase
@@ -36,7 +37,8 @@ protected function service(): Syncer
     {
         $parser    = new Parser();
         $stringify = new Stringify();
-        $compiler  = new Compiler($stringify);
+        $config    = new Config();
+        $compiler  = new Compiler($stringify, $config);
 
         return new Syncer($parser, $compiler);
     }

tests/fixtures/config.php

@@ -0,0 +1,9 @@
+<?php
+
+return [
+    'keep' => ['APP_ENV', 'LOG_CHANNEL'],
+
+    'forces' => [
+        'DB_HOST' => 'foo',
+    ],
+];

tests/fixtures/expected-config

@@ -0,0 +1,48 @@
+APP_NAME=null
+APP_ENV=local
+APP_KEY=null
+APP_DEBUG=null
+APP_URL=null
+
+LOG_CHANNEL=stack
+
+DB_CONNECTION=null
+DB_HOST=foo
+DB_PORT=null
+DB_DATABASE=null
+DB_USERNAME=null
+DB_PASSWORD=null
+
+AUDITS_DB_CONNECTION=null
+AUDITS_DB_HOST=foo
+AUDITS_DB_PORT=null
+AUDITS_DB_DATABASE=null
+AUDITS_DB_USERNAME=null
+AUDITS_DB_PASSWORD=null
+
+BROADCAST_DRIVER=null
+CACHE_DRIVER=null
+QUEUE_CONNECTION=null
+SESSION_DRIVER=null
+SESSION_LIFETIME=null
+
+REDIS_HOST=null
+REDIS_PASSWORD=null
+REDIS_PORT=null
+
+MAIL_MAILER=null
+MAIL_HOST=null
+MAIL_PORT=null
+MAIL_USERNAME=null
+MAIL_PASSWORD=null
+MAIL_ENCRYPTION=null
+MAIL_FROM_ADDRESS=null
+MAIL_FROM_NAME=null
+
+GIT_WEBHOOK_SECRET=null
+
+GITHUB_CLIENT_ID=null
+GITHUB_CLIENT_SECRET=null
+
+FOO_ONE=null
+FOO_TWO=null