@internetarchive/bookreader 5.0.0-4 → 5.0.0-40-a1

package/tests/BookReader/BookReaderPublicFunctions.test.js

@@ -1,171 +0,0 @@
-import BookReader from '../../src/BookReader';
-
-beforeAll(() => {
-  global.alert = jest.fn();
-})
-afterEach(() => {
-  jest.restoreAllMocks();
-});
-
-describe('BookReader.prototype.toggleFullscreen', ()  => {
-  test('uses `isFullscreen` to check fullscreen state', () => {
-    const isFSmock = jest.fn();
-    isFSmock.mockReturnValueOnce(false);
-    const br = new BookReader();
-    br.mode = br.constMode1up;
-    br.enterFullscreen = jest.fn();
-    br.isFullscreen = isFSmock;
-
-    br.toggleFullscreen();
-    expect(br.isFullscreen).toHaveBeenCalled();
-    expect(br.isFullscreen).toHaveBeenCalled();
-  });
-
-  test('will always emit an event', () => {
-    const br = new BookReader();
-    br.mode = br.constMode1up;
-    br.enterFullscreen = jest.fn();
-    br.trigger = jest.fn();
-    br.refs.$brContainer = {
-      css: jest.fn(),
-      animate: jest.fn()
-    }
-
-    br.toggleFullscreen();
-    expect(br.enterFullscreen).toHaveBeenCalled();
-  });
-
-  test('will start with opening fullscreen', () => {
-    const br = new BookReader();
-    br.mode = br.constMode1up;
-    br.enterFullscreen = jest.fn();
-
-    br.toggleFullscreen();
-    expect(br.enterFullscreen).toHaveBeenCalled();
-  });
-
-  test('will close fullscreen if BookReader is in fullscreen', () => {
-    const br = new BookReader();
-    br.mode = br.constMode1up;
-    br.exitFullScreen = jest.fn();
-    br.isFullscreenActive = true;
-
-    br.toggleFullscreen();
-    expect(br.exitFullScreen).toHaveBeenCalled();
-  });
-});
-
-describe('BookReader.prototype.enterFullscreen', ()  => {
-  test('will bind `_fullscreenCloseHandler` by default', () => {
-    const br = new BookReader();
-    br.mode = br.constMode1up;
-    br.switchMode = jest.fn();
-    br.updateBrClasses = jest.fn();
-    br.refs.$brContainer = {
-      css: jest.fn(),
-      animate: jest.fn(),
-    };
-    expect(br._fullscreenCloseHandler).toBeUndefined();
-
-    br.enterFullscreen();
-    expect(br._fullscreenCloseHandler).toBeDefined();
-  });
-
-  test('fires certain events when called', () => {
-    const br = new BookReader();
-    br.mode = br.constMode1up;
-    br.switchMode = jest.fn();
-    br.updateBrClasses = jest.fn();
-    br.trigger = jest.fn();
-    br.resize = jest.fn();
-    br.jumpToIndex = jest.fn();
-    const animateMock = (options, speed, style, callback) => {
-      callback();
-    };
-    br.refs.$brContainer = {
-      css: jest.fn(),
-      animate: animateMock,
-    };
-
-    br.enterFullscreen();
-    expect(br.switchMode).toHaveBeenCalledTimes(1);
-    expect(br.updateBrClasses).toHaveBeenCalledTimes(0); // book nav's fullscreen manager will set these classes
-    expect(br.trigger).toHaveBeenCalledTimes(1);
-    expect(br.resize).toHaveBeenCalledTimes(1);
-    expect(br.jumpToIndex).toHaveBeenCalledTimes(1);
-  });
-});
-
-describe('BookReader.prototype.exitFullScreen', () => {
-  test('fires certain events when called', () => {
-    const br = new BookReader();
-    br.mode = br.constMode1up;
-    br.switchMode = jest.fn();
-    br.updateBrClasses = jest.fn();
-    br.trigger = jest.fn();
-    br.resize = jest.fn();
-    const animateMock = (options, speed, style, callback) => {
-      callback();
-    };
-    br.refs.$brContainer = {
-      css: jest.fn(),
-      animate: animateMock,
-    };
-    br.exitFullScreen();
-    expect(br.switchMode).toHaveBeenCalledTimes(1);
-    expect(br.updateBrClasses).toHaveBeenCalledTimes(1);
-    expect(br.trigger).toHaveBeenCalledTimes(1);
-    expect(br.resize).toHaveBeenCalledTimes(1);
-  });
-});
-
-describe('BookReader.prototype.trigger', () => {
-  test('fires custom event', () => {
-    const br = new BookReader();
-    global.br = br;
-    global.dispatchEvent = jest.fn();
-
-    const props = {bar: 1};
-    br.trigger('foo', props);
-    expect(global.dispatchEvent.mock.calls.length).toBe(1);
-  });
-});
-
-describe('`BookReader.prototype.prev`', () => {
-  const br = new BookReader();
-  global.br = br;
-  br.trigger = jest.fn();
-  br.flipBackToIndex = jest.fn();
-  br.jumpToIndex = jest.fn();
-
-  test('does not take action if user is on front page', () => {
-    br.firstIndex = 0;
-    br.prev();
-    expect(br.trigger.mock.calls.length).toBe(0);
-    expect(br.flipBackToIndex.mock.calls.length).toBe(0);
-    expect(br.jumpToIndex.mock.calls.length).toBe(0);
-  });
-
-  describe('2up mode', () => {
-    test('fires event and turns the page', () => {
-      br.firstIndex = 10;
-      br.mode = br.constMode2up;
-      br.prev();
-      expect(br.jumpToIndex.mock.calls.length).toBe(0); // <--  does not get called
-      expect(br.trigger.mock.calls.length).toBe(1);
-      expect(br.flipBackToIndex.mock.calls.length).toBe(1);
-    });
-  })
-
-  describe('non 2up mode', () => {
-    test('jumps to provided index', () => {
-      br.firstIndex = 100;
-      br.mode = br.constMode1up;
-      br.prev();
-      expect(br.jumpToIndex.mock.calls.length).toBe(1);  // <--  gets called
-      expect(br.trigger.mock.calls.length).toBe(1); // <-- gets called by `jumpToIndex` internally
-      expect(br.flipBackToIndex.mock.calls.length).toBe(1); // <-- gets called by `jumpToIndex` internally
-    })
-  });
-});
-

package/tests/BookReader/Mode1Up.test.js

@@ -1,164 +0,0 @@
-import sinon from 'sinon';
-import { deepCopy } from '../utils.js';
-import { Mode1Up } from '../../src/BookReader/Mode1Up.js'
-import { BookModel } from '../../src/BookReader/BookModel.js';
-import { DEFAULT_OPTIONS } from '../../src/BookReader/options.js';
-const DEFAULT_PPI = DEFAULT_OPTIONS.ppi;
-
-/** @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('pagesWithBounds', () => {
-  test('Works with empty book', () => {
-    const br = { data: [] };
-    const book = new BookModel(br);
-    const mode = new Mode1Up(br, book);
-    expect(Array.from(mode.pagesWithBounds())).toHaveLength(0);
-  });
-
-  test('Iterates all pages', () => {
-    const br = { data: SAMPLE_DATA };
-    const book = new BookModel(br);
-    const mode = new Mode1Up(br, book);
-    expect(Array.from(mode.pagesWithBounds())).toHaveLength(6);
-  });
-
-  test('Computes bounds', () => {
-    const br = { data: SAMPLE_DATA };
-    const book = new BookModel(br);
-    const mode = new Mode1Up(br, book);
-    const x = Array.from(mode.pagesWithBounds());
-    expect(x.map(({top, bottom}) => [top, bottom].map(x => x.toFixed(1)))).toEqual([
-      ['0.0', '24.6'],
-      ['44.6', '69.2'],
-      ['89.2', '113.8'],
-      ['133.8', '158.4'],
-      ['178.4', '203.0'],
-      ['223.0', '247.6'],
-    ]);
-  });
-});
-
-describe('boundIntersection', () => {
-  const f = Mode1Up.boundIntersection;
-  test('Exactly equal', () => {
-    expect(f({top: 0, bottom: 10}, {top: 0, bottom: 10})).toBe(1);
-  });
-
-  test('A contains B', () => {
-    expect(f({top: 0, bottom: 10}, {top: 1, bottom: 2})).toBe(0.1);
-  });
-  test('A boundary contains B', () => {
-    expect(f({top: 0, bottom: 10}, {top: 0, bottom: 2})).toBe(0.2);
-  });
-  test('A contains top part of B', () => {
-    expect(f({top: 0, bottom: 10}, {top: 5, bottom: 15})).toBeCloseTo(5 / 15);
-  });
-  test('A contains bottom part of B', () => {
-    expect(f({top: 5, bottom: 10}, {top: 0, bottom: 6})).toBe(0.1);
-  });
-  test('A entirely above B', () => {
-    expect(f({top: 0, bottom: 10}, {top: 20, bottom: 30})).toBe(0);
-  });
-  test('A entirely below B', () => {
-    expect(f({top: 20, bottom: 30}, {top: 0, bottom: 10})).toBe(0);
-  });
-});
-
-describe('physicalInchesToDisplayPixels', () => {
-  test('0 case', () => {
-    const f = Mode1Up.prototype.physicalInchesToDisplayPixels;
-    expect(f(0, 1, 100)).toBe(0);
-  });
-  test('Misc case', () => {
-    const f = Mode1Up.prototype.physicalInchesToDisplayPixels;
-    expect(f(1, 1, 100)).toBe(100);
-    expect(f(1, 2, 100)).toBe(50);
-    expect(f(1, 1, 78)).toBe(78);
-  });
-});
-
-describe('calculateViewDimensions', () => {
-  test('Padding added for each page', () => {
-    const br = { data: SAMPLE_DATA };
-    const book = new BookModel(br);
-    const mode = new Mode1Up(br, book);
-    const pageSizeIn = 123 / DEFAULT_PPI;
-    const dims = mode.calculateViewDimensions(1, 2.5);
-    expect(dims.width).toBeCloseTo(mode.physicalInchesToDisplayPixels(pageSizeIn, 1));
-    expect(dims.height).toBeCloseTo(mode.physicalInchesToDisplayPixels(6 * pageSizeIn + 5 * 2.5, 1));
-  });
-
-  test('Reduction factor applied to each page/spacing individually', () => {
-    const br = { data: SAMPLE_DATA };
-    const book = new BookModel(br);
-    const mode = new Mode1Up(br, book);
-    const pageSizeIn = 123 / DEFAULT_PPI;
-    const dims = mode.calculateViewDimensions(2, 5);
-    expect(dims.width).toBeCloseTo(mode.physicalInchesToDisplayPixels(pageSizeIn, 2));
-    expect(dims.height).toBeCloseTo(mode.physicalInchesToDisplayPixels(6 * pageSizeIn + 5 * 5, 2));
-  });
-
-  test('Uses maximal width', () => {
-    const br = { data: deepCopy(SAMPLE_DATA) };
-    br.data.flat().forEach((page, i) => page.width = i);
-    const book = new BookModel(br);
-    const mode = new Mode1Up(br, book);
-    expect(mode.calculateViewDimensions().width).toBe(mode.physicalInchesToDisplayPixels(5 / DEFAULT_PPI));
-  });
-});
-
-describe('centerY', () => {
-  test('Computes the scroll position of the center of the screen', () => {
-    const $container = $(`
-      <div style="height: 500px">
-        <div style="height: 2500px" />
-      </div>`);
-    $container.scrollTop(1000);
-    expect(Mode1Up.prototype.centerY($container)).toBe(1250);
-  });
-
-  test('Handles no scroll', () => {
-    const $container = $(`
-      <div style="height: 1280px">
-        <div style="height: 500px" />
-      </div>`);
-    expect(Mode1Up.prototype.centerY($container)).toBe(640);
-  });
-});
-
-describe('centerX', () => {
-  test('Pages narrower than viewport', () => {
-    const $container = $(`<div style="width: 800px; height: 800px" />`);
-    const $pagesContainer = $(`<div style="width: 500px; height: 1600px" />`)
-      .appendTo($container);
-    // clientWidth doesn't work in jsdom, so stub it
-    sinon.stub($container, 'prop').returns(800);
-    expect(Mode1Up.prototype.centerX($container, $pagesContainer)).toBe(500);
-  });
-
-  test('Pages wider than viewport', () => {
-    const $container = $(`<div style="width: 800px; height: 800px; overflow: scroll;" />`);
-    const $pagesContainer = $(`<div style="width: 1200px; height: 1600px" />`)
-      .appendTo($container);
-    $container.scrollLeft(10);
-    // clientWidth doesn't work in jsdom, so stub it
-    sinon.stub($container, 'prop').returns(800);
-    expect(Mode1Up.prototype.centerX($container, $pagesContainer)).toBe(410);
-  });
-});

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