Merge pull request #77 from 8fold/sitemap

Sitemap

.env-example

@@ -0,0 +1,2 @@
+APP_ENV={production|local|test}
+APP_URL={host with schema}

.gitignore

@@ -10,3 +10,5 @@ yarn-error.log
 .nova
 
 site-static-html/
+
+!site-dynamic-php/public/.gitignore

README.md

@@ -12,7 +12,7 @@ The content is also available in a [separate repository](https://github.com/josh
 	- [MAMP](https://www.mamp.info/en/mamp-pro/windows/),
 	- [XAMPP](https://www.apachefriends.org/download.html), or
 	- custom build.
-3. Point the locally hosted domain to the `public` directory.
+3. Point the locally hosted domain to the `site-dynamic-php` directory.
 
 When you go to the locally hosted URL, it should throw a 500 server error. This is because you will need two things: the content folder and a `.env` file.
 

content/public/.gitignore

@@ -0,0 +1,2 @@
+.DS_Store
+

content/public/sitemap.xml

@@ -0,0 +1,3 @@
+---
+template: 'sitemap'
+---

phpstan.neon

@@ -5,3 +5,5 @@ parameters:
 		- site-dynamic-php
 	ignoreErrors:
 		- '#Call to an undefined static method Eightfold\\HTMLBuilder\\Element::(.*)#'
+		- '#Call to an undefined static method Eightfold\\XMLBuilder\\Element::(.*)#'
+		- '#Call to an undefined static method Eightfold\\XMLBuilder\\Document::(.*)#'

src/Content/FrontMatter.php

@@ -63,4 +63,12 @@ public function original(): string
         }
         return '';
     }
+
+    public function template(): string
+    {
+        if ($this->hasMember('template')) {
+            return strval($this->frontMatter['template']);
+        }
+        return '';
+    }
 }

src/Content/Markdown.php

@@ -131,6 +131,11 @@ public function pageTitle(): string
         return implode(' | ', $titles);
     }
 
+    public function canonicalURl(): string
+    {
+        return $this->file->canonicalUrl();
+    }
+
     private function fileContent(): string
     {
         if (strlen($this->fileContent) === 0 and $this->file->found()) {

src/Documents/Sitemap.php

@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+namespace JoshBruce\Site\Documents;
+
+use Eightfold\XMLBuilder\Document;
+use Eightfold\XMLBuilder\Element;
+
+use JoshBruce\Site\FileSystem;
+use JoshBruce\Site\File;
+
+use JoshBruce\Site\Content\Markdown;
+
+class Sitemap
+{
+    public static function create(): string
+    {
+        $finder = FileSystem::finder()->name('content.md')->sortByName()
+            ->notContains('redirect:')
+            ->notContains('noindex:');
+
+        $markdown = [];
+        foreach ($finder as $file) {
+            $markdown[] = Markdown::for(
+                File::at($file->getPathname())
+            );
+        }
+
+        $urls = [];
+        foreach ($markdown as $m) {
+            $urls[] = Element::url(
+                Element::loc($m->canonicalUrl())
+            );
+        }
+
+        return Document::urlset(
+            ...$urls
+        )->props("xmlns http://www.sitemaps.org/schemas/sitemap/0.9")->build();
+    }
+}

src/File.php

@@ -10,6 +10,8 @@
 
 class File
 {
+    private string $contentFileName = '/content.md';
+
     public static function at(string $localPath): File
     {
         return new File($localPath);
@@ -66,15 +68,15 @@ public function path(bool $full = true): string
 
     public function canGoUp(): bool
     {
-        return $this->path(false) !== '/content.md';
+        return $this->path(false) !== $this->contentFileName;
     }
 
     public function up(): File
     {
         $parts = explode('/', $this->localPath);
         $parts = array_slice($parts, 0, -2); // remove file name and one folder.
         $localPath = implode('/', $parts);
-        return File::at($localPath . '/content.md');
+        return File::at($localPath . $this->contentFileName);
     }
 
     public function contents(): string
@@ -97,7 +99,8 @@ public function mimetype(): string
             $extensionMap = [
                 'md'  => 'text/html',
                 'css' => 'text/css',
-                'js'  => 'text/javascript'
+                'js'  => 'text/javascript',
+                'xml' => 'application/xml'
             ];
 
             $parts     = explode('.', $this->path());
@@ -108,12 +111,21 @@ public function mimetype(): string
         return $type;
     }
 
+    public function canonicalUrl(): string
+    {
+        return str_replace(
+            $this->contentFileName,
+            '',
+            'https://joshbruce.com' . $this->path(false)
+        );
+    }
+
     /**
      * @return File[]
      */
     public function children(string $filesNamed): array
     {
-        $base = str_replace('/content.md', '', $this->path());
+        $base = str_replace($this->contentFileName, '', $this->path());
 
         $files = [];
         foreach (new DirectoryIterator($base) as $folder) {
@@ -134,6 +146,6 @@ public function children(string $filesNamed): array
 
     private function contentRoot(): string
     {
-        return FileSystem::contentRoot() . '/public';
+        return FileSystem::publicRoot();
     }
 }

src/FileSystem.php

@@ -4,8 +4,17 @@
 
 namespace JoshBruce\Site;
 
+use SplFileInfo;
+
+use Symfony\Component\Finder\Finder;
+
 class FileSystem
 {
+    public static function publicRoot(): string
+    {
+        return FileSystem::contentRoot() . '/public';
+    }
+
     public static function contentRoot(): string
     {
         $parts   = explode('/', self::projectRoot());
@@ -24,4 +33,34 @@ public static function projectRoot(): string
         $parts = array_slice($parts, 0, -1);
         return implode('/', $parts);
     }
+
+    public static function finder(): Finder
+    {
+        $finder = new Finder();
+        return $finder->ignoreVCS(false)
+            ->ignoreUnreadableDirs()
+            ->ignoreDotFiles(false)
+            ->ignoreVCSIgnored(true)
+            ->notName('.gitignore')
+            ->files()
+            ->filter(fn($f) => self::isPublished($f))
+            ->in(self::publicRoot());
+    }
+
+    private static function isPublished(SplFileInfo $finderFile): bool
+    {
+        return ! self::isDraft($finderFile);
+    }
+
+    private static function isDraft(SplFileInfo $finderFile): bool
+    {
+        $filePath = (string) $finderFile;
+        $relativePath = self::relativePath($filePath);
+        return str_contains($relativePath, '_');
+    }
+
+    private static function relativePath(string $path): string
+    {
+        return str_replace(self::contentRoot(), '', $path);
+    }
 }

src/HttpRequest.php

@@ -65,6 +65,16 @@ public function isFile(): bool
         return str_contains($this->possibleFileName(), '.');
     }
 
+    public function isSitemap(): bool
+    {
+        return $this->isFile() and $this->possibleFileName() === 'sitemap.xml';
+    }
+
+    public function isNotSitemap(): bool
+    {
+        return ! $this->isSitemap();
+    }
+
     public function localFile(): File
     {
         return File::at(localPath: $this->localPath());
@@ -82,6 +92,14 @@ private function localPath(): string
             $relativePath = $this->uriPath();
             if (empty($possibleFileName)) {
                 $relativePath = $this->uriPath() . '/content.md';
+
+            // } elseif (str_contains($relativePath, '.xml')) {
+            //     $relativePath = str_replace('.xml', '.md', $relativePath);
+
+            }
+
+            if (! str_starts_with($relativePath, '/')) {
+                $relativePath = "/{$relativePath}";
             }
 
             $root = FileSystem::contentRoot();

src/HttpResponse.php

@@ -21,6 +21,8 @@
 
 use JoshBruce\Site\PageComponents\Navigation;
 
+use JoshBruce\Site\Documents\Sitemap;
+
 class HttpResponse
 {
     private ResponseInterface $psrResponse;
@@ -69,7 +71,11 @@ public function headers(): array
     public function body(): string
     {
         $localFile = $this->request->localFile();
-        if ($this->statusCode() === 200 and $localFile->isNotMarkdown()) {
+        if (
+            $this->statusCode() === 200 and
+            $localFile->isNotMarkdown() and
+            $this->request->isNotSitemap()
+        ) {
             return $localFile->path();
 
         } elseif ($this->statusCode() === 404) {
@@ -82,15 +88,22 @@ public function body(): string
 
         }
 
-        $html = '';
+        $template = '';
         $pageTitle = '';
+        $html = '';
         if ($localFile->isMarkdown()) {
             $markdown  = Markdown::for(file: $localFile);
+            $template  = $markdown->frontMatter()->template();
             $pageTitle = $markdown->pageTitle();
             $html      = $markdown->html();
 
         }
 
+        if ($this->request->isSitemap()) {
+            return Sitemap::create();
+
+        }
+
         return Document::create(
             $pageTitle
         )->head(
@@ -153,7 +166,10 @@ public function psrResponse(): ResponseInterface
             $psr17Factory = new PsrFactory();
             $body         = $this->body();
             $stream       = $psr17Factory->createStream($body);
-            if ($this->request->isFile()) {
+            if (
+                $this->request->isFile() and
+                $this->request->isNotSitemap()
+            ) {
                 $stream = $psr17Factory->createStreamFromFile($body);
             }
 

src/ServerGlobals.php

@@ -15,7 +15,6 @@ private function __construct()
     {
     }
 
-
     public function appEnvIsNot(string $value): bool
     {
         return $this->appEnv() !== $value;
@@ -26,6 +25,20 @@ public function isMissingAppEnv(): bool
         return ! $this->hasAppEnv();
     }
 
+    public function isMissingAppUrl(): bool
+    {
+        return ! $this->hasAppUrl();
+    }
+
+    public function appUrl(): string
+    {
+        if ($this->hasAppUrl()) {
+            $globals = $this->globals();
+            return strval($globals['APP_URL']);
+        }
+        return '';
+    }
+
     private function appEnv(): string
     {
         if ($this->hasAppEnv()) {
@@ -40,6 +53,11 @@ private function hasAppEnv(): bool
         return array_key_exists('APP_ENV', $this->globals());
     }
 
+    private function hasAppUrl(): bool
+    {
+        return array_key_exists('APP_URL', $this->globals());
+    }
+
     /**
      * @return array<string, int|string>
      */

tests/FileTest.php

@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+use JoshBruce\Site\File;
+
+use JoshBruce\Site\FileSystem;
+
+test('can generate canonical URL', function() {
+   expect(
+       File::at(FileSystem::publicRoot() . '/content.md')->canonicalUrl()
+   )->toBe(
+       'https://joshbruce.com'
+   );
+
+    expect(
+       File::at(FileSystem::publicRoot())->canonicalUrl()
+   )->toBe(
+       'https://joshbruce.com'
+   );
+
+    expect(
+       File::at(FileSystem::publicRoot() . '/web-development')->canonicalUrl()
+   )->toBe(
+       'https://joshbruce.com/web-development'
+   );
+
+   expect(
+        File::at(FileSystem::publicRoot() . '/web-development/content.md')
+            ->canonicalUrl()
+    )->toBe(
+        'https://joshbruce.com/web-development'
+    );
+})->group('file');

tests/IndexTest.php

@@ -29,4 +29,4 @@
             'Okay to fail in local.'
         )->toBeFalse();
     }
-})->group('index', 'focus');
+})->group('index');