Trying to make code more readable

And by that hopefully more maintainable

Author: megoth

bin/lib/common.js bin/lib/cli-utils.jsbin/lib/common.js renamed to bin/lib/cli-utils.js

@@ -2,7 +2,7 @@ const fs = require('fs-extra')
 const Handlebars = require('handlebars')
 const path = require('path')
 
-const { getAccountManager, loadConfig, loadUsernames } = require('./common')
+const { getAccountManager, loadConfig, loadUsernames } = require('./cli-utils')
 const { isValidUsername } = require('../../lib/common/user-utils')
 const blacklistService = require('../../lib/services/blacklist-service')
 const { initConfigDir, initTemplateDirs } = require('../../lib/server-config')

bin/lib/invalidUsernames.js

@@ -2,7 +2,7 @@
 
 const options = require('./options')
 const fs = require('fs')
-const { loadConfig } = require('./common')
+const { loadConfig } = require('./cli-utils')
 const { red, bold } = require('colorette')
 
 module.exports = function (program, server) {

bin/lib/start.js

@@ -1,53 +1,50 @@
 const fs = require('fs')
 const path = require('path')
 const cheerio = require('cheerio')
-const Handlebars = require('handlebars')
 const LDP = require('../../lib/ldp')
-const $rdf = require('rdflib')
 const { URL } = require('url')
 
-const { getAccountManager, loadConfig, loadUsernames } = require('./common')
+const { compileTemplate, writeTemplate } = require('../../lib/common/template-utils')
+const { getAccountManager, loadConfig, loadUsernames } = require('./cli-utils')
+const { getWebId } = require('../../lib/common/user-utils')
 const { initConfigDir, initTemplateDirs } = require('../../lib/server-config')
 
-const SOLID = $rdf.Namespace('http://www.w3.org/ns/solid/terms#')
-
 module.exports = function (program) {
   program
     .command('updateindex')
     .description('Update index.html in root of all PODs that haven\'t been marked otherwise')
     .action(async (options) => {
       const config = loadConfig(program, options)
-      const ldp = new LDP(config)
       const configPath = initConfigDir(config)
       const templates = initTemplateDirs(configPath)
+      const indexTemplatePath = path.join(templates.account, 'index.html')
+      const indexTemplate = await compileTemplate(indexTemplatePath)
+      const ldp = new LDP(config)
       const accountManager = getAccountManager(config, { ldp })
       const usernames = loadUsernames(config)
-      const indexTemplatePath = path.join(templates.account, 'index.html')
-      const indexTemplateSource = fs.readFileSync(indexTemplatePath, 'utf-8')
-      const indexTemplate = Handlebars.compile(indexTemplateSource)
       const usersProcessed = usernames.map(async name => {
-        const userDirectory = accountManager.accountDirFor(name)
-        const indexFilePath = path.join(userDirectory, 'index.html')
-        const indexSource = fs.readFileSync(indexFilePath, 'utf-8')
-        const $ = cheerio.load(indexSource)
-        const allowAutomaticUpdateValue = $('meta[name="solid-allow-automatic-updates"]').prop('content')
-        const allowAutomaticUpdate = !allowAutomaticUpdateValue || allowAutomaticUpdateValue === 'true'
-        if (!allowAutomaticUpdate) {
+        const accountDirectory = accountManager.accountDirFor(name)
+        const indexFilePath = path.join(accountDirectory, 'index.html')
+        if (!isUpdateAllowed(indexFilePath)) {
           return
         }
-        const serverUrl = new URL(config.serverUri)
-        const accountUrl = `${serverUrl.protocol}//${name}.${serverUrl.host}/`
-        const metaFileUri = `${accountUrl}/${ldp.suffixMeta}`
-        const metaData = await ldp.readContainerMeta(userDirectory)
-        const metaGraph = $rdf.graph()
-        $rdf.parse(metaData, metaGraph, metaFileUri, 'text/turtle')
-        const webIdNode = metaGraph.any(undefined, SOLID('account'), $rdf.sym(accountUrl))
-        const webId = webIdNode.value
-        const newIndexSource = indexTemplate({ name, webId })
-        fs.writeFileSync(indexFilePath, newIndexSource, 'utf-8')
+        const accountUrl = getAccountUrl(name, config)
+        const webId = await getWebId(accountDirectory, accountUrl, { ldp })
+        writeTemplate(indexFilePath, indexTemplate, { name, webId })
       })
       await Promise.all(usersProcessed)
       console.log(`Processed ${usersProcessed.length} users`)
     })
 }
 
+function getAccountUrl (name, config) {
+  const serverUrl = new URL(config.serverUri)
+  return `${serverUrl.protocol}//${name}.${serverUrl.host}/`
+}
+
+function isUpdateAllowed (indexFilePath) {
+  const indexSource = fs.readFileSync(indexFilePath, 'utf-8')
+  const $ = cheerio.load(indexSource)
+  const allowAutomaticUpdateValue = $('meta[name="solid-allow-automatic-updates"]').prop('content')
+  return !allowAutomaticUpdateValue || allowAutomaticUpdateValue === 'true'
+}

bin/lib/updateIndex.js

@@ -3,6 +3,8 @@
 <head>
   <meta charset="utf-8">
   <meta name="viewport" content="width=device-width, initial-scale=1">
+  <!-- Set content in the next line to false if you do not want your homepage to be automatically updated whenever a new version becomes available. -->
+  <meta name="solid-allow-automatic-updates" content="true">
   <title>{{#if name}}{{name}} &ndash; {{/if}}Solid Home</title>
   <link rel="stylesheet" href="/common/css/bootstrap.min.css">
   <link rel="stylesheet" href="/common/css/solid.css">

default-templates/new-account/index.html

@@ -1,5 +1,7 @@
 module.exports.copyTemplateDir = copyTemplateDir
 module.exports.processFile = processFile
+module.exports.readFile = readFile
+module.exports.writeFile = writeFile
 
 const fs = require('fs-extra')
 
@@ -31,3 +33,11 @@ async function processFile (filePath, manipulateSourceFn) {
     })
   })
 }
+
+function readFile (filePath, options = 'utf-8') {
+  return fs.readFileSync(filePath, options)
+}
+
+function writeFile (filePath, fileSource, options = 'utf-8') {
+  fs.writeFileSync(filePath, fileSource, options)
+}

lib/common/fs-utils.js

@@ -1,8 +1,15 @@
+module.exports.compileTemplate = compileTemplate
 module.exports.processHandlebarFile = processHandlebarFile
+module.exports.writeTemplate = writeTemplate
 
 const Handlebars = require('handlebars')
 const debug = require('../debug').errors
-const { processFile } = require('./fs-utils')
+const { processFile, readFile, writeFile } = require('./fs-utils')
+
+async function compileTemplate (filePath) {
+  const indexTemplateSource = readFile(filePath)
+  return Handlebars.compile(indexTemplateSource)
+}
 
 /**
  * Reads a file, processes it (performing template substitution), and saves
@@ -14,25 +21,18 @@ const { processFile } = require('./fs-utils')
  * @return {Promise}
  */
 async function processHandlebarFile (filePath, substitutions) {
-  return processFile(filePath, (rawSource) => processHandlebarTemplate(rawSource, substitutions))
+  return processFile(filePath, (rawSource) => {
+    try {
+      const template = Handlebars.compile(rawSource)
+      return template(substitutions)
+    } catch (error) {
+      debug(`Error processing template: ${error}`)
+      return rawSource
+    }
+  })
 }
 
-/**
- * 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
-  }
+function writeTemplate (filePath, template, substitutions) {
+  const source = template(substitutions)
+  writeFile(filePath, source)
 }

lib/common/template-utils.js

@@ -1,5 +1,25 @@
+const $rdf = require('rdflib')
+
+const LDP = require('../ldp')
+
+const SOLID = $rdf.Namespace('http://www.w3.org/ns/solid/terms#')
+
+module.exports.getWebId = getWebId
 module.exports.isValidUsername = isValidUsername
 
+async function getWebId (accountDirectory, accountUrl, options = {}) {
+  if (!options.ldp && !options.config) {
+    throw new Error('Require ldp or config set in options for getWebId')
+  }
+  const ldp = options.ldp || new LDP(options.config)
+  const metaFileUri = `${accountUrl}/${ldp.suffixMeta}`
+  const metaData = await ldp.readContainerMeta(accountDirectory)
+  const metaGraph = $rdf.graph()
+  $rdf.parse(metaData, metaGraph, metaFileUri, 'text/turtle')
+  const webIdNode = metaGraph.any(undefined, SOLID('account'), $rdf.sym(accountUrl))
+  return webIdNode.value
+}
+
 function isValidUsername (username) {
   return /^[a-z0-9]+(?:-[a-z0-9]+)*$/.test(username)
 }