votive 0.2.0 → 0.3.0

package/tests/index.js

@@ -13,84 +13,21 @@ import { checkFile } from "./../lib/utils/index.js"
 
 process.chdir("./tests")
 
-test("database creation in memory", (t) => {
-  const database = votive.createDatabase(":memory:")
-
-  t.test("database functions", () => {
-    const databaseKeys = new Set(Object.keys(database))
-    const expectedKeys = new Set(["saveDB", "source", "setting", "dependency", "target", "url"])
-    const difference = databaseKeys.difference(expectedKeys)
-    assert(difference.size === 0)
-  })
-
-  t.test("create sources", () => {
-    database.source.create("abc.in", "abc.out", 1)
-    database.source.create("def.in", "def.out", 2)
-    const sources = database.source.getAll()
-    assert(sources.length === 2)
-  })
-
-  t.test("create targets", () => {
-    database.target.create({
-      path: "abc.out",
-      abstract: ["abc"],
-      metadata: {
-        color: "blue",
-      }
-    })
-
-    database.target.create({
-      path: "def.out",
-      abstract: ["def"],
-      metadata: {
-        color: "red",
-      }
-    })
-
-    const targets = database.target.getAll()
-
-    assert(targets.length === 2)
-  })
-})
-
-test("bundle", async () => {
-  const tempDest = fs.mkdtempDisposableSync("target-")
+test("empty directory", async () => {
+  const tempDest = fs.mkdtempDisposableSync("destination-")
   const tempSource = fs.mkdtempDisposableSync("source-")
 
-  fs.writeFileSync(
-    path.join(tempSource.path, "abc.in"),
-    JSON.stringify({ abstract: ["abc"], metadata: { color: "blue" } }),
-    "utf-8"
-  )
-
   try {
-    const stop = stopwatch("Bundle folder")
-    const database = await votive.bundle({
+    const stop = stopwatch("Bundle empty folder")
+    await votive.bundle({
       sourceFolder: tempSource.path,
       destinationFolder: tempDest.path,
-      plugins: [{
-        name: "test-plugin",
-        processors: [{
-          format: "text",
-          extensions: [".in"],
-          // readResource: null,
-          writeFile: (destination) => ({ data: destination.abstract[0] }),
-          readFile: (data) => ({ abstract: [data], metadata: { color: "green" } }),
-          // readFolder: null,
-          // transformFile: null
-        }],
-        router: ({ base, dir, root }) => ({ base, root, ext: ".out" }),
-      }]
-
+      plugins: []
     })
 
-    const sources = database.source.getAll()
-
-    const targets = database.target.getAll()
-
     stop()
 
-    const dir = fs.readdirSync(tempDest.path, { recursive: true })
+    const dir = fs.readdirSync(tempDest.path)
     assert(dir.length === 0, "Destination directory is not empty.")
   } catch (error) {
     tempDest.remove()
@@ -103,275 +40,281 @@ test("bundle", async () => {
   tempSource.remove()
 })
 
-// test("internals", async (t) => {
-//   const dbExists = checkFile(".votive.db")
-//   if (dbExists) await rm(".votive.db")
-
-//   const temp = fs.mkdtempDisposableSync("destination-")
-
-//   /** @returns {Job} */
-//   function createExampleJob() {
-//     return {
-//       data: Math.floor(Math.random() * 1000),
-//       runner: "exampleRunner"
-//     }
-//   }
-
-
-//   /** @type {ReadText} */
-//   function exampleTextReader(text, filePath, destinationPath, database, config) {
-//     const matches = text.match(/\b\w+\b/)
-//     const title = matches ? matches[0] : "Untitled"
-
-//     /** @type {ReadTextResult} */
-//     return {
-//       abstract: {
-//         content: text,
-//       },
-//       metadata: {
-//         title
-//       },
-//       jobs: [
-//         createExampleJob()
-//       ]
-//     }
-//   }
-
-//   /** @type {ReadAbstract} */
-//   function exampleAbstractReader(abstract, database, config) {
-//     abstract.exampleAppend = true
-//     return { abstract, jobs: [createExampleJob()] }
-//   }
-
-//   /** @type {ReadFolder} */
-//   function exampleFolderReader(folder, database, config) {
-//     return {
-//       jobs: [createExampleJob()],
-//       destinations: [
-//         {
-//           path: "index.html",
-//           abstract: { content: "" },
-//           metadata: {
-//             title: "home"
-//           },
-//           syntax: "md"
-//         }
-//       ]
-//     }
-//   }
-
-//   /** @type {VotiveProcessor} */
-//   const exampleProcessor = {
-//     syntax: "md",
-//     filter: {
-//       extensions: [".md"]
-//     },
-//     read: {
-//       text: exampleTextReader,
-//       abstract: exampleAbstractReader,
-//       folder: exampleFolderReader
-//     },
-//     write: (destination, database, config) => {
-//       return {
-//         data: "lorem ipsum",
-//       }
-//     }
-//   }
-
-//   /** @param {string} sourcePath */
-//   function router({ base, ...parsed }) {
-//     return { ...parsed, ext: ".html" }
-//   }
-
-//   /** @type {VotivePlugin} */
-//   const examplePlugin = {
-//     name: "example plugin",
-//     runners: {
-//       exampleRunner: exampleRunner
-//     },
-//     router,
-//     processors: [exampleProcessor]
-//   }
-
-//   /** @type {Runner} */
-//   async function exampleRunner(data, database) {
-//     return await new Promise((resolve) => setTimeout(() => resolve(data), 1))
-//   }
-
-//   /** @type {VotiveConfig} */
-//   const config = {
-//     sourceFolder: "./markdown",
-//     destinationFolder: temp.path,
-//     plugins: [examplePlugin]
-//   }
-
-//   /** @type {FlatProcessors} */
-//   const processors = [
-//     {
-//       plugin: examplePlugin,
-//       processor: exampleProcessor
-//     }
-//   ]
-
-//   try {
-//     fs.writeFileSync("markdown/prunee.md", "A little content")
-
-//     const database = votive.createDatabase()
-//     const sourcesOne = database.getAllSources()
-
-//     t.test("no sources on startup", () => {
-//       const isArray = Array.isArray(sourcesOne)
-//       const isEmpty = !sourcesOne.length
-//       assert(isArray && isEmpty)
-//     })
-
-
-
-//     const stop = stopwatch("Read sources")
-
-//     const { folders, sources } = await votive.readSources(config, database, processors)
-
-//     t.test('one folder exists', () => {
-//       assert(folders.length === 1)
-//     })
-
-//     t.test('three sources exist', () => {
-//       assert(sources.length === 4)
-//     })
-
-//     stop()
-
-//     const sourcesJobs = sources.flatMap(source => source.jobs)
+test("internals", async (t) => {
+  const dbExists = checkFile(".votive.db")
+  if (dbExists) await rm(".votive.db")
+
+  const temp = fs.mkdtempDisposableSync("destination-")
+
+  /** @returns {Job} */
+  function createExampleJob() {
+    return {
+      data: Math.floor(Math.random() * 1000),
+      runner: "exampleRunner"
+    }
+  }
+
+
+  /** @type {ReadText} */
+  function exampleTextReader(text, filePath, database, config) {
+    const matches = text.match(/\b\w+\b/)
+    const title = matches ? matches[0] : "Untitled"
+
+    /** @type {ReadTextResult} */
+    return {
+      abstract: {
+        content: text,
+      },
+      metadata: {
+        title
+      },
+      jobs: [
+        createExampleJob()
+      ]
+    }
+  }
+
+  /** @type {ReadAbstract} */
+  function exampleAbstractReader(abstract, database, config) {
+    abstract.exampleAppend = true
+    return { abstract, jobs: [createExampleJob()] }
+  }
+
+  /** @type {ReadFolder} */
+  function exampleFolderReader(folder, database, config) {
+    return {
+      jobs: [createExampleJob()],
+      destinations: [
+        {
+          path: "/index.html",
+          abstract: { content: "" },
+          metadata: {
+            title: "home"
+          },
+          syntax: "md"
+        }
+      ]
+    }
+  }
+
+  /** @type {VotiveProcessor} */
+  const exampleProcessor = {
+    syntax: "md",
+    filter: {
+      extensions: [".md"]
+    },
+    read: {
+      text: exampleTextReader,
+      abstract: exampleAbstractReader,
+      folder: exampleFolderReader
+    },
+    write: (destination, database, config) => {
+      return {
+        data: "lorem ipsum",
+      }
+    }
+  }
+
+  /** @param {string} sourcePath */
+  function router(sourcePath) {
+    const { base, ...parsed }= path.parse(sourcePath)
+    return path.format({ ...parsed, ext: ".html" })
+  }
+
+  /** @type {VotivePlugin} */
+  const examplePlugin = {
+    name: "example plugin",
+    runners: {
+      exampleRunner: exampleRunner
+    },
+    router,
+    processors: [exampleProcessor]
+  }
+
+  /** @type {Runner} */
+  async function exampleRunner(data, database) {
+    return await new Promise((resolve) => setTimeout(() => resolve(data), 1))
+  }
+
+  /** @type {VotiveConfig} */
+  const config = {
+    sourceFolder: "./markdown",
+    destinationFolder: temp.path,
+    plugins: [examplePlugin]
+  }
 
-//     const { processedAbstracts, abstractsJobs } = votive.readAbstracts(sources, config, database, processors)
-
-//     t.test('transformation succeeded', () => {
-//       assert(processedAbstracts.find(abstract => abstract.exampleAppend))
-//     })
+  /** @type {FlatProcessors} */
+  const processors = [
+    {
+      plugin: examplePlugin,
+      processor: exampleProcessor
+    }
+  ]
 
-//     t.test('abstract jobs exist', () => {
-//       assert(abstractsJobs.length > 0)
-//       assert(abstractsJobs.every(job => job.data && job.runner))
-//     })
+  try {
+    fs.writeFileSync("markdown/prunee.md", "A little content")
 
-//     const foldersJobs = readFolders(folders, config, database, processors)
+    const database = votive.createDatabase()
+    const sourcesOne = database.getAllSources()
 
-//     t.test("folders jobs exist", () => {
-//       assert(foldersJobs.length > 0)
-//       assert(foldersJobs.every(job => job.data && job.runner))
-//     })
+    t.test("no sources on startup", () => {
+      const isArray = Array.isArray(sourcesOne)
+      const isEmpty = !sourcesOne.length
+      assert(isArray && isEmpty)
+    })
 
-//     database.createOrUpdateDestination({ metadata: { a: 1, b: 2 }, path: "abc.html", abstract: { c: 3 }, syntax: "md" })
-//     const firstDestination = database.getDestinationIndependently("abc.html", [])
 
-//     t.test('first destination created', () => {
-//       assert(firstDestination.path === 'abc.html')
-//     })
 
-//     database.createOrUpdateDestination({ metadata: { a: 3, b: 4 }, path: "abc/def.html", abstract: { c: 5 }, syntax: "md" })
+    const stop = stopwatch("Read sources")
 
-//     /* TODO: Test that dependencies are working */
+    const { folders, sources } = await votive.readSources(config, database, processors)
 
-//     const setting = database.setSetting("abc.html", "theme", "blue", "markdown/prunee.md")
-//     const newSetting = database.setSetting("abc", "category", "Dog", "markdown/prunee.md")
-//     const sameSetting = database.setSetting("abc", "category", "Dog", "markdown/prunee.md")
-//     const folderSetting = database.setSetting("abc", "theme", "red", "markdown/prunee.md")
+    t.test('one folder exists', () => {
+      assert(folders.length === 1)
+    })
 
-//     t.test('settings created', () => {
-//       assert(setting.value === 'blue')
-//       assert(newSetting.value === 'Dog')
-//       assert(!sameSetting)
-//     })
+    t.test('three sources exist', () => {
+      assert(sources.length === 4)
+    })
 
-//     const abcSettings = database.getSettings("abc.html")
+    stop()
 
-//     t.test('settings retrieved', () => {
-//       assert(abcSettings.theme[0] === "blue")
-//     })
+    const sourcesJobs = sources.flatMap(source => source.jobs)
 
-//     const descendentSetting = database.setSetting("abc/def.html", "theme", "green", "abc.md")
-//     const defSettings = database.getSettings("abc/def.html")
+    const { processedAbstracts, abstractsJobs } = votive.readAbstracts(sources, config, database, processors)
 
-//     t.test('settings retrieved', () => {
-//       assert(abcSettings.theme[0] === "blue")
-//       assert(defSettings.theme[1] === "green")
-//     })
+    t.test('transformation succeeded', () => {
+      assert(processedAbstracts.find(abstract => abstract.exampleAppend))
+    })
 
-//     const staleDestinations = database.getStaleDestinations()
+    t.test('abstract jobs exist', () => {
+      assert(abstractsJobs.length > 0)
+      assert(abstractsJobs.every(job => job.data && job.runner))
+    })
 
-//     t.test('all destinations are stale', () => {
-//       assert(staleDestinations.length === 7)
-//     })
+    const foldersJobs = readFolders(folders, config, database, processors)
 
-//     const written = await votive.writeDestinations(config, database)
+    t.test("folders jobs exist", () => {
+      assert(foldersJobs.length > 0)
+      assert(foldersJobs.every(job => job.data && job.runner))
+    })
 
-//     const staleDestinationsAfterWriting = database.getStaleDestinations()
+    database.createOrUpdateDestination({ metadata: { a: 1, b: 2 }, path: "abc.html", abstract: { c: 3 }, syntax: "md" })
+    const firstDestination = database.getDestinationIndependently("abc.html", [])
 
-//     t.test('all destinations are fresh', () => {
-//       assert(staleDestinationsAfterWriting.length === 0)
-//     })
+    t.test('first destination created', () => {
+      assert(firstDestination.path === 'abc.html')
+    })
 
-//     const updated = database.createOrUpdateDestination({ metadata: { a: 1, b: 9 }, path: "abc.html", abstract: { c: 4 }, syntax: "md" })
-//     const staleAfterAbstractUpdate = database.getStaleDestinations()
+    database.createOrUpdateDestination({ metadata: { a: 3, b: 4 }, path: "abc/def.html", abstract: { c: 5 }, syntax: "md" })
+    const destination = database.getDestinationDependently("abc.html", ["a"], "abc/def.html")
 
-//     t.test('updated document with no side effects is stale', () => {
-//       assert(staleAfterAbstractUpdate.length === 1)
-//     })
+    const dependencies = database.getDependencies()
 
-//     await votive.writeDestinations(config, database)
-//     const staleAfterSecondWrite = database.getStaleDestinations()
+    t.test('dependency created', () => {
+      assert(dependencies[0].dependent === 'abc/def.html')
+    })
 
-//     t.test('everything fresh again', () => {
-//       assert(staleAfterSecondWrite.length === 0)
-//     })
 
-//     const updatedWithSideEffects = database.createOrUpdateDestination({ metadata: { a: 4, b: 9 }, path: "abc.html", abstract: { c: 4 }, syntax: "md" })
-//     const staleAfterSideEffects = database.getStaleDestinations()
+    const setting = database.setSetting("abc.html", "theme", "blue", "markdown/prunee.md")
+    const newSetting = database.setSetting("abc", "category", "Dog", "markdown/prunee.md")
+    const sameSetting = database.setSetting("abc", "category", "Dog", "markdown/prunee.md")
+    const folderSetting = database.setSetting("abc", "theme", "red", "markdown/prunee.md")
 
-//     t.test('side effects work', () => {
-//       assert(staleAfterSideEffects.length === 2)
-//     })
+    t.test('settings created', () => {
+      assert(setting.value === 'blue')
+      assert(newSetting.value === 'Dog')
+      assert(!sameSetting)
+    })
 
+    const abcSettings = database.getSettings("abc.html")
 
-//     await votive.writeDestinations(config, database)
+    t.test('settings retrieved', () => {
+      assert(abcSettings.theme[0] === "blue")
+    })
 
-//     const oldSetting = database.setSetting("abc", "theme", "green")
+    const descendentSetting = database.setSetting("abc/def.html", "theme", "green", "abc.md")
+    const defSettings = database.getSettings("abc/def.html")
 
-//     const staleAfterSettingsChange = database.getStaleDestinations()
+    t.test('settings retrieved', () => {
+      assert(abcSettings.theme[0] === "blue")
+      assert(defSettings.theme[1] === "green")
+    })
 
-//     t.test('setting affects descendents', () => {
-//       assert(staleAfterSettingsChange.length === 1)
-//     })
+    const staleDestinations = database.getStaleDestinations()
 
-//     // TODO: Write tests for jobs
-//     const jobs = [...sourcesJobs, ...abstractsJobs, ...foldersJobs]
-//     runJobs(jobs, config, database)
+    t.test('all destinations are stale', () => {
+      assert(staleDestinations.length === 7)
+    })
 
-//     fs.rmSync("markdown/prunee.md")
+    const written = await votive.writeDestinations(config, database)
 
-//     await votive.pruneSources(config, database)
+    const staleDestinationsAfterWriting = database.getStaleDestinations()
 
-//     const result = database.getDestinationIndependently("markdown/prunee.html")
+    t.test('all destinations are fresh', () => {
+      assert(staleDestinationsAfterWriting.length === 0)
+    })
+
+    const updated = database.createOrUpdateDestination({ metadata: { a: 1, b: 9 }, path: "abc.html", abstract: { c: 4 }, syntax: "md" })
+    const staleAfterAbstractUpdate = database.getStaleDestinations()
 
-//     /* TODO: Check pruning metadata works (I removed it) */
+    t.test('updated document with no side effects is stale', () => {
+      assert(staleAfterAbstractUpdate.length === 1)
+    })
 
-//     const finalDestinations = database.getDestinations({
-//       filter: [
-//         {
-//           property: "a",
-//           operator: "gt",
-//           value: 3
-//         }
-//       ]
-//     }, "markdown/prunee.html")
+    await votive.writeDestinations(config, database)
+    const staleAfterSecondWrite = database.getStaleDestinations()
 
-//     // TODO: Write a test for get destinations
+    t.test('everything fresh again', () => {
+      assert(staleAfterSecondWrite.length === 0)
+    })
 
-//     await database.saveDB()
+    const updatedWithSideEffects = database.createOrUpdateDestination({ metadata: { a: 4, b: 9 }, path: "abc.html", abstract: { c: 4 }, syntax: "md" })
+    const staleAfterSideEffects = database.getStaleDestinations()
 
-//     temp.remove()
-//   } catch (error) {
-//     temp.remove()
-//     throw error
-//   }
-// })
+    t.test('side effects work', () => {
+      assert(staleAfterSideEffects.length === 2)
+    })
+
+    const freshDestinations = database.getAllDestinations()
+
+    await votive.writeDestinations(config, database)
+
+    const oldSetting = database.setSetting("abc", "theme", "green")
+
+    const staleAfterSettingsChange = database.getStaleDestinations()
+
+    t.test('setting affects descendents', () => {
+      assert(staleAfterSettingsChange.length === 1)
+    })
+
+    // TODO: Write tests for jobs
+    const jobs = [...sourcesJobs, ...abstractsJobs, ...foldersJobs]
+    runJobs(jobs, config, database)
+
+    const destinations = database.getAllDestinations()
+    database.getDestinationDependently("markdown/prunee.html", ["title"], "abc/def.html")
+    const newDependencies = database.getDependencies()
+
+    fs.rmSync("markdown/prunee.md")
+
+    await votive.pruneSources(config, database)
+
+    const result = database.getDestinationIndependently("markdown/prunee.html")
+    const prunedDependencies = database.getDependencies()
+    const prunedMetadata = database.getAllMetadataByPath("markdown/prunee.html")
+
+    t.test('source pruned', () => {
+      assert(!result)
+      assert(newDependencies.length - prunedDependencies.length === 1)
+      assert(!prunedMetadata)
+    })
+
+    await database.saveDB()
+
+    temp.remove()
+  } catch (error) {
+    temp.remove()
+    throw error
+  }
+})