@internetarchive/bookreader 5.0.0-42-a2 → 5.0.0-44-a1

package/tests/{karma → jest}/BookNavigator/volumes/volumes.test.js

@@ -1,11 +1,10 @@
 import {
   html,
   fixture,
-  expect,
   fixtureCleanup,
-} from '@open-wc/testing';
+} from '@open-wc/testing-helpers';
 import sinon from 'sinon';
-import '../../../../src/BookNavigator/volumes/volumes.js';
+import '@/src/BookNavigator/volumes/volumes.js';
 
 
 const brOptions = {
@@ -58,30 +57,30 @@ afterEach(() => {
 });
 
 describe('<viewable-files>', () => {
-  it('sets default properties', async () => {
+  test('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.viewableFiles).toEqual(viewableFiles);
+    expect(el.viewableFiles.length).toEqual(3);
+    expect(el.shadowRoot.querySelectorAll("ul li").length).toEqual(3);
 
-    expect(el.shadowRoot.querySelector(".item-title").innerText).to.include(`${viewableFiles[0].title}`);
+    expect(el.shadowRoot.querySelector(".item-title").textContent).toContain(`${viewableFiles[0].title}`);
   });
 
-  it('render empty volumes', async () => {
+  test('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);
+    expect(el.viewableFiles).toEqual(viewableFiles);
+    expect(el.viewableFiles.length).toEqual(0);
+    expect(el.shadowRoot.childElementCount).not.toEqual(0);
   });
 
-  it('render active volume item set as first viewable item ', async () => {
+  test('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;
@@ -89,10 +88,10 @@ describe('<viewable-files>', () => {
     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.viewableFiles).toEqual(viewableFiles);
+    expect(el.viewableFiles.length).toEqual(3);
 
-    expect(el.shadowRoot.querySelectorAll("ul li div")[1].className).to.equal("content active");
+    expect(el.shadowRoot.querySelectorAll("ul li div")[1].className).toEqual("content active");
   });
 
 });

package/tests/jest/plugins/search/plugin.search.test.js

@@ -1,7 +1,7 @@
-
 import BookReader from '@/src/BookReader.js';
 import '@/src/plugins/plugin.mobile_nav.js';
-import '@/src/plugins/search/plugin.search.js';
+import { marshallSearchResults } from '@/src/plugins/search/plugin.search.js';
+import { deepCopy } from '../../utils.js';
 
 jest.mock('@/src/plugins/search/view.js');
 
@@ -14,31 +14,33 @@ const triggeredEvents = () => {
   });
 };
 
+const DUMMY_RESULTS = {
+  ia: "adventuresofoli00dick",
+  q: "child",
+  indexed: true,
+  page_count: 644,
+  body_length: 666,
+  leaf0_missing: false,
+  matches: [{
+    text: 'For a long; time after it was ushered into this world of sorrow and trouble, by the parish surgeon, it remained a matter of considerable doubt wliether the {{{child}}} Avould survi^ e to bear any name at all; in which case it is somewhat more than probable that these memoirs would never have appeared; or, if they had, that being comprised within a couple of pages, they would have possessed the inestimable meiit of being the most concise and faithful specimen of biography, extant in the literature of any age or country.',
+    par: [{
+      boxes: [{r: 1221, b: 2121, t: 2075, page: 37, l: 1107}],
+      b: 2535,
+      t: 1942,
+      page_width: 1790,
+      r: 1598,
+      l: 50,
+      page_height: 2940,
+      page: 37
+    }]
+  }]
+};
+
 beforeEach(() => {
   $.ajax = jest.fn().mockImplementation(() => {
     // return from:
     // `https://ia800304.us.archive.org/fulltext/inside.php?item_id=adventuresofoli00dick&doc=adventuresofoli00dick&path=/30/items/adventuresofoli00dick&q=child&callback=<serialized jQ CB>`
-    return Promise.resolve({
-      ia: "adventuresofoli00dick",
-      q: "child",
-      indexed: true,
-      page_count: 644,
-      body_length: 666,
-      leaf0_missing: false,
-      matches: [{
-        text: 'For a long; time after it was ushered into this world of sorrow and trouble, by the parish surgeon, it remained a matter of considerable doubt wliether the {{{child}}} Avould survi^ e to bear any name at all; in which case it is somewhat more than probable that these memoirs would never have appeared; or, if they had, that being comprised within a couple of pages, they would have possessed the inestimable meiit of being the most concise and faithful specimen of biography, extant in the literature of any age or country.',
-        par: [{
-          boxes: [{r: 1221, b: 2121, t: 2075, page: 37, l: 1107}],
-          b: 2535,
-          t: 1942,
-          page_width: 1790,
-          r: 1598,
-          l: 50,
-          page_height: 2940,
-          page: 37
-        }]
-      }]
-    });
+    return Promise.resolve(deepCopy(DUMMY_RESULTS));
   });
 
   $.fn.trigger = jest.fn();
@@ -163,3 +165,18 @@ describe('Plugin: Search', () => {
     expect(triggeredEvents()).toContain(`${namespace}SearchCallbackEmpty`);
   });
 });
+
+describe('marshallSearchResults', () => {
+  test('Adds match index', () => {
+    const results = deepCopy(DUMMY_RESULTS);
+    marshallSearchResults(results, x => x.toString());
+    expect(results.matches[0]).toHaveProperty('matchIndex', 0);
+    expect(results.matches[0].par[0].boxes[0]).toHaveProperty('matchIndex', 0);
+  });
+
+  test('Adds display page number', () => {
+    const results = deepCopy(DUMMY_RESULTS);
+    marshallSearchResults(results, x => `n${x}`);
+    expect(results.matches[0]).toHaveProperty('displayPageNumber', 'n37');
+  });
+});

package/tests/jest/plugins/tts/AbstractTTSEngine.test.js

@@ -20,7 +20,7 @@ describe.skip('AbstractTTSEngine', () => {
   });
 });
 
-for (const dummyVoice of [dummyVoice, dummyVoiceUnderscores]) {
+for (const dummyVoice of [dummyVoiceHyphens, dummyVoiceUnderscores]) {
   describe(`getBestBookVoice with BCP47 ${dummyVoice == dummyVoiceUnderscores ? '+' : '-'} underscores`, () => {
     const { getBestBookVoice } = AbstractTTSEngine;
 
@@ -130,7 +130,7 @@ export const DUMMY_TTS_ENGINE_OPTS = {
  * @param {SpeechSynthesisVoice}
  * @return {SpeechSynthesisVoice}
  **/
-function dummyVoice(overrides) {
+function dummyVoiceHyphens(overrides) {
   return Object.assign({
     default: false,
     lang: "en-US",
@@ -147,7 +147,7 @@ function dummyVoice(overrides) {
  * @return {SpeechSynthesisVoice}
  **/
 function dummyVoiceUnderscores(overrides) {
-  const voice = dummyVoice(overrides);
+  const voice = dummyVoiceHyphens(overrides);
   voice.lang = voice.lang.replace('-', '_');
   return voice;
 }

package/karma.conf.js

@@ -1,23 +0,0 @@
-const { createDefaultConfig } = require('@open-wc/testing-karma');
-const merge = require('deepmerge');
-
-module.exports = (config) => {
-  config.set(
-    merge(createDefaultConfig(config), {
-      files: [
-        // runs all files ending with .test in the test folder,
-        // can be overwritten by passing a --grep flag. examples:
-        //
-        // npm run test -- --grep test/foo/bar.test.js
-        // npm run test -- --grep test/bar/*
-        { pattern: config.grep ? config.grep : 'tests/karma/**/*.test.js', type: 'module' },
-      ],
-
-      esm: {
-        nodeResolve: true,
-      },
-      // you can overwrite/extend the config further
-    }),
-  );
-  return config;
-};

package/tests/karma/BookNavigator/bookmarks/ia-bookmarks.test.js

@@ -1,57 +0,0 @@
-import {
-  html,
-  fixtureSync,
-  expect,
-  fixtureCleanup,
-} from '@open-wc/testing';
-import '../../../../src/BookNavigator/bookmarks/ia-bookmarks.js';
-import sinon from 'sinon';
-
-afterEach(() => {
-  sinon.restore();
-  fixtureCleanup();
-});
-
-describe('<ia-bookmarks>', () => {
-  it('uses `setup` to start component', async () => {
-    const el = fixtureSync(html`<ia-bookmarks></ia-bookmarks>`);
-    await el.updateComplete;
-
-    let fetchHappened = false;
-    el.bookreader.bookId = 'foo';
-    el.displayMode = 'bookmarks';
-
-    el.fetchBookmarks = async () => {
-      fetchHappened = true;
-      return await Promise.resolve();
-    };
-
-    const fetchSpy = sinon.spy(el, 'fetchUserBookmarks');
-
-    el.setup();
-    await el.updateComplete;
-
-    expect(fetchSpy.callCount).to.equal(1);
-    expect(fetchHappened).to.equal(true);
-  });
-  it('does not fetch user bookmarks if displayMode = login', async () => {
-    const el = fixtureSync(html`<ia-bookmarks></ia-bookmarks>`);
-    await el.updateComplete;
-
-    let fetchHappened = false;
-    el.displayMode = 'login';
-
-    el.fetchBookmarks = async () => {
-      fetchHappened = true;
-      return await Promise.resolve();
-    };
-
-    const fetchSpy = sinon.spy(el, 'fetchUserBookmarks');
-
-    el.setup();
-    await el.updateComplete;
-
-    expect(fetchSpy.callCount).to.equal(0);
-    expect(fetchHappened).to.equal(false);
-  });
-});

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