New Bedrock Configuration Model

composer.json

@@ -32,6 +32,11 @@
       "url": "https://wpackagist.org"
     }
   ],
+  "autoload": {
+    "psr-4": {
+      "Roots\\Bedrock\\": "lib/Bedrock"
+    }
+  },
   "require": {
     "php": ">=5.6",
     "composer/installers": "^1.4",

config/application.php

@@ -1,5 +1,7 @@
 <?php
 
+use Roots\Bedrock\Config;
+
 /** @var string Directory containing all of the site's files */
 $root_dir = dirname(__DIR__);
 
@@ -26,54 +28,67 @@
  */
 define('WP_ENV', env('WP_ENV') ?: 'production');
 
-$env_config = __DIR__ . '/environments/' . WP_ENV . '.php';
-
-if (file_exists($env_config)) {
-    require_once $env_config;
-}
-
 /**
  * URLs
  */
-define('WP_HOME', env('WP_HOME'));
-define('WP_SITEURL', env('WP_SITEURL'));
+Config::define('WP_HOME', env('WP_HOME'));
+Config::define('WP_SITEURL', env('WP_SITEURL'));
 
 /**
  * Custom Content Directory
  */
-define('CONTENT_DIR', '/app');
-define('WP_CONTENT_DIR', $webroot_dir . CONTENT_DIR);
-define('WP_CONTENT_URL', WP_HOME . CONTENT_DIR);
+Config::define('CONTENT_DIR', '/app');
+Config::define('WP_CONTENT_DIR', $webroot_dir . Config::get('CONTENT_DIR'));
+Config::define('WP_CONTENT_URL', Config::get('WP_HOME') . Config::get('CONTENT_DIR'));
 
 /**
  * DB settings
  */
-define('DB_NAME', env('DB_NAME'));
-define('DB_USER', env('DB_USER'));
-define('DB_PASSWORD', env('DB_PASSWORD'));
-define('DB_HOST', env('DB_HOST') ?: 'localhost');
-define('DB_CHARSET', 'utf8mb4');
-define('DB_COLLATE', '');
+Config::define('DB_NAME', env('DB_NAME'));
+Config::define('DB_USER', env('DB_USER'));
+Config::define('DB_PASSWORD', env('DB_PASSWORD'));
+Config::define('DB_HOST', env('DB_HOST') ?: 'localhost');
+Config::define('DB_CHARSET', 'utf8mb4');
+Config::define('DB_COLLATE', '');
 $table_prefix = env('DB_PREFIX') ?: 'wp_';
 
 /**
  * Authentication Unique Keys and Salts
  */
-define('AUTH_KEY', env('AUTH_KEY'));
-define('SECURE_AUTH_KEY', env('SECURE_AUTH_KEY'));
-define('LOGGED_IN_KEY', env('LOGGED_IN_KEY'));
-define('NONCE_KEY', env('NONCE_KEY'));
-define('AUTH_SALT', env('AUTH_SALT'));
-define('SECURE_AUTH_SALT', env('SECURE_AUTH_SALT'));
-define('LOGGED_IN_SALT', env('LOGGED_IN_SALT'));
-define('NONCE_SALT', env('NONCE_SALT'));
+Config::define('AUTH_KEY', env('AUTH_KEY'));
+Config::define('SECURE_AUTH_KEY', env('SECURE_AUTH_KEY'));
+Config::define('LOGGED_IN_KEY', env('LOGGED_IN_KEY'));
+Config::define('NONCE_KEY', env('NONCE_KEY'));
+Config::define('AUTH_SALT', env('AUTH_SALT'));
+Config::define('SECURE_AUTH_SALT', env('SECURE_AUTH_SALT'));
+Config::define('LOGGED_IN_SALT', env('LOGGED_IN_SALT'));
+Config::define('NONCE_SALT', env('NONCE_SALT'));
 
 /**
  * Custom Settings
  */
-define('AUTOMATIC_UPDATER_DISABLED', true);
-define('DISABLE_WP_CRON', env('DISABLE_WP_CRON') ?: false);
-define('DISALLOW_FILE_EDIT', true);
+Config::define('AUTOMATIC_UPDATER_DISABLED', true);
+Config::define('DISABLE_WP_CRON', env('DISABLE_WP_CRON') ?: false);
+// Disable the plugin and theme file editor in the admin
+Config::define('DISALLOW_FILE_EDIT', true);
+// Disable plugin and theme updates and installation from the admin
+Config::define('DISALLOW_FILE_MODS', true);
+
+/**
+ * Safe Debugging Settings
+ * Override these in config/{WP_ENV}.php
+ */
+Config::define('WP_DEBUG_DISPLAY', false);
+Config::define('SCRIPT_DEBUG', false);
+ini_set('display_errors', 0);
+
+$env_config = __DIR__ . '/environments/' . WP_ENV . '.php';
+
+if (file_exists($env_config)) {
+    require_once $env_config;
+}
+
+Config::apply();
 
 /**
  * Bootstrap WordPress

config/environments/development.php

@@ -1,5 +1,10 @@
 <?php
-/** Development */
-define('SAVEQUERIES', true);
-define('WP_DEBUG', true);
-define('SCRIPT_DEBUG', true);
+/** Configuration Overrides for Development */
+
+use Roots\Bedrock\Config;
+
+Config::define('SAVEQUERIES', true);
+Config::define('WP_DEBUG', true);
+Config::define('SCRIPT_DEBUG', true);
+
+ini_set('display_errors', 1);

config/environments/production.php

@@ -1,7 +1,4 @@
 <?php
-/** Production */
-ini_set('display_errors', 0);
-define('WP_DEBUG_DISPLAY', false);
-define('SCRIPT_DEBUG', false);
-/** Disable all file modifications including updates and update notifications */
-define('DISALLOW_FILE_MODS', true);
+/** Configuration Overrides for Production */
+
+use Roots\Bedrock\Config;

config/environments/staging.php

@@ -1,7 +1,7 @@
 <?php
-/** Staging */
-ini_set('display_errors', 0);
-define('WP_DEBUG_DISPLAY', false);
-define('SCRIPT_DEBUG', false);
-/** Disable all file modifications including updates and update notifications */
-define('DISALLOW_FILE_MODS', true);
+/** Configuration Overrides for Staging */
+
+use Roots\Bedrock\Config;
+
+// Config::define('WP_DEBUG', true);
+// ini_set('display_errors', 1);

lib/Bedrock/Config.php

@@ -0,0 +1,108 @@
+<?php
+
+namespace Roots\Bedrock;
+
+/**
+ * Class Config
+ * @package Roots\Bedrock
+ */
+class Config
+{
+    /**
+     * @var array
+     */
+    private static $configMap = [];
+
+    /**
+     * @param string $key
+     * @param $value
+     * @throws ConstantAlreadyDefinedException
+     */
+    public static function define($key, $value)
+    {
+        self::defined($key) or self::$configMap[$key] = $value;
+    }
+
+    /**
+     * @param string $key
+     * @return mixed
+     * @throws UndefinedConfigKeyException
+     */
+    public static function get($key)
+    {
+        if (!array_key_exists($key, self::$configMap)) {
+            $class = self::class;
+            throw new UndefinedConfigKeyException("'$key' has not been set by $class::define('$key', ...)");
+        }
+
+        return self::$configMap[$key];
+    }
+
+    /**
+     * @param string $key
+     */
+    public static function remove($key)
+    {
+        unset(self::$configMap[$key]);
+    }
+
+    /**
+     * define() all values in $configMap and throw an exception if we are attempting to redefine a constant.
+     *
+     * We throw the exception because a silent rejection of a configuration value is unacceptable. This method fails
+     * fast before undefined behavior propagates due to unexpected configuration sneaking through.
+     *
+     * ```
+     * define('BEDROCK', 'no');
+     * define('BEDROCK', 'yes');
+     * echo BEDROCK;
+     * // output: 'no'
+     * ```
+     *
+     * vs.
+     *
+     * ```
+     * define('BEDROCK', 'no');
+     * Config::define('BEDROCK', 'yes');
+     * Config::apply();
+     * // output: Fatal error: Uncaught Roots\Bedrock\ConstantAlreadyDefinedException ...
+     * ```
+     *
+     * @throws ConstantAlreadyDefinedException
+     */
+    public static function apply()
+    {
+        // Scan configMap to see if user is trying to redefine any constants.
+        // We do this because we don't want to 'half apply' the configMap. The user should be able to catch the
+        // exception, repair their config, and run apply() again
+        foreach (self::$configMap as $key => $value) {
+            try {
+                self::defined($key);
+            } catch (ConstantAlreadyDefinedException $e) {
+                if (constant($key) !== $value) {
+                    throw $e;
+                }
+            }
+        }
+
+        // If all is well, apply the configMap ignoring entries that have already been applied
+        foreach (self::$configMap as $key => $value) {
+            defined($key) or define($key, $value);
+        }
+    }
+
+    /**
+     * @param string $key
+     * @return bool
+     * @throws ConstantAlreadyDefinedException
+     */
+    private static function defined($key)
+    {
+        if (defined($key)) {
+            $message = "Bedrock aborted trying to redefine constant '$key'";
+            throw new ConstantAlreadyDefinedException($message);
+        }
+
+        return false;
+    }
+}

lib/Bedrock/ConstantAlreadyDefinedException.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Roots\Bedrock;
+
+/**
+ * Class ConstantAlreadyDefinedException
+ * This should be thrown when a user attempts to define() a constant that has already been defined
+ * @package Roots\Bedrock
+ */
+class ConstantAlreadyDefinedException extends \RuntimeException
+{
+
+}

lib/Bedrock/UndefinedConfigKeyException.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Roots\Bedrock;
+
+class UndefinedConfigKeyException extends \RuntimeException
+{
+
+}