Update README.md

[rbdr/blog] / lib / blog.js

diff --git a/lib/blog.js b/lib/blog.js
index 6923a10b3b649c845e0ae8386fa690fff498f57b..e1a76a8d848e2803d6f116495307f7d66698d8c3 100644 (file)
--- a/lib/blog.js
+++ b/lib/blog.js
@@ -1,28 +1,26 @@
-'use strict';
-
-const { access, cp, mkdir, readdir, readFile, 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');
-const { ensureDirectoryExists, rmIfExists } = require('./utils');
-const { kFileNotFoundError } = require('./constants');
+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 = {
 


@@ -51,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) {
 


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

-    catch {};
+    catch {}
+

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

-    const firstDirectory = join(this.postsDirectory, '0'); 
+    const firstDirectory = join(this.postsDirectory, '0');

     await rmIfExists(firstDirectory);
     await ensureDirectoryExists(firstDirectory);
     await this._update(postLocation);
     await rmIfExists(firstDirectory);
     await ensureDirectoryExists(firstDirectory);
     await this._update(postLocation);


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

-    catch {};
-    const metadata = await this._update();
+    catch {}
+
+    await this._update(postLocation);

   }
 
   /**
   }
 
   /**


@@ -108,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');


@@ -150,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');


@@ -171,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);

   }
 
   /**
   }
 
   /**


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

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

   }
 
 
   }
 
 


@@ -196,9 +198,10 @@ module.exports = class Blog {
    * @instance
    */
   async syncDown() {
    * @instance
    */
   async syncDown() {

+

     internals.debuglog('Pulling remote state');
     internals.debuglog('Pulling remote state');

-    await ensureDirectoryExists(this.postsDirectory);
-    await Remote.syncDown(this.remoteConfig, this.blogDirectory)
+    await ensureDirectoryExists(this.dataDirectory);
+    await Remote.syncDown(this.remoteConfig, this.dataDirectory);

     internals.debuglog('Pulled remote state');
   }
 
     internals.debuglog('Pulled remote state');
   }
 


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

+

     internals.debuglog('Pushing remote state');
     internals.debuglog('Pushing remote state');

-    await ensureDirectoryExists(this.postsDirectory);
-    await Remote.syncUp(this.remoteConfig, this.blogDirectory)
+    await ensureDirectoryExists(this.dataDirectory);
+    await Remote.syncUp(this.remoteConfig, this.dataDirectory);

     internals.debuglog('Pushed remote state');
   }
 
     internals.debuglog('Pushed remote state');
   }
 


@@ -232,7 +236,7 @@ module.exports = class Blog {
     try {
       await this.syncUp();
     }
     try {
       await this.syncUp();
     }

-    catch {};
+    catch {}

   }
 
 
   }
 
 


@@ -244,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);
+
+    // Start from a clean slate.
+    await rmIfExists(this.archiveOutputDirectory);
+    await ensureDirectoryExists(this.archiveOutputDirectory);
+    await ensureDirectoryExists(this.archiveDirectory);

 
 

-    await GemlogArchiver(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


@@ -278,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.


@@ -332,6 +349,7 @@ 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);
     await ensureDirectoryExists(this.archiveDirectory);
     internals.debuglog('Archiving post');
     const post = await this._readPost(0);
     await ensureDirectoryExists(this.archiveDirectory);


@@ -410,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;
+    }
+  }
+}