[CM2] model.match(),create() rootContext and fixes

Some ideas in this one:

Match & Create
==============

Each model has a method named 'match' which returns whether or not a
node satisfies the model's fsNode requirements. And they have a 'create'
method to turn a node into a content-model.

So, e.g., a collection calls category.match(node) in a node traversal,
and then calls category.create(node) if the former returns true.

Each model configures its matchers mostly based on the settings it
receives.

Benefits:
- Prevents the duplicaiton of functions like 'isPost', 'isPostIndexFile'
  etc.
- Models look similar in shape to each other and to root (countdown to
  class Model {})
- Post index files can now be named with the entryAlias. e.g. demo.md,
  episode.md, article.md
- Same goes for categories. Whatever alias works.

Root context
============

ContentModel2 has now a context object which is passed down throughout
the tree, just like a collection context.

Benefits:
- No more reliance on settings.out and settings.permalinkPrefix in
  models. So, permalinks and outputPaths are computed completely by a
  cascade of contexts.
- This inspires a further improvement of automating that computation by
  introducing a context depth-level. Each model would rely on the
  context that is closest to itself, without necessarily recognizing
  where it comes from. But to not complicate the templates, some magic
  should follow it either in rendering phase or in the form of template
  helpers. {{context.category.permalink}} is too tasty to give up on.
- It also means simpler/less settings for initializing models.

Some fixes
==========

- Category index
- Tags

Author: scriptype

src/compiler/contentModel2/index.js

@@ -8,48 +8,6 @@ const models = {
   asset: require('./models/asset')
 }
 
-const isHomepageFile = (node) => {
-  return isTemplateFile(node) && node.name.match(/^(homepage|home|index)\..+$/)
-}
-
-const isHomepageDirectory = (node) => {
-  return node.children && node.name.match(/^(homepage|home)$/) && node.children.find(isHomepageFile)
-}
-
-const isHomepage = (node) => {
-  return isHomepageFile(node) || isHomepageDirectory(node)
-}
-
-const isPagesDirectory = (node) => {
-  return node.children && node.name.match(/^(subpages|pages)$/)
-}
-
-const isSubpageIndexFile = (node) => {
-  return isTemplateFile(node) && node.name.match(/^(page|index)\..+$/)
-}
-
-const isSubpage = (node) => {
-  return isTemplateFile(node) || node.children?.find(isSubpageIndexFile)
-}
-
-const isCollectionIndexFile = (node) => {
-  return isTemplateFile(node) && node.name.match(/^collection\..+$/)
-}
-
-const isACollectionDirectory = (node) => {
-  return node.children?.find(isCollectionIndexFile)
-}
-
-const isAssetsDirectory = (node) => {
-  return node.children && node.name.match(/^assets$/)
-}
-
-const defaultHomepage = () => models.homepage({
-  name: 'index',
-  extension: 'md',
-  content: ''
-})
-
 const linkEntries = (contentModel) => {
   contentModel.collections.forEach(collection => {
     collection.posts.forEach(post => {
@@ -107,73 +65,84 @@ class ContentModel {
       ...contentModelSettings
     }
 
-    this.collectionSettings = _.pick(
-      this.settings,
-      ['permalinkPrefix', 'out', 'defaultCategoryName']
-    )
-    this.subpageSettings = _.pick(
-      this.settings,
-      ['permalinkPrefix', 'out', 'pagesDirectory']
-    )
-    this.homepageSettings = _.pick(
-      this.settings,
-      ['permalinkPrefix', 'out', 'homepageDirectory']
-    )
-    this.assetSettings = _.pick(
-      this.settings,
-      ['permalinkPrefix', 'out', 'assetsDirectory']
-    )
+    this.models = {
+      collection: models.collection({
+        defaultCategoryName: this.settings.defaultCategoryName
+      }),
+      subpage: models.subpage({
+        pagesDirectory: this.settings.pagesDirectory
+      }),
+      homepage: models.homepage({
+        homepageDirectory: this.settings.homepageDirectory
+      }),
+      asset: models.asset({
+        assetsDirectory: this.settings.assetsDirectory
+      })
+    }
   }
 
   create(fileSystemTree) {
+    const context = {
+      outputPath: this.settings.out,
+      permalink: this.settings.permalinkPrefix
+    }
+
     const contentModel = {
-      homepage: defaultHomepage(),
+      homepage: this.models.homepage.create({
+        name: 'index',
+        extension: 'md',
+        content: ''
+      }, { root: context }),
       subpages: [],
       collections: [],
       assets: []
     }
 
     fileSystemTree.forEach(node => {
-      if (isHomepage(node)) {
-        contentModel.homepage = models.homepage(node, this.homepageSettings)
+      if (this.models.homepage.match(node)) {
+        contentModel.homepage = this.models.homepage.create(node, { root: context })
         return
       }
 
-      if (isSubpage(node)) {
+      if (this.models.subpage.match(node)) {
         return contentModel.subpages.push(
-          models.subpage(node, this.subpageSettings)
+          this.models.subpage.create(node, { root: context })
         )
       }
 
-      if (isPagesDirectory(node)) {
+      if (this.models.subpage.matchPagesDirectory(node)) {
         return node.children.forEach(childNode => {
-          if (isSubpage(childNode)) {
+          if (this.models.subpage.match(childNode)) {
             contentModel.subpages.push(
-              models.subpage(childNode, this.subpageSettings)
+              this.models.subpage.create(childNode, { root: context })
             )
-          } else {
+          } else if (this.models.asset.match(childNode)) {
             contentModel.assets.push(
-              models.asset(childNode, this.assetSettings)
+              this.models.asset.create(childNode, { root: context })
             )
           }
         })
       }
 
-      if (isACollectionDirectory(node)) {
+      if (this.models.collection.match(node)) {
         return contentModel.collections.push(
-          models.collection(node, this.collectionSettings)
+          this.models.collection.create(node, { root: context })
         )
       }
 
-      if (isAssetsDirectory(node)) {
+      if (this.models.asset.matchAssetsDirectory(node)) {
         return contentModel.assets.push(
-          ...node.children.map(n => models.asset(n, this.assetSettings))
+          ...node.children.map(childNode => {
+            return this.models.asset.create(childNode, { root: context })
+          })
         )
       }
 
-      contentModel.assets.push(
-        models.asset(node, this.assetSettings)
-      )
+      if (this.models.asset.match(node)) {
+        return contentModel.assets.push(
+          this.models.asset.create(node, { root: context })
+        )
+      }
     })
 
     linkEntries(contentModel)

src/compiler/contentModel2/models/_baseEntry.js

@@ -22,12 +22,17 @@ function parseFolderedEntry(node, indexFileNameOptions) {
     indexFile: null,
     attachments: []
   }
+  const subModels = {
+    attachment: models.attachment()
+  }
   node.children.forEach(childNode => {
     if (isIndexFile(childNode, indexFileNameOptions)) {
       tree.indexFile = childNode
       return
     }
-    tree.attachments.push(models.attachment.bind(null, childNode))
+    if (subModels.attachment.match(childNode)) {
+      tree.attachments.push(subModels.attachment.create.bind(null, childNode))
+    }
   })
   return tree
 }

src/compiler/contentModel2/models/asset.js

@@ -1,28 +1,42 @@
 const { join, resolve } = require('path')
 
 const defaultSettings = {
-  permalinkPrefix: '/',
-  out: resolve('.'),
   assetsDirectory: 'assets'
 }
-function asset(node, settings = defaultSettings) {
-  const permalink = (
-    settings.permalinkPrefix +
-    [settings.assetsDirectory, node.name].join('/')
-  )
+module.exports = function asset(settings = defaultSettings) {
+  const assetsDirectoryNameOptions = [settings.assetsDirectory, 'assets']
 
-  const outputPath = join(
-    settings.out,
-    settings.assetsDirectory,
-    node.name
-  )
+  const isAssetsDirectory = (node) => {
+    return (
+      node.children &&
+      node.name.match(
+        new RegExp(`^(${assetsDirectoryNameOptions.join('|')})$`)
+      )
+    )
+  }
 
   return {
-    ...node,
-    permalink,
-    outputPath,
-    date: new Date(node.stats.birthtime || Date.now())
+    match: node => true,
+    matchAssetsDirectory: isAssetsDirectory,
+    create: (node, context) => {
+      const permalink = (
+        context.root.permalink +
+        [settings.assetsDirectory, node.name].join('/')
+      )
+
+      const outputPath = join(
+        context.root.outputPath,
+        settings.assetsDirectory,
+        node.name
+      )
+
+      return {
+        ...node,
+        context,
+        permalink,
+        outputPath,
+        date: new Date(node.stats.birthtime || Date.now())
+      }
+    }
   }
 }
-
-module.exports = asset

src/compiler/contentModel2/models/attachment.js

@@ -1,29 +1,32 @@
 const { join } = require('path')
 
-function attachment(node, context) {
-  const permalink = [
-    context.page?.permalink ||
-    context.post?.permalink ||
-    context.category?.permalink ||
-    context.collection?.permalink,
-    node.name
-  ].filter(Boolean).join('/')
+module.exports = function attachment() {
+  return {
+    match: node => true,
+    create(node, context) {
+      const permalink = [
+        context.page?.permalink ||
+        context.post?.permalink ||
+        context.category?.permalink ||
+        context.collection?.permalink,
+        node.name
+      ].filter(Boolean).join('/')
 
-  const outputPath = join(...[
-    context.page?.outputPath ||
-    context.post?.outputPath ||
-    context.category?.outputPath ||
-    context.collection?.outputPath,
-    node.name
-  ].filter(Boolean))
+      const outputPath = join(...[
+        context.page?.outputPath ||
+        context.post?.outputPath ||
+        context.category?.outputPath ||
+        context.collection?.outputPath,
+        node.name
+      ].filter(Boolean))
 
-  return {
-    ...node,
-    context,
-    permalink,
-    outputPath,
-    date: new Date(node.stats.birthtime || Date.now())
+      return {
+        ...node,
+        context,
+        permalink,
+        outputPath,
+        date: new Date(node.stats.birthtime || Date.now())
+      }
+    }
   }
 }
-
-module.exports = attachment