@internetarchive/bookreader 5.0.0-11-multiple-files → 5.0.0-110

package/tests/plugins/plugin.autoplay.test.js

@@ -1,52 +0,0 @@
-
-import BookReader from '../../src/BookReader.js';
-import '../../src/plugins/plugin.autoplay.js';
-
-
-let br;
-beforeEach(() => {
-  document.body.innerHTML = '<div id="BookReader">';
-  br = new BookReader();
-  br.init();
-});
-
-afterEach(() => {
-  jest.clearAllMocks();
-});
-
-describe('Plugin: Menu Toggle', () => {
-  test('has option flag', () => {
-    expect(BookReader.defaultOptions.enableAutoPlayPlugin).toEqual(true);
-  });
-  test('has added BR property: auto', () => {
-    expect(br).toHaveProperty('auto');
-    expect(br.auto).toEqual(false);
-  });
-  test('has added BR property: autoTimer', () => {
-    expect(br).toHaveProperty('autoTimer');
-    expect(br.autoTimer).toEqual(null);
-  });
-  test('has added BR property: flipDelay', () => {
-    expect(br).toHaveProperty('flipDelay');
-    expect(br.flipDelay).toBeTruthy();
-    expect(br.flipDelay).toBeGreaterThan(1);
-  });
-  test('autoplay does not start when BookReaderInitializes', () => {
-    br.autoToggle = jest.fn();
-    br.init();
-    expect(br.autoToggle).toHaveBeenCalledTimes(0);
-  });
-  test('autoplay will run without `flipSpeed` parameters', () => {
-    const initialAutoTimer = br.autoTimer;
-    br.flipFwdToIndex = jest.fn();
-    br.autoStop = jest.fn();
-    br.init();
-    br.autoToggle();
-    // internally referenced functions that fire
-    expect(br.flipFwdToIndex).toHaveBeenCalledTimes(1);
-
-    expect(initialAutoTimer).toBeFalsy();
-    // br.autoTimer changes when autoToggle turns on
-    expect(br.autoTimer).toBeTruthy();
-  });
-});

package/tests/plugins/plugin.chapters.test.js

@@ -1,130 +0,0 @@
-import sinon from 'sinon';
-
-import BookReader from '../../src/BookReader.js';
-import '../../src/plugins/plugin.mobile_nav.js';
-import '../../src/plugins/plugin.chapters.js';
-
-const SAMPLE_TOC = [{
-  "pagenum": "3",
-  "level": 1,
-  "label": "CHAPTER I",
-  "type": {"key": "/type/toc_item"},
-  "title": "THE COUNTRY AND THE MISSION 1",
-  "pageIndex": 3,
-},{
-  "pagenum": "17",
-  "level": 1,
-  "label": "CHAPTER II",
-  "type": {"key": "/type/toc_item"},
-  "title": "THE COUNTRY AND THE MISSION 2",
-  "pageIndex": 17,
-},
-{
-  "pagenum": "undefined",
-  "level": 1,
-  "label": "CHAPTER III",
-  "type": {"key": "/type/toc_item"},
-  "title": "THE COUNTRY AND THE MISSION 3",
-  "pageIndex": undefined,
-},
-{
-  "pagenum": "40",
-  "level": 1,
-  "label": "CHAPTER IV",
-  "type": {"key": "/type/toc_item"},
-  "title": "THE COUNTRY AND THE MISSION 4",
-  "pageIndex": 40,
-}];
-
-const SAMPLE_TOC_UNDEF = [
-  {
-    "pagenum": "undefined",
-    "level": 1,
-    "label": "CHAPTER I",
-    "type": {"key": "/type/toc_item"},
-    "title": "THE COUNTRY AND THE MISSION 1",
-    "pageIndex": undefined,
-  },
-  {
-    "pagenum": "undefined",
-    "level": 1,
-    "label": "CHAPTER II",
-    "type": {"key": "/type/toc_item"},
-    "title": "THE COUNTRY AND THE MISSION 2",
-    "pageIndex": undefined,
-  }
-]
-
-let br;
-beforeEach(() => {
-  $.ajax = jest.fn().mockImplementation((args) => {
-    return Promise.resolve([{
-      table_of_contents: SAMPLE_TOC,
-    }]);
-  });
-  document.body.innerHTML = '<div id="BookReader">';
-  br = new BookReader();
-});
-
-afterEach(() => {
-  jest.clearAllMocks();
-});
-
-describe('Plugin: Menu Toggle', () => {
-  test('has option flag', () => {
-    expect(BookReader.defaultOptions.enableChaptersPlugin).toEqual(true);
-  });
-  test('has added BR property: olHost', () => {
-    expect(br).toHaveProperty('olHost');
-    expect(br.olHost).toBeTruthy();
-  });
-  test('has added BR property: bookId', () => {
-    expect(br).toHaveProperty('bookId');
-    expect(br.bookId).toBeFalsy();
-  });
-  test('fetches OL Book Record on init', () => {
-    br.getOpenLibraryRecord = jest.fn();
-    br.init();
-    expect(br.getOpenLibraryRecord).toHaveBeenCalled();
-  });
-  test('Updates Table of Contents when available', () => {
-    br.init();
-    expect($.ajax).toHaveBeenCalled();
-  });
-});
-
-describe('updateTOCState', () => {
-
-  beforeEach(() => {
-    window.HTMLElement.prototype.scrollIntoView = sinon.stub();
-    //Sinon is not used because this function is imported from BookModel with exposeOverrideableMethod()
-    //which has a getter and setter
-    br.getPageIndex = (str) => parseFloat(str);
-    br.init();
-  });
-
-  test('Test page is one of TOC', () => {
-    br.updateTOCState(20, SAMPLE_TOC);
-    expect($('li.BRtable-contents-el')[1].classList.contains('current-chapter'));
-  });
-
-  test('Only one element has .current-chapter', () => {
-    br.updateTOCState(9, SAMPLE_TOC);
-    expect($('li.BRtable-contents-el.current-chapter').length).toBe(1);
-  })
-
-  test('No chapter has .current-chapter if current index is < than any chapter index', () => {
-    br.updateTOCState(1, SAMPLE_TOC);
-    expect($('li.BRtable-contents-el.current-chapter').length).toBe(0);
-  })
-
-  test('if current index == chapter index ', () => {
-    br.updateTOCState(17, SAMPLE_TOC);
-    expect($('li.BRtable-contents-el')[1].classList.contains('current-chapter'));
-  })
-
-  test('No chapter has .current-chapter if all chapter have undefined pageIndex ', () => {
-    br.updateTOCState(10, SAMPLE_TOC_UNDEF);
-    expect($('li.BRtable-contents-el.current-chapter').length).toBe(0);
-  })
-});

package/tests/plugins/plugin.iframe.test.js

@@ -1,42 +0,0 @@
-import sinon from 'sinon';
-
-import BookReader from '../../src/BookReader.js';
-import { _attachEventListeners } from '../../src/plugins/plugin.iframe.js';
-
-afterEach(() => {
-  sinon.restore();
-});
-
-test('listens for br events if parent', () => {
-  const br = new BookReader();
-  sinon.spy(br, 'bind');
-  sinon.spy(window, 'addEventListener');
-
-  _attachEventListeners(br, window.parent);
-  expect(br.bind.callCount).toBe(1);
-  expect(window.addEventListener.callCount).toBe(1);
-  expect(window.addEventListener.args[0][0]).toBe('message');
-});
-
-test('does not attach if not in iframe', () => {
-  const br = new BookReader();
-  sinon.spy(br, 'bind');
-  sinon.spy(window, 'addEventListener');
-
-  _attachEventListeners(br, null);
-  expect(br.bind.callCount).toBe(0);
-  expect(window.addEventListener.callCount).toBe(0);
-});
-
-test('updates params when window receives a message', () => {
-  const br = new BookReader();
-  sinon.spy(br, 'updateFromParams');
-  _attachEventListeners(br);
-  window.dispatchEvent(new MessageEvent('message', {
-    data: {
-      type: 'bookReaderFragmentChange',
-      fragment: ''
-    }
-  }));
-  expect(br.updateFromParams.callCount).toBe(1);
-});

package/tests/plugins/plugin.mobile_nav.test.js

@@ -1,66 +0,0 @@
-
-import BookReader from '../../src/BookReader.js';
-import '../../src/plugins/plugin.mobile_nav.js';
-
-/** @type {BookReader} */
-let br;
-beforeEach(() => {
-  document.body.innerHTML = '<div id="BookReader">';
-  br = new BookReader();
-  br.init();
-});
-
-afterEach(() => {
-  jest.clearAllMocks();
-});
-
-describe('Plugin: Mobile Nav', () => {
-  test('has option flag', () => {
-    expect(BookReader.defaultOptions.enableMobileNav).toEqual(true);
-  });
-  test('has added BR property: mobileNavTitle', () => {
-    expect(br).toHaveProperty('mobileNavTitle');
-    expect(br.mobileNavTitle).toBeTruthy();
-  });
-  test('has added BR property: mobileNavFullscreenOnly', () => {
-    expect(br).toHaveProperty('mobileNavFullscreenOnly');
-    expect(br.mobileNavFullscreenOnly).toEqual(false);
-  });
-  test('has a referenced copy of nav in BookReader', () => {
-    expect(br.refs).toHaveProperty('$mmenu');
-  });
-  test('draws toolbar on init', () => {
-    let callCount = 0;
-    // Since we have a custom setter set in utils/classes.js, we can't
-    // use regular spying; need to "override" the function with a watcher.
-    BookReader.prototype.initToolbar = function(_super) {
-      return function() {
-        callCount++;
-        _super.apply(this, arguments);
-      }
-    }(BookReader.prototype.initToolbar);
-    const br = new BookReader();
-    br.init();
-    expect(callCount).toBe(1);
-  });
-  test('sets a class on body to signal it has attached', () => {
-    expect($(document.body).hasClass('BRbodyMobileNavEnabled')).toEqual(true);
-  });
-  test('loads the navbar on init', () => {
-    expect($('#BRmobileMenu')).toHaveLength(1)
-  });
-  test('There is a Settings Section', () => {
-    expect($('.BRmobileMenu__settings')).toHaveLength(1);
-  });
-  test('There is a More Info Section', () => {
-    expect($('.BRmobileMenu__moreInfoRow')).toHaveLength(1);
-  });
-  test('There is a Sharing Section', () => {
-    expect($('.BRmobileMenu__share')).toHaveLength(1);
-  });
-  test('clicking on hamburger opens menu', () => {
-    expect($('html').hasClass('mm-opened')).toEqual(false);
-    $('.BRmobileHamburger').click();
-    expect($('html').hasClass('mm-opened')).toEqual(true);
-  });
-});

package/tests/plugins/plugin.resume.test.js

@@ -1,98 +0,0 @@
-import BookReader from '../../src/BookReader.js';
-import '../../src/plugins/plugin.resume.js';
-
-import sinon from 'sinon';
-import * as docCookies from '../../src/util/docCookies.js';
-
-let br;
-beforeAll(() => {
-  document.body.innerHTML = '<div id="BookReader">';
-  br = new BookReader();
-  br.init();
-});
-
-afterEach(() => {
-  jest.clearAllMocks();
-  sinon.restore();
-});
-
-describe('Plugin: Remember Current Page in Cookies', () => {
-  test('has default option flag', () => {
-    expect(BookReader.defaultOptions.enablePageResume).toEqual(true);
-    expect(BookReader.defaultOptions.resumeCookiePath).toEqual(null);
-  });
-
-  test('has added BR property: getResumeValue', () => {
-    expect(br).toHaveProperty('getResumeValue');
-  });
-
-  test('has added BR property: updateResumeValue', () => {
-    expect(br).toHaveProperty('updateResumeValue');
-  });
-});
-
-describe('updateResumeValue', () => {
-  /* Mark 2020-05-02
-    Skipping while confirming with Neeraj
-    I'm not sure:
-    - What this test really does
-    - If the instantiation of the prototype counts as a call
-    - If so, why would there be a second call
-    Can't find in production
-    In this branch .toHaveBeenCalledTimes() === 1
-  */
-  test.skip('starts when BookReaderInit is called', () => {
-    br.updateResumeValue = jest.fn();
-    br.init();
-    expect(br.updateResumeValue).toHaveBeenCalledTimes(2);
-  });
-
-  test('handles cookieName=null', () => {
-    const { updateResumeValue } = BookReader.prototype;
-    const setItemSpy = sinon.spy(docCookies, 'setItem');
-    const fakeBr = { options: { resumeCookiePath: '/details/goody' } };
-
-    updateResumeValue.call(fakeBr, 16);
-    expect(setItemSpy.callCount).toBe(1);
-    expect(setItemSpy.args[0].slice(0, 2)).toEqual(['br-resume', 16]);
-    expect(setItemSpy.args[0][3]).toEqual('/details/goody');
-  });
-
-  test('handles resumeCookiePath not set', () => {
-    const setItemSpy = sinon.spy(docCookies, 'setItem');
-    // Save function
-    const saveFn = br.getCookiePath;
-    br.getCookiePath = jest.fn(() => '/details/foo');
-    br.updateResumeValue(16);
-    expect(setItemSpy.args[0][3]).toEqual('/details/foo');
-    // Restore function
-    br.getCookiePath = saveFn;
-  });
-
-  test('handles cookie path from URL with decoration', () => {
-    const complexPathWithPage = '/details/2008ELMValidityStudyFinalReportRevised/Executive%20Summary%20for%20the%20EPT%26ELM%20Validity%20Studie_20100603%20-%20Copy/page/n1/mode/2up';
-    const complexPath = '/details/2008ELMValidityStudyFinalReportRevised/Executive%20Summary%20for%20the%20EPT%26ELM%20Validity%20Studie_20100603%20-%20Copy';
-    expect(br.getCookiePath(complexPathWithPage))
-      .toEqual(complexPath);
-
-    expect(br.getCookiePath('/details/item/mode/1up'))
-      .toEqual('/details/item');
-
-    expect(br.getCookiePath('/details/item/inside/a/long/path/model/is/used'))
-      .toEqual('/details/item/inside/a/long/path/model/is/used');
-
-    expect(br.getCookiePath('/details/item/inside/a/long/path/mode/is/used'))
-      .toEqual('/details/item/inside/a/long/path');
-  });
-
-  test('handles cookie path from URL with no decoration', () => {
-    expect(br.getCookiePath('/details/item'))
-      .toEqual('/details/item');
-
-    expect(br.getCookiePath('/details/item/'))
-      .toEqual('/details/item/');
-
-    expect(br.getCookiePath('/details/item/almost/any/kind/of/long/path'))
-      .toEqual('/details/item/almost/any/kind/of/long/path');
-  });
-});

package/tests/plugins/plugin.text_selection.test.js

@@ -1,203 +0,0 @@
-import sinon from 'sinon';
-
-import '../../src/BookReader.js';
-import { BookreaderWithTextSelection, TextSelectionPlugin, Cache } from '../../src/plugins/plugin.text_selection.js';
-
-
-/** @type {BookReader} */
-
-// djvu.xml book infos copied from https://ia803103.us.archive.org/14/items/goodytwoshoes00newyiala/goodytwoshoes00newyiala_djvu.xml
-const FAKE_XML_1WORD = `<OBJECT data="file://localhost//tmp/derive/goodytwoshoes00newyiala//goodytwoshoes00newyiala.djvu" height="3192" type="image/x.djvu" usemap="goodytwoshoes00newyiala_0001.djvu" width="2454">
-<PARAGRAPH><LINE><WORD coords="1216,2768,1256,2640">test</WORD></LINE></PARAGRAPH>
-</OBJECT>`;
-const FAKE_XML_MULT_WORDS = `<OBJECT data="file://localhost//tmp/derive/goodytwoshoes00newyiala//goodytwoshoes00newyiala.djvu" height="3192" type="image/x.djvu" usemap="goodytwoshoes00newyiala_0001.djvu" width="2454">
-<PARAGRAPH><LINE><WORD coords="1216,2768,1256,2640">test1</WORD>
-<WORD coords="1400,2768,1500,2640">test2</WORD>
-<WORD coords="1600,2768,1700,2640">test3</WORD></LINE></PARAGRAPH></OBJECT>`;
-const FAKE_XML_5COORDS = `<OBJECT data="file://localhost//tmp/derive/goodytwoshoes00newyiala//goodytwoshoes00newyiala.djvu" height="3192" type="image/x.djvu" usemap="goodytwoshoes00newyiala_0001.djvu" width="2454">
-<PARAGRAPH><LINE><WORD coords="1216,2768,1256,2640,2690">test</WORD></LINE></PARAGRAPH></OBJECT>`;
-const FAKE_XML_EMPTY = '';
-
-describe("Generic tests", () => {
-  let br;
-  beforeEach(() => {
-    document.body.innerHTML = '<div id="BookReader">';
-    br = new BookreaderWithTextSelection({
-      data: [
-        [
-          { width: 800, height: 1200,
-            uri: '//archive.org/download/BookReader/img/page001.jpg' },
-        ],
-        [
-          { width: 800, height: 1200,
-            uri: '//archive.org/download/BookReader/img/page002.jpg' },
-          { width: 800, height: 1200,
-            uri: '//archive.org/download/BookReader/img/page003.jpg' },
-        ],
-        [
-          { width: 800, height: 1200,
-            uri: '//archive.org/download/BookReader/img/page004.jpg' },
-          { width: 800, height: 1200,
-            uri: '//archive.org/download/BookReader/img/page005.jpg' },
-        ]
-      ],
-    });
-    br.init();
-  });
-
-  test("_createPageContainer overridden function still creates a BRpagecontainer element", () => {
-    const spy = sinon.spy(br.textSelectionPlugin, 'createTextLayer');
-    sinon.stub(br.textSelectionPlugin, "getPageText")
-      .returns($(new DOMParser().parseFromString(FAKE_XML_1WORD, "text/xml")));
-    const container = br._createPageContainer(1, {});
-    expect(container).toBeTruthy();
-    expect(spy.callCount).toBe(1);
-  });
-
-  // test loading first object from sample data
-  test("_createPageContainer handles index 0", () => {
-    const spy = sinon.spy(br.textSelectionPlugin, 'createTextLayer');
-    br._createPageContainer(0, {});
-    expect(spy.callCount).toBe(1);
-  });
-
-  // test loading last object from sample data
-  test("_createPageContainer handles index -1", () => {
-    const spy = sinon.spy(br.textSelectionPlugin, 'createTextLayer');
-    br._createPageContainer(-1, {});
-    expect(spy.callCount).toBe(0);
-  });
-
-  test("createTextLayer will render the last page and create text layer properly", async () => {
-    const $container = br.refs.$brContainer;
-    sinon.stub(br.textSelectionPlugin, "getPageText")
-      .returns($(new DOMParser().parseFromString(FAKE_XML_1WORD, "text/xml")));
-    const pageIndex = br.data.length - 1
-    await br.textSelectionPlugin.createTextLayer(pageIndex, $container);
-    expect($container.find(".textSelectionSVG").length).toBe(1);
-    expect($container.find(".BRparagElement").length).toBe(1);
-  });
-
-  test("createTextLayer will not create text layer if there are too many words", async () => {
-    const $container = br.refs.$brContainer;
-    const xml = FAKE_XML_1WORD.replace(/<WORD.*<\/WORD>/, FAKE_XML_1WORD.match(/<WORD.*<\/WORD>/)[0].repeat(3000));
-    sinon.stub(br.textSelectionPlugin, "getPageText")
-      .returns($(new DOMParser().parseFromString(xml, "text/xml")));
-    await br.textSelectionPlugin.createTextLayer(0, $container);
-    expect($container.find(".textSelectionSVG").length).toBe(0);
-    expect($container.find(".BRparagElement").length).toBe(0);
-    expect($container.find(".BRwordElement").length).toBe(0);
-  });
-
-  // GRRRR!!! This is a useful test :( But can't get it working for some reason,
-  // and the error output is super cryptic.
-  test.skip("createTextLayer will not create text layer if index is more than total number of book pages", async () => {
-    const $container = br.refs.$brContainer;
-    await br.textSelectionPlugin.createTextLayer(150, $container);
-    expect($container.find(".textSelectionSVG").length).toBe(0);
-    expect($container.find(".BRparagElement").length).toBe(0);
-    expect($container.find(".BRwordElement").length).toBe(0);
-  });
-
-  test("createTextLayer creates an svg layer with paragraph with 1 word element", async () => {
-    const $container = br.refs.$brContainer;
-    sinon.stub(br.textSelectionPlugin, "getPageText")
-      .returns($(new DOMParser().parseFromString(FAKE_XML_1WORD, "text/xml")));
-    await br.textSelectionPlugin.createTextLayer(1, $container);
-    expect($container.find(".textSelectionSVG").length).toBe(1);
-    expect($container.find(".BRparagElement").length).toBe(1);
-    expect($container.find(".BRwordElement").length).toBe(1);
-    expect($container.find(".BRwordElement").text()).toBe("test");
-  });
-
-  test("createTextLayer creates an svg layer with paragraph with multiple word elements", async () => {
-    const $container = br.refs.$brContainer;
-    sinon.stub(br.textSelectionPlugin, "getPageText")
-      .returns($(new DOMParser().parseFromString(FAKE_XML_MULT_WORDS, "text/xml")));
-    await br.textSelectionPlugin.createTextLayer(2, $container);
-    expect($container.find(".textSelectionSVG").length).toBe(1);
-    expect($container.find(".BRparagElement").length).toBe(1);
-    expect($container.find(".BRwordElement").length).toBe(5);
-    expect($container.find(".BRwordElement").last()).not.toBe(" ");
-  });
-
-  test("createTextLayer creates an svg layer with paragraph with word with 5 params coordinates", async () => {
-    const $container = br.refs.$brContainer;
-    sinon.stub(br.textSelectionPlugin, "getPageText")
-      .returns($(new DOMParser().parseFromString(FAKE_XML_5COORDS, "text/xml")));
-    await br.textSelectionPlugin.createTextLayer(3, $container);
-    expect($container.find(".textSelectionSVG").length).toBe(1);
-    expect($container.find(".BRparagElement").length).toBe(1);
-    expect($container.find(".BRwordElement").length).toBe(1);
-  });
-
-  test("createTextLayer can handle empty xml", async () => {
-    const $container = br.refs.$brContainer;
-    sinon.stub(br.textSelectionPlugin, "getPageText")
-      .returns($(new DOMParser().parseFromString(FAKE_XML_EMPTY, "text/xml")));
-    await br.textSelectionPlugin.createTextLayer(4, $container);
-    expect($container.find(".textSelectionSVG").length).toBe(1);
-    expect($container.find(".BRparagElement").length).toBe(0);
-    expect($container.find(".BRwordElement").length).toBe(0);
-  });
-
-  const LONG_PRESS_DURATION = 500;
-  test("calling stopPageFlip does not allow long click to flip the page", () => {
-    const $container = br.refs.$brContainer;
-    br.textSelectionPlugin.stopPageFlip($container);
-    const currIndex = br.currentIndex();
-    $container.find("BRwordElement").mousedown();
-    // Waits for long press
-    setTimeout(() => {
-      $container.find("BRwordElement").mousedown();
-      // Waits for flipping animation
-      setTimeout(() => {
-        expect(br.currentIndex()).toBe(currIndex);
-      }, 2000);
-    }, LONG_PRESS_DURATION);
-  });
-})
-
-describe("textSelectionPlugin constructor", () => {
-  test("textSelectionPlugin constructor with firefox browser", () => {
-    const tsp = new TextSelectionPlugin({}, {}, true)
-    expect(tsp.djvuPagesPromise).toBe(null);
-    expect(tsp.svgParagraphElement).toBe("g");
-    expect(tsp.svgWordElement).toBe("text");
-  });
-
-  test("textSelectionPlugin constructor not on firefox browser", () => {
-    const tsp = new TextSelectionPlugin({}, {}, false)
-    expect(tsp.djvuPagesPromise).toBe(null);
-    expect(tsp.svgParagraphElement).toBe("text");
-    expect(tsp.svgWordElement).toBe("tspan");
-  });
-});
-
-describe("Cache", () => {
-  test('Adding works', () => {
-    const c = new Cache(10);
-    c.add(35);
-    expect(c.entries).toEqual([35]);
-  });
-
-  test('Size does not grow beyond limit', () => {
-    const c = new Cache(2);
-    c.add(35);
-    c.add(32);
-    c.add(12);
-    c.add(11);
-    c.add(112);
-    expect(c.entries).toHaveLength(2);
-  });
-
-  test('Oldest evicted first', () => {
-    const c = new Cache(2);
-    c.add(35);
-    c.add(32);
-    c.add(12);
-    c.add(12);
-    c.add(10);
-    expect(c.entries).toEqual([12, 10]);
-  });
-});