Merge pull request #1352 from hydephp/clean-up-and-refactor-internal-bootstrapper-class

emmadesilva · web-flow · commit c63ee87d67ef · 2023-03-22T18:07:00.000+01:00
Clean up and refactor the internal LoadYamlConfiguration test
diff --git a/packages/framework/src/Foundation/Internal/LoadYamlConfiguration.php b/packages/framework/src/Foundation/Internal/LoadYamlConfiguration.php
@@ -13,7 +13,9 @@
 use function file_exists;
 
 /**
- * @internal
+ * @internal Bootstrap service that loads the YAML configuration file.
+ *
+ * @see docs/digging-deeper/customization.md#yaml-configuration
  */
 class LoadYamlConfiguration
 {
diff --git a/packages/framework/tests/Feature/LoadYamlConfigurationTest.php b/packages/framework/tests/Feature/LoadYamlConfigurationTest.php
@@ -15,40 +15,97 @@
  */
 class LoadYamlConfigurationTest extends TestCase
 {
-    public function test_bootstrapper_applies_yaml_configuration_when_present()
+    public function testCanDefineHydeConfigSettingsInHydeYmlFile()
+    {
+        config(['hyde' => []]);
+
+        $this->file('hyde.yml', <<<'YAML'
+        name: HydePHP
+        url: "http://localhost"
+        pretty_urls: false
+        generate_sitemap: true
+        rss:
+          enabled: true
+          filename: feed.xml
+          description: HydePHP RSS Feed
+        language: en
+        output_directory: _site
+        YAML);
+        $this->runBootstrapper();
+
+        $this->assertSame('HydePHP', Config::get('hyde.name'));
+        $this->assertSame('http://localhost', Config::get('hyde.url'));
+        $this->assertSame(false, Config::get('hyde.pretty_urls'));
+        $this->assertSame(true, Config::get('hyde.generate_sitemap'));
+        $this->assertSame(true, Config::get('hyde.rss.enabled'));
+        $this->assertSame('feed.xml', Config::get('hyde.rss.filename'));
+        $this->assertSame('HydePHP RSS Feed', Config::get('hyde.rss.description'));
+        $this->assertSame('en', Config::get('hyde.language'));
+        $this->assertSame('_site', Config::get('hyde.output_directory'));
+    }
+
+    public function testBootstrapperAppliesYamlConfigurationWhenPresent()
     {
-        $this->assertSame('HydePHP', config('hyde.name'));
         $this->file('hyde.yml', 'name: Foo');
-        $this->app->bootstrapWith([LoadYamlConfiguration::class]);
+        $this->runBootstrapper();
+
         $this->assertSame('Foo', config('hyde.name'));
     }
 
-    public function test_changes_in_yaml_file_override_changes_in_site_config()
+    public function testChangesInYamlFileOverrideChangesInHydeConfig()
     {
-        $this->assertSame('HydePHP', Config::get('hyde.name'));
         $this->file('hyde.yml', 'name: Foo');
-        $this->app->bootstrapWith([LoadYamlConfiguration::class]);
+        $this->runBootstrapper();
+
         $this->assertSame('Foo', Config::get('hyde.name'));
     }
 
-    public function test_changes_in_yaml_file_override_changes_in_site_config_when_using_yaml_extension()
+    public function testChangesInYamlFileOverrideChangesInHydeConfigWhenUsingYamlExtension()
     {
-        $this->assertSame('HydePHP', Config::get('hyde.name'));
         $this->file('hyde.yaml', 'name: Foo');
-        $this->app->bootstrapWith([LoadYamlConfiguration::class]);
+        $this->runBootstrapper();
+
         $this->assertSame('Foo', Config::get('hyde.name'));
     }
 
-    public function test_service_gracefully_handles_missing_file()
+    public function testServiceGracefullyHandlesMissingFile()
     {
-        $this->app->bootstrapWith([LoadYamlConfiguration::class]);
+        $this->runBootstrapper();
+
         $this->assertSame('HydePHP', Config::get('hyde.name'));
     }
 
-    public function test_service_gracefully_handles_empty_file()
+    public function testServiceGracefullyHandlesEmptyFile()
     {
         $this->file('hyde.yml', '');
-        $this->app->bootstrapWith([LoadYamlConfiguration::class]);
+        $this->runBootstrapper();
+
         $this->assertSame('HydePHP', Config::get('hyde.name'));
     }
+
+    public function testCanAddArbitraryConfigKeys()
+    {
+        $this->file('hyde.yml', 'foo: bar');
+        $this->runBootstrapper();
+
+        $this->assertSame('bar', Config::get('hyde.foo'));
+    }
+
+    public function testConfigurationOptionsAreMerged()
+    {
+        config(['hyde' => [
+            'foo' => 'bar',
+            'baz' => 'qux',
+        ]]);
+
+        $this->file('hyde.yml', 'baz: hat');
+        $this->runBootstrapper();
+
+        $this->assertSame('bar', Config::get('hyde.foo'));
+    }
+
+    protected function runBootstrapper(): void
+    {
+        $this->app->bootstrapWith([LoadYamlConfiguration::class]);
+    }
 }
