@internetarchive/bookreader 5.0.0-94 → 5.0.0-95

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

@@ -1,263 +0,0 @@
-import BookReader from '@/src/BookReader.js';
-import { sleep } from '@/src/BookReader/utils.js';
-import sinon from 'sinon';
-
-beforeAll(() => {
-  global.alert = sinon.fake();
-});
-afterEach(() => {
-  sinon.restore();
-});
-
-describe('BookReader.prototype.toggleFullscreen', ()  => {
-  test('uses `isFullscreen` to check fullscreen state', () => {
-    const isFSmock = sinon.fake();
-    // isFSmock.mockReturnValueOnce(false);
-    const br = new BookReader();
-    br.mode = br.constMode1up;
-    br.enterFullscreen = sinon.fake();
-    br.isFullscreen = isFSmock;
-
-    br.toggleFullscreen();
-    expect(br.isFullscreen.callCount).toEqual(1);
-  });
-
-  test('will always emit an event', async () => {
-    const br = new BookReader();
-    br.mode = br.constMode2up;
-    br.trigger = sinon.fake();
-    br.switchMode = sinon.fake();
-    br.updateBrClasses = sinon.fake();
-    br.jumpToIndex = sinon.fake();
-    br.refs.$brContainer = {
-      css: sinon.fake(),
-      animate: (options, speed, style, callback) => callback(),
-    };
-    br.refs.$br = {
-      updateBrClasses: sinon.fake(),
-      removeClass: sinon.fake(),
-      addClass: sinon.fake(),
-      css: sinon.fake(),
-      animate: (options, speed, style, callback) => callback(),
-    };
-
-    await br.toggleFullscreen();
-    expect(br.trigger.callCount).toBeGreaterThan(0);
-  });
-
-  test('will start with opening fullscreen', () => {
-    const br = new BookReader();
-    br.mode = br.constMode2up;
-    br.enterFullscreen = sinon.fake();
-
-    br.toggleFullscreen();
-    expect(br.enterFullscreen.callCount).toEqual(1);
-  });
-
-  test('will close fullscreen if BookReader is in fullscreen', () => {
-    const br = new BookReader();
-    br.mode = br.constMode1up;
-    br.exitFullScreen = sinon.fake();
-    br.isFullscreenActive = true;
-
-    br.toggleFullscreen();
-    expect(br.exitFullScreen.callCount).toEqual(1);
-  });
-});
-
-describe('BookReader.prototype.enterFullscreen', ()  => {
-  test('will bind `_fullscreenCloseHandler` by default', () => {
-    const br = new BookReader();
-    br.mode = br.constMode1up;
-    br.switchMode = sinon.fake();
-    br.updateBrClasses = sinon.fake();
-    br.refs.$br = {
-      css: sinon.fake(),
-      animate: sinon.fake(),
-      addClass: sinon.fake(),
-    };
-    expect(br._fullscreenCloseHandler).toBeUndefined();
-
-    br.enterFullscreen();
-    expect(br._fullscreenCloseHandler).toBeDefined();
-  });
-
-  test('fires certain events when called', async () => {
-    const br = new BookReader();
-    br.mode = br.constMode2up;
-    br.switchMode = sinon.fake();
-    br.updateBrClasses = sinon.fake();
-    br.trigger = sinon.fake();
-    br.resize = sinon.fake();
-    br.jumpToIndex = sinon.fake();
-    br.refs.$br = {
-      addClass: sinon.fake(),
-      removeClass: sinon.fake(),
-    };
-    br.refs.$brContainer = {
-      css: sinon.fake(),
-      animate: (options, speed, style, callback) => callback(),
-    };
-
-    await br.enterFullscreen();
-    expect(br.switchMode.callCount).toEqual(1);
-    expect(br.updateBrClasses.callCount).toEqual(1);
-    expect(br.trigger.callCount).toEqual(2); // fragmentChange, fullscreenToggled
-    expect(br.jumpToIndex.callCount).toEqual(1);
-
-    await sleep(0);
-    expect(br.resize.callCount).toEqual(1);
-  });
-});
-
-describe('BookReader.prototype.exitFullScreen', () => {
-  test('fires certain events when called', async () => {
-    const br = new BookReader();
-    br.mode = br.constMode2up;
-    br.switchMode = sinon.fake();
-    br.updateBrClasses = sinon.fake();
-    br.trigger = sinon.fake();
-    br.resize = sinon.fake();
-    br.refs.$br = {
-      addClass: sinon.fake(),
-      removeClass: sinon.fake(),
-    };
-    br.refs.$brContainer = {
-      css: sinon.fake(),
-      animate: (options, speed, style, callback) => callback(),
-    };
-    await br.exitFullScreen();
-    expect(br.switchMode.callCount).toEqual(1);
-    expect(br.updateBrClasses.callCount).toEqual(1);
-    expect(br.trigger.callCount).toEqual(2); // fragmentChange, fullscreenToggled
-    expect(br.resize.callCount).toEqual(1);
-  });
-});
-
-describe('BookReader.prototype.trigger', () => {
-  test('fires custom event', () => {
-    const br = new BookReader();
-    global.br = br;
-    global.dispatchEvent = sinon.fake();
-
-    const props = {bar: 1};
-    br.trigger('foo', props);
-    expect(global.dispatchEvent.callCount).toBe(1);
-  });
-});
-
-describe('`BookReader.prototype.prev`', () => {
-  let br;
-  let flipAnimationStub;
-  beforeEach(() => {
-    br = new BookReader();
-    global.br = br;
-    br.trigger = sinon.fake();
-    br.jumpToIndex = sinon.fake();
-    flipAnimationStub = sinon.stub(br._modes.mode2Up.mode2UpLit, 'flipAnimation');
-  });
-
-  afterEach(() => {
-    sinon.restore();
-  });
-
-  test('does not take action if user is on front page', () => {
-    br.firstIndex = 0;
-    br.prev();
-    expect(br.trigger.callCount).toBe(0);
-    expect(flipAnimationStub.callCount).toBe(0);
-    expect(br.jumpToIndex.callCount).toBe(0);
-  });
-
-  describe('2up mode', () => {
-    test('fires event and turns the page', () => {
-      br.firstIndex = 10;
-      br.mode = br.constMode2up;
-      br.prev();
-      expect(br.jumpToIndex.callCount).toBe(0); // <--  does not get called
-      expect(br.trigger.callCount).toBe(1);
-      expect(flipAnimationStub.callCount).toBe(1);
-    });
-  });
-
-  describe('non 2up mode', () => {
-    test('jumps to provided index', () => {
-      br.firstIndex = 100;
-      br.mode = br.constMode1up;
-      br.prev();
-      expect(br.jumpToIndex.callCount).toBe(1);  // <--  gets called
-      expect(flipAnimationStub.callCount).toBe(0); // <-- gets called by `jumpToIndex` internally
-    });
-  });
-});
-
-describe('`BookReader.prototype.jumpToIndex`', () => {
-  /**
-   * @param {Partial<BookReaderOptions>} overrides
-   */
-  function makeFakeBr(overrides = {}) {
-    const br = new BookReader({
-      data: [
-        [
-          { index: 0, viewable: true },
-        ],
-        [
-          { index: 1, viewable: false },
-          { index: 2, viewable: false },
-        ],
-        [
-          { index: 3, viewable: false },
-          { index: 4, viewable: false },
-        ],
-        [
-          { index: 5, viewable: true },
-        ],
-      ],
-      ...overrides,
-    });
-    br.init();
-
-    br._modes.mode2Up.jumpToIndex = sinon.fake();
-
-    expect(br.firstIndex).toBe(0);
-    expect(br.mode).toBe(br.constMode2up);
-
-    return br;
-  }
-
-  test('Jumping into an unviewables range will go to start of range', () => {
-    const br = makeFakeBr();
-    br.jumpToIndex(3, 0, 0, true);
-    expect(br._modes.mode2Up.jumpToIndex.callCount).toBe(1);
-    expect(br._modes.mode2Up.jumpToIndex.args[0][0]).toBe(1);
-  });
-
-  test('Trying to jump into unviewables range while in that range, will jump forward', () => {
-    const br = makeFakeBr();
-    br.displayedIndices = [1, 2];
-    br.jumpToIndex(3, 0, 0, true);
-    expect(br._modes.mode2Up.jumpToIndex.callCount).toBe(1);
-    expect(br._modes.mode2Up.jumpToIndex.args[0][0]).toBe(5);
-  });
-
-  test('Trying to jump into unviewables range while in that range, will do nothing if cannot jump forward', () => {
-    const br = makeFakeBr({
-      data: [
-        [
-          { index: 0, viewable: true },
-        ],
-        [
-          { index: 1, viewable: false },
-          { index: 2, viewable: false },
-        ],
-        [
-          { index: 3, viewable: false },
-          { index: 4, viewable: false },
-        ],
-      ],
-    });
-    br.displayedIndices = [1, 2];
-    br.jumpToIndex(3, 0, 0, true);
-    expect(br._modes.mode2Up.jumpToIndex.callCount).toBe(0);
-  });
-});

package/tests/jest/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/jest/BookReader/Mode1UpLit.test.js

@@ -1,73 +0,0 @@
-import { BookModel } from '@/src/BookReader/BookModel.js';
-import { Mode1UpLit } from '@/src/BookReader/Mode1UpLit.js';
-
-/** @type {import('@/src/BookReader/options.js').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' },
-  ],
-];
-
-function make_dummy_br(overrides = {}) {
-  return Object.assign({
-    updateFirstIndex() {},
-    _components: {
-      navbar: {
-        updateNavIndexThrottled() {},
-      },
-    },
-    data: [],
-  }, overrides);
-}
-
-describe('pageTops', () => {
-  afterEach(() => document.body.innerHTML = '');
-
-  test('Works with empty book', async () => {
-    const br = make_dummy_br({ data: [] });
-    const book = new BookModel(br);
-    const mode = new Mode1UpLit(book, br);
-    document.body.appendChild(mode);
-    mode.requestUpdate();
-    await mode.updateComplete;
-    expect(mode.pageTops).toEqual({});
-  });
-
-  test('Iterates all pages', async () => {
-    const br = make_dummy_br({ data: SAMPLE_DATA });
-    const book = new BookModel(br);
-    const mode = new Mode1UpLit(book, br);
-    document.body.appendChild(mode);
-    await mode.requestUpdate();
-    expect(Object.values(mode.pageTops)).toHaveLength(6);
-  });
-
-  test('Computes tops', async () => {
-    const br = make_dummy_br({ data: SAMPLE_DATA });
-    const book = new BookModel(br);
-    const mode = new Mode1UpLit(book, br);
-    document.body.appendChild(mode);
-    await mode.requestUpdate();
-    const tops = Object.entries(mode.pageTops);
-    expect(tops.map(([index, top]) => [index, top.toFixed(1)])).toEqual([
-      // Recall these are in inches
-      ['0', '0.2'],
-      ['1', '0.6'],
-      ['2', '1.1'],
-      ['3', '1.5'],
-      ['4', '2.0'],
-      ['5', '2.4'],
-    ]);
-  });
-});

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

@@ -1,98 +0,0 @@
-
-import sinon from 'sinon';
-import { Mode2Up } from '@/src/BookReader/Mode2Up.js';
-import BookReader from '@/src/BookReader.js';
-import { BookModel } from '@/src/BookReader/BookModel.js';
-import { afterEventLoop } from '../utils.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('Mode2Up', () => {
-  /** @type {BookReader} */
-  let br;
-  /** @type {BookModel} */
-  let bookModel;
-  /** @type {Mode2Up} */
-  let mode2Up;
-
-  beforeEach(() => {
-    br = new BookReader({
-      data: SAMPLE_DATA,
-      el: document.createElement('div'),
-    });
-    br.init();
-    bookModel = new BookModel(br);
-    mode2Up = new Mode2Up(br, bookModel);
-  });
-
-  describe('prepare', () => {
-    it('initializes DOM properly', async () => {
-      const spyAppend = sinon.spy(br.refs.$brContainer, 'append');
-      const spyRequestUpdate = sinon.spy(mode2Up.mode2UpLit, 'requestUpdate');
-      const initFirstRenderSpy = sinon.spy(mode2Up.mode2UpLit, 'initFirstRender');
-      const jumpToIndexSpy = sinon.spy(mode2Up.mode2UpLit, 'jumpToIndex');
-      sinon.stub(mode2Up.mode2UpLit, 'updateComplete').get(() => Promise.resolve());
-      mode2Up.prepare();
-
-      expect(br.refs.$brContainer[0].style.overflow).toEqual('hidden');
-      expect(spyAppend.calledWith(mode2Up.$el)).toBe(true);
-      expect(mode2Up.mode2UpLit.style.opacity).toEqual('0');
-
-      await afterEventLoop();
-
-      expect(initFirstRenderSpy.called).toBe(true);
-      expect(jumpToIndexSpy.called).toBe(false);
-      expect(mode2Up.everShown).toBe(true);
-      expect(spyRequestUpdate.called).toBe(true);
-      expect(mode2Up.mode2UpLit.style.opacity).toEqual('1');
-    });
-  });
-
-  describe('resizePageView', () => {
-    it('updates autoFit when possible', async () => {
-      const updateClientSizesSpy = sinon.stub(mode2Up.mode2UpLit.htmlDimensionsCacher, 'updateClientSizes');
-      const resizeViaAutofitSpy = sinon.spy(mode2Up.mode2UpLit, 'resizeViaAutofit');
-      const recenterStub = sinon.stub(mode2Up.mode2UpLit, 'recenter');
-
-      mode2Up.resizePageView();
-      expect(updateClientSizesSpy.called).toBe(true);
-      expect(resizeViaAutofitSpy.called).toBe(true);
-      expect(recenterStub.called).toBe(true);
-
-      // Test with scale and autoFit as 'none'
-      mode2Up.mode2UpLit.scale = 0.1;
-      mode2Up.mode2UpLit.autoFit = 'none';
-      mode2Up.resizePageView();
-
-      expect(mode2Up.mode2UpLit.autoFit).toEqual('auto');
-      expect(resizeViaAutofitSpy.callCount).toEqual(2);
-      expect(recenterStub.callCount).toEqual(2);
-    });
-  });
-});