]> git.r.bdr.sh - rbdr/blog/blobdiff - lib/blog.js
Docs update
[rbdr/blog] / lib / blog.js
index 0b291dfa71b8c00dd40438c30e5728459f38ae52..6923a10b3b649c845e0ae8386fa690fff498f57b 100644 (file)
@@ -1,11 +1,13 @@
 'use strict';
 
-const { access, cp, mkdir, readdir, readFile, rm, writeFile } = require('fs/promises');
+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');
 
 // Generators for the Blog
 
@@ -31,7 +33,6 @@ const internals = {
 
   // constants
 
-  kFileNotFoundError: 'ENOENT',
   kGeminiRe: /\.gmi$/i,
   kMetadataFilename: 'metadata.json',
 
@@ -58,37 +59,35 @@ 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
-   * @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) {
 
-    await this._ensurePostsDirectoryExists();
+    await ensureDirectoryExists(this.postsDirectory);
     try {
       await this.syncDown();
     }
     catch {};
     await this._shift();
     const firstDirectory = join(this.postsDirectory, '0'); 
-    await rm(firstDirectory, { recursive: true, force: true });
-    await this._ensurePostsDirectoryExists(firstDirectory);
+    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
-   * @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
    */
@@ -198,6 +197,7 @@ module.exports = class Blog {
    */
   async syncDown() {
     internals.debuglog('Pulling remote state');
+    await ensureDirectoryExists(this.postsDirectory);
     await Remote.syncDown(this.remoteConfig, this.blogDirectory)
     internals.debuglog('Pulled remote state');
   }
@@ -212,6 +212,7 @@ module.exports = class Blog {
    */
   async syncUp() {
     internals.debuglog('Pushing remote state');
+    await ensureDirectoryExists(this.postsDirectory);
     await Remote.syncUp(this.remoteConfig, this.blogDirectory)
     internals.debuglog('Pushed remote state');
   }
@@ -221,7 +222,7 @@ module.exports = class Blog {
   async _update(postLocation) {
 
     const metadata = await this._getMetadata();
-    await this._ensurePostsDirectoryExists();
+    await ensureDirectoryExists(this.postsDirectory);
     await this._copyPost(postLocation);
     await this._writeMetadata(metadata);
 
@@ -263,7 +264,7 @@ module.exports = class Blog {
         posts.push(await this._readPost(i));
       }
       catch (error) {
-        if (error.code === internals.kFileNotFoundError) {
+        if (error.code === kFileNotFoundError) {
           internals.debuglog(`Skipping ${i}`);
           continue;
         }
@@ -311,14 +312,14 @@ module.exports = class Blog {
 
       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) {
-        if (error.code === internals.kFileNotFoundError) {
+        if (error.code === kFileNotFoundError) {
           internals.debuglog(`Skipping ${sourcePath}: Does not exist.`);
           continue;
         }
@@ -333,14 +334,14 @@ module.exports = class Blog {
   async _archive() {
     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}`);
-    await rm(targetPath, { recursive: true, force: true });
+    await rmIfExists(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}`);
   }
@@ -377,48 +378,21 @@ module.exports = class Blog {
     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) {
 
+    internals.debuglog(`Copying ${postLocation}`);
     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}`);
   }
 
-  // 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) {