adapt-migrations 1.2.0 → 1.3.0

package/api/plugins.js

@@ -1,47 +1,47 @@
-import { deferOrRunWrap, successStopOrErrorWrap } from '../lib/lifecycle.js'
-import { valid } from 'semver'
-
-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 (!valid(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 (!valid(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' })
-};
+import { deferOrRunWrap, successStopOrErrorWrap } from '../lib/lifecycle.js'
+import { valid } from 'semver'
+
+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 (!valid(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 (!valid(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,56 @@
-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.info(`Test success where -- ${description}`)
+    return new TaskTest({
+      description,
+      shouldRun: true,
+      fromPlugins,
+      toPlugins,
+      content
+    })
+  }, { type: 'test' })
+};
+
+export function testStopWhere (description, {
+  fromPlugins,
+  toPlugins,
+  content
+}) {
+  return deferOrRunWrap(() => {
+    logger.info(`Test stop where -- ${description}`)
+    return new TaskTest({
+      description,
+      shouldStop: true,
+      fromPlugins,
+      toPlugins,
+      content
+    })
+  }, { type: 'test' })
+};
+
+export function testErrorWhere (description, {
+  fromPlugins,
+  toPlugins,
+  content
+}) {
+  return deferOrRunWrap(() => {
+    logger.info(`Test error where -- ${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' })
+};

package/examples/migrations.js

@@ -1,159 +1,159 @@
-module.exports = function(grunt) {
-
-  const Helpers = require('../helpers')(grunt);
-  const globs = require('globs');
-  const path = require('path');
-  const fs = require('fs-extra');
-  const _ = require('underscore');
-
-  function unix(path) {
-    return path.replace(/\\/g, '/');
-  }
-
-  function dressPathIndex(fileItem) {
-    return {
-      ...fileItem.item,
-      __index__: fileItem.index,
-      __path__: unix(fileItem.file.path)
-    };
-  }
-
-  function undressPathIndex(object) {
-    const clone = { ...object };
-    delete clone.__index__;
-    delete clone.__path__;
-    return clone;
-  }
-
-  grunt.registerTask('migration', 'Migrate from on verion to another', function(mode) {
-    const next = this.async();
-    const buildConfig = Helpers.generateConfigData();
-    const fileNameIncludes = grunt.option('file');
-
-    (async function() {
-      const migrations = await import('adapt-migrations');
-      const logger = migrations.Logger.getInstance();
-      const cwd = process.cwd();
-      const outputPath = path.join(cwd, './migrations/');
-      const cache = new migrations.CacheManager();
-      const cachePath = await cache.getCachePath({
-        outputPath: buildConfig.outputdir,
-        tempPath: outputPath
-      });
-
-      const framework = Helpers.getFramework();
-      logger.debug(`Using ${framework.useOutputData ? framework.outputPath : framework.sourcePath} folder for course data...`);
-
-      const plugins = framework.getPlugins().getAllPackageJSONFileItems().map(fileItem => fileItem.item);
-      const migrationScripts = Array.from(await new Promise(resolve => {
-        globs([
-          '*/*/migrations/**/*.js',
-          'core/migrations/**/*.js'
-        ], { cwd: path.join(cwd, './src/'), absolute: true }, (err, files) => resolve(err ? null : files));
-      })).filter(filePath => {
-        if (!fileNameIncludes) return true;
-        return filePath.includes(fileNameIncludes);
-      });
-
-      await migrations.load({
-        cachePath,
-        scripts: migrationScripts,
-        logger
-      });
-
-      if (mode === 'capture') {
-
-        if (!fs.existsSync(outputPath)) fs.mkdirSync(outputPath);
-        const languages = framework.getData().languages.map((language) => language.name);
-        const languageFile = path.join(outputPath, 'captureLanguages.json');
-        fs.writeJSONSync(languageFile, languages);
-        languages.forEach(async (language, index) => {
-          logger.debug(`Migration -- Capture ${language}`)
-          const data = framework.getData();
-          // get all items from config.json file and all language files, append __index__ and __path__ to each item
-          const content = [
-            ...data.configFile.fileItems,
-            ...data.languages[index].getAllFileItems()
-          ].map(dressPathIndex);
-          const captured = await migrations.capture({ content, fromPlugins: plugins, logger });
-          const outputFile = path.join(outputPath, `capture_${language}.json`);
-          fs.writeJSONSync(outputFile, captured);
-        });
-
-        logger.output(outputPath, 'capture');
-        return next();
-      }
-
-      if (mode === 'migrate') {
-        try {
-          const languagesFile = path.join(outputPath, 'captureLanguages.json');
-          const languages = fs.readJSONSync(languagesFile);
-
-          for (const language of languages) {
-            logger.debug(`Migration -- Migrate ${language}`)
-            const Journal = migrations.Journal;
-            if (!fs.existsSync(outputPath)) fs.mkdirSync(outputPath);
-            const outputFile = path.join(outputPath, `capture_${language}.json`);
-            const { content, fromPlugins } = fs.readJSONSync(outputFile);
-            const originalFromPlugins = JSON.parse(JSON.stringify(fromPlugins));
-            const journal = new Journal({
-              logger,
-              data: {
-                content,
-                fromPlugins,
-                originalFromPlugins,
-                toPlugins: plugins,
-              },
-              supplementEntry: (entry, data) => {
-                entry._id = data[entry.keys[0]][entry.keys[1]]?._id ?? '';
-                entry._type = data[entry.keys[0]][entry.keys[1]]?._type ?? '';
-                if (entry._type && data[entry.keys[0]][entry.keys[1]]?.[`_${entry._type}`]) {
-                  entry[`_${entry._type}`] = data[entry.keys[0]][entry.keys[1]]?.[`_${entry._type}`] ?? '';
-                }
-                return entry;
-              }
-            });
-            await migrations.migrate({ journal, logger });
-
-            // Todo - {
-              // display changes success/failure and request user confirmation before completing
-              // move saving of content outside of the language loop
-              // only 1 confirmation per course rather than 1 per language
-              // output journal entries for revert
-            // }
-
-            // group all content items by path
-            const outputFilePathItems = _.groupBy(content, '__path__');
-            // sort items inside each path
-            Object.values(outputFilePathItems).forEach(outputFile => outputFile.sort((a, b) => a.__index__ - b.__index__));
-            // get paths
-            const outputFilePaths = Object.keys(outputFilePathItems);
-
-            outputFilePaths.forEach(outputPath => {
-              const outputItems = outputFilePathItems[outputPath];
-              if (!outputItems?.length) return;
-              const isSingleObject = (outputItems.length === 1 && outputItems[0].__index__ === null);
-              const stripped = isSingleObject
-                ? undressPathIndex(outputItems[0]) // config.json, course.json
-                : outputItems.map(undressPathIndex); // contentObjects.json, articles.json, blocks.json, components.json
-              // console.log(journal.entries)
-              fs.writeJSONSync(outputPath, stripped, { replacer: null, spaces: 2 });
-            });
-          }
-        } catch (error) {
-          logger.error(error.stack);
-        }
-        logger.output(outputPath, 'migrate');
-        return next();
-      }
-
-      if (mode === 'test') {
-        await migrations.test();
-        return next();
-      }
-
-      return next();
-    })();
-  });
-
-};
+module.exports = function(grunt) {
+
+  const Helpers = require('../helpers')(grunt);
+  const globs = require('globs');
+  const path = require('path');
+  const fs = require('fs-extra');
+  const _ = require('underscore');
+
+  function unix(path) {
+    return path.replace(/\\/g, '/');
+  }
+
+  function dressPathIndex(fileItem) {
+    return {
+      ...fileItem.item,
+      __index__: fileItem.index,
+      __path__: unix(fileItem.file.path)
+    };
+  }
+
+  function undressPathIndex(object) {
+    const clone = { ...object };
+    delete clone.__index__;
+    delete clone.__path__;
+    return clone;
+  }
+
+  grunt.registerTask('migration', 'Migrate from on verion to another', function(mode) {
+    const next = this.async();
+    const buildConfig = Helpers.generateConfigData();
+    const fileNameIncludes = grunt.option('file');
+
+    (async function() {
+      const migrations = await import('adapt-migrations');
+      const logger = migrations.Logger.getInstance();
+      const cwd = process.cwd();
+      const outputPath = path.join(cwd, './migrations/');
+      const cache = new migrations.CacheManager();
+      const cachePath = await cache.getCachePath({
+        outputPath: buildConfig.outputdir,
+        tempPath: outputPath
+      });
+
+      const framework = Helpers.getFramework();
+      logger.debug(`Using ${framework.useOutputData ? framework.outputPath : framework.sourcePath} folder for course data...`);
+
+      const plugins = framework.getPlugins().getAllPackageJSONFileItems().map(fileItem => fileItem.item);
+      const migrationScripts = Array.from(await new Promise(resolve => {
+        globs([
+          '*/*/migrations/**/*.js',
+          'core/migrations/**/*.js'
+        ], { cwd: path.join(cwd, './src/'), absolute: true }, (err, files) => resolve(err ? null : files));
+      })).filter(filePath => {
+        if (!fileNameIncludes) return true;
+        return filePath.includes(fileNameIncludes);
+      });
+
+      await migrations.load({
+        cachePath,
+        scripts: migrationScripts,
+        logger
+      });
+
+      if (mode === 'capture') {
+
+        if (!fs.existsSync(outputPath)) fs.mkdirSync(outputPath);
+        const languages = framework.getData().languages.map((language) => language.name);
+        const languageFile = path.join(outputPath, 'captureLanguages.json');
+        fs.writeJSONSync(languageFile, languages);
+        languages.forEach(async (language, index) => {
+          logger.debug(`Migration -- Capture ${language}`)
+          const data = framework.getData();
+          // get all items from config.json file and all language files, append __index__ and __path__ to each item
+          const content = [
+            ...data.configFile.fileItems,
+            ...data.languages[index].getAllFileItems()
+          ].map(dressPathIndex);
+          const captured = await migrations.capture({ content, fromPlugins: plugins, logger });
+          const outputFile = path.join(outputPath, `capture_${language}.json`);
+          fs.writeJSONSync(outputFile, captured);
+        });
+
+        logger.output(outputPath, 'capture');
+        return next();
+      }
+
+      if (mode === 'migrate') {
+        try {
+          const languagesFile = path.join(outputPath, 'captureLanguages.json');
+          const languages = fs.readJSONSync(languagesFile);
+
+          for (const language of languages) {
+            logger.debug(`Migration -- Migrate ${language}`)
+            const Journal = migrations.Journal;
+            if (!fs.existsSync(outputPath)) fs.mkdirSync(outputPath);
+            const outputFile = path.join(outputPath, `capture_${language}.json`);
+            const { content, fromPlugins } = fs.readJSONSync(outputFile);
+            const originalFromPlugins = JSON.parse(JSON.stringify(fromPlugins));
+            const journal = new Journal({
+              logger,
+              data: {
+                content,
+                fromPlugins,
+                originalFromPlugins,
+                toPlugins: plugins,
+              },
+              supplementEntry: (entry, data) => {
+                entry._id = data[entry.keys[0]][entry.keys[1]]?._id ?? '';
+                entry._type = data[entry.keys[0]][entry.keys[1]]?._type ?? '';
+                if (entry._type && data[entry.keys[0]][entry.keys[1]]?.[`_${entry._type}`]) {
+                  entry[`_${entry._type}`] = data[entry.keys[0]][entry.keys[1]]?.[`_${entry._type}`] ?? '';
+                }
+                return entry;
+              }
+            });
+            await migrations.migrate({ journal, logger });
+
+            // Todo - {
+              // display changes success/failure and request user confirmation before completing
+              // move saving of content outside of the language loop
+              // only 1 confirmation per course rather than 1 per language
+              // output journal entries for revert
+            // }
+
+            // group all content items by path
+            const outputFilePathItems = _.groupBy(content, '__path__');
+            // sort items inside each path
+            Object.values(outputFilePathItems).forEach(outputFile => outputFile.sort((a, b) => a.__index__ - b.__index__));
+            // get paths
+            const outputFilePaths = Object.keys(outputFilePathItems);
+
+            outputFilePaths.forEach(outputPath => {
+              const outputItems = outputFilePathItems[outputPath];
+              if (!outputItems?.length) return;
+              const isSingleObject = (outputItems.length === 1 && outputItems[0].__index__ === null);
+              const stripped = isSingleObject
+                ? undressPathIndex(outputItems[0]) // config.json, course.json
+                : outputItems.map(undressPathIndex); // contentObjects.json, articles.json, blocks.json, components.json
+              // console.log(journal.entries)
+              fs.writeJSONSync(outputPath, stripped, { replacer: null, spaces: 2 });
+            });
+          }
+        } catch (error) {
+          logger.error(error.stack);
+        }
+        logger.output(outputPath, 'migrate');
+        return next();
+      }
+
+      if (mode === 'test') {
+        await migrations.test();
+        return next();
+      }
+
+      return next();
+    })();
+  });
+
+};