Extend collection from ContentModelNode

Calculate contentType of a collection at the top level ContentModel and
pass it down to the collection. Collection accesses it via
settings.contentType.

Fix root collection json rendering path.

Add a getSlug template method to ContentModelEntryNode. It's called
before setting permalink and outputPath. Allows outliers like collection
to implement a custom slug mechanism and let it cascade to permalink and
outputPath.

For that reason exactly, add an __originalAttributes__ field to what
parseTextEntry returns. In it, there are non-overridden values of title
and slug. So, collection can ignore auto-slugging in case slug is null
in the front-matter. That allows collection acting like root.

Implement a serialize method at the top level ContentModel class,
serialize itself before passing its tree down to model renders.

Serialize every model before passing itself to template in render.

Author: scriptype

src/compiler/contentModel/index.js

@@ -2,12 +2,13 @@ const { resolve } = require('path')
 const _ = require('lodash')
 const frontMatter = require('front-matter')
 const ImmutableStack = require('../../lib/ImmutableStack')
-const { isTemplateFile } = require('./helpers')
+const { removeExtension, isTemplateFile } = require('../../lib/contentModelHelpers')
 const createMatchers = require('./matchers')
+
 const models = {
   Homepage: require('./models/homepage'),
   Subpage: require('./models/subpage'),
-  collection: require('./models/collection'),
+  Collection: require('./models/collection'),
   Asset: require('./models/asset')
 }
 
@@ -88,7 +89,7 @@ const linkBack = (post, entry, key) => {
 
 const linkEntries = (contentModel) => {
   contentModel.collections.forEach(collection => {
-    collection.posts.forEach(post => {
+    collection.subtree.posts.forEach(post => {
       const fields = Object.keys(post)
       Object.keys(post).forEach(key => {
         const value = post[key]
@@ -141,6 +142,15 @@ const defaultContentModelSettings = {
   mode: 'start'
 }
 class ContentModel {
+  static serialize(contentModel) {
+    return {
+      homepage: models.Homepage.serialize(contentModel.homepage),
+      subpages: contentModel.subpages.map(models.Subpage.serialize),
+      collections: contentModel.collections.map(models.Collection.serialize),
+      assets: contentModel.assets.map(models.Asset.serialize)
+    }
+  }
+
   constructor(contentModelSettings = defaultContentModelSettings, contentTypes = []) {
     this.settings = {
       ...defaultContentModelSettings,
@@ -172,47 +182,35 @@ class ContentModel {
       permalink: this.settings.permalinkPrefix
     }])
 
-    this.models = {
-      collection: models.collection({
-        defaultCategoryName: this.settings.defaultCategoryName,
-        collectionAliases: [
-          ...this.contentTypes
-            .filter(ct => ct.model === 'collection')
-            .map(ct => ct.collectionAlias),
-          ...(indexProps.attributes?.collectionAliases || [])
-        ],
-        mode: this.settings.mode
-      }, this.contentTypes, this.matchers),
-
-      Subpage: models.Subpage,
-
-      Homepage: models.Homepage,
-
-      Asset: models.Asset
-    }
-
     this.contentModel = {
-      homepage: new this.models.Homepage({
-        name: 'index',
-        extension: 'md',
-        content: ''
-      }, context, { homepageDirectory: this.settings.homepageDirectory }),
+      homepage: new models.Homepage(
+        { name: 'index', extension: 'md', content: '' },
+        context,
+        { homepageDirectory: this.settings.homepageDirectory }
+      ),
       subpages: [],
       collections: [],
       assets: []
     }
 
+    this.collectionAliases = [
+      ...this.contentTypes
+      .filter(ct => ct.model === 'collection')
+      .map(ct => ct.collectionAlias),
+      ...(indexProps.attributes?.collectionAliases || [])
+    ]
+
     fileSystemTree.forEach(node => {
       if (this.matchers.homepage(node)) {
-        this.contentModel.homepage = new this.models.Homepage(node, context, {
+        this.contentModel.homepage = new models.Homepage(node, context, {
           homepageDirectory: this.settings.homepageDirectory
         })
         return
       }
 
       if (this.matchers.subpage(node)) {
         return this.contentModel.subpages.push(
-          new this.models.Subpage(node, context, {
+          new models.Subpage(node, context, {
             pagesDirectory: this.settings.pagesDirectory
           })
         )
@@ -222,22 +220,39 @@ class ContentModel {
         return node.children.forEach(childNode => {
           if (this.matchers.subpage(childNode)) {
             this.contentModel.subpages.push(
-              new this.models.subpage(childNode, context, {
+              new models.subpage(childNode, context, {
                 pagesDirectory: this.settings.pagesDirectory
               })
             )
           } else if (this.matchers.asset(childNode)) {
             this.contentModel.assets.push(
-              new this.models.Asset(childNode, context, {
+              new models.Asset(childNode, context, {
                 assetsDirectory: this.settings.assetsDirectory
               })
             )
           }
         })
       }
 
-      if (this.models.collection.match(node)) {
-        const collection = this.models.collection.create(node, context)
+      if (this.matchers.collection(node, this.collectionAliases)) {
+        const indexFile = node.children.find(
+          this.matchers.collectionIndexFile(this.collectionAliases)
+        )
+
+        const contentType = this.contentTypes
+          .filter(ct => ct.model === 'collection')
+          .find(ct => {
+            return ct.collectionAlias === (indexFile ? removeExtension(indexFile.name) : node.name)
+          })
+
+        const collection = new models.Collection(node, context, {
+          defaultCategoryName: this.settings.defaultCategoryName,
+          collectionAliases: this.collectionAliases,
+          mode: this.settings.mode,
+          contentTypes: this.contentTypes,
+          contentType
+        })
+
         if (this.draftCheck(collection)) {
           this.contentModel.collections.push(collection)
         }
@@ -247,7 +262,7 @@ class ContentModel {
       if (this.matchers.assetsDirectory(node)) {
         return this.contentModel.assets.push(
           ...node.children.map(childNode => {
-            return new this.models.Asset(childNode, context, {
+            return new models.Asset(childNode, context, {
               assetsDirectory: this.settings.assetsDirectory
             })
           })
@@ -256,7 +271,7 @@ class ContentModel {
 
       if (this.matchers.asset(node)) {
         return this.contentModel.assets.push(
-          new this.models.Asset(node, context, {
+          new models.Asset(node, context, {
             assetsDirectory: this.settings.assetsDirectory
           })
         )
@@ -271,7 +286,7 @@ class ContentModel {
     linkEntries(this.contentModel)
 
     this.contentModel.collections.forEach(collection => {
-      this.models.collection.afterEffects(this.contentModel, collection)
+      collection.afterEffects(this.contentModel)
     })
 
     this.contentModel.subpages.forEach(subpage => {
@@ -288,7 +303,7 @@ class ContentModel {
   render(renderer) {
     const renderHomepage = () => {
       return this.contentModel.homepage.render(renderer, {
-        contentModel: this.contentModel,
+        contentModel: ContentModel.serialize(this.contentModel),
         settings: this.settings,
         debug: this.settings.debug
       })
@@ -297,8 +312,8 @@ class ContentModel {
     const renderCollections = () => {
       return Promise.all(
         this.contentModel.collections.map(collection => {
-          return this.models.collection.render( renderer, collection, {
-            contentModel: this.contentModel,
+          return collection.render(renderer, {
+            contentModel: ContentModel.serialize(this.contentModel),
             settings: this.settings,
             debug: this.settings.debug
           })
@@ -310,7 +325,7 @@ class ContentModel {
       return Promise.all(
         this.contentModel.subpages.map(subpage => {
           return subpage.render(renderer, {
-            contentModel: this.contentModel,
+            contentModel: ContentModel.serialize(this.contentModel),
             settings: this.settings,
             debug: this.settings.debug
           })

src/compiler/contentModel/matchers.js

@@ -26,7 +26,25 @@ module.exports = function createMatchers(settings) {
       return matchers.homepageFile(fsNode) || matchers.homepageDirectory(fsNode)
     },
 
-    collection: fsNode => {},
+    collectionIndexFile: (collectionAliases) => (fsNode) => {
+      const indexFileNameOptions = [ ...collectionAliases, 'collection' ].filter(Boolean)
+
+      return isTemplateFile(fsNode) && fsNode.name.match(
+        new RegExp(`^(${indexFileNameOptions.join('|')})\\..+$`)
+      )
+    },
+
+    collectionDataFile: (fsNode, parentNode) => {
+      return fsNode.name.match(new RegExp(`^${parentNode.name}\\.json$`, 'i'))
+    },
+
+    collection: (fsNode, collectionAliases) => {
+      const hasCollectionIndex = fsNode.children?.find(matchers.collectionIndexFile(collectionAliases))
+      const hasCollectionData = fsNode.children?.find(childNode => {
+        return matchers.collectionDataFile(childNode, fsNode)
+      })
+      return hasCollectionIndex || hasCollectionData
+    },
 
     category: (fsNode) => {
       fsNode.children?.find(childNode => {

src/compiler/contentModel/models/asset.js

@@ -6,6 +6,10 @@ const defaultSettings = {
   assetsDirectory: 'assets'
 }
 class Asset extends ContentModelResourceNode {
+  static serialize(asset) {
+    return asset
+  }
+
   constructor(fsNode, context, settings = defaultSettings) {
     super(fsNode, context, settings)
   }

src/compiler/contentModel/models/attachment.js

@@ -1,6 +1,10 @@
 const ContentModelResourceNode = require('../../../lib/ContentModelResourceNode')
 
 class Attachment extends ContentModelResourceNode {
+  static serialize(attachment) {
+    return attachment
+  }
+
   constructor(fsNode, context) {
     super(fsNode, context)
   }

src/compiler/contentModel/models/collection/category.js

@@ -40,10 +40,10 @@ class Category extends ContentModelEntryNode {
     const data = {
       ...category,
       facets: category.facets.map(models.facet().serialize),
-      posts: category.subtree.posts,
-      levelPosts: category.subtree.levelPosts,
-      categories: category.subtree.categories,
-      attachments: category.subtree.attachments
+      posts: category.subtree.posts.map(models.Post.serialize),
+      levelPosts: category.subtree.levelPosts.map(models.Post.serialize),
+      categories: category.subtree.categories.map(Category.serialize),
+      attachments: category.subtree.attachments.map(models.Attachment.serialize)
     }
 
     if (entriesAlias) {