Combine defaults to one class and use match(), Add new Features class…

… to detect additional services.
druidfi · back-2-95 · Nov 27, 2023 · May 20, 2023 · May 20, 2023 · May 20, 2023
commit 8f54d32713e718381152fe664bc70804797476be
diff --git a/src/Defaults.php b/src/Defaults.php
@@ -0,0 +1,58 @@
+<?php
+
+namespace Druidfi\Omen;
+
+class Defaults
+{
+  private array $config = [];
+
+  private array $settings = [
+    'config_exclude_modules' => [
+      'devel',
+      'stage_file_proxy',
+      'upgrade_status',
+    ],
+  ];
+
+  public function __construct(string $app_env)
+  {
+    $this->config['system.logging']['error_level'] = match ($app_env) {
+      'dev' => 'all',
+      default => 'hide',
+    };
+
+    $this->config['system.performance'] = match ($app_env) {
+      'dev' => [
+        'cache' => ['page' => ['max_age' => 0]],
+        'css' => ['preprocess' => 0],
+        'js' => ['preprocess' => 0],
+      ],
+      default => [
+        'cache' => ['page' => ['max_age' => 900]],
+        'css' => ['preprocess' => 1],
+        'js' => ['preprocess' => 1],
+      ],
+    };
+
+    $this->settings['skip_permissions_hardening'] = match ($app_env) {
+      'dev' => TRUE,
+      default => FALSE,
+    };
+
+    // Simple Environment Indicator.
+    $this->settings['simple_environment_indicator'] = match ($app_env) {
+      'dev' => 'Black Development',
+      'test' => 'Blue Testing',
+      'prod' => 'DarkRed Production',
+      default => FALSE,
+    };
+  }
+
+  public function getDefaults() : array
+  {
+    return [
+      'config' => $this->config,
+      'settings' => $this->settings,
+    ];
+  }
+}
diff --git a/src/EnvDefaults/AbstractDefaults.php b/src/EnvDefaults/AbstractDefaults.php
diff --git a/src/EnvDefaults/DevDefaults.php b/src/EnvDefaults/DevDefaults.php
diff --git a/src/EnvDefaults/ProdDefaults.php b/src/EnvDefaults/ProdDefaults.php
diff --git a/src/EnvDefaults/TestDefaults.php b/src/EnvDefaults/TestDefaults.php
diff --git a/src/Features.php b/src/Features.php
@@ -0,0 +1,53 @@
+<?php
+
+namespace Druidfi\Omen;
+
+class Features
+{
+  public bool $redis = false;
+  public bool $solr = false;
+
+  private array $redisEnvVariables = [
+    'REDIS_HOST', // Lagoon
+  ];
+
+  private array $solrEnvVariables = [
+    'SOLR_HOST', // Lagoon
+  ];
+
+  public function __construct()
+  {
+    $this->detectRedis();
+    $this->detectSolr();
+  }
+
+  public function hasRedis(): bool
+  {
+    return $this->redis;
+  }
+
+  public function hasSolr(): bool
+  {
+    return $this->solr;
+  }
+
+  private function detectRedis(): void
+  {
+    foreach ($this->redisEnvVariables as $env) {
+      if (getenv($env)) {
+        $this->redis = true;
+        break;
+      }
+    }
+  }
+
+  private function detectSolr(): void
+  {
+    foreach ($this->solrEnvVariables as $env) {
+      if (getenv($env)) {
+        $this->solr = true;
+        break;
+      }
+    }
+  }
+}
diff --git a/src/Reader.php b/src/Reader.php
@@ -9,6 +9,7 @@
 use Druidfi\Omen\EnvMapping\Pantheon;
 use Druidfi\Omen\EnvMapping\Tugboat;
 use Druidfi\Omen\EnvMapping\Wodby;
+use JetBrains\PhpStorm\NoReturn;
 use ReflectionClass;
 use Symfony\Component\HttpFoundation\Request;
 
@@ -29,10 +30,10 @@ class Reader
     'WODBY_INSTANCE_TYPE' => Wodby::class,
   ];
 
-  private $app_env;
+  private string $app_env;
   private ?string $app_root;
-  private ?array $config = [];
-  private ?array $databases = [];
+  private array $config = [];
+  private array $databases = [];
   private string $drupal_version;
 
   /**
@@ -72,13 +73,15 @@ public function __construct(array $vars)
       }
     }
 
+    $features = new Features();
+
     // Set mapped env variables IF we have detected something
-    if (!is_null($this->omen)) {
+    if ($this->omen) {
       foreach ($this->omen->getEnvs() as $env_var => $env_val) {
         putenv($env_var . '=' . $env_val);
       }
 
-      // Set Env specific configuration
+      // Set system specific configuration
       $this->omen->setConfiguration($config, $settings);
     }
     else {
@@ -125,7 +128,7 @@ public function __construct(array $vars)
     $this->setDatabaseConnection();
   }
 
-  public static function get(array $vars) : array
+  public static function get(array $vars): array
   {
     return (new Reader($vars))->getConf();
   }
@@ -135,7 +138,7 @@ public static function get(array $vars) : array
    *
    * @return array
    */
-  public function getConf() : array
+  public function getConf(): array
   {
     $conf = [
       'config' => $this->config,
@@ -159,13 +162,15 @@ public function getConf() : array
   /**
    * Print out configuration.
    */
-  public static function show(array $vars)
+  #[NoReturn]
+  public static function show(array $vars): void
   {
     $reader = new Reader($vars);
     $reader->printConfiguration($reader->getConf());
   }
 
-  protected function printConfiguration($conf)
+  #[NoReturn]
+  protected function printConfiguration($conf): void
   {
     $omen = is_null($this->omen) ? '[NOT_ANY_DETECTED_SYSTEM]' : get_class($this->omen);
     echo '<h1>Drupal: '. $this->drupal_version .', APP_ENV: '. $this->app_env .' on '. $omen .'</h1>';
@@ -183,10 +188,9 @@ protected function printConfiguration($conf)
   /**
    * Set ENV specific default values.
    */
-  private function setEnvDefaults()
+  private function setEnvDefaults(): void
   {
-    $class = "Druidfi\Omen\EnvDefaults\\". ucfirst($this->app_env) ."Defaults";
-    $env_defaults = (new $class())->getDefaults();
+    $env_defaults = (new Defaults($this->app_env))->getDefaults();
 
     foreach ($env_defaults as $set => $values) {
       if (!is_array($this->{$set})) {
@@ -200,7 +204,7 @@ private function setEnvDefaults()
   /**
    * Set global values. Same for all environments.
    */
-  private function setGlobalDefaults()
+  private function setGlobalDefaults(): void
   {
     // Set directory for loading CMI configuration.
     $this->settings['config_sync_directory'] = getenv('DRUPAL_SYNC_DIR')
@@ -226,7 +230,7 @@ private function setGlobalDefaults()
    *
    * @see https://www.drupal.org/node/2410395
    */
-  private function setTrustedHostPatterns()
+  private function setTrustedHostPatterns(): void
   {
     if (!isset($this->settings['trusted_host_patterns'])) {
       $this->settings['trusted_host_patterns'] = [];
@@ -263,7 +267,7 @@ private function setTrustedHostPatterns()
       putenv('DRUSH_OPTIONS_URI=https://' . $hosts[0]);
     }
 
-    if (!is_null($this->omen) && method_exists($this->omen, 'getTrustedHostPatterns')) {
+    if ($this->omen && method_exists($this->omen, 'getTrustedHostPatterns')) {
       $patterns = $this->omen->getTrustedHostPatterns();
       $this->settings['trusted_host_patterns'] = array_merge($this->settings['trusted_host_patterns'], $patterns);
     }
@@ -272,7 +276,7 @@ private function setTrustedHostPatterns()
   /**
    * Set database connection.
    */
-  private function setDatabaseConnection()
+  private function setDatabaseConnection(): void
   {
     // DRUPAL_DB_* should be defined at this point.
     $this->databases['default']['default'] = [