Merge pull request #654 from ueokande/settings-as-a-class

Refactor settings on shared logics

6 files changed, 76 insertions, 236 deletions

diff --git a/test/content/InputDriver.test.ts b/test/content/InputDriver.test.ts
index b9f2c28..441d107 100644
--- a/test/content/InputDriver.test.ts
+++ b/test/content/InputDriver.test.ts
@@ -1,6 +1,6 @@
-import InputDriver from '../../src/content/InputDriver';
+import InputDriver, {keyFromKeyboardEvent} from '../../src/content/InputDriver';
 import { expect } from 'chai';
-import Key from '../../src/content/domains/Key';
+import Key from '../../src/shared/settings/Key';
 
 describe('InputDriver', () => {
   let target: HTMLElement;
@@ -21,10 +21,10 @@ describe('InputDriver', () => {
   it('register callbacks', (done) => {
     driver.onKey((key: Key): boolean => {
       expect(key.key).to.equal('a');
-      expect(key.ctrlKey).to.be.true;
-      expect(key.shiftKey).to.be.false;
-      expect(key.altKey).to.be.false;
-      expect(key.metaKey).to.be.false;
+      expect(key.ctrl).to.be.true;
+      expect(key.shift).to.be.false;
+      expect(key.alt).to.be.false;
+      expect(key.meta).to.be.false;
       done();
       return true;
     });
@@ -68,15 +68,15 @@ describe('InputDriver', () => {
 
   it('propagates and stop handler chain', () => {
     let a = 0, b = 0, c = 0;
-    driver.onKey((key: Key): boolean => {
+    driver.onKey((_key: Key): boolean => {
       a++;
       return false;
     });
-    driver.onKey((key: Key): boolean => {
+    driver.onKey((_key: Key): boolean => {
       b++;
       return true;
     });
-    driver.onKey((key: Key): boolean => {
+    driver.onKey((_key: Key): boolean => {
       c++;
       return true;
     });
@@ -89,7 +89,7 @@ describe('InputDriver', () => {
   })
 
   it('does not invoke only meta keys', () => {
-    driver.onKey((key: Key): boolean=> {
+    driver.onKey((_key: Key): boolean=> {
       expect.fail();
       return false;
     });
@@ -115,7 +115,7 @@ describe('InputDriver', () => {
   it('ignores events from contenteditable elements', () => {
     let div = window.document.createElement('div');
     let driver = new InputDriver(div);
-    driver.onKey((key: Key): boolean => {
+    driver.onKey((_key: Key): boolean => {
       expect.fail();
       return false;
     });
@@ -127,3 +127,50 @@ describe('InputDriver', () => {
     div.dispatchEvent(new KeyboardEvent('keydown', { key: 'x' }));
   });
 });
+
+describe("#keyFromKeyboardEvent", () => {
+  it('returns from keyboard input Ctrl+X', () => {
+    let k = keyFromKeyboardEvent(new KeyboardEvent('keydown', {
+      key: 'x', shiftKey: false, ctrlKey: true, altKey: false, metaKey: true,
+    }));
+    expect(k.key).to.equal('x');
+    expect(k.shift).to.be.false;
+    expect(k.ctrl).to.be.true;
+    expect(k.alt).to.be.false;
+    expect(k.meta).to.be.true;
+  });
+
+  it('returns from keyboard input Shift+Esc', () => {
+    let k = keyFromKeyboardEvent(new KeyboardEvent('keydown', {
+      key: 'Escape', shiftKey: true, ctrlKey: false, altKey: false, metaKey: true
+    }));
+    expect(k.key).to.equal('Esc');
+    expect(k.shift).to.be.true;
+    expect(k.ctrl).to.be.false;
+    expect(k.alt).to.be.false;
+    expect(k.meta).to.be.true;
+  });
+
+  it('returns from keyboard input Ctrl+$', () => {
+    // $ required shift pressing on most keyboards
+    let k = keyFromKeyboardEvent(new KeyboardEvent('keydown', {
+      key: '$', shiftKey: true, ctrlKey: true, altKey: false, metaKey: false
+    }));
+    expect(k.key).to.equal('$');
+    expect(k.shift).to.be.false;
+    expect(k.ctrl).to.be.true;
+    expect(k.alt).to.be.false;
+    expect(k.meta).to.be.false;
+  });
+
+  it('returns from keyboard input Crtl+Space', () => {
+    let k = keyFromKeyboardEvent(new KeyboardEvent('keydown', {
+      key: ' ', shiftKey: false, ctrlKey: true, altKey: false, metaKey: false
+    }));
+    expect(k.key).to.equal('Space');
+    expect(k.shift).to.be.false;
+    expect(k.ctrl).to.be.true;
+    expect(k.alt).to.be.false;
+    expect(k.meta).to.be.false;
+  });
+});
diff --git a/test/content/domains/Key.test.ts b/test/content/domains/Key.test.ts
deleted file mode 100644
index b3f9fb6..0000000
--- a/test/content/domains/Key.test.ts
+++ /dev/null
@@ -1,137 +0,0 @@
-import Key, * as keys from '../../../src/content/domains/Key';
-import { expect } from 'chai'
-
-describe("Key", () => {
-  describe('fromKeyboardEvent', () => {
-    it('returns from keyboard input Ctrl+X', () => {
-      let k = keys.fromKeyboardEvent(new KeyboardEvent('keydown', {
-        key: 'x', shiftKey: false, ctrlKey: true, altKey: false, metaKey: true,
-      }));
-      expect(k.key).to.equal('x');
-      expect(k.shiftKey).to.be.false;
-      expect(k.ctrlKey).to.be.true;
-      expect(k.altKey).to.be.false;
-      expect(k.metaKey).to.be.true;
-    });
-
-    it('returns from keyboard input Shift+Esc', () => {
-      let k = keys.fromKeyboardEvent(new KeyboardEvent('keydown', {
-        key: 'Escape', shiftKey: true, ctrlKey: false, altKey: false, metaKey: true
-      }));
-      expect(k.key).to.equal('Esc');
-      expect(k.shiftKey).to.be.true;
-      expect(k.ctrlKey).to.be.false;
-      expect(k.altKey).to.be.false;
-      expect(k.metaKey).to.be.true;
-    });
-
-    it('returns from keyboard input Ctrl+$', () => {
-      // $ required shift pressing on most keyboards
-      let k = keys.fromKeyboardEvent(new KeyboardEvent('keydown', {
-        key: '$', shiftKey: true, ctrlKey: true, altKey: false, metaKey: false
-      }));
-      expect(k.key).to.equal('$');
-      expect(k.shiftKey).to.be.false;
-      expect(k.ctrlKey).to.be.true;
-      expect(k.altKey).to.be.false;
-      expect(k.metaKey).to.be.false;
-    });
-
-    it('returns from keyboard input Crtl+Space', () => {
-      let k = keys.fromKeyboardEvent(new KeyboardEvent('keydown', {
-        key: ' ', shiftKey: false, ctrlKey: true, altKey: false, metaKey: false
-      }));
-      expect(k.key).to.equal('Space');
-      expect(k.shiftKey).to.be.false;
-      expect(k.ctrlKey).to.be.true;
-      expect(k.altKey).to.be.false;
-      expect(k.metaKey).to.be.false;
-    });
-  });
-
-  describe('fromMapKey', () => {
-    it('return for X', () => {
-      let key = keys.fromMapKey('x');
-      expect(key.key).to.equal('x');
-      expect(key.shiftKey).to.be.false;
-      expect(key.ctrlKey).to.be.false;
-      expect(key.altKey).to.be.false;
-      expect(key.metaKey).to.be.false;
-    });
-
-    it('return for Shift+X', () => {
-      let key = keys.fromMapKey('X');
-      expect(key.key).to.equal('X');
-      expect(key.shiftKey).to.be.true;
-      expect(key.ctrlKey).to.be.false;
-      expect(key.altKey).to.be.false;
-      expect(key.metaKey).to.be.false;
-    });
-
-    it('return for Ctrl+X', () => {
-      let key = keys.fromMapKey('<C-X>');
-      expect(key.key).to.equal('x');
-      expect(key.shiftKey).to.be.false;
-      expect(key.ctrlKey).to.be.true;
-      expect(key.altKey).to.be.false;
-      expect(key.metaKey).to.be.false;
-    });
-
-    it('returns for Ctrl+Meta+X', () => {
-      let key = keys.fromMapKey('<C-M-X>');
-      expect(key.key).to.equal('x');
-      expect(key.shiftKey).to.be.false;
-      expect(key.ctrlKey).to.be.true;
-      expect(key.altKey).to.be.false;
-      expect(key.metaKey).to.be.true;
-    });
-
-    it('returns for Ctrl+Shift+x', () => {
-      let key = keys.fromMapKey('<C-S-x>');
-      expect(key.key).to.equal('X');
-      expect(key.shiftKey).to.be.true;
-      expect(key.ctrlKey).to.be.true;
-      expect(key.altKey).to.be.false;
-      expect(key.metaKey).to.be.false;
-    });
-
-    it('returns for Shift+Esc', () => {
-      let key = keys.fromMapKey('<S-Esc>');
-      expect(key.key).to.equal('Esc');
-      expect(key.shiftKey).to.be.true;
-      expect(key.ctrlKey).to.be.false;
-      expect(key.altKey).to.be.false;
-      expect(key.metaKey).to.be.false;
-    });
-
-    it('returns for Ctrl+Esc', () => {
-      let key = keys.fromMapKey('<C-Esc>');
-      expect(key.key).to.equal('Esc');
-      expect(key.shiftKey).to.be.false;
-      expect(key.ctrlKey).to.be.true;
-      expect(key.altKey).to.be.false;
-      expect(key.metaKey).to.be.false;
-    });
-
-    it('returns for Ctrl+Esc', () => {
-      let key = keys.fromMapKey('<C-Space>');
-      expect(key.key).to.equal('Space');
-      expect(key.shiftKey).to.be.false;
-      expect(key.ctrlKey).to.be.true;
-      expect(key.altKey).to.be.false;
-      expect(key.metaKey).to.be.false;
-    });
-  });
-
-  describe('equals', () => {
-    expect(keys.equals(
-      { key: 'x', ctrlKey: true, },
-      { key: 'x', ctrlKey: true, },
-    )).to.be.true;
-
-    expect(keys.equals(
-      { key: 'X', shiftKey: true, },
-      { key: 'x', ctrlKey: true, },
-    )).to.be.false;
-  });
-});
diff --git a/test/content/domains/KeySequence.test.ts b/test/content/domains/KeySequence.test.ts
deleted file mode 100644
index 7387c06..0000000
--- a/test/content/domains/KeySequence.test.ts
+++ /dev/null
@@ -1,72 +0,0 @@
-import KeySequence, * as utils from '../../../src/content/domains/KeySequence';
-import { expect } from 'chai'
-
-describe("KeySequence", () => {
-  describe('#push', () => {
-    it('append a key to the sequence', () => {
-      let seq = KeySequence.from([]);
-      seq.push({ key: 'g' });
-      seq.push({ key: 'u', shiftKey: true });
-
-      let array = seq.getKeyArray();
-      expect(array[0]).to.deep.equal({ key: 'g' });
-      expect(array[1]).to.deep.equal({ key: 'u', shiftKey: true });
-    })
-  });
-
-  describe('#startsWith', () => {
-    it('returns true if the key sequence starts with param', () => {
-      let seq = KeySequence.from([
-        { key: 'g' },
-        { key: 'u', shiftKey: true },
-      ]);
-
-      expect(seq.startsWith(KeySequence.from([
-      ]))).to.be.true;
-      expect(seq.startsWith(KeySequence.from([
-        { key: 'g' },
-      ]))).to.be.true;
-      expect(seq.startsWith(KeySequence.from([
-        { key: 'g' }, { key: 'u', shiftKey: true },
-      ]))).to.be.true;
-      expect(seq.startsWith(KeySequence.from([
-        { key: 'g' }, { key: 'u', shiftKey: true }, { key: 'x' },
-      ]))).to.be.false;
-      expect(seq.startsWith(KeySequence.from([
-        { key: 'h' },
-      ]))).to.be.false;
-    })
-
-    it('returns true if the empty sequence starts with an empty sequence', () => {
-      let seq = KeySequence.from([]);
-
-      expect(seq.startsWith(KeySequence.from([]))).to.be.true;
-      expect(seq.startsWith(KeySequence.from([
-        { key: 'h' },
-      ]))).to.be.false;
-    })
-  });
-
-  describe('#fromMapKeys', () => {
-    it('returns mapped keys for Shift+Esc', () => {
-      let keyArray = utils.fromMapKeys('<S-Esc>').getKeyArray();
-      expect(keyArray).to.have.lengthOf(1);
-      expect(keyArray[0].key).to.equal('Esc');
-      expect(keyArray[0].shiftKey).to.be.true;
-    });
-
-    it('returns mapped keys for a<C-B><A-C>d<M-e>', () => {
-      let keyArray = utils.fromMapKeys('a<C-B><A-C>d<M-e>').getKeyArray();
-      expect(keyArray).to.have.lengthOf(5);
-      expect(keyArray[0].key).to.equal('a');
-      expect(keyArray[1].ctrlKey).to.be.true;
-      expect(keyArray[1].key).to.equal('b');
-      expect(keyArray[2].altKey).to.be.true;
-      expect(keyArray[2].key).to.equal('c');
-      expect(keyArray[3].key).to.equal('d');
-      expect(keyArray[4].metaKey).to.be.true;
-      expect(keyArray[4].key).to.equal('e');
-    });
-  })
-
-});
diff --git a/test/content/repositories/KeymapRepository.test.ts b/test/content/repositories/KeymapRepository.test.ts
index 34704d9..df013df 100644
--- a/test/content/repositories/KeymapRepository.test.ts
+++ b/test/content/repositories/KeymapRepository.test.ts
@@ -1,6 +1,7 @@
 import KeymapRepository, { KeymapRepositoryImpl }
   from '../../../src/content/repositories/KeymapRepository';
 import { expect } from 'chai';
+import Key from "../../../src/shared/settings/Key";
 
 describe('KeymapRepositoryImpl', () => {
   let sut: KeymapRepository;
@@ -11,24 +12,25 @@ describe('KeymapRepositoryImpl', () => {
 
   describe('#enqueueKey()', () => {
     it('enqueues keys', () => {
-      sut.enqueueKey({ key: 'a' });
-      sut.enqueueKey({ key: 'b' });
-      let sequence = sut.enqueueKey({ key: 'c' });
-
-      expect(sequence.getKeyArray()).deep.equals([
-        { key: 'a' }, { key: 'b' }, { key: 'c' },
-      ]);
+      sut.enqueueKey(Key.fromMapKey('a');
+      sut.enqueueKey(Key.fromMapKey('b');
+      let sequence = sut.enqueueKey(Key.fromMapKey('c'));
+
+      let keys = sequence.keys;
+      expect(keys[0].equals(Key.fromMapKey('a'))).to.be.true;
+      expect(keys[1].equals(Key.fromMapKey('b'))).to.be.true;
+      expect(keys[2].equals(Key.fromMapKey('c'))).to.be.true;
     });
   });
 
   describe('#clear()', () => {
     it('clears keys', () => {
-      sut.enqueueKey({ key: 'a' });
-      sut.enqueueKey({ key: 'b' });
-      sut.enqueueKey({ key: 'c' });
+      sut.enqueueKey(Key.fromMapKey('a'));
+      sut.enqueueKey(Key.fromMapKey('b'));
+      sut.enqueueKey(Key.fromMapKey('c'));
       sut.clear();
 
-      let sequence = sut.enqueueKey({ key: 'a' });
+      let sequence = sut.enqueueKey(Key.fromMapKey('a'));
       expect(sequence.length()).to.equal(1);
     });
   });
diff --git a/test/content/repositories/SettingRepository.test.ts b/test/content/repositories/SettingRepository.test.ts
index fea70b7..db4c528 100644
--- a/test/content/repositories/SettingRepository.test.ts
+++ b/test/content/repositories/SettingRepository.test.ts
@@ -1,13 +1,14 @@
 import { SettingRepositoryImpl } from '../../../src/content/repositories/SettingRepository';
 import { expect } from 'chai';
+import Settings from '../../../src/shared/settings/Settings';
 
 describe('SettingRepositoryImpl', () => {
   it('updates and gets current value', () => {
     let sut = new SettingRepositoryImpl();
 
-    let settings = {
+    let settings = Settings.fromJSON({
       keymaps: {},
-      search: {
+      search:{
         default: 'google',
         engines: {
           google: 'https://google.com/?q={}',
@@ -19,7 +20,7 @@ describe('SettingRepositoryImpl', () => {
         complete: 'sbh',
       },
       blacklist: [],
-    }
+    });
 
     sut.set(settings);
 
@@ -27,4 +28,3 @@ describe('SettingRepositoryImpl', () => {
     expect(actual.properties.hintchars).to.equal('abcd1234');
   });
 });
-
diff --git a/test/content/usecases/SettingUseCaase.test.ts b/test/content/usecases/SettingUseCaase.test.ts
index e9633f4..136c5af 100644
--- a/test/content/usecases/SettingUseCaase.test.ts
+++ b/test/content/usecases/SettingUseCaase.test.ts
@@ -1,7 +1,7 @@
 import SettingRepository from '../../../src/content/repositories/SettingRepository';
 import SettingClient from '../../../src/content/client/SettingClient';
 import SettingUseCase from '../../../src/content/usecases/SettingUseCase';
-import Settings, { DefaultSetting } from '../../../src/shared/Settings';
+import Settings, { DefaultSetting } from '../../../src/shared/settings/Settings';
 import { expect } from 'chai';
 
 class MockSettingRepository implements SettingRepository {