@internetarchive/bookreader 5.0.0-94 → 5.0.0-96

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

@@ -1,218 +0,0 @@
-import sinon from 'sinon';
-import interact from 'interactjs';
-import { EventTargetSpy, afterEventLoop } from '../utils.js';
-import { ModeSmoothZoom, TouchesMonitor } from '@/src/BookReader/ModeSmoothZoom.js';
-/** @typedef {import('@/src/BookReader/ModeSmoothZoom.js').SmoothZoomable} SmoothZoomable */
-
-/**
- * @param {Partial<SmoothZoomable>} overrides
- * @returns {SmoothZoomable}
- */
-function dummy_mode(overrides = {}) {
-  return {
-    $container: document.createElement('div'),
-    $visibleWorld: document.createElement('div'),
-    scale: 1,
-    htmlDimensionsCacher: {
-      clientWidth: 100,
-      clientHeight: 100,
-      boundingClientRect: { left: 0, top: 0 },
-    },
-    scaleCenter: {x: 0.5, y: 0.5},
-    ...overrides,
-  };
-}
-
-afterEach(() => {
-  sinon.restore();
-  try {
-    interact.removeDocument(document);
-  } catch (e) {}
-});
-
-describe('ModeSmoothZoom', () => {
-  test('handle iOS-only gesture events', () => {
-    const mode = dummy_mode();
-    const msz = new ModeSmoothZoom(mode);
-    sinon.stub(msz, '_pinchStart');
-    sinon.stub(msz, '_pinchMove');
-    sinon.stub(msz, '_pinchEnd');
-
-    msz.attach();
-
-    const gesturestart = new Event('gesturestart', {});
-    mode.$container.dispatchEvent(gesturestart);
-    expect(msz._pinchStart.callCount).toBe(1);
-  });
-
-  test('sets will-change', async () => {
-    const mode = dummy_mode();
-    const msz = new ModeSmoothZoom(mode);
-    msz.attach();
-    expect(mode.$visibleWorld.style.willChange).toBeFalsy();
-    msz._pinchStart();
-    expect(mode.$visibleWorld.style.willChange).toBe('transform');
-    await msz._pinchEnd();
-    expect(mode.$visibleWorld.style.willChange).toBe('auto');
-  });
-
-  test('pinch move updates scale', () => {
-    const mode = dummy_mode();
-    const msz = new ModeSmoothZoom(mode);
-    msz.attach();
-    // disable buffering
-    msz.bufferFn = (callback) => callback();
-    msz._pinchStart();
-    expect(mode.scale).toBe(1);
-    msz._pinchMove({ scale: 2, center: { x: 0, y: 0 }});
-    expect(mode.scale).toBe(2);
-  });
-
-  test('updateScaleCenter sets scaleCenter in unitless coordinates', () => {
-    const mode = dummy_mode({
-      htmlDimensionsCacher: {
-        clientWidth: 200,
-        clientHeight: 100,
-        boundingClientRect: {
-          left: 5,
-          top: 50,
-        },
-      },
-    });
-    const msz = new ModeSmoothZoom(mode);
-    expect(msz.scaleCenter).toEqual({ x: 0.5, y: 0.5 });
-    msz.updateScaleCenter({ clientX: 85, clientY: 110 });
-    expect(msz.scaleCenter).toEqual({ x: 0.4, y: 0.6 });
-  });
-
-  test('detaches all listeners', async () => {
-    const mode = dummy_mode();
-    const msz = new ModeSmoothZoom(mode);
-
-    const documentEventSpy = EventTargetSpy.wrap(document);
-    const containerEventSpy = EventTargetSpy.wrap(mode.$container);
-    const visibleWorldSpy = EventTargetSpy.wrap(mode.$visibleWorld);
-
-    msz.attach();
-    await afterEventLoop();
-    expect(documentEventSpy._totalListenerCount).toBeGreaterThan(0);
-    expect(containerEventSpy._totalListenerCount).toBeGreaterThan(0);
-
-    msz.detach();
-    expect(documentEventSpy._totalListenerCount).toBe(0);
-    expect(containerEventSpy._totalListenerCount).toBe(0);
-    expect(visibleWorldSpy._totalListenerCount).toBe(0);
-  });
-
-  test('attach can be called twice without double attachments', () => {
-    const mode = dummy_mode();
-    const msz = new ModeSmoothZoom(mode);
-
-    const documentEventSpy = EventTargetSpy.wrap(document);
-    const containerEventSpy = EventTargetSpy.wrap(mode.$container);
-    const visibleWorldSpy = EventTargetSpy.wrap(mode.$visibleWorld);
-
-    msz.attach();
-    const documentListenersCount = documentEventSpy._totalListenerCount;
-    const containerListenersCount = containerEventSpy._totalListenerCount;
-    const visibleWorldListenersCount = visibleWorldSpy._totalListenerCount;
-
-    msz.attach();
-    expect(documentEventSpy._totalListenerCount).toBe(documentListenersCount);
-    expect(containerEventSpy._totalListenerCount).toBe(containerListenersCount);
-    expect(visibleWorldSpy._totalListenerCount).toBe(visibleWorldListenersCount);
-  });
-
-  describe('_handleCtrlWheel', () => {
-    test('non-ctrl wheel events ignored', () => {
-      const mode = dummy_mode();
-      const msz = new ModeSmoothZoom(mode);
-      expect(mode.scale).toBe(1);
-      const ev = new WheelEvent('wheel', { ctrlKey: false, deltaY: 20 });
-      const preventDefaultSpy = sinon.spy(ev, 'preventDefault');
-      msz._handleCtrlWheel(ev);
-      expect(preventDefaultSpy.callCount).toBe(0);
-      expect(mode.scale).toBe(1);
-    });
-
-    test('ctrl-wheel events update scale', () => {
-      const mode = dummy_mode();
-      const msz = new ModeSmoothZoom(mode);
-      expect(mode.scale).toBe(1);
-      const ev = new WheelEvent('wheel', { ctrlKey: true, deltaY: 20 });
-      const preventDefaultSpy = sinon.spy(ev, 'preventDefault');
-      msz._handleCtrlWheel(ev);
-      expect(preventDefaultSpy.callCount).toBe(1);
-      expect(mode.scale).not.toBe(1);
-    });
-  });
-
-  describe("updateViewportOnZoom", () => {
-    test("adjusts scroll position when zooming in", () => {
-      const mode = dummy_mode();
-      const msz = new ModeSmoothZoom(mode);
-      mode.$container.scrollTop = 100;
-      mode.$container.scrollLeft = 100;
-
-      msz.updateViewportOnZoom(2, 1);
-
-      expect(mode.$container.scrollTop).toBeGreaterThan(100);
-      expect(mode.$container.scrollLeft).toBeGreaterThan(100);
-    });
-
-    test("updates scroll position when zooming out", () => {
-      const mode = dummy_mode();
-      const msz = new ModeSmoothZoom(mode);
-      mode.$container.scrollTop = 100;
-      mode.$container.scrollLeft = 100;
-
-      msz.updateViewportOnZoom(0.5, 1);
-
-      expect(mode.$container.scrollTop).toBeLessThan(100);
-      expect(mode.$container.scrollLeft).toBeLessThan(100);
-    });
-  });
-});
-
-
-describe("TouchesMonitor", () => {
-  /** @type {HTMLElement} */
-  let container;
-  /** @type {TouchesMonitor} */
-  let monitor;
-
-  beforeEach(() => {
-    container = document.createElement("div");
-    monitor = new TouchesMonitor(container);
-  });
-
-  afterEach(() => {
-    monitor.detach();
-  });
-
-  test("should start with 0 touches", () => {
-    expect(monitor.touches).toBe(0);
-  });
-
-  test("should update touch count on touch events", () => {
-    monitor.attach();
-    container.dispatchEvent(new TouchEvent("touchstart", { touches: [{}] }));
-    expect(monitor.touches).toBe(1);
-
-    container.dispatchEvent(new TouchEvent("touchstart", { touches: [{}, {}] }));
-    expect(monitor.touches).toBe(2);
-
-    container.dispatchEvent(new TouchEvent("touchend", { touches: [{}] }));
-    expect(monitor.touches).toBe(1);
-
-    container.dispatchEvent(new TouchEvent("touchend", { touches: [] }));
-  });
-
-  test("should detach all listeners", () => {
-    const spy = EventTargetSpy.wrap(container);
-    monitor.attach();
-    expect(spy._totalListenerCount).toBeGreaterThan(0);
-    monitor.detach();
-    expect(spy._totalListenerCount).toBe(0);
-  });
-});

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

@@ -1,71 +0,0 @@
-
-import sinon from 'sinon';
-import BookReader from '@/src/BookReader.js';
-/** @typedef {import('@/src/BookReader/options.js').BookReaderOptions} BookReaderOptions */
-
-beforeAll(() => {
-  global.alert = jest.fn();
-});
-afterEach(() => {
-  jest.restoreAllMocks();
-  sinon.restore();
-});
-
-/** @type {BookReaderOptions['data']} */
-const SAMPLE_DATA = [
-  [
-    { width: 123, height: 123, uri: 'https://archive.org/image0.jpg', pageNum: '1' },
-  ],
-  [
-    { width: 123, height: 123, uri: 'https://archive.org/image1.jpg', pageNum: '2' },
-    { width: 123, height: 123, uri: 'https://archive.org/image2.jpg', pageNum: '3' },
-  ],
-  [
-    { width: 123, height: 123, uri: 'https://archive.org/image3.jpg', pageNum: '4' },
-    { width: 123, height: 123, uri: 'https://archive.org/image4.jpg', pageNum: '5' },
-  ],
-  [
-    { width: 123, height: 123, uri: 'https://archive.org/image5.jpg', pageNum: '6' },
-  ],
-];
-
-describe('zoom', () => {
-  const br = new BookReader({ data: SAMPLE_DATA });
-  br.init();
-
-  test('initializes with default columns', () => {
-    expect(br.thumbColumns).toBe(br.options.thumbColumns);
-  });
-
-  test('removes column and redraws zooming in', () => {
-    const prepare = sinon.spy(br._modes.modeThumb, 'prepare');
-    const startColumns = br.thumbColumns;
-    br._modes.modeThumb.zoom('in');
-    expect(br.thumbColumns).toBe(startColumns - 1);
-    expect(prepare.callCount).toBe(1);
-  });
-
-  test('adds column and redraws zooming out', () => {
-    const prepare = sinon.spy(br._modes.modeThumb, 'prepare');
-    const startColumns = br.thumbColumns;
-    br._modes.modeThumb.zoom('out');
-    expect(br.thumbColumns).toBe(startColumns + 1);
-    expect(prepare.callCount).toBe(1);
-  });
-
-  test('keeps columns and no redraw at zooming in limit', () => {
-    const prepare = sinon.spy(br._modes.modeThumb, 'prepare');
-    br.thumbColumns = br.options.thumbMinZoomColumns;
-    br._modes.modeThumb.zoom('in');
-    expect(br.thumbColumns).toBe(br.options.thumbMinZoomColumns);
-    expect(prepare.callCount).toBe(0);
-  });
-
-  test('keeps columns and no redraw at zooming out limit', () => {
-    const prepare = sinon.spy(br._modes.modeThumb, 'prepare');
-    br.thumbColumns = br.options.thumbMaxZoomColumns;
-    br._modes.modeThumb.zoom('out');
-    expect(br.thumbColumns).toBe(br.options.thumbMaxZoomColumns);
-    expect(prepare.callCount).toBe(0);
-  });
-});

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

@@ -1,182 +0,0 @@
-import sinon from 'sinon';
-import { getNavPageNumHtml } from '@/src/BookReader/Navbar/Navbar.js';
-import BookReader from '@/src/BookReader.js';
-
-describe('getNavPageNumHtml', () => {
-  const f = getNavPageNumHtml;
-
-  test('handle n-prefixed page numbers-min format', () => {
-    expect(f(3, 40, 'n3', '', 40)).toBe('(4 of 40)');
-  });
-
-  test('handle regular page numbers-min format', () => {
-    expect(f(3, 40, '14', '', 40)).toBe('14 of 40');
-  });
-
-  test('handle no max page-min format', () => {
-    expect(f(3, 40, '14', '', null)).toBe('14');
-  });
-
-  test('handle n-prefixed page numbers-max format', () => {
-    expect(f(3, 40, 'n3', '', 40, true)).toBe('Page — (4/40)');
-  });
-
-  test('handle regular page numbers-max format', () => {
-    expect(f(3, 40, '14', '', 40, true)).toBe('Page 14 (4/40)');
-  });
-
-  test('handle no max page-max format', () => {
-    expect(f(3, 40, '14', '', null, true)).toBe('Page 14 (4/40)');
-  });
-});
-
-/** @type {BookReader} */
-let br;
-/** @type {Navbar} */
-let navbar;
-beforeEach(() => {
-  document.body.innerHTML = '<div id="BookReader">';
-  br = new BookReader({
-    data: [
-      [
-        { width: 800, height: 1200,
-          uri: '//archive.org/download/BookReader/img/page001.jpg' },
-      ],
-      [
-        { width: 800, height: 1200,
-          uri: '//archive.org/download/BookReader/img/page002.jpg' },
-        { width: 800, height: 1200,
-          uri: '//archive.org/download/BookReader/img/page003.jpg' },
-      ],
-      [
-        { width: 800, height: 1200,
-          uri: '//archive.org/download/BookReader/img/page004.jpg' },
-        { width: 800, height: 1200,
-          uri: '//archive.org/download/BookReader/img/page005.jpg' },
-      ],
-    ],
-  });
-  br.init();
-  navbar = br._components.navbar;
-});
-
-afterEach(() => sinon.restore());
-
-describe('Navbar slider', () => {
-  test('while sliding, visible page number updates, but does not flip', () => {
-    const $slider = navbar.$root.find('.BRpager');
-    const jumpToIndexSpy = sinon.spy(br, 'jumpToIndex');
-    expect(br.currentIndex()).toBe(0);
-
-    $slider.trigger('slide', { value: 3 });
-
-    expect(navbar.$root.find('.BRcurrentpage').text().includes('3'));
-    expect(jumpToIndexSpy.callCount).toBe(0);
-  });
-
-  test('on slide change, actual page changes', () => {
-    const $slider = navbar.$root.find('.BRpager');
-    const jumpToIndexStub = sinon.stub(br, 'jumpToIndex');
-    expect(br.currentIndex()).toBe(0);
-
-    $slider.trigger('slidechange', { value: 3 });
-
-    expect(navbar.$root.find('.BRcurrentpage').text().includes('3'));
-    expect(jumpToIndexStub.callCount).toBe(1);
-    expect(jumpToIndexStub.args[0][0]).toBe(3);
-  });
-});
-
-describe('Navbar controls overrides', () => {
-  const createBRWithOverrides = (overrides) => {
-    br = new BookReader($.extend(true, br.options, overrides));
-    br.init();
-    navbar = br._components.navbar;
-  };
-
-  test(`when a view mode is excluded,
-      the mode should not be used in viewport toggling`, () => {
-    const overrides = {
-      controls: {
-        viewmode: {
-          visible: true,
-          className: 'viewmode',
-          excludedModes: [1],
-        },
-      },
-    };
-    createBRWithOverrides(overrides);
-
-    const $viewMode = navbar.$root.find('.viewmode');
-
-    expect($viewMode.find('.icon-thumb').length).toBe(1);
-    $viewMode.trigger("click");
-    expect($viewMode.find('.icon-twopg').length).toBe(1);
-    $viewMode.trigger("click");
-    expect($viewMode.find('.icon-thumb').length).toBe(1);
-  });
-
-  test('when a control is set to visible: false, do not return a button template', () => {
-    const overrides = {
-      controls: {
-        onePage: {
-          visible: false,
-        },
-      },
-    };
-    createBRWithOverrides(overrides);
-
-    expect(navbar.$root.find('.onepg').length).toBe(0);
-    expect(navbar.$root.find('.twopg').length).toBe(1);
-  });
-
-  test(`when a control's className is overridden,
-      the class should be used in place of the default`, () => {
-    const overrides = {
-      controls: {
-        onePage: {
-          className: 'foo',
-        },
-      },
-    };
-    createBRWithOverrides(overrides);
-
-    expect(navbar.$root.find(`.${overrides.controls.onePage.className}`).length).toBe(1);
-    expect(navbar.$root.find('.onepg').length).toBe(0);
-  });
-
-  test(`when a control's template is overridden,
-      the HTML output should match the template provided`, () => {
-    const overrides = {
-      controls: {
-        onePage: {
-          template: () => (
-            '<button id="foo"></button>'
-          ),
-        },
-      },
-    };
-    createBRWithOverrides(overrides);
-
-    expect(navbar.$root.find('#foo').length).toBe(1);
-    expect(navbar.$root.find('.onepg').length).toBe(0);
-  });
-
-  test(`when viewmode control set to visible,
-      the individual view mode controls are not rendered`, () => {
-    const overrides = {
-      controls: {
-        viewmode: {
-          visible: true,
-        },
-        onePage: {
-          visible: false,
-        },
-      },
-    };
-    createBRWithOverrides(overrides);
-
-    expect(navbar.$root.find('.viewmode').length).toBe(1);
-    expect(navbar.$root.find('.onepg').length).toBe(0);
-  });
-});