Internal: Extract testing helpers and refactor tests

src/Console/Commands/ServeCommand.php

@@ -13,6 +13,7 @@
 use Hyde\RealtimeCompiler\ConsoleOutput;
 use Illuminate\Support\Facades\Process;
 
+use function rtrim;
 use function sprintf;
 use function in_array;
 use function str_replace;

src/Support/DataCollections.php

@@ -16,6 +16,7 @@
 use function json_decode;
 use function sprintf;
 use function unslash;
+use function str_starts_with;
 
 /**
  * Automatically generates Laravel Collections from static data files,

tests/Feature/Commands/BuildRssFeedCommandTest.php

@@ -16,7 +16,7 @@ class BuildRssFeedCommandTest extends TestCase
 {
     public function testRssFeedIsGeneratedWhenConditionsAreMet()
     {
-        config(['hyde.url' => 'https://example.com']);
+        $this->withSiteUrl();
         config(['hyde.rss.enabled' => true]);
         $this->file('_posts/foo.md');
 
@@ -29,7 +29,7 @@ public function testRssFeedIsGeneratedWhenConditionsAreMet()
 
     public function testRssFilenameCanBeChanged()
     {
-        config(['hyde.url' => 'https://example.com']);
+        $this->withSiteUrl();
         config(['hyde.rss.enabled' => true]);
         config(['hyde.rss.filename' => 'blog.xml']);
         $this->file('_posts/foo.md');

tests/Feature/Commands/BuildSitemapCommandTest.php

@@ -16,7 +16,7 @@ class BuildSitemapCommandTest extends TestCase
 {
     public function testSitemapIsGeneratedWhenConditionsAreMet()
     {
-        config(['hyde.url' => 'https://example.com']);
+        $this->withSiteUrl();
         config(['hyde.generate_sitemap' => true]);
 
         $this->assertFileDoesNotExist(Hyde::path('_site/sitemap.xml'));

tests/Feature/ConfigurableFeaturesTest.php

@@ -41,19 +41,19 @@ public function testHasFeatureReturnsTrueWhenFeatureIsEnabled()
 
     public function testCanGenerateSitemapHelperReturnsTrueIfHydeHasBaseUrl()
     {
-        config(['hyde.url' => 'foo']);
+        $this->withSiteUrl();
         $this->assertTrue(Features::sitemap());
     }
 
     public function testCanGenerateSitemapHelperReturnsFalseIfHydeDoesNotHaveBaseUrl()
     {
-        config(['hyde.url' => '']);
+        $this->withoutSiteUrl();
         $this->assertFalse(Features::sitemap());
     }
 
     public function testCanGenerateSitemapHelperReturnsFalseIfSitemapsAreDisabledInConfig()
     {
-        config(['hyde.url' => 'foo']);
+        $this->withSiteUrl();
         config(['hyde.generate_sitemap' => false]);
         $this->assertFalse(Features::sitemap());
     }

tests/Feature/Foundation/HyperlinksTest.php

@@ -62,7 +62,7 @@ public function testAssetHelperReturnsQualifiedAbsoluteUriWhenRequestedAndSiteHa
 
     public function testAssetHelperReturnsDefaultRelativePathWhenQualifiedAbsoluteUriIsRequestedButSiteHasNoBaseUrl()
     {
-        config(['hyde.url' => null]);
+        $this->withoutSiteUrl();
         $this->assertSame('media/test.jpg', $this->class->asset('test.jpg', true));
     }
 

tests/Feature/GlobalMetadataBagTest.php

@@ -15,10 +15,15 @@
  */
 class GlobalMetadataBagTest extends TestCase
 {
-    public function testSiteMetadataAddsConfigDefinedMetadata()
+    protected function setUp(): void
     {
+        parent::setUp();
+
         $this->withEmptyConfig();
+    }
 
+    public function testSiteMetadataAddsConfigDefinedMetadata()
+    {
         config(['hyde.meta' => [
             Meta::link('foo', 'bar'),
             Meta::name('foo', 'bar'),
@@ -43,53 +48,37 @@ public function testSiteMetadataAddsConfigDefinedMetadata()
 
     public function testSiteMetadataAutomaticallyAddsSitemapWhenEnabled()
     {
-        $this->withEmptyConfig();
-
-        config(['hyde.url' => 'foo']);
-        config(['hyde.generate_sitemap' => true]);
+        config(['hyde.url' => 'foo', 'hyde.generate_sitemap' => true]);
 
         $this->assertSame('<link rel="sitemap" href="foo/sitemap.xml" type="application/xml" title="Sitemap">', GlobalMetadataBag::make()->render());
     }
 
     public function testSiteMetadataSitemapUsesConfiguredSiteUrl()
     {
-        $this->withEmptyConfig();
-
-        config(['hyde.url' => 'bar']);
-        config(['hyde.generate_sitemap' => true]);
+        config(['hyde.url' => 'bar', 'hyde.generate_sitemap' => true]);
 
         $this->assertSame('<link rel="sitemap" href="bar/sitemap.xml" type="application/xml" title="Sitemap">', GlobalMetadataBag::make()->render());
     }
 
     public function testSiteMetadataAutomaticallyAddsRssFeedWhenEnabled()
     {
-        $this->withEmptyConfig();
-
-        config(['hyde.url' => 'foo']);
-        config(['hyde.rss.enabled' => true]);
+        config(['hyde.url' => 'foo', 'hyde.rss.enabled' => true]);
         $this->file('_posts/foo.md');
 
         $this->assertSame('<link rel="alternate" href="foo/feed.xml" type="application/rss+xml" title="HydePHP RSS Feed">', GlobalMetadataBag::make()->render());
     }
 
     public function testSiteMetadataRssFeedUsesConfiguredSiteUrl()
     {
-        $this->withEmptyConfig();
-
-        config(['hyde.url' => 'bar']);
-        config(['hyde.rss.enabled' => true]);
+        config(['hyde.url' => 'bar', 'hyde.rss.enabled' => true]);
         $this->file('_posts/foo.md');
 
         $this->assertSame('<link rel="alternate" href="bar/feed.xml" type="application/rss+xml" title="HydePHP RSS Feed">', GlobalMetadataBag::make()->render());
     }
 
     public function testSiteMetadataRssFeedUsesConfiguredSiteName()
     {
-        $this->withEmptyConfig();
-
-        config(['hyde.url' => 'foo']);
-        config(['hyde.name' => 'Site']);
-        config(['hyde.rss.enabled' => true]);
+        config(['hyde.url' => 'foo', 'hyde.name' => 'Site', 'hyde.rss.enabled' => true]);
         $config = config('hyde');
         unset($config['rss']['description']);
         config(['hyde' => $config]);
@@ -100,11 +89,7 @@ public function testSiteMetadataRssFeedUsesConfiguredSiteName()
 
     public function testSiteMetadataRssFeedUsesConfiguredRssFileName()
     {
-        $this->withEmptyConfig();
-
-        config(['hyde.url' => 'foo']);
-        config(['hyde.rss.filename' => 'posts.rss']);
-        config(['hyde.rss.enabled' => true]);
+        config(['hyde.url' => 'foo', 'hyde.rss.filename' => 'posts.rss', 'hyde.rss.enabled' => true]);
         $this->file('_posts/foo.md');
 
         $this->assertStringContainsString(
@@ -115,15 +100,10 @@ public function testSiteMetadataRssFeedUsesConfiguredRssFileName()
 
     public function testMetadataExistingInTheCurrentPageIsNotAdded()
     {
-        $this->withEmptyConfig();
-
         $duplicate = Meta::name('remove', 'me');
         $keep = Meta::name('keep', 'this');
 
-        config(['hyde.meta' => [
-            $duplicate,
-            $keep,
-        ]]);
+        config(['hyde.meta' => [$duplicate, $keep]]);
 
         $page = new MarkdownPage('foo');
         $page->metadata->add($duplicate);
@@ -136,8 +116,6 @@ public function testMetadataExistingInTheCurrentPageIsNotAdded()
 
     public function testMetadataExistingInTheCurrentPageIsNotAddedRegardlessOfItsValue()
     {
-        $this->withEmptyConfig();
-
         config(['hyde.meta' => [Meta::name('foo', 'bar')]]);
 
         $page = new MarkdownPage('foo');
@@ -151,9 +129,11 @@ public function testMetadataExistingInTheCurrentPageIsNotAddedRegardlessOfItsVal
 
     protected function withEmptyConfig(): void
     {
-        config(['hyde.url' => null]);
-        config(['hyde.meta' => []]);
-        config(['hyde.rss.enabled' => false]);
-        config(['hyde.generate_sitemap' => false]);
+        config([
+            'hyde.url' => null,
+            'hyde.meta' => [],
+            'hyde.rss.enabled' => false,
+            'hyde.generate_sitemap' => false,
+        ]);
     }
 }

tests/Feature/HydePageTest.php

@@ -822,15 +822,15 @@ public function testDocumentationPageCanBeHiddenFromNavigationUsingConfig()
 
     public function testGetCanonicalUrlReturnsUrlForTopLevelPage()
     {
-        config(['hyde.url' => 'https://example.com']);
+        $this->withSiteUrl();
 
         $page = new MarkdownPage('foo');
         $this->assertSame('https://example.com/foo.html', $page->getCanonicalUrl());
     }
 
     public function testGetCanonicalUrlReturnsPrettyUrlForTopLevelPage()
     {
-        config(['hyde.url' => 'https://example.com']);
+        $this->withSiteUrl();
         config(['hyde.pretty_urls' => true]);
 
         $page = new MarkdownPage('foo');
@@ -840,7 +840,7 @@ public function testGetCanonicalUrlReturnsPrettyUrlForTopLevelPage()
 
     public function testGetCanonicalUrlReturnsUrlForNestedPage()
     {
-        config(['hyde.url' => 'https://example.com']);
+        $this->withSiteUrl();
 
         $page = new MarkdownPage('foo/bar');
 
@@ -849,7 +849,7 @@ public function testGetCanonicalUrlReturnsUrlForNestedPage()
 
     public function testGetCanonicalUrlReturnsUrlForDeeplyNestedPage()
     {
-        config(['hyde.url' => 'https://example.com']);
+        $this->withSiteUrl();
 
         $page = new MarkdownPage('foo/bar/baz');
 
@@ -858,7 +858,7 @@ public function testGetCanonicalUrlReturnsUrlForDeeplyNestedPage()
 
     public function testCanonicalUrlIsNotSetWhenIdentifierIsNull()
     {
-        config(['hyde.url' => 'https://example.com']);
+        $this->withSiteUrl();
 
         $page = new MarkdownPage();
 
@@ -869,7 +869,7 @@ public function testCanonicalUrlIsNotSetWhenIdentifierIsNull()
 
     public function testCanonicalUrlIsNotSetWhenSiteUrlIsNull()
     {
-        config(['hyde.url' => null]);
+        $this->withoutSiteUrl();
 
         $page = new MarkdownPage('foo');
 
@@ -880,7 +880,7 @@ public function testCanonicalUrlIsNotSetWhenSiteUrlIsNull()
 
     public function testCustomCanonicalLinkCanBeSetInFrontMatter()
     {
-        config(['hyde.url' => 'https://example.com']);
+        $this->withSiteUrl();
 
         $page = MarkdownPage::make(matter: ['canonicalUrl' => 'foo/bar']);
 

tests/Feature/MetadataHelperTest.php

@@ -18,7 +18,7 @@ protected function setUp(): void
         parent::setUp();
 
         config(['hyde.meta' => []]);
-        config(['hyde.url' => null]);
+        $this->withoutSiteUrl();
     }
 
     public function testNameMethodReturnsAValidHtmlMetaString()

tests/Feature/MetadataTest.php

@@ -29,7 +29,7 @@ protected function setUp(): void
     {
         parent::setUp();
 
-        config(['hyde.url' => null]);
+        $this->withoutSiteUrl();
         config(['hyde.meta' => []]);
         config(['hyde.rss.enabled' => false]);
         config(['hyde.generate_sitemap' => false]);
@@ -205,7 +205,7 @@ public function testDynamicMetadataOverridesConfigDefinedMetadata()
 
     public function testDoesNotAddCanonicalLinkWhenBaseUrlIsNotSet()
     {
-        config(['hyde.url' => null]);
+        $this->withoutSiteUrl();
 
         $page = MarkdownPage::make('bar');
 

tests/Feature/Services/BuildTaskServiceTest.php

@@ -30,7 +30,7 @@ class BuildTaskServiceTest extends TestCase
      */
     public function testBuildCommandCanRunBuildTasks()
     {
-        config(['hyde.url' => 'https://example.com']);
+        $this->withSiteUrl();
 
         $this->artisan('build')
             ->expectsOutputToContain('Removing all files from build directory')

tests/Feature/Services/RssFeedServiceTest.php

@@ -41,7 +41,7 @@ public function testXmlElementHasChannelElement()
     public function testXmlChannelElementHasRequiredElements()
     {
         config(['hyde.name' => 'Test Blog']);
-        config(['hyde.url' => 'https://example.com']);
+        $this->withSiteUrl();
         config(['hyde.rss.description' => 'Test Blog RSS Feed']);
 
         $service = new RssFeedGenerator();
@@ -57,7 +57,7 @@ public function testXmlChannelElementHasRequiredElements()
 
     public function testXmlChannelElementHasAdditionalElements()
     {
-        config(['hyde.url' => 'https://example.com']);
+        $this->withSiteUrl();
 
         $service = new RssFeedGenerator();
 
@@ -102,7 +102,7 @@ public function testMarkdownBlogPostsAreAddedToRssFeedThroughAutodiscovery()
             MD
         );
 
-        config(['hyde.url' => 'https://example.com']);
+        $this->withSiteUrl();
 
         file_put_contents(Hyde::path('_media/rss-test.jpg'), 'statData'); // 8 bytes to test stat gets file length
 
@@ -150,7 +150,7 @@ public function testCanGenerateFeedHelperReturnsTrueIfHydeHasBaseUrl()
 
     public function testCanGenerateFeedHelperReturnsFalseIfHydeDoesNotHaveBaseUrl()
     {
-        config(['hyde.url' => '']);
+        $this->withoutSiteUrl();
         $this->file('_posts/foo.md');
 
         $this->assertFalse(Features::rss());

tests/Feature/Services/SitemapServiceTest.php

@@ -103,7 +103,7 @@ public function testGenerateSitemapShorthandMethodReturnsXmlString()
     public function testUrlItemIsGeneratedCorrectly()
     {
         config(['hyde.pretty_urls' => false]);
-        config(['hyde.url' => 'https://example.com']);
+        $this->withSiteUrl();
 
         Filesystem::touch('_pages/0-test.blade.php');
 
@@ -122,7 +122,7 @@ public function testUrlItemIsGeneratedCorrectly()
     public function testUrlItemIsGeneratedWithPrettyUrlsIfEnabled()
     {
         config(['hyde.pretty_urls' => true]);
-        config(['hyde.url' => 'https://example.com']);
+        $this->withSiteUrl();
 
         Filesystem::touch('_pages/0-test.blade.php');
 
@@ -170,7 +170,7 @@ public function testAllRouteTypesAreDiscovered()
 
     public function testLinksFallbackToRelativeLinksWhenASiteUrlIsNotSet()
     {
-        config(['hyde.url' => null]);
+        $this->withoutSiteUrl();
 
         $service = new SitemapGenerator();
         $service->generate();

tests/Feature/Services/ValidationServiceTest.php

@@ -132,14 +132,14 @@ public function testCheckSiteHasAnAppCssStylesheetCanFail()
 
     public function testCheckSiteHasABaseUrlSetCanPass()
     {
-        config(['hyde.url' => 'https://example.com']);
+        $this->withSiteUrl();
 
         $this->testMethod('check_site_has_a_base_url_set', 0);
     }
 
     public function testCheckSiteHasABaseUrlSetCanFail()
     {
-        config(['hyde.url' => null]);
+        $this->withoutSiteUrl();
 
         $this->testMethod('check_site_has_a_base_url_set', 2);
     }

tests/Feature/SiteTest.php

@@ -17,10 +17,10 @@ public function testUrl()
     {
         $this->assertSame('http://localhost', Site::url());
 
-        config(['hyde.url' => null]);
+        $this->withoutSiteUrl();
         $this->assertNull(Site::url());
 
-        config(['hyde.url' => 'https://example.com']);
+        $this->withSiteUrl();
         $this->assertSame('https://example.com', Site::url());
     }