@internetarchive/bookreader 5.0.0-12-fixsorting-8 → 5.0.0-121

package/tests/karma/BookNavigator/volumes/volumes.test.js

@@ -1,98 +0,0 @@
-import {
-  html,
-  fixture,
-  expect,
-  fixtureCleanup,
-} from '@open-wc/testing';
-import sinon from 'sinon';
-import '../../../../src/BookNavigator/volumes/volumes.js';
-
-
-const brOptions = {
-  "options": {
-    "enableMultipleBooks": true,
-    "multipleBooksList": {
-      "by_subprefix": {
-        "/details/SubBookTest": {
-          "url_path": "/details/SubBookTest",
-          "file_subprefix": "book1/GPORFP",
-          "orig_sort": 0,
-          "title": "book1/GPORFP.pdf",
-          "file_source": "/book1/GPORFP_jp2.zip"
-        },
-        "/details/SubBookTest/subdir/book2/brewster_kahle_internet_archive": {
-          "url_path": "/details/SubBookTest/subdir/book2/brewster_kahle_internet_archive",
-          "file_subprefix": "subdir/book2/brewster_kahle_internet_archive",
-          "orig_sort": 1,
-          "title": "subdir/book2/brewster_kahle_internet_archive.pdf",
-          "file_source": "/subdir/book2/brewster_kahle_internet_archive_jp2.zip"
-        },
-        "/details/SubBookTest/subdir/subsubdir/book3/Rfp008011ResponseInternetArchive-without-resume": {
-          "url_path": "/details/SubBookTest/subdir/subsubdir/book3/Rfp008011ResponseInternetArchive-without-resume",
-          "file_subprefix": "subdir/subsubdir/book3/Rfp008011ResponseInternetArchive-without-resume",
-          "orig_sort": 2,
-          "title": "subdir/subsubdir/book3/Rfp008011ResponseInternetArchive-without-resume.pdf",
-          "file_source": "/subdir/subsubdir/book3/Rfp008011ResponseInternetArchive-without-resume_jp2.zip"
-        }
-      }
-    }
-  }
-};
-
-const container = (brOptions, prefix) => (
-  html`
-    <viewable-files .viewableFiles=${brOptions} .hostUrl="https://archive.org" .subPrefix=${prefix}></viewable-files>
-  `
-);
-
-beforeEach(() => {
-  const body = document.querySelector('body');
-  const brHook = document.createElement('div');
-  brHook.setAttribute('id', 'BookReader');
-  body.appendChild(brHook);
-});
-
-afterEach(() => {
-  sinon.restore();
-  fixtureCleanup();
-});
-
-describe('<viewable-files>', () => {
-  it('sets default properties', async () => {
-    const files = brOptions.options.multipleBooksList?.by_subprefix;
-    const viewableFiles = Object.keys(files).map(item => files[item]);
-    const el = await fixture(container(viewableFiles));
-    await el.updateComplete;
-
-    expect(el.viewableFiles).to.equal(viewableFiles);
-    expect(el.viewableFiles.length).to.equal(3);
-    expect(el.shadowRoot.querySelectorAll("ul li").length).to.equal(3);
-
-    expect(el.shadowRoot.querySelector(".item-title").innerText).to.include(`${viewableFiles[0].title}`);
-  });
-
-  it('render empty volumes', async () => {
-    const viewableFiles = [];
-    const el = await fixture(container(viewableFiles));
-    await el.updateComplete;
-
-    expect(el.viewableFiles).to.equal(viewableFiles);
-    expect(el.viewableFiles.length).to.equal(0);
-    expect(el.shadowRoot.childElementCount).to.equal(0);
-  });
-
-  it('render active volume item set as first viewable item ', async () => {
-    const files = brOptions.options.multipleBooksList?.by_subprefix;
-    const viewableFiles = Object.keys(files).map(item => files[item]);
-    const prefix = viewableFiles[0].file_subprefix;
-
-    const el = await fixture(container(viewableFiles, prefix));
-    await el.updateComplete;
-
-    expect(el.viewableFiles).to.equal(viewableFiles);
-    expect(el.viewableFiles.length).to.equal(3);
-
-    expect(el.shadowRoot.querySelectorAll("ul li div")[1].className).to.equal("content active");
-  });
-
-});

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

@@ -1,68 +0,0 @@
-
-import BookReader from '../../../src/BookReader.js';
-import '../../../src/plugins/menu_toggle/plugin.menu_toggle.js';
-
-
-let br;
-let hideFlag;
-beforeAll(() => {
-  $.fx.off = true;
-  const OGSpeed = $.speed;
-  $.speed = function(_speed, easing, callback) {
-    return OGSpeed(0, easing, callback);
-  };
-  document.body.innerHTML = '<div id="BookReader">';
-  br = new BookReader();
-  br.init();
-});
-
-afterEach(() => {
-  $.fx.off = false;
-  jest.clearAllMocks();
-});
-
-describe('Plugin: Menu Toggle', () => {
-  test('has option flag', () => {
-    expect(BookReader.defaultOptions.enableMenuToggle).toEqual(true);
-  });
-
-  test('core code has animation consts', () => {
-    expect(BookReader.constNavAnimationDuration).toEqual(300);
-    expect(BookReader.constResizeAnimationDuration).toEqual(100);
-  });
-
-  test('core code has registered event: `navToggled`', () => {
-    expect(BookReader.eventNames.navToggled).toBeTruthy();
-  });
-
-  test('when bookreader loads, the menu shows', () => {
-    expect($('.BRfooter').hasClass('js-menu-hide')).toEqual(false);
-    expect($('.BRtoolbar').hasClass('js-menu-hide')).toEqual(false);
-  });
-
-  test('clicking on background hides the menu', () => {
-    expect($('.BRfooter').hasClass('js-menu-hide')).toEqual(false);
-    expect($('.BRtoolbar').hasClass('js-menu-hide')).toEqual(false);
-    $('.BRcontainer').click();
-    expect($('.BRfooter').hasClass('js-menu-hide')).toEqual(true);
-    expect($('.BRtoolbar').hasClass('js-menu-hide')).toEqual(true);
-  });
-
-  test('core function `setNavigationView` is called `hideNavigation` is called', () => {
-    br.setNavigationView = jest.fn((arg) => hideFlag = arg);
-
-    br.hideNavigation();
-    expect(br.setNavigationView).toHaveBeenCalled();
-    expect(hideFlag).toEqual(true);
-  });
-
-  test('core function `setNavigationView` is called `showNavigation` is called', () => {
-    br.setNavigationView = jest.fn((arg) => hideFlag = arg);
-    br.navigationIsVisible = jest.fn(() => false);
-
-    br.showNavigation();
-    expect(br.setNavigationView).toHaveBeenCalled();
-    expect(br.navigationIsVisible).toHaveBeenCalled();
-    expect(hideFlag).toEqual(undefined);
-  });
-});

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

@@ -1,23 +0,0 @@
-import sinon from 'sinon';
-import BookReader from '../../src/BookReader.js';
-import '../../src/plugins/plugin.archive_analytics.js';
-
-describe('archiveAnalyticsSendEvent', () => {
-  const sendEvent = BookReader.prototype.archiveAnalyticsSendEvent;
-
-  test('logs if debug set to true', () => {
-    const stub = sinon.stub(console, 'log');
-    const FAKE_BR = { options: { enableArchiveAnalytics: true, debugArchiveAnaltyics: true }};
-    sendEvent.call(FAKE_BR);
-    expect(stub.callCount).toBe(1);
-    stub.restore();
-  });
-
-  test('Does not error if window.archive_analytics is undefined', () => {
-    const spy = sinon.spy(sendEvent);
-    const FAKE_BR = { options: { enableArchiveAnalytics: true }};
-    spy.call(FAKE_BR);
-    expect(spy.threw()).toBe(false);
-  });
-});
-

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');
-  });
-});