@internetarchive/bookreader 5.0.0-95 → 5.0.0-96

package/tests/jest/plugins/plugin.chapters.test.js

@@ -1,193 +0,0 @@
-import sinon from "sinon";
-
-import "@/src/BookReader.js";
-import {ChaptersPlugin} from "@/src/plugins/plugin.chapters.js";
-import { BookModel } from "@/src/BookReader/BookModel.js";
-import { deepCopy } from "../utils.js";
-/** @typedef {import('@/src/plugins/plugin.chapters').TocEntry} TocEntry  */
-
-/** @type {TocEntry[]} */
-const SAMPLE_TOC = [{
-  "pagenum": "3",
-  "level": 1,
-  "label": "CHAPTER I",
-  "type": { "key": "/type/toc_item" },
-  "title": "THE COUNTRY AND THE MISSION 1",
-  "pageIndex": 3,
-}, {
-  "pagenum": "17",
-  "level": 1,
-  "label": "CHAPTER II",
-  "type": { "key": "/type/toc_item" },
-  "title": "THE COUNTRY AND THE MISSION 2",
-  "pageIndex": 17,
-}, {
-  "pagenum": "undefined",
-  "level": 1,
-  "label": "CHAPTER III",
-  "type": { "key": "/type/toc_item" },
-  "title": "THE COUNTRY AND THE MISSION 3",
-}, {
-  "pagenum": "40",
-  "level": 1,
-  "label": "CHAPTER IV",
-  "type": { "key": "/type/toc_item" },
-  "title": "THE COUNTRY AND THE MISSION 4",
-  "pageIndex": 40,
-}];
-
-/** @type {TocEntry[]} */
-const SAMPLE_TOC_UNDEF = [
-  {
-    "level": 1,
-    "label": "CHAPTER I",
-    "type": { "key": "/type/toc_item" },
-    "title": "THE COUNTRY AND THE MISSION 1",
-  },
-  {
-    "level": 1,
-    "label": "CHAPTER II",
-    "type": { "key": "/type/toc_item" },
-    "title": "THE COUNTRY AND THE MISSION 2",
-  },
-];
-
-/** @type {TocEntry[]} */
-const SAMPLE_TOC_OPTION = [
-  {
-    "level": 1,
-    "title": "THE COUNTRY AND THE MISSION 1",
-  },
-  {
-    "level": 1,
-    "title": "THE COUNTRY AND THE MISSION 2",
-  },
-];
-
-afterEach(() => {
-  sinon.restore();
-});
-
-describe("ChaptersPlugin", () => {
-  beforeEach(() => {
-    sinon.stub(BookModel.prototype, "getPageIndex").callsFake((str) =>
-      parseFloat(str),
-    );
-  });
-
-  describe("init", () => {
-    test("does not render when open library has no record", async () => {
-      const p = new ChaptersPlugin({ options: { vars: {} } });
-      sinon.stub(p, "getOpenLibraryRecord").resolves(null);
-      sinon.spy(p, "_render");
-      await p.init();
-      expect(p._render.callCount).toBe(0);
-    });
-
-    test("does not render when open library record has no TOC", async () => {
-      const p = new ChaptersPlugin({ options: { vars: {} } });
-      sinon.stub(p, "getOpenLibraryRecord").resolves({ key: "/books/OL1M" });
-      sinon.spy(p, "_render");
-      await p.init();
-      expect(p._render.callCount).toBe(0);
-    });
-
-    test("renders if valid TOC on open library", async () => {
-      const fakeBR = {
-        options: { vars: {} },
-        bind: sinon.stub(),
-      };
-      const p = new ChaptersPlugin(fakeBR);
-      sinon.stub(p, "getOpenLibraryRecord").resolves({
-        "title": "The Adventures of Sherlock Holmes",
-        "table_of_contents": deepCopy(SAMPLE_TOC_OPTION),
-        "ocaid": "adventureofsherl0000unse",
-      });
-      sinon.stub(p, "_render");
-      await p.init();
-      expect(p._render.callCount).toBe(1);
-    });
-
-    test("does not fetch open library record if table of contents in options", async () => {
-      const fakeBR = {
-        options: {
-          table_of_contents: deepCopy(SAMPLE_TOC_UNDEF),
-        },
-        bind: sinon.stub(),
-      };
-      const p = new ChaptersPlugin(fakeBR);
-      sinon.stub(p, "getOpenLibraryRecord");
-      sinon.stub(p, "_render");
-      await p.init();
-      expect(p.getOpenLibraryRecord.callCount).toBe(0);
-      expect(p._render.callCount).toBe(1);
-    });
-
-    test("converts leafs and pagenums to page index", async () => {
-      const table_of_contents = deepCopy(SAMPLE_TOC_UNDEF);
-      table_of_contents[0].leaf = 0;
-      table_of_contents[1].pagenum = '17';
-      const fakeBR = {
-        options: {
-          table_of_contents,
-        },
-        bind: sinon.stub(),
-        book: {
-          leafNumToIndex: (leaf) => leaf + 1,
-          getPageIndex: (str) => parseFloat(str),
-        },
-      };
-      const p = new ChaptersPlugin(fakeBR);
-      sinon.stub(p, "_render");
-      await p.init();
-      expect(p._render.callCount).toBe(1);
-      expect(p._tocEntries[0].pageIndex).toBe(1);
-      expect(p._tocEntries[1].pageIndex).toBe(17);
-    });
-  });
-
-  describe('_render', () => {
-    test('renders markers and panel', () => {
-      const fakeBR = {
-        shell: {
-          menuProviders: {},
-          addMenuShortcut: sinon.stub(),
-          updateMenuContents: sinon.stub(),
-        },
-      };
-      const p = new ChaptersPlugin(fakeBR);
-      sinon.stub(p, '_renderMarker');
-      p._tocEntries = deepCopy(SAMPLE_TOC);
-      p._render();
-      expect(fakeBR.shell.menuProviders['chapters']).toBeTruthy();
-      expect(fakeBR.shell.addMenuShortcut.callCount).toBe(1);
-      expect(fakeBR.shell.updateMenuContents.callCount).toBe(1);
-      expect(p._renderMarker.callCount).toBeGreaterThan(1);
-    });
-  });
-
-  describe('_updateCurrent', () => {
-    test('highlights the current chapter', () => {
-      const fakeBR = {
-        mode: 2,
-        firstIndex: 16,
-        displayedIndices: [16, 17],
-      };
-      const p = new ChaptersPlugin(fakeBR);
-      p._tocEntries = deepCopy(SAMPLE_TOC);
-      p._chaptersPanel = {
-        currentChapter: null,
-      };
-      p._updateCurrent();
-      expect(p._chaptersPanel.currentChapter).toEqual(SAMPLE_TOC[1]);
-
-      fakeBR.mode = 1;
-      p._updateCurrent();
-      expect(p._chaptersPanel.currentChapter).toEqual(SAMPLE_TOC[0]);
-
-      fakeBR.firstIndex = 0;
-      p._updateCurrent();
-      expect(p._chaptersPanel.currentChapter).toBeUndefined();
-    });
-  });
-});

package/tests/jest/plugins/plugin.iframe.test.js

@@ -1,42 +0,0 @@
-import sinon from 'sinon';
-
-import BookReader from '@/src/BookReader.js';
-import { _attachEventListeners } from '@/src/plugins/plugin.iframe.js';
-
-afterEach(() => {
-  sinon.restore();
-});
-
-test('listens for br events if parent', () => {
-  const br = new BookReader();
-  sinon.spy(br, 'bind');
-  sinon.spy(window, 'addEventListener');
-
-  _attachEventListeners(br, window.parent);
-  expect(br.bind.callCount).toBe(1);
-  expect(window.addEventListener.callCount).toBe(1);
-  expect(window.addEventListener.args[0][0]).toBe('message');
-});
-
-test('does not attach if not in iframe', () => {
-  const br = new BookReader();
-  sinon.spy(br, 'bind');
-  sinon.spy(window, 'addEventListener');
-
-  _attachEventListeners(br, null);
-  expect(br.bind.callCount).toBe(0);
-  expect(window.addEventListener.callCount).toBe(0);
-});
-
-test('updates params when window receives a message', () => {
-  const br = new BookReader();
-  sinon.spy(br, 'updateFromParams');
-  _attachEventListeners(br);
-  window.dispatchEvent(new MessageEvent('message', {
-    data: {
-      type: 'bookReaderFragmentChange',
-      fragment: '',
-    },
-  }));
-  expect(br.updateFromParams.callCount).toBe(1);
-});

package/tests/jest/plugins/plugin.resume.test.js

@@ -1,85 +0,0 @@
-import BookReader from '@/src/BookReader.js';
-import '@/src/plugins/plugin.resume.js';
-
-import sinon from 'sinon';
-import * as docCookies from '@/src/util/docCookies.js';
-import { ResumePlugin } from '@/src/plugins/plugin.resume.js';
-
-/** @type {import('@/src/BookReader.js').default} */
-let br;
-beforeAll(() => {
-  document.body.innerHTML = '<div id="BookReader">';
-  br = new BookReader();
-  br.init();
-});
-
-afterEach(() => {
-  jest.clearAllMocks();
-  sinon.restore();
-});
-
-describe('updateResumeValue', () => {
-  /* Mark 2020-05-02
-    Skipping while confirming with Neeraj
-    I'm not sure:
-    - What this test really does
-    - If the instantiation of the prototype counts as a call
-    - If so, why would there be a second call
-    Can't find in production
-    In this branch .toHaveBeenCalledTimes() === 1
-  */
-  test.skip('starts when BookReaderInit is called', () => {
-    br.plugins.resume.updateResumeValue = jest.fn();
-    br.init();
-    expect(br.plugins.resume.updateResumeValue).toHaveBeenCalledTimes(2);
-  });
-
-  test('handles cookieName=null', () => {
-    const p = new ResumePlugin(null);
-    p.setup({ cookiePath: '/details/goody' });
-    const setItemSpy = sinon.spy(docCookies, 'setItem');
-
-    p.updateResumeValue(16);
-    expect(setItemSpy.callCount).toBe(1);
-    expect(setItemSpy.args[0].slice(0, 2)).toEqual(['br-resume', 16]);
-    expect(setItemSpy.args[0][3]).toEqual('/details/goody');
-  });
-
-  test('handles cookiePath not set', () => {
-    const setItemSpy = sinon.spy(docCookies, 'setItem');
-    // Save function
-    const saveFn = br.plugins.resume.getCookiePath;
-    br.plugins.resume.getCookiePath = jest.fn(() => '/details/foo');
-    br.plugins.resume.updateResumeValue(16);
-    expect(setItemSpy.args[0][3]).toEqual('/details/foo');
-    // Restore function
-    br.plugins.resume.getCookiePath = saveFn;
-  });
-
-  test('handles cookie path from URL with decoration', () => {
-    const complexPathWithPage = '/details/2008ELMValidityStudyFinalReportRevised/Executive%20Summary%20for%20the%20EPT%26ELM%20Validity%20Studie_20100603%20-%20Copy/page/n1/mode/2up';
-    const complexPath = '/details/2008ELMValidityStudyFinalReportRevised/Executive%20Summary%20for%20the%20EPT%26ELM%20Validity%20Studie_20100603%20-%20Copy';
-    expect(br.plugins.resume.getCookiePath(complexPathWithPage))
-      .toEqual(complexPath);
-
-    expect(br.plugins.resume.getCookiePath('/details/item/mode/1up'))
-      .toEqual('/details/item');
-
-    expect(br.plugins.resume.getCookiePath('/details/item/inside/a/long/path/model/is/used'))
-      .toEqual('/details/item/inside/a/long/path/model/is/used');
-
-    expect(br.plugins.resume.getCookiePath('/details/item/inside/a/long/path/mode/is/used'))
-      .toEqual('/details/item/inside/a/long/path');
-  });
-
-  test('handles cookie path from URL with no decoration', () => {
-    expect(br.plugins.resume.getCookiePath('/details/item'))
-      .toEqual('/details/item');
-
-    expect(br.plugins.resume.getCookiePath('/details/item/'))
-      .toEqual('/details/item/');
-
-    expect(br.plugins.resume.getCookiePath('/details/item/almost/any/kind/of/long/path'))
-      .toEqual('/details/item/almost/any/kind/of/long/path');
-  });
-});