@internetarchive/bookreader 5.0.0-12-fixsorting-7 → 5.0.0-120

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

@@ -1,25 +0,0 @@
-import sinon from 'sinon';
-import { DebugConsole } from '../../src/BookReader/DebugConsole.js';
-
-beforeEach(() => {
-  sinon.stub(console, 'log');
-});
-afterEach(() => {
-  sinon.restore();
-});
-
-test('hijacks console.log', () => {
-  const _realLog = console.log;
-  expect(_realLog).toBe(console.log);
-  new DebugConsole().init();
-  expect(_realLog).not.toBe(console.log);
-});
-
-test('logging the same thing twice does not create more entries', () => {
-  const dc = new DebugConsole();
-  dc.init();
-  dc.logToScreen(['hello']);
-  dc.logToScreen(['hello']);
-  expect(dc.$log.children('.log-entry')).toHaveLength(1);
-  expect(dc.$log.find('.count').text()).toBe('(2)');
-});

package/tests/BookReader/ImageCache.test.js

@@ -1,150 +0,0 @@
-import sinon from 'sinon';
-import { BookModel } from '../../src/BookReader/BookModel.js';
-import { ImageCache } from '../../src/BookReader/ImageCache.js';
-import { Pow2ReduceSet } from '../../src/BookReader/ReduceSet.js';
-/** @typedef {import('../../src/BookReader/options.js').BookReaderOptions} BookReaderOptions */
-
-afterEach(() => {
-  jest.restoreAllMocks();
-  sinon.restore();
-});
-
-const CACHE_MOCK = { 1: [{ reduce: 3, loaded: true }] };
-const FIRST_PAGE_MOCK = { width: 123, height: 123, uri: 'https://archive.org/image0.jpg', pageNum: '1' };
-/** @type {BookReaderOptions['data']} */
-const SAMPLE_DATA = [
-  [ FIRST_PAGE_MOCK ],
-  [
-    { 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('Image Cache', () => {
-  describe('`image` call', () => {
-    test('calling `image` will create an image if none is cached', () => {
-      const reduceSet = Pow2ReduceSet;
-      const ic = new ImageCache(new BookModel({ data: SAMPLE_DATA, reduceSet }), reduceSet);
-      ic.cache = {};
-      ic.image(1, 5);
-      expect(Object.keys(ic.cache).length).toBe(1);
-      expect(ic.cache['1'].length).toBe(1);
-    });
-    test('will pull from cache if image of a good quality has been stored', () => {
-      const reduceSet = Pow2ReduceSet;
-      const ic = new ImageCache(new BookModel({ data: SAMPLE_DATA, reduceSet }), reduceSet);
-      const serveImgElSpy = sinon.spy(ic, '_serveImageElement');
-      ic.cache = CACHE_MOCK;
-      ic.image(1, 5);
-      expect(serveImgElSpy.callCount).toBe(1);
-    });
-  });
-
-  describe('`imageLoaded` call', () => {
-    test('returns true if image in cache', () => {
-      const reduceSet = Pow2ReduceSet;
-      const ic = new ImageCache(new BookModel({ data: SAMPLE_DATA, reduceSet }), reduceSet);
-      ic.cache = CACHE_MOCK;
-      const isImgLoaded = ic.imageLoaded(1, 3);
-      expect(isImgLoaded).toBe(true);
-    });
-    test('returns true if image reducer in cache is good enough', () => {
-      const reduceSet = Pow2ReduceSet;
-      const ic = new ImageCache(new BookModel({ data: SAMPLE_DATA, reduceSet }), reduceSet);
-      ic.cache = CACHE_MOCK;
-      const isImgLoaded = ic.imageLoaded(1, 5);
-      expect(isImgLoaded).toBe(true);
-    });
-    test('returns false if no image in cache', () => {
-      const reduceSet = Pow2ReduceSet;
-      const ic = new ImageCache(new BookModel({ data: SAMPLE_DATA, reduceSet }), reduceSet);
-      ic.cache = CACHE_MOCK;
-      const isImgLoaded = ic.imageLoaded(2, 3);
-      expect(isImgLoaded).toBe(false);
-    });
-    test('returns false if reducer to check is better than cache', () => {
-      const reduceSet = Pow2ReduceSet;
-      const ic = new ImageCache(new BookModel({ data: SAMPLE_DATA, reduceSet }), reduceSet);
-      ic.cache = CACHE_MOCK;
-      const isImgLoaded = ic.imageLoaded(1, 2);
-      expect(isImgLoaded).toBe(false);
-    });
-    test('returns false if image has not loaded', () => {
-      const reduceSet = Pow2ReduceSet;
-      const ic = new ImageCache(new BookModel({ data: SAMPLE_DATA, reduceSet }), reduceSet);
-      ic.cache = { 1: [{ reduce: 4, loaded: false }] };
-      const isImgLoaded = ic.imageLoaded(1, 2);
-      expect(isImgLoaded).toBe(false);
-    });
-  });
-
-  describe('`getBestLoadedReduce` call', () => {
-    test('handles empty cache', () => {
-      const reduceSet = Pow2ReduceSet;
-      const ic = new ImageCache(new BookModel({ data: SAMPLE_DATA, reduceSet }), reduceSet);
-      ic.cache = {};
-      expect(ic.getBestLoadedReduce(0)).toBeNull();
-    });
-
-    test('handles empty page-level cache', () => {
-      const reduceSet = Pow2ReduceSet;
-      const ic = new ImageCache(new BookModel({ data: SAMPLE_DATA, reduceSet }), reduceSet);
-      ic.cache = { 0: [] };
-      expect(ic.getBestLoadedReduce(0)).toBeNull();
-      ic.cache = { 0: [{ reduce: 10, loaded: false }] };
-      expect(ic.getBestLoadedReduce(0)).toBeNull();
-    });
-
-    test('chooses highest quality sufficient image', () => {
-      const reduceSet = Pow2ReduceSet;
-      const ic = new ImageCache(new BookModel({ data: SAMPLE_DATA, reduceSet }), reduceSet);
-      ic.cache = { 0: [{ reduce: 1, loaded: true }, { reduce: 4, loaded: true }, { reduce: 10, loaded: true }] };
-      expect(ic.getBestLoadedReduce(0, 5)).toBe(10);
-    });
-
-    test('chooses closest image if no lower images', () => {
-      const reduceSet = Pow2ReduceSet;
-      const ic = new ImageCache(new BookModel({ data: SAMPLE_DATA, reduceSet }), reduceSet);
-      ic.cache = { 0: [{ reduce: 1, loaded: true }, { reduce: 4, loaded: true }] };
-      expect(ic.getBestLoadedReduce(0, 5)).toBe(4);
-    });
-  });
-
-  describe('`_serveImageElement` call', () => {
-    test('returns jQuery image element', () => {
-      const reduceSet = Pow2ReduceSet;
-      const ic = new ImageCache(new BookModel({ data: SAMPLE_DATA, reduceSet }), reduceSet);
-      const img = ic._serveImageElement(0);
-      expect($(img).length).toBe(1);
-      expect($(img)[0].classList.contains('BRpageimage')).toBe(true);
-      expect($(img).attr('src')).toBe(FIRST_PAGE_MOCK.uri);
-    });
-
-    test('does not set srcset when useSrcSet=false', () => {
-      const reduceSet = Pow2ReduceSet;
-      const ic = new ImageCache(
-        new BookModel({ data: SAMPLE_DATA, reduceSet }),
-        { useSrcSet: false, reduceSet },
-      );
-      const $img = ic._serveImageElement(0);
-      expect($img[0].hasAttribute('srcset')).toBe(false);
-    });
-
-    test('sets srcset when useSrcSet=true', () => {
-      const reduceSet = Pow2ReduceSet;
-      const ic = new ImageCache(
-        new BookModel({ data: SAMPLE_DATA, reduceSet }),
-        { useSrcSet: true, reduceSet },
-      );
-      const $img = ic._serveImageElement(0, 9);
-      expect($img.attr('srcset')).toBeTruthy();
-    });
-  });
-});

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