New: Migration Scripts (fixes #158)

migrations/v2.js

@@ -0,0 +1,143 @@
+import { describe, whereContent, whereFromPlugin, mutateContent, checkContent, updatePlugin, getComponents, testStopWhere, testSuccessWhere } from 'adapt-migrations';
+import _ from 'lodash';
+
+describe('adapt-contrib-accordion - v2.0.3 > v2.0.4', async () => {
+  let accordions;
+
+  whereFromPlugin('adapt-contrib-accordion - from v2.0.3', { name: 'adapt-contrib-accordion', version: '>=2.0.0 <2.0.4' });
+
+  whereContent('adapt-contrib-accordion - where accordion', async content => {
+    accordions = getComponents('accordion');
+    return accordions.length;
+  });
+
+  mutateContent('adapt-contrib-accordion - add accordion._items._classes attribute', async () => {
+    accordions.forEach(accordion => {
+      accordion._items.forEach(item => {
+        item._classes = '';
+      });
+    });
+    return true;
+  });
+
+  checkContent('adapt-contrib-accordion - check accordion._items._classes attribute', async () => {
+    const isValid = accordions.every(accordion =>
+      accordion._items.every(item =>
+        item && item._classes !== undefined
+      )
+    );
+    if (!isValid) throw new Error('adapt-contrib-accordion - _classes not added to every instance of accordion._items');
+    return true;
+  });
+
+  updatePlugin('adapt-contrib-accordion - update to v2.0.4', { name: 'adapt-contrib-accordion', version: '2.0.4', framework: '>=2.0.0' });
+
+  testSuccessWhere('correct version with accordion components', {
+    fromPlugins: [{ name: 'adapt-contrib-accordion', version: '2.0.3' }],
+    content: [
+      { _id: 'c-100', _component: 'accordion', _items: [{ title: 'item 1' }] },
+      { _id: 'c-105', _component: 'accordion', _items: [{ title: 'item 1' }] }
+    ]
+  });
+
+  testStopWhere('no accordion components', {
+    fromPlugins: [{ name: 'adapt-contrib-accordion', version: '2.0.3' }],
+    content: [{ _component: 'other' }]
+  });
+
+  testStopWhere('incorrect version', {
+    fromPlugins: [{ name: 'adapt-contrib-accordion', version: '2.0.4' }]
+  });
+});
+
+describe('adapt-contrib-accordion - v2.0.4 > v2.0.5', async () => {
+  let accordions;
+
+  whereFromPlugin('adapt-contrib-accordion - from v2.0.4', { name: 'adapt-contrib-accordion', version: '<2.0.5' });
+
+  whereContent('adapt-contrib-accordion - where accordion', async content => {
+    accordions = getComponents('accordion');
+    return accordions.length;
+  });
+
+  mutateContent('adapt-contrib-accordion - add accordion._shouldCollapseItems attribute', async () => {
+    accordions.forEach(accordion => {
+      accordion._shouldCollapseItems = true;
+    });
+    return true;
+  });
+
+  checkContent('adapt-contrib-accordion - check accordion._shouldCollapseItems attribute', async () => {
+    const isValid = accordions.every(({ _shouldCollapseItems }) => _shouldCollapseItems === true);
+    if (!isValid) throw new Error('adapt-contrib-accordion - _shouldCollapseItems not added to every instance of accordion and set to true.');
+    return true;
+  });
+
+  updatePlugin('adapt-contrib-accordion - update to v2.0.5', { name: 'adapt-contrib-accordion', version: '2.0.5', framework: '>=2.0.0' });
+
+  testSuccessWhere('correct version with accordion components', {
+    fromPlugins: [{ name: 'adapt-contrib-accordion', version: '2.0.4' }],
+    content: [
+      { _id: 'c-100', _component: 'accordion', _items: [{ title: 'item 1' }] },
+      { _id: 'c-105', _component: 'accordion' }
+    ]
+  });
+
+  testStopWhere('no accordion components', {
+    fromPlugins: [{ name: 'adapt-contrib-accordion', version: '2.0.4' }],
+    content: [{ _component: 'other' }]
+  });
+
+  testStopWhere('incorrect version', {
+    fromPlugins: [{ name: 'adapt-contrib-accordion', version: '2.0.5' }]
+  });
+});
+
+describe('adapt-contrib-accordion - v2.0.5 > v2.1.0', async () => {
+  let accordions;
+
+  whereFromPlugin('adapt-contrib-accordion - from v2.0.5', { name: 'adapt-contrib-accordion', version: '<2.1.0' });
+
+  whereContent('adapt-contrib-accordion - where accordion', async content => {
+    accordions = getComponents('accordion');
+    return accordions.length;
+  });
+
+  mutateContent('adapt-contrib-accordion - add accordion._items._graphic.attribution', async () => {
+    accordions.forEach(accordion => {
+      accordion._items.forEach(item => {
+        _.set(item, '_graphic.attribution', '');
+      });
+    });
+    return true;
+  });
+
+  checkContent('adapt-contrib-accordion - check accordion._items._graphic.attribution atrribute', async () => {
+    const isValid = accordions.every(accordion =>
+      accordion._items.every(item =>
+        item._graphic && item._graphic.attribution !== undefined
+      )
+    );
+    if (!isValid) throw new Error('adapt-contrib-accordion - _graphic.attribution not added to every instance of accordion._items');
+    return true;
+  });
+
+  updatePlugin('adapt-contrib-accordion - update to v2.1.0', { name: 'adapt-contrib-accordion', version: '2.1.0', framework: '>=2.0.0' });
+
+  testSuccessWhere('correct version with accordion components with/without _graphic', {
+    fromPlugins: [{ name: 'adapt-contrib-accordion', version: '2.0.5' }],
+    content: [
+      { _id: 'c-100', _component: 'accordion', _items: [{ title: 'item 1', _graphic: {} }] },
+      { _id: 'c-105', _component: 'accordion', _items: [{ title: 'item 1' }] }
+    ]
+  });
+
+  testStopWhere('no accordion components', {
+    fromPlugins: [{ name: 'adapt-contrib-accordion', version: '2.0.5' }],
+    content: [{ _component: 'other' }]
+  });
+
+  testStopWhere('incorrect version', {
+    fromPlugins: [{ name: 'adapt-contrib-accordion', version: '2.1.0' }]
+  });
+});

migrations/v4.js

@@ -0,0 +1,82 @@
+import { describe, whereContent, whereFromPlugin, mutateContent, checkContent, updatePlugin, getCourse, getComponents, testStopWhere, testSuccessWhere } from 'adapt-migrations';
+import _ from 'lodash';
+
+describe('adapt-contrib-accordion - v2.1.0 > v4.0.0', async () => {
+
+  let course, courseAccordionGlobals, accordions;
+  const oldAriaRegion = 'This component requires you to answer the question by selecting the relevant value. After selecting a value select the submit button below.';
+
+  whereFromPlugin('adapt-contrib-accordion - from v2.1.0', { name: 'adapt-contrib-accordion', version: '<4.0.0' });
+
+  whereContent('adapt-contrib-accordion - where accordion', async content => {
+    accordions = getComponents('accordion');
+    return accordions.length;
+  });
+
+  mutateContent('adapt-contrib-accordion - modify globals ariaRegion attribute', async (content) => {
+    course = getCourse();
+    if (!_.has(course, '_globals._components._accordion')) _.set(course, '_globals._components._accordion', { ariaRegion: oldAriaRegion });
+    courseAccordionGlobals = course._globals._components._accordion;
+    if (courseAccordionGlobals.ariaRegion === oldAriaRegion) {
+      courseAccordionGlobals.ariaRegion = 'Accordion. Select each button to expand the content.';
+    }
+    return true;
+  });
+
+  mutateContent('adapt-contrib-accordion - add accordion._setCompletionOn and set attribute', async () => {
+    accordions.forEach(accordion => {
+      accordion._setCompletionOn = 'allItems';
+    });
+    return true;
+  });
+
+  checkContent('adapt-contrib-accordion - modify globals ariaRegion attribute', async (content) => {
+    const isValid = courseAccordionGlobals.ariaRegion !== oldAriaRegion;
+    if (!isValid) throw new Error('Accordion globals ariaRegion attribute not modified.');
+    return true;
+  });
+
+  checkContent('adapt-contrib-accordion - check accordion._setCompletionOn attribute', async () => {
+    const isValid = accordions.every(({ _setCompletionOn }) => _setCompletionOn === 'allItems');
+    if (!isValid) throw new Error('adapt-contrib-accordion - _setCompletionOn not added to every instance of accordion and set to "allItems"');
+    return true;
+  });
+
+  updatePlugin('adapt-contrib-accordion - update to v4.0.0', { name: 'adapt-contrib-accordion', version: '4.0.0', framework: '>=3.3.0' });
+
+  testSuccessWhere('correct version with accordion components and empty course', {
+    fromPlugins: [{ name: 'adapt-contrib-accordion', version: '2.1.0' }],
+    content: [
+      { _id: 'c-100', _component: 'accordion', _items: [{ title: 'item 1' }] },
+      { _id: 'c-105', _component: 'accordion', _items: [{ title: 'item 1' }] },
+      { _type: 'course' }
+    ]
+  });
+
+  testSuccessWhere('correct version with accordion components and course globals', {
+    fromPlugins: [{ name: 'adapt-contrib-accordion', version: '2.1.0' }],
+    content: [
+      { _id: 'c-100', _component: 'accordion', _items: [{ title: 'item 1' }] },
+      { _id: 'c-105', _component: 'accordion', _items: [{ title: 'item 1' }] },
+      { _type: 'course', _globals: { _components: { _accordion: {} } } }
+    ]
+  });
+
+  testSuccessWhere('correct version with accordion components and custom course globals', {
+    fromPlugins: [{ name: 'adapt-contrib-accordion', version: '2.1.0' }],
+    content: [
+      { _id: 'c-100', _component: 'accordion', _items: [{ title: 'item 1' }] },
+      { _id: 'c-105', _component: 'accordion', _items: [{ title: 'item 1' }] },
+      { _type: 'course', _globals: { _components: { _accordion: { ariaRegion: 'custom aria region' } } } }
+    ]
+  });
+
+  testStopWhere('no accordion components', {
+    fromPlugins: [{ name: 'adapt-contrib-accordion', version: '2.1.0' }],
+    content: [{ _component: 'other' }]
+  });
+
+  testStopWhere('incorrect version', {
+    fromPlugins: [{ name: 'adapt-contrib-accordion', version: '4.0.0' }]
+  });
+});

migrations/v5.js

@@ -0,0 +1,128 @@
+import { describe, whereContent, whereFromPlugin, mutateContent, checkContent, updatePlugin, getCourse, getComponents, testStopWhere, testSuccessWhere } from 'adapt-migrations';
+import _ from 'lodash';
+
+describe('adapt-contrib-accordion - v4.0.0 > v5.0.0', async () => {
+  let course, courseAccordionGlobals, accordions;
+  const originalAriaRegion = 'Accordion. Select each button to expand the content.';
+  const newAriaRegion = 'List of expandable sections. Select each button to expand the content.';
+
+  whereFromPlugin('adapt-contrib-accordion - from v4.0.0', { name: 'adapt-contrib-accordion', version: '<5.0.0' });
+
+  whereContent('adapt-contrib-accordion - where accordion', async content => {
+    accordions = getComponents('accordion');
+    return accordions.length;
+  });
+
+  mutateContent('adapt-contrib-accordion - modify globals ariaRegion attribute', async (content) => {
+    course = getCourse();
+    if (!_.has(course, '_globals._components._accordion.ariaRegion')) _.set(course, '_globals._components._accordion', { ariaRegion: originalAriaRegion });
+    courseAccordionGlobals = course._globals._components._accordion;
+    if (courseAccordionGlobals.ariaRegion === originalAriaRegion) {
+      courseAccordionGlobals.ariaRegion = newAriaRegion;
+    }
+    return true;
+  });
+
+  mutateContent('adapt-contrib-accordion - update accordion._supportedLayout attribute to full-width if current isn\'t a supported value.', async () => {
+    accordions.forEach(accordion => {
+      if (accordion._supportedLayout !== 'full-width' || accordion._supportedLayout !== 'half-width' || accordion._supportedLayout !== 'both') {
+        accordion._supportedLayout = 'full-width';
+      }
+    });
+    return true;
+  });
+
+  checkContent('adapt-contrib-accordion - modify globals ariaRegion attribute', async (content) => {
+    const isValid = courseAccordionGlobals.ariaRegion !== originalAriaRegion;
+    if (!isValid) throw new Error('adapt-contrib-accordion - globals ariaRegion attribute not modified.');
+    return true;
+  });
+
+  checkContent('adapt-contrib-accordion - check accordion._supportedLayout attribute is now full-width', async () => {
+    const isValid = accordions.every(({ _supportedLayout }) => _supportedLayout === 'full-width' || _supportedLayout === 'half-width' || _supportedLayout === 'both');
+    if (!isValid) throw new Error('adapt-contrib-accordion - _supportedLayout attribute has not been modified to a supported value.');
+    return true;
+  });
+
+  updatePlugin('adapt-contrib-accordion - update to v5.0.0', { name: 'adapt-contrib-accordion', version: '5.0.0', framework: '>=5.0.0' });
+
+  testSuccessWhere('correct version with accordion components and empty course', {
+    fromPlugins: [{ name: 'adapt-contrib-accordion', version: '2.1.0' }],
+    content: [
+      { _id: 'c-100', _component: 'accordion', _items: [{ title: 'item 1' }] },
+      { _id: 'c-105', _component: 'accordion', _items: [{ title: 'item 1' }] },
+      { _type: 'course' }
+    ]
+  });
+
+  testSuccessWhere('correct version with accordion components and course globals', {
+    fromPlugins: [{ name: 'adapt-contrib-accordion', version: '2.1.0' }],
+    content: [
+      { _id: 'c-100', _component: 'accordion', _items: [{ title: 'item 1' }] },
+      { _id: 'c-105', _component: 'accordion', _items: [{ title: 'item 1' }] },
+      { _type: 'course', _globals: { _components: { _accordion: {} } } }
+    ]
+  });
+
+  testSuccessWhere('correct version with accordion components and custom course globals', {
+    fromPlugins: [{ name: 'adapt-contrib-accordion', version: '2.1.0' }],
+    content: [
+      { _id: 'c-100', _component: 'accordion', _items: [{ title: 'item 1' }] },
+      { _id: 'c-105', _component: 'accordion', _items: [{ title: 'item 1' }] },
+      { _type: 'course', _globals: { _components: { _accordion: { ariaRegion: 'custom aria region' } } } }
+    ]
+  });
+
+  testStopWhere('no accordion components', {
+    fromPlugins: [{ name: 'adapt-contrib-accordion', version: '2.1.0' }],
+    content: [{ _component: 'other' }]
+  });
+
+  testStopWhere('incorrect version', {
+    fromPlugins: [{ name: 'adapt-contrib-accordion', version: '4.0.0' }]
+  });
+});
+
+describe('adapt-contrib-accordion - v5.0.0 > v5.3.0', async () => {
+  let accordions;
+
+  whereFromPlugin('adapt-contrib-accordion - from v5.0.0', { name: 'adapt-contrib-accordion', version: '<5.3.0' });
+
+  whereContent('adapt-contrib-accordion - where accordion', async content => {
+    accordions = getComponents('accordion');
+    return accordions.length;
+  });
+
+  mutateContent('adapt-contrib-accordion - add accordion._shouldExpandFirstItem', async () => {
+    accordions.forEach(accordion => {
+      accordion._shouldExpandFirstItem = false;
+    });
+    return true;
+  });
+
+  checkContent('adapt-contrib-accordion - check accordion._shouldExpandFirstItem atrribute', async () => {
+    const isValid = accordions.every(({ _shouldExpandFirstItem }) => _shouldExpandFirstItem === false);
+    if (!isValid) throw new Error('adapt-contrib-accordion - _shouldExpandFirstItem not added to every instance of accordion');
+    return true;
+  });
+
+  updatePlugin('adapt-contrib-accordion - update to v5.3.0', { name: 'adapt-contrib-accordion', version: '5.3.0', framework: '>=5.8.0' });
+
+  testSuccessWhere('correct version with accordion components and empty course', {
+    fromPlugins: [{ name: 'adapt-contrib-accordion', version: '5.0.0' }],
+    content: [
+      { _id: 'c-100', _component: 'accordion', _items: [{ title: 'item 1' }] },
+      { _id: 'c-105', _component: 'accordion', _items: [{ title: 'item 1' }] },
+      { _type: 'course' }
+    ]
+  });
+
+  testStopWhere('no accordion components', {
+    fromPlugins: [{ name: 'adapt-contrib-accordion', version: '5.0.0' }],
+    content: [{ _component: 'other' }]
+  });
+
+  testStopWhere('incorrect version', {
+    fromPlugins: [{ name: 'adapt-contrib-accordion', version: '5.3.0' }]
+  });
+});