@internetarchive/bookreader 5.0.0-65 → 5.0.0-67

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

@@ -1,37 +1,36 @@
-import sinon from 'sinon';
+import sinon from "sinon";
 
-import BookReader from '@/src/BookReader.js';
-import '@/src/plugins/plugin.mobile_nav.js';
-import '@/src/plugins/plugin.chapters.js';
+import BookReader from "@/src/BookReader.js";
+import "@/src/plugins/plugin.mobile_nav.js";
+import "@/src/plugins/plugin.chapters.js";
+import { BookModel } from "@/src/BookReader/BookModel";
+import { deepCopy } from "../utils";
 
 const SAMPLE_TOC = [{
   "pagenum": "3",
   "level": 1,
   "label": "CHAPTER I",
-  "type": {"key": "/type/toc_item"},
+  "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"},
+  "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"},
+  "type": { "key": "/type/toc_item" },
   "title": "THE COUNTRY AND THE MISSION 3",
-  "pageIndex": undefined,
-},
-{
+}, {
   "pagenum": "40",
   "level": 1,
   "label": "CHAPTER IV",
-  "type": {"key": "/type/toc_item"},
+  "type": { "key": "/type/toc_item" },
   "title": "THE COUNTRY AND THE MISSION 4",
   "pageIndex": 40,
 }];
@@ -41,89 +40,107 @@ const SAMPLE_TOC_UNDEF = [
     "pagenum": "undefined",
     "level": 1,
     "label": "CHAPTER I",
-    "type": {"key": "/type/toc_item"},
+    "type": { "key": "/type/toc_item" },
     "title": "THE COUNTRY AND THE MISSION 1",
-    "pageIndex": undefined,
   },
   {
     "pagenum": "undefined",
     "level": 1,
     "label": "CHAPTER II",
-    "type": {"key": "/type/toc_item"},
+    "type": { "key": "/type/toc_item" },
     "title": "THE COUNTRY AND THE MISSION 2",
-    "pageIndex": undefined,
-  }
+  },
 ];
 
-/** @type {BookReader} */
-let br;
-beforeEach(() => {
-  $.ajax = jest.fn().mockImplementation((args) => {
-    return Promise.resolve([{
-      table_of_contents: SAMPLE_TOC,
-    }]);
-  });
-  document.body.innerHTML = '<div id="BookReader">';
-  br = new BookReader();
-});
-
 afterEach(() => {
-  jest.clearAllMocks();
+  sinon.restore();
 });
 
-describe('Plugin: Menu Toggle', () => {
-  test('has option flag', () => {
-    expect(BookReader.defaultOptions.enableChaptersPlugin).toEqual(true);
-  });
-  test('has added BR property: olHost', () => {
-    expect(br).toHaveProperty('olHost');
-    expect(br.olHost).toBeTruthy();
-  });
-  test('has added BR property: bookId', () => {
-    expect(br).toHaveProperty('bookId');
-    expect(br.bookId).toBeFalsy();
-  });
-  test('fetches OL Book Record on init', () => {
-    br.getOpenLibraryRecord = jest.fn();
-    br.init();
-    expect(br.getOpenLibraryRecord).toHaveBeenCalled();
-  });
-  test('Updates Table of Contents when available', () => {
-    br.init();
-    expect($.ajax).toHaveBeenCalled();
+describe("BRChaptersPlugin", () => {
+  beforeEach(() => {
+    sinon.stub(BookModel.prototype, "getPageIndex").callsFake((str) =>
+      parseFloat(str)
+    );
   });
-});
 
-describe('updateTOCState', () => {
+  describe("_chaptersInit", () => {
+    test("does not render when no open library record", async () => {
+      const fakeBR = {
+        options: {},
+        getOpenLibraryRecord: async () => null,
+        _chaptersRender: sinon.stub(),
+      };
+      await BookReader.prototype._chapterInit.call(fakeBR);
+      expect(fakeBR._chaptersRender.callCount).toBe(0);
+    });
 
-  beforeEach(() => {
-    window.HTMLElement.prototype.scrollIntoView = sinon.stub();
-    br.book.getPageIndex = (str) => parseFloat(str);
-    br.init();
-  });
+    test("does not render when open library record with no TOC", async () => {
+      const fakeBR = {
+        options: {},
+        getOpenLibraryRecord: async () => ({ key: "/books/OL1M" }),
+        _chaptersRender: sinon.stub(),
+      };
+      await BookReader.prototype._chapterInit.call(fakeBR);
+      expect(fakeBR._chaptersRender.callCount).toBe(0);
+    });
 
-  test('Test page is one of TOC', () => {
-    br.updateTOCState(20, SAMPLE_TOC);
-    expect($('li.BRtable-contents-el')[1].classList.contains('current-chapter'));
+    test("renders if valid TOC on open library", async () => {
+      const fakeBR = {
+        options: {},
+        bind: sinon.stub(),
+        book: {
+          getPageIndex: (str) => parseFloat(str),
+        },
+        getOpenLibraryRecord: async () => ({
+          "title": "The Adventures of Sherlock Holmes",
+          "table_of_contents": deepCopy(SAMPLE_TOC_UNDEF),
+          "ocaid": "adventureofsherl0000unse",
+        }),
+        _chaptersRender: sinon.stub(),
+      };
+      await BookReader.prototype._chapterInit.call(fakeBR);
+      expect(fakeBR._chaptersRender.callCount).toBe(1);
+    });
   });
 
-  test('Only one element has .current-chapter', () => {
-    br.updateTOCState(9, SAMPLE_TOC);
-    expect($('li.BRtable-contents-el.current-chapter').length).toBe(1);
+  describe('_chaptersRender', () => {
+    test('renders markers and panel', () => {
+      const fakeBR = {
+        _tocEntries: SAMPLE_TOC,
+        _chaptersRenderMarker: sinon.stub(),
+        shell: {
+          menuProviders: {},
+          updateMenuContents: sinon.stub(),
+        }
+      };
+      BookReader.prototype._chaptersRender.call(fakeBR);
+      expect(fakeBR.shell.menuProviders['chapters']).toBeTruthy();
+      expect(fakeBR.shell.updateMenuContents.callCount).toBe(1);
+      expect(fakeBR._chaptersRenderMarker.callCount).toBeGreaterThan(1);
+    });
   });
 
-  test('No chapter has .current-chapter if current index is < than any chapter index', () => {
-    br.updateTOCState(1, SAMPLE_TOC);
-    expect($('li.BRtable-contents-el.current-chapter').length).toBe(0);
-  });
+  describe('_chaptersUpdateCurrent', () => {
+    test('highlights the current chapter', () => {
+      const fakeBR = {
+        mode: 2,
+        firstIndex: 16,
+        displayedIndices: [16, 17],
+        _tocEntries: SAMPLE_TOC,
+        _chaptersPanel: {
+          currentChapter: null,
+        }
+      };
+      BookReader.prototype._chaptersUpdateCurrent.call(fakeBR);
+      expect(fakeBR._chaptersPanel.currentChapter).toEqual(SAMPLE_TOC[1]);
 
-  test('if current index == chapter index ', () => {
-    br.updateTOCState(17, SAMPLE_TOC);
-    expect($('li.BRtable-contents-el')[1].classList.contains('current-chapter'));
-  });
+      fakeBR.mode = 1;
+      BookReader.prototype._chaptersUpdateCurrent.call(fakeBR);
+      expect(fakeBR._chaptersPanel.currentChapter).toEqual(SAMPLE_TOC[0]);
 
-  test('No chapter has .current-chapter if all chapter have undefined pageIndex ', () => {
-    br.updateTOCState(10, SAMPLE_TOC_UNDEF);
-    expect($('li.BRtable-contents-el.current-chapter').length).toBe(0);
+      fakeBR.firstIndex = 0;
+      BookReader.prototype._chaptersUpdateCurrent.call(fakeBR);
+      expect(fakeBR._chaptersPanel.currentChapter).toBeUndefined();
+    });
   });
 });