@internetarchive/bookreader 5.0.0-9-multiple-files → 5.0.0-90

package/tests/karma/BookNavigator/book-navigator.test.js

@@ -1,132 +0,0 @@
-import {
-  html,
-  elementUpdated,
-  fixtureCleanup,
-  fixtureSync,
-  expect,
-} from '@open-wc/testing';
-import sinon from 'sinon';
-
-import '../../../src/BookNavigator/BookNavigator.js';
-import BRFullscreenMgr from '../../../src/BookNavigator/br-fullscreen-mgr.js';
-
-const container = () => {
-  const item = {};
-  return html`
-    <book-navigator
-      .item=${item}
-      .baseHost
-    >
-      <div slot="bookreader">
-        <p class="visible-in-reader">now showing</p>
-      <div>
-      <p class="bunny">foo</p>
-      </
-  `;
-}
-
-beforeEach(() => {
-  const body = document.querySelector('body');
-  const brHook = document.createElement('div');
-  brHook.setAttribute('id', 'BookReader');
-  body.appendChild(brHook);
-});
-
-afterEach(() => {
-  window.br = null;
-  fixtureCleanup();
-});
-
-
-describe('<book-navigator>', () => {
-  describe('first update', () => {
-    it('binds global event listeners', async () => {
-      const el = fixtureSync(container());
-      const spy = sinon.spy(el, 'bindEventListeners');
-      await elementUpdated(el);
-      expect(spy.callCount).to.equal(1);
-    });
-    it('emits a BrBookNav:PostInit event', async () => {
-      let initEventFired = false;
-      window.addEventListener('BrBookNav:PostInit', (e) => {
-        initEventFired = true;
-      });
-      const el = fixtureSync(container());
-      const spy = sinon.spy(el, 'emitPostInit');
-      await elementUpdated(el);
-
-      expect(initEventFired).to.be.true;
-      expect(spy.callCount).to.equal(1);
-    });
-  });
-
-  it('handles global event: BookReader:PostInit', async () => {
-    const setTimeoutSpy = sinon.spy(window, 'setTimeout');
-    const brStub = {
-      resize: sinon.fake(),
-      currentIndex: sinon.fake(),
-      jumpToIndex: sinon.fake(),
-      el: '#BookReader'
-    };
-
-    const el = fixtureSync(container());
-    const initializeBookSubmenus = sinon.spy(el, 'initializeBookSubmenus');
-
-    await elementUpdated(el);
-    window.dispatchEvent(new CustomEvent('BookReader:PostInit', {
-      detail: { props: brStub }
-    }));
-    await elementUpdated(el);
-
-    expect(initializeBookSubmenus.callCount).to.equal(1);
-    expect(el.bookreader).to.equal(brStub); // sets bookreader
-    expect(el.bookReaderLoaded).to.be.true; // notes bookreader is loaded
-    expect(el.bookReaderCannotLoad).to.be.false;
-    expect(el.fullscreenMgr).to.an.instanceof(BRFullscreenMgr);
-    expect(el.brResizeObserver).to.an.instanceof(window.ResizeObserver);
-    expect(setTimeoutSpy.callCount).to.equal(1); // resizes at end
-  });
-
-  it('resizes bookreader when side menu toggles', async () => {
-    const el = fixtureSync(container());
-    const brStub = {
-      resize: sinon.fake(),
-      currentIndex: sinon.fake(),
-      jumpToIndex: sinon.fake()
-    }
-    el.bookreader = brStub;
-    await elementUpdated(el);
-
-    el.sideMenuOpen = true;
-    await elementUpdated(el);
-
-    expect(el.bookreader.resize.callCount).to.equal(1);
-    expect(el.bookreader.currentIndex.callCount).to.equal(1);
-    expect(el.bookreader.jumpToIndex.callCount).to.equal(1);
-
-    el.sideMenuOpen = false;
-    await elementUpdated(el);
-
-    expect(el.bookreader.resize.callCount).to.equal(2);
-    expect(el.bookreader.currentIndex.callCount).to.equal(2);
-    expect(el.bookreader.jumpToIndex.callCount).to.equal(2);
-  });
-  it('does not resize bookreader if animating', async () => {
-    const el = fixtureSync(container());
-    const brStub = {
-      animating: true, // <-- testing for this
-      resize: sinon.fake(),
-      currentIndex: sinon.fake(),
-      jumpToIndex: sinon.fake()
-    }
-    el.bookreader = brStub;
-    await elementUpdated(el);
-
-    el.sideMenuOpen = true;
-    await elementUpdated(el);
-
-    expect(el.bookreader.resize.callCount).to.equal(0);
-    expect(el.bookreader.currentIndex.callCount).to.equal(0);
-    expect(el.bookreader.jumpToIndex.callCount).to.equal(0);
-  });
-});

package/tests/karma/BookNavigator/visual-adjustments.test.js

@@ -1,201 +0,0 @@
-import {
-  html,
-  fixture,
-  expect,
-  oneEvent,
-} from '@open-wc/testing';
-import sinon from 'sinon';
-import { IABookVisualAdjustments } from '../../../src/BookNavigator/visual-adjustments/visual-adjustments.js';
-
-const options = [{
-  id: 'contrast',
-  name: 'Adjust contrast',
-  active: true,
-  min: 0,
-  max: 150,
-  step: 1,
-  value: 100,
-}, {
-  id: 'invert',
-  name: 'Invert colors',
-  active: false,
-}, {
-  id: 'brightness',
-  name: 'Adjust brightness',
-  active: false,
-  value: 100,
-}];
-
-const container = (renderHeader = false) => (
-  html`<ia-book-visual-adjustments .options=${options} ?renderHeader=${renderHeader}></ia-book-visual-adjustments>`
-);
-
-describe('<ia-book-visual-adjustments>', () => {
-  afterEach(() => {
-    sinon.restore();
-  });
-
-  it('sets default properties', async () => {
-    const el = await fixture(container());
-
-    expect(el.options).to.exist;
-    expect(el.options.length).to.equal(options.length);
-    expect(el.renderHeader).to.exist;
-    expect(el.renderHeader).to.be.false;
-    expect(el.activeCount).to.exist;
-    expect(el.showZoomControls).to.be.true;
-  });
-
-  it('renders all properties of a visual adjustment option', async () => {
-    const el = await fixture(container());
-
-    await el.updateComplete;
-
-    const label = el.shadowRoot.querySelector('label');
-    const name = label.querySelector('.name');
-    const checkbox = label.querySelector('input');
-    expect(name.innerText).to.equal(options[0].name);
-    expect(checkbox.checked).to.equal(true);
-  });
-
-  it('can render header with active options count', async () => {
-    const renderHeader = true;
-    const el = await fixture(container(renderHeader));
-    expect(el.shadowRoot.querySelector('header p').innerText).to.include('1');
-  });
-
-  it('does not render active options count element when none are selected', async () => {
-    const el = await fixture(container());
-
-    el.options = [options[1]];
-    await el.updateComplete;
-
-    expect(el.shadowRoot.querySelector('header p')).not.to.exist;
-  });
-
-  it('changes option\'s active state when input changed', async () => {
-    const el = await fixture(container());
-
-    el.shadowRoot.querySelector('li input').dispatchEvent(new Event('change'));
-    await el.updateComplete;
-
-    expect(el.options[0].active).to.equal(false);
-  });
-
-  it('renders zoom in and out controls when enabled', async () => {
-    const el = await fixture(container());
-
-    expect(el.shadowRoot.querySelector('.zoom_out')).to.exist;
-    expect(el.shadowRoot.querySelector('.zoom_in')).to.exist;
-  });
-
-  it('does not render zoom controls when disabled', async () => {
-    const el = await fixture(container());
-
-    el.showZoomControls = false;
-    await el.updateComplete;
-
-    expect(el.shadowRoot.querySelector('.zoom_out')).not.to.exist;
-    expect(el.shadowRoot.querySelector('.zoom_in')).not.to.exist;
-  });
-
-  describe('Custom events', () => {
-    it('prepareEventDetails returns proper params', async () => {
-      const el = await fixture(container());
-      await el.updateComplete;
-      const params = el.prepareEventDetails();
-
-      expect(params.activeCount).to.exist;
-      expect(typeof (params.activeCount)).to.be.equal('number');
-      expect(params.changedOptionId).to.exist;
-      expect(typeof (params.changedOptionId)).to.be.equal('string');
-      expect(params.options).to.exist;
-      expect(params.options.length).to.exist;
-      expect(params.options.length).to.be.greaterThan(0);
-    });
-    it('emitOptionChangedEvent calls for the params', async () => {
-      IABookVisualAdjustments.prototype.prepareEventDetails = sinon.fake();
-      const el = await fixture(container());
-      await el.updateComplete;
-
-      expect(el.prepareEventDetails.callCount).to.equal(1);
-    });
-    it('triggers an emitOptionChangedEvent event at firstUpdate', async () => {
-      IABookVisualAdjustments.prototype.emitOptionChangedEvent = sinon.fake();
-      const el = await fixture(container());
-
-      expect(el.emitOptionChangedEvent.callCount).to.equal(1);
-    });
-
-    it('triggers an emitOptionChangedEvent event when a checkbox\'s change event fires', async () => {
-      IABookVisualAdjustments.prototype.emitOptionChangedEvent = sinon.fake();
-      const el = await fixture(container());
-
-      expect(el.emitOptionChangedEvent.callCount).to.equal(1); // firstUpdate fire
-
-      el.shadowRoot.querySelector('li input').dispatchEvent(new Event('change'));
-      expect(el.emitOptionChangedEvent.callCount).to.equal(2);
-    });
-
-    it('triggers an emitOptionChangedEvent event when a range\'s change event fires', async () => {
-      IABookVisualAdjustments.prototype.emitOptionChangedEvent = sinon.fake();
-
-      const el = await fixture(container());
-      expect(el.emitOptionChangedEvent.callCount).to.equal(1); // firstUpdate fire
-
-      el.shadowRoot.querySelector('[name="brightness_range"]').dispatchEvent(new Event('change'));
-      expect(el.emitOptionChangedEvent.callCount).to.equal(2);
-    });
-
-    it('emits a zoom out event when zoom out button clicked', async () => {
-      const el = await fixture(container());
-
-      setTimeout(() => (
-        el.shadowRoot.querySelector('.zoom_out').click()
-      ));
-      const response = await oneEvent(el, 'visualAdjustmentZoomOut');
-
-      expect(response).to.exist;
-    });
-
-    it('emits a zoom in event when zoom in button clicked', async () => {
-      const el = await fixture(container());
-
-      setTimeout(() => (
-        el.shadowRoot.querySelector('.zoom_in').click()
-      ));
-      const response = await oneEvent(el, 'visualAdjustmentZoomIn');
-
-      expect(response).to.exist;
-    });
-  });
-
-  it('sets range defaults when none supplied', async () => {
-    const el = await fixture(container());
-    const brightnessRange = el.shadowRoot.querySelector('[name="brightness_range"]');
-
-    expect(brightnessRange.getAttribute('min')).to.equal('0');
-    expect(brightnessRange.getAttribute('max')).to.equal('100');
-    expect(brightnessRange.getAttribute('step')).to.equal('1');
-  });
-
-  it('sets the updated range value on the options prop', async () => {
-    const el = await fixture(container());
-    const { id } = options[0];
-    const newValue = 120;
-
-    el.setRangeValue(id, newValue);
-    await el.updateComplete;
-
-    expect(el.options[0].value).to.equal(newValue);
-  });
-
-  it('triggers a setRangeValue event when a range\'s input event fires', async () => {
-    IABookVisualAdjustments.prototype.setRangeValue = sinon.fake();
-
-    const el = await fixture(container());
-
-    el.shadowRoot.querySelector('[name="brightness_range"]').dispatchEvent(new Event('input'));
-    expect(el.setRangeValue.callCount).to.equal(1);
-  });
-});

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

@@ -1,133 +0,0 @@
-import {
-  html,
-  fixture,
-  expect
-} from '@open-wc/testing';
-import sinon from 'sinon';
-// import { Volumes } from '../../../src/BookNavigator/volumes/volumes.js';
-
-const stub = {
-  "success": true,
-  "value": {
-    "identifier": "SubBookTest",
-    "mediatype": "texts",
-    "files": {
-      "by_url": {
-        "/details/SubBookTest": {
-          "url_path": "/details/SubBookTest",
-          "file_prefix": "book1/GPORFP",
-          "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_prefix": "subdir/book2/brewster_kahle_internet_archive",
-          "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_prefix": "subdir/subsubdir/book3/Rfp008011ResponseInternetArchive-without-resume",
-          "title": "subdir/subsubdir/book3/Rfp008011ResponseInternetArchive-without-resume.pdf",
-          "file_source": "/subdir/subsubdir/book3/Rfp008011ResponseInternetArchive-without-resume_jp2.zip"
-        }
-      },
-      "main_dir": "/2/items/SubBookTest"
-    }
-  }
-};
-
-
-const options = [{
-  id: 'contrast',
-  name: 'Adjust contrast',
-  active: true,
-  min: 0,
-  max: 150,
-  step: 1,
-  value: 100,
-}, {
-  id: 'invert',
-  name: 'Invert colors',
-  active: false,
-}, {
-  id: 'brightness',
-  name: 'Adjust brightness',
-  active: false,
-  value: 100,
-}];
-
-const container = (hostUrl = false) => (
-  html`<viewable-files .viewableFiles=${options}} .hostUrl="https://archive.org"></viewable-files>`
-);
-
-describe('<viewable-files>', () => {
-  afterEach(() => {
-    sinon.restore();
-  });
-
-  it('sets default properties', async () => {
-    const el = await fixture(container());
-
-    expect(el.options).to.exist;
-    expect(el.options.length).to.equal(options.length);
-    expect(el.renderHeader).to.exist;
-    expect(el.renderHeader).to.be.false;
-    expect(el.activeCount).to.exist;
-    expect(el.showZoomControls).to.be.true;
-  });
-
-  // it('renders all properties of a visual adjustment option', async () => {
-  //   const el = await fixture(container());
-
-  //   await el.updateComplete;
-
-  //   const label = el.shadowRoot.querySelector('label');
-  //   const name = label.querySelector('.name');
-  //   const checkbox = label.querySelector('input');
-  //   expect(name.innerText).to.equal(options[0].name);
-  //   expect(checkbox.checked).to.equal(true);
-  // });
-
-  // it('can render header with active options count', async () => {
-  //   const renderHeader = true;
-  //   const el = await fixture(container(renderHeader));
-  //   expect(el.shadowRoot.querySelector('header p').innerText).to.include('1');
-  // });
-
-  // it('does not render active options count element when none are selected', async () => {
-  //   const el = await fixture(container());
-
-  //   el.options = [options[1]];
-  //   await el.updateComplete;
-
-  //   expect(el.shadowRoot.querySelector('header p')).not.to.exist;
-  // });
-
-  // it('changes option\'s active state when input changed', async () => {
-  //   const el = await fixture(container());
-
-  //   el.shadowRoot.querySelector('li input').dispatchEvent(new Event('change'));
-  //   await el.updateComplete;
-
-  //   expect(el.options[0].active).to.equal(false);
-  // });
-
-  // it('renders zoom in and out controls when enabled', async () => {
-  //   const el = await fixture(container());
-
-  //   expect(el.shadowRoot.querySelector('.zoom_out')).to.exist;
-  //   expect(el.shadowRoot.querySelector('.zoom_in')).to.exist;
-  // });
-
-  // it('does not render zoom controls when disabled', async () => {
-  //   const el = await fixture(container());
-
-  //   el.showZoomControls = false;
-  //   await el.updateComplete;
-
-  //   expect(el.shadowRoot.querySelector('.zoom_out')).not.to.exist;
-  //   expect(el.shadowRoot.querySelector('.zoom_in')).not.to.exist;
-  // });
-
-});

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