Changed the principle of collecting keys

Author: Andrey Helldar

.github/images/compare.png

@@ -14,11 +14,6 @@
 [![Total Downloads][badge_downloads]][link_packagist]
 [![License][badge_license]][link_license]
 
-> What is he doing?
-> In the current implementation, the package copies the `.env` file with the environment settings to the `.env.example` file and hides the private data.
->
-> Soon, the file compilation algorithm will be slightly different.
-
 ## Table of contents
 
 * [Installation](#installation)
@@ -40,13 +35,17 @@ Or manually update `require-dev` block of `composer.json` and run `composer upda
 ```json
 {
     "require-dev": {
-        "andrey-helldar/env-sync": "^1.0"
+        "andrey-helldar/env-sync": "^1.2"
     }
 }
 ```
 
 ## How to use
 
+> Note
+> This package scans files with `*.php`, `*.json`, `*.yml`, `*.yaml` and `*.twig` extensions in the specified folder, receiving from them calls to the `env` and `getenv` functions.
+> Based on the received values, the package creates a key-value array. When saving, the keys are split into blocks by the first word before the `_` character.
+
 ### Laravel / Lumen Frameworks
 
 Just execute the `php artisan env:sync` command.
@@ -65,7 +64,7 @@ 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:
+If you want to force the stored values, you can change the configuration file by publishing it with the command:
 
 ```bash
 php artisan vendor:publish --provider="Helldar\EnvSync\ServiceProvider"
@@ -79,31 +78,29 @@ To call a command in your application, you need to do the following:
 
 ```php
 use Helldar\EnvSync\Services\Compiler;
+use Helldar\EnvSync\Services\Finder;
 use Helldar\EnvSync\Services\Parser;
 use Helldar\EnvSync\Services\Stringify;
 use Helldar\EnvSync\Services\Syncer;
 use Helldar\EnvSync\Support\Config;
+use Symfony\Component\Finder\Finder as SymfonyFinder;
 
 protected function syncer(): Syncer
 {
     $parser    = new Parser();
     $stringify = new Stringify();
     $config    = new Config();
     $compiler  = new Compiler($stringify, $config);
+    $finder    = new Finder(SymfonyFinder::create());
 
-    return new Syncer($parser, $compiler);
+    return new Syncer($parser, $compiler, $finder);
 }
 
 protected function sync()
 {
-    // $this->syncer()
-    //    ->from('/** path to .env file */')
-    //    ->to('/** path to .env.example file */')
-    //    ->store();
-
     $this->syncer()
-       ->from(__DIR__ . '/../.env')
-       ->to(__DIR__ . '/../.env.example')
+       ->path(__DIR__)
+       ->filename('.env.example')
        ->store();
 }
 ```
@@ -112,19 +109,22 @@ If you want to define default values or specify which key values should be store
 
 ```php
 use Helldar\EnvSync\Services\Compiler;
+use Helldar\EnvSync\Services\Finder;
 use Helldar\EnvSync\Services\Parser;
 use Helldar\EnvSync\Services\Stringify;
 use Helldar\EnvSync\Services\Syncer;
 use Helldar\EnvSync\Support\Config;
+use Symfony\Component\Finder\Finder as SymfonyFinder;
 
 protected function syncer(): Syncer
 {
     $parser    = new Parser();
     $stringify = new Stringify();
     $config    = new Config($this->config());
     $compiler  = new Compiler($stringify, $config);
+    $finder    = new Finder(SymfonyFinder::create());
 
-    return new Syncer($parser, $compiler);
+    return new Syncer($parser, $compiler, $finder);
 }
 
 protected function config(): array
@@ -133,12 +133,6 @@ protected function config(): array
 }
 ```
 
-### Example
-
-<p align="center">
-    <img src="/.github/images/compare.png?raw=true" alt="Example"/>
-</p>
-
 You can also suggest your implementation by sending a PR. We will be glad 😊
 
 [badge_build]:          https://img.shields.io/github/workflow/status/andrey-helldar/env-sync/native?style=flat-square

README.md

@@ -16,7 +16,8 @@
     },
     "require": {
         "php": "^7.3|^8.0",
-        "andrey-helldar/support": "^2.5"
+        "andrey-helldar/support": "^2.5",
+        "symfony/finder": "^4.0|^5.0"
     },
     "require-dev": {
         "mockery/mockery": "^1.3.1",
@@ -42,7 +43,7 @@
     "extra": {
         "laravel": {
             "providers": [
-                "Helldar\\EnvSync\\ServiceProvider"
+                "Helldar\\EnvSync\\Frameworks\\Laravel\\ServiceProvider"
             ]
         }
     }

composer.json

@@ -1,16 +1,13 @@
 <?php
 
 return [
-    'keep' => [
-        'APP_NAME',
-    ],
-
     'forces' => [
         'APP_ENV'   => 'production',
         'APP_DEBUG' => false,
         'APP_URL'   => 'http://localhost',
 
         'LOG_CHANNEL' => 'daily',
+        'LOG_LEVEL'   => 'debug',
 
         'DB_CONNECTION' => 'mysql',
         'DB_HOST'       => '127.0.0.1',

config/env-sync.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace Helldar\EnvSync\Frameworks\Laravel\Console;
+
+use Helldar\EnvSync\Services\Syncer;
+use Illuminate\Console\Command;
+
+final class Sync extends Command
+{
+    protected $signature = 'env:sync {--path=}';
+
+    protected $description = 'Synchronizing environment settings with a preset.';
+
+    public function handle(Syncer $syncer)
+    {
+        $syncer
+            ->path($this->path())
+            ->filename($this->filename())
+            ->store();
+    }
+
+    protected function path(): string
+    {
+        return $this->optionPath() ?: $this->realPath();
+    }
+
+    protected function filename(): string
+    {
+        return '.env.example';
+    }
+
+    protected function optionPath(): ?string
+    {
+        return $this->option('path');
+    }
+
+    protected function realPath(): string
+    {
+        return realpath(base_path());
+    }
+}

src/Console/Sync.php

@@ -1,13 +1,15 @@
 <?php
 
-namespace Helldar\EnvSync;
+namespace Helldar\EnvSync\Frameworks\Laravel;
 
-use Helldar\EnvSync\Console\Sync;
+use Helldar\EnvSync\Frameworks\Laravel\Console\Sync;
 use Helldar\EnvSync\Support\Config;
 use Illuminate\Support\ServiceProvider as BaseServiceProvider;
 
 final class ServiceProvider extends BaseServiceProvider
 {
+    protected $config_path = __DIR__ . '/../../../config/env-sync.php';
+
     public function register()
     {
         $this->registerCommands();
@@ -26,7 +28,7 @@ protected function registerCommands(): void
 
     protected function registerConfig(): void
     {
-        $this->mergeConfigFrom(__DIR__ . '/../config/env-sync.php', 'env-sync');
+        $this->mergeConfigFrom($this->config_path, 'env-sync');
 
         $this->app->singleton(Config::class, static function ($app) {
             return new Config($app['config']->get('env-sync'));
@@ -36,7 +38,7 @@ protected function registerConfig(): void
     protected function bootConfig(): void
     {
         $this->publishes([
-            __DIR__ . '/../config/env-sync.php' => $this->app->configPath('env-sync.php'),
+            $this->config_path => $this->app->configPath('env-sync.php'),
         ], 'config');
     }
 }

src/Frameworks/Laravel/Console/Sync.php

@@ -32,83 +32,84 @@ public function items(array $items): self
 
     public function get(): string
     {
-        foreach ($this->items as $key => &$value) {
-            if ($this->isEmptyRow($key, $value)) {
-                continue;
-            }
+        $this->map();
+        $this->split();
+
+        return $this->compile();
+    }
 
+    protected function map(): void
+    {
+        foreach ($this->items as $key => &$value) {
             $replaced = $this->replace($key, $value);
 
             $value = $this->stringify($replaced);
         }
-
-        return $this->compile();
     }
 
-    protected function replace(string $key, $value)
+    protected function split(): void
     {
-        switch (true) {
-            case $this->isForceHiding($key):
-                return null;
+        $items = [];
 
-            case $this->isKeeping($key):
-                return $value;
+        foreach ($this->items as $key => $value) {
+            $section = $this->section($key);
 
-            default:
-                return $this->value($key);
+            $items[$section][$key] = $value;
         }
-    }
 
-    protected function isKeeping(string $key): bool
-    {
-        return $this->inArray($key, $this->config->keep());
+        $this->items = $items;
     }
 
-    protected function isForceHiding(string $key): bool
+    protected function compile(): string
     {
-        return $this->inArray($key, $this->hides);
-    }
+        $result = '';
 
-    protected function value(string $key)
-    {
-        foreach ($this->config->forces() as $forced_key => $value) {
-            if (Str::endsWith($key, $forced_key)) {
-                return $value;
+        foreach ($this->items as $values) {
+            ksort($values);
+
+            foreach ($values as $key => $value) {
+                $result .= "{$key}={$value}{$this->separator}";
             }
+
+            $result .= $this->separator;
         }
 
-        return null;
+        return trim($result) . $this->separator;
     }
 
-    protected function stringify($value): string
+    protected function replace(string $key, $value)
     {
-        return $this->stringify->get($value);
+        return $this->isForceHiding($key) ? null : $this->value($key, $value);
     }
 
-    protected function compile(): string
+    protected function isForceHiding(string $key): bool
     {
-        $result = [];
-
-        foreach ($this->items as $key => $value) {
-            if ($this->isEmptyRow($key, $value)) {
-                $result[] = '';
+        return $this->inArray($key, $this->hides);
+    }
 
-                continue;
+    protected function value(string $key, $value)
+    {
+        foreach ($this->config->forces() as $force_key => $force_value) {
+            if (Str::contains($key, $force_key)) {
+                return $force_value;
             }
-
-            $result[] = $key . '=' . $value;
         }
 
-        return implode($this->separator, $result);
+        return $value;
     }
 
-    protected function isEmptyRow($key, $value): bool
+    protected function stringify($value): string
     {
-        return is_numeric($key) && empty($value);
+        return $this->stringify->get($value);
     }
 
     protected function inArray(string $key, array $array): bool
     {
         return Str::contains($key, $array);
     }
+
+    protected function section(string $key): string
+    {
+        return explode('_', $key, 2)[0];
+    }
 }