adapt-migrations 1.0.0 → 1.1.0

package/.eslintignore

@@ -1 +1 @@
-node_modules
+node_modules

package/.eslintrc.json

@@ -1,14 +1,14 @@
-{
-  "env": {
-      "browser": false,
-      "node": true,
-      "commonjs": false,
-      "es2020": true
-  },
-  "extends": [
-      "standard"
-  ],
-  "parserOptions": {
-      "ecmaVersion": 2022
-  }
-}
+{
+  "env": {
+      "browser": false,
+      "node": true,
+      "commonjs": false,
+      "es2020": true
+  },
+  "extends": [
+      "standard"
+  ],
+  "parserOptions": {
+      "ecmaVersion": 2022
+  }
+}

package/README.md

@@ -1,43 +1,43 @@
-# adapt-migrations
-
-### Todos
-https://github.com/cgkineo/adapt-migrations/issues/1
-
-### Commands API
-https://github.com/cgkineo/adapt-migrations/blob/master/api/commands.js
-* `load({ cwd, cachePath, scripts })` - loads all migration tasks
-* `capture({ cwd, content, fromPlugins })` - captures current plugins and content
-* `migrate({ cwd, toPlugins })` - migrates content from capture to new plugins
-* `test({ cwd })` - tests the migrations with dummy content
-
-### Migration script API
-Functions:
-* `describe(description, describeFunction)` Describe a migration
-* `whereContent(description, contentFilterFunction)` Limit when the migration runs, return true/false/throw Error
-* `whereFromPlugin(description, fromPluginFilterFunction)` Limit when the migration runs, return true/false/throw Error
-* `whereToPlugin(description, toPluginFilterFunction)` Limit when the migration runs, return true/false/throw Error
-* `mutateContent(contentFunction)` Change content, return true/false/throw Error
-* `checkContent(contentFunction)` Check content, return true/false/throw Error
-* `throwError(description)` Throw an error
-* `testSuccessWhere({ fromPlugins, toPlugins, content })` Supply some tests content which should end in success
-* `testStopWhere({ fromPlugins, toPlugins, content })` Supply some tests content which should end prematurely
-* `testErrorWhere({ fromPlugins, toPlugins, content })` Supply some tests content which will trigger an error
-
-Arguments:
-* `describeFunction = () => {}` Function body has a collection of migration script functions
-* `contentFilterFunction = content => {}` Function body should return true/false/throw Error
-* `fromPluginFilterFunction = fromPlugins => {}` Function body should return true/false/throw Error
-* `toPluginFilterFunction = toPlugins => {}` Function body should return true/false/throw Error
-* `contentFunction = content => { }` Function body should mutate or check the content, returning true/false/throw Error
-* `fromPlugins = [{ name: 'quickNav , version: '1.0.0' }]` Test data describing the original plugins
-* `toPlugins = [{ name: 'pageNav , version: '1.0.0' }]` Test data describing the destination plugins
-* `content = [{ _id: 'c-05, ... }]` Test content for the course content
-
-### Grunt Commands
-```sh
-grunt migration:capture # captures current plugins and content
-# do plugin/fw updates
-grunt migration:migrate # migrates content from capture to new plugins
-grunt migration:test # tests the migrations with dummy content
-grunt migration:test --file=adapt-contrib-text/migrations/text.js # tests the migrations with dummy content
-```
+# adapt-migrations
+
+### Todos
+https://github.com/cgkineo/adapt-migrations/issues/1
+
+### Commands API
+https://github.com/cgkineo/adapt-migrations/blob/master/api/commands.js
+* `load({ cwd, cachePath, scripts })` - loads all migration tasks
+* `capture({ cwd, content, fromPlugins })` - captures current plugins and content
+* `migrate({ cwd, toPlugins })` - migrates content from capture to new plugins
+* `test({ cwd })` - tests the migrations with dummy content
+
+### Migration script API
+Functions:
+* `describe(description, describeFunction)` Describe a migration
+* `whereContent(description, contentFilterFunction)` Limit when the migration runs, return true/false/throw Error
+* `whereFromPlugin(description, fromPluginFilterFunction)` Limit when the migration runs, return true/false/throw Error
+* `whereToPlugin(description, toPluginFilterFunction)` Limit when the migration runs, return true/false/throw Error
+* `mutateContent(contentFunction)` Change content, return true/false/throw Error
+* `checkContent(contentFunction)` Check content, return true/false/throw Error
+* `throwError(description)` Throw an error
+* `testSuccessWhere({ fromPlugins, toPlugins, content })` Supply some tests content which should end in success
+* `testStopWhere({ fromPlugins, toPlugins, content })` Supply some tests content which should end prematurely
+* `testErrorWhere({ fromPlugins, toPlugins, content })` Supply some tests content which will trigger an error
+
+Arguments:
+* `describeFunction = () => {}` Function body has a collection of migration script functions
+* `contentFilterFunction = content => {}` Function body should return true/false/throw Error
+* `fromPluginFilterFunction = fromPlugins => {}` Function body should return true/false/throw Error
+* `toPluginFilterFunction = toPlugins => {}` Function body should return true/false/throw Error
+* `contentFunction = content => { }` Function body should mutate or check the content, returning true/false/throw Error
+* `fromPlugins = [{ name: 'quickNav , version: '1.0.0' }]` Test data describing the original plugins
+* `toPlugins = [{ name: 'pageNav , version: '1.0.0' }]` Test data describing the destination plugins
+* `content = [{ _id: 'c-05, ... }]` Test content for the course content
+
+### Grunt Commands
+```sh
+grunt migration:capture # captures current plugins and content
+# do plugin/fw updates
+grunt migration:migrate # migrates content from capture to new plugins
+grunt migration:test # tests the migrations with dummy content
+grunt migration:test --file=adapt-contrib-text/migrations/text.js # tests the migrations with dummy content
+```

package/api/commands.js

@@ -1,33 +1,33 @@
-import Task from '../lib/Task.js'
-
-export async function load ({ cwd = process.cwd(), scripts = [], cachePath, logger } = {}) {
-  return Task.load({
-    cwd,
-    scripts,
-    cachePath,
-    logger
-  })
-}
-
-export async function capture ({ content, fromPlugins, logger }) {
-  return {
-    content,
-    fromPlugins,
-    logger
-  }
-};
-
-export async function migrate ({ cwd = process.cwd(), journal, logger }) {
-  return Task.runApplicable({
-    cwd,
-    journal,
-    logger
-  })
-}
-
-export async function test ({ cwd = process.cwd(), logger } = {}) {
-  return Task.runTests({
-    cwd,
-    logger
-  })
-}
+import Task from '../lib/Task.js'
+
+export async function load ({ cwd = process.cwd(), scripts = [], cachePath, logger } = {}) {
+  return Task.load({
+    cwd,
+    scripts,
+    cachePath,
+    logger
+  })
+}
+
+export async function capture ({ content, fromPlugins, logger }) {
+  return {
+    content,
+    fromPlugins,
+    logger
+  }
+};
+
+export async function migrate ({ cwd = process.cwd(), journal, logger }) {
+  return Task.runApplicable({
+    cwd,
+    journal,
+    logger
+  })
+}
+
+export async function test ({ cwd = process.cwd(), logger } = {}) {
+  return Task.runTests({
+    cwd,
+    logger
+  })
+}

package/api/data.js

@@ -1,26 +1,26 @@
-import { deferOrRunWrap, successStopOrErrorWrap } from '../lib/lifecycle.js'
-
-export function mutateContent (description, callback) {
-  return deferOrRunWrap(function (context) {
-    return successStopOrErrorWrap('mutateContent', description, async () => {
-      return callback(context.content)
-    })
-  }, { description, type: 'action' })
-};
-
-export function checkContent (description, callback) {
-  return deferOrRunWrap(function (context) {
-    return successStopOrErrorWrap('checkContent', description, async () => {
-      context.journal.freeze()
-      let result
-      try {
-        result = await callback(context.content)
-      } catch (err) {
-        context.journal.unfreeze()
-        throw err
-      }
-      context.journal.unfreeze()
-      return result
-    })
-  }, { description, type: 'action' })
-};
+import { deferOrRunWrap, successStopOrErrorWrap } from '../lib/lifecycle.js'
+
+export function mutateContent (description, callback) {
+  return deferOrRunWrap(function (context) {
+    return successStopOrErrorWrap('mutateContent', description, async () => {
+      return callback(context.content)
+    })
+  }, { description, type: 'action' })
+};
+
+export function checkContent (description, callback) {
+  return deferOrRunWrap(function (context) {
+    return successStopOrErrorWrap('checkContent', description, async () => {
+      context.journal.freeze()
+      let result
+      try {
+        result = await callback(context.content)
+      } catch (err) {
+        context.journal.unfreeze()
+        throw err
+      }
+      context.journal.unfreeze()
+      return result
+    })
+  }, { description, type: 'action' })
+};

package/api/describe.js

@@ -1,12 +1,12 @@
-import Task from '../lib/Task.js'
-import Logger from './../lib/Logger.js'
-
-export function describe (description, load) {
-  const logger = Logger.getInstance();
-  logger.info(`Describe -- ${description} -- Registered`)
-  if (Task.current) {
-    logger.error(`Describe -- Cannot nest describe statements -- ${description}`)
-  }
-  // eslint-disable-next-line no-new
-  new Task({ description, load })
-};
+import Task from '../lib/Task.js'
+import Logger from './../lib/Logger.js'
+
+export function describe (description, load) {
+  const logger = Logger.getInstance();
+  logger.info(`Describe -- ${description} -- Registered`)
+  if (Task.current) {
+    logger.error(`Describe -- Cannot nest describe statements -- ${description}`)
+  }
+  // eslint-disable-next-line no-new
+  new Task({ description, load })
+};

package/api/errors.js

@@ -1,28 +1,28 @@
-import { deferOrRunWrap, successStopOrErrorWrap } from '../lib/lifecycle.js'
-import Logger from './../lib/Logger.js'
-
-const logger = Logger.getInstance();
-
-export function throwError (description) {
-  let error = description
-  if (!(description instanceof Error)) {
-    logger.error(`Errors -- ${description}`)
-    error = new Error(description)
-  } else {
-    description = description.message
-  }
-  return deferOrRunWrap(function (context) {
-    return successStopOrErrorWrap('throwError', description, async () => {
-      throw error
-    })
-  }, { type: 'action' })
-}
-
-export function ifErroredAsk (config) {
-  return deferOrRunWrap(function (context) {
-    return successStopOrErrorWrap('isErroredAsk', config.question, async () => {
-      if (!context.hasErrored) return true
-      // Ask a question
-    })
-  }, { type: 'error' })
-};
+import { deferOrRunWrap, successStopOrErrorWrap } from '../lib/lifecycle.js'
+import Logger from './../lib/Logger.js'
+
+const logger = Logger.getInstance();
+
+export function throwError (description) {
+  let error = description
+  if (!(description instanceof Error)) {
+    logger.error(`Errors -- ${description}`)
+    error = new Error(description)
+  } else {
+    description = description.message
+  }
+  return deferOrRunWrap(function (context) {
+    return successStopOrErrorWrap('throwError', description, async () => {
+      throw error
+    })
+  }, { type: 'action' })
+}
+
+export function ifErroredAsk (config) {
+  return deferOrRunWrap(function (context) {
+    return successStopOrErrorWrap('isErroredAsk', config.question, async () => {
+      if (!context.hasErrored) return true
+      // Ask a question
+    })
+  }, { type: 'error' })
+};

package/api/helpers.js

@@ -0,0 +1,17 @@
+import Task from '../lib/Task.js'
+
+function getContent() {
+  return Task.current.context.content;
+}
+
+export function getConfig () {
+  return getContent().find(({ _type, __path__ }) => _type === 'config' || __path__.endsWith('config.json'))
+}
+
+export function getCourse() {
+  return getContent().find(({ _type }) => _type === 'course');
+}
+
+export function getComponents(componentName) {
+  return getContent().filter(({ _component }) => _component === componentName);
+}

package/api/plugins.js

@@ -1,44 +1,47 @@
-import { deferOrRunWrap, successStopOrErrorWrap } from '../lib/lifecycle.js'
-
-export function removePlugin (description, config) {
-  return deferOrRunWrap(function (context) {
-    return successStopOrErrorWrap('removePlugin', description, async () => {
-      if (!description || !config) throw new Error('removePlugin - incorrectly configured')
-
-      context.fromPlugins = context.fromPlugins.filter(plugin => plugin.name !== config.name)
-
-      return true
-    })
-  }, { description, type: 'action' })
-};
-
-export function addPlugin (description, config) {
-  return deferOrRunWrap(function (context) {
-    return successStopOrErrorWrap('addPlugin', description, async () => {
-      if (!description || !config) throw new Error('addPlugin - incorrectly configured')
-
-      const newPlugin = context.toPlugins.find(plugin => (plugin.name === config.name))
-      if (!newPlugin) throw new Error(`addPlugin - ${config.name} not found`)
-      context.fromPlugins.push(newPlugin)
-
-      return true
-    })
-  }, { description, type: 'action' })
-};
-
-export function updatePlugin (description, config) {
-  return deferOrRunWrap(function (context) {
-    return successStopOrErrorWrap('updatePlugin', description, async () => {
-      if (!description || !config) throw new Error('updatePlugin - incorrectly configured')
-
-      context.fromPlugins.forEach(plugin => {
-        if (plugin.name !== config.name) return
-        plugin.version = config.version
-        if (!config.framework) return
-        plugin.framework = config.framework
-      })
-
-      return true
-    })
-  }, { description, type: 'action' })
-};
+import { deferOrRunWrap, successStopOrErrorWrap } from '../lib/lifecycle.js'
+const VERSION_CHECK = /^\d+\.\d+\.\d+$/
+
+export function removePlugin (description, config) {
+  return deferOrRunWrap(function (context) {
+    return successStopOrErrorWrap('removePlugin', description, async () => {
+      if (!description || !config) throw new Error('removePlugin - incorrectly configured')
+
+      context.fromPlugins = context.fromPlugins.filter(plugin => plugin.name !== config.name)
+
+      return true
+    })
+  }, { description, type: 'action' })
+};
+
+export function addPlugin (description, config) {
+  return deferOrRunWrap(function (context) {
+    return successStopOrErrorWrap('addPlugin', description, async () => {
+      if (!description || !config) throw new Error('addPlugin - incorrectly configured')
+      if (!VERSION_CHECK.test(config.version)) throw new Error(`addPlugin - invalid version number ${config.version}`)
+
+      const newPlugin = context.toPlugins.find(plugin => (plugin.name === config.name))
+      if (!newPlugin) throw new Error(`addPlugin - ${config.name} not found`)
+      context.fromPlugins.push(newPlugin)
+
+      return true
+    })
+  }, { description, type: 'action' })
+};
+
+export function updatePlugin (description, config) {
+  return deferOrRunWrap(function (context) {
+    return successStopOrErrorWrap('updatePlugin', description, async () => {
+      if (!description || !config) throw new Error('updatePlugin - incorrectly configured')
+      if (!VERSION_CHECK.test(config.version)) throw new Error(`updatePlugin - invalid version number ${config.version}`)
+
+      context.fromPlugins.forEach(plugin => {
+        if (plugin.name !== config.name) return
+        plugin.version = config.version
+        if (!config.framework) return
+        plugin.framework = config.framework
+      })
+
+      return true
+    })
+  }, { description, type: 'action' })
+};

package/api/tests.js

@@ -1,57 +1,57 @@
-import TaskTest from '../lib/TaskTest.js'
-import { deferOrRunWrap } from '../lib/lifecycle.js'
-import Logger from '../lib/Logger.js'
-
-const logger = Logger.getInstance();
-
-export function testSuccessWhere (description, {
-  fromPlugins,
-  toPlugins,
-  content
-}) {
-  return deferOrRunWrap(() => {
-    logger.debug(`Tests -- testSuccessWhere ${description}`)
-    return new TaskTest({
-      description,
-      shouldRun: true,
-      fromPlugins,
-      toPlugins,
-      content
-    })
-  }, { type: 'test' })
-};
-
-export function testStopWhere (description, {
-  fromPlugins,
-  toPlugins,
-  content
-}) {
-  return deferOrRunWrap(() => {
-    logger.debug(`Tests -- testStopWhere ${description}`)
-    return new TaskTest({
-      description,
-      shouldStop: true,
-      shouldRun: false,
-      fromPlugins,
-      toPlugins,
-      content
-    })
-  }, { type: 'test' })
-};
-
-export function testErrorWhere (description, {
-  fromPlugins,
-  toPlugins,
-  content
-}) {
-  return deferOrRunWrap(() => {
-    logger.debug(`Tests -- testErrorWhere ${description}`)
-    return new TaskTest({
-      description,
-      shouldError: true,
-      fromPlugins,
-      toPlugins,
-      content
-    })
-  }, { type: 'test' })
-};
+import TaskTest from '../lib/TaskTest.js'
+import { deferOrRunWrap } from '../lib/lifecycle.js'
+import Logger from '../lib/Logger.js'
+
+const logger = Logger.getInstance();
+
+export function testSuccessWhere (description, {
+  fromPlugins,
+  toPlugins,
+  content
+}) {
+  return deferOrRunWrap(() => {
+    logger.debug(`Tests -- testSuccessWhere ${description}`)
+    return new TaskTest({
+      description,
+      shouldRun: true,
+      fromPlugins,
+      toPlugins,
+      content
+    })
+  }, { type: 'test' })
+};
+
+export function testStopWhere (description, {
+  fromPlugins,
+  toPlugins,
+  content
+}) {
+  return deferOrRunWrap(() => {
+    logger.debug(`Tests -- testStopWhere ${description}`)
+    return new TaskTest({
+      description,
+      shouldStop: true,
+      shouldRun: false,
+      fromPlugins,
+      toPlugins,
+      content
+    })
+  }, { type: 'test' })
+};
+
+export function testErrorWhere (description, {
+  fromPlugins,
+  toPlugins,
+  content
+}) {
+  return deferOrRunWrap(() => {
+    logger.debug(`Tests -- testErrorWhere ${description}`)
+    return new TaskTest({
+      description,
+      shouldError: true,
+      fromPlugins,
+      toPlugins,
+      content
+    })
+  }, { type: 'test' })
+};

package/api/where.js

@@ -1,46 +1,46 @@
-import semver from 'semver'
-import { deferOrRunWrap, successStopOrErrorWrap } from '../lib/lifecycle.js'
-
-export function whereContent (description, callback) {
-  return deferOrRunWrap(({ content }) => {
-    return successStopOrErrorWrap('whereContent', description, async () => {
-      return callback(content)
-    })
-  }, { description, type: 'where' })
-};
-
-export function whereFromPlugin (description, callbackOrConfig) {
-  return deferOrRunWrap(({ fromPlugins }) => {
-    return successStopOrErrorWrap('whereFromPlugin', description, async () => {
-      const isCallback = (typeof callbackOrConfig === 'function')
-      if (isCallback) {
-        const callback = callbackOrConfig
-        return callback(fromPlugins)
-      }
-      const config = callbackOrConfig
-      return fromPlugins.some(plugin => {
-        if (config.name && plugin.name !== config.name) return false
-        if (config.version && !semver.satisfies(plugin.version, config.version)) return false
-        return true
-      })
-    })
-  }, { description, type: 'where' })
-};
-
-export function whereToPlugin (description, callbackOrConfig) {
-  return deferOrRunWrap(({ toPlugins }) => {
-    return successStopOrErrorWrap('whereToPlugin', description, async () => {
-      const isCallback = (typeof callbackOrConfig === 'function')
-      if (isCallback) {
-        const callback = callbackOrConfig
-        return callback(toPlugins)
-      }
-      const config = callbackOrConfig
-      return toPlugins.some(plugin => {
-        if (config.name && plugin.name !== config.name) return false
-        if (config.version && !semver.satisfies(plugin.version, config.version)) return false
-        return true
-      })
-    })
-  }, { description, type: 'where' })
-};
+import semver from 'semver'
+import { deferOrRunWrap, successStopOrErrorWrap } from '../lib/lifecycle.js'
+
+export function whereContent (description, callback) {
+  return deferOrRunWrap(({ content }) => {
+    return successStopOrErrorWrap('whereContent', description, async () => {
+      return callback(content)
+    })
+  }, { description, type: 'where' })
+};
+
+export function whereFromPlugin (description, callbackOrConfig) {
+  return deferOrRunWrap(({ fromPlugins }) => {
+    return successStopOrErrorWrap('whereFromPlugin', description, async () => {
+      const isCallback = (typeof callbackOrConfig === 'function')
+      if (isCallback) {
+        const callback = callbackOrConfig
+        return callback(fromPlugins)
+      }
+      const config = callbackOrConfig
+      return fromPlugins.some(plugin => {
+        if (config.name && plugin.name !== config.name) return false
+        if (config.version && !semver.satisfies(plugin.version, config.version)) return false
+        return true
+      })
+    })
+  }, { description, type: 'where' })
+};
+
+export function whereToPlugin (description, callbackOrConfig) {
+  return deferOrRunWrap(({ toPlugins }) => {
+    return successStopOrErrorWrap('whereToPlugin', description, async () => {
+      const isCallback = (typeof callbackOrConfig === 'function')
+      if (isCallback) {
+        const callback = callbackOrConfig
+        return callback(toPlugins)
+      }
+      const config = callbackOrConfig
+      return toPlugins.some(plugin => {
+        if (config.name && plugin.name !== config.name) return false
+        if (config.version && !semver.satisfies(plugin.version, config.version)) return false
+        return true
+      })
+    })
+  }, { description, type: 'where' })
+};