Add generator

[rbdr/blog] / lib / blog.js

diff --git a/lib/blog.js b/lib/blog.js
index ba9ae534f25b067acde2b271f2139f51b02b79f7..e1a76a8d848e2803d6f116495307f7d66698d8c3 100644 (file)
--- a/lib/blog.js
+++ b/lib/blog.js
@@ -1,26 +1,26 @@
-'use strict';
-
-const { access, cp, mkdir, readdir, readFile, rm, writeFile } = require('fs/promises');
-const { exec } = require('child_process');
-const { basename, resolve, join } = require('path');
-const ParseGemini = require('gemini-to-html/parse');
-const RenderGemini = require('gemini-to-html/render');
-const { debuglog, promisify } = require('util');
+import { access, cp, readdir, readFile, writeFile } from 'fs/promises';
+import { exec } from 'child_process';
+import { basename, join } from 'path';
+import ParseGemini from 'gemini-to-html/parse.js';
+import RenderGemini from 'gemini-to-html/render.js';
+import { debuglog, promisify } from 'util';
+import { ensureDirectoryExists, rmIfExists } from './utils.js';
+import { kFileNotFoundError } from './constants.js';

 
 // Generators for the Blog
 
 
 // Generators for the Blog
 

-const StaticGenerator = require('./generators/static');
-const HTMLGenerator = require('./generators/html');
-const RSSGenerator = require('./generators/rss');
-const TXTGenerator = require('./generators/txt');
+import StaticGenerator from './generators/static.js';
+import HTMLGenerator from './generators/html.js';
+import RSSGenerator from './generators/rss.js';
+import TXTGenerator from './generators/txt.js';

 
 // Archiving Methods
 
 
 // Archiving Methods
 

-const GemlogArchiver = require('./archivers/gemlog');
+import GemlogArchiver from './archivers/gemlog.js';

 
 // Remote Handler
 
 
 // Remote Handler
 

-const Remote = require('./remote');
+import Remote from './remote.js';

 
 const internals = {
 
 
 const internals = {
 


@@ -31,7 +31,6 @@ const internals = {
 
   // constants
 
 
   // constants
 

-  kFileNotFoundError: 'ENOENT',

   kGeminiRe: /\.gmi$/i,
   kMetadataFilename: 'metadata.json',
 
   kGeminiRe: /\.gmi$/i,
   kMetadataFilename: 'metadata.json',
 


@@ -50,7 +49,7 @@ const internals = {
  * @param {Blog.tConfiguration} config the initialization options to
  * extend the instance
  */
  * @param {Blog.tConfiguration} config the initialization options to
  * extend the instance
  */

-module.exports = class Blog {
+export default class Blog {

 
   constructor(config) {
 
 
   constructor(config) {
 


@@ -58,35 +57,36 @@ module.exports = class Blog {
   }
 
   /**
   }
 
   /**

-   * Shifts the blog posts, adds the passed path to slot 0, and
+   * Shifts the blog posts, adds the passed file to slot 0, and

    * generates files.
    *
    * @function add
    * @memberof Blog
    * generates files.
    *
    * @function add
    * @memberof Blog

-   * @param {string} postLocation the path to the directory containing
-   * the post structure
+   * @param {string} postLocation the path to the blog post file

    * @return {Promise<undefined>} empty promise, returns no value
    * @instance
    */
   async add(postLocation) {
 
    * @return {Promise<undefined>} empty promise, returns no value
    * @instance
    */
   async add(postLocation) {
 

-    await this._ensurePostsDirectoryExists();
+    await ensureDirectoryExists(this.postsDirectory);

     try {
       await this.syncDown();
     }
     try {
       await this.syncDown();
     }

-    catch {};
+    catch {}
+

     await this._shift();
     await this._shift();

-    await this._ensurePostsDirectoryExists(join(this.postsDirectory, '0'));
-    await this.update(postLocation);
+    const firstDirectory = join(this.postsDirectory, '0');
+    await rmIfExists(firstDirectory);
+    await ensureDirectoryExists(firstDirectory);
+    await this._update(postLocation);

   }
 
   /**
   }
 
   /**

-   * Adds the passed path to slot 0, and generates files.
+   * Update slot 0 with the passed gmi file, and generates files.

    *
    * @function update
    * @memberof Blog
    *
    * @function update
    * @memberof Blog

-   * @param {string} postLocation the path to the directory containing
-   * the post structure
+   * @param {string} postLocation the path to the blog post file

    * @return {Promise<undefined>} empty promise, returns no value
    * @instance
    */
    * @return {Promise<undefined>} empty promise, returns no value
    * @instance
    */


@@ -95,19 +95,9 @@ module.exports = class Blog {
     try {
       await this.syncDown();
     }
     try {
       await this.syncDown();
     }

-    catch {};
-    const metadata = await this._getMetadata();
-    await this._ensurePostsDirectoryExists();
-    await this._copyPost(postLocation);
-    await this._writeMetadata(metadata);
-
-    await this._archive(postLocation);
+    catch {}

 
 

-    await this.generate();
-    try {
-      await this.syncUp();
-    }
-    catch {};
+    await this._update(postLocation);

   }
 
   /**
   }
 
   /**


@@ -118,19 +108,19 @@ module.exports = class Blog {
    * @return {Promise<undefined>} empty promise, returns no value
    * @instance
    */
    * @return {Promise<undefined>} empty promise, returns no value
    * @instance
    */

-  async publish(bucket) {
+  async publish(host) {

 
 

-    internals.debuglog(`Publishing to ${bucket}`);
+    internals.debuglog(`Publishing to ${host}`);

     try {
     try {

-      await internals.exec('which aws');
+      await internals.exec('which rsync');

     }
     catch (err) {
     }
     catch (err) {

-      console.error('Please install and configure AWS CLI to publish.');
+      console.error('Please install and configure rsync to publish.');

     }
 
     try {
     }
 
     try {

-      await internals.exec(`aws s3 sync --acl public-read --delete ${this.staticDirectory} s3://${bucket}`);
-      await internals.exec(`aws s3 cp --content-type 'text/plain; charset=utf-8 ' --acl public-read ${this.staticDirectory}/index.txt s3://${bucket}`);
+      internals.debuglog(`Copying ephemeral blog from ${this.blogOutputDirectory}`);
+      await internals.exec(`rsync -r ${this.blogOutputDirectory}/ ${host}`);

     }
     catch (err) {
       console.error('Failed to publish');
     }
     catch (err) {
       console.error('Failed to publish');


@@ -160,9 +150,8 @@ module.exports = class Blog {
     }
 
     try {
     }
 
     try {

-      const gemlogPath = resolve(join(__dirname, '../', '.gemlog'));
-      internals.debuglog(`Reading archive from ${gemlogPath}`);
-      await internals.exec(`rsync -r ${gemlogPath}/ ${host}`);
+      internals.debuglog(`Copying archive from ${this.archiveOutputDirectory}`);
+      await internals.exec(`rsync -r ${this.archiveOutputDirectory}/ ${host}`);

     }
     catch (err) {
       console.error('Failed to publish archive');
     }
     catch (err) {
       console.error('Failed to publish archive');


@@ -181,7 +170,9 @@ module.exports = class Blog {
    * @instance
    */
   async addRemote(remote) {
    * @instance
    */
   async addRemote(remote) {

-    await Remote.add(this.remoteConfig, remote)
+
+    await ensureDirectoryExists(this.configDirectory);
+    await Remote.add(this.remoteConfig, remote);

   }
 
   /**
   }
 
   /**


@@ -193,7 +184,8 @@ module.exports = class Blog {
    * @instance
    */
   async removeRemote() {
    * @instance
    */
   async removeRemote() {

-    await Remote.remove(this.remoteConfig)
+
+    await Remote.remove(this.remoteConfig);

   }
 
 
   }
 
 


@@ -206,7 +198,11 @@ module.exports = class Blog {
    * @instance
    */
   async syncDown() {
    * @instance
    */
   async syncDown() {

-    await Remote.syncDown(this.remoteConfig, this.blogDirectory)
+
+    internals.debuglog('Pulling remote state');
+    await ensureDirectoryExists(this.dataDirectory);
+    await Remote.syncDown(this.remoteConfig, this.dataDirectory);
+    internals.debuglog('Pulled remote state');

   }
 
   /**
   }
 
   /**


@@ -218,9 +214,32 @@ module.exports = class Blog {
    * @instance
    */
   async syncUp() {
    * @instance
    */
   async syncUp() {

-    await Remote.syncUp(this.remoteConfig, this.blogDirectory)
+
+    internals.debuglog('Pushing remote state');
+    await ensureDirectoryExists(this.dataDirectory);
+    await Remote.syncUp(this.remoteConfig, this.dataDirectory);
+    internals.debuglog('Pushed remote state');

   }
 
   }
 

+  // Adds the passed path to slot 0, and generates files.
+
+  async _update(postLocation) {
+
+    const metadata = await this._getMetadata();
+    await ensureDirectoryExists(this.postsDirectory);
+    await this._copyPost(postLocation);
+    await this._writeMetadata(metadata);
+
+    await this._archive(postLocation);
+
+    await this.generate();
+    try {
+      await this.syncUp();
+    }
+    catch {}
+  }
+
+

   // Parses Gemini for each page, copies assets and generates index.
 
   async generate() {
   // Parses Gemini for each page, copies assets and generates index.
 
   async generate() {


@@ -229,12 +248,24 @@ module.exports = class Blog {
 
     const posts = await this._readPosts();
 
 
     const posts = await this._readPosts();
 

-    await StaticGenerator(this.postsDirectory, this.staticDirectory, posts);
-    await HTMLGenerator(this.templatesDirectory, this.staticDirectory, posts);
-    await RSSGenerator(this.templatesDirectory, this.staticDirectory, posts);
-    await TXTGenerator(this.templatesDirectory, this.staticDirectory, posts);
+    // Start from a clean slate.
+    await rmIfExists(this.blogOutputDirectory);
+    await ensureDirectoryExists(this.blogOutputDirectory);
+
+    // Run each generator
+    await StaticGenerator(this.staticDirectory, this.blogOutputDirectory, posts);
+    await HTMLGenerator(await this._templateDirectoryFor('index.html'), this.blogOutputDirectory, posts);
+    await RSSGenerator(await this._templateDirectoryFor('feed.xml'), this.blogOutputDirectory, posts);
+    await TXTGenerator(await this._templateDirectoryFor('index.txt'), this.blogOutputDirectory, posts);

 
 

-    await GemlogArchiver(this.archiveDirectory);
+    // Start from a clean slate.
+    await rmIfExists(this.archiveOutputDirectory);
+    await ensureDirectoryExists(this.archiveOutputDirectory);
+    await ensureDirectoryExists(this.archiveDirectory);
+
+    // Run each archiver
+    await GemlogArchiver(await this._templateDirectoryFor('index.gmi'), this.archiveDirectory, this.archiveOutputDirectory);
+    // TODO: GopherArchiver

   }
 
   // Reads the posts into an array
   }
 
   // Reads the posts into an array


@@ -249,7 +280,7 @@ module.exports = class Blog {
         posts.push(await this._readPost(i));
       }
       catch (error) {
         posts.push(await this._readPost(i));
       }
       catch (error) {

-        if (error.code === internals.kFileNotFoundError) {
+        if (error.code === kFileNotFoundError) {

           internals.debuglog(`Skipping ${i}`);
           continue;
         }
           internals.debuglog(`Skipping ${i}`);
           continue;
         }


@@ -263,27 +294,28 @@ module.exports = class Blog {
 
   // Reads an individual post
 
 
   // Reads an individual post
 

-  async _readPost(index=0) {
-      const postSourcePath = join(this.postsDirectory, `${index}`);
+  async _readPost(index = 0) {

 
 

-      internals.debuglog(`Reading ${postSourcePath}`);
+    const postSourcePath = join(this.postsDirectory, `${index}`);

 
 

-      await access(postSourcePath);
+    internals.debuglog(`Reading ${postSourcePath}`);

 
 

-      const metadata = await this._getMetadata(index);
+    await access(postSourcePath);

 
 

-      const postContentPath = await this._findBlogContent(postSourcePath);
-      internals.debuglog(`Reading ${postContentPath}`);
-      const postContent = await readFile(postContentPath, { encoding: 'utf8' });
+    const metadata = await this._getMetadata(index);

 
 

-      internals.debuglog('Parsing Gemini');
-      return {
-        ...metadata,
-        location: postSourcePath,
-        index,
-        html: RenderGemini(ParseGemini(postContent)),
-        raw: postContent
-      };
+    const postContentPath = await this._findBlogContent(postSourcePath);
+    internals.debuglog(`Reading ${postContentPath}`);
+    const postContent = await readFile(postContentPath, { encoding: 'utf8' });
+
+    internals.debuglog('Parsing Gemini');
+    return {
+      ...metadata,
+      location: postSourcePath,
+      index,
+      html: RenderGemini(ParseGemini(postContent)),
+      raw: postContent
+    };

   }
 
   // Shift the posts, delete any remainder.
   }
 
   // Shift the posts, delete any remainder.


@@ -297,14 +329,14 @@ module.exports = class Blog {
 
       try {
         internals.debuglog(`Archiving ${targetPath}`);
 
       try {
         internals.debuglog(`Archiving ${targetPath}`);

-        await rm(targetPath, { recursive: true, force: true });
+        await rmIfExists(targetPath);

         await access(sourcePath); // check the source path
 
         internals.debuglog(`Shifting blog post ${sourcePath} to ${targetPath}`);
         await cp(sourcePath, targetPath, { recursive: true });
       }
       catch (error) {
         await access(sourcePath); // check the source path
 
         internals.debuglog(`Shifting blog post ${sourcePath} to ${targetPath}`);
         await cp(sourcePath, targetPath, { recursive: true });
       }
       catch (error) {

-        if (error.code === internals.kFileNotFoundError) {
+        if (error.code === kFileNotFoundError) {

           internals.debuglog(`Skipping ${sourcePath}: Does not exist.`);
           continue;
         }
           internals.debuglog(`Skipping ${sourcePath}: Does not exist.`);
           continue;
         }


@@ -317,16 +349,17 @@ module.exports = class Blog {
   // Moves older posts to the archive
 
   async _archive() {
   // Moves older posts to the archive
 
   async _archive() {

+

     internals.debuglog('Archiving post');
     const post = await this._readPost(0);
     internals.debuglog('Archiving post');
     const post = await this._readPost(0);

-    await this._ensureDirectoryExists(this.archiveDirectory);
+    await ensureDirectoryExists(this.archiveDirectory);

 
     const targetPath = join(this.archiveDirectory, post.id);
 
     internals.debuglog(`Removing ${targetPath}`);
 
     const targetPath = join(this.archiveDirectory, post.id);
 
     internals.debuglog(`Removing ${targetPath}`);

-    await rm(targetPath, { recursive: true, force: true });
+    await rmIfExists(targetPath);

     internals.debuglog(`Adding ${post.location} to ${targetPath}`);
     internals.debuglog(`Adding ${post.location} to ${targetPath}`);

-    await this._ensureDirectoryExists(targetPath);
+    await ensureDirectoryExists(targetPath);

     await cp(post.location, targetPath, { recursive: true });
     internals.debuglog(`Added ${post.location} to ${targetPath}`);
   }
     await cp(post.location, targetPath, { recursive: true });
     internals.debuglog(`Added ${post.location} to ${targetPath}`);
   }


@@ -363,48 +396,21 @@ module.exports = class Blog {
     await writeFile(metadataTarget, JSON.stringify(metadata, null, 2));
   }
 
     await writeFile(metadataTarget, JSON.stringify(metadata, null, 2));
   }
 

-  // Copies a post directory to the latest slot.
+  // Copies a post file to the latest slot.

 
   async _copyPost(postLocation) {
 
 
   async _copyPost(postLocation) {
 

+    internals.debuglog(`Copying ${postLocation}`);

     const targetPath = join(this.postsDirectory, '0');
     const postName = basename(postLocation);
     const targetPost = join(targetPath, postName);
 
     const targetPath = join(this.postsDirectory, '0');
     const postName = basename(postLocation);
     const targetPost = join(targetPath, postName);
 

-    internals.debuglog(`Removing ${targetPath}`);
-    await rm(targetPath, { recursive: true, force: true });
-    await this._ensureDirectoryExists(targetPath);
-    internals.debuglog(`Adding ${postLocation} to ${targetPost}`);
+    await rmIfExists(targetPath);
+    await ensureDirectoryExists(targetPath);

     await cp(postLocation, targetPost, { recursive: true });
     internals.debuglog(`Added ${postLocation} to ${targetPath}`);
   }
 
     await cp(postLocation, targetPost, { recursive: true });
     internals.debuglog(`Added ${postLocation} to ${targetPath}`);
   }
 

-  // Ensures a directory exists.
-
-  async _ensureDirectoryExists(directory) {
-
-    internals.debuglog(`Checking if ${directory} exists.`);
-    try {
-      await access(directory);
-    }
-    catch (error) {
-      if (error.code === internals.kFileNotFoundError) {
-        internals.debuglog(`Creating ${directory}`);
-        await mkdir(directory, { recursive: true });
-        return;
-      }
-
-      throw error;
-    }
-  }
-
-  // Ensures posts directory exists
-
-  async _ensurePostsDirectoryExists() {
-
-    return this._ensureDirectoryExists(this.postsDirectory);
-  }
-

   // Looks for a `.gmi` file in the blog directory, and returns the path
 
   async _findBlogContent(directory) {
   // Looks for a `.gmi` file in the blog directory, and returns the path
 
   async _findBlogContent(directory) {


@@ -422,4 +428,21 @@ module.exports = class Blog {
 
     throw new Error(internals.strings.geminiNotFound);
   }
 
     throw new Error(internals.strings.geminiNotFound);
   }

-};
+
+  // Gets the template directory for a given template.
+  async _templateDirectoryFor(template) {
+
+    try {
+      await access(join(this.templatesDirectory, template));
+      return this.templatesDirectory;
+    }
+    catch (error) {
+      if (error.code === kFileNotFoundError) {
+        internals.debuglog(`No custom template for ${template}`);
+        return this.defaultTemplatesDirectory;
+      }
+
+      throw error;
+    }
+  }
+}