diva.js 6.0.1 → 7.2.3

package/source/js/viewport.js

@@ -1,143 +0,0 @@
-export default class Viewport
-{
-    constructor (outer, options)
-    {
-        options = options || {};
-
-        this.intersectionTolerance = options.intersectionTolerance || 0;
-        this.outer = outer;
-        this._top = this._left = this._width = this._height = this._innerDimensions = null;
-
-        this.invalidate();
-    }
-
-    intersectsRegion (region)
-    {
-        return this.hasHorizontalOverlap(region) && this.hasVerticalOverlap(region);
-    }
-
-    hasVerticalOverlap (region)
-    {
-        const top = this.top - this.intersectionTolerance;
-        const bottom = this.bottom + this.intersectionTolerance;
-
-        return (
-            fallsBetween(region.top, top, bottom) ||
-            fallsBetween(region.bottom, top, bottom) ||
-            (region.top <= top && region.bottom >= bottom)
-        );
-    }
-
-    hasHorizontalOverlap (region)
-    {
-        const left = this.left - this.intersectionTolerance;
-        const right = this.right + this.intersectionTolerance;
-
-        return (
-            fallsBetween(region.left, left, right) ||
-            fallsBetween(region.right, left, right) ||
-            (region.left <= left && region.right >= right)
-        );
-    }
-
-    invalidate ()
-    {
-        // FIXME: Should this check the inner dimensions as well?
-        this._width = this.outer.clientWidth;
-        this._height = this.outer.clientHeight;
-
-        this._top = this.outer.scrollTop;
-        this._left = this.outer.scrollLeft;
-    }
-
-    setInnerDimensions (dimensions)
-    {
-        this._innerDimensions = dimensions;
-
-        if (dimensions)
-        {
-            this._top = clamp(this._top, 0, dimensions.height - this._height);
-            this._left = clamp(this._left, 0, dimensions.width - this._width);
-        }
-    }
-}
-
-Object.defineProperties(Viewport.prototype, {
-    top: getCoordinateDescriptor('top', 'height'),
-    left: getCoordinateDescriptor('left', 'width'),
-
-    width: getDimensionDescriptor('width'),
-    height: getDimensionDescriptor('height'),
-
-    bottom: {
-        get: function ()
-        {
-            return this._top + this._height;
-        }
-    },
-    right: {
-        get: function ()
-        {
-            return this._left + this._width;
-        }
-    }
-});
-
-function getCoordinateDescriptor (coord, associatedDimension)
-{
-    const privateProp = '_' + coord;
-    const source = 'scroll' + coord.charAt(0).toUpperCase() + coord.slice(1);
-
-    return {
-        get: function ()
-        {
-            return this[privateProp];
-        },
-        set: function (newValue)
-        {
-            let normalized;
-
-            if (this._innerDimensions)
-            {
-                const maxAllowed = this._innerDimensions[associatedDimension] - this[associatedDimension];
-                normalized = clamp(newValue, 0, maxAllowed);
-            }
-            else
-            {
-                normalized = clampMin(newValue, 0);
-            }
-
-            this[privateProp] = this.outer[source] = normalized;
-        }
-    };
-}
-
-function getDimensionDescriptor (dimen)
-{
-    return {
-        get: function ()
-        {
-            return this['_' + dimen];
-        }
-    };
-}
-
-function fallsBetween (point, start, end)
-{
-    return point >= start && point <= end;
-}
-
-function clamp (value, min, max)
-{
-    return clampMin(clampMax(value, max), min);
-}
-
-function clampMin (value, min)
-{
-    return Math.max(value, min);
-}
-
-function clampMax (value, max)
-{
-    return Math.min(value, max);
-}

package/test/_setup.js

@@ -1,13 +0,0 @@
-let expect = require('chai').expect;
-global.expect = expect;
-
-let assert = require('chai').assert;
-global.assert = assert;
-
-let wrapper = document.createElement('div');
-wrapper.id = 'parent-wrapper';
-wrapper.setAttribute('style', 'width: 984px; height: 800px');
-let div = document.createElement('div');
-div.id = 'diva-wrapper';
-wrapper.appendChild(div);
-document.body.appendChild(wrapper);

package/test/composite-image_test.js

@@ -1,94 +0,0 @@
-import CompositeImage from '../source/js/composite-image';
-
-describe('Composite Image', function () 
-{
-    it('getTiles(zoomLevel) works properly', function ()
-    {
-        let tileLevels = [
-            dummyTileLevel({ zoomLevel: 2, baseRows: 1, baseCols: 1 }),
-            dummyTileLevel({ zoomLevel: 1, baseRows: 1, baseCols: 1 }),
-            dummyTileLevel({ zoomLevel: 0, baseRows: 1, baseCols: 1 })
-        ];
-
-        let composite = new CompositeImage(tileLevels);
-
-        // Load the really low-res tile
-        composite.updateWithLoadedUrls(getUrls(tileLevels[2].tiles));
-
-        assert.deepEqual(composite.getTiles(2), tileLevels[2].tiles, 'Should load available images');
-
-        let mostOfLevel1 = tileLevels[1].tiles.slice(1);
-        composite.updateWithLoadedUrls(getUrls(mostOfLevel1));
-
-        assert.deepEqual(composite.getTiles(2), [tileLevels[2].tiles[0]].concat(mostOfLevel1),
-            'Should load lower-res tiles if not completely covered (with low-res first)');
-
-        assert.deepEqual(composite.getTiles(0), tileLevels[2].tiles,
-            'Should prefer tiles at the specified zoomLevel, then higher levels, then lower');
-
-        composite.clear();
-        composite.updateWithLoadedUrls(getUrls(tileLevels[2].tiles));
-        let mostOfLevel0 = tileLevels[0].tiles.slice(1);
-        composite.updateWithLoadedUrls(getUrls(mostOfLevel0));
-
-        assert.deepEqual(composite.getTiles(2), [tileLevels[2].tiles[0]].concat(mostOfLevel0),
-            'Should load lower-res tiles across multiple zoom levels if not completely covered');
-    });
-});
-
-function dummyTileLevel(options)
-{
-    let zoomLevel = options.zoomLevel,
-        baseRows = options.baseRows,
-        baseCols = options.baseCols;
-
-    let tiles = [];
-    let scaleRatio = Math.pow(2, zoomLevel);
-
-    for (let baseRow=0; baseRow < baseRows; baseRow++) {
-        for (let baseCol=0; baseCol < baseCols; baseCol++) {
-            tiles.push.apply(tiles, dummyTiles(scaleRatio, baseRow, baseCol));
-        }
-    }
-
-    return {
-        zoomLevel: zoomLevel,
-        rows: baseRows * scaleRatio,
-        cols: baseCols * scaleRatio,
-        tiles: tiles
-    };
-}
-
-function dummyTiles(scaleRatio, baseRow, baseCol)
-{
-    let tiles = [];
-
-    for (let rowOffset=0; rowOffset < scaleRatio; rowOffset++)
-    {
-        for (let colOffset=0; colOffset < scaleRatio; colOffset++)
-        {
-            let row = baseRow * scaleRatio + rowOffset;
-            let col = baseCol * scaleRatio + colOffset;
-
-            let url = 'dummy://ratio/' + scaleRatio + '/' +
-                baseRow + '[' + rowOffset + ']/' +
-                baseCol + '[' + colOffset + ']';
-
-            // FIXME: More fields
-            tiles.push({
-                url: url,
-                row: row,
-                col: col
-            });
-        }
-    }
-
-    return tiles;
-}
-
-function getUrls(tiles) {
-    return tiles.map(function (tile)
-    {
-        return tile.url;
-    });
-}

package/test/diva_test.js

@@ -1,43 +0,0 @@
-import Diva from "../source/js/diva";
-import {
-    DivaParentElementNotFoundException,
-    ObjectDataNotSuppliedException
-} from "../source/js/exceptions";
-
-describe('Viewer', function ()
-{
-    it('should throw an exception if the parent is not found', function ()
-    {
-        let fcn = () => { new Diva('blah', {}); };
-        expect(fcn).to.throw(DivaParentElementNotFoundException);
-    });
-
-    it('should not throw an exception if the parent div is found', () =>
-    {
-        let fcn = () => { new Diva('diva-wrapper', {}); };
-        expect(fcn).to.not.throw(DivaParentElementNotFoundException);
-    });
-
-    it('should allow an element object to be passed in as a parent', () =>
-    {
-        let parent = document.createElement('div');
-        let fcn = () => { new Diva(parent, {}); };
-        expect(fcn).to.not.throw(DivaParentElementNotFoundException);
-    });
-
-    it('should throw an exception if objectData is not supplied', () =>
-    {
-        let parent = document.createElement('div');
-        let fcn = () => { new Diva(parent, {}); };
-        expect(fcn).to.throw(ObjectDataNotSuppliedException);
-    });
-
-    it('should not throw an exception if objectData is supplied', () =>
-    {
-        let parent = document.createElement('div');
-        let fcn = () => { new Diva(parent, {
-            objectData: 'https://example.com/iiif/manifest.json'
-        }); };
-        expect(fcn).to.not.throw(ObjectDataNotSuppliedException);
-    });
-});

package/test/hash-params_test.js

@@ -1,221 +0,0 @@
-import Diva from '../source/js/diva';
-
-// jQuery mimic
-let el = document.getElementById.bind(document);
-
-describe('Hash Params', 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);
-    });
-
-    let testHashParams = function (testName, hashParams, onReadyCallback, config)
-    {
-        it(testName, function (done)
-        {
-            window.location.hash = Object.keys(hashParams).map(function (param)
-            {
-                return param + '=' + hashParams[param];
-            }).join('&');
-
-            let diva = new Diva('diva-wrapper', { // jshint ignore:line
-                objectData: 'https://images.simssa.ca/iiif/manuscripts/cdn-hsmu-m2149l4/manifest.json',
-                hashParamSuffix: config && config.hashParamSuffix ? config.hashParamSuffix : '',
-                enableFilename: config && config.enableFilename ? config.enableFilename : ''
-            });
-
-            Diva.Events.subscribe('ViewerDidLoad', function (settings)
-            {
-                let scroll = {
-                    left: settings.viewportElement.scrollLeft,
-                    top: settings.viewportElement.scrollTop
-                };
-
-                onReadyCallback.call(this, settings, scroll);
-                done();
-            });
-        });
-    };
-
-    testHashParams('works with hashParamSuffix', {vxyz: 'g', f: 'true'}, function (settings)
-    {
-        assert.isOk(settings.inGrid, 'Should read properties with the specified suffix');
-        assert.isOk(!settings.inFullscreen, 'Should not read properties without it');
-    }, {hashParamSuffix: 'xyz'});
-
-    testHashParams("grid view (v)", {v: "g"}, function (settings)
-    {
-        assert.isOk(settings.inGrid, "inGrid setting should be true");
-        assert.strictEqual(el(settings.selector + 'view-menu').children[0].classList[0], 'diva-grid-icon', "Current toolbar view icon should be the grid icon");
-    });
-
-    testHashParams("book view (v)", {v: "b"}, function (settings)
-    {
-        assert.isOk(settings.inBookLayout, "inBookLayout setting should be true");
-        assert.strictEqual(el(settings.selector + 'view-menu').children[0].classList[0], 'diva-book-icon', "Current toolbar view icon should be the book icon");
-        assert.isOk(this.isPageInViewport(0), 'There should be some book pages');
-    });
-
-    testHashParams("invalid view parameter (v) ", {v: "a"}, function (settings)
-    {
-        assert.isFalse(settings.inBookLayout, 'Should not be in book layout');
-        assert.isFalse(settings.inGrid, 'Should also not be in grid layout');
-    });
-
-    testHashParams("fullscreen (f)", {f: "true"}, function (settings)
-    {
-        assert.isOk(settings.inFullscreen, "inFullscreen setting should be true");
-        assert.isOk(document.body.classList.contains('diva-hide-scrollbar'), "The body element should have the hide-scrollbar class");
-    });
-
-    testHashParams("view (v) = 'g' and fullscreen (f)", {v: "g", f: "true"}, function (settings)
-    {
-        assert.isOk(settings.inFullscreen, "inFullscreen setting should be true");
-        assert.isOk(settings.inGrid, "inGrid setting should be true");
-    });
-
-    testHashParams("zoom level (z) - valid value", {z: "3", f: "false"}, function (settings)
-    {
-        assert.strictEqual(settings.zoomLevel, 3, "Initial zoom level should be 3");
-    });
-
-    testHashParams("zoom level (z) - invalid value", {z: "6"}, function (settings)
-    {
-        assert.strictEqual(settings.zoomLevel, 0, "Initial zoom was invalid but >= 0, should be set to the min (0)");
-    });
-
-    testHashParams("zoom level (z) and view (v) = 'g' ", {z: "1", v: "g"}, function (settings)
-    {
-        assert.strictEqual(settings.zoomLevel, 1, "Initial zoom level should be 1");
-        assert.isOk(settings.inGrid, "Should be in grid initially");
-
-        // Now let's switch into document view and see if the zoom level is preserved
-        document.getElementsByClassName('diva-document-icon')[0].click();
-        assert.strictEqual(settings.zoomLevel, 1, "Zoom level setting should still be 1");
-        // zoom level is 0 indexed internally, so setting to 1 should display 2.00
-        assert.strictEqual(el(settings.selector + 'zoom-label').textContent, "Zoom level: 2", "Zoom buttons label should show a zoom level of 2");
-    });
-
-    testHashParams("zoom level (z) and fullscreen (f)", {z: "1", f: "true"}, function (settings)
-    {
-        assert.strictEqual(settings.zoomLevel, 1, "Initial zoom level should be 1");
-        assert.isOk(settings.inFullscreen, "Should be in fullscreen initially");
-
-        // Check that we're actually in fullscreen mode
-        assert.isOk(document.body.classList.contains('diva-hide-scrollbar'), "The body element should have the hide-scrollbar class");
-
-        // Check that the zoom level is actually 1 (second zoom)
-        assert.strictEqual(el(settings.selector + 'zoom-label').textContent, "Zoom level: 2", "Zoom buttons label should show a zoom level of 2");
-    });
-
-    testHashParams("pagesPerRow (n) - valid value", {n: "3"}, function (settings)
-    {
-        assert.strictEqual(settings.pagesPerRow, 3, "Pages per row should be 3 initially");
-    });
-
-    testHashParams("pagesPerRow (n) - invalid value", {n: "1"}, function (settings)
-    {
-        assert.strictEqual(settings.pagesPerRow, 8, "Pages per row should default to the maximum");
-    });
-
-    testHashParams("pagesPerRow (n) and view (v) = 'g'", {n: "3", v: "g"}, function (settings)
-    {
-        assert.strictEqual(settings.pagesPerRow, 3, "Pages per row should be 3 initially");
-        assert.isOk(settings.inGrid, "Should be in grid initially");
-
-        // Check that the pages per row setting is actually 3
-        assert.strictEqual(el(settings.selector + 'grid-label').textContent, "Pages per row: 3", "Grid buttons label should show 3 pages per row");
-    });
-
-    testHashParams("page filename (i) - valid value", {i: "https://images.simssa.ca/iiif/image/cdn-hsmu-m2149l4/cdn-hsmu-m2149l4_003r.jp2"}, function (settings)
-    {
-        assert.strictEqual(settings.activePageIndex, 4, "The initial page should be page 5 (index of 4)");
-    }, {enableFilename: true});
-
-    testHashParams("page filename (i) - invalid value", {i: "https://images.simssa.ca/iiif/image/cdn-hsmu-m2149l4/cdn-hsmu-m2149l4_000r.jp2"}, function (settings)
-    {
-        assert.strictEqual(settings.activePageIndex, 0, "The initial page should just be the first page");
-    }, {enableFilename: true});
-
-    testHashParams("page number (p) - valid value", {p: "6"}, function (settings)
-    {
-        assert.strictEqual(settings.activePageIndex, 5, "The initial page should be page 6 (index of 5)");
-    }, {enableFilename: false});
-
-    testHashParams("page number (p) - invalid value", {p: "600"}, function (settings)
-    {
-        assert.strictEqual(settings.activePageIndex, 0, "The initial page should just be the first page");
-    }, {enableFilename: false});
-
-    testHashParams("page number (p), view = 'g'", {p: "100", v: "g"}, function (settings)
-    {
-        assert.strictEqual(settings.activePageIndex, 99, "The initial page should be 100 (index of 99)");
-        assert.ok(settings.inGrid, "Should be in grid");
-    }, {enableFilename: false});
-
-    testHashParams("horizontal and vertical offsets (x, y) without page specified", {x: 100, y: 200}, function (settings, scroll)
-    {
-        assert.strictEqual(scroll.top, 0, 'y position should not change');
-    });
-
-    testHashParams("vertical offset (y) on first page - positive value", {y: "600", p: "1"}, function (settings, scroll)
-    {
-        assert.strictEqual(scroll.top, 353, "Should have scrolled 353 (600 = top of page - viewport y-center) vertically");
-    });
-
-    testHashParams("vertical offset (y) on first page - negative value", {y: "-600", p: "1"}, function (settings, scroll)
-    {
-        assert.strictEqual(scroll.top, 0, "Should not have scrolled negatively because, well, you can't");
-    });
-    testHashParams("vertical offset (y) and page number (p)", {y: 500, p: "50"}, function (settings, scroll)
-    {
-        let expectedTopScroll = 44994;
-        assert.strictEqual(settings.activePageIndex, 49, "Current page should be 50 (index of 49)");
-        assert.strictEqual(scroll.top, expectedTopScroll, "Should be heightAbovePages + 500 pixels of scroll from the top + page y-center");
-
-        // Check that the horizontal scroll hasn't been weirdly affected
-        let expectedLeftScroll = 0; // no scrollbar at this zoom level
-        assert.strictEqual(scroll.left, expectedLeftScroll, "Horizontal scroll should just center it");
-    }, {enableFilename: false, zoomLevel: 2});
-
-    testHashParams("horizontal offset (x) on first page - positive value", {x: "100", p: "1"}, function (settings, scroll)
-    {
-        // FIXME: https://github.com/DDMAL/diva.js/issues/331
-        assert.strictEqual(scroll.left, 0, "Horizontal scroll should center it + 100 pixels to the right");
-    });
-
-    testHashParams("horizontal offset (x) on first page - negative value", {x: "-100", p: "1"}, function (settings, scroll)
-    {
-        // FIXME: https://github.com/DDMAL/diva.js/issues/331
-        assert.strictEqual(scroll.left, 0, "Horizontal scroll should center it + 100 pixels to the left");
-    });
-
-    testHashParams("horizontal offset (x) and page number (p)", {x: 100, p: "50"}, function (settings, scroll)
-    {
-        // FIXME: https://github.com/DDMAL/diva.js/issues/331
-        let expectedTopScroll = 44741;
-        assert.strictEqual(scroll.top, expectedTopScroll, "vertical scroll should be just to page 50");
-        assert.strictEqual(scroll.left, 0, "Horizontal scroll should center it + 100 pixels to the right");
-    }, {enableFilename: false});
-
-    testHashParams("horizontal offset (x), vertical offset (y), page number (p)", {x: 100, y: 200, p: "50"}, function (settings, scroll)
-    {
-        // FIXME: https://github.com/DDMAL/diva.js/issues/331
-        let expectedTopScroll = 44694;
-        assert.strictEqual(scroll.top, expectedTopScroll, "vertical scroll should be to page 50 + 200 + page y-center");
-        assert.strictEqual(scroll.left, 0, "Horizontal scroll should center it + 100 pixels to the right");
-    }, {enableFilename: false});
-});

package/test/image-cache_test.js

@@ -1,106 +0,0 @@
-'use strict';
-
-import ImageCache from '../source/js/image-cache';
-
-describe('Image Cache', function () 
-{
-    it('Default max entries is 100', function ()
-    {
-        let cache = new ImageCache();
-        assert.strictEqual(cache.maxKeys, 100);
-    });
-
-    it('Evicts the least recently used entry', function ()
-    {
-        let cache = new ImageCache({ maxKeys: 2 });
-
-        let imgA = new Image();
-        let imgB = new Image();
-        let imgC = new Image();
-
-        cache.put('A', imgA);
-        cache.put('B', imgB);
-        cache.put('C', imgC);
-
-        assert.strictEqual(cache.has('A'), false, 'A evicted [has]');
-        assert.strictEqual(cache.has('B'), true, 'B remains [has]');
-        assert.strictEqual(cache.has('C'), true, 'C remains [has]');
-
-        assert.strictEqual(cache.get('A'), null, 'A evicted [get]');
-        assert.strictEqual(cache.get('B'), imgB, 'B remains [get]');
-        assert.strictEqual(cache.get('C'), imgC, 'C remains [get]');
-
-        cache.put('A', imgA);
-        assert.strictEqual(cache.has('A'), true, 'A restored [has v2]');
-        assert.strictEqual(cache.has('B'), false, 'B evicted [has v2]');
-        assert.strictEqual(cache.has('C'), true, 'C remains [has v2]');
-    });
-
-    it('Put overwrites existing entries and bumps their LRU position', function ()
-    {
-        let cache = new ImageCache({ maxKeys: 2 });
-
-        let imgA = new Image();
-        let imgA2 = new Image();
-        let imgB = new Image();
-        let imgC = new Image();
-
-        cache.put('A', imgA);
-        cache.put('B', imgB);
-        cache.put('A', imgA2);
-        cache.put('C', imgC);
-
-        assert.strictEqual(cache.get('A'), imgA2, 'A overwritten, still in cache');
-        assert.strictEqual(cache.get('B'), null, 'B evicted');
-        assert.strictEqual(cache.get('C'), imgC, 'C still in cache');
-    });
-
-    it("Entries which have been acquire()'d are promoted", function ()
-    {
-        let cache = new ImageCache({ maxKeys: 2 });
-
-        let imgA = new Image();
-        let imgB = new Image();
-        let imgC = new Image();
-
-        cache.put('A', imgA);
-        cache.put('B', imgB);
-
-        cache.acquire('A');
-        cache.release('A');
-
-        cache.put('C', imgC); // A would be evicted here if not promoted
-
-        assert.strictEqual(cache.has('A'), true, 'A remains');
-        assert.strictEqual(cache.has('B'), false, 'B evicted');
-        assert.strictEqual(cache.has('C'), true, 'C remains');
-    });
-
-    it("Entries which have been acquire()'d are not evicted until released", function ()
-    {
-        let cache = new ImageCache({ maxKeys: 2 });
-
-        let imgA = new Image();
-        let imgB = new Image();
-        let imgC = new Image();
-
-        cache.put('A', imgA);
-        cache.acquire('A');
-
-        cache.put('B', imgB);
-        cache.acquire('B');
-
-        cache.put('C', imgC); // A would be evicted here if not held
-
-        assert.strictEqual(cache.has('A'), true, 'A remains');
-        assert.strictEqual(cache.has('B'), true, 'B remains');
-        assert.strictEqual(cache.has('C'), true, 'C still entered');
-
-        cache.release('B'); // B will be evicted even though it still has priority over A
-
-        assert.strictEqual(cache.has('A'), true, 'A still remains (held)');
-        assert.strictEqual(cache.has('B'), false, 'B evicted');
-        assert.strictEqual(cache.has('C'), true, 'C still remains (by LRU policy)');
-    });
-
-});

package/test/main.js

@@ -1,6 +0,0 @@
-
-const srcContext = require.context('../source/js', true, /\.js$/);
-srcContext.keys().forEach(srcContext);
-
-const testsContext = require.context('.', true, /\.js$/);
-testsContext.keys().forEach(testsContext);