Replace config('site') calls with config('hyde')

Replace `config('site')` calls with `config('hyde')` Replace `config(['site'])` calls with `config(['hyde'])` Replace `Config::get('site')` calls with `Config::get('hyde')`
hydephp · Feb 10, 2023 · 73143af · 73143af
1 parent e8a65fe
commit 73143af
Show file tree

Hide file tree

Showing 49 changed files with 165 additions and 165 deletions.
diff --git a/_pages/404.blade.php b/_pages/404.blade.php
@@ -31,7 +31,7 @@
                     Sorry, the page you are looking for could not be found.
                 </p>
 
-                <a href="{{ config('site.url') ?? '/' }}">
+                <a href="{{ config('hyde.url') ?? '/' }}">
                     <button
                         class="bg-transparent text-grey-darkest font-bold uppercase tracking-wide py-3 px-6 border-2 border-grey-light hover:border-grey rounded-lg">
                         Go Home

diff --git a/config/docs.php b/config/docs.php
@@ -21,7 +21,7 @@
     |
     */
 
-    'header_title' => config('site.name', 'HydePHP').' Docs',
+    'header_title' => config('hyde.name', 'HydePHP').' Docs',
 
     /*
     |--------------------------------------------------------------------------

diff --git a/config/hyde.php b/config/hyde.php
@@ -203,7 +203,7 @@
         // Meta::name('description', 'My Hyde Blog'),
         // Meta::name('keywords', 'Static Sites, Blogs, Documentation'),
         Meta::name('generator', 'HydePHP '.Hyde\Hyde::version()),
-        Meta::property('site_name', config('site.name', 'HydePHP')),
+        Meta::property('site_name', config('hyde.name', 'HydePHP')),
     ],
 
     /*

diff --git a/docs/digging-deeper/customization.md b/docs/digging-deeper/customization.md
@@ -11,7 +11,7 @@ navigation:
 Hyde favours <a href="https://en.wikipedia.org/wiki/Convention_over_configuration">"Convention over Configuration"</a>
 and comes preconfigured with sensible defaults. However, Hyde also strives to be modular and endlessly customizable if you need it. This page guides you through the many options available!
 
-When referencing configuration options, we often use "dot notation" to specify the configuration file. For example, <code>config('site.name')</code> means that we are looking for the <code>name</code> option in the <code>config/site.php</code> file.
+When referencing configuration options, we often use "dot notation" to specify the configuration file. For example, <code>config('hyde.name')</code> means that we are looking for the <code>name</code> option in the <code>config/site.php</code> file.
 
 If you want to reference these configuration options in your Blade views, or other integrations, please take a look at the [Laravel Documentation](https://laravel.com/docs/9.x/configuration).
 

diff --git a/packages/framework/config/docs.php b/packages/framework/config/docs.php
@@ -21,7 +21,7 @@
     |
     */
 
-    'header_title' => config('site.name', 'HydePHP').' Docs',
+    'header_title' => config('hyde.name', 'HydePHP').' Docs',
 
     /*
     |--------------------------------------------------------------------------

diff --git a/packages/framework/config/hyde.php b/packages/framework/config/hyde.php
@@ -203,7 +203,7 @@
         // Meta::name('description', 'My Hyde Blog'),
         // Meta::name('keywords', 'Static Sites, Blogs, Documentation'),
         Meta::name('generator', 'HydePHP '.Hyde\Hyde::version()),
-        Meta::property('site_name', config('site.name', 'HydePHP')),
+        Meta::property('site_name', config('hyde.name', 'HydePHP')),
     ],
 
     /*

diff --git a/packages/framework/resources/views/components/navigation/navigation-brand.blade.php b/packages/framework/resources/views/components/navigation/navigation-brand.blade.php
@@ -1,3 +1,3 @@
 <a href="{{ Route::get('index') }}" class="font-bold px-4" aria-label="Home page">
-    {{ config('site.name', 'HydePHP') }}
+    {{ config('hyde.name', 'HydePHP') }}
 </a>
diff --git a/packages/framework/resources/views/layouts/app.blade.php b/packages/framework/resources/views/layouts/app.blade.php
@@ -1,5 +1,5 @@
 <!DOCTYPE html>
-<html lang="{{ config('site.language', 'en') }}">
+<html lang="{{ config('hyde.language', 'en') }}">
 <head>
     @include('hyde::layouts.head')
 </head>

diff --git a/packages/framework/resources/views/layouts/docs.blade.php b/packages/framework/resources/views/layouts/docs.blade.php
@@ -1,5 +1,5 @@
 <!DOCTYPE html>
-<html lang="{{ config('site.language', 'en') }}">
+<html lang="{{ config('hyde.language', 'en') }}">
 <head>
     @include('hyde::layouts.head')
 </head>

diff --git a/packages/framework/resources/views/pages/404.blade.php b/packages/framework/resources/views/pages/404.blade.php
@@ -31,7 +31,7 @@
                     Sorry, the page you are looking for could not be found.
                 </p>
 
-                <a href="{{ config('site.url') ?? '/' }}">
+                <a href="{{ config('hyde.url') ?? '/' }}">
                     <button
                         class="bg-transparent text-grey-darkest font-bold uppercase tracking-wide py-3 px-6 border-2 border-grey-light hover:border-grey rounded-lg">
                         Go Home

diff --git a/packages/framework/src/Console/Commands/BuildSiteCommand.php b/packages/framework/src/Console/Commands/BuildSiteCommand.php
@@ -70,7 +70,7 @@ protected function runPreBuildActions(): void
         if ($this->option('pretty-urls')) {
             $this->info('Generating site with pretty URLs');
             $this->newLine();
-            Config::set(['site.pretty_urls' => true]);
+            Config::set(['hyde.pretty_urls' => true]);
         }
     }
 

diff --git a/packages/framework/src/Facades/Features.php b/packages/framework/src/Facades/Features.php
@@ -156,7 +156,7 @@ public static function torchlight(): string
     public static function sitemap(): bool
     {
         return static::resolveMockedInstance('sitemap') ?? Hyde::hasSiteUrl()
-            && config('site.generate_sitemap', true)
+            && config('hyde.generate_sitemap', true)
             && extension_loaded('simplexml');
     }
 

diff --git a/packages/framework/src/Facades/Site.php b/packages/framework/src/Facades/Site.php
@@ -16,17 +16,17 @@ final class Site
 {
     public static function url(): ?string
     {
-        return config('site.url');
+        return config('hyde.url');
     }
 
     public static function name(): ?string
     {
-        return config('site.name');
+        return config('hyde.name');
     }
 
     public static function language(): ?string
     {
-        return config('site.language');
+        return config('hyde.language');
     }
 
     public static function metadata(): GlobalMetadataBag

diff --git a/packages/framework/src/Foundation/Hyperlinks.php b/packages/framework/src/Foundation/Hyperlinks.php
@@ -31,7 +31,7 @@ public function __construct(HydeKernel $kernel)
      */
     public function formatLink(string $destination): string
     {
-        if (config('site.pretty_urls', false) === true) {
+        if (config('hyde.pretty_urls', false) === true) {
             if (str_ends_with($destination, '.html')) {
                 if ($destination === 'index.html') {
                     return '/';
@@ -108,7 +108,7 @@ public function image(string $name, bool $preferQualifiedUrl = false): string
      */
     public function hasSiteUrl(): bool
     {
-        return ! blank(config('site.url'));
+        return ! blank(config('hyde.url'));
     }
 
     /**
@@ -123,7 +123,7 @@ public function url(string $path = ''): string
         $path = $this->formatLink(trim($path, '/'));
 
         if ($this->hasSiteUrl()) {
-            return rtrim(rtrim((string) config('site.url'), '/')."/$path", '/');
+            return rtrim(rtrim((string) config('hyde.url'), '/')."/$path", '/');
         }
 
         throw new BaseUrlNotSetException();

diff --git a/packages/framework/src/Framework/Features/XmlGenerators/RssFeedGenerator.php b/packages/framework/src/Framework/Features/XmlGenerators/RssFeedGenerator.php
@@ -82,7 +82,7 @@ protected function addBaseChannelItems(): void
         $this->addChild($channel, 'title', Site::name());
         $this->addChild($channel, 'link', Site::url());
         $this->addChild($channel, 'description', $this->getDescription());
-        $this->addChild($channel, 'language', config('site.language', 'en'));
+        $this->addChild($channel, 'language', config('hyde.language', 'en'));
         $this->addChild($channel, 'generator', 'HydePHP '.Hyde::version());
         $this->addChild($channel, 'lastBuildDate', date(DATE_RSS));
     }

diff --git a/packages/framework/src/Framework/HydeServiceProvider.php b/packages/framework/src/Framework/HydeServiceProvider.php
@@ -58,9 +58,9 @@ public function register(): void
             DocumentationPage::class => config('docs.output_directory', 'docs'),
         ]);
 
-        $this->storeCompiledSiteIn(config('site.output_directory', '_site'));
+        $this->storeCompiledSiteIn(config('hyde.output_directory', '_site'));
 
-        $this->useMediaDirectory(config('site.media_directory', '_media'));
+        $this->useMediaDirectory(config('hyde.media_directory', '_media'));
 
         $this->discoverBladeViewsIn(BladePage::sourceDirectory());
 

diff --git a/packages/framework/src/Framework/Services/DocumentationSearchService.php b/packages/framework/src/Framework/Services/DocumentationSearchService.php
@@ -81,7 +81,7 @@ protected function getSearchContentForDocument(DocumentationPage $page): string
 
     protected function formatDestination(string $slug): string
     {
-        if (config('site.pretty_urls', false) === true) {
+        if (config('hyde.pretty_urls', false) === true) {
             return $slug === 'index' ? '' : $slug;
         }
 

diff --git a/packages/framework/src/Framework/Services/YamlConfigurationService.php b/packages/framework/src/Framework/Services/YamlConfigurationService.php
@@ -16,8 +16,8 @@ class YamlConfigurationService
     public static function boot(): void
     {
         if (static::hasFile()) {
-            Config::set('site', array_merge(
-                Config::get('site', []),
+            Config::set('hyde', array_merge(
+                Config::get('hyde', []),
                 static::getYaml()
             ));
         }

diff --git a/packages/framework/src/Pages/Concerns/HydePage.php b/packages/framework/src/Pages/Concerns/HydePage.php
@@ -267,7 +267,7 @@ public function getBladeView(): string
      */
     public function htmlTitle(): string
     {
-        return config('site.name', 'HydePHP').' - '.$this->title;
+        return config('hyde.name', 'HydePHP').' - '.$this->title;
     }
 
     public function metadata(): PageMetadataBag

diff --git a/packages/framework/tests/Feature/Commands/BuildRssFeedCommandTest.php b/packages/framework/tests/Feature/Commands/BuildRssFeedCommandTest.php
@@ -15,7 +15,7 @@ class BuildRssFeedCommandTest extends TestCase
 {
     public function test_rss_feed_is_generated_when_conditions_are_met()
     {
-        config(['site.url' => 'https://example.com']);
+        config(['hyde.url' => 'https://example.com']);
         config(['hyde.generate_rss_feed' => true]);
         $this->file('_posts/foo.md');
 
@@ -28,7 +28,7 @@ public function test_rss_feed_is_generated_when_conditions_are_met()
 
     public function test_rss_filename_can_be_changed()
     {
-        config(['site.url' => 'https://example.com']);
+        config(['hyde.url' => 'https://example.com']);
         config(['hyde.generate_rss_feed' => true]);
         config(['hyde.rss_filename' => 'blog.xml']);
         $this->file('_posts/foo.md');

diff --git a/packages/framework/tests/Feature/Commands/BuildSitemapCommandTest.php b/packages/framework/tests/Feature/Commands/BuildSitemapCommandTest.php
@@ -15,8 +15,8 @@ class BuildSitemapCommandTest extends TestCase
 {
     public function test_sitemap_is_generated_when_conditions_are_met()
     {
-        config(['site.url' => 'https://example.com']);
-        config(['site.generate_sitemap' => true]);
+        config(['hyde.url' => 'https://example.com']);
+        config(['hyde.generate_sitemap' => true]);
 
         $this->assertFileDoesNotExist(Hyde::path('_site/sitemap.xml'));
 

diff --git a/packages/framework/tests/Feature/ConfigurableFeaturesTest.php b/packages/framework/tests/Feature/ConfigurableFeaturesTest.php
@@ -43,20 +43,20 @@ public function test_has_feature_returns_true_when_feature_is_enabled()
 
     public function test_can_generate_sitemap_helper_returns_true_if_hyde_has_base_url()
     {
-        config(['site.url' => 'foo']);
+        config(['hyde.url' => 'foo']);
         $this->assertTrue(Features::sitemap());
     }
 
     public function test_can_generate_sitemap_helper_returns_false_if_hyde_does_not_have_base_url()
     {
-        config(['site.url' => '']);
+        config(['hyde.url' => '']);
         $this->assertFalse(Features::sitemap());
     }
 
     public function test_can_generate_sitemap_helper_returns_false_if_sitemaps_are_disabled_in_config()
     {
-        config(['site.url' => 'foo']);
-        config(['site.generate_sitemap' => false]);
+        config(['hyde.url' => 'foo']);
+        config(['hyde.generate_sitemap' => false]);
         $this->assertFalse(Features::sitemap());
     }
 

diff --git a/packages/framework/tests/Feature/Foundation/HyperlinksTest.php b/packages/framework/tests/Feature/Foundation/HyperlinksTest.php
@@ -59,7 +59,7 @@ public function test_image_helper_returns_qualified_absolute_uri_when_requested_
 
     public function test_image_helper_returns_default_relative_path_when_qualified_absolute_uri_is_requested_but_site_has_no_base_url()
     {
-        config(['site.url' => null]);
+        config(['hyde.url' => null]);
         $this->assertEquals('media/test.jpg', $this->class->image('test.jpg', true));
     }
 

diff --git a/packages/framework/tests/Feature/GlobalMetadataBagTest.php b/packages/framework/tests/Feature/GlobalMetadataBagTest.php
@@ -39,8 +39,8 @@ public function test_site_metadata_automatically_adds_sitemap_when_enabled()
     {
         $this->emptyConfig();
 
-        config(['site.url' => 'foo']);
-        config(['site.generate_sitemap' => true]);
+        config(['hyde.url' => 'foo']);
+        config(['hyde.generate_sitemap' => true]);
 
         $this->assertEquals('<link rel="sitemap" href="foo/sitemap.xml" type="application/xml" title="Sitemap">', GlobalMetadataBag::make()->render());
     }
@@ -49,8 +49,8 @@ public function test_site_metadata_sitemap_uses_configured_site_url()
     {
         $this->emptyConfig();
 
-        config(['site.url' => 'bar']);
-        config(['site.generate_sitemap' => true]);
+        config(['hyde.url' => 'bar']);
+        config(['hyde.generate_sitemap' => true]);
 
         $this->assertEquals('<link rel="sitemap" href="bar/sitemap.xml" type="application/xml" title="Sitemap">', GlobalMetadataBag::make()->render());
     }
@@ -59,7 +59,7 @@ public function test_site_metadata_automatically_adds_rss_feed_when_enabled()
     {
         $this->emptyConfig();
 
-        config(['site.url' => 'foo']);
+        config(['hyde.url' => 'foo']);
         config(['hyde.generate_rss_feed' => true]);
         $this->file('_posts/foo.md');
 
@@ -70,7 +70,7 @@ public function test_site_metadata_rss_feed_uses_configured_site_url()
     {
         $this->emptyConfig();
 
-        config(['site.url' => 'bar']);
+        config(['hyde.url' => 'bar']);
         config(['hyde.generate_rss_feed' => true]);
         $this->file('_posts/foo.md');
 
@@ -81,8 +81,8 @@ public function test_site_metadata_rss_feed_uses_configured_site_name()
     {
         $this->emptyConfig();
 
-        config(['site.url' => 'foo']);
-        config(['site.name' => 'Site']);
+        config(['hyde.url' => 'foo']);
+        config(['hyde.name' => 'Site']);
         config(['hyde.generate_rss_feed' => true]);
         $this->file('_posts/foo.md');
 
@@ -93,7 +93,7 @@ public function test_site_metadata_rss_feed_uses_configured_rss_file_name()
     {
         $this->emptyConfig();
 
-        config(['site.url' => 'foo']);
+        config(['hyde.url' => 'foo']);
         config(['hyde.rss_filename' => 'posts.rss']);
         config(['hyde.generate_rss_feed' => true]);
         $this->file('_posts/foo.md');
@@ -142,9 +142,9 @@ public function test_metadata_existing_in_the_current_page_is_not_added_regardle
 
     protected function emptyConfig(): void
     {
-        config(['site.url' => null]);
+        config(['hyde.url' => null]);
         config(['hyde.meta' => []]);
         config(['hyde.generate_rss_feed' => false]);
-        config(['site.generate_sitemap' => false]);
+        config(['hyde.generate_sitemap' => false]);
     }
 }
diff --git a/packages/framework/tests/Feature/HydeKernelTest.php b/packages/framework/tests/Feature/HydeKernelTest.php
@@ -137,11 +137,11 @@ public function test_markdown_helper_converts_indented_markdown_to_html()
 
     public function test_format_html_path_helper_formats_path_according_to_config_rules()
     {
-        Config::set('site.pretty_urls', false);
+        Config::set('hyde.pretty_urls', false);
         $this->assertSame('foo.html', Hyde::formatLink('foo.html'));
         $this->assertSame('index.html', Hyde::formatLink('index.html'));
 
-        Config::set('site.pretty_urls', true);
+        Config::set('hyde.pretty_urls', true);
         $this->assertSame('foo', Hyde::formatLink('foo.html'));
         $this->assertSame('/', Hyde::formatLink('index.html'));
     }
@@ -188,24 +188,24 @@ public function test_image_helper_supports_custom_media_directories()
 
     public function test_has_site_url_helper_returns_boolean_value_for_when_config_setting_is_set()
     {
-        Config::set('site.url', 'https://example.com');
+        Config::set('hyde.url', 'https://example.com');
         $this->assertTrue(Hyde::hasSiteUrl());
 
-        Config::set('site.url', null);
+        Config::set('hyde.url', null);
         $this->assertFalse(Hyde::hasSiteUrl());
     }
 
     public function test_url_returns_qualified_url_paths()
     {
-        Config::set('site.url', 'https://example.com');
+        Config::set('hyde.url', 'https://example.com');
         $this->assertSame('https://example.com', Hyde::url());
         $this->assertSame('https://example.com/foo', Hyde::url('foo'));
 
-        Config::set('site.pretty_urls', false);
+        Config::set('hyde.pretty_urls', false);
         $this->assertSame('https://example.com/foo.html', Hyde::url('foo.html'));
         $this->assertSame('https://example.com/index.html', Hyde::url('index.html'));
 
-        Config::set('site.pretty_urls', true);
+        Config::set('hyde.pretty_urls', true);
         $this->assertSame('https://example.com/foo', Hyde::url('foo.html'));
         $this->assertSame('https://example.com', Hyde::url('index.html'));
     }
@@ -414,7 +414,7 @@ public function test_media_output_directory_can_be_changed_in_configuration()
     {
         $this->assertEquals('_media', Hyde::getMediaDirectory());
 
-        config(['site.media_directory' => '_assets']);
+        config(['hyde.media_directory' => '_assets']);
         (new HydeServiceProvider($this->app))->register();
 
         $this->assertEquals('_assets', Hyde::getMediaDirectory());
-Original file line number
+Diff line change
@@ Expand Up / @@ -21,7 +21,7 @@ @@
         |
         */
-        'header_title' => config('site.name', 'HydePHP').' Docs',
+        'header_title' => config('hyde.name', 'HydePHP').' Docs',
         /*
         |--------------------------------------------------------------------------
@@ Expand Down @@