Refactor static methods

Author: MGatner

system/HTTP/URL.php

@@ -12,6 +12,7 @@
 namespace CodeIgniter\HTTP;
 
 use CodeIgniter\HTTP\IncomingRequest;
+use CodeIgniter\Router\Exceptions\RouterException;
 use Config\App;
 use Config\Services;
 use InvalidArgumentException;
@@ -20,7 +21,7 @@
  * URI wrapper to work with complete project URLs.
  * This class creates immutable instances.
  */
-class URL
+final class URL
 {
 	/**
 	 * Underlying URI instance
@@ -34,18 +35,29 @@ class URL
 	 *
 	 * @var string
 	 */
-	protected $relativePath;
+	private $relativePath;
 
 	//--------------------------------------------------------------------
 
 	/**
-	 * Returns an instance representing the base URL.
+	 * Creates the base URL.
+	 *
+	 * @return static
+	 */
+	public static function base()
+	{
+		return static::public('');
+	}
+
+	/**
+	 * Creates a URL to unrouted public files (typically assets).
+	 * Similar to base_url('path/to/file')
 	 *
 	 * @param string $uri Additional URI string to include
 	 *
 	 * @return static
 	 */
-	final public static function base(string $uri = '')
+	public static function public(string $uri)
 	{
 		// Base URLs never include the index page
 		$config            = clone config('App');
@@ -55,33 +67,45 @@ final public static function base(string $uri = '')
 	}
 
 	/**
-	 * Returns an instance representing a routed URL.
-	 *
-	 * @param string $uri Named route, reverse route, or URI string
+	 * Returns an instance representing the current URL.
 	 *
 	 * @return static
 	 */
-	final public static function to(string $uri)
+	public static function current()
 	{
-		$uri = rtrim($uri, '/ ');
-
-		// Check for a named or reverse-route
-		if ($uri !== '' && $route = Services::routes()->reverseRoute($uri))
-		{
-			return new static($route);
-		}
+		return static::fromRequest(Services::request());
+	}
 
-		return new static($uri);
+	/**
+	 * Creates a framework URL.
+	 *
+	 * @param string $uri
+	 *
+	 * @return static
+	 */
+	public static function to(string $uri)
+	{
+		return new static(rtrim($uri, '/ '));
 	}
 
 	/**
-	 * Returns an instance representing the current URL.
+	 * Creates a URL to a named or reverse route.
+	 *
+	 * @param string $uri Named or reverse route
 	 *
 	 * @return static
+	 *
+	 * @throws RouterException
 	 */
-	final public static function current()
+	public static function route(string $uri)
 	{
-		return static::fromRequest(Services::request());
+		// Check for a named or reverse-route
+		if ($route = Services::routes()->reverseRoute($uri))
+		{
+			return new static($route);
+		}
+
+		throw RouterException::forInvalidRoute($uri);
 	}
 
 	/**
@@ -92,7 +116,7 @@ final public static function current()
 	 *
 	 * @return static
 	 */
-	final public static function fromRequest(IncomingRequest $request)
+	public static function fromRequest(IncomingRequest $request)
 	{
 		$path  = $request->detectPath($request->config->uriProtocol);
 		$query = isset($_SERVER['QUERY_STRING']) ? '?' . $_SERVER['QUERY_STRING'] : '';
@@ -109,7 +133,7 @@ final public static function fromRequest(IncomingRequest $request)
 	 * @param string   $relativePath
 	 * @param App|null $config
 	 */
-	final public function __construct(string $relativePath = '', App $config = null)
+	public function __construct(string $relativePath = '', App $config = null)
 	{
 		$config = $config ?? config('App');
 
@@ -175,11 +199,14 @@ public function getUri(): URI
 
 	/**
 	 * Returns this URL as a string.
+	 * Since this is typically for routing and
+	 * link purposes we strip any queries, but
+	 * they can be accessed via getUri().
 	 *
 	 * @return string
 	 */
 	public function __toString(): string
 	{
-		return (string) $this->uri;
+		return (string) $this->getUri()->setQuery('');
 	}
 }

tests/system/HTTP/URLTest.php

@@ -193,9 +193,9 @@ public function testBase(array $configs, string $baseURL, string $siteURL)
 		$this->assertSame($baseURL, (string) $url);
 	}
 
-	public function testBaseWithUri()
+	public function testPublic()
 	{
-		$url = URL::base('images/cat.gif');
+		$url = URL::public('images/cat.gif');
 
 		$this->assertSame('http://example.com/images/cat.gif', (string) $url);
 	}
@@ -207,20 +207,20 @@ public function testTo()
 		$this->assertSame('http://example.com/index.php/fruit/basket', (string) $url);
 	}
 
-	public function testToNamedRoute()
+	public function testNamedRoute()
 	{
-		Services::routes()->add('apples', 'Home::index', ['as' => 'home']);
+		Services::routes()->add('apples', 'Home::index', ['as' => 'orchard']);
 
-		$url = URL::to('home');
+		$url = URL::route('orchard');
 
 		$this->assertSame('http://example.com/index.php/apples', (string) $url);
 	}
 
-	public function testToReverseRoute()
+	public function testReverseRoute()
 	{
 		Services::routes()->add('oranges', 'Basket::fruit');
 
-		$url = URL::to('App\Controllers\Basket::fruit');
+		$url = URL::route('App\Controllers\Basket::fruit');
 
 		$this->assertSame('http://example.com/index.php/oranges', (string) $url);
 	}
@@ -367,11 +367,11 @@ public function currentProvider(): array
 			],
 			[
 				'?blahblah=true',
-				'http://example.com/index.php?blahblah=true',
+				'http://example.com/index.php',
 			],
 			[
 				'http://example.com/index.php?blahblah=true',
-				'http://example.com/index.php?blahblah=true',
+				'http://example.com/index.php',
 			],
 		];
 	}