Added the command description. Added Travis CI build status badge. Added support for using en external .env file when using "key=value" syntax. Merged with upstream/master.

CaliforniaMountainSnake · CaliforniaMountainSnake · commit cf37d1ffc583 · 2020-05-13T15:44:54.000+03:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -11,6 +11,14 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ### Security
 
 
+## [1.1.4] - 2020-05-13
+### Added
+- Added the command description.
+- Added Travis CI build status badge.
+- Added support for using en external `.env` file when using "key=value" syntax.
+### Changed
+- Merged with upstream/master.
+
 ## [1.1.3] - 2020-05-12
 ### Security
 - roave/security-advisories finds laravel 5.3/5.4 not safe, so it is removed from the travis-ci config.
@@ -39,6 +47,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ### Added
 - Initial release
 
+[1.1.4]: https://github.com/imliam/laravel-env-set-command/compare/1.1.3...1.1.4
 [1.1.3]: https://github.com/imliam/laravel-env-set-command/compare/1.1.2...1.1.3
 [1.1.2]: https://github.com/imliam/laravel-env-set-command/compare/1.1.1...1.1.2
 [1.1.1]: https://github.com/imliam/laravel-env-set-command/compare/1.1.0...1.1.1
diff --git a/README.md b/README.md
@@ -3,6 +3,7 @@
 [![Latest Version on Packagist](https://img.shields.io/packagist/v/imliam/laravel-env-set-command.svg)](https://packagist.org/packages/imliam/laravel-env-set-command)
 [![Total Downloads](https://img.shields.io/packagist/dt/imliam/laravel-env-set-command.svg)](https://packagist.org/packages/imliam/laravel-env-set-command)
 [![License](https://img.shields.io/github/license/imliam/laravel-env-set-command.svg)](LICENSE.md)
+[![Build Status](https://travis-ci.com/imliam/laravel-env-set-command.svg?branch=master)](https://travis-ci.com/imliam/laravel-env-set-command)
 
 Set a .env file variable from the command line.
 
@@ -64,6 +65,19 @@ $ php artisan env:set @pp_n@me Laravel
 # Invalid environment key. Only use letters and underscores
 ```
 
+You can specify the external `.env` file in the third optional argument.
+
+```bash
+$ php artisan env:set APP_NAME TestApp /var/www/my_own_env.env
+# Environment variable with key 'APP_NAME' has been changed from 'Laravel' to 'TestApp'
+```
+
+Or in the second parameter if you use key=value syntax.
+```bash
+$ php artisan env:set APP_NAME=TestApp /var/www/my_own_env.env
+# Environment variable with key 'APP_NAME' has been changed from 'Laravel' to 'TestApp'
+```
+
 ## Changelog
 
 Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
diff --git a/src/EnvironmentSetCommand.php b/src/EnvironmentSetCommand.php
@@ -21,9 +21,9 @@ class EnvironmentSetCommand extends Command
      */
     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}';
+        . ' {' . 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.
@@ -39,19 +39,23 @@ public function handle(): void
     {
         try {
             // Parse key and value arguments.
-            [$key, $value] = $this->parseKeyValueArguments(
+            [$key, $value, $envFilePath] = $this->parseCommandArguments(
                 $this->argument(self::ARGUMENT_KEY),
-                $this->argument(self::ARGUMENT_VALUE)
+                $this->argument(self::ARGUMENT_VALUE),
+                $this->argument(self::ARGUMENT_ENV_FILE)
             );
+
+            // Use system env file path if the argument env file path is not provided.
+            $envFilePath = $envFilePath ?? App::environmentFilePath();
+            $this->info("The following environment file is used: '" . $envFilePath . "'");
         } catch (InvalidArgumentException $e) {
             $this->error($e->getMessage());
             return;
         }
 
-        $envFilePath = realpath($this->argument(self::ARGUMENT_ENV_FILE) ?? App::environmentFilePath());
         $content = file_get_contents($envFilePath);
-
         [$newEnvFileContent, $isNewVariableSet] = $this->setEnvVariable($content, $key, $value);
+
         if ($isNewVariableSet) {
             $this->info("A new environment variable with key '{$key}' has been set to '{$value}'");
         } else {
@@ -102,25 +106,36 @@ public function readKeyValuePair(string $envFileContent, string $key): ?string
     }
 
     /**
-     * Determine what the supplied key and value is from the current command.
+     * Parse key, value and path to .env-file from command line arguments.
      *
-     * @param string      $key
-     * @param string|null $value
+     * @param string      $_key
+     * @param string|null $_value
+     * @param string|null $_envFilePath
      *
-     * @return string[]
-     * @throws InvalidArgumentException
+     * @return string[] [string KEY, string value, ?string envFilePath].
      */
-    public function parseKeyValueArguments(string $key, ?string $value): array
+    public function parseCommandArguments(string $_key, ?string $_value, ?string $_envFilePath): array
     {
+        $key = null;
+        $value = null;
+        $envFilePath = null;
+
         // Parse "key=value" key argument.
-        if ($value === null) {
-            $parts = explode('=', $key, 2);
-            if (count($parts) !== 2) {
-                $key = $parts[0];
-                $value = '';
-            } else {
-                [$key, $value] = $parts;
+        if (preg_match('#^([^=]+)=(.*)$#umu', $_key, $matches)) {
+            [1 => $key, 2 => $value] = $matches;
+
+            // Use second argument as path to env file:
+            if ($_value !== null) {
+                $envFilePath = $_value;
             }
+        } else {
+            $key = $_key;
+            $value = $_value;
+        }
+
+        // If the path to env file is not set, use third argument or return null (default system path).
+        if ($envFilePath === null) {
+            $envFilePath = $_envFilePath;
         }
 
         $this->assertKeyIsValid($key);
@@ -130,7 +145,7 @@ public function parseKeyValueArguments(string $key, ?string $value): array
             $value = '"' . $value . '"';
         }
 
-        return [strtoupper($key), $value];
+        return [strtoupper($key), $value, ($envFilePath === null ? null : realpath($envFilePath))];
     }
 
     /**
diff --git a/tests/Unit/EnvironmentSetCommandTest.php b/tests/Unit/EnvironmentSetCommandTest.php
@@ -57,15 +57,15 @@ public function testReadKeyValuePair(string $envFileContent, string $key, ?strin
     }
 
     /**
-     * @covers       EnvironmentSetCommand::parseKeyValueArguments
+     * @covers       EnvironmentSetCommand::parseCommandArguments
      * @dataProvider parseKeyValueArgumentsDataProvider
      *
      * @param array $params
      * @param array $expectedResult
      */
-    public function testParseKeyValueArguments(array $params, array $expectedResult): void
+    public function testParseCommandArguments(array $params, array $expectedResult): void
     {
-        $result = $this->command->parseKeyValueArguments(...$params);
+        $result = $this->command->parseCommandArguments(...$params);
         $this->assertEquals($expectedResult, $result);
     }
 
@@ -219,81 +219,99 @@ public function assertKeyIsValidDataProvider(): array
 
     /**
      * @return array
-     * @see EnvironmentSetCommandTest::testParseKeyValueArguments
+     * @see EnvironmentSetCommandTest::testParseCommandArguments
      */
     public function parseKeyValueArgumentsDataProvider(): array
     {
         return [
-            // Normal usage.
+            // Normal syntax.
             [
-                ['SOME_KEY=some_value', null],
-                ['SOME_KEY', 'some_value'],
+                ['SOME_KEY', 'some_value', null],
+                ['SOME_KEY', 'some_value', null],
             ],
             [
-                ['SOME_KEY=some_value', null],
-                ['SOME_KEY', 'some_value'],
+                ['SOME_KEY', 'some_value', __FILE__],
+                ['SOME_KEY', 'some_value', __FILE__],
+            ],
+            // key=value syntax.
+            [
+                ['SOME_KEY=some_value', null, null],
+                ['SOME_KEY', 'some_value', null],
+            ],
+            [
+                ['SOME_KEY=some_value', __FILE__, null],
+                ['SOME_KEY', 'some_value', __FILE__],
+            ],
+            [
+                ['SOME_KEY=some_value', __FILE__, 'ambiguous_third_parameter'],
+                ['SOME_KEY', 'some_value', __FILE__],
+            ],
+            // Equals signs in the key=value parameter.
+            [
+                ['SOME_KEY==some=value===', null, null],
+                ['SOME_KEY', '=some=value===', null],
             ],
             // Test without neither value argument nor value in the key.
             [
-                ['some_key=', null],
-                ['SOME_KEY', ''],
+                ['some_key=', null, null],
+                ['SOME_KEY', '', null],
             ],
             [
-                ['some_key', null],
-                ['SOME_KEY', ''],
+                ['some_key', null, null],
+                ['SOME_KEY', '', null],
             ],
             // Test lowercase in the key.
             [
-                ['some_key=some_value', null],
-                ['SOME_KEY', 'some_value'],
+                ['some_key=some_value', null, null],
+                ['SOME_KEY', 'some_value', null],
             ],
             [
-                ['some_key=some_value', null],
-                ['SOME_KEY', 'some_value'],
+                ['some_key=some_value', null, null],
+                ['SOME_KEY', 'some_value', null],
             ],
             // Test double quotes in value.
             [
-                ['some_key="some_value"', null],
-                ['SOME_KEY', '"some_value"'],
+                ['some_key="some_value"', null, null],
+                ['SOME_KEY', '"some_value"', null],
             ],
             [
-                ['some_key', '"some_value"'],
-                ['SOME_KEY', '"some_value"'],
+                ['some_key', '"some_value"', null],
+                ['SOME_KEY', '"some_value"', null],
             ],
             // Test single quotes in value.
             [
-                ["some_key='some_value'", null],
-                ['SOME_KEY', "'some_value'"],
+                ["some_key='some_value'", null, null],
+                ['SOME_KEY', "'some_value'", null],
             ],
             [
-                ['some_key', "'some_value'"],
-                ['SOME_KEY', "'some_value'"],
+                ['some_key', "'some_value'", null],
+                ['SOME_KEY', "'some_value'", null],
             ],
             // Test spaces in value.
             [
-                ['some_key=some value', null],
-                ['SOME_KEY', '"some value"'],
+                ['some_key=some value', null, null],
+                ['SOME_KEY', '"some value"', null],
             ],
             [
-                ['some_key', 'some value'],
-                ['SOME_KEY', '"some value"'],
+                ['some_key', 'some value', null],
+                ['SOME_KEY', '"some value"', null],
             ],
             // Test spaces in value that are enclosed in quotes.
             [
-                ['some_key="some value"', null],
-                ['SOME_KEY', '"some value"'],
+                ['some_key="some value"', null, null],
+                ['SOME_KEY', '"some value"', null],
             ],
             [
-                ['some_key', '"some value"'],
-                ['SOME_KEY', '"some value"'],
+                ['some_key', '"some value"', null],
+                ['SOME_KEY', '"some value"', null],
             ],
             [
-                ["some_key='some value'", null],
-                ['SOME_KEY', "'some value'"],
+                ["some_key='some value'", null, null],
+                ['SOME_KEY', "'some value'", null],
             ],
             [
-                ['some_key', "'some value'"],
-                ['SOME_KEY', "'some value'"],
+                ['some_key', "'some value'", null],
+                ['SOME_KEY', "'some value'", null],
             ],
         ];
     }
