adapt-migrations 1.0.0 → 1.1.0

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();
+    })();
+  });
+
+};

package/examples/script.js

@@ -1,78 +1,78 @@
-// Example migration script
-
-import { describe, whereContent, whereFromPlugin, whereToPlugin, mutateContent, checkContent, throwError, ifErroredAsk, testSuccessWhere, testErrorWhere, testStopWhere } from 'adapt-migrations';
-
-describe('update plugin from v6.1.4 to v6.1.5 and add "Ollie" to display title', async () => {
-  whereFromPlugin('text v6.1.4', { name: 'adapt-contrib-text', version: '<=6.1.4' });
-  whereContent('has configured displayTitles', async content =>
-    content.some(({ displayTitle }) => displayTitle)
-  );
-  mutateContent('change displayTitle', async content => {
-    const quicknavs = content.filter(({ displayTitle }) => displayTitle);
-    quicknavs.forEach(item => (item.displayTitle += ' ollie'));
-    return true;
-  });
-  checkContent('check everything is ok', async content => {
-    const isInvalid = content.some(({ displayTitle }) => displayTitle && !String(displayTitle).endsWith(' ollie'));
-    if (isInvalid) throw new Error('found displayTitle without ollie at the end');
-    return true;
-  });
-  updatePlugin('update text plugin', {name: 'adapt-contrib-text', version: '6.1.5', framework: '>=5.19.4'})
-});
-
-describe('quicknav to pagenav', async () => {
-  addPlugin('add pagenav plugin', { name: 'pagenav', version: '1.0.0'});
-  whereFromPlugin('quicknav v1.0.0', { name: 'quicknav', version: '1.0.0' });
-  whereToPlugin('pagenav v1.0.0', { name: 'pagenav', version: '1.0.0' });
-  removePlugin('remove quicknav plugin', {name: 'quicknav'})
-  whereContent('has configured quicknavs', async content =>
-    content.some(({ _component }) => _component === 'quicknav')
-  );
-  mutateContent('change _component name', async content => {
-    const quicknavs = content.filter(({ _component }) => _component === 'quicknav');
-    quicknavs.forEach(item => (item._component = 'pagenav'));
-    return true;
-  });
-  checkContent('check everything is ok', async content => {
-    const isInvalid = content.some(({ isInvalid }) => isInvalid);
-    if (isInvalid) throw new Error('found invalid content attribute');
-    return true;
-  });
-  // TODO: handle errors with question, allow to run without ui
-  // ifErroredAsk({ question: 'Skip error', yes: 'Yes', no: 'No', defaultSkipError: true });
-  // TODO: modify stack traces one errors to refer to the original migration script rather than the cached one,keep map of cached files to original files
-  testSuccessWhere('Valid plugins and content', {
-    fromPlugins: [{ name: 'quicknav', version: '1.0.0' }],
-    toPlugins: [{ name: 'pagenav', version: '1.0.0' }],
-    content: [{ _component: 'quicknav' }]
-  });
-  testStopWhere('Invalid content', {
-    fromPlugins: [{ name: 'quicknav', version: '1.0.0' }],
-    toPlugins: [{ name: 'pagenav', version: '1.0.0' }],
-    content: [{ _component: 'quicknav1' }]
-  });
-  testStopWhere('Invalid origin plugins', {
-    fromPlugins: [{ name: 'quicknav', version: '0.1.0' }],
-    toPlugins: [{ name: 'pagenav', version: '0.1.0' }],
-    content: [{ _component: 'quicknav' }]
-  });
-  testStopWhere('Invalid destination plugins', {
-    content: [{ _component: 'quicknav' }],
-    fromPlugins: [{ name: 'quicknav', version: '1.0.0' }],
-    toPlugins: [{ name: 'pagenav', version: '0.1.0' }]
-  });
-  testErrorWhere('Has invalid configuration', {
-    fromPlugins: [{ name: 'quicknav', version: '1.0.0' }],
-    toPlugins: [{ name: 'pagenav', version: '1.0.0' }],
-    content: [{ _component: 'quicknav', isInvalid: true }]
-  });
-});
-
-describe('where quicknav is weirdly configured', async () => {
-  checkContent('check everything is ok', async content => {
-    const isInvalid = content.some(({ isInvalid }) => isInvalid);
-    if (isInvalid) throw new Error('Something went wrong');
-    return true;
-  });
-  throwError('this is an error');
-});
+// Example migration script
+
+import { describe, whereContent, whereFromPlugin, whereToPlugin, mutateContent, checkContent, throwError, ifErroredAsk, testSuccessWhere, testErrorWhere, testStopWhere } from 'adapt-migrations';
+
+describe('update plugin from v6.1.4 to v6.1.5 and add "Ollie" to display title', async () => {
+  whereFromPlugin('text v6.1.4', { name: 'adapt-contrib-text', version: '<=6.1.4' });
+  whereContent('has configured displayTitles', async content =>
+    content.some(({ displayTitle }) => displayTitle)
+  );
+  mutateContent('change displayTitle', async content => {
+    const quicknavs = content.filter(({ displayTitle }) => displayTitle);
+    quicknavs.forEach(item => (item.displayTitle += ' ollie'));
+    return true;
+  });
+  checkContent('check everything is ok', async content => {
+    const isInvalid = content.some(({ displayTitle }) => displayTitle && !String(displayTitle).endsWith(' ollie'));
+    if (isInvalid) throw new Error('found displayTitle without ollie at the end');
+    return true;
+  });
+  updatePlugin('update text plugin', {name: 'adapt-contrib-text', version: '6.1.5', framework: '>=5.19.4'})
+});
+
+describe('quicknav to pagenav', async () => {
+  addPlugin('add pagenav plugin', { name: 'pagenav', version: '1.0.0'});
+  whereFromPlugin('quicknav v1.0.0', { name: 'quicknav', version: '1.0.0' });
+  whereToPlugin('pagenav v1.0.0', { name: 'pagenav', version: '1.0.0' });
+  removePlugin('remove quicknav plugin', {name: 'quicknav'})
+  whereContent('has configured quicknavs', async content =>
+    content.some(({ _component }) => _component === 'quicknav')
+  );
+  mutateContent('change _component name', async content => {
+    const quicknavs = content.filter(({ _component }) => _component === 'quicknav');
+    quicknavs.forEach(item => (item._component = 'pagenav'));
+    return true;
+  });
+  checkContent('check everything is ok', async content => {
+    const isInvalid = content.some(({ isInvalid }) => isInvalid);
+    if (isInvalid) throw new Error('found invalid content attribute');
+    return true;
+  });
+  // TODO: handle errors with question, allow to run without ui
+  // ifErroredAsk({ question: 'Skip error', yes: 'Yes', no: 'No', defaultSkipError: true });
+  // TODO: modify stack traces one errors to refer to the original migration script rather than the cached one,keep map of cached files to original files
+  testSuccessWhere('Valid plugins and content', {
+    fromPlugins: [{ name: 'quicknav', version: '1.0.0' }],
+    toPlugins: [{ name: 'pagenav', version: '1.0.0' }],
+    content: [{ _component: 'quicknav' }]
+  });
+  testStopWhere('Invalid content', {
+    fromPlugins: [{ name: 'quicknav', version: '1.0.0' }],
+    toPlugins: [{ name: 'pagenav', version: '1.0.0' }],
+    content: [{ _component: 'quicknav1' }]
+  });
+  testStopWhere('Invalid origin plugins', {
+    fromPlugins: [{ name: 'quicknav', version: '0.1.0' }],
+    toPlugins: [{ name: 'pagenav', version: '0.1.0' }],
+    content: [{ _component: 'quicknav' }]
+  });
+  testStopWhere('Invalid destination plugins', {
+    content: [{ _component: 'quicknav' }],
+    fromPlugins: [{ name: 'quicknav', version: '1.0.0' }],
+    toPlugins: [{ name: 'pagenav', version: '0.1.0' }]
+  });
+  testErrorWhere('Has invalid configuration', {
+    fromPlugins: [{ name: 'quicknav', version: '1.0.0' }],
+    toPlugins: [{ name: 'pagenav', version: '1.0.0' }],
+    content: [{ _component: 'quicknav', isInvalid: true }]
+  });
+});
+
+describe('where quicknav is weirdly configured', async () => {
+  checkContent('check everything is ok', async content => {
+    const isInvalid = content.some(({ isInvalid }) => isInvalid);
+    if (isInvalid) throw new Error('Something went wrong');
+    return true;
+  });
+  throwError('this is an error');
+});

package/index.js

@@ -1,62 +1,70 @@
-import {
-  load,
-  capture,
-  migrate,
-  test
-} from './api/commands.js'
-import {
-  describe
-} from './api/describe.js'
-import {
-  whereContent,
-  whereFromPlugin,
-  whereToPlugin
-} from './api/where.js'
-import {
-  checkContent,
-  mutateContent
-} from './api/data.js'
-import {
-  ifErroredAsk,
-  throwError
-} from './api/errors.js'
-import {
-  testErrorWhere,
-  testStopWhere,
-  testSuccessWhere
-} from './api/tests.js'
-import {
-  updatePlugin,
-  removePlugin,
-  addPlugin
-} from './api/plugins.js'
-import Journal from './lib/Journal.js'
-import CacheManager from './lib/CacheManager.js'
-import Logger from './lib/Logger.js'
-
-export {
-  // commands
-  load,
-  capture,
-  migrate,
-  test,
-  // migration script api
-  describe,
-  whereContent,
-  whereFromPlugin,
-  whereToPlugin,
-  checkContent,
-  mutateContent,
-  ifErroredAsk,
-  throwError,
-  testErrorWhere,
-  testStopWhere,
-  testSuccessWhere,
-  updatePlugin,
-  removePlugin,
-  addPlugin,
-  // environment objects
-  Journal,
-  CacheManager,
-  Logger
-}
+import {
+  load,
+  capture,
+  migrate,
+  test
+} from './api/commands.js'
+import {
+  describe
+} from './api/describe.js'
+import {
+  whereContent,
+  whereFromPlugin,
+  whereToPlugin
+} from './api/where.js'
+import {
+  checkContent,
+  mutateContent
+} from './api/data.js'
+import {
+  ifErroredAsk,
+  throwError
+} from './api/errors.js'
+import {
+  testErrorWhere,
+  testStopWhere,
+  testSuccessWhere
+} from './api/tests.js'
+import {
+  updatePlugin,
+  removePlugin,
+  addPlugin
+} from './api/plugins.js'
+import {
+  getConfig,
+  getCourse,
+  getComponents
+} from './api/helpers.js'
+import Journal from './lib/Journal.js'
+import CacheManager from './lib/CacheManager.js'
+import Logger from './lib/Logger.js'
+
+export {
+  // commands
+  load,
+  capture,
+  migrate,
+  test,
+  // migration script api
+  describe,
+  whereContent,
+  whereFromPlugin,
+  whereToPlugin,
+  checkContent,
+  mutateContent,
+  ifErroredAsk,
+  throwError,
+  testErrorWhere,
+  testStopWhere,
+  testSuccessWhere,
+  updatePlugin,
+  removePlugin,
+  addPlugin,
+  getConfig,
+  getCourse,
+  getComponents,
+  // environment objects
+  Journal,
+  CacheManager,
+  Logger
+}