- output path can be remapped

SavvyWombat · Aug 14, 2023 · 7ba95d7 · 7ba95d7
1 parent e5c41d2
commit 7ba95d7
Show file tree

Hide file tree

Showing 11 changed files with 329 additions and 206 deletions.
diff --git a/README.md b/README.md
@@ -162,6 +162,50 @@ You can specify files for inclusion or exclusion in the `caxton.json` configurat
 }
 ```
 
+### Output mapping
+
+By default, the output URLs will follow the same structure as the folder paths within your public and content directories.
+
+If you like to organise your files differently, then you can use the `output.maps` configuration to map the URLs accordingly.
+
+For example:
+
+```
++ content
+|-+ blog
+  |-+ 2018
+    |-+ 10-22-it-begins
+      |-  index.blade.md
+      |-  pretty-picture.png
+```
+
+To output this document as `/blog/2018-10-22/it-begins`, you can use this in your `caxton.json` file:
+
+```
+{
+  "output": {
+    "maps": [
+      {
+        "path": "/blog/*/*/",
+        "url": "/blog/{{ date }}/{{ slug }}/"
+      }
+    ]
+  }
+}
+```
+
+`date` and `slug` are read from the front matter of the template file.
+
+```
+---
+date: 2018-10-22
+slug: it-begins
+---
+```
+
+Caxton will then store an internal map for all output for paths starting with `/blog/2018/10-22-it-begins/` and rewrite them as `/blog/2018-10-22/it-begins`.
+This means that any resources related to the blog post (such as the `png` file) will be written to the same output URL. 
+
 ### Sitemap
 
 Caxton will generate a `sitemap.xml` and add it to the root of your output directory.

diff --git a/caxton b/caxton
@@ -6,7 +6,7 @@ require_once 'vendor/autoload.php';
 use SavvyWombat\Caxton\Config;
 use SavvyWombat\Caxton\ConfigFile;
 use SavvyWombat\Caxton\Middleware;
-use SavvyWombat\Caxton\FileList;
+use SavvyWombat\Caxton\Site;
 
 $config = [];
 $config['verbose'] = in_array('-v', $argv) || in_array('--verbose', $argv);
@@ -29,6 +29,8 @@ $config['paths']['public'] = $config['paths']['base'] . ($_ENV['PUBLIC_DIR'] ??
 $config['paths']['cache'] = $config['paths']['base'] . '/build' . ($_ENV['CACHE_DIR'] ?? '/cache');
 $config['paths']['output'] = $config['paths']['base'] . '/build' . ($_ENV['OUTPUT_DIR'] ?? '/' . $config['environment']);
 
+$config['blade']['extensions'] = '.blade.(md|php)';
+
 $config = Config::instance(
     $config,
     ConfigFile::read($config['paths']['base'] . '/caxton.json', []),
@@ -57,14 +59,14 @@ if (file_exists(Config::instance()->get('paths.output'))) {
 }
 
 $middlewares = [
-    Middleware\CopyPublicFiles::class,
+    Middleware\ScanFiles::class,
+    Middleware\CopyStaticFiles::class,
     Middleware\BuildContentFiles::class,
-    Middleware\GenerateSiteMap::class,
 ];
 
-$action = fn (FileList $files): FileList => $files;
+$action = fn (Site $site): Site => $site;
 foreach (array_reverse($middlewares) as $m) {
     $middleware = new $m();
-    $action = fn (FileList $files): FileList => $middleware->run($files, $action);
+    $action = fn (Site $site): Site => $middleware->run($site, $action);
 }
-$action(new FileList());
+$action(Site::instance());
diff --git a/src/File.php b/src/File.php
diff --git a/src/FileList.php b/src/FileList.php
diff --git a/src/Middleware/BuildContentFiles.php b/src/Middleware/BuildContentFiles.php
@@ -4,72 +4,61 @@
 
 use SavvyWombat\Caxton\Blade\ViewFactory;
 use SavvyWombat\Caxton\Config;
-use SavvyWombat\Caxton\ContentFileFilter;
-use SavvyWombat\Caxton\File;
-use SavvyWombat\Caxton\FileList;
 use SavvyWombat\Caxton\Markdown\MarkdownConverter;
+use SavvyWombat\Caxton\Site;
+use SavvyWombat\Caxton\SourceFile;
 
 class BuildContentFiles implements Middleware
 {
-    public function run(FileList $files, callable $next): FileList
-    {
-        $contentFiles = new \RecursiveIteratorIterator(
-            new ContentFileFilter(
-                new \RecursiveDirectoryIterator(
-                    Config::instance()->get('paths.content'),
-                    \FilesystemIterator::SKIP_DOTS
-                )
-            ),
-            \RecursiveIteratorIterator::SELF_FIRST
-        );
+    protected $markdown = null;
 
-        foreach ($contentFiles as $contentFile) {
-            $subpath = str_replace(
-                Config::instance()->get('paths.content'),
-                '',
-                $contentFile->getRealPath()
-            );
+    public function __construct() {
+        $this->markdown = new MarkdownConverter();
+    }
 
-            if (!file_exists(Config::instance()->get('paths.output') . dirname($subpath))) {
-                // directories need the 'execute/search' bit
-                // permissions are subject to the umask value in the running environment
-                mkdir(Config::instance()->get('paths.output') . dirname($subpath), 0775, true);
+    public function run(Site $site, callable $next): Site
+    {
+        $extensions = str_replace('.', '\.', Config::instance()->get('blade.extensions'));
+
+        foreach ($site->sourceFiles() as $file) {
+            if (preg_match('#(.*)' . $extensions . '$#', $file->sourcePath())) {
+                $this->buildFromTemplate($file,  $file->outputPath());
             }
+        }
 
-            $matches = [];
-            if (preg_match('#(.*)\.blade\.(md|php)$#', $subpath, $matches)) {
-                $markdown = new MarkdownConverter();
-                $frontMatter = $markdown->extractFrontMatter(
-                    file_get_contents(Config::instance()->get('paths.content') . $subpath)
-                );
+        return $next($site);
+    }
 
-                $data = yaml_parse($frontMatter) ?? [];
+    protected function buildFromTemplate(SourceFile $sourceFile, string $outputPath)
+    {
+        $extensions = str_replace('.', '\.', Config::instance()->get('blade.extensions'));
 
-                $subpath = $matches[1];
-                $output = ViewFactory::instance()->make(
-                    str_replace('/', '.', $subpath),
-                    [
-                        'page' => null,
-                        'url' => Config::instance()->get('base_url') . (str_ends_with($subpath, '/index') ? substr($subpath, 0, -6) : $subpath),
-                        ...$data,
-                    ]
-                )->render();
+        $templateName = str_replace(
+            '/',
+            '.',
+            str_replace(
+                Config::instance()->get('paths.content') . '/',
+                '',
+                preg_replace(
+                    '#' . $extensions . '$#',
+                    '',
+                    $sourceFile->sourcePath(),
+                ),
 
-                file_put_contents(Config::instance()->get('paths.output') . $subpath . '.html', $output);
-                $files->add(new File(
-                    filename: $subpath . '.html',
-                    url: (str_ends_with($subpath, '/index')) ? substr($subpath, 0, -6) : $subpath,
-                    source: $contentFile->getRealPath(),
-                ));
-            } else if (!is_dir($contentFile->getRealPath())) {
-                copy($contentFile->getRealPath(), Config::instance()->get('paths.output') . $subpath);
-                $files->add(new File(
-                    filename: $subpath,
-                    source: $contentFile->getRealPath(),
-                ));
-            }
+            )
+        );
+
+        $output = ViewFactory::instance()->make(
+            str_replace('/', '.', $templateName),
+            $sourceFile->data()
+        )->render();
+
+        if (!file_exists(Config::instance()->get('paths.output') . dirname($outputPath))) {
+            // directories need the 'execute/search' bit
+            // permissions are subject to the umask value in the running environment
+            mkdir(Config::instance()->get('paths.output') . dirname($outputPath), 0775, true);
         }
 
-        return $next($files);
+        file_put_contents(Config::instance()->get('paths.output') . $outputPath, $output);
     }
 }
diff --git a/src/Middleware/CopyPublicFiles.php b/src/Middleware/CopyPublicFiles.php
diff --git a/src/Middleware/CopyStaticFiles.php b/src/Middleware/CopyStaticFiles.php
@@ -0,0 +1,27 @@
+<?php
+
+namespace SavvyWombat\Caxton\Middleware;
+
+use SavvyWombat\Caxton\Config;
+use SavvyWombat\Caxton\Site;
+
+class CopyStaticFiles implements Middleware
+{
+    public function run(Site $site, callable $next): Site
+    {
+        $extensions = str_replace('.', '\.', Config::instance()->get('blade.extensions'));
+
+        foreach ($site->sourceFiles() as $file) {
+            if (! preg_match('#(.*)' . $extensions . '$#', $file->sourcePath())) {
+                $outputPath = $file->outputPath();
+
+                if (! file_exists(dirname(Config::instance()->get('paths.output') . '/' . $outputPath))) {
+                    mkdir(dirname(Config::instance()->get('paths.output') . '/' . $outputPath), 0775, true);
+                }
+                copy($file->sourcePath(), Config::instance()->get('paths.output') . '/' . $outputPath);
+            }
+        }
+
+        return $next($site);
+    }
+}
diff --git a/src/Middleware/Middleware.php b/src/Middleware/Middleware.php
@@ -2,9 +2,9 @@
 
 namespace SavvyWombat\Caxton\Middleware;
 
-use SavvyWombat\Caxton\FileList;
+use SavvyWombat\Caxton\Site;
 
 interface Middleware
 {
-    public function run(FileList $files, callable $next): FileList;
+    public function run(Site $site, callable $next): Site;
 }