diva.js 6.0.2 → 7.2.3

package/test/utils/elt_test.js

@@ -1,102 +0,0 @@
-import {elt} from '../../source/js/utils/elt';
-
-describe('elt util', function () 
-{
-    it("elt() function works", function ()
-    {
-        // Serialize node type and text content (not attributes, because those are more complicated)
-        var serialize = function (node)
-        {
-            if (node.nodeName === '#text')
-                return node.textContent;
-
-            return {
-                name: node.nodeName.toLowerCase(),
-                childNodes: Array.prototype.map.call(node.childNodes, serialize)
-            };
-        };
-
-        var simple = elt('span');
-        var expectedSimple = { name: 'span', childNodes: [] };
-        assert.deepEqual(serialize(simple), expectedSimple, 'It should create nodes with the given tag');
-
-        var withNull = elt('span', null, undefined);
-        var expectedWithNull = { name: 'span', childNodes: [] };
-        assert.deepEqual(serialize(withNull), expectedWithNull, 'It should ignore null and undefined values');
-
-        var withText = elt('span', 'A', 'B');
-        var expectedWithText = { name: 'span', childNodes: ['A', 'B'] };
-        assert.deepEqual(serialize(withText), expectedWithText, 'It should add additional string arguments as text');
-
-        var withArray = elt('ol', [
-            elt('li', 'first'),
-            elt('li', 'second'),
-            [
-                elt('li', 'more'),
-                elt('li', 'and more')
-            ]
-        ]);
-        var expectedWithArray = {
-            name: 'ol',
-            childNodes: [
-                { name: 'li', childNodes: ['first'] },
-                { name: 'li', childNodes: ['second'] },
-                { name: 'li', childNodes: ['more'] },
-                { name: 'li', childNodes: ['and more'] }
-            ]
-        };
-        assert.deepEqual(serialize(withArray), expectedWithArray, 'It should recurse on nested arrays');
-
-        var withOther = elt('span', 2, false);
-        var expectedWithOther = { name: 'span', childNodes: ['2', 'false'] };
-        assert.deepEqual(serialize(withOther), expectedWithOther, 'It should coerce other arguments to strings');
-
-        var link = elt('a',
-            { href: 'http://example.org/', title: 'overridden' },
-            'Hello world!',
-            { title: 'additional argument' }
-        );
-        var expectedLink = {
-            name: 'a',
-            childNodes: ['Hello world!']
-        };
-        assert.strictEqual(link.href, 'http://example.org/', 'It should set attributes from object arguments');
-        assert.strictEqual(link.title, 'additional argument', 'It should handle multiple attribute arguments');
-        assert.deepEqual(serialize(link), expectedLink, 'It should handle children along with attribute arguments');
-
-        var fragment = document.createDocumentFragment();
-        fragment.appendChild(document.createTextNode(', very'));
-
-        var compound = elt('span',
-            'This is ', elt('em', 'very'), fragment, document.createTextNode(' exciting')
-        );
-        var expectedCompound = {
-            name: 'span',
-            childNodes: [
-                'This is ',
-                {
-                    name: 'em',
-                    childNodes: ['very']
-                },
-                ', very',
-                ' exciting'
-            ]
-        };
-        assert.deepEqual(serialize(compound), expectedCompound, 'It should append DOM node arguments');
-
-        var hidden = elt('span', {
-            style: { display: 'none' }
-        });
-        assert.strictEqual(hidden.style.display, 'none', 'It should handle objects for the style attribute');
-
-        var hiddenAsText = elt('span', {
-            style: 'display: none;'
-        });
-        assert.strictEqual(hiddenAsText.style.display, 'none', 'It should handle strings for the style attribute');
-
-        var nullStyle = elt('span', {
-            style: null
-        });
-        assert.strictEqual(nullStyle.style.cssText, '', 'It should ignore a null style');
-    });
-});

package/test/utils/events_test.js

@@ -1,245 +0,0 @@
-'use strict';
-
-import {Events} from '../../source/js/utils/events';
-
-describe('Events', function ()
-{
-    it('subscribe(topic, callback[, instanceID])', function ()
-    {
-        var events = Events;
-
-        var callback = function () {};
-        assert.deepEqual(events.subscribe('Topic', callback), ['Topic', callback], 'Global callback handles should have no scope');
-        assert.deepEqual(events.subscribe('Topic', callback, 'A'), ['Topic', callback, 'A'], 'Scoped callback handles should have a scope');
-    });
-
-    it('publish(topic[, args])', function ()
-    {
-        var events = Events;
-        var calls = [];
-
-        events.subscribe('MyTopic', function ()
-        {
-            calls.push(['callback 1', this, Array.prototype.slice.call(arguments)]);
-        });
-
-        events.subscribe('MyTopic', function ()
-        {
-            calls.push(['callback 2', this, Array.prototype.slice.call(arguments)]);
-        });
-
-        events.subscribe('MyTopic', function ()
-        {
-            calls.push(['scoped callback', this, Array.prototype.slice.call(arguments)]);
-        }, 'some scope');
-
-        events.publish('OtherTopic', []);
-        events.publish('MyTopic', [1, 2, 3]);
-        events.publish('MyTopic');
-
-        assert.deepEqual(calls, [
-            ['callback 1', null, [1, 2, 3]],
-            ['callback 2', null, [1, 2, 3]],
-            ['callback 1', null, []],
-            ['callback 2', null, []]
-        ], 'Global callbacks should be called for the topic with the arguments in the order subscribed');
-    });
-
-    it('publish(topic, args, scope)', function ()
-    {
-        var scopeID = '1000';
-
-        var scopeObject = {
-            getInstanceId: function ()
-            {
-                return scopeID;
-            }
-        };
-
-        var events = Events;
-        var calls = [];
-
-        events.subscribe('MyTopic', function ()
-        {
-            calls.push(['global callback', this, Array.prototype.slice.call(arguments)]);
-        });
-
-        events.subscribe('MyTopic', function ()
-        {
-            calls.push(['scoped callback', this, Array.prototype.slice.call(arguments)]);
-        }, scopeID);
-
-        events.subscribe('MyTopic', function ()
-        {
-            calls.push(['global callback after scoped', this, Array.prototype.slice.call(arguments)]);
-        });
-
-        events.subscribe('MyTopic', function ()
-        {
-            calls.push(['irrelevant callback', this, Array.prototype.slice.call(arguments)]);
-        }, 'irrelevant');
-
-        events.publish('OtherTopic', ['should not be called'], scopeObject);
-        events.publish('MyTopic', [1, 2, 3], scopeObject);
-        events.publish('MyTopic', null, scopeObject); // Null arguments should work
-
-        assert.deepEqual(calls, [
-            ['global callback', scopeObject, [1, 2, 3]],
-            ['global callback after scoped', scopeObject, [1, 2, 3]],
-            ['scoped callback', scopeObject, [1, 2, 3]],
-            ['global callback', scopeObject, []],
-            ['global callback after scoped', scopeObject, []],
-            ['scoped callback', scopeObject, []]
-        ], 'Global and relevant scoped callbacks should be called, with globals first');
-
-        calls = [];
-
-        var invalidScope = null;
-
-        events.publish('MyTopic', [3, 2, 1], invalidScope);
-
-        // I don't know if this is really desirable behaviour, but it's what happens
-        assert.deepEqual(calls, [
-            ['global callback', invalidScope, [3, 2, 1]],
-            ['global callback after scoped', invalidScope, [3, 2, 1]]
-        ], 'Only global callbacks should be called for invalid scope objects');
-    });
-
-    it('unsubscribe(Array<topic, callback[, instanceId]>[, completely])', function ()
-    {
-        var events = Events;
-        events.unsubscribeAll();
-
-        var callback = function () {};
-        var otherCallback = function () {};
-
-        events.subscribe('MyTopic', callback);
-        events.subscribe('MyTopic', otherCallback);
-        events.subscribe('MyTopic', callback, 'some scope');
-        events.subscribe('MyTopic', otherCallback, 'some scope');
-        events.subscribe('MyTopic', callback, 'another scope');
-        events.subscribe('MyTopic', otherCallback, 'another scope');
-
-        assert.deepEqual(getTestSubscriptions(), {
-            'global': [callback, otherCallback],
-            'some scope': [callback, otherCallback],
-            'another scope': [callback, otherCallback]
-        }, 'The callbacks should be subscribed (sanity check)');
-
-        assert.ok(events.unsubscribe(['MyTopic', callback]), 'It should return true if events are unsubscribed');
-        assert.ok(!events.unsubscribe(['MyTopic', callback, 'unknown']), 'It should return false if the scope is unknown');
-        assert.ok(!events.unsubscribe(['Blueberries', callback]), 'It should return false if the topic is unknown');
-
-        assert.deepEqual(getTestSubscriptions(), {
-            'global': [otherCallback],
-            'some scope': [callback, otherCallback],
-            'another scope': [callback, otherCallback]
-        }, 'The global callback should be removed');
-
-        assert.ok(!events.unsubscribe(['MyTopic', callback]), 'It should return false if no events are unsubscribed');
-
-        events.unsubscribe(['MyTopic', callback, 'some scope']);
-
-        assert.deepEqual(getTestSubscriptions(), {
-            'global': [otherCallback],
-            'some scope': [otherCallback],
-            'another scope': [callback, otherCallback]
-        }, 'The relevant scoped callback should be removed');
-
-        assert.ok(events.unsubscribe(['MyTopic', callback, 'another scope'], true), 'It should return true if events are unsubscribed (completely)');
-        assert.ok(!events.unsubscribe(['MyTopic', callback, 'another scope'], true), 'It should return false if no events are unsubscribed (completely)');
-
-        assert.deepEqual(getTestSubscriptions(), {
-            'global': [otherCallback],
-            'some scope': [otherCallback],
-            'another scope': []
-        }, 'All scoped callbacks should be removed when `completely` is true');
-
-        events.unsubscribe(['MyTopic', callback], true);
-
-        assert.deepEqual(getTestSubscriptions(), {
-            'global': [],
-            'some scope': [otherCallback],
-            'another scope': []
-        }, 'All global callbacks should be removed when `completely` is true');
-
-        function getTestSubscriptions()
-        {
-            return {
-                'global': subscriptions(events, 'MyTopic'),
-                'some scope': subscriptions(events, 'MyTopic', 'some scope'),
-                'another scope': subscriptions(events, 'MyTopic', 'another scope')
-            };
-        }
-    });
-
-    it('unsubscribeAll([instanceID])', function ()
-    {
-        var events = Events;
-        events.unsubscribeAll();
-
-        var callback = function () {};
-
-        events.subscribe('MyTopic', callback);
-        events.subscribe('MyTopic', callback, 'some scope');
-        events.subscribe('MyTopic', callback, 'another scope');
-
-        assert.deepEqual(getTestSubscriptions(), {
-            'global': [callback],
-            'some scope': [callback],
-            'another scope': [callback]
-        }, 'The callbacks should be subscribed (sanity check)');
-
-        events.unsubscribeAll('some scope');
-
-        assert.deepEqual(getTestSubscriptions(), {
-            'global': [callback],
-            'some scope': [],
-            'another scope': [callback]
-        }, 'All topics for the scope should be unsubscribed');
-
-        events.unsubscribeAll('this is not actually a scope');
-
-        assert.deepEqual(getTestSubscriptions(), {
-            'global': [callback],
-            'some scope': [],
-            'another scope': [callback]
-        }, 'Unsubscribing from an unknown topic should not blow things up');
-
-        events.unsubscribeAll();
-
-        assert.deepEqual(getTestSubscriptions(), {
-            'global': [],
-            'some scope': [],
-            'another scope': []
-        }, 'Unsubscribing without a topic should clear everything');
-
-        function getTestSubscriptions()
-        {
-            return {
-                'global': subscriptions(events, 'MyTopic'),
-                'some scope': subscriptions(events, 'MyTopic', 'some scope'),
-                'another scope': subscriptions(events, 'MyTopic', 'another scope')
-            };
-        }
-    });
-
-    /** Reach into an events instance to check private state **/
-    function subscriptions(events, topic, instanceID)
-    {
-        if (typeof instanceID === 'undefined')
-            instanceID = 'global';
-
-        var topicSubs = events._cache[topic];
-
-        if (!topicSubs)
-            return [];
-
-        var instanceSubs = topicSubs[instanceID];
-
-        if (!instanceSubs)
-            return [];
-
-        return instanceSubs.slice();
-    }
-});

package/test/utils/hash-params_test.js

@@ -1,79 +0,0 @@
-import HashParams from '../../source/js/utils/hash-params';
-
-describe('HashParams', function ()
-{
-    it("HashParams.get", function ()
-    {
-        // First try it with no hash params - should return false
-        assert.ok(!HashParams.get('anything'), "No hash params, should return false");
-
-        // Now set the current URL to something
-        window.location.hash = '#p=149&z=2';
-        var nonexistentParam = HashParams.get('lol');
-        var firstParam = HashParams.get('p');
-        var secondParam = HashParams.get('z');
-        assert.ok(!nonexistentParam, "The nonexistent param should return false");
-        assert.strictEqual(firstParam, '149', "The 'p' param should be 149 (string)");
-        assert.strictEqual(secondParam, '2', "The 'z' param should be 2 (string)");
-
-        // Now let there be only one element in the URL
-        window.location.hash = '#p=149';
-        var soleParam = HashParams.get('p');
-        assert.strictEqual(soleParam, '149', "The 'p' param should be 149 when it is the sole param");
-
-        // Now let there be other elements in the URL
-        window.location.hash = '#z=2&p=100&lol=lol';
-        var anotherFirstParam = HashParams.get('z');
-        var anotherSecondParam = HashParams.get('p');
-        var thirdParam = HashParams.get('lol');
-        assert.strictEqual(anotherFirstParam, '2', "The 'z' param should be '2' when it is the first param");
-        assert.strictEqual(anotherSecondParam, '100', "The 'p' param should be '100' when it is the middle param");
-        assert.strictEqual(thirdParam, 'lol', "The last param should be 'lol'");
-        window.location.hash = '';
-    });
-
-    it("HashParams.update", function ()
-    {
-        window.location.hash = '';
-        // First try it with no hash params in the URL
-        HashParams.update('p', '1');
-        assert.strictEqual(window.location.hash, '#p=1');
-
-        // The key is present but there is no value
-        window.location.hash = '#p=';
-        HashParams.update('p', '2');
-        assert.strictEqual(window.location.hash, '#p=2');
-
-        // Then, with a bunch of irrelevant ones
-        window.location.hash = '#key=2&another=3';
-        HashParams.update('p', '3');
-        assert.strictEqual(window.location.hash, '#key=2&another=3&p=3');
-
-        // One irrelevant one
-        window.location.hash = '#a=b';
-        HashParams.update('p', '4');
-        assert.strictEqual(window.location.hash, '#a=b&p=4');
-
-        // Only one hash param, and it's the one we want to update
-        window.location.hash = '#p=1';
-        HashParams.update('p', '9001');
-        assert.strictEqual(window.location.hash, '#p=9001');
-
-        // Two hash params, one of which is the one we want to update
-        window.location.hash = '#p=4&h=1';
-        HashParams.update('p', '1');
-        assert.strictEqual(window.location.hash, '#p=1&h=1');
-        HashParams.update('h', '100');
-        assert.strictEqual(window.location.hash, '#p=1&h=100');
-
-        // Two hash params, both are which are right (choose one)
-        // Should never happen unless the user is being malicious
-        window.location.hash = '#p=4&p=2';
-        HashParams.update('p', '5');
-        assert.strictEqual(window.location.hash, '#p=4&p=5');
-        // Not actually sure why it chooses the first one to update
-
-        // Restore the URL
-        window.location.hash = '';
-    });
-});

package/test/utils/parse-label-value_test.js

@@ -1,45 +0,0 @@
-import parseLabelValue from '../../source/js/utils/parse-label-value';
-
-describe('Parse Label Value', function ()
-{
-    it('Should parse object -> array -> objects', function ()
-    {
-        let key = {
-            "label" : "Date",
-            "value" : [ 
-                {
-                    "@value" : "1101-1125"
-                }, {
-                    "@value" : "1301-1400"
-                } 
-            ]
-        };
-
-        let obj = parseLabelValue(key);
-
-        assert.strictEqual(obj.label, 'Date', 'Label should be "Date"');
-        assert.strictEqual(obj.value, '1101-1125, 1301-1400', 'Value should be the date string');
-    });
-
-    it('Should parse object -> array', function ()
-    {
-        let key = {
-            "label": {
-                "en": [
-                    "Date Statement"
-                ]
-            },
-            "value": {
-                "en": [
-                    "1401",
-                    "1500"
-                ]
-            }
-        };
-
-        let obj = parseLabelValue(key);
-
-        assert.strictEqual(obj.label, 'Date Statement', 'Label should be "Date Statement"');
-        assert.strictEqual(obj.value, '1401, 1500', 'Value should be the date string');
-    });
-});

package/test/z_plugins_test.js

@@ -1,180 +0,0 @@
-import Diva from '../source/js/diva';
-
-let v3Manifest = require('./manifests/iiifv3.json');
-
-describe('Plugins', function ()
-{
-    beforeEach(function ()
-    {
-        // reset event subscription so only current test is subscribed
-        Diva.Events.unsubscribeAll();
-
-        // recreate diva instance
-        let oldWrapper = document.getElementById('parent-wrapper');
-        oldWrapper.parentNode.removeChild(oldWrapper);
-        let newWrapper = document.createElement('div');
-        newWrapper.id = 'parent-wrapper';
-        newWrapper.setAttribute('style', 'width: 984px;');
-        let div = document.createElement('div');
-        div.id = 'diva-wrapper';
-        newWrapper.appendChild(div);
-        document.body.appendChild(newWrapper);
-    }); 
-
-    //METADATA PLUGIN
-    it('Metadata plugin is created when added as a Diva plugin', function (done)
-    {
-        Diva.Events.subscribe('ViewerDidLoad', function ()
-        {
-            let icon = document.getElementsByClassName('diva-metadata-icon')[0];
-            assert.isNotNull(icon, 'Metadata icon should exist');
-            done();
-        });
-
-        let diva = new Diva('diva-wrapper', { // jshint ignore:line
-            objectData: 'https://images.simssa.ca/iiif/manuscripts/cdn-hsmu-m2149l4/manifest.json',
-            plugins: [Diva.MetadataPlugin]
-        });
-    });
-
-    it('Metadata div can be opened and closed', function (done) 
-    {
-        Diva.Events.subscribe('ViewerDidLoad', function ()
-        {
-            let icon = document.getElementsByClassName('diva-metadata-icon')[0];
-
-            assert.isNull(document.getElementById('metadataDiv'), 'Metadata div should not exist yet');
-
-            icon.click();
-
-            let div = document.getElementById('metadataDiv');
-            assert.isNotNull(div, 'Metadata div should exist');
-
-            icon.click();
-            assert.strictEqual(div.style.display, 'none', 'Div should be hidden');
-
-            icon.click(); 
-            document.getElementsByClassName('close-button')[0].click();
-            assert.strictEqual(div.style.display, 'none', 'Div should be hidden from close button');
-
-            // trigger drag events
-            icon.click();
-            let e = new Event('mousedown');
-            div.dispatchEvent(e);
-            e = new Event('mousemove');
-            document.dispatchEvent(e);
-            e = new Event('mouseup');
-            document.dispatchEvent(e);
-            icon.click();
-
-            done();
-        });
-
-        let diva = new Diva('diva-wrapper', { // jshint ignore:line
-            objectData: 'https://images.simssa.ca/iiif/manuscripts/cdn-hsmu-m2149l4/manifest.json',
-            plugins: [Diva.MetadataPlugin]
-        });
-    });
-
-    // hard to test dragging the element with just javascript, skipping
-
-    // DOWNLOAD PLUGIN
-    it('Download plugin is created when added as a Diva plugin', function (done)
-    {
-        Diva.Events.subscribe('ViewerDidLoad', function ()
-        {
-            let icon = document.getElementsByClassName('diva-download-icon')[0];
-            assert.isNotNull(icon, 'Download icon should exist');
-            done();
-        });
-
-        let diva = new Diva('diva-wrapper', { // jshint ignore:line
-            objectData: 'https://images.simssa.ca/iiif/manuscripts/cdn-hsmu-m2149l4/manifest.json',
-            plugins: [Diva.DownloadPlugin]
-        });
-    });
-
-    it('Download icon can be clicked', function (done)
-    {
-        Diva.Events.subscribe('ViewerDidLoad', function ()
-        {
-            let icon = document.getElementsByClassName('diva-download-icon')[0];
-            icon.click();
-            done();
-        });
-
-        let diva = new Diva('diva-wrapper', { // jshint ignore:line
-            objectData: 'https://images.simssa.ca/iiif/manuscripts/cdn-hsmu-m2149l4/manifest.json',
-            plugins: [Diva.DownloadPlugin]
-        });
-    });
-
-    // MANIPULATION PLUGIN
-    it('Manipulation plugin is created when added as a Diva plugin', function (done)
-    {
-        Diva.Events.subscribe('ViewerDidLoad', function ()
-        {
-            let icon = document.getElementsByClassName('diva-manipulation-icon')[0];
-            assert.isNotNull(icon, 'Manipulation icon should exist');
-            done();
-        });
-
-        let diva = new Diva('diva-wrapper', { // jshint ignore:line
-            objectData: 'https://images.simssa.ca/iiif/manuscripts/cdn-hsmu-m2149l4/manifest.json',
-            plugins: [Diva.ManipulationPlugin]
-        });
-    });
-
-    it('Manipulation controls can be used', function (done)
-    {
-        Diva.Events.subscribe('ViewerDidLoad', function ()
-        {
-            let icon = document.getElementsByClassName('diva-manipulation-icon')[0];
-            icon.click();
-
-            let controls = document.getElementsByClassName('manipulation-tools-mobile')[0];
-            assert.isNotNull(controls, 'Controls exist once icon is clicked');
-
-            // give main image some time to load
-            setTimeout(() =>
-            {
-                // do all control related tests
-                let view = document.getElementsByClassName('manipulation-main-area-mobile')[0];
-
-                let event = new MouseEvent('dblclick', {
-                    'view': window,
-                    'bubbles': true,
-                    'cancelable': true
-                });
-
-                view.dispatchEvent(event);
-
-                let zoomSlider = document.getElementById('zoom-slider');
-                assert.strictEqual(zoomSlider.value, '2', 'Zoom should now be 2');
-
-                // click on hamburger
-                document.getElementsByClassName('burger-menu')[0].click();
-
-                // click on first color filter button (grayscale rn)
-                document.getElementsByClassName('color-filters')[0].click();
-                let log = document.getElementById('filter-log');
-
-                // change select to threshold
-                let select = document.getElementById('filter-select');
-                select.value = 'threshold';
-                event = new Event('change');
-                select.dispatchEvent(event);
-                assert.isFalse(log.innerText.includes('Grayscale'), 'Log should be reset');
-
-                done();
-            }, 1000);
-        });
-
-        let diva = new Diva('diva-wrapper', { // jshint ignore:line
-            objectData: v3Manifest,
-            plugins: [Diva.ManipulationPlugin]
-        });
-    });
-
-    // hard to test dragging the sliders to manipulate the image with just javascript, skipping
-});