@internetarchive/bookreader 5.0.0-8 → 5.0.0-80

package/tests/BookReader/utils.test.js

@@ -1,109 +0,0 @@
-import sinon from 'sinon';
-import {
-  clamp,
-  cssPercentage,
-  debounce,
-  decodeURIComponentPlus,
-  encodeURIComponentPlus,
-  escapeHTML,
-  polyfillCustomEvent,
-  PolyfilledCustomEvent,
-  sleep,
-} from '../../src/BookReader/utils.js';
-
-test('clamp function returns Math.min(Math.max(value, min), max)', () => {
-  expect(clamp(2,1,3)).toEqual(2);
-});
-
-test('calculate a percentage suitable for CSS', () => {
-  expect(cssPercentage(2,1)).toEqual('200%');
-});
-
-test('escapeHTML function which replaces the string', () => {
-  expect(escapeHTML('Me & You')).toEqual('Me & You');
-  expect(escapeHTML('Me > You')).toEqual('Me > You');
-  expect(escapeHTML('Me < You')).toEqual('Me &lt; You');
-  expect(escapeHTML('Me " You')).toEqual('Me &quot; You');
-});
-
-test('Decodes a URI component and converts + to emptyStr', () => {
-  expect(decodeURIComponentPlus("https%3A%2F%2Farchive.org%2Fskr+")).toEqual("https://archive.org/skr ");
-  expect(decodeURIComponentPlus("%3Fx%3D+test")).toEqual("?x= test");
-});
-
-test('Encodes a URI component and converts emptyStr to +', () => {
-  expect(encodeURIComponentPlus("?x=test ")).toEqual("%3Fx%3Dtest+");
-  expect(encodeURIComponentPlus("ABC abc 123")).toEqual("ABC+abc+123");
-});
-
-let clock;
-
-beforeEach(() => {
-  clock = sinon.useFakeTimers();
-});
-
-afterEach(() => {
-  clock.restore();
-});
-
-test('testing debounce', () => {
-  const func = jest.fn();
-  const debouncedFunc = debounce(func, 1000);
-  // Call it immediately
-  debouncedFunc();
-  expect(func).toHaveBeenCalledTimes(0); // func not called
-
-  // Call it several times with 500ms between each call
-  for (let i = 0; i < 10; i++) {
-    clock.tick(500);
-    debouncedFunc();
-  }
-  expect(func).toHaveBeenCalledTimes(0); // func not called
-
-  // wait 1000ms
-  clock.tick(1000);
-  expect(func).toHaveBeenCalledTimes(1);  // func called
-});
-
-
-describe('polyfillCustomEvent', () => {
-  test('Overrides when missing', () => {
-    const win = {};
-    polyfillCustomEvent(win);
-    expect(win).toHaveProperty('CustomEvent');
-  });
-
-  test('Overrides when not a function', () => {
-    const win = { CustomEvent: {} };
-    polyfillCustomEvent(win);
-    expect(typeof win.CustomEvent).toBe('function');
-  });
-});
-
-describe('PolyfilledCustomEvent', () => {
-  test('Can be called as a constructor', () => {
-    new PolyfilledCustomEvent('foo');
-  });
-
-  test('Calls deprecated browser methods', () => {
-    const createEventSpy = sinon.spy(document, 'createEvent');
-    const initCustomEventSpy = sinon.spy(CustomEvent.prototype, 'initCustomEvent');
-    new PolyfilledCustomEvent('foo');
-    expect(createEventSpy.callCount).toBe(1);
-    expect(initCustomEventSpy.callCount).toBe(1);
-  });
-});
-
-describe('sleep', () => {
-  test('can set sleep in ms', async () => {
-    jest.useFakeTimers();
-
-    const sleepTimeMS = 11;
-    await sleep(sleepTimeMS);
-
-    expect(setTimeout).toHaveBeenCalledTimes(1);
-    expect(setTimeout).toHaveBeenLastCalledWith(undefined, sleepTimeMS);
-
-    jest.clearAllTimers();
-  });
-});

package/tests/e2e/helpers/desktopSearch.js

@@ -1,72 +0,0 @@
-import { ClientFunction, RequestMock } from 'testcafe';
-import { SEARCH_INSIDE_URL_RE , mockResponseFound, mockResponseNotFound,
-  TEST_TEXT_FOUND, TEST_TEXT_NOT_FOUND, PAGE_FIRST_RESULT, SEARCH_MATCHES_LENGTH } from './mockSearch';
-
-
-export function runDesktopSearchTests(br) {
-  //building mock response  for successful and unsuccessful search
-  const mockFound = RequestMock()
-    .onRequestTo(SEARCH_INSIDE_URL_RE )
-    .respond(mockResponseFound, 202);
-
-  const mockNotFound = RequestMock()
-    .onRequestTo(SEARCH_INSIDE_URL_RE )
-    .respond(mockResponseNotFound, 202);
-
-
-  test
-    .requestHooks(mockFound)('Desktop search - successful search', async t => {
-      const nav = br.nav;
-
-      //assuring that the search bar is enabled
-      await t.expect(nav.desktop.searchBox.visible).ok();
-
-      //testing search for a word found in the book
-      await t
-        .selectText(nav.desktop.searchBox.child('.BRsearchInput'))
-        .pressKey('delete');
-      await t.typeText(nav.desktop.searchBox.child('.BRsearchInput'), TEST_TEXT_FOUND);
-      await t.click((nav.desktop.searchBox).child('.BRsearchSubmit'));
-      await t.expect(nav.desktop.searchPin.exists).ok();
-      await t.expect(nav.desktop.searchPin.child('.BRquery').child('div').exists).ok();
-      await t.expect(nav.desktop.searchPin.child('.BRquery').child('div').innerText).contains(TEST_TEXT_FOUND);
-      await t.expect(nav.desktop.searchNavigation.exists).ok();
-      await t.expect(nav.desktop.searchNavigation.find('[data-id="resultsCount"]').exists).ok();
-      await t.expect(nav.desktop.searchNavigation.find('[data-id="resultsCount"]').innerText).contains(SEARCH_MATCHES_LENGTH);
-
-      //checking url
-      const getPageUrl = ClientFunction(() => window.location.href.toString());
-      await t.expect(getPageUrl()).contains(TEST_TEXT_FOUND);
-
-      //checks clicking on first search pin opens correct page
-      await t.click(nav.desktop.searchPin);
-      await t.expect(getPageUrl()).contains(PAGE_FIRST_RESULT);
-
-      //checks highlight on result page is visible
-      const highlight = br.shell.find(".BookReaderSearchHilite");
-      await t.expect(highlight.visible).ok();
-
-    });
-
-
-  test
-    .requestHooks(mockNotFound)('Desktop search - unsuccessful search', async t => {
-      const nav = br.nav;
-
-      //assuring that the search bar is enabled
-      await t.expect(nav.desktop.searchBox.visible).ok();
-
-      //testing search for a word not found in the book
-      await t
-        .selectText(nav.desktop.searchBox.child('.BRsearchInput'))
-        .pressKey('delete');
-      await t.typeText(nav.desktop.searchBox.child('.BRsearchInput'), TEST_TEXT_NOT_FOUND);
-      await t.click((nav.desktop.searchBox).child('.BRsearchSubmit'));
-      await t.expect(nav.desktop.searchPin.child('.BRquery').child('div').withText(TEST_TEXT_NOT_FOUND).exists).notOk();
-
-      const getPageUrl = ClientFunction(() => window.location.href.toString());
-      await t.expect(getPageUrl()).contains(TEST_TEXT_NOT_FOUND);
-    });
-
-
-}

package/tests/e2e/helpers/mobileSearch.js

@@ -1,85 +0,0 @@
-import { ClientFunction, RequestMock } from 'testcafe';
-import { SEARCH_INSIDE_URL_RE , mockResponseFound, mockResponseNotFound,
-  TEST_TEXT_FOUND, TEST_TEXT_NOT_FOUND, PAGE_FIRST_RESULT } from './mockSearch';
-
-
-export function runMobileSearchTests(br) {
-  //building mock response  for successful and unsuccessful search
-  const mockFound = RequestMock()
-    .onRequestTo(SEARCH_INSIDE_URL_RE )
-    .respond(mockResponseFound, 202);
-
-  const mockNotFound = RequestMock()
-    .onRequestTo(SEARCH_INSIDE_URL_RE )
-    .respond(mockResponseNotFound, 202);
-
-  test
-    .requestHooks(mockFound)('Mobile search - successful search', async t => {
-      await t.resizeWindowToFitDevice('Sony Xperia Z', {portraitOrientation: true})
-      const nav = br.nav.mobile;
-
-      //opening side menu and search
-      await t.expect(nav.hamburgerButton.visible).ok();
-      await t.click(nav.hamburgerButton);
-      await t.expect(nav.menuSearchButton.visible).ok();
-      await t.click(nav.menuSearchButton);
-
-      //assuring that the search bar is enabled
-      await t.expect(nav.searchBox.visible).ok();
-
-      //testing successful search
-      await t
-        .selectText(nav.searchBox.find('[name="query"]'))
-        .pressKey('delete');
-      await t
-        .typeText(nav.searchBox.find('[name="query"]'), TEST_TEXT_FOUND)
-        .pressKey('enter');
-      await t.expect(nav.searchResults.visible).ok();
-      await t.expect(nav.searchResultText.exists).ok();
-      await t.expect(nav.searchResultText.innerText).contains(TEST_TEXT_FOUND);
-
-      //checking url
-      const getPageUrl = ClientFunction(() => window.location.href);
-      await t.expect(getPageUrl()).contains(TEST_TEXT_FOUND);
-
-      //checks clicking on first search result opens correct page
-      await t.click(nav.searchResults.child(0));
-      await t.expect(getPageUrl()).contains(PAGE_FIRST_RESULT);
-
-      //checks highlight on result page is visible
-      const highlight = br.shell.find(".BookReaderSearchHilite");
-      await t.expect(highlight.visible).ok();
-
-      await t.maximizeWindow();
-    });
-
-  test
-    .requestHooks(mockNotFound)('Mobile search - unsuccessful search', async t => {
-      await t.resizeWindowToFitDevice('Sony Xperia Z', {portraitOrientation: true})
-      const nav = br.nav.mobile;
-
-      //opening side menu and search
-      await t.expect(nav.hamburgerButton.visible).ok();
-      await t.click(nav.hamburgerButton);
-      await t.expect(nav.menuSearchButton.visible).ok();
-      await t.click(nav.menuSearchButton);
-
-      //assuring that the search bar is enabled
-      await t.expect(nav.searchBox.visible).ok();
-
-      //testing unsuccessful search
-      await t
-        .selectText(nav.searchBox.find('[name="query"]'))
-        .pressKey('delete');
-      await t
-        .typeText(nav.searchBox.find('[name="query"]'), TEST_TEXT_NOT_FOUND)
-        .pressKey('enter');
-      await t.expect(nav.searchResultText.withText(TEST_TEXT_NOT_FOUND).exists).notOk();
-
-      //checking url
-      const getPageUrl = ClientFunction(() => window.location.href.toString());
-      await t.expect(getPageUrl()).contains(TEST_TEXT_NOT_FOUND);
-      await t.maximizeWindow();
-    });
-
-}

package/tests/e2e/ia-production/ia-prod-base.js

@@ -1,17 +0,0 @@
-import { runBaseTests } from '../helpers/base';
-import BookReader from '../models/BookReader';
-
-const localURL = 'https://archive.org/details/';
-const books = [
-  'birdbookillustra00reedrich', // publicDomain
-  // 'pianoservicingtu00rebl_0', // borrowable,
-  // 'adventuresoftoms00twaiiala', // has chapter markers
-  // 'gendaitankashu00meijuoft', // Right to Left book
-  // 'gov.uspto.patents.application.10074026', // multiple files
-];
-
-books.forEach(function(page) {
-  const url = `${localURL}${page}`;
-  fixture `Archive.org BR Base Tests for: ${page}`.page `${url}`;
-  runBaseTests(new BookReader());
-});

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/search/search-provider.test.js

@@ -1,23 +0,0 @@
-import { expect } from '@open-wc/testing';
-import sinon from 'sinon';
-import searchProvider from '../../../../src/BookNavigator/search/search-provider';
-
-afterEach(() => {
-  sinon.restore();
-});
-
-describe('Search Provider', () => {
-  describe('constructor', () => {
-    const onSearchChangeCB = sinon.fake();
-    const br = sinon.fake();
-    const provider = new searchProvider(onSearchChangeCB, br);
-
-    expect(provider.bookreader).to.equal(br);
-    expect(provider.onSearchChange).to.equal(onSearchChangeCB);
-    expect(provider.id).to.equal('search');
-    expect(provider.icon).to.exist;
-    expect(provider.label).to.equal('Search inside');
-    expect(provider.menuDetails).to.exist;
-    expect(provider.component).to.exist;
-  });
-});

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