feat(core): add Environment initializer

Author: innocenzi

packages/core/src/AppConfig.php

@@ -27,7 +27,7 @@ public function __construct(
          */
         public array $insightsProviders = [],
     ) {
-        $this->environment = $environment ?? Environment::fromEnv();
+        $this->environment = $environment ?? Environment::guessFromEnvironment();
         $this->baseUri = $baseUri ?? env('BASE_URI') ?? '';
     }
 }

packages/core/src/Environment.php

@@ -6,14 +6,16 @@
 
 use function Tempest\env;
 
+/**
+ * Represents the environment in which the application is running.
+ */
 enum Environment: string
 {
     case LOCAL = 'local';
     case STAGING = 'staging';
     case PRODUCTION = 'production';
-    case CI = 'ci';
+    case CONTINUOUS_INTEGRATION = 'ci';
     case TESTING = 'testing';
-    case OTHER = 'other';
 
     public function isProduction(): bool
     {
@@ -30,24 +32,27 @@ public function isLocal(): bool
         return $this === self::LOCAL;
     }
 
-    public function isCI(): bool
+    public function isContinuousIntegration(): bool
     {
-        return $this === self::CI;
+        return $this === self::CONTINUOUS_INTEGRATION;
     }
 
     public function isTesting(): bool
     {
         return $this === self::TESTING;
     }
 
-    public function isOther(): bool
+    /**
+     * Guesses the environment from the `ENVIRONMENT` environment variable.
+     */
+    public static function guessFromEnvironment(): self
     {
-        return $this === self::OTHER;
-    }
+        $value = env('ENVIRONMENT', default: 'local');
 
-    public static function fromEnv(): self
-    {
-        $value = env('ENVIRONMENT', 'local');
+        // Can be removed after https://github.com/tempestphp/tempest-framework/pull/1836
+        if (is_null($value)) {
+            $value = 'local';
+        }
 
         return self::tryFrom($value) ?? throw new EnvironmentValueWasInvalid($value);
     }

packages/core/src/EnvironmentInitalizer.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace Tempest\Core;
+
+use Tempest\Container\Container;
+use Tempest\Container\Initializer;
+
+final class EnvironmentInitalizer implements Initializer
+{
+    public function initialize(Container $container): Environment
+    {
+        return $container->get(AppConfig::class)->environment;
+    }
+}

packages/core/src/EnvironmentValueWasInvalid.php

@@ -12,8 +12,10 @@ final class EnvironmentValueWasInvalid extends Exception
 {
     public function __construct(string $value)
     {
-        $possibleValues = arr(Environment::cases())->map(fn (Environment $environment) => $environment->value)->implode(', ');
+        $possibleValues = arr(Environment::cases())
+            ->map(fn (Environment $environment) => $environment->value)
+            ->join();
 
-        parent::__construct("Invalid environment value `{$value}`, possible values are {$possibleValues}.");
+        parent::__construct("Invalid environment [{$value}]. Possible values are {$possibleValues}.");
     }
 }

packages/core/src/FrameworkKernel.php

@@ -223,7 +223,7 @@ public function event(object $event): self
 
     public function registerEmergencyExceptionHandler(): self
     {
-        $environment = Environment::fromEnv();
+        $environment = Environment::guessFromEnvironment();
 
         // During tests, PHPUnit registers its own error handling.
         if ($environment->isTesting()) {

packages/core/tests/EnvironmentTest.php

@@ -0,0 +1,45 @@
+<?php
+
+namespace Tempest\Core\Tests;
+
+use PHPUnit\Framework\Attributes\Test;
+use PHPUnit\Framework\TestCase;
+use Tempest\Container\GenericContainer;
+use Tempest\Core\Environment;
+use Tempest\Core\EnvironmentInitalizer;
+use Tempest\Core\EnvironmentValueWasInvalid;
+
+final class EnvironmentTest extends TestCase
+{
+    #[Test]
+    public function default_is_local(): void
+    {
+        putenv('ENVIRONMENT=null');
+
+        $this->assertSame(Environment::LOCAL, Environment::guessFromEnvironment());
+    }
+
+    #[Test]
+    public function throws_on_unknown_value(): void
+    {
+        putenv('ENVIRONMENT=unknown');
+
+        $this->expectException(EnvironmentValueWasInvalid::class);
+
+        Environment::guessFromEnvironment();
+    }
+
+    #[Test]
+    public function can_be_resolved_from_container(): void
+    {
+        $container = new GenericContainer();
+        $container->addInitializer(EnvironmentInitalizer::class);
+
+        putenv('ENVIRONMENT=staging');
+        $this->assertSame(Environment::STAGING, $container->get(Environment::class));
+
+        // ensure it's not a singleton
+        putenv('ENVIRONMENT=production');
+        $this->assertSame(Environment::PRODUCTION, $container->get(Environment::class));
+    }
+}