A bit more refactoring

I propose we put utils-methods into `lib/common`, and distinguish them a bit more than just `utils`

Author: megoth

lib/common/fs-utils.js

@@ -0,0 +1,33 @@
+module.exports.copyTemplateDir = copyTemplateDir
+module.exports.processFile = processFile
+
+const fs = require('fs-extra')
+
+async function copyTemplateDir (templatePath, targetPath) {
+  return new Promise((resolve, reject) => {
+    fs.copy(templatePath, targetPath, (error) => {
+      if (error) { return reject(error) }
+
+      resolve()
+    })
+  })
+}
+
+async function processFile (filePath, manipulateSourceFn) {
+  return new Promise((resolve, reject) => {
+    fs.readFile(filePath, 'utf8', (error, rawSource) => {
+      if (error) {
+        return reject(error)
+      }
+
+      const output = manipulateSourceFn(rawSource)
+
+      fs.writeFile(filePath, output, (error) => {
+        if (error) {
+          return reject(error)
+        }
+        resolve()
+      })
+    })
+  })
+}

lib/common/template-utils.js

@@ -0,0 +1,38 @@
+module.exports.processHandlebarFile = processHandlebarFile
+
+const Handlebars = require('handlebars')
+const debug = require('../debug').errors
+const { processFile } = require('./fs-utils')
+
+/**
+ * Reads a file, processes it (performing template substitution), and saves
+ * back the processed result.
+ *
+ * @param filePath {string}
+ * @param substitutions {Object}
+ *
+ * @return {Promise}
+ */
+async function processHandlebarFile (filePath, substitutions) {
+  return processFile(filePath, (rawSource) => processHandlebarTemplate(rawSource, substitutions))
+}
+
+/**
+ * Performs a Handlebars string template substitution, and returns the
+ * resulting string.
+ *
+ * @see https://www.npmjs.com/package/handlebars
+ *
+ * @param source {string} e.g. 'Hello, {{name}}'
+ *
+ * @return {string} Result, e.g. 'Hello, Alice'
+ */
+function processHandlebarTemplate (source, substitutions) {
+  try {
+    const template = Handlebars.compile(source)
+    return template(substitutions)
+  } catch (error) {
+    debug(`Error processing template: ${error}`)
+    return source
+  }
+}

lib/models/account-template.js

@@ -1,10 +1,10 @@
 'use strict'
 
-const fs = require('fs-extra')
 const path = require('path')
 const mime = require('mime-types')
 const recursiveRead = require('recursive-readdir')
-const utils = require('../utils')
+const fsUtils = require('../common/fs-utils')
+const templateUtils = require('../common/template-utils')
 
 const RDF_MIME_TYPES = require('../ldp').RDF_MIME_TYPES
 const TEMPLATE_EXTENSIONS = [ '.acl', '.meta', '.json', '.hbs', '.handlebars' ]
@@ -62,13 +62,7 @@ class AccountTemplate {
    * @return {Promise}
    */
   static copyTemplateDir (templatePath, accountPath) {
-    return new Promise((resolve, reject) => {
-      fs.copy(templatePath, accountPath, (error) => {
-        if (error) { return reject(error) }
-
-        resolve()
-      })
-    })
+    return fsUtils.copyTemplateDir(templatePath, accountPath)
   }
 
   /**
@@ -130,7 +124,7 @@ class AccountTemplate {
    */
   processAccount (accountPath) {
     return this.readTemplateFiles(accountPath)
-      .then(files => Promise.all(files.map(path => utils.processHandlebarFile(path, this.substitutions))))
+      .then(files => Promise.all(files.map(path => templateUtils.processHandlebarFile(path, this.substitutions))))
   }
 
   /**

lib/server-config.js

@@ -6,7 +6,8 @@
 
 const fs = require('fs-extra')
 const path = require('path')
-const utils = require('./utils')
+const templateUtils = require('./common/template-utils')
+const fsUtils = require('./common/fs-utils')
 
 /**
  * Ensures that a directory has been copied / initialized. Used to ensure that
@@ -51,8 +52,8 @@ async function ensureWelcomePage (argv) {
   if (!fs.existsSync(existingIndexPage)) {
     console.log(argv)
     fs.mkdirp(serverRootDir)
-    await utils.copyTemplateDir(templates.server, serverRootDir)
-    await utils.processHandlebarFile(existingIndexPage, {
+    await fsUtils.copyTemplateDir(templates.server, serverRootDir)
+    await templateUtils.processHandlebarFile(existingIndexPage, {
       serverName: server ? server.name : host.hostname,
       serverDescription: server ? server.description : '',
       serverLogo: server ? server.logo : '',

lib/utils.js

@@ -13,16 +13,12 @@ module.exports.debrack = debrack
 module.exports.stripLineEndings = stripLineEndings
 module.exports.fullUrlForReq = fullUrlForReq
 module.exports.routeResolvedFile = routeResolvedFile
-module.exports.processHandlebarFile = processHandlebarFile
-module.exports.copyTemplateDir = copyTemplateDir
 
 const fs = require('fs-extra')
 const path = require('path')
 const $rdf = require('rdflib')
 const from = require('from2')
 const url = require('url')
-const Handlebars = require('handlebars')
-const debug = require('./debug').errors
 
 /**
  * Returns a fully qualified URL from an Express.js Request object.
@@ -151,64 +147,6 @@ function parse (data, baseUri, contentType, callback) {
   }
 }
 
-/**
- * Reads a file, processes it (performing template substitution), and saves
- * back the processed result.
- *
- * @param filePath {string}
- * @param substitutions {Object}
- *
- * @return {Promise}
- */
-async function processHandlebarFile (filePath, substitutions) {
-  return new Promise((resolve, reject) => {
-    fs.readFile(filePath, 'utf8', (error, rawSource) => {
-      if (error) {
-        return reject(error)
-      }
-
-      const output = processHandlebarTemplate(rawSource, substitutions)
-
-      fs.writeFile(filePath, output, (error) => {
-        if (error) {
-          return reject(error)
-        }
-        resolve()
-      })
-    })
-  })
-}
-
-/**
- * Performs a Handlebars string template substitution, and returns the
- * resulting string.
- *
- * @see https://www.npmjs.com/package/handlebars
- *
- * @param source {string} e.g. 'Hello, {{name}}'
- *
- * @return {string} Result, e.g. 'Hello, Alice'
- */
-function processHandlebarTemplate (source, substitutions) {
-  try {
-    const template = Handlebars.compile(source)
-    return template(substitutions)
-  } catch (error) {
-    debug(`Error processing template: ${error}`)
-    return source
-  }
-}
-
-async function copyTemplateDir (templatePath, targetPath) {
-  return new Promise((resolve, reject) => {
-    fs.copy(templatePath, targetPath, (error) => {
-      if (error) { return reject(error) }
-
-      resolve()
-    })
-  })
-}
-
 function serialize (graph, baseUri, contentType, callback) {
   try {
     // target, kb, base, contentType, callback