Pagination support

.gitignore

@@ -1,3 +1,4 @@
 .DS_Store
+.phpunit.result.cache
 /vendor
 /composer.lock

README.md

@@ -63,7 +63,7 @@ You can also exclude single routes, or route groups with wildcards. This will ov
 ],
 ```
 
-### Dynamically adding routes
+### Dynamic Routes
 
 You may add URLs dynamically by providing a closure that returns an array to the `addUrls` method.
 
@@ -81,6 +81,16 @@ class AppServiceProvider extends Provider
 }
 ```
 
+### Pagination Routes
+
+Wherever pagination is detected in your antlers templates (eg. if you use the `paginate` param on the `collection` tag), multiple pages will automatically be generated with `/articles/page/2` style urls.
+
+You may configure a custom routing style in `config/statamic/ssg.php`:
+
+```php
+'pagination_route' => '{url}/{page_name}/{page_number}',
+``` 
+
 
 ## Post-generation callback
 

config/ssg.php

@@ -73,6 +73,19 @@
         //
     ],
 
+    /*
+    |--------------------------------------------------------------------------
+    | Pagination Route
+    |--------------------------------------------------------------------------
+    |
+    | Here you may define how paginated entries are routed. This will take
+    | effect wherever pagination is detected in your antlers templates,
+    | like if you use the `paginate` param on the `collection` tag.
+    |
+    */
+
+    'pagination_route' => '{url}/{page_name}/{page_number}',
+
     /*
     |--------------------------------------------------------------------------
     | Glide

phpunit.xml

@@ -18,5 +18,7 @@
         <env name="CACHE_DRIVER" value="array"/>
         <env name="SESSION_DRIVER" value="array"/>
         <env name="QUEUE_DRIVER" value="sync"/>
+	<env name="APP_URL" value="http://cool-runnings.com" />
+	<env name="APP_KEY" value="base64:QeU8nSJFKtBB3Y9SdxH0U4xH/1rsFd4zNfOLTeK/DUw=" />
     </php>
 </phpunit>

src/LengthAwarePaginator.php

@@ -0,0 +1,39 @@
+<?php
+
+namespace Statamic\StaticSite;
+
+use Statamic\Extensions\Pagination\LengthAwarePaginator as StatamicLengthAwarePaginator;
+use Statamic\Facades\URL;
+use Statamic\Support\Arr;
+use Statamic\Support\Str;
+
+class LengthAwarePaginator extends StatamicLengthAwarePaginator
+{
+    public function url($page)
+    {
+        if ($page <= 0) {
+            $page = 1;
+        }
+
+        $url = self::generatePaginatedUrl($this->path(), $this->getPageName(), $page);
+
+        if (Str::contains($this->path(), '?') || count($this->query)) {
+            $url .= '?'.Arr::query($this->query);
+        }
+
+        return $url.$this->buildFragment();
+    }
+
+    public static function generatePaginatedUrl($url, $pageName, $pageNumber)
+    {
+        $route = config('statamic.ssg.pagination_route');
+
+        $url = str_replace('{url}', $url, $route);
+
+        $url = str_replace('{page_name}', $pageName, $url);
+
+        $url = str_replace('{page_number}', $pageNumber, $url);
+
+        return URL::makeRelative($url);
+    }
+}

src/Page.php

@@ -6,12 +6,15 @@
 use Illuminate\Filesystem\Filesystem;
 use Illuminate\Http\Exceptions\HttpResponseException;
 use Illuminate\Http\RedirectResponse;
+use Statamic\Facades\Blink;
 
 class Page
 {
     protected $files;
     protected $config;
     protected $content;
+    protected $paginationPageName;
+    protected $paginationCurrentPage;
 
     public function __construct(Filesystem $files, array $config, $content)
     {
@@ -33,14 +36,24 @@ public function isGeneratable()
     public function generate($request)
     {
         try {
-            return $this->write($request);
+            $generatedPage = $this->write($request);
         } catch (Exception $e) {
             throw new NotGeneratedException($this, $e);
         }
+
+        if ($paginator = $this->detectPaginator($request)) {
+            $this->writePaginatedPages($request, $paginator);
+        }
+
+        return $generatedPage;
     }
 
     protected function write($request)
     {
+        if ($this->paginationPageName) {
+            $request->merge([$this->paginationPageName => $this->paginationCurrentPage]);
+        }
+
         try {
             $response = $this->content->toResponse($request);
         } catch (HttpResponseException $e) {
@@ -59,6 +72,23 @@ protected function write($request)
         return new GeneratedPage($this, $response);
     }
 
+    protected function writePaginatedPages($request, $paginator)
+    {
+        collect(range(1, $paginator->lastPage()))->each(function ($pageNumber) use ($request) {
+            $page = clone $this;
+
+            try {
+                $page
+                    ->setPaginationCurrentPage($pageNumber)
+                    ->write($request);
+            } catch (Exception $e) {
+                throw new NotGeneratedException($page, $e);
+            }
+        });
+
+        $this->clearPaginator($request);
+    }
+
     public function directory()
     {
         return dirname($this->path());
@@ -85,7 +115,17 @@ public function path()
 
     public function url()
     {
-        return $this->content->urlWithoutRedirect();
+        $url = $this->content->urlWithoutRedirect();
+
+        if ($this->paginationCurrentPage) {
+            $url = LengthAwarePaginator::generatePaginatedUrl(
+                $url,
+                $this->paginationPageName,
+                $this->paginationCurrentPage
+            );
+        }
+
+        return $url;
     }
 
     public function site()
@@ -97,4 +137,31 @@ public function is404()
     {
         return $this->url() === '/404';
     }
+
+    public function setPaginationCurrentPage($currentPage)
+    {
+        $this->paginationCurrentPage = $currentPage;
+
+        return $this;
+    }
+
+    protected function detectPaginator($request)
+    {
+        if ($paginator = Blink::get('tag-paginator')) {
+            $this->paginationPageName = $paginator->getPageName();
+        }
+
+        $this->clearPaginator($request);
+
+        return $paginator;
+    }
+
+    protected function clearPaginator($request)
+    {
+        Blink::forget('tag-paginator');
+
+        if ($this->paginationPageName) {
+            $request->forget($this->paginationPageName);
+        }
+    }
 }

src/Request.php

@@ -61,4 +61,11 @@ public function path()
 
         return ltrim($path, '/');
     }
+
+    public function forget(string $inputKey)
+    {
+        $this->getInputSource()->remove($inputKey);
+
+        return $this;
+    }
 }

src/ServiceProvider.php

@@ -4,13 +4,16 @@
 
 use Illuminate\Support\ServiceProvider as LaravelServiceProvider;
 use Spatie\Fork\Fork;
+use Statamic\Extensions\Pagination\LengthAwarePaginator as StatamicLengthAwarePaginator;
 
 class ServiceProvider extends LaravelServiceProvider
 {
     public function register()
     {
+        $this->app->bind('fork-installed', fn () => class_exists(Fork::class));
+
         $this->app->bind(Tasks::class, function ($app) {
-            return $app->runningInConsole() && class_exists(Fork::class)
+            return $app->runningInConsole() && $app['fork-installed']
                 ? new ConcurrentTasks(new Fork)
                 : new ConsecutiveTasks;
         });
@@ -33,5 +36,17 @@ public function boot()
                 Commands\StaticSiteServe::class,
             ]);
         }
+
+        if ($this->app->runningInConsole()) {
+            $this->app->extend(StatamicLengthAwarePaginator::class, function ($paginator) {
+                return $this->app->makeWith(LengthAwarePaginator::class, [
+                    'items' => $paginator->getCollection(),
+                    'total' => $paginator->total(),
+                    'perPage' => $paginator->perPage(),
+                    'currentPage' => $paginator->currentPage(),
+                    'options' => $paginator->getOptions(),
+                ]);
+            });
+        }
     }
 }

tests/Concerns/RunsGeneratorCommand.php

@@ -0,0 +1,77 @@
+<?php
+
+namespace Tests\Concerns;
+
+use Statamic\Facades\Path;
+
+trait RunsGeneratorCommand
+{
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        $this->destination = storage_path('app/static');
+
+        $this->cleanUpDestination();
+    }
+
+    public function tearDown(): void
+    {
+        $this->cleanUpDestination();
+
+        parent::tearDown();
+    }
+
+    protected function generate()
+    {
+        $this->assertFalse($this->files->exists($this->destination));
+
+        $this
+            ->artisan('statamic:ssg:generate')
+            ->doesntExpectOutputToContain('pages not generated');
+
+        $this->assertTrue($this->files->exists($this->destination));
+
+        return $this->getGeneratedFilesAtPath($this->destination);
+    }
+
+    protected function relativePath($path)
+    {
+        return str_replace(Path::tidy($this->destination.'/'), '', Path::tidy($path));
+    }
+
+    protected function destinationPath($path)
+    {
+        return Path::tidy($this->destination.'/'.$path);
+    }
+
+    protected function getGeneratedFilesAtPath($path)
+    {
+        return collect($this->files->allFiles($path))
+            ->mapWithKeys(fn ($file) => [$this->relativePath($file->getPathname()) => $file->getContents()])
+            ->all();
+    }
+
+    protected function cleanUpDestination($destination = null)
+    {
+        $destination ??= $this->destination;
+
+        if ($this->files->exists($destination)) {
+            $this->files->deleteDirectory($destination);
+        }
+    }
+
+    protected function assertStringContainsStrings($needleStrings, $haystackString)
+    {
+        foreach ($needleStrings as $string) {
+            $this->assertStringContainsString($string, $haystackString);
+        }
+    }
+
+    protected function assertStringNotContainsStrings($needleStrings, $haystackString)
+    {
+        foreach ($needleStrings as $string) {
+            $this->assertStringNotContainsString($string, $haystackString);
+        }
+    }
+}

tests/Fixtures/resources/views/articles/index.antlers.html

@@ -0,0 +1,4 @@
+<h1>Articles Index Page Title</h1>
+{{ collection:articles sort="date:asc" }}
+    <a href="{{ permalink }}">{{ title }}</a>
+{{ /collection:articles }}

tests/Fixtures/resources/views/articles/show.antlers.html

@@ -0,0 +1,2 @@
+<h1>Article Title: {{ title }}</h1>
+<p>Content: {{ content }}</p>

tests/Fixtures/resources/views/default.antlers.html

@@ -0,0 +1,2 @@
+<h1>Page Title: {{ title }}</h1>
+<p>Content: {{ content }}</p>

tests/Fixtures/resources/views/errors/404.antlers.html

@@ -0,0 +1 @@
+<h1>404!</h1>

tests/Fixtures/resources/views/layout.antlers.html

@@ -0,0 +1,2 @@
+{{ seo_pro:meta }}
+{{ template_content }}

tests/Fixtures/site-localized/content/collections/articles.yaml

@@ -0,0 +1,16 @@
+title: Articles
+sites:
+  - default
+  - french
+route:
+  default: 'articles/{slug}'
+  french: 'le-articles/{slug}'
+template: articles.show
+mount: b9e4bfe3-9c12-4553-b7ef-f43c22ffaa63
+taxonomies:
+  - topics
+revisions: false
+date: true
+date_behavior:
+  past: public
+  future: private

tests/Fixtures/site-localized/content/collections/articles/default/2023-07-01.one.md

@@ -0,0 +1,4 @@
+---
+id: a356f052-06a3-4f37-8376-2f136fe973c3
+title: One
+---

tests/Fixtures/site-localized/content/collections/articles/default/2023-07-02.two.md

@@ -0,0 +1,4 @@
+---
+id: ca648856-ff12-407d-a523-72074f5997e1
+title: Two
+---

tests/Fixtures/site-localized/content/collections/articles/default/2023-07-03.three.md

@@ -0,0 +1,4 @@
+---
+id: 312dff5e-4d4e-44bd-ac47-80ef58278675
+title: Three
+---

tests/Fixtures/site-localized/content/collections/articles/default/2023-07-04.four.md

@@ -0,0 +1,4 @@
+---
+id: d813ea6f-a637-4c6b-a724-c9e5f70e23de
+title: Four
+---

tests/Fixtures/site-localized/content/collections/articles/default/2023-07-05.five.md

@@ -0,0 +1,4 @@
+---
+id: 3a2e2f92-f93e-481d-b120-c63ff09c1775
+title: Five
+---