Add rudimentary gemlog archive support

3 files changed, 164 insertions, 42 deletions

diff --git a/lib/archivers/gemlog.js b/lib/archivers/gemlog.js
new file mode 100644
index 0000000..d50d411
--- /dev/null
+++ b/lib/archivers/gemlog.js
@@ -0,0 +1,45 @@
+const { mkdir, readdir, rm, writeFile } = require('fs/promises');
+const { debuglog, promisify } = require('util');
+const { ncp } = require('ncp');
+const { join } = require('path');
+
+const internals = {
+  kArchiveName: '.gemlog',
+  kIndexName: 'index.gmi',
+  kGeminiRe: /\.gmi$/i,
+
+  ncp: promisify(ncp),
+  debuglog: debuglog('blog'),
+};
+
+module.exports = async function(archiveDirectory) {
+  internals.debuglog(`Reading archive ${archiveDirectory}`);
+  const postIds = await readdir(archiveDirectory)
+  const posts = [];
+  for (const id of postIds) {
+    const postDirectory = join(archiveDirectory, id);
+    const slug = (await readdir(postDirectory))
+        .filter((entry) => internals.kGeminiRe.test(entry))[0];
+
+      posts.push({ id, slug })
+  };
+
+  internals.debuglog(`Read ${posts.length} posts`);
+
+  const index = ['# Unlimited Pizza Gemlog Archive', '',
+    ...posts.map((post) => `=> ./${post.id}/${post.slug}`)].join('\n');
+
+  try {
+    internals.debuglog('Removing index');
+    await rm(internals.kArchiveName, { recursive: true });
+  }
+  finally {
+    internals.debuglog('Creating index');
+    await mkdir(internals.kArchiveName);
+    const indexFile = join(internals.kArchiveName, internals.kIndexName);
+    await writeFile(indexFile, index);
+
+    internals.debuglog('Copying posts to archive');
+    await internals.ncp(archiveDirectory, internals.kArchiveName);
+  }
+};
diff --git a/lib/blog.js b/lib/blog.js
index 27a440e..8ae3e21 100644
--- a/lib/blog.js
+++ b/lib/blog.js
@@ -1,19 +1,28 @@
 'use strict';
 
-const { access, mkdir, readdir, readFile, rmdir, writeFile } = require('fs/promises');
+const { access, mkdir, readdir, readFile, rm, writeFile } = require('fs/promises');
+const { exec } = require('child_process');
 const { ncp } = require('ncp');
 const { join } = require('path');
-const Marked = require('marked');
+const ParseGemini = require('gemini-to-html/parse');
+const RenderGemini = require('gemini-to-html/render');
 const { debuglog, promisify } = require('util');
 
+// Generators for the Blog
+
 const StaticGenerator = require('./generators/static');
 const HTMLGenerator = require('./generators/html');
 const RSSGenerator = require('./generators/rss');
 const TXTGenerator = require('./generators/txt');
 
+// Archiving Methods
+
+const GemlogArchiver = require('./archivers/gemlog');
+
 const internals = {
 
   // Promisified functions
+  exec: promisify(exec),
   ncp: promisify(ncp),
 
   debuglog: debuglog('blog'),
@@ -21,13 +30,13 @@ const internals = {
   // constants
 
   kFileNotFoundError: 'ENOENT',
-  kMarkdownRe: /\.md$/i,
+  kGeminiRe: /\.gmi$/i,
   kMetadataFilename: 'metadata.json',
 
   // Strings
 
   strings: {
-    markdownNotFound: 'Markdown file was not found in blog directory. Please update.'
+    geminiNotFound: 'Gemini file was not found in blog directory. Please update.'
   }
 };
 
@@ -61,6 +70,7 @@ module.exports = class Blog {
 
     await this._ensurePostsDirectoryExists();
     await this._shift();
+    await mkdir(join(this.postsDirectory, '0'));
     await this.update(postLocation);
   }
 
@@ -81,6 +91,8 @@ module.exports = class Blog {
     await this._copyPost(postLocation);
     await this._writeMetadata(metadata);
 
+    await this._archive(postLocation);
+
     await this.generate();
   }
 
@@ -92,54 +104,54 @@ module.exports = class Blog {
    * @return {Promise<undefined>} empty promise, returns no value
    * @instance
    */
-  publish() {
+  async publish(bucket) {
+
+    internals.debuglog(`Publishing to ${bucket}`);
+    try {
+      await internals.exec('which aws');
+    }
+    catch (err) {
+      console.error('Please install and configure AWS CLI to publish.');
+    }
+
+    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}`);
+    }
+    catch (err) {
+      console.error('Failed to publish');
+      console.error(err.stderr);
+    }
 
-    console.error('Publishing not yet implemented');
-    return Promise.resolve();
+    internals.debuglog('Finished publishing');
   }
 
-  // Parses markdown for each page, copies assets and generates index.
+  // Parses Gemini for each page, copies assets and generates index.
 
   async generate() {
 
     internals.debuglog('Generating output');
 
-    const posts = await this._readPosts(this.postsDirectory);
+    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);
+
+    await GemlogArchiver(this.archiveDirectory);
   }
 
   // Reads the posts into an array
 
-  async _readPosts(source) {
+  async _readPosts() {
 
     internals.debuglog('Reading posts');
     const posts = [];
 
     for (let i = 0; i < this.maxPosts; ++i) {
-      const postSourcePath = join(source, `${i}`);
-
-      internals.debuglog(`Reading ${postSourcePath} into posts array`);
-
       try {
-        await access(postSourcePath);
-
-        const metadata = await this._getMetadata(i);
-
-        const postContentPath = await this._findBlogContent(postSourcePath);
-        internals.debuglog(`Reading ${postContentPath}`);
-        const postContent = await readFile(postContentPath, { encoding: 'utf8' });
-
-        internals.debuglog('Parsing markdown');
-        posts.push({
-          ...metadata,
-          index: i,
-          html: Marked(postContent),
-          raw: postContent
-        });
+        posts.push(await this._readPost(i));
       }
       catch (error) {
         if (error.code === internals.kFileNotFoundError) {
@@ -154,6 +166,31 @@ module.exports = class Blog {
     return posts;
   }
 
+  // Reads an individual post
+
+  async _readPost(index=0) {
+      const postSourcePath = join(this.postsDirectory, `${index}`);
+
+      internals.debuglog(`Reading ${postSourcePath}`);
+
+      await access(postSourcePath);
+
+      const metadata = await this._getMetadata(index);
+
+      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.
 
   async _shift() {
@@ -164,8 +201,8 @@ module.exports = class Blog {
       const sourcePath = join(this.postsDirectory, `${i - 1}`);
 
       try {
-        internals.debuglog(`Removing ${targetPath}`);
-        await rmdir(targetPath, { recursive: true });
+        internals.debuglog(`Archiving ${targetPath}`);
+        await rm(targetPath, { recursive: true });
 
         await access(sourcePath); // check the source path
 
@@ -183,6 +220,26 @@ module.exports = class Blog {
     }
   }
 
+  // Moves older posts to the archive
+
+  async _archive() {
+    internals.debuglog('Archiving post');
+    const post = await this._readPost(0);
+    await this._ensureDirectoryExists(this.archiveDirectory);
+
+    const targetPath = join(this.archiveDirectory, post.id);
+
+    try {
+      internals.debuglog(`Removing ${targetPath}`);
+      await rm(targetPath, { recursive: true });
+    } 
+    finally {
+      internals.debuglog(`Adding ${post.location} to ${targetPath}`);
+      await internals.ncp(post.location, targetPath);
+      internals.debuglog(`Added ${post.location} to ${targetPath}`);
+    }
+  }
+
   // Attempts to read existing metadata. Otherwise generates new set.
 
   async _getMetadata(index = 0) {
@@ -222,16 +279,36 @@ module.exports = class Blog {
     const targetPath = join(this.postsDirectory, '0');
 
     internals.debuglog(`Removing ${targetPath}`);
-    await rmdir(targetPath, { recursive: true });
+    await rm(targetPath, { recursive: true });
 
     internals.debuglog(`Adding ${postLocation} to ${targetPath}`);
     await internals.ncp(postLocation, targetPath);
   }
 
-  // Ensures the posts directory exists.
+  // 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 posts directory');
+        await mkdir(directory);
+        return;
+      }
+
+      throw error;
+    }
+  }
+
+  // Ensures posts directory exists
 
   async _ensurePostsDirectoryExists() {
 
+    return this._ensureDirectoryExists(this.postsDirectory);
     internals.debuglog(`Checking if ${this.postsDirectory} exists.`);
     try {
       await access(this.postsDirectory);
@@ -247,21 +324,21 @@ module.exports = class Blog {
     }
   }
 
-  // Looks for a `.md` file in the blog directory, and returns the path
+  // Looks for a `.gmi` file in the blog directory, and returns the path
 
   async _findBlogContent(directory) {
 
     const entries = await readdir(directory);
 
-    const markdownEntries = entries
-      .filter((entry) => internals.kMarkdownRe.test(entry))
+    const geminiEntries = entries
+      .filter((entry) => internals.kGeminiRe.test(entry))
       .map((entry) => join(directory, entry));
 
-    if (markdownEntries.length > 0) {
-      internals.debuglog(`Found markdown file: ${markdownEntries[0]}`);
-      return markdownEntries[0];
+    if (geminiEntries.length > 0) {
+      internals.debuglog(`Found gemini file: ${geminiEntries[0]}`);
+      return geminiEntries[0];
     }
 
-    throw new Error(internals.strings.markdownNotFound);
+    throw new Error(internals.strings.geminiNotFound);
   }
 };
diff --git a/lib/generators/static.js b/lib/generators/static.js
index eb3c631..a0856a3 100644
--- a/lib/generators/static.js
+++ b/lib/generators/static.js
@@ -1,6 +1,6 @@
 'use strict';
 
-const { access, rmdir } = require('fs/promises');
+const { access, rm } = require('fs/promises');
 const { ncp } = require('ncp');
 const { join } = require('path');
 const { debuglog, promisify } = require('util');
@@ -25,7 +25,7 @@ module.exports = async function StaticGenerator(source, target, posts) {
   const assetsTarget = join(target, internals.kAssetsDirectoryName);
 
   internals.debuglog(`Removing ${assetsTarget}`);
-  await rmdir(assetsTarget, { recursive: true });
+  await rm(assetsTarget, { recursive: true });
 
   for (let i = 0; i < posts.length; ++i) {
     const postSourcePath = join(source, `${i}`);