Merge pull request #2 from ergebnis/feature/production

localheinz · web-flow · commit 144ee4672aa5 · 2020-02-22T22:16:04.000+01:00
Enhancement: Add Production
diff --git a/.github/workflows/continuous-integration.yml b/.github/workflows/continuous-integration.yml
@@ -9,8 +9,8 @@ on:
       - "master"
 
 env:
-  MIN_COVERED_MSI: 97
-  MIN_MSI: 97
+  MIN_COVERED_MSI: 99
+  MIN_MSI: 98
   REQUIRED_PHP_EXTENSIONS: "mbstring"
 
 jobs:
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -11,9 +11,11 @@ For a full diff see [`c0c63bb...master`][c0c63bb...master].
 ### Added
 
 * Added `Test`, which allows backing up, restoring, and safely modifying environment variables in test environments ([#1]), by [@localheinz]
+* Added `Production`, which allows reading, setting, and unsetting environment variables in production environments ([#2]), by [@localheinz]
 
 [c0c63bb...master]: https://github.com/ergebnis/environment-variables/compare/c0c63bb...master
 
 [#1]: https://github.com/ergebnis/environment-variables/pull/1
+[#2]: https://github.com/ergebnis/environment-variables/pull/2
 
 [@localheinz]: https://github.com/localheinz
diff --git a/Makefile b/Makefile
@@ -1,5 +1,5 @@
-MIN_COVERED_MSI:=97
-MIN_MSI:=97
+MIN_COVERED_MSI:=98
+MIN_MSI:=98
 
 .PHONY: it
 it: coding-standards dependency-analysis static-code-analysis tests ## Runs the coding-standards, dependency-analysis, static-code-analysis, and tests targets
diff --git a/README.md b/README.md
@@ -21,6 +21,36 @@ $ composer require ergebnis/environment-variables
 
 ## Usage
 
+### `Ergebnis\Environment\Variables\Production`
+
+If you want to read, set, and unset environment variables in an object-oriented way in a production environment, you can use [`Ergebnis\Environment\Variables\Production`](src/Production.php):
+
+```php
+use Ergebnis\Environment\Variables;
+
+final class BuildEnvironment
+{
+    private $environmentVariables;
+
+    public function __construct(Variables\Production $environmentVariables)
+    {
+        $this->environmentVariables = $environmentVariables;
+    }
+
+    public function isGitHubActions(): bool
+    {
+        return $this->environmentVariables->has('GITHUB_ACTIONS')
+            && 'true' === $this->environmentVariables->get('GITHUB_ACTIONS');
+    }
+
+    public function isTravisCi(): bool
+    {
+        return $this->environmentVariables->has('TRAVIS')
+            && 'true' === $this->environmentVariables->get('TRAVIS');
+    }
+}
+```
+
 ### `Ergebnis\Environment\Variables\Test`
 
 If your tests depend on environment variables, you have the following challenges:
diff --git a/src/Exception/InvalidName.php b/src/Exception/InvalidName.php
@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * Copyright (c) 2020 Andreas Möller
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE.md file that was distributed with this source code.
+ *
+ * @see https://github.com/ergebnis/environment-variables
+ */
+
+namespace Ergebnis\Environment\Variables\Exception;
+
+final class InvalidName extends \InvalidArgumentException implements Exception
+{
+    public static function create(string $name): self
+    {
+        return new self(\sprintf(
+            'Name cannot be empty or untrimmed, but "%s" is.',
+            $name
+        ));
+    }
+}
diff --git a/src/Production.php b/src/Production.php
@@ -0,0 +1,57 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * Copyright (c) 2020 Andreas Möller
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE.md file that was distributed with this source code.
+ *
+ * @see https://github.com/ergebnis/environment-variables
+ */
+
+namespace Ergebnis\Environment\Variables;
+
+final class Production implements Variables
+{
+    public function has(string $name): bool
+    {
+        if ('' === $name || \trim($name) !== $name) {
+            throw Exception\InvalidName::create($name);
+        }
+
+        return false !== \getenv($name);
+    }
+
+    public function get(string $name)
+    {
+        if ('' === $name || \trim($name) !== $name) {
+            throw Exception\InvalidName::create($name);
+        }
+
+        return \getenv($name);
+    }
+
+    public function set(string $name, string $value): void
+    {
+        if ('' === $name || \trim($name) !== $name) {
+            throw Exception\InvalidName::create($name);
+        }
+
+        \putenv(\sprintf(
+            '%s=%s',
+            $name,
+            $value
+        ));
+    }
+
+    public function unset(string $name): void
+    {
+        if ('' === $name || \trim($name) !== $name) {
+            throw Exception\InvalidName::create($name);
+        }
+
+        \putenv($name);
+    }
+}
diff --git a/src/Variables.php b/src/Variables.php
@@ -0,0 +1,50 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * Copyright (c) 2020 Andreas Möller
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE.md file that was distributed with this source code.
+ *
+ * @see https://github.com/ergebnis/environment-variables
+ */
+
+namespace Ergebnis\Environment\Variables;
+
+interface Variables
+{
+    /**
+     * @param string $name
+     *
+     * @throws Exception\InvalidName
+     *
+     * @return bool
+     */
+    public function has(string $name): bool;
+
+    /**
+     * @param string $name
+     *
+     * @throws Exception\InvalidName
+     *
+     * @return bool|string
+     */
+    public function get(string $name);
+
+    /**
+     * @param string $name
+     * @param string $value
+     *
+     * @throws Exception\InvalidName
+     */
+    public function set(string $name, string $value): void;
+
+    /**
+     * @param string $name
+     *
+     * @throws Exception\InvalidName
+     */
+    public function unset(string $name): void;
+}
diff --git a/test/DataProvider/Name.php b/test/DataProvider/Name.php
@@ -0,0 +1,42 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * Copyright (c) 2020 Andreas Möller
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE.md file that was distributed with this source code.
+ *
+ * @see https://github.com/ergebnis/environment-variables
+ */
+
+namespace Ergebnis\Environment\Variables\Test\DataProvider;
+
+use Ergebnis\Test\Util\Helper;
+
+final class Name
+{
+    use Helper;
+
+    /**
+     * @return \Generator<string, array<string>>
+     */
+    public static function invalid(): \Generator
+    {
+        $values = [
+            'string-blank' => ' ',
+            'string-empty' => '',
+            'string-untrimmed' => \sprintf(
+                ' %s ',
+                self::faker()->sentence
+            ),
+        ];
+
+        foreach ($values as $key => $value) {
+            yield $key => [
+                $value,
+            ];
+        }
+    }
+}
diff --git a/test/Unit/Exception/InvalidNameTest.php b/test/Unit/Exception/InvalidNameTest.php
@@ -0,0 +1,45 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * Copyright (c) 2020 Andreas Möller
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE.md file that was distributed with this source code.
+ *
+ * @see https://github.com/ergebnis/environment-variables
+ */
+
+namespace Ergebnis\Environment\Variables\Test\Unit\Exception;
+
+use Ergebnis\Environment\Variables\Exception\InvalidName;
+use Ergebnis\Test\Util\Helper;
+use PHPUnit\Framework;
+
+/**
+ * @internal
+ *
+ * @covers \Ergebnis\Environment\Variables\Exception\InvalidName
+ */
+final class InvalidNameTest extends Framework\TestCase
+{
+    use Helper;
+
+    public function testCreateReturnsException(): void
+    {
+        $name = \sprintf(
+            ' %s ',
+            self::faker()->word
+        );
+
+        $exception = InvalidName::create($name);
+
+        $message = \sprintf(
+            'Name cannot be empty or untrimmed, but "%s" is.',
+            $name
+        );
+
+        self::assertSame($message, $exception->getMessage());
+    }
+}
diff --git a/test/Unit/ProductionTest.php b/test/Unit/ProductionTest.php
diff --git a/test/Unit/TestTest.php b/test/Unit/TestTest.php
