add crawl_profile config to set custom CrawlProfile implementation (#94)

* add crawl_profile config to set custom CrawlProfile implementation, fixes #90

* apply style ci fixes

* add tests for custom crawl profile

* apply fixes from style ci

* remove empty line

README.md

@@ -130,6 +130,12 @@ return [
      */
     'chrome_binary_path' => '',
 
+    /*
+     * The sitemap generator uses a CrawlProfile implementation to determine
+     * which urls should be crawled for the sitemap.
+     */
+    'crawl_profile' => Profile::class,
+
 ];
 ```
 

config/sitemap.php

@@ -1,6 +1,7 @@
 <?php
 
 use GuzzleHttp\RequestOptions;
+use Spatie\Sitemap\Crawler\Profile;
 
 return [
 
@@ -47,4 +48,10 @@
      */
     'chrome_binary_path' => null,
 
+    /*
+     * The sitemap generator uses a CrawlProfile implementation to determine
+     * which urls should be crawled for the sitemap.
+     */
+    'crawl_profile' => Profile::class,
+
 ];

src/SitemapGenerator.php

@@ -4,6 +4,7 @@
 
 use Spatie\Crawler\Crawler;
 use Spatie\Sitemap\Tags\Url;
+use Spatie\Crawler\CrawlProfile;
 use Spatie\Sitemap\Crawler\Profile;
 use Spatie\Sitemap\Crawler\Observer;
 use Spatie\Crawler\Url as CrawlerUrl;
@@ -103,7 +104,7 @@ public function writeToFile(string $path)
         return $this;
     }
 
-    protected function getCrawlProfile(): Profile
+    protected function getCrawlProfile(): CrawlProfile
     {
         $shouldCrawl = function (CrawlerUrl $url) {
             if ($url->host !== CrawlerUrl::create($this->urlToBeCrawled)->host) {
@@ -117,7 +118,9 @@ protected function getCrawlProfile(): Profile
             return ($this->shouldCrawl)($url);
         };
 
-        return new Profile($shouldCrawl);
+        $profileClass = config('sitemap.crawl_profile', Profile::class);
+
+        return app($profileClass, [$shouldCrawl]);
     }
 
     protected function getCrawlObserver(): Observer

src/SitemapServiceProvider.php

@@ -3,6 +3,7 @@
 namespace Spatie\Sitemap;
 
 use Spatie\Crawler\Crawler;
+use Spatie\Sitemap\Crawler\Profile;
 use Illuminate\Support\ServiceProvider;
 
 class SitemapServiceProvider extends ServiceProvider
@@ -27,6 +28,10 @@ public function boot()
             ->give(function () {
                 return Crawler::create(config('sitemap.guzzle_options'));
             });
+
+        $this->app->bind(Profile::class, function ($app, $params) {
+            return new Profile(reset($params));
+        });
     }
 
     /**

tests/CrawlProfileTest.php

@@ -0,0 +1,58 @@
+<?php
+
+namespace Spatie\Sitemap\Test;
+
+use Spatie\Crawler\Crawler;
+use Spatie\Sitemap\Sitemap;
+use Spatie\Sitemap\Crawler\Profile;
+use Spatie\Sitemap\SitemapGenerator;
+
+class CrawlProfileTest extends TestCase
+{
+    /**
+     * @var Crawler
+     */
+    private $crawler;
+
+    public function setUp()
+    {
+        parent::setUp();
+
+        $this->crawler = $this->createMock(Crawler::class);
+
+        $this->crawler->method('setCrawlObserver')->willReturn($this->crawler);
+        $this->crawler->method('setConcurrency')->willReturn($this->crawler);
+    }
+
+    /** @test */
+    public function it_should_use_the_default_crawl_profile()
+    {
+        $this->crawler
+            ->method('setCrawlProfile')
+            ->with($this->isInstanceOf(Profile::class))
+            ->willReturn($this->crawler);
+
+        $sitemapGenerator = new SitemapGenerator($this->crawler);
+
+        $sitemap = $sitemapGenerator->getSitemap();
+
+        $this->assertInstanceOf(Sitemap::class, $sitemap);
+    }
+
+    /** @test */
+    public function it_should_use_a_custom_crawl_profile()
+    {
+        config(['sitemap.crawl_profile' => CustomCrawlProfile::class]);
+
+        $this->crawler
+            ->method('setCrawlProfile')
+            ->with($this->isInstanceOf(CustomCrawlProfile::class))
+            ->willReturn($this->crawler);
+
+        $sitemapGenerator = new SitemapGenerator($this->crawler);
+
+        $sitemap = $sitemapGenerator->getSitemap();
+
+        $this->assertInstanceOf(Sitemap::class, $sitemap);
+    }
+}

tests/CustomCrawlProfile.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Spatie\Sitemap\Test;
+
+use Spatie\Crawler\Url;
+use Spatie\Crawler\CrawlProfile;
+
+class CustomCrawlProfile implements CrawlProfile
+{
+    /**
+     * Determine if the given url should be crawled.
+     *
+     * @param \Spatie\Crawler\Url $url
+     *
+     * @return bool
+     */
+    public function shouldCrawl(Url $url): bool
+    {
+        return true;
+    }
+}