@internetarchive/bookreader 5.0.0-94 → 5.0.0-96

package/tests/jest/BookReader/utils.test.js

@@ -1,250 +0,0 @@
-import sinon from 'sinon';
-import { afterEventLoop, eventTargetMixin } from '../utils.js';
-import {
-  clamp,
-  cssPercentage,
-  debounce,
-  decodeURIComponentPlus,
-  encodeURIComponentPlus,
-  escapeHTML,
-  escapeRegExp,
-  getActiveElement,
-  isInputActive,
-  parseAnimationSpeed,
-  poll,
-  polyfillCustomEvent,
-  PolyfilledCustomEvent,
-  promisifyEvent,
-  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");
-});
-
-describe('getActiveElement', () => {
-  test('Can ignore shadow DOM', () => {
-    const doc = {activeElement: { shadowRoot: {activeElement: {}}}};
-    expect(getActiveElement(doc, false)).toBe(doc.activeElement);
-  });
-
-  test('Can traverse shadow DOM', () => {
-    const doc = {activeElement: { shadowRoot: {activeElement: {}}}};
-    expect(getActiveElement(doc, true)).toBe(doc.activeElement.shadowRoot.activeElement);
-  });
-
-  test('Handles non-shadow elements', () => {
-    const doc = {activeElement: {}};
-    expect(getActiveElement(doc, true)).toBe(doc.activeElement);
-  });
-
-  test('Handles no active element', () => {
-    const doc = {activeElement: null};
-    expect(getActiveElement(doc, true)).toBe(null);
-  });
-});
-
-describe('isInputActive', () => {
-  test('Handles no activeElement', () => {
-    expect(isInputActive({activeElement: null})).toBe(false);
-  });
-
-  test('Handles deep input activeElement', () => {
-    const doc = {activeElement: { shadowRoot: {activeElement: { tagName: 'INPUT' }}}};
-    expect(isInputActive(doc)).toBe(true);
-  });
-
-  test('Handles deep non-input activeElement', () => {
-    const doc = {activeElement: { shadowRoot: {activeElement: { tagName: 'A' }}}};
-    expect(isInputActive(doc)).toBe(false);
-  });
-
-  test('Handles textarea activeElement', () => {
-    const doc = {activeElement: { tagName: 'TEXTAREA' }};
-    expect(isInputActive(doc)).toBe(true);
-  });
-});
-
-describe('debounce', () => {
-  /** @type {sinon.SinonFakeTimers} */
-  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('poll', () => {
-  beforeEach(() => jest.useFakeTimers());
-  afterEach(() => jest.useRealTimers());
-  test('polls until condition is true', async () => {
-    const fakeSleep = sinon.spy((ms) => jest.advanceTimersByTime(ms));
-
-    const returns = [null, null, 'foo'];
-    const check = sinon.spy(() => returns.shift());
-    const result = await poll(check, {_sleep: fakeSleep});
-    expect(fakeSleep.callCount).toBe(2);
-    expect(result).toBe('foo');
-    expect(check.callCount).toBe(3);
-  });
-
-  test('times out eventually', async () => {
-    const fakeSleep = sinon.spy((ms) => jest.advanceTimersByTime(ms));
-
-    const check = sinon.stub().returns(null);
-    const result = await poll(check, {_sleep: fakeSleep});
-    expect(result).toBeUndefined();
-    expect(check.callCount).toBe(10);
-  });
-});
-
-describe('sleep', () => {
-  test('Sleep 0 doest not called immediately', async () => {
-    const spy = sinon.spy();
-    sleep(0).then(spy);
-    expect(spy.callCount).toBe(0);
-    await afterEventLoop();
-    expect(spy.callCount).toBe(1);
-  });
-
-  test('Waits the appropriate ms', async () => {
-    const clock = sinon.useFakeTimers();
-    const spy = sinon.spy();
-    sleep(10).then(spy);
-    expect(spy.callCount).toBe(0);
-    clock.tick(10);
-    expect(spy.callCount).toBe(0);
-    clock.restore();
-
-    await afterEventLoop();
-    expect(spy.callCount).toBe(1);
-  });
-});
-
-describe('promisifyEvent', () => {
-  test('Resolves once event fires', async () => {
-    const fakeTarget = eventTargetMixin();
-    const resolveSpy = sinon.spy();
-    promisifyEvent(fakeTarget, 'pause').then(resolveSpy);
-
-    await afterEventLoop();
-    expect(resolveSpy.callCount).toBe(0);
-    fakeTarget.dispatchEvent('pause', {});
-    await afterEventLoop();
-    expect(resolveSpy.callCount).toBe(1);
-  });
-
-  test('Only resolves once', async () => {
-    const fakeTarget = eventTargetMixin();
-    const resolveSpy = sinon.spy();
-    promisifyEvent(fakeTarget, 'pause').then(resolveSpy);
-
-    await afterEventLoop();
-    expect(resolveSpy.callCount).toBe(0);
-    fakeTarget.dispatchEvent('pause', {});
-    fakeTarget.dispatchEvent('pause', {});
-    fakeTarget.dispatchEvent('pause', {});
-    fakeTarget.dispatchEvent('pause', {});
-
-    await afterEventLoop();
-    expect(resolveSpy.callCount).toBe(1);
-  });
-});
-
-describe('escapeRegex', () => {
-  test('Escapes regex', () => {
-    expect(escapeRegExp('.*')).toBe('\\.\\*');
-    expect(escapeRegExp('foo')).toBe('foo');
-    expect(escapeRegExp('foo.bar')).toBe('foo\\.bar');
-    expect(escapeRegExp('{{{')).toBe('\\{\\{\\{');
-    expect(escapeRegExp('')).toBe('');
-    expect(escapeRegExp('https://example.com')).toBe('https://example\\.com');
-  });
-});
-
-describe('parseAnimationSpeed', () => {
-  test('Parses numbers', () => {
-    expect(parseAnimationSpeed(100)).toBe(100);
-    expect(parseAnimationSpeed(0)).toBe(0);
-    expect(parseAnimationSpeed(1000)).toBe(1000);
-  });
-
-  test('Parses strings', () => {
-    expect(parseAnimationSpeed('slow')).toBe(600);
-    expect(parseAnimationSpeed('fast')).toBe(200);
-    expect(parseAnimationSpeed('100')).toBe(100);
-  });
-
-  test('Handles invalid input', () => {
-    expect(parseAnimationSpeed('foo')).toBeFalsy();
-    expect(parseAnimationSpeed('')).toBeFalsy();
-    expect(parseAnimationSpeed(null)).toBeFalsy();
-  });
-});

package/tests/jest/BookReader.keyboard.test.js

@@ -1,190 +0,0 @@
-import BookReader from '@/src/BookReader.js';
-import * as utils from '@/src/BookReader/utils.js';
-
-let br;
-beforeAll(() => {
-  document.body.innerHTML = '<div id="BookReader">';
-  br = new BookReader();
-});
-
-afterEach(() => {
-  jest.clearAllMocks();
-});
-
-/**
- * Only run init() once. Otherwise multiple EventListeners will be added.
- */
-test('Initialzation enables IntersectionObserver and defaults', () => {
-  const observe = jest.fn();
-  window.IntersectionObserver = jest.fn(() => ({
-    observe,
-  }));
-  br.init();
-  expect(br.hasKeyFocus).toBe(true);
-  expect(observe).toHaveBeenCalledTimes(1);
-});
-
-describe('Keyboard shortcuts turned off', () => {
-
-  test('Focus flag disables', () => {
-    br.next = jest.fn();
-    br.hasKeyFocus = false;
-    const keyEvent = new KeyboardEvent('keydown', {'key': 'ArrowDown'});
-    keyEvent.preventDefault = jest.fn();
-    document.dispatchEvent(keyEvent);
-    expect(br.next).toHaveBeenCalledTimes(0);
-    expect(keyEvent.preventDefault).toHaveBeenCalledTimes(0);
-    // Must reset for following tests
-    br.hasKeyFocus = true;
-  });
-
-  test('Input active disables', () => {
-    // eslint-disable-next-line no-import-assign
-    utils.isInputActive = jest.fn(() => true);
-    br.next = jest.fn();
-    const keyEvent = new KeyboardEvent('keydown', {'key': 'ArrowDown'});
-    keyEvent.preventDefault = jest.fn();
-    document.dispatchEvent(keyEvent);
-    expect(br.next).toHaveBeenCalledTimes(0);
-    expect(keyEvent.preventDefault).toHaveBeenCalledTimes(0);
-    // Must reset for following tests
-    utils.isInputActive.mockReset();
-  });
-
-});
-
-describe('Keyboard shortcuts', () => {
-
-  test('Home key', () => {
-    br.first = jest.fn();
-    const keyEvent = new KeyboardEvent('keydown', {'key': 'Home'});
-    keyEvent.preventDefault = jest.fn();
-    document.dispatchEvent(keyEvent);
-    expect(br.first).toHaveBeenCalledTimes(1);
-    expect(keyEvent.preventDefault).toHaveBeenCalledTimes(1);
-  });
-
-  test('End key', () => {
-    br.last = jest.fn();
-    const keyEvent = new KeyboardEvent('keydown', {'key': 'End'});
-    keyEvent.preventDefault = jest.fn();
-    document.dispatchEvent(keyEvent);
-    expect(br.last).toHaveBeenCalledTimes(1);
-    expect(keyEvent.preventDefault).toHaveBeenCalledTimes(1);
-  });
-
-  test('ArrowDown key', () => {
-    br.mode = br.constMode2up;
-    br.next = jest.fn();
-    const keyEvent = new KeyboardEvent('keydown', {'key': 'ArrowDown'});
-    keyEvent.preventDefault = jest.fn();
-    document.dispatchEvent(keyEvent);
-    expect(br.next).toHaveBeenCalledTimes(1);
-    expect(keyEvent.preventDefault).toHaveBeenCalledTimes(1);
-  });
-
-  test('PageDown key', () => {
-    br.mode = br.constMode2up;
-    br.next = jest.fn();
-    const keyEvent = new KeyboardEvent('keydown', {'key': 'PageDown'});
-    keyEvent.preventDefault = jest.fn();
-    document.dispatchEvent(keyEvent);
-    expect(br.next).toHaveBeenCalledTimes(1);
-    expect(keyEvent.preventDefault).toHaveBeenCalledTimes(1);
-  });
-
-  test('ArrowUp key', () => {
-    br.mode = br.constMode2up;
-    br.prev = jest.fn();
-    const keyEvent = new KeyboardEvent('keydown', {'key': 'ArrowUp'});
-    keyEvent.preventDefault = jest.fn();
-    document.dispatchEvent(keyEvent);
-    expect(br.prev).toHaveBeenCalledTimes(1);
-    expect(keyEvent.preventDefault).toHaveBeenCalledTimes(1);
-  });
-
-  test('PageUp key', () => {
-    br.mode = br.constMode2up;
-    br.prev = jest.fn();
-    const keyEvent = new KeyboardEvent('keydown', {'key': 'PageUp'});
-    keyEvent.preventDefault = jest.fn();
-    document.dispatchEvent(keyEvent);
-    expect(br.prev).toHaveBeenCalledTimes(1);
-    expect(keyEvent.preventDefault).toHaveBeenCalledTimes(1);
-  });
-
-  test('ArrowLeft key', () => {
-    br.mode = br.constMode2up;
-    br.left = jest.fn();
-    const keyEvent = new KeyboardEvent('keydown', {'key': 'ArrowLeft'});
-    keyEvent.preventDefault = jest.fn();
-    document.dispatchEvent(keyEvent);
-    expect(br.left).toHaveBeenCalledTimes(1);
-    expect(keyEvent.preventDefault).toHaveBeenCalledTimes(1);
-  });
-
-  test('ArrowRight key', () => {
-    br.mode = br.constMode2up;
-    br.right = jest.fn();
-    const keyEvent = new KeyboardEvent('keydown', {'key': 'ArrowRight'});
-    keyEvent.preventDefault = jest.fn();
-    document.dispatchEvent(keyEvent);
-    expect(br.right).toHaveBeenCalledTimes(1);
-    expect(keyEvent.preventDefault).toHaveBeenCalledTimes(1);
-  });
-
-  test('Subtract key', () => {
-    br.zoom = jest.fn();
-    const keyEvent = new KeyboardEvent('keydown', {'key': 'Subtract'});
-    keyEvent.preventDefault = jest.fn();
-    document.dispatchEvent(keyEvent);
-    expect(br.zoom).toHaveBeenCalledTimes(1);
-    expect(keyEvent.preventDefault).toHaveBeenCalledTimes(1);
-  });
-
-  test('- key', () => {
-    br.zoom = jest.fn();
-    const keyEvent = new KeyboardEvent('keydown', {'key': '-'});
-    keyEvent.preventDefault = jest.fn();
-    document.dispatchEvent(keyEvent);
-    expect(br.zoom).toHaveBeenCalledTimes(1);
-    expect(keyEvent.preventDefault).toHaveBeenCalledTimes(1);
-  });
-
-  test('Add key', () => {
-    br.zoom = jest.fn();
-    const keyEvent = new KeyboardEvent('keydown', {'key': 'Add'});
-    keyEvent.preventDefault = jest.fn();
-    document.dispatchEvent(keyEvent);
-    expect(br.zoom).toHaveBeenCalledTimes(1);
-    expect(keyEvent.preventDefault).toHaveBeenCalledTimes(1);
-  });
-
-  test('+ key', () => {
-    br.zoom = jest.fn();
-    const keyEvent = new KeyboardEvent('keydown', {'key': '+'});
-    keyEvent.preventDefault = jest.fn();
-    document.dispatchEvent(keyEvent);
-    expect(br.zoom).toHaveBeenCalledTimes(1);
-    expect(keyEvent.preventDefault).toHaveBeenCalledTimes(1);
-  });
-
-  test('= key', () => {
-    br.zoom = jest.fn();
-    const keyEvent = new KeyboardEvent('keydown', {'key': '='});
-    keyEvent.preventDefault = jest.fn();
-    document.dispatchEvent(keyEvent);
-    expect(br.zoom).toHaveBeenCalledTimes(1);
-    expect(keyEvent.preventDefault).toHaveBeenCalledTimes(1);
-  });
-
-  test('F key', () => {
-    br.toggleFullscreen = jest.fn();
-    const keyEvent = new KeyboardEvent('keydown', {'key': 'F'});
-    keyEvent.preventDefault = jest.fn();
-    document.dispatchEvent(keyEvent);
-    expect(br.toggleFullscreen).toHaveBeenCalledTimes(1);
-    expect(keyEvent.preventDefault).toHaveBeenCalledTimes(1);
-  });
-
-});

package/tests/jest/BookReader.options.test.js

@@ -1,47 +0,0 @@
-
-import BookReader from '@/src/BookReader.js';
-
-beforeAll(() => {
-  document.body.innerHTML = '<div id="BookReader">';
-});
-
-afterEach(() => {
-  jest.clearAllMocks();
-});
-
-describe('BookReader options', () => {
-  describe('`autoResize`', () => {
-    it('is on by default', () => {
-      const br = new BookReader();
-      br.init();
-      expect(br.options.autoResize).toBe(true);
-    });
-  });
-
-  describe('`startFullscreen`', () => {
-    it('initializes BookReader to fullscreen', () => {
-      const br = new BookReader({
-        startFullscreen: true,
-      });
-      br.init();
-
-      expect(document.getElementById('BookReader').classList.contains('br-ui-full')).toBe(true);
-    });
-  });
-
-  describe('`useSrcSet`', () => {
-    it('is on by default', () => {
-      const br = new BookReader();
-      br.init();
-      expect(br.options.autoResize).toBe(true);
-    });
-  });
-
-  describe('`showNavbar`', () => {
-    it('is on by default', () => {
-      const br = new BookReader();
-      br.init();
-      expect(br.options.showNavbar).toBe(true);
-    });
-  });
-});