Merge pull request #19 from ergebnis/feature/url

Enhancement: Add Url

.php_cs

@@ -19,14 +19,15 @@ $range = License\Range::since(
     License\Year::fromString('2020'),
     new \DateTimeZone('UTC')
 );
+$url = License\Url::fromString('https://github.com/ergebnis/license');
 
 $header = <<<EOF
 Copyright (c) {$range->toString()} {$holder->toString()}
 
 For the full copyright and license information, please view
 the LICENSE file that was distributed with this source code.
 
-@see https://github.com/ergebnis/license
+@see {$url->toString()}
 EOF;
 
 $config = Config\Factory::fromRuleSet(new Config\RuleSet\Php71($header));

CHANGELOG.md

@@ -13,11 +13,13 @@ For a full diff see [`675601b...master`][675601b...master].
 * Added `Holder` ([#7]), by [@localheinz]
 * Added `Year` ([#10]), by [@localheinz]
 * Added `Range` ([#12]), by [@localheinz]
+* Added `Url` ([#19]), by [@localheinz]
 
 [675601b...master]: https://github.com/ergebnis/license/compare/675601b...master
 
 [#7]: https://github.com/ergebnis/license/pull/7
 [#10]: https://github.com/ergebnis/license/pull/10
 [#12]: https://github.com/ergebnis/license/pull/12
+[#19]: https://github.com/ergebnis/license/pull/18
 
 [@localheinz]: https://github.com/localheinz

composer.json

@@ -14,7 +14,8 @@
     }
   ],
   "require": {
-    "php": "^7.1"
+    "php": "^7.1",
+    "ext-filter": "*"
   },
   "require-dev": {
     "ergebnis/composer-normalize": "^2.2.0",

src/Exception/InvalidUrl.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * Copyright (c) 2020 Andreas Möller
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ *
+ * @see https://github.com/ergebnis/license
+ */
+
+namespace Ergebnis\License\Exception;
+
+final class InvalidUrl extends \InvalidArgumentException implements Exception
+{
+    public static function fromValue(string $value): self
+    {
+        return new self(\sprintf(
+            'Value "%s" is not a valid URL.',
+            $value
+        ));
+    }
+}

src/Url.php

@@ -0,0 +1,47 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * Copyright (c) 2020 Andreas Möller
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ *
+ * @see https://github.com/ergebnis/license
+ */
+
+namespace Ergebnis\License;
+
+final class Url
+{
+    private $value;
+
+    private function __construct(string $value)
+    {
+        $this->value = $value;
+    }
+
+    /**
+     * @param string $value
+     *
+     * @throws Exception\InvalidUrl
+     *
+     * @return self
+     */
+    public static function fromString(string $value): self
+    {
+        $trimmed = \trim($value);
+
+        if (false === \filter_var($trimmed, \FILTER_VALIDATE_URL)) {
+            throw Exception\InvalidUrl::fromValue($value);
+        }
+
+        return new self($trimmed);
+    }
+
+    public function toString(): string
+    {
+        return $this->value;
+    }
+}

test/Unit/Exception/InvalidUrlTest.php

@@ -0,0 +1,42 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * Copyright (c) 2020 Andreas Möller
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ *
+ * @see https://github.com/ergebnis/license
+ */
+
+namespace Ergebnis\License\Test\Unit\Exception;
+
+use Ergebnis\License\Exception\InvalidUrl;
+use Ergebnis\Test\Util\Helper;
+use PHPUnit\Framework;
+
+/**
+ * @internal
+ *
+ * @covers \Ergebnis\License\Exception\InvalidUrl
+ */
+final class InvalidUrlTest extends Framework\TestCase
+{
+    use Helper;
+
+    public function testFromValueReturnsInvalidUrl(): void
+    {
+        $value = self::faker()->sentence;
+
+        $exception = InvalidUrl::fromValue($value);
+
+        $expected = \sprintf(
+            'Value "%s" is not a valid URL.',
+            $value
+        );
+
+        self::assertSame($expected, $exception->getMessage());
+    }
+}

test/Unit/UrlTest.php

@@ -0,0 +1,111 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * Copyright (c) 2020 Andreas Möller
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ *
+ * @see https://github.com/ergebnis/license
+ */
+
+namespace Ergebnis\License\Test\Unit;
+
+use Ergebnis\License\Exception;
+use Ergebnis\License\Url;
+use Ergebnis\Test\Util\Helper;
+use PHPUnit\Framework;
+
+/**
+ * @internal
+ *
+ * @covers \Ergebnis\License\Url
+ *
+ * @uses \Ergebnis\License\Exception\InvalidUrl
+ */
+final class UrlTest extends Framework\TestCase
+{
+    use Helper;
+
+    /**
+     * @dataProvider provideInvalidValue
+     *
+     * @param string $value
+     */
+    public function testFromStringRejectsInvalidValue(string $value): void
+    {
+        $this->expectException(Exception\InvalidUrl::class);
+
+        Url::fromString($value);
+    }
+
+    public function provideInvalidValue(): \Generator
+    {
+        $values = [
+            'string-arbitrary' => self::faker()->sentence,
+            'string-blank' => '  ',
+            'string-empty' => '',
+        ];
+
+        foreach ($values as $key => $value) {
+            yield $key => [
+                $value,
+            ];
+        }
+    }
+
+    /**
+     * @dataProvider provideValidValue
+     *
+     * @param string $value
+     */
+    public function testFromStringReturnsUrl(string $value): void
+    {
+        $url = Url::fromString($value);
+
+        self::assertSame($value, $url->toString());
+    }
+
+    public function provideValidValue(): \Generator
+    {
+        foreach (self::validValues() as $key => $value) {
+            yield $key => [
+                $value,
+            ];
+        }
+    }
+
+    /**
+     * @dataProvider provideUntrimmedValue
+     *
+     * @param string $value
+     */
+    public function testFromStringReturnsUrlWithTrimmedValue(string $value): void
+    {
+        $url = Url::fromString($value);
+
+        self::assertSame(\trim($value), $url->toString());
+    }
+
+    public function provideUntrimmedValue(): \Generator
+    {
+        foreach (self::validValues() as $key => $value) {
+            yield $key => [
+                \sprintf(
+                    " %s \n\n",
+                    $value
+                ),
+            ];
+        }
+    }
+
+    private static function validValues(): array
+    {
+        return [
+            'string-https' => 'https://github.com/ergebnis/php-cs-fixer-config',
+            'string-http' => 'https://github.com/ergebnis/php-cs-fixer-config',
+        ];
+    }
+}