breaking change: bump to Laravel 9 or Laravel 10. Minimum PHP version…

…: 8.1. Updated php-cs-fixer, and implemented fix and analyse script with phpstan

.gitignore

@@ -1,7 +1,8 @@
 build
 composer.lock
 docs
-vendor
+vendor/
+.test/
 .php_cs.cache
 .phpunit.result.cache
 .php-cs-fixer.cache

.php_cs.dist.php → .php-cs-fixer.dist.php

@@ -1,6 +1,5 @@
 <?php
-
-$finder = Symfony\Component\Finder\Finder::create()
+$finder = PhpCsFixer\Finder::create()
     ->in([
         __DIR__ . '/src',
         __DIR__ . '/tests',
@@ -10,7 +9,8 @@
     ->ignoreDotFiles(true)
     ->ignoreVCS(true);
 
-return (new PhpCsFixer\Config())
+$config = new PhpCsFixer\Config();
+$config
     ->setRules([
         '@PSR2' => true,
         'array_syntax' => ['syntax' => 'short'],
@@ -38,3 +38,5 @@
         'single_trait_insert_per_statement' => true,
     ])
     ->setFinder($finder);
+
+return $config;

composer.json

@@ -24,16 +24,19 @@
     ],
     "require": {
         "php": "^8.1",
+        "ext-openssl": ">1.0.2",
         "illuminate/support": "^9.0 || ^10.0",
         "nesbot/carbon": "^2.0",
         "spatie/laravel-package-tools": "^1.14"
     },
     "require-dev": {
+        "friendsofphp/php-cs-fixer": "^3.4",
+        "phpstan/phpstan": "^1.9",
         "mockery/mockery": "^1.3.3",
-        "orchestra/testbench": "^6.0",
-        "phpunit/phpunit": "^9.3",
-        "spatie/phpunit-snapshot-assertions": "^4.0",
-        "spatie/temporary-directory": "^1.2.4"
+        "orchestra/testbench": "^7.0",
+        "phpunit/phpunit": "^9.5",
+        "spatie/phpunit-snapshot-assertions": "^4.2",
+        "spatie/temporary-directory": "^2.1"
     },
     "config": {
         "sort-packages": true
@@ -58,6 +61,8 @@
     "minimum-stability": "dev",
     "prefer-stable": true,
     "scripts": {
-        "test": "vendor/bin/phpunit"
+        "test": "vendor/bin/phpunit",
+        "fix": "@php vendor/bin/php-cs-fixer fix",
+        "analyse": "@php vendor/bin/phpstan analyse src --level 4"
     }
 }

src/Sitemap.php

@@ -12,14 +12,18 @@
 
 class Sitemap implements Responsable, Renderable
 {
-    /** @var \Spatie\Sitemap\Tags\Url[] */
+    /** @var \Mfonte\Sitemap\Tags\Url[] */
     protected $tags = [];
 
     public static function create()
     {
         return new static();
     }
 
+    final public function __construct()
+    {
+    }
+
     /**
      * @param $tag string|Url|Sitemapable
      */
@@ -68,14 +72,14 @@ public function hasUrl(string $url): bool
     public function hasImages() : bool
     {
         return (bool) collect($this->tags)->first(function (Tag $tag) {
-            return $tag->getType() === 'url' && !empty($tag->images);
+            return $tag->getType() === 'url' && ! empty($tag->images);
         });
     }
 
     public function hasNews() : bool
     {
         return (bool) collect($this->tags)->first(function (Tag $tag) {
-            return $tag->getType() === 'url' && !empty($tag->news);
+            return $tag->getType() === 'url' && ! empty($tag->news);
         });
     }
 
@@ -116,4 +120,4 @@ public function toResponse($request)
             'Content-Type' => 'text/xml',
         ]);
     }
-}
+}

src/SitemapIndex.php

@@ -11,14 +11,18 @@
 
 class SitemapIndex implements Responsable, Renderable
 {
-    /** @var \Spatie\Sitemap\Tags\Sitemap[] */
+    /** @var \Mfonte\Sitemap\Tags\Sitemap[] */
     protected array $tags = [];
 
     public static function create()
     {
         return new static();
     }
 
+    final public function __construct()
+    {
+    }
+
     /**
      * @param $tag string|Sitemap
      */

src/Tags/Alternate.php

@@ -15,7 +15,7 @@ public static function create(string $url, string $locale = '')
         return new static($url, $locale);
     }
 
-    public function __construct(string $url, $locale = '')
+    final public function __construct(string $url, $locale = '')
     {
         $this->setUrl($url);
 
@@ -35,4 +35,4 @@ public function setLocale(string $locale = '')
 
         return $this;
     }
-}
+}

src/Tags/Image.php

@@ -29,7 +29,7 @@ public static function create(
         return new static($url, $caption, $geo_location, $title, $license);
     }
 
-    public function __construct(
+    final public function __construct(
         string $url,
         string $caption = '',
         string $geo_location = '',
@@ -82,4 +82,4 @@ public function setLicense(string $license = '')
 
         return $this;
     }
-}
+}

src/Tags/News.php

@@ -28,7 +28,7 @@ public static function create(
         return new static($name, $language, $publication_date, $title);
     }
 
-    public function __construct(
+    final public function __construct(
         string $name,
         string $language,
         ?DateTimeInterface $publication_date,
@@ -58,7 +58,6 @@ public function setLanguage(string $language)
 
         return $this;
     }
-
 
     public function setPublicationDate(?DateTimeInterface $publication_date = null)
     {
@@ -75,4 +74,4 @@ public function setTitle(string $title)
 
         return $this;
     }
-}
+}

src/Tags/Sitemap.php

@@ -7,7 +7,8 @@
 
 class Sitemap extends Tag
 {
-    public string $url;
+    /** @var string */
+    public $url;
 
     /** @var Carbon */
     public $lastModificationDate;
@@ -17,7 +18,7 @@ public static function create(string $url)
         return new static($url);
     }
 
-    public function __construct(string $url)
+    final public function __construct(string $url)
     {
         $this->url = $url;
 

src/Tags/Tag.php

@@ -4,6 +4,9 @@
 
 abstract class Tag
 {
+    /** @var string */
+    public $url;
+
     public function getType(): string
     {
         return mb_strtolower(class_basename(static::class));

src/Tags/Url.php

@@ -41,7 +41,7 @@ public static function create(string $url)
         return new static($url);
     }
 
-    public function __construct(string $url)
+    final public function __construct(string $url)
     {
         $this->url = $url;
 
@@ -114,7 +114,7 @@ public function path(): string
     }
 
     /**
-     * @param integer|null $index
+     * @param int|null $index
      *
      * @return array|string|null
      */
@@ -138,4 +138,4 @@ public function segment(int $index): ?string
     {
         return $this->segments()[$index - 1] ?? null;
     }
-}
+}

tests/AlternateTest.php

@@ -30,4 +30,4 @@ public function locale_can_be_set()
 
         $this->assertEquals('en', $this->alternate->locale);
     }
-}
+}

tests/ImageTest.php

@@ -62,4 +62,4 @@ public function license_can_be_set()
 
         $this->assertEquals('some_random_photographer', $this->image->license);
     }
-}
+}

tests/NewsTest.php

@@ -51,4 +51,4 @@ public function title_can_be_set()
 
         $this->assertEquals('a_beautiful_title', $this->news->title);
     }
-}
+}

tests/SitemapIndexTest.php

@@ -132,4 +132,4 @@ public function an_instance_can_return_a_response()
 
         $this->assertInstanceOf(Response::class, $this->index->toResponse(new Request));
     }
-}
+}

tests/SitemapTest.php

@@ -269,4 +269,4 @@ public function toSitemapTag()
 
         $this->assertMatchesXmlSnapshot($this->sitemap->render());
     }
-}
+}

tests/TestCase.php

@@ -3,8 +3,8 @@
 namespace Mfonte\Sitemap\Test;
 
 use Carbon\Carbon;
-use Orchestra\Testbench\TestCase as OrchestraTestCase;
 use Mfonte\Sitemap\SitemapServiceProvider;
+use Orchestra\Testbench\TestCase as OrchestraTestCase;
 use Spatie\Snapshots\MatchesSnapshots;
 use Spatie\TemporaryDirectory\TemporaryDirectory;
 
@@ -33,4 +33,4 @@ protected function getPackageProviders($app)
             SitemapServiceProvider::class,
         ];
     }
-}
+}

tests/UrlTest.php

@@ -3,9 +3,9 @@
 namespace Mfonte\Sitemap\Test;
 
 use Carbon\Carbon;
+use Mfonte\Sitemap\Tags\Alternate;
 use Mfonte\Sitemap\Tags\Image;
 use Mfonte\Sitemap\Tags\News;
-use Mfonte\Sitemap\Tags\Alternate;
 use Mfonte\Sitemap\Tags\Url;
 
 class UrlTest extends TestCase
@@ -218,4 +218,4 @@ public function it_will_return_null_for_a_non_existing_segment()
     {
         $this->assertNull(Url::create('http://example.com/part1/part2/part3')->segment(5));
     }
-}
+}