Implement: Homepage can be a folder with assets

- Add few tests for raw html homepage - both root and foldered

Author: scriptype

src/compiler/contentModel/fsToContent.js

@@ -4,7 +4,12 @@ const Dictionary = require('../../dictionary')
 const { last } = require('../../helpers')
 const { createLocalAsset } = require('./models/localAsset')
 const { createAssets } = require('./models/asset')
-const { createHomepage } = require('./models/homepage')
+
+const {
+  createHomepage,
+  createFolderedHomepage,
+  createFolderedHomepageIndex
+} = require('./models/homepage')
 
 const {
   createCategory,
@@ -54,6 +59,12 @@ const isHomepageFile = (fsObject) => {
   return isTemplateFile(fsObject) && fsObject.name.match(/^(homepage|home|index)\..+$/)
 }
 
+const isHomepageDirectory = (fsObject) => {
+  const { homepageDirectory } = Settings.getSettings()
+  const pattern = new RegExp(`^(${homepageDirectory}|homepage|home)$`)
+  return fsObject.name.match(pattern)
+}
+
 const newEntry = ({
   contentModel,
   key,
@@ -126,6 +137,31 @@ const withHomepage = (contentModel, fsObject) => {
   })
 }
 
+const withFolderedHomepage = (contentModel, fsObject) => {
+  return newEntry({
+    contentModel,
+    key: 'homepage',
+    entryFn: () => {
+      const homepage = createFolderedHomepage({
+        ...fsObject,
+        children: fsObject.children.map(mapFolderedHomepageTree)
+      })
+      return homepage.data
+    },
+    replace: true
+  })
+}
+
+const mapFolderedHomepageTree = (fsObject) => {
+  if (isHomepageFile(fsObject)) {
+    return createFolderedHomepageIndex(fsObject)
+  }
+  return createLocalAsset({
+    ...fsObject,
+    isFolder: !!fsObject.children
+  })
+}
+
 const withSubpages = (contentModel, fsObject) => {
   return newEntry({
     contentModel,
@@ -276,6 +312,9 @@ const createContentModel = (fsTree) => {
     if (!fsObject.children) {
       return withLocalAsset(contentModel, fsObject)
     }
+    if (isHomepageDirectory(fsObject)) {
+      return withFolderedHomepage(contentModel, fsObject)
+    }
     if (fsObject.name === pagesDirectory) {
       return withSubpages(contentModel, fsObject)
     }
@@ -293,7 +332,7 @@ const createContentModel = (fsTree) => {
     subpages: [],
     categories: [],
     posts: [],
-    homepage: createHomepage().data,
+    homepage: createHomepage({}).data,
     localAssets: [],
     tags: []
   })

src/compiler/contentModel/models/homepage.js

@@ -1,30 +1,65 @@
+const _ = require('lodash')
 const Settings = require('../../../settings')
 const contentTypes = require('../contentTypes')
 const parseTemplate = require('../parseTemplate')
+const { isLocalAsset } = require('./localAsset')
+
+const isFolderedHomepageIndex = (fsObject) => {
+  return fsObject.type === contentTypes.FOLDERED_HOMEPAGE_INDEX
+}
+
+const _createHomepage = (fsObject, { foldered }) => {
+  const indexFile = foldered ?
+    fsObject.children.find(isFolderedHomepageIndex) :
+    fsObject
+
+  const localAssets = foldered ?
+    fsObject.children.filter(isLocalAsset) :
+    []
 
-const createHomepage = (fsObject = {}) => {
   const permalink = Settings.getSettings().permalinkPrefix
 
-  const metadata = fsObject ?
-    parseTemplate(fsObject, { permalink }) :
-    { attributes: {} }
+  const metadata = parseTemplate(indexFile, {
+    permalink,
+    localAssets
+  })
 
-  const type = fsObject.extension === '.html' ? 'raw-index-html' : 'basic'
+  const type = indexFile.extension === '.html' ? 'raw-index-html' : 'basic'
 
   return {
-    ...(fsObject || {}),
+    ..._.omit(fsObject, 'children'),
     type: contentTypes.HOMEPAGE,
     data: {
       type: metadata.type || type,
       title: metadata.title || '',
       content: metadata.content || '',
       mentions: metadata.mentions || [],
       ...metadata.attributes,
+      foldered,
+      localAssets,
       permalink
     }
   }
 }
 
+const createFolderedHomepageIndex = (fsObject) => {
+  return {
+    ...fsObject,
+    type: contentTypes.FOLDERED_HOMEPAGE_INDEX
+  }
+}
+
+const createHomepage = (fsObject) => {
+  return _createHomepage(fsObject, { foldered: false })
+}
+
+const createFolderedHomepage = (fsObject) => {
+  return _createHomepage(fsObject, { foldered: true })
+}
+
 module.exports = {
-  createHomepage
+  createHomepage,
+  createFolderedHomepage,
+  isFolderedHomepageIndex,
+  createFolderedHomepageIndex
 }

src/compiler/rendering/views/local-assets.js

@@ -28,7 +28,7 @@ const copyAsset = async ({ basePath, destPath, path, name, isFolder }) => {
   }
 }
 
-const copyLocalAssets = async ({ localAssets, posts, subpages, categories }) => {
+const copyLocalAssets = async ({ localAssets, homepage, posts, subpages, categories }) => {
   const { rootDirectory, contentDirectory, pagesDirectory } = Settings.getSettings()
   const basePath = await contentRoot(rootDirectory, contentDirectory)
 
@@ -38,6 +38,16 @@ const copyLocalAssets = async ({ localAssets, posts, subpages, categories }) =>
       .map(copyAsset)
   )
 
+  const copyHomepageAssets = all(
+    (homepage.localAssets || []).map((localAsset) => {
+      const assetWithBasePath = withBasePath(basePath)(localAsset)
+      return copyAsset({
+        ...assetWithBasePath,
+        destPath: '.'
+      })
+    })
+  )
+
   const copyCategoryAssets = all(
     categories.map(({ localAssets }) => {
       return all(
@@ -74,6 +84,7 @@ const copyLocalAssets = async ({ localAssets, posts, subpages, categories }) =>
 
   return all([
     copyRootAssets,
+    copyHomepageAssets,
     copyCategoryAssets,
     copyPostAssets,
     copySubpageAssets

src/settings.js

@@ -13,6 +13,7 @@ const defaultSettings = (rootDirectory) => ({
   permalinkPrefix: "/",
   assetsDirectory: "assets",
   exportDirectory: "docs",
+  homepageDirectory: "homepage",
   pagesDirectory: "pages",
   themeDirectory: "theme",
   contentDirectory: "content",

src/tests/programmatic.js

@@ -129,6 +129,63 @@ test('post files in a category', async t => {
   hasPaths(t, categoryDir, compiledPostNames)
 })
 
+test('homepage', async t => {
+  const { exportDirectory, homepageDirectory } = writ.getDefaultSettings()
+
+  const dir = await createTempDir(t)
+  const rawHTMLHomepageContent = 'raw html homepage'
+  await dir.mkFile('index.html', rawHTMLHomepageContent)
+
+  await writ.build({
+    rootDirectory: dir.name
+  })
+
+  await common.builds(t, dir.name, {
+    rootDirectoryPaths: {
+      exists: ['index.html']
+    },
+    exportDirectoryPaths: {
+      exists: ['index.html']
+    }
+  })
+
+  const actualRawHTMLOutputContent = await readFile(join(dir.name, exportDirectory, 'index.html'), { encoding: 'utf-8' })
+  const expectedRawHTMLOutputContent = new RegExp(`^${rawHTMLHomepageContent}$`, 's')
+  t.match(
+    actualRawHTMLOutputContent,
+    expectedRawHTMLOutputContent,
+    "When homepage file has .html extension, it's treated as raw HTML"
+  )
+
+  await rm(join(dir.name, 'index.html'))
+
+  const folderedHomepageContent = 'I am foldered homepage'
+  await dir.mkDir(homepageDirectory)
+  await dir.mkFile(join(homepageDirectory, 'index.html'), folderedHomepageContent)
+
+  await writ.build({
+    rootDirectory: dir.name
+  })
+
+  await common.builds(t, dir.name, {
+    rootDirectoryPaths: {
+      exists: [homepageDirectory]
+    },
+    exportDirectoryPaths: {
+      notExists: [homepageDirectory],
+      exists: ['index.html']
+    }
+  })
+
+  const actualFolderedOutputContent = await readFile(join(dir.name, exportDirectory, 'index.html'), { encoding: 'utf-8' })
+  const expectedFolderedOutputContent = new RegExp(`^${folderedHomepageContent}$`, 's')
+  t.match(
+    actualFolderedOutputContent,
+    expectedFolderedOutputContent,
+    'Using a homepage folder works'
+  )
+})
+
 test('subpages', async t => {
   const dir = await createTempDir(t)