Fix #330, Create helper to make pretty URLs if enabled

Author: caendesilva

src/Concerns/Internal/FileHelpers.php

@@ -73,6 +73,21 @@ public static function vendorPath(string $path = ''): string
         return static::path('vendor/hyde/framework/'.trim($path, '/\\'));
     }
 
+    /**
+     * Format a link to an HTML file, allowing for pretty URLs, if enabled.
+     * @see \Tests\Unit\HydeFileHelperForPageLinksCanCreatePrettyUrlsTest
+     */
+    public static function pageLink(string $destination): string
+    {
+        if (config('hyde.prettyUrls', false) === true) {
+            if (str_ends_with($destination, '.html')) {
+                return substr($destination, 0, -5);
+            }
+        }
+
+        return $destination;
+    }
+
     /**
      * Inject the proper number of `../` before the links in Blade templates.
      *

tests/Unit/HydeFileHelperForPageLinksCanCreatePrettyUrlsTest.php

@@ -0,0 +1,71 @@
+<?php
+
+namespace Tests\Unit;
+
+use Hyde\Framework\Hyde;
+use Tests\TestCase;
+
+/**
+ * Class HydeFileHelperForPageLinksCanCreatePrettyUrlsTest.
+ *
+ * @covers \Hyde\Framework\Concerns\Internal\FileHelpers
+ */
+class HydeFileHelperForPageLinksCanCreatePrettyUrlsTest extends TestCase
+{
+    public function test_helper_returns_string_as_is_if_pretty_urls_is_not_true()
+    {
+        config(['hyde.prettyUrls' => false]);
+
+        $this->assertEquals('foo/bar.html', Hyde::pageLink('foo/bar.html'));
+    }
+
+    public function test_helper_returns_pretty_url_if_pretty_urls_is_true()
+    {
+        config(['hyde.prettyUrls' => true]);
+
+        $this->assertEquals('foo/bar', Hyde::pageLink('foo/bar.html'));
+    }
+
+    public function test_non_pretty_urls_is_default_value_when_config_is_not_set()
+    {
+        config(['hyde.prettyUrls' => null]);
+
+        $this->assertEquals('foo/bar.html', Hyde::pageLink('foo/bar.html'));
+    }
+
+    public function test_helper_respects_absolute_urls()
+    {
+        config(['hyde.prettyUrls' => false]);
+        $this->assertEquals('/foo/bar.html', Hyde::pageLink('/foo/bar.html'));
+    }
+
+    public function test_helper_respects_pretty_absolute_urls()
+    {
+        config(['hyde.prettyUrls' => true]);
+        $this->assertEquals('/foo/bar', Hyde::pageLink('/foo/bar.html'));
+    }
+
+    public function test_helper_respects_relative_urls()
+    {
+        config(['hyde.prettyUrls' => false]);
+        $this->assertEquals('../foo/bar.html', Hyde::pageLink('../foo/bar.html'));
+    }
+
+    public function test_helper_respects_pretty_relative_urls()
+    {
+        config(['hyde.prettyUrls' => true]);
+        $this->assertEquals('../foo/bar', Hyde::pageLink('../foo/bar.html'));
+    }
+
+    public function test_non_html_links_are_not_modified()
+    {
+        config(['hyde.prettyUrls' => true]);
+        $this->assertEquals('/foo/bar.jpg', Hyde::pageLink('/foo/bar.jpg'));
+    }
+
+    public function test_helper_respects_absolute_urls_with_pretty_urls_enabled()
+    {
+        config(['hyde.prettyUrls' => true]);
+        $this->assertEquals('/foo/bar.jpg', Hyde::pageLink('/foo/bar.jpg'));
+    }
+}