Merge pull request #1753 from hydephp/deprecate-global-unslash-function

emmadesilva · web-flow · commit 3757b4669245 · 2024-06-28T16:50:22.000+02:00
[1.x] Deprecate the global `unslash` function
diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
@@ -23,7 +23,7 @@ This serves two purposes:
 - Updated the `.env.example` file to contain more details on the site URL setting's usages in https://github.com/hydephp/develop/pull/1746
 
 ### Deprecated
-- for soon-to-be removed features.
+- Deprecated the global `unslash()` function, replaced with the existing namespaced `\Hyde\unslash()` function in https://github.com/hydephp/develop/pull/1753
 
 ### Removed
 - for now removed features.
diff --git a/packages/framework/src/Console/Commands/RebuildPageCommand.php b/packages/framework/src/Console/Commands/RebuildPageCommand.php
@@ -21,7 +21,7 @@
 use function file_exists;
 use function in_array;
 use function str_replace;
-use function unslash;
+use function Hyde\unslash;
 
 /**
  * Build a single static site file.
diff --git a/packages/framework/src/Foundation/Kernel/Filesystem.php b/packages/framework/src/Foundation/Kernel/Filesystem.php
@@ -17,7 +17,7 @@
 use function array_map;
 use function is_array;
 use function str_starts_with;
-use function unslash;
+use function Hyde\unslash;
 use function unlink;
 use function touch;
 
diff --git a/packages/framework/src/Framework/Actions/CreatesNewPageSourceFile.php b/packages/framework/src/Framework/Actions/CreatesNewPageSourceFile.php
@@ -20,7 +20,7 @@
 use function basename;
 use function in_array;
 use function str_contains;
-use function unslash;
+use function Hyde\unslash;
 use function rtrim;
 
 /**
diff --git a/packages/framework/src/Framework/Concerns/RegistersFileLocations.php b/packages/framework/src/Framework/Concerns/RegistersFileLocations.php
@@ -13,7 +13,7 @@
 use function array_unique;
 use function array_merge;
 use function base_path;
-use function unslash;
+use function Hyde\unslash;
 
 /**
  * This trait registers the file paths for important Hyde locations.
diff --git a/packages/framework/src/Framework/Factories/FeaturedImageFactory.php b/packages/framework/src/Framework/Factories/FeaturedImageFactory.php
@@ -13,7 +13,7 @@
 
 use function str_starts_with;
 use function is_string;
-use function unslash;
+use function Hyde\unslash;
 
 class FeaturedImageFactory extends Concerns\PageDataFactory implements FeaturedImageSchema
 {
diff --git a/packages/framework/src/Framework/Services/ViewDiffService.php b/packages/framework/src/Framework/Services/ViewDiffService.php
@@ -9,7 +9,7 @@
 use function Hyde\unixsum_file;
 use function str_replace;
 use function in_array;
-use function unslash;
+use function Hyde\unslash;
 use function glob;
 
 /**
diff --git a/packages/framework/src/Pages/Concerns/HydePage.php b/packages/framework/src/Pages/Concerns/HydePage.php
@@ -25,7 +25,7 @@
 use Hyde\Support\Models\RouteKey;
 use Illuminate\Support\Str;
 
-use function unslash;
+use function Hyde\unslash;
 use function filled;
 use function ltrim;
 use function rtrim;
diff --git a/packages/framework/src/Pages/DocumentationPage.php b/packages/framework/src/Pages/DocumentationPage.php
@@ -12,7 +12,7 @@
 
 use function trim;
 use function sprintf;
-use function unslash;
+use function Hyde\unslash;
 use function basename;
 
 /**
diff --git a/packages/framework/src/Support/DataCollections.php b/packages/framework/src/Support/DataCollections.php
@@ -15,7 +15,7 @@
 use function implode;
 use function json_decode;
 use function sprintf;
-use function unslash;
+use function Hyde\unslash;
 use function str_starts_with;
 
 /**
diff --git a/packages/framework/src/Support/Models/RouteKey.php b/packages/framework/src/Support/Models/RouteKey.php
@@ -6,7 +6,7 @@
 
 use Stringable;
 
-use function unslash;
+use function Hyde\unslash;
 
 /**
  * Route keys provide the core bindings of the HydePHP routing system as they are what canonically identifies a page.
diff --git a/packages/framework/src/helpers.php b/packages/framework/src/helpers.php
@@ -4,6 +4,7 @@
 
 namespace {
     use Hyde\Foundation\HydeKernel;
+    use JetBrains\PhpStorm\Deprecated;
 
     if (! function_exists('hyde')) {
         /**
@@ -18,10 +19,15 @@ function hyde(): HydeKernel
     if (! function_exists('unslash')) {
         /**
          * Remove trailing slashes from the start and end of a string.
+         *
+         * @deprecated This function will be replaced by {@see \Hyde\unslash()} in v2.0
+         *
+         * @codeCoverageIgnore This function is deprecated and will be removed in a future release.
          */
+        #[Deprecated(reason: 'Replaced by the \Hyde\unslash() function', replacement: '\Hyde\unslash(%parametersList%)', since: '1.7.0')]
         function unslash(string $string): string
         {
-            return trim($string, '/\\');
+            return \Hyde\unslash($string);
         }
     }
 
diff --git a/packages/framework/tests/Feature/HelpersTest.php b/packages/framework/tests/Feature/HelpersTest.php
@@ -38,31 +38,31 @@ public function testCanCallMethodsOnReturnedHydeClass()
         $this->assertSame(Hyde::path(), hyde()->path());
     }
 
-    /** @covers ::unslash */
+    /** @covers ::\Hyde\unslash */
     public function testUnslashFunctionExists()
     {
-        $this->assertTrue(function_exists('unslash'));
+        $this->assertTrue(function_exists('Hyde\unslash'));
     }
 
-    /** @covers ::unslash */
+    /** @covers ::\Hyde\unslash */
     public function testUnslashFunctionTrimsTrailingSlashes()
     {
         $tests = ['foo',  '/foo',  'foo/',  '/foo/',  '\foo\\',  '\\/foo/\\'];
 
         foreach ($tests as $test) {
-            $this->assertSame('foo', unslash($test));
+            $this->assertSame('foo', \Hyde\unslash($test));
         }
 
         $tests = ['',  '/',  '\\',  '/\\'];
 
         foreach ($tests as $test) {
-            $this->assertSame('', unslash($test));
+            $this->assertSame('', \Hyde\unslash($test));
         }
 
         $tests = ['foo/bar',  'foo/bar/',  'foo/bar\\',  '\\/foo/bar/\\'];
 
         foreach ($tests as $test) {
-            $this->assertSame('foo/bar', unslash($test));
+            $this->assertSame('foo/bar', \Hyde\unslash($test));
         }
     }
 
@@ -224,7 +224,7 @@ public function testUnslashFunctionExistsInHydeNamespace()
     /** @covers ::\Hyde\unslash */
     public function testNamespacedUnslashFunction()
     {
-        $this->assertSame(unslash('foo'), \Hyde\unslash('foo'));
+        $this->assertSame(\Hyde\unslash('foo'), \Hyde\unslash('foo'));
     }
 
     /** @covers ::\Hyde\unixsum */
diff --git a/packages/realtime-compiler/src/Routing/PageRouter.php b/packages/realtime-compiler/src/Routing/PageRouter.php
@@ -92,7 +92,7 @@ public static function handle(Request $request): Response
 
     protected function getPageFromRoute(): HydePage
     {
-        if (unslash($this->request->path) === DocumentationSearchPage::routeKey() && DocumentationSearchPage::enabled()) {
+        if (\Hyde\unslash($this->request->path) === DocumentationSearchPage::routeKey() && DocumentationSearchPage::enabled()) {
             // Since this page is not present within the search index (as it's normally generated by a build task)
             // we instantiate and return it here.
             return new DocumentationSearchPage();

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@`
`13`	`13`
`14`	`14`	`use function str_starts_with;`
`15`	`15`	`use function is_string;`
`16`		`-use function unslash;`
	`16`	`+use function Hyde\unslash;`
`17`	`17`
`18`	`18`	`class FeaturedImageFactory extends Concerns\PageDataFactory implements FeaturedImageSchema`
`19`	`19`	`{`