@internetarchive/bookreader 5.0.0-94 → 5.0.0-96

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

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

@@ -1,190 +0,0 @@
-import sinon from "sinon";
-import { BookModel } from "@/src/BookReader/BookModel.js";
-import { Mode2UpLit } from "@/src/BookReader/Mode2UpLit.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);
-}
-
-afterEach(() => {
-  sinon.restore();
-});
-
-describe("computePageHeight", () => {
-  test("Always returns the median", () => {
-    const mode = new Mode2UpLit({
-      getMedianPageSizeInches: () => ({ width: 100, height: 200 }),
-    }, null);
-    expect(mode.computePageHeight(null)).toEqual(200);
-    expect(mode.computePageHeight({ widthInches: 300, heightInches: 400 }))
-      .toEqual(200);
-  });
-});
-
-describe("computePageWidth", () => {
-  test("returns relative to pageHeight", () => {
-    const mode = new Mode2UpLit(null, null);
-    sinon.stub(mode, "computePageHeight").returns(6);
-
-    expect(mode.computePageWidth({ widthInches: 2, heightInches: 6 })).toEqual(
-      2,
-    );
-    expect(mode.computePageWidth({ widthInches: 3, heightInches: 6 })).toEqual(
-      3,
-    );
-    expect(mode.computePageWidth({ widthInches: 2, heightInches: 4 })).toEqual(
-      2 * 6 / 4,
-    );
-  });
-});
-
-describe("computePositions", () => {
-  const LEFT_COVER_EXPECTED = {
-    leafEdgesLeftStart: -0.246,
-    leafEdgesLeftMainWidth: 0,
-    leafEdgesLeftMovingStart: -0.246,
-    leafEdgesLeftMovingWidth: 0,
-    leafEdgesLeftEnd: -0.246,
-    leafEdgesLeftFullWidth: 0,
-    pageLeftStart: -0.246,
-    pageLeftWidth: 0.246,
-    pageLeftEnd: 0,
-    gutter: 0,
-    pageRightStart: 0,
-    pageRightWidth: 0.246,
-    pageRightEnd: 0.246,
-    leafEdgesRightStart: 0.246,
-    leafEdgesRightMovingWidth: 0,
-    leafEdgesRightMainStart: 0.246,
-    leafEdgesRightMainWidth: 0.006,
-    leafEdgesRightEnd: 0.252,
-    leafEdgesRightFullWidth: 0.006,
-    spreadWidth: 0.492,
-    bookWidth: 0.498,
-  };
-  const SPREAD_EXPECTED = {
-    leafEdgesLeftStart: -0.246,
-    leafEdgesLeftMainWidth: 0.002,
-    leafEdgesLeftMovingStart: -0.244,
-    leafEdgesLeftMovingWidth: 0,
-    leafEdgesLeftEnd: -0.244,
-    leafEdgesLeftFullWidth: 0.002,
-    pageLeftStart: -0.244,
-    pageLeftWidth: 0.246,
-    pageLeftEnd: 0.002,
-    gutter: 0.002,
-    pageRightStart: 0.002,
-    pageRightWidth: 0.246,
-    pageRightEnd: 0.248,
-    leafEdgesRightStart: 0.248,
-    leafEdgesRightMovingWidth: 0,
-    leafEdgesRightMainStart: 0.248,
-    leafEdgesRightMainWidth: 0.004,
-    leafEdgesRightEnd: 0.252,
-    leafEdgesRightFullWidth: 0.004,
-    spreadWidth: 0.492,
-    bookWidth: 0.498,
-  };
-  const RIGHT_COVER_EXPECTED = {
-    leafEdgesLeftStart: -0.242,
-    leafEdgesLeftMainWidth: 0.006,
-    leafEdgesLeftMovingStart: -0.236,
-    leafEdgesLeftMovingWidth: 0,
-    leafEdgesLeftEnd: -0.236,
-    leafEdgesLeftFullWidth: 0.006,
-    pageLeftStart: -0.236,
-    pageLeftWidth: 0.246,
-    pageLeftEnd: 0.01,
-    gutter: 0.01,
-    pageRightStart: 0.01,
-    pageRightWidth: 0,
-    pageRightEnd: 0.01,
-    leafEdgesRightStart: 0.01,
-    leafEdgesRightMovingWidth: 0,
-    leafEdgesRightMainStart: 0.01,
-    leafEdgesRightMainWidth: 0,
-    leafEdgesRightEnd: 0.01,
-    leafEdgesRightFullWidth: 0,
-    spreadWidth: 0.246,
-    bookWidth: 0.252,
-  };
-
-  test("left cover page", () => {
-    const br = make_dummy_br({ data: SAMPLE_DATA });
-    const book = new BookModel(br);
-    const mode = new Mode2UpLit(book, br);
-    expect(mode.computePositions(null, book.getPage(0))).toEqual(LEFT_COVER_EXPECTED);
-  });
-
-  test("spread", () => {
-    const br = make_dummy_br({ data: SAMPLE_DATA });
-    const book = new BookModel(br);
-    const mode = new Mode2UpLit(book, br);
-
-    expect(mode.computePositions(book.getPage(1), book.getPage(2))).toEqual(SPREAD_EXPECTED);
-  });
-
-  test("right cover page", () => {
-    const br = make_dummy_br({ data: SAMPLE_DATA });
-    const book = new BookModel(br);
-    const mode = new Mode2UpLit(book, br);
-
-    expect(mode.computePositions(book.getPage(-1), null)).toEqual(RIGHT_COVER_EXPECTED);
-  });
-});

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

@@ -1,16 +0,0 @@
-import { ModeCoordinateSpace } from "@/src/BookReader/ModeCoordinateSpace.js";
-
-describe("worldUnitsToRenderedPixels", () => {
-  test("0 case", () => {
-    const mcs = new ModeCoordinateSpace({ scale: 1 });
-    expect(mcs.worldUnitsToRenderedPixels(0)).toBe(0);
-  });
-
-  test("Misc cases", () => {
-    const mcs = new ModeCoordinateSpace({ scale: 1 });
-    mcs.screenDPI = 100;
-    expect(mcs.worldUnitsToRenderedPixels(1)).toBe(100);
-    mcs.screenDPI = 78;
-    expect(mcs.worldUnitsToRenderedPixels(1)).toBe(78);
-  });
-});