Merge pull request #587 from ueokande/refactor-content

Refactor content scripts

10 files changed, 379 insertions, 0 deletions

diff --git a/src/content/controllers/AddonEnabledController.ts b/src/content/controllers/AddonEnabledController.ts
new file mode 100644
index 0000000..4e19b6a
--- /dev/null
+++ b/src/content/controllers/AddonEnabledController.ts
@@ -0,0 +1,19 @@
+import * as messages from '../../shared/messages';
+import AddonEnabledUseCase from '../usecases/AddonEnabledUseCase';
+
+export default class AddonEnabledController {
+  private addonEnabledUseCase: AddonEnabledUseCase;
+
+  constructor({
+    addonEnabledUseCase = new AddonEnabledUseCase(),
+  } = {}) {
+    this.addonEnabledUseCase = addonEnabledUseCase;
+  }
+
+  getAddonEnabled(
+    _message: messages.AddonEnabledQueryMessage,
+  ): Promise<boolean> {
+    let enabled = this.addonEnabledUseCase.getEnabled();
+    return Promise.resolve(enabled);
+  }
+}
diff --git a/src/content/controllers/ConsoleFrameController.ts b/src/content/controllers/ConsoleFrameController.ts
new file mode 100644
index 0000000..fafadf4
--- /dev/null
+++ b/src/content/controllers/ConsoleFrameController.ts
@@ -0,0 +1,16 @@
+import ConsoleFrameUseCase from '../usecases/ConsoleFrameUseCase';
+import * as messages from '../../shared/messages';
+
+export default class ConsoleFrameController {
+  private consoleFrameUseCase: ConsoleFrameUseCase;
+
+  constructor({
+    consoleFrameUseCase = new ConsoleFrameUseCase(),
+  } = {}) {
+    this.consoleFrameUseCase = consoleFrameUseCase;
+  }
+
+  unfocus(_message: messages.Message) {
+    this.consoleFrameUseCase.unfocus();
+  }
+}
diff --git a/src/content/controllers/FindController.ts b/src/content/controllers/FindController.ts
new file mode 100644
index 0000000..cf27a8d
--- /dev/null
+++ b/src/content/controllers/FindController.ts
@@ -0,0 +1,24 @@
+import * as messages from '../../shared/messages';
+import FindUseCase from '../usecases/FindUseCase';
+
+export default class FindController {
+  private findUseCase: FindUseCase;
+
+  constructor({
+    findUseCase = new FindUseCase(),
+  } = {}) {
+    this.findUseCase = findUseCase;
+  }
+
+  async start(m: messages.ConsoleEnterFindMessage): Promise<void> {
+    await this.findUseCase.startFind(m.text);
+  }
+
+  async next(_: messages.FindNextMessage): Promise<void> {
+    await this.findUseCase.findNext();
+  }
+
+  async prev(_: messages.FindPrevMessage): Promise<void> {
+    await this.findUseCase.findPrev();
+  }
+}
diff --git a/src/content/controllers/FollowKeyController.ts b/src/content/controllers/FollowKeyController.ts
new file mode 100644
index 0000000..eb45e01
--- /dev/null
+++ b/src/content/controllers/FollowKeyController.ts
@@ -0,0 +1,21 @@
+import FollowSlaveUseCase from '../usecases/FollowSlaveUseCase';
+import Key from '../domains/Key';
+
+export default class FollowKeyController {
+  private followSlaveUseCase: FollowSlaveUseCase;
+
+  constructor({
+    followSlaveUseCase = new FollowSlaveUseCase(),
+  } = {}) {
+    this.followSlaveUseCase = followSlaveUseCase;
+  }
+
+  press(key: Key): boolean {
+    if (!this.followSlaveUseCase.isFollowMode()) {
+      return false;
+    }
+
+    this.followSlaveUseCase.sendKey(key);
+    return true;
+  }
+}
diff --git a/src/content/controllers/FollowMasterController.ts b/src/content/controllers/FollowMasterController.ts
new file mode 100644
index 0000000..89294ff
--- /dev/null
+++ b/src/content/controllers/FollowMasterController.ts
@@ -0,0 +1,31 @@
+import FollowMasterUseCase from '../usecases/FollowMasterUseCase';
+import * as messages from '../../shared/messages';
+
+export default class FollowMasterController {
+  private followMasterUseCase: FollowMasterUseCase;
+
+  constructor({
+    followMasterUseCase = new FollowMasterUseCase(),
+  } = {}) {
+    this.followMasterUseCase = followMasterUseCase;
+  }
+
+  followStart(m: messages.FollowStartMessage): void {
+    this.followMasterUseCase.startFollow(m.newTab, m.background);
+  }
+
+  responseCountTargets(
+    m: messages.FollowResponseCountTargetsMessage, sender: Window,
+  ): void {
+    this.followMasterUseCase.createSlaveHints(m.count, sender);
+  }
+
+  keyPress(message: messages.FollowKeyPressMessage): void {
+    if (message.key === '[' && message.ctrlKey) {
+      this.followMasterUseCase.cancelFollow();
+    } else {
+      this.followMasterUseCase.enqueue(message.key);
+    }
+  }
+}
+
diff --git a/src/content/controllers/FollowSlaveController.ts b/src/content/controllers/FollowSlaveController.ts
new file mode 100644
index 0000000..88dccf3
--- /dev/null
+++ b/src/content/controllers/FollowSlaveController.ts
@@ -0,0 +1,32 @@
+import * as messages from '../../shared/messages';
+import FollowSlaveUseCase from '../usecases/FollowSlaveUseCase';
+
+export default class FollowSlaveController {
+  private usecase: FollowSlaveUseCase;
+
+  constructor({
+    usecase = new FollowSlaveUseCase(),
+  } = {}) {
+    this.usecase = usecase;
+  }
+
+  countTargets(m: messages.FollowRequestCountTargetsMessage): void {
+    this.usecase.countTargets(m.viewSize, m.framePosition);
+  }
+
+  createHints(m: messages.FollowCreateHintsMessage): void {
+    this.usecase.createHints(m.viewSize, m.framePosition, m.tags);
+  }
+
+  showHints(m: messages.FollowShowHintsMessage): void {
+    this.usecase.showHints(m.prefix);
+  }
+
+  activate(m: messages.FollowActivateMessage): void {
+    this.usecase.activate(m.tag, m.newTab, m.background);
+  }
+
+  clear(_m: messages.FollowRemoveHintsMessage) {
+    this.usecase.clear();
+  }
+}
diff --git a/src/content/controllers/KeymapController.ts b/src/content/controllers/KeymapController.ts
new file mode 100644
index 0000000..20c24c0
--- /dev/null
+++ b/src/content/controllers/KeymapController.ts
@@ -0,0 +1,148 @@
+import * as operations from '../../shared/operations';
+import KeymapUseCase from '../usecases/KeymapUseCase';
+import AddonEnabledUseCase from '../usecases/AddonEnabledUseCase';
+import FindSlaveUseCase from '../usecases/FindSlaveUseCase';
+import ScrollUseCase from '../usecases/ScrollUseCase';
+import NavigateUseCase from '../usecases/NavigateUseCase';
+import FocusUseCase from '../usecases/FocusUseCase';
+import ClipboardUseCase from '../usecases/ClipboardUseCase';
+import BackgroundClient from '../client/BackgroundClient';
+import MarkKeyyUseCase from '../usecases/MarkKeyUseCase';
+import FollowMasterClient, { FollowMasterClientImpl }
+  from '../client/FollowMasterClient';
+import Key from '../domains/Key';
+
+export default class KeymapController {
+  private keymapUseCase: KeymapUseCase;
+
+  private addonEnabledUseCase: AddonEnabledUseCase;
+
+  private findSlaveUseCase: FindSlaveUseCase;
+
+  private scrollUseCase: ScrollUseCase;
+
+  private navigateUseCase: NavigateUseCase;
+
+  private focusUseCase: FocusUseCase;
+
+  private clipbaordUseCase: ClipboardUseCase;
+
+  private backgroundClient: BackgroundClient;
+
+  private markKeyUseCase: MarkKeyyUseCase;
+
+  private followMasterClient: FollowMasterClient;
+
+  constructor({
+    keymapUseCase = new KeymapUseCase(),
+    addonEnabledUseCase = new AddonEnabledUseCase(),
+    findSlaveUseCase = new FindSlaveUseCase(),
+    scrollUseCase = new ScrollUseCase(),
+    navigateUseCase = new NavigateUseCase(),
+    focusUseCase = new FocusUseCase(),
+    clipbaordUseCase = new ClipboardUseCase(),
+    backgroundClient = new BackgroundClient(),
+    markKeyUseCase = new MarkKeyyUseCase(),
+    followMasterClient = new FollowMasterClientImpl(window.top),
+  } = {}) {
+    this.keymapUseCase = keymapUseCase;
+    this.addonEnabledUseCase = addonEnabledUseCase;
+    this.findSlaveUseCase = findSlaveUseCase;
+    this.scrollUseCase = scrollUseCase;
+    this.navigateUseCase = navigateUseCase;
+    this.focusUseCase = focusUseCase;
+    this.clipbaordUseCase = clipbaordUseCase;
+    this.backgroundClient = backgroundClient;
+    this.markKeyUseCase = markKeyUseCase;
+    this.followMasterClient = followMasterClient;
+  }
+
+  // eslint-disable-next-line complexity, max-lines-per-function
+  press(key: Key): boolean {
+    let op = this.keymapUseCase.nextOp(key);
+    if (op === null) {
+      return false;
+    }
+
+    // do not await due to return a boolean immediately
+    switch (op.type) {
+    case operations.ADDON_ENABLE:
+      this.addonEnabledUseCase.enable();
+      break;
+    case operations.ADDON_DISABLE:
+      this.addonEnabledUseCase.disable();
+      break;
+    case operations.ADDON_TOGGLE_ENABLED:
+      this.addonEnabledUseCase.toggle();
+      break;
+    case operations.FIND_NEXT:
+      this.findSlaveUseCase.findNext();
+      break;
+    case operations.FIND_PREV:
+      this.findSlaveUseCase.findPrev();
+      break;
+    case operations.SCROLL_VERTICALLY:
+      this.scrollUseCase.scrollVertically(op.count);
+      break;
+    case operations.SCROLL_HORIZONALLY:
+      this.scrollUseCase.scrollHorizonally(op.count);
+      break;
+    case operations.SCROLL_PAGES:
+      this.scrollUseCase.scrollPages(op.count);
+      break;
+    case operations.SCROLL_TOP:
+      this.scrollUseCase.scrollToTop();
+      break;
+    case operations.SCROLL_BOTTOM:
+      this.scrollUseCase.scrollToBottom();
+      break;
+    case operations.SCROLL_HOME:
+      this.scrollUseCase.scrollToHome();
+      break;
+    case operations.SCROLL_END:
+      this.scrollUseCase.scrollToEnd();
+      break;
+    case operations.FOLLOW_START:
+      this.followMasterClient.startFollow(op.newTab, op.background);
+      break;
+    case operations.MARK_SET_PREFIX:
+      this.markKeyUseCase.enableSetMode();
+      break;
+    case operations.MARK_JUMP_PREFIX:
+      this.markKeyUseCase.enableJumpMode();
+      break;
+    case operations.NAVIGATE_HISTORY_PREV:
+      this.navigateUseCase.openHistoryPrev();
+      break;
+    case operations.NAVIGATE_HISTORY_NEXT:
+      this.navigateUseCase.openHistoryNext();
+      break;
+    case operations.NAVIGATE_LINK_PREV:
+      this.navigateUseCase.openLinkPrev();
+      break;
+    case operations.NAVIGATE_LINK_NEXT:
+      this.navigateUseCase.openLinkNext();
+      break;
+    case operations.NAVIGATE_PARENT:
+      this.navigateUseCase.openParent();
+      break;
+    case operations.NAVIGATE_ROOT:
+      this.navigateUseCase.openRoot();
+      break;
+    case operations.FOCUS_INPUT:
+      this.focusUseCase.focusFirstInput();
+      break;
+    case operations.URLS_YANK:
+      this.clipbaordUseCase.yankCurrentURL();
+      break;
+    case operations.URLS_PASTE:
+      this.clipbaordUseCase.openOrSearch(
+        op.newTab ? op.newTab : false,
+      );
+      break;
+    default:
+      this.backgroundClient.execBackgroundOp(op);
+    }
+    return true;
+  }
+}
diff --git a/src/content/controllers/MarkController.ts b/src/content/controllers/MarkController.ts
new file mode 100644
index 0000000..365794c
--- /dev/null
+++ b/src/content/controllers/MarkController.ts
@@ -0,0 +1,16 @@
+import * as messages from '../../shared/messages';
+import MarkUseCase from '../usecases/MarkUseCase';
+
+export default class MarkController {
+  private markUseCase: MarkUseCase;
+
+  constructor({
+    markUseCase = new MarkUseCase(),
+  } = {}) {
+    this.markUseCase = markUseCase;
+  }
+
+  scrollTo(message: messages.TabScrollToMessage) {
+    this.markUseCase.scroll(message.x, message.y);
+  }
+}
diff --git a/src/content/controllers/MarkKeyController.ts b/src/content/controllers/MarkKeyController.ts
new file mode 100644
index 0000000..395dee3
--- /dev/null
+++ b/src/content/controllers/MarkKeyController.ts
@@ -0,0 +1,31 @@
+import MarkUseCase from '../usecases/MarkUseCase';
+import MarkKeyyUseCase from '../usecases/MarkKeyUseCase';
+import Key from '../domains/Key';
+
+export default class MarkKeyController {
+  private markUseCase: MarkUseCase;
+
+  private markKeyUseCase: MarkKeyyUseCase;
+
+  constructor({
+    markUseCase = new MarkUseCase(),
+    markKeyUseCase = new MarkKeyyUseCase(),
+  } = {}) {
+    this.markUseCase = markUseCase;
+    this.markKeyUseCase = markKeyUseCase;
+  }
+
+  press(key: Key): boolean {
+    if (this.markKeyUseCase.isSetMode()) {
+      this.markUseCase.set(key.key);
+      this.markKeyUseCase.disableSetMode();
+      return true;
+    }
+    if (this.markKeyUseCase.isJumpMode()) {
+      this.markUseCase.jump(key.key);
+      this.markKeyUseCase.disableJumpMode();
+      return true;
+    }
+    return false;
+  }
+}
diff --git a/src/content/controllers/SettingController.ts b/src/content/controllers/SettingController.ts
new file mode 100644
index 0000000..f0e770b
--- /dev/null
+++ b/src/content/controllers/SettingController.ts
@@ -0,0 +1,41 @@
+import AddonEnabledUseCase from '../usecases/AddonEnabledUseCase';
+import SettingUseCase from '../usecases/SettingUseCase';
+import * as blacklists from '../../shared/blacklists';
+
+import * as messages from '../../shared/messages';
+
+export default class SettingController {
+  private addonEnabledUseCase: AddonEnabledUseCase;
+
+  private settingUseCase: SettingUseCase;
+
+  constructor({
+    addonEnabledUseCase = new AddonEnabledUseCase(),
+    settingUseCase = new SettingUseCase(),
+  } = {}) {
+    this.addonEnabledUseCase = addonEnabledUseCase;
+    this.settingUseCase = settingUseCase;
+  }
+
+  async initSettings(): Promise<void> {
+    try {
+      let current = await this.settingUseCase.reload();
+      let disabled = blacklists.includes(
+        current.blacklist, window.location.href,
+      );
+      if (disabled) {
+        this.addonEnabledUseCase.disable();
+      } else {
+        this.addonEnabledUseCase.enable();
+      }
+    } catch (e) {
+      // Sometime sendMessage fails when background script is not ready.
+      console.warn(e);
+      setTimeout(() => this.initSettings(), 500);
+    }
+  }
+
+  async reloadSettings(_message: messages.Message): Promise<void> {
+    await this.settingUseCase.reload();
+  }
+}