@internetarchive/bookreader 5.0.0-24-sortingstate-final → 5.0.0-27

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

@@ -0,0 +1,190 @@
+import BookReader from '@/src/BookReader.js';
+import * as utils from '@/src/BookReader/utils.js';
+
+let br;
+beforeAll(() => {
+  document.body.innerHTML = '<div id="BookReader">';
+  br = new BookReader();
+});
+
+afterEach(() => {
+  jest.clearAllMocks();
+});
+
+/**
+ * Only run init() once. Otherwise multiple EventListeners will be added.
+ */
+test('Initialzation enables IntersectionObserver and defaults', () => {
+  const observe = jest.fn();
+  window.IntersectionObserver = jest.fn(() => ({
+    observe
+  }));
+  br.init();
+  expect(br.hasKeyFocus).toBe(true);
+  expect(observe).toHaveBeenCalledTimes(1);
+});
+
+describe('Keyboard shortcuts turned off', () => {
+
+  test('Focus flag disables', () => {
+    br.next = jest.fn();
+    br.hasKeyFocus = false;
+    const keyEvent = new KeyboardEvent('keydown', {'key': 'ArrowDown'});
+    keyEvent.preventDefault = jest.fn();
+    document.dispatchEvent(keyEvent);
+    expect(br.next).toHaveBeenCalledTimes(0);
+    expect(keyEvent.preventDefault).toHaveBeenCalledTimes(0);
+    // Must reset for following tests
+    br.hasKeyFocus = true;
+  });
+
+  test('Input active disables', () => {
+    // eslint-disable-next-line no-import-assign
+    utils.isInputActive = jest.fn(() => true);
+    br.next = jest.fn();
+    const keyEvent = new KeyboardEvent('keydown', {'key': 'ArrowDown'});
+    keyEvent.preventDefault = jest.fn();
+    document.dispatchEvent(keyEvent);
+    expect(br.next).toHaveBeenCalledTimes(0);
+    expect(keyEvent.preventDefault).toHaveBeenCalledTimes(0);
+    // Must reset for following tests
+    utils.isInputActive.mockReset();
+  });
+
+});
+
+describe('Keyboard shortcuts', () => {
+
+  test('Home key', () => {
+    br.first = jest.fn();
+    const keyEvent = new KeyboardEvent('keydown', {'key': 'Home'});
+    keyEvent.preventDefault = jest.fn();
+    document.dispatchEvent(keyEvent);
+    expect(br.first).toHaveBeenCalledTimes(1);
+    expect(keyEvent.preventDefault).toHaveBeenCalledTimes(1);
+  });
+
+  test('End key', () => {
+    br.last = jest.fn();
+    const keyEvent = new KeyboardEvent('keydown', {'key': 'End'});
+    keyEvent.preventDefault = jest.fn();
+    document.dispatchEvent(keyEvent);
+    expect(br.last).toHaveBeenCalledTimes(1);
+    expect(keyEvent.preventDefault).toHaveBeenCalledTimes(1);
+  });
+
+  test('ArrowDown key', () => {
+    br.mode = br.constMode2up;
+    br.next = jest.fn();
+    const keyEvent = new KeyboardEvent('keydown', {'key': 'ArrowDown'});
+    keyEvent.preventDefault = jest.fn();
+    document.dispatchEvent(keyEvent);
+    expect(br.next).toHaveBeenCalledTimes(1);
+    expect(keyEvent.preventDefault).toHaveBeenCalledTimes(1);
+  });
+
+  test('PageDown key', () => {
+    br.mode = br.constMode2up;
+    br.next = jest.fn();
+    const keyEvent = new KeyboardEvent('keydown', {'key': 'PageDown'});
+    keyEvent.preventDefault = jest.fn();
+    document.dispatchEvent(keyEvent);
+    expect(br.next).toHaveBeenCalledTimes(1);
+    expect(keyEvent.preventDefault).toHaveBeenCalledTimes(1);
+  });
+
+  test('ArrowUp key', () => {
+    br.mode = br.constMode2up;
+    br.prev = jest.fn();
+    const keyEvent = new KeyboardEvent('keydown', {'key': 'ArrowUp'});
+    keyEvent.preventDefault = jest.fn();
+    document.dispatchEvent(keyEvent);
+    expect(br.prev).toHaveBeenCalledTimes(1);
+    expect(keyEvent.preventDefault).toHaveBeenCalledTimes(1);
+  });
+
+  test('PageUp key', () => {
+    br.mode = br.constMode2up;
+    br.prev = jest.fn();
+    const keyEvent = new KeyboardEvent('keydown', {'key': 'PageUp'});
+    keyEvent.preventDefault = jest.fn();
+    document.dispatchEvent(keyEvent);
+    expect(br.prev).toHaveBeenCalledTimes(1);
+    expect(keyEvent.preventDefault).toHaveBeenCalledTimes(1);
+  });
+
+  test('ArrowLeft key', () => {
+    br.mode = br.constMode2up;
+    br.left = jest.fn();
+    const keyEvent = new KeyboardEvent('keydown', {'key': 'ArrowLeft'});
+    keyEvent.preventDefault = jest.fn();
+    document.dispatchEvent(keyEvent);
+    expect(br.left).toHaveBeenCalledTimes(1);
+    expect(keyEvent.preventDefault).toHaveBeenCalledTimes(1);
+  });
+
+  test('ArrowRight key', () => {
+    br.mode = br.constMode2up;
+    br.right = jest.fn();
+    const keyEvent = new KeyboardEvent('keydown', {'key': 'ArrowRight'});
+    keyEvent.preventDefault = jest.fn();
+    document.dispatchEvent(keyEvent);
+    expect(br.right).toHaveBeenCalledTimes(1);
+    expect(keyEvent.preventDefault).toHaveBeenCalledTimes(1);
+  });
+
+  test('Subtract key', () => {
+    br.zoom = jest.fn();
+    const keyEvent = new KeyboardEvent('keydown', {'key': 'Subtract'});
+    keyEvent.preventDefault = jest.fn();
+    document.dispatchEvent(keyEvent);
+    expect(br.zoom).toHaveBeenCalledTimes(1);
+    expect(keyEvent.preventDefault).toHaveBeenCalledTimes(1);
+  });
+
+  test('- key', () => {
+    br.zoom = jest.fn();
+    const keyEvent = new KeyboardEvent('keydown', {'key': '-'});
+    keyEvent.preventDefault = jest.fn();
+    document.dispatchEvent(keyEvent);
+    expect(br.zoom).toHaveBeenCalledTimes(1);
+    expect(keyEvent.preventDefault).toHaveBeenCalledTimes(1);
+  });
+
+  test('Add key', () => {
+    br.zoom = jest.fn();
+    const keyEvent = new KeyboardEvent('keydown', {'key': 'Add'});
+    keyEvent.preventDefault = jest.fn();
+    document.dispatchEvent(keyEvent);
+    expect(br.zoom).toHaveBeenCalledTimes(1);
+    expect(keyEvent.preventDefault).toHaveBeenCalledTimes(1);
+  });
+
+  test('+ key', () => {
+    br.zoom = jest.fn();
+    const keyEvent = new KeyboardEvent('keydown', {'key': '+'});
+    keyEvent.preventDefault = jest.fn();
+    document.dispatchEvent(keyEvent);
+    expect(br.zoom).toHaveBeenCalledTimes(1);
+    expect(keyEvent.preventDefault).toHaveBeenCalledTimes(1);
+  });
+
+  test('= key', () => {
+    br.zoom = jest.fn();
+    const keyEvent = new KeyboardEvent('keydown', {'key': '='});
+    keyEvent.preventDefault = jest.fn();
+    document.dispatchEvent(keyEvent);
+    expect(br.zoom).toHaveBeenCalledTimes(1);
+    expect(keyEvent.preventDefault).toHaveBeenCalledTimes(1);
+  });
+
+  test('F key', () => {
+    br.toggleFullscreen = jest.fn();
+    const keyEvent = new KeyboardEvent('keydown', {'key': 'F'});
+    keyEvent.preventDefault = jest.fn();
+    document.dispatchEvent(keyEvent);
+    expect(br.toggleFullscreen).toHaveBeenCalledTimes(1);
+    expect(keyEvent.preventDefault).toHaveBeenCalledTimes(1);
+  });
+
+});

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

@@ -1,7 +1,6 @@
+
 import BookReader from '@/src/BookReader.js';
 import '@/src/plugins/plugin.url.js';
-import { UrlPlugin } from '@/src/plugins/plugin.url.js';
-import sinon from 'sinon';
 
 let br;
 beforeAll(() => {
@@ -11,155 +10,6 @@ beforeAll(() => {
 
 afterEach(() => {
   jest.clearAllMocks();
-  sinon.restore();
-});
-
-
-describe.only('UrlPlugin tests', () => {
-  const urlPlugin = new UrlPlugin();
-
-  describe('urlStateToUrlString tests', () => {
-    test('urlStateToUrlString with known states in schema', () => {
-      const urlState = { page: 'n7', mode: '1up', search: 'foo' };
-      const urlStateWithQueries = { page: 'n7', mode: '1up', q: 'hello', view: 'theater', sort: 'title_asc' };
-
-      const expectedUrlFromState = 'page/n7/mode/1up?q=foo';
-      const expectedUrlFromStateWithQueries = 'page/n7/mode/1up?q=hello&view=theater&sort=title_asc';
-
-      expect(urlPlugin.urlStateToUrlString(urlState)).toBe(expectedUrlFromState);
-      expect(urlPlugin.urlStateToUrlString(urlStateWithQueries)).toBe(expectedUrlFromStateWithQueries);
-    });
-
-    test('urlStateToUrlString with unknown states in schema', () => {
-      const urlState = { page: 'n7', mode: '1up' };
-      const urlStateWithQueries = { page: 'n7', mode: '1up', q: 'hello', viewer: 'theater', sortBy: 'title_asc' };
-
-      const expectedUrlFromState = 'page/n7/mode/1up';
-      const expectedUrlFromStateWithQueries = 'page/n7/mode/1up?q=hello&viewer=theater&sortBy=title_asc';
-
-      expect(urlPlugin.urlStateToUrlString(urlState)).toBe(expectedUrlFromState);
-      expect(urlPlugin.urlStateToUrlString(urlStateWithQueries)).toBe(expectedUrlFromStateWithQueries);
-    });
-
-    test('urlStateToUrlString with boolean value', () => {
-      const urlState = { page: 'n7', mode: '1up', search: 'foo', view: 'theater', wrapper: 'false' };
-      const expectedUrlFromState = 'page/n7/mode/1up?q=foo&view=theater&wrapper=false';
-
-      expect(urlPlugin.urlStateToUrlString(urlState)).toBe(expectedUrlFromState);
-    });
-  });
-
-  describe('urlStringToUrlState tests', () => {
-    test('urlStringToUrlState without query string', () => {
-      const url = '/page/n7/mode/2up';
-      const url1 = '/page/n7/mode/1up';
-
-      expect(urlPlugin.urlStringToUrlState(url)).toEqual({page: 'n7', mode: '2up'});
-      expect(urlPlugin.urlStringToUrlState(url1)).toEqual({page: 'n7', mode: '1up'});
-    });
-
-    test('urlStringToUrlState with deprecated_for', () => {
-      const url = '/page/n7/mode/2up/search/hello';
-
-      expect(urlPlugin.urlStringToUrlState(url)).toEqual({page: 'n7', mode: '2up', q: 'hello'});
-    });
-
-    test('urlStringToUrlState with query string', () => {
-      const url = '/page/n7/mode/2up/search/hello?view=theather&foo=bar&sort=title_asc';
-      const url1 = '/mode/2up?ref=ol&ui=embed&wrapper=false&view=theater';
-
-      expect(urlPlugin.urlStringToUrlState(url)).toEqual(
-        {page: 'n7', mode: '2up', q: 'hello', view: 'theather', foo: 'bar', sort: 'title_asc'}
-      );
-      expect(urlPlugin.urlStringToUrlState(url1)).toEqual(
-        {page: 'n0', mode: '2up', ref: 'ol', ui: 'embed', wrapper: 'false', view: 'theater'}
-      );
-    });
-
-    test('urlStringToUrlState compare search and ?q', () => {
-      const url = '/page/n7/mode/2up/search/hello';
-      urlPlugin.urlState = { q: 'hello' };
-
-      expect(urlPlugin.urlStringToUrlState(url)).toEqual({page: 'n7', mode: '2up', q: 'hello'});
-    });
-  });
-
-  describe('url plugin helper functions', () => {
-    test('setUrlParam', () => {
-      urlPlugin.urlState = {};
-      urlPlugin.setUrlParam('page', '20');
-      urlPlugin.setUrlParam('mode', '2up');
-
-      expect(urlPlugin.urlState).toEqual({page: '20', mode: '2up'});
-    });
-
-    test('removeUrlParam', () => {
-      urlPlugin.setUrlParam('page', '20');
-      urlPlugin.setUrlParam('mode', '2up');
-      urlPlugin.removeUrlParam('mode');
-
-      expect(urlPlugin.urlState).toEqual({page: '20'});
-    });
-
-    test('getUrlParam', () => {
-      urlPlugin.setUrlParam('page', '20');
-      urlPlugin.setUrlParam('mode', '2up');
-      expect(urlPlugin.getUrlParam('page')).toEqual('20');
-      expect(urlPlugin.getUrlParam('mode')).toEqual('2up');
-    });
-  });
-
-  describe('pullFromAddressBar and pushToAddressBar - hash mode', () => {
-    test('url without mode state value - use default', () => {
-      urlPlugin.urlState = {};
-      urlPlugin.urlMode = 'hash';
-
-      urlPlugin.pullFromAddressBar({ pathname: '', search: '', hash: '#page/12' });
-      expect(urlPlugin.urlState).toEqual({page: '12', mode: '2up'});
-
-      urlPlugin.pushToAddressBar();
-      expect(window.location.hash).toEqual('#page/12/mode/2up');
-    });
-
-    test('url with query param', () => {
-      urlPlugin.urlState = {};
-      urlPlugin.urlMode = 'hash';
-
-      urlPlugin.pullFromAddressBar({ pathname: '', search: '', hash: '#page/12?q=hello&view=theater' });
-      expect(urlPlugin.urlState).toEqual({page: '12', mode: '2up', q: 'hello', view: 'theater'});
-
-      urlPlugin.pushToAddressBar();
-      expect(window.location.hash).toEqual('#page/12/mode/2up?q=hello&view=theater');
-    });
-  });
-
-  describe('pullFromAddressBar and pushToAddressBar - history mode', () => {
-    test('url without mode state value - use default', () => {
-      urlPlugin.urlState = {};
-      urlPlugin.urlHistoryBasePath = '/details/foo';
-      urlPlugin.urlMode = 'history';
-
-      urlPlugin.pullFromAddressBar({ pathname: '/details/foo/page/12', search: '', hash: '' });
-      expect(urlPlugin.urlState).toEqual({page: '12', mode: '2up'});
-
-      urlPlugin.pushToAddressBar();
-      expect(window.location.pathname).toEqual('/details/foo/page/12/mode/2up');
-    });
-
-    test('url with query param', () => {
-      urlPlugin.urlState = {};
-      urlPlugin.urlHistoryBasePath = '/details/foo';
-      urlPlugin.urlMode = 'history';
-
-      urlPlugin.pullFromAddressBar({ pathname: '/details/foo/page/12', search: '?q=hello&view=theater', hash: '' });
-      expect(urlPlugin.urlState).toEqual({page: '12', mode: '2up', q: 'hello', view: 'theater'});
-
-      urlPlugin.pushToAddressBar();
-      const locationUrl = `${window.location.pathname}${window.location.search}`;
-      expect(locationUrl).toEqual('/details/foo/page/12/mode/2up?q=hello&view=theater');
-    });
-  });
-
 });
 
 describe('Plugin: URL controller', () => {

package/tests/karma/BookNavigator/volumes/volumes-provider.test.js

@@ -64,7 +64,7 @@ describe('Volumes Provider', () => {
     const baseHost = "https://archive.org";
     const provider = new volumesProvider(baseHost, brOptions, onSortClick);
 
-    expect(provider.sortOrderBy).to.equal("default");
+    expect(provider.sortOrderBy).to.equal("orig_sort");
 
     provider.sortVolumes("title_asc");
     expect(provider.sortOrderBy).to.equal("title_asc");
@@ -74,8 +74,8 @@ describe('Volumes Provider', () => {
     expect(provider.sortOrderBy).to.equal("title_desc");
     expect(provider.sortButton.getHTML()).includes("sort-by desc-icon");
 
-    provider.sortVolumes("default");
-    expect(provider.sortOrderBy).to.equal("default");
+    provider.sortVolumes("orig_sort");
+    expect(provider.sortOrderBy).to.equal("orig_sort");
     expect(provider.sortButton.getHTML()).includes("sort-by neutral-icon");
   });
 
@@ -88,9 +88,9 @@ describe('Volumes Provider', () => {
     const files = Object.keys(parsedFiles).map(item => parsedFiles[item]).sort((a, b) => a.orig_sort - b.orig_sort);
     const origSortTitles = files.map(item => item.title);
 
-    provider.sortVolumes("default");
+    provider.sortVolumes("orig_sort");
 
-    expect(provider.sortOrderBy).to.equal("default");
+    expect(provider.sortOrderBy).to.equal("orig_sort");
     expect(provider.actionButton).to.exist;
 
     const providerFileTitles = provider.viewableFiles.map(item => item.title);
@@ -144,7 +144,7 @@ describe('Volumes Provider', () => {
       const baseHost = "https://archive.org";
       const provider = new volumesProvider(baseHost, brOptions, onSortClick);
 
-      provider.sortOrderBy = 'default';
+      provider.sortOrderBy = 'orig_sort';
       const origSortButton = await fixture(provider.sortButton);
       expect(origSortButton.classList.contains('neutral-icon')).to.be.true;
 

package/.nvmrc

@@ -1 +0,0 @@
-14