Now you can set and update empty env-variables. Now you can specify external .env-file as the third optional argument. Now you can set the value with equals sign ("="). Added a lot of unit-tests. Added travis-ci integration. composer.json now includes needed laravel components. Fixed compatibility with Laravel 6+.

CaliforniaMountainSnake · CaliforniaMountainSnake · commit bd69615ddc05 · 2020-05-12T20:03:44.000+03:00
diff --git a/.editorconfig b/.editorconfig
@@ -13,3 +13,6 @@ trim_trailing_whitespace = true
 
 [*.md]
 trim_trailing_whitespace = false
+
+[*.{yml,yaml}]
+indent_size = 2
diff --git a/.gitignore b/.gitignore
@@ -1,6 +1,9 @@
-build
-composer.lock
-docs
-vendor
-coverage
-SCRATCH.md
+/.idea/
+/nbproject/
+/build
+/composer.lock
+/docs
+/vendor
+/coverage
+/SCRATCH.md
+/REFACTORING.md
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,38 @@
+language: php
+
+dist: bionic
+
+branches:
+  only:
+    - master
+    - v1.x
+
+cache:
+  directories:
+    - $HOME/.composer/cache
+    - $HOME/.cache
+env:
+  - LARAVEL_VERSION="~5.3"
+  - LARAVEL_VERSION="~5.4"
+  - LARAVEL_VERSION="~5.5"
+  - LARAVEL_VERSION="~5.6"
+  - LARAVEL_VERSION="~5.7"
+  - LARAVEL_VERSION="~5.8"
+  - LARAVEL_VERSION="~6.0"
+  - LARAVEL_VERSION="~7.0"
+
+matrix:
+  include:
+    -   php: 7.1
+    -   php: 7.2
+    -   php: 7.3
+    -   php: 7.4
+
+before_install:
+  - composer self-update
+
+install:
+  - composer require laravel/framework:${LARAVEL_VERSION}
+
+script:
+  - vendor/bin/phpunit --verbose
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,7 +1,30 @@
 # Changelog
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-All notable changes to `laravel-env-set-command` will be documented in this file
+## [Unreleased]
+### Added
+### Changed
+### Deprecated
+### Removed
+### Fixed
+### Security
 
-## 1.0.0 - 2018-07-13
 
+## [1.1.0] - 2020-05-12
+### Added
+- Now you can set and update empty env-variables.
+- Now you can specify external .env-file as the third optional argument.
+- Now you can set the value with equals sign ("=").
+- Added a lot of unit-tests.
+- Added travis-ci integration.
+### Changed
+- composer.json now includes needed laravel components.
+### Fixed
+- Fixed compatibility with Laravel 6+.
+
+## [1.0.0] - 2018-07-13
+### Added
 - Initial release
+
+[1.1.0]: https://github.com/imliam/laravel-env-set-command/compare/1.0.0...1.1.0
diff --git a/composer.json b/composer.json
@@ -20,13 +20,24 @@
         }
     ],
     "require": {
-        "php": "^7.1"
+        "php": "^7.1",
+        "illuminate/support": "*",
+        "illuminate/console": "*"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^7.5",
+        "roave/security-advisories": "dev-master"
     },
     "autoload": {
         "psr-4": {
             "ImLiam\\EnvironmentSetCommand\\": "src"
         }
     },
+    "autoload-dev": {
+        "psr-4": {
+            "Tests\\": "tests/"
+        }
+    },
     "config": {
         "sort-packages": true
     },
diff --git a/phpunit.xml b/phpunit.xml
@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="./vendor/phpunit/phpunit/phpunit.xsd"
+         bootstrap="vendor/autoload.php"
+         colors="true"
+>
+    <testsuites>
+        <testsuite name="Unit">
+            <directory suffix="Test.php">./tests/Unit</directory>
+        </testsuite>
+        <testsuite name="Feature">
+            <directory suffix="Test.php">./tests/Feature</directory>
+        </testsuite>
+    </testsuites>
+    <filter>
+        <whitelist processUncoveredFilesFromWhitelist="true">
+            <directory suffix=".php">./app</directory>
+        </whitelist>
+    </filter>
+    <php>
+        <ini name="display_errors" value="true"/>
+    </php>
+</phpunit>
diff --git a/src/EnvironmentSetCommand.php b/src/EnvironmentSetCommand.php
@@ -2,18 +2,28 @@
 
 namespace ImLiam\EnvironmentSetCommand;
 
+use Illuminate\Console\Command;
+use Illuminate\Support\Facades\App;
 use Illuminate\Support\Str;
 use InvalidArgumentException;
-use Illuminate\Console\Command;
 
 class EnvironmentSetCommand extends Command
 {
+    public const COMMAND_NAME = 'env:set';
+    public const ARGUMENT_KEY = 'key';
+    public const ARGUMENT_VALUE = 'value';
+    public const ARGUMENT_ENV_FILE = 'env_file';
+
     /**
      * The name and signature of the console command.
      *
      * @var string
      */
-    protected $signature = 'env:set {key} {value?}';
+    protected $signature
+        = self::COMMAND_NAME
+        . '{' . self::ARGUMENT_KEY . ' : Key or key=value pair}'
+        . '{' . self::ARGUMENT_VALUE . '? : Value}'
+        . '{' . self::ARGUMENT_ENV_FILE . '? : Optional path to the .env file}';
 
     /**
      * The console command description.
@@ -22,127 +32,139 @@ class EnvironmentSetCommand extends Command
      */
     protected $description = 'Set and save an environment variable in the .env file';
 
-    /**
-     * Create a new command instance.
-     *
-     * @return void
-     */
-    public function __construct()
-    {
-        parent::__construct();
-    }
-
     /**
      * Execute the console command.
-     *
-     * @return mixed
      */
-    public function handle()
+    public function handle(): void
     {
         try {
-            [$key, $value] = $this->getKeyValue();
-        } catch (\InvalidArgumentException $e) {
-            return $this->error($e->getMessage());
+            // Parse key and value arguments.
+            [$key, $value] = $this->parseKeyValueArguments(
+                $this->argument(self::ARGUMENT_KEY),
+                $this->argument(self::ARGUMENT_VALUE)
+            );
+        } catch (InvalidArgumentException $e) {
+            $this->error($e->getMessage());
+            return;
         }
 
-        $envFilePath = app()->environmentFilePath();
-        $contents = file_get_contents($envFilePath);
+        $envFilePath = realpath($this->argument(self::ARGUMENT_ENV_FILE) ?? App::environmentFilePath());
+        $content = file_get_contents($envFilePath);
 
-        if ($oldValue = $this->getOldValue($contents, $key)) {
-            $contents = str_replace("{$oldValue}", "{$key}={$value}", $contents);
-            $this->writeFile($envFilePath, $contents);
-
-            return $this->info("Environment variable with key '{$key}' has been updated to '{$value}'");
+        [$newEnvFileContent, $isNewVariableSet] = $this->setEnvVariable($content, $key, $value);
+        if ($isNewVariableSet) {
+            $this->info("A new environment variable with key '{$key}' has been set to '{$value}'");
+        } else {
+            $this->info("Environment variable with key '{$key}' has been updated to '{$value}'");
         }
 
-        $contents = $contents . "\n{$key}={$value}\n";
-        $this->writeFile($envFilePath, $contents);
-
-        return $this->info("A new environment variable with key '{$key}' has been set to '{$value}'");
+        $this->writeFile($envFilePath, $newEnvFileContent);
     }
 
     /**
-     * Overwrite the contents of a file.
+     * Set or update env-variable.
      *
-     * @param string $path
-     * @param string $contents
-     * @return boolean
+     * @param string $envFileContent Content of the .env file.
+     * @param string $key            Name of the variable.
+     * @param string $value          Value of the variable.
+     *
+     * @return array [string newEnvFileContent, bool isNewVariableSet].
      */
-    protected function writeFile(string $path, string $contents): bool
+    public function setEnvVariable(string $envFileContent, string $key, string $value): array
     {
-        $file = fopen($path, 'w');
-        fwrite($file, $contents);
+        // For existed key.
+        $oldKeyValuePair = $this->readKeyValuePair($envFileContent, $key);
+        if ($oldKeyValuePair !== null) {
+            return [str_replace($oldKeyValuePair, $key . '=' . $value, $envFileContent), false];
+        }
 
-        return fclose($file);
+        // For a new key.
+        return [$envFileContent . "\n" . $key . '=' . $value . "\n", true];
     }
 
     /**
-     * Get the old value of a given key from an environment file.
+     * Read the "key=value" string of a given key from an environment file.
+     * This function returns original "key=value" string and doesn't modify it.
      *
-     * @param string $envFile
+     * @param string $envFileContent
      * @param string $key
-     * @return string
+     *
+     * @return string|null Key=value string or null if the key is not exists.
      */
-    protected function getOldValue(string $envFile, string $key): string
+    public function readKeyValuePair(string $envFileContent, string $key): ?string
     {
         // Match the given key at the beginning of a line
-        preg_match("/^{$key}=[^\r\n]*/m", $envFile, $matches);
-
-        if (count($matches)) {
+        if (preg_match("#^ *{$key} *= *[^\r\n]*$#imu", $envFileContent, $matches)) {
             return $matches[0];
         }
 
-        return '';
+        return null;
     }
 
     /**
      * Determine what the supplied key and value is from the current command.
      *
-     * @return array
+     * @param string      $key
+     * @param string|null $value
+     *
+     * @return string[]
+     * @throws InvalidArgumentException
      */
-    protected function getKeyValue(): array
+    public function parseKeyValueArguments(string $key, ?string $value): array
     {
-        $key = $this->argument('key');
-        $value = $this->argument('value');
-
-        if (! $value) {
+        // Parse "key=value" key argument.
+        if ($value === null) {
             $parts = explode('=', $key, 2);
-
             if (count($parts) !== 2) {
                 $key = $parts[0];
+                $value = '';
             } else {
-                $key = $parts[0];
-                $value = $parts[1];
+                [$key, $value] = $parts;
             }
         }
 
-        if (! $this->isValidKey($key)) {
-            throw new InvalidArgumentException('Invalid argument key');
-        }
+        $this->assertKeyIsValid($key);
 
-        if (! is_bool(strpos($value, ' '))) {
+        // If the value contains spaces but not is not enclosed in quotes.
+        if (preg_match('#^[^\'"].*\s+.*[^\'"]$#um', $value)) {
             $value = '"' . $value . '"';
         }
 
         return [strtoupper($key), $value];
     }
 
     /**
-     * Check if a given string is valid as an environment variable key.
+     * Assert a given string is valid as an environment variable key.
      *
      * @param string $key
-     * @return boolean
+     *
+     * @return bool Is key is valid.
      */
-    protected function isValidKey(string $key): bool
+    public function assertKeyIsValid(string $key): bool
     {
         if (Str::contains($key, '=')) {
-            throw new InvalidArgumentException("Environment key should not contain '='");
+            throw new InvalidArgumentException('Invalid environment key ' . $key
+                . "! Environment key should not contain '='");
         }
 
         if (!preg_match('/^[a-zA-Z_]+$/', $key)) {
-            throw new InvalidArgumentException('Invalid environment key. Only use letters and underscores');
+            throw new InvalidArgumentException('Invalid environment key ' . $key
+                . '! Only use letters and underscores');
         }
 
         return true;
     }
+
+    /**
+     * Overwrite the contents of a file.
+     *
+     * @param string $path
+     * @param string $contents
+     *
+     * @return boolean
+     */
+    protected function writeFile(string $path, string $contents): bool
+    {
+        return (bool)file_put_contents($path, $contents, LOCK_EX);
+    }
 }
diff --git a/src/EnvironmentSetCommandServiceProvider.php b/src/EnvironmentSetCommandServiceProvider.php
@@ -9,15 +9,15 @@ class EnvironmentSetCommandServiceProvider extends ServiceProvider
     /**
      * Bootstrap the application services.
      */
-    public function boot()
+    public function boot(): void
     {
         // ...
     }
 
     /**
      * Register the application services.
      */
-    public function register()
+    public function register(): void
     {
         $this->app->bind('command.env:set', EnvironmentSetCommand::class);
 
diff --git a/tests/ReflectionHelper.php b/tests/ReflectionHelper.php
diff --git a/tests/Unit/EnvironmentSetCommandTest.php b/tests/Unit/EnvironmentSetCommandTest.php

Original file line number	Diff line number	Diff line change
`@@ -9,15 +9,15 @@ class EnvironmentSetCommandServiceProvider extends ServiceProvider`
`9`	`9`	`/**`
`10`	`10`	`* Bootstrap the application services.`
`11`	`11`	`*/`
`12`		`- public function boot()`
	`12`	`+ public function boot(): void`
`13`	`13`	`{`
`14`	`14`	`// ...`
`15`	`15`	`}`
`16`	`16`
`17`	`17`	`/**`
`18`	`18`	`* Register the application services.`
`19`	`19`	`*/`
`20`		`- public function register()`
	`20`	`+ public function register(): void`
`21`	`21`	`{`
`22`	`22`	`$this->app->bind('command.env:set', EnvironmentSetCommand::class);`
`23`	`23`