Declare setting types

jh-changes
Shin'ya Ueoka 6 years ago
parent d01db82c0d
commit a0882bbceb
  1. 3
      src/background/controllers/SettingController.ts
  2. 3
      src/background/domains/GlobalMark.ts
  3. 59
      src/background/domains/Setting.ts
  4. 6
      src/background/repositories/PersistentSettingRepository.ts
  5. 34
      src/background/repositories/SettingRepository.ts
  6. 7
      src/background/usecases/CommandUseCase.ts
  7. 30
      src/background/usecases/CompletionsUseCase.ts
  8. 17
      src/background/usecases/SettingUseCase.ts
  9. 21
      src/background/usecases/parsers.ts
  10. 3
      src/content/actions/index.ts
  11. 4
      src/content/actions/operation.ts
  12. 23
      src/content/actions/setting.ts
  13. 5
      src/content/components/common/index.ts
  14. 1
      src/content/components/common/input.ts
  15. 24
      src/content/components/common/keymapper.ts
  16. 10
      src/content/components/common/mark.ts
  17. 4
      src/content/components/top-content/follow-controller.ts
  18. 24
      src/content/reducers/setting.ts
  19. 16
      src/settings/actions/index.ts
  20. 54
      src/settings/actions/setting.ts
  21. 23
      src/settings/components/form/KeymapsForm.tsx
  22. 30
      src/settings/components/form/SearchForm.tsx
  23. 104
      src/settings/components/index.tsx
  24. 3
      src/settings/keymaps.ts
  25. 22
      src/settings/reducers/setting.ts
  26. 15
      src/settings/storage.ts
  27. 414
      src/shared/SettingData.ts
  28. 200
      src/shared/Settings.ts
  29. 2
      src/shared/operations.ts
  30. 50
      src/shared/properties.ts
  31. 50
      src/shared/property-defs.ts
  32. 85
      src/shared/settings/default.ts
  33. 24
      src/shared/settings/properties.ts
  34. 32
      src/shared/settings/storage.ts
  35. 76
      src/shared/settings/validator.ts
  36. 108
      src/shared/settings/values.ts
  37. 41
      test/background/usecases/parsers.test.ts
  38. 46
      test/content/actions/setting.test.ts
  39. 21
      test/content/reducers/setting.test.ts
  40. 14
      test/settings/components/form/KeymapsForm.test.tsx
  41. 60
      test/settings/components/form/SearchEngineForm.test.tsx
  42. 3
      test/settings/reducers/setting.test.ts
  43. 293
      test/shared/SettingData.test.ts
  44. 190
      test/shared/Settings.test.ts
  45. 18
      test/shared/properties.test.js
  46. 18
      test/shared/property-defs.test.js
  47. 81
      test/shared/settings/validator.test.ts
  48. 138
      test/shared/settings/values.test.ts

@ -1,5 +1,6 @@
import SettingUseCase from '../usecases/SettingUseCase'; import SettingUseCase from '../usecases/SettingUseCase';
import ContentMessageClient from '../infrastructures/ContentMessageClient'; import ContentMessageClient from '../infrastructures/ContentMessageClient';
import Settings from '../../shared/Settings';
export default class SettingController { export default class SettingController {
private settingUseCase: SettingUseCase; private settingUseCase: SettingUseCase;
@ -11,7 +12,7 @@ export default class SettingController {
this.contentMessageClient = new ContentMessageClient(); this.contentMessageClient = new ContentMessageClient();
} }
getSetting(): any { getSetting(): Promise<Settings> {
return this.settingUseCase.get(); return this.settingUseCase.get();
} }

@ -1,6 +1,7 @@
export interface GlobalMark { export default interface GlobalMark {
readonly tabId: number; readonly tabId: number;
readonly url: string; readonly url: string;
readonly x: number; readonly x: number;
readonly y: number; readonly y: number;
// eslint-disable-next-line semi
} }

@ -1,59 +0,0 @@
import DefaultSettings from '../../shared/settings/default';
import * as settingsValues from '../../shared/settings/values';
type SettingValue = {
source: string,
json: string,
form: any
}
export default class Setting {
private obj: SettingValue;
constructor({ source, json, form }: SettingValue) {
this.obj = {
source, json, form
};
}
get source(): string {
return this.obj.source;
}
get json(): string {
return this.obj.json;
}
get form(): any {
return this.obj.form;
}
value() {
let value = JSON.parse(DefaultSettings.json);
if (this.obj.source === 'json') {
value = settingsValues.valueFromJson(this.obj.json);
} else if (this.obj.source === 'form') {
value = settingsValues.valueFromForm(this.obj.form);
}
if (!value.properties) {
value.properties = {};
}
return { ...settingsValues.valueFromJson(DefaultSettings.json), ...value };
}
serialize(): SettingValue {
return this.obj;
}
static deserialize(obj: SettingValue): Setting {
return new Setting({ source: obj.source, json: obj.json, form: obj.form });
}
static defaultSettings() {
return new Setting({
source: DefaultSettings.source,
json: DefaultSettings.json,
form: {},
});
}
}

@ -1,12 +1,12 @@
import Setting from '../domains/Setting'; import SettingData from '../../shared/SettingData';
export default class SettingRepository { export default class SettingRepository {
async load(): Promise<any> { async load(): Promise<SettingData | null> {
let { settings } = await browser.storage.local.get('settings'); let { settings } = await browser.storage.local.get('settings');
if (!settings) { if (!settings) {
return null; return null;
} }
return Setting.deserialize(settings); return SettingData.valueOf(settings);
} }
} }

@ -1,4 +1,6 @@
import MemoryStorage from '../infrastructures/MemoryStorage'; import MemoryStorage from '../infrastructures/MemoryStorage';
import Settings from '../../shared/Settings';
import * as PropertyDefs from '../../shared/property-defs';
const CACHED_SETTING_KEY = 'setting'; const CACHED_SETTING_KEY = 'setting';
@ -9,17 +11,41 @@ export default class SettingRepository {
this.cache = new MemoryStorage(); this.cache = new MemoryStorage();
} }
get(): Promise<any> { get(): Promise<Settings> {
return Promise.resolve(this.cache.get(CACHED_SETTING_KEY)); return Promise.resolve(this.cache.get(CACHED_SETTING_KEY));
} }
update(value: any): any { update(value: Settings): void {
return this.cache.set(CACHED_SETTING_KEY, value); return this.cache.set(CACHED_SETTING_KEY, value);
} }
async setProperty(name: string, value: string): Promise<any> { async setProperty(
name: string, value: string | number | boolean,
): Promise<void> {
let def = PropertyDefs.defs.find(d => name === d.name);
if (!def) {
throw new Error('unknown property: ' + name);
}
if (typeof value !== def.type) {
throw new TypeError(`property type of ${name} mismatch: ${typeof value}`);
}
let newValue = value;
if (typeof value === 'string' && value === '') {
newValue = def.defaultValue;
}
let current = await this.get(); let current = await this.get();
current.properties[name] = value; switch (name) {
case 'hintchars':
current.properties.hintchars = newValue as string;
break;
case 'smoothscroll':
current.properties.smoothscroll = newValue as boolean;
break;
case 'complete':
current.properties.complete = newValue as string;
break;
}
return this.update(current); return this.update(current);
} }
} }

@ -6,7 +6,6 @@ import SettingRepository from '../repositories/SettingRepository';
import BookmarkRepository from '../repositories/BookmarkRepository'; import BookmarkRepository from '../repositories/BookmarkRepository';
import ConsoleClient from '../infrastructures/ConsoleClient'; import ConsoleClient from '../infrastructures/ConsoleClient';
import ContentMessageClient from '../infrastructures/ContentMessageClient'; import ContentMessageClient from '../infrastructures/ContentMessageClient';
import * as properties from '../../shared/settings/properties';
export default class CommandIndicator { export default class CommandIndicator {
private tabPresenter: TabPresenter; private tabPresenter: TabPresenter;
@ -115,16 +114,16 @@ export default class CommandIndicator {
async addbookmark(title: string): Promise<any> { async addbookmark(title: string): Promise<any> {
let tab = await this.tabPresenter.getCurrent(); let tab = await this.tabPresenter.getCurrent();
let item = await this.bookmarkRepository.create(title, tab.url); let item = await this.bookmarkRepository.create(title, tab.url as string);
let message = 'Saved current page: ' + item.url; let message = 'Saved current page: ' + item.url;
return this.consoleClient.showInfo(tab.id, message); return this.consoleClient.showInfo(tab.id as number, message);
} }
async set(keywords: string): Promise<any> { async set(keywords: string): Promise<any> {
if (keywords.length === 0) { if (keywords.length === 0) {
return; return;
} }
let [name, value] = parsers.parseSetOption(keywords, properties.types); let [name, value] = parsers.parseSetOption(keywords);
await this.settingRepository.setProperty(name, value); await this.settingRepository.setProperty(name, value);
return this.contentMessageClient.broadcastSettingsChanged(); return this.contentMessageClient.broadcastSettingsChanged();

@ -4,7 +4,7 @@ import CompletionsRepository from '../repositories/CompletionsRepository';
import * as filters from './filters'; import * as filters from './filters';
import SettingRepository from '../repositories/SettingRepository'; import SettingRepository from '../repositories/SettingRepository';
import TabPresenter from '../presenters/TabPresenter'; import TabPresenter from '../presenters/TabPresenter';
import * as properties from '../../shared/settings/properties'; import * as PropertyDefs from '../../shared/property-defs';
const COMPLETION_ITEM_LIMIT = 10; const COMPLETION_ITEM_LIMIT = 10;
@ -44,7 +44,7 @@ export default class CompletionsUseCase {
let settings = await this.settingRepository.get(); let settings = await this.settingRepository.get();
let groups: CompletionGroup[] = []; let groups: CompletionGroup[] = [];
let complete = settings.properties.complete || properties.defaults.complete; let complete = settings.properties.complete;
for (let c of complete) { for (let c of complete) {
if (c === 's') { if (c === 's') {
// eslint-disable-next-line no-await-in-loop // eslint-disable-next-line no-await-in-loop
@ -127,25 +127,25 @@ export default class CompletionsUseCase {
} }
querySet(name: string, keywords: string): Promise<CompletionGroup[]> { querySet(name: string, keywords: string): Promise<CompletionGroup[]> {
let items = Object.keys(properties.docs).map((key) => { let items = PropertyDefs.defs.map((def) => {
if (properties.types[key] === 'boolean') { if (def.type === 'boolean') {
return [ return [
{ {
caption: key, caption: def.name,
content: name + ' ' + key, content: name + ' ' + def.name,
url: 'Enable ' + properties.docs[key], url: 'Enable ' + def.description,
}, { }, {
caption: 'no' + key, caption: 'no' + def.name,
content: name + ' no' + key, content: name + ' no' + def.name,
url: 'Disable ' + properties.docs[key], url: 'Disable ' + def.description
} }
]; ];
} }
return [ return [
{ {
caption: key, caption: def.name,
content: name + ' ' + key, content: name + ' ' + def.name,
url: 'Set ' + properties.docs[key], url: 'Set ' + def.description,
} }
]; ];
}); });
@ -195,8 +195,8 @@ export default class CompletionsUseCase {
.map(filters.filterByTailingSlash) .map(filters.filterByTailingSlash)
.map(pages => filters.filterByPathname(pages, COMPLETION_ITEM_LIMIT)) .map(pages => filters.filterByPathname(pages, COMPLETION_ITEM_LIMIT))
.map(pages => filters.filterByOrigin(pages, COMPLETION_ITEM_LIMIT))[0] .map(pages => filters.filterByOrigin(pages, COMPLETION_ITEM_LIMIT))[0]
.sort((x: HistoryItem, y: HistoryItem) => { .sort((x: HistoryItem, y: HistoryItem): number => {
return Number(x.visitCount) < Number(y.visitCount); return Number(x.visitCount) - Number(y.visitCount);
}) })
.slice(0, COMPLETION_ITEM_LIMIT); .slice(0, COMPLETION_ITEM_LIMIT);
return histories.map(page => ({ return histories.map(page => ({

@ -1,7 +1,8 @@
import Setting from '../domains/Setting';
// eslint-disable-next-line max-len // eslint-disable-next-line max-len
import PersistentSettingRepository from '../repositories/PersistentSettingRepository'; import PersistentSettingRepository from '../repositories/PersistentSettingRepository';
import SettingRepository from '../repositories/SettingRepository'; import SettingRepository from '../repositories/SettingRepository';
import { DefaultSettingData } from '../../shared/SettingData';
import Settings from '../../shared/Settings';
export default class SettingUseCase { export default class SettingUseCase {
private persistentSettingRepository: PersistentSettingRepository; private persistentSettingRepository: PersistentSettingRepository;
@ -13,20 +14,18 @@ export default class SettingUseCase {
this.settingRepository = new SettingRepository(); this.settingRepository = new SettingRepository();
} }
get(): Promise<any> { get(): Promise<Settings> {
return this.settingRepository.get(); return this.settingRepository.get();
} }
async reload(): Promise<any> { async reload(): Promise<Settings> {
let settings = await this.persistentSettingRepository.load(); let data = await this.persistentSettingRepository.load();
if (!settings) { if (!data) {
settings = Setting.defaultSettings(); data = DefaultSettingData;
} }
let value = settings.value(); let value = data.toSettings();
this.settingRepository.update(value); this.settingRepository.update(value);
return value; return value;
} }
} }

@ -1,3 +1,5 @@
import * as PropertyDefs from '../../shared//property-defs';
const mustNumber = (v: any): number => { const mustNumber = (v: any): number => {
let num = Number(v); let num = Number(v);
if (isNaN(num)) { if (isNaN(num)) {
@ -7,29 +9,28 @@ const mustNumber = (v: any): number => {
}; };
const parseSetOption = ( const parseSetOption = (
word: string, args: string,
types: { [key: string]: string },
): any[] => { ): any[] => {
let [key, value]: any[] = word.split('='); let [key, value]: any[] = args.split('=');
if (value === undefined) { if (value === undefined) {
value = !key.startsWith('no'); value = !key.startsWith('no');
key = value ? key : key.slice(2); key = value ? key : key.slice(2);
} }
let type = types[key]; let def = PropertyDefs.defs.find(d => d.name === key);
if (!type) { if (!def) {
throw new Error('Unknown property: ' + key); throw new Error('Unknown property: ' + key);
} }
if (type === 'boolean' && typeof value !== 'boolean' || if (def.type === 'boolean' && typeof value !== 'boolean' ||
type !== 'boolean' && typeof value === 'boolean') { def.type !== 'boolean' && typeof value === 'boolean') {
throw new Error('Invalid argument: ' + word); throw new Error('Invalid argument: ' + args);
} }
switch (type) { switch (def.type) {
case 'string': return [key, value]; case 'string': return [key, value];
case 'number': return [key, mustNumber(value)]; case 'number': return [key, mustNumber(value)];
case 'boolean': return [key, value]; case 'boolean': return [key, value];
} }
throw new Error('Unknown property type: ' + type); throw new Error('Unknown property type: ' + def.type);
}; };
export { parseSetOption }; export { parseSetOption };

@ -1,4 +1,5 @@
import Redux from 'redux'; import Redux from 'redux';
import Settings from '../../shared/Settings';
// Enable/disable // Enable/disable
export const ADDON_SET_ENABLED = 'addon.set.enabled'; export const ADDON_SET_ENABLED = 'addon.set.enabled';
@ -45,7 +46,7 @@ export interface FindSetKeywordAction extends Redux.Action {
export interface SettingSetAction extends Redux.Action { export interface SettingSetAction extends Redux.Action {
type: typeof SETTING_SET; type: typeof SETTING_SET;
value: any; settings: Settings,
} }
export interface InputKeyPressAction extends Redux.Action { export interface InputKeyPressAction extends Redux.Action {

@ -8,7 +8,6 @@ import * as urls from '../urls';
import * as consoleFrames from '../console-frames'; import * as consoleFrames from '../console-frames';
import * as addonActions from './addon'; import * as addonActions from './addon';
import * as markActions from './mark'; import * as markActions from './mark';
import * as properties from '../../shared/settings/properties';
// eslint-disable-next-line complexity, max-lines-per-function // eslint-disable-next-line complexity, max-lines-per-function
const exec = ( const exec = (
@ -16,8 +15,7 @@ const exec = (
settings: any, settings: any,
addonEnabled: boolean, addonEnabled: boolean,
): Promise<actions.Action> | actions.Action => { ): Promise<actions.Action> | actions.Action => {
let smoothscroll = settings.properties.smoothscroll || let smoothscroll = settings.properties.smoothscroll;
properties.defaults.smoothscroll;
switch (operation.type) { switch (operation.type) {
case operations.ADDON_ENABLE: case operations.ADDON_ENABLE:
return addonActions.enable(); return addonActions.enable();

@ -1,29 +1,20 @@
import * as actions from './index'; import * as actions from './index';
import * as keyUtils from '../../shared/utils/keys';
import * as operations from '../../shared/operations'; import * as operations from '../../shared/operations';
import * as messages from '../../shared/messages'; import * as messages from '../../shared/messages';
import Settings, { Keymaps } from '../../shared/Settings';
const reservedKeymaps = { const reservedKeymaps: Keymaps = {
'<Esc>': { type: operations.CANCEL }, '<Esc>': { type: operations.CANCEL },
'<C-[>': { type: operations.CANCEL }, '<C-[>': { type: operations.CANCEL },
}; };
const set = (value: any): actions.SettingAction => { const set = (settings: Settings): actions.SettingAction => {
let entries: any[] = [];
if (value.keymaps) {
let keymaps = { ...value.keymaps, ...reservedKeymaps };
entries = Object.entries(keymaps).map((entry) => {
return [
keyUtils.fromMapKeys(entry[0]),
entry[1],
];
});
}
return { return {
type: actions.SETTING_SET, type: actions.SETTING_SET,
value: { ...value, settings: {
keymaps: entries, } ...settings,
keymaps: { ...settings.keymaps, ...reservedKeymaps },
}
}; };
}; };

@ -8,6 +8,7 @@ import MessageListener from '../../MessageListener';
import * as addonActions from '../../actions/addon'; import * as addonActions from '../../actions/addon';
import * as blacklists from '../../../shared/blacklists'; import * as blacklists from '../../../shared/blacklists';
import * as keys from '../../../shared/utils/keys'; import * as keys from '../../../shared/utils/keys';
import * as actions from '../../actions';
export default class Common { export default class Common {
private win: Window; private win: Window;
@ -45,9 +46,9 @@ export default class Common {
reloadSettings() { reloadSettings() {
try { try {
this.store.dispatch(settingActions.load()) this.store.dispatch(settingActions.load())
.then(({ value: settings }: any) => { .then((action: actions.SettingAction) => {
let enabled = !blacklists.includes( let enabled = !blacklists.includes(
settings.blacklist, this.win.location.href action.settings.blacklist, this.win.location.href
); );
this.store.dispatch(addonActions.setEnabled(enabled)); this.store.dispatch(addonActions.setEnabled(enabled));
}); });

@ -61,7 +61,6 @@ export default class InputComponent {
} }
let key = keys.fromKeyboardEvent(e); let key = keys.fromKeyboardEvent(e);
for (let listener of this.onKeyListeners) { for (let listener of this.onKeyListeners) {
let stop = listener(key); let stop = listener(key);
if (stop) { if (stop) {

@ -3,7 +3,10 @@ import * as operationActions from '../../actions/operation';
import * as operations from '../../../shared/operations'; import * as operations from '../../../shared/operations';
import * as keyUtils from '../../../shared/utils/keys'; import * as keyUtils from '../../../shared/utils/keys';
const mapStartsWith = (mapping, keys) => { const mapStartsWith = (
mapping: keyUtils.Key[],
keys: keyUtils.Key[],
): boolean => {
if (mapping.length < keys.length) { if (mapping.length < keys.length) {
return false; return false;
} }
@ -16,26 +19,33 @@ const mapStartsWith = (mapping, keys) => {
}; };
export default class KeymapperComponent { export default class KeymapperComponent {
constructor(store) { private store: any;
constructor(store: any) {
this.store = store; this.store = store;
} }
// eslint-disable-next-line max-statements // eslint-disable-next-line max-statements
key(key) { key(key: keyUtils.Key): boolean {
this.store.dispatch(inputActions.keyPress(key)); this.store.dispatch(inputActions.keyPress(key));
let state = this.store.getState(); let state = this.store.getState();
let input = state.input; let input = state.input;
let keymaps = new Map(state.setting.keymaps); let keymaps = new Map<keyUtils.Key[], operations.Operation>(
state.setting.keymaps.map(
(e: {key: keyUtils.Key[], op: operations.Operation}) => [e.key, e.op],
)
);
let matched = Array.from(keymaps.keys()).filter((mapping) => { let matched = Array.from(keymaps.keys()).filter(
(mapping: keyUtils.Key[]) => {
return mapStartsWith(mapping, input.keys); return mapStartsWith(mapping, input.keys);
}); });
if (!state.addon.enabled) { if (!state.addon.enabled) {
// available keymaps are only ADDON_ENABLE and ADDON_TOGGLE_ENABLED if // available keymaps are only ADDON_ENABLE and ADDON_TOGGLE_ENABLED if
// the addon disabled // the addon disabled
matched = matched.filter((keys) => { matched = matched.filter((keys) => {
let type = keymaps.get(keys).type; let type = (keymaps.get(keys) as operations.Operation).type;
return type === operations.ADDON_ENABLE || return type === operations.ADDON_ENABLE ||
type === operations.ADDON_TOGGLE_ENABLED; type === operations.ADDON_TOGGLE_ENABLED;
}); });
@ -47,7 +57,7 @@ export default class KeymapperComponent {
matched.length === 1 && input.keys.length < matched[0].length) { matched.length === 1 && input.keys.length < matched[0].length) {
return true; return true;
} }
let operation = keymaps.get(matched[0]); let operation = keymaps.get(matched[0]) as operations.Operation;
let act = operationActions.exec( let act = operationActions.exec(
operation, state.setting, state.addon.enabled operation, state.setting, state.addon.enabled
); );

@ -1,7 +1,6 @@
import * as markActions from 'content/actions/mark'; import * as markActions from '../../actions/mark';
import * as scrolls from 'content/scrolls'; import * as scrolls from '../..//scrolls';
import * as consoleFrames from 'content/console-frames'; import * as consoleFrames from '../..//console-frames';
import * as properties from 'shared/settings/properties';
const cancelKey = (key): boolean => { const cancelKey = (key): boolean => {
return key.key === 'Esc' || key.key === '[' && key.ctrlKey; return key.key === 'Esc' || key.key === '[' && key.ctrlKey;
@ -20,8 +19,7 @@ export default class MarkComponent {
// eslint-disable-next-line max-statements // eslint-disable-next-line max-statements
key(key) { key(key) {
let { mark: markStage, setting } = this.store.getState(); let { mark: markStage, setting } = this.store.getState();
let smoothscroll = setting.properties.smoothscroll || let smoothscroll = setting.properties.smoothscroll;
properties.defaults.smoothscroll;
if (!markStage.setMode && !markStage.jumpMode) { if (!markStage.setMode && !markStage.jumpMode) {
return false; return false;

@ -2,7 +2,6 @@ import * as followControllerActions from '../../actions/follow-controller';
import * as messages from '../../../shared/messages'; import * as messages from '../../../shared/messages';
import MessageListener, { WebMessageSender } from '../../MessageListener'; import MessageListener, { WebMessageSender } from '../../MessageListener';
import HintKeyProducer from '../../hint-key-producer'; import HintKeyProducer from '../../hint-key-producer';
import * as properties from '../../../shared/settings/properties';
const broadcastMessage = (win: Window, message: messages.Message): void => { const broadcastMessage = (win: Window, message: messages.Message): void => {
let json = JSON.stringify(message); let json = JSON.stringify(message);
@ -162,7 +161,6 @@ export default class FollowController {
} }
hintchars() { hintchars() {
return this.store.getState().setting.properties.hintchars || return this.store.getState().setting.properties.hintchars;
properties.defaults.hintchars;
} }
} }

@ -1,12 +1,20 @@
import * as actions from '../actions'; import * as actions from '../actions';
import * as keyUtils from '../../shared/utils/keys';
import * as operations from '../../shared/operations';
import { Properties } from '../../shared/Settings';
export interface State { export interface State {
keymaps: any[]; keymaps: { key: keyUtils.Key[], op: operations.Operation }[];
properties: Properties;
} }
const defaultState = { const defaultState: State = {
// keymaps is and arrays of key-binding pairs, which is entries of Map
keymaps: [], keymaps: [],
properties: {
complete: '',
smoothscroll: false,
hintchars: '',
},
}; };
export default function reducer( export default function reducer(
@ -15,7 +23,15 @@ export default function reducer(
): State { ): State {
switch (action.type) { switch (action.type) {
case actions.SETTING_SET: case actions.SETTING_SET:
return { ...action.value }; return {
keymaps: Object.entries(action.settings.keymaps).map((entry) => {
return {
key: keyUtils.fromMapKeys(entry[0]),
op: entry[1],
};
}),
properties: action.settings.properties,
};
default: default:
return state; return state;
} }

@ -1,3 +1,7 @@
import {
JSONSettings, FormSettings, SettingSource,
} from '../../shared/SettingData';
// Settings // Settings
export const SETTING_SET_SETTINGS = 'setting.set.settings'; export const SETTING_SET_SETTINGS = 'setting.set.settings';
export const SETTING_SHOW_ERROR = 'setting.show.error'; export const SETTING_SHOW_ERROR = 'setting.show.error';
@ -6,25 +10,25 @@ export const SETTING_SWITCH_TO_JSON = 'setting.switch.to.json';
interface SettingSetSettingsAcion { interface SettingSetSettingsAcion {
type: typeof SETTING_SET_SETTINGS; type: typeof SETTING_SET_SETTINGS;
source: string; source: SettingSource;
json: string; json?: JSONSettings;
form: any; form?: FormSettings;
} }
interface SettingShowErrorAction { interface SettingShowErrorAction {
type: typeof SETTING_SHOW_ERROR; type: typeof SETTING_SHOW_ERROR;
error: string; error: string;
json: string; json: JSONSettings;
} }
interface SettingSwitchToFormAction { interface SettingSwitchToFormAction {
type: typeof SETTING_SWITCH_TO_FORM; type: typeof SETTING_SWITCH_TO_FORM;
form: any; form: FormSettings,
} }
interface SettingSwitchToJsonAction { interface SettingSwitchToJsonAction {
type: typeof SETTING_SWITCH_TO_JSON; type: typeof SETTING_SWITCH_TO_JSON;
json: string; json: JSONSettings,
} }
export type SettingAction = export type SettingAction =

@ -1,35 +1,35 @@
import * as actions from './index'; import * as actions from './index';
import * as validator from '../../shared/settings/validator'; import * as storages from '../storage';
import * as settingsValues from '../../shared/settings/values'; import SettingData, {
import * as settingsStorage from '../../shared/settings/storage'; JSONSettings, FormSettings, SettingSource,
import keymaps from '../keymaps'; } from '../../shared/SettingData';
const load = async(): Promise<actions.SettingAction> => { const load = async(): Promise<actions.SettingAction> => {
let settings = await settingsStorage.loadRaw(); let data = await storages.load();
return set(settings); return set(data);
}; };
const save = async(settings: any): Promise<actions.SettingAction> => { const save = async(data: SettingData): Promise<actions.SettingAction> => {
try { try {
if (settings.source === 'json') { if (data.getSource() === SettingSource.JSON) {
let value = JSON.parse(settings.json); // toSettings exercise validation
validator.validate(value); data.toSettings();
} }
} catch (e) { } catch (e) {
return { return {
type: actions.SETTING_SHOW_ERROR, type: actions.SETTING_SHOW_ERROR,
error: e.toString(), error: e.toString(),
json: settings.json, json: data.getJSON(),
}; };
} }
await settingsStorage.save(settings); await storages.save(data);
return set(settings); return set(data);
}; };
const switchToForm = (json: string): actions.SettingAction => { const switchToForm = (json: JSONSettings): actions.SettingAction => {
try { try {
validator.validate(JSON.parse(json)); // toSettings exercise validation
let form = settingsValues.formFromJson(json, keymaps.allowedOps); let form = FormSettings.fromSettings(json.toSettings());
return { return {
type: actions.SETTING_SWITCH_TO_FORM, type: actions.SETTING_SWITCH_TO_FORM,
form, form,
@ -43,21 +43,31 @@ const switchToForm = (json: string): actions.SettingAction => {
} }
}; };
const switchToJson = (form: any): actions.SettingAction => { const switchToJson = (form: FormSettings): actions.SettingAction => {
let json = settingsValues.jsonFromForm(form); let json = JSONSettings.fromSettings(form.toSettings());
return { return {
type: actions.SETTING_SWITCH_TO_JSON, type: actions.SETTING_SWITCH_TO_JSON,
json, json,
}; };
}; };
const set = (settings: any): actions.SettingAction => { const set = (data: SettingData): actions.SettingAction => {
let source = data.getSource();
switch (source) {
case SettingSource.JSON:
return { return {
type: actions.SETTING_SET_SETTINGS, type: actions.SETTING_SET_SETTINGS,
source: settings.source, source: source,
json: settings.json, json: data.getJSON(),
form: settings.form,
}; };
case SettingSource.Form:
return {
type: actions.SETTING_SET_SETTINGS,
source: source,
form: data.getForm(),
};
}
throw new Error(`unknown source: ${source}`);
}; };
export { load, save, set, switchToForm, switchToJson }; export { load, save, set, switchToForm, switchToJson };

@ -2,32 +2,30 @@ import './KeymapsForm.scss';
import React from 'react'; import React from 'react';
import Input from '../ui/Input'; import Input from '../ui/Input';
import keymaps from '../../keymaps'; import keymaps from '../../keymaps';
import { FormKeymaps } from '../../../shared/SettingData';
type Value = {[key: string]: string}; interface Props {
value: FormKeymaps;
interface Props{ onChange: (e: FormKeymaps) => void;
value: Value;
onChange: (e: Value) => void;
onBlur: () => void; onBlur: () => void;
} }
class KeymapsForm extends React.Component<Props> { class KeymapsForm extends React.Component<Props> {
public static defaultProps: Props = { public static defaultProps: Props = {
value: {}, value: FormKeymaps.valueOf({}),
onChange: () => {}, onChange: () => {},
onBlur: () => {}, onBlur: () => {},
} }
render() { render() {
let values = this.props.value.toJSON();
return <div className='form-keymaps-form'> return <div className='form-keymaps-form'>
{ {
keymaps.fields.map((group, index) => { keymaps.fields.map((group, index) => {
return <div key={index} className='form-keymaps-form-field-group'> return <div key={index} className='form-keymaps-form-field-group'>
{ {
group.map((field) => { group.map(([name, label]) => {
let name = field[0]; let value = values[name] || '';
let label = field[1];
let value = this.props.value[name] || '';
return <Input return <Input
type='text' id={name} name={name} key={name} type='text' id={name} name={name} key={name}
label={label} value={value} label={label} value={value}
@ -43,10 +41,7 @@ class KeymapsForm extends React.Component<Props> {
} }
bindValue(name: string, value: string) { bindValue(name: string, value: string) {
let next = { ...this.props.value }; this.props.onChange(this.props.value.buildWithOverride(name, value));
next[name] = value;
this.props.onChange(next);
} }
} }

@ -2,31 +2,23 @@ import './SearchForm.scss';
import React from 'react'; import React from 'react';
import AddButton from '../ui/AddButton'; import AddButton from '../ui/AddButton';
import DeleteButton from '../ui/DeleteButton'; import DeleteButton from '../ui/DeleteButton';
import { FormSearch } from '../../../shared/SettingData';
interface Value {
default: string;
engines: string[][];
}
interface Props { interface Props {
value: Value; value: FormSearch;
onChange: (value: Value) => void; onChange: (value: FormSearch) => void;
onBlur: () => void; onBlur: () => void;
} }
class SearchForm extends React.Component<Props> { class SearchForm extends React.Component<Props> {
public static defaultProps: Props = { public static defaultProps: Props = {
value: { default: '', engines: []}, value: FormSearch.valueOf({ default: '', engines: []}),
onChange: () => {}, onChange: () => {},
onBlur: () => {}, onBlur: () => {},
} }
render() { render() {
let value = this.props.value; let value = this.props.value.toJSON();
if (!value.engines) {
value.engines = [];
}
return <div className='form-search-form'> return <div className='form-search-form'>
<div className='form-search-form-header'> <div className='form-search-form-header'>
<div className='column-name'>Name</div> <div className='column-name'>Name</div>
@ -63,28 +55,28 @@ class SearchForm extends React.Component<Props> {
} }
bindValue(e: any) { bindValue(e: any) {
let value = this.props.value; let value = this.props.value.toJSON();
let name = e.target.name; let name = e.target.name;
let index = Number(e.target.getAttribute('data-index')); let index = Number(e.target.getAttribute('data-index'));
let next: Value = { let next: typeof value = {
default: value.default, default: value.default,
engines: value.engines ? value.engines.slice() : [], engines: value.engines.slice(),
}; };
if (name === 'name') { if (name === 'name') {
next.engines[index][0] = e.target.value; next.engines[index][0] = e.target.value;
next.default = this.props.value.engines[index][0]; next.default = value.engines[index][0];
} else if (name === 'url') { } else if (name === 'url') {
next.engines[index][1] = e.target.value; next.engines[index][1] = e.target.value;
} else if (name === 'default') { } else if (name === 'default') {
next.default = this.props.value.engines[index][0]; next.default = value.engines[index][0];
} else if (name === 'add') { } else if (name === 'add') {
next.engines.push(['', '']); next.engines.push(['', '']);
} else if (name === 'delete') { } else if (name === 'delete') {
next.engines.splice(index, 1); next.engines.splice(index, 1);
} }
this.props.onChange(next); this.props.onChange(FormSearch.valueOf(next));
if (name === 'delete' || name === 'default') { if (name === 'delete' || name === 'default') {
this.props.onBlur(); this.props.onBlur();
} }

@ -6,22 +6,26 @@ import SearchForm from './form/SearchForm';
import KeymapsForm from './form/KeymapsForm'; import KeymapsForm from './form/KeymapsForm';
import BlacklistForm from './form/BlacklistForm'; import BlacklistForm from './form/BlacklistForm';
import PropertiesForm from './form/PropertiesForm'; import PropertiesForm from './form/PropertiesForm';
import * as properties from '../../shared/settings/properties';
import * as settingActions from '../../settings/actions/setting'; import * as settingActions from '../../settings/actions/setting';
import SettingData, {
JSONSettings, FormKeymaps, FormSearch, FormSettings,
} from '../../shared/SettingData';
import { State as AppState } from '../reducers/setting';
import * as settings from '../../shared/Settings';
import * as PropertyDefs from '../../shared/property-defs';
const DO_YOU_WANT_TO_CONTINUE = const DO_YOU_WANT_TO_CONTINUE =
'Some settings in JSON can be lost when migrating. ' + 'Some settings in JSON can be lost when migrating. ' +
'Do you want to continue?'; 'Do you want to continue?';
interface Props { type StateProps = ReturnType<typeof mapStateToProps>;
source: string; interface DispatchProps {
json: string; dispatch: (action: any) => void,
form: any; }
error: string; type Props = StateProps & DispatchProps & {
// FIXME // FIXME
store: any; store: any;
} };
class SettingsComponent extends React.Component<Props> { class SettingsComponent extends React.Component<Props> {
componentDidMount() { componentDidMount() {
@ -29,12 +33,17 @@ class SettingsComponent extends React.Component<Props> {
} }
renderFormFields(form: any) { renderFormFields(form: any) {
let types = PropertyDefs.defs.reduce(
(o: {[key: string]: string}, def) => {
o[def.name] = def.type;
return o;
}, {});
return <div> return <div>
<fieldset> <fieldset>
<legend>Keybindings</legend> <legend>Keybindings</legend>
<KeymapsForm <KeymapsForm
value={form.keymaps} value={form.keymaps}
onChange={value => this.bindForm('keymaps', value)} onChange={this.bindKeymapsForm.bind(this)}
onBlur={this.save.bind(this)} onBlur={this.save.bind(this)}
/> />
</fieldset> </fieldset>
@ -42,7 +51,7 @@ class SettingsComponent extends React.Component<Props> {
<legend>Search Engines</legend> <legend>Search Engines</legend>
<SearchForm <SearchForm
value={form.search} value={form.search}
onChange={value => this.bindForm('search', value)} onChange={this.bindSearchForm.bind(this)}
onBlur={this.save.bind(this)} onBlur={this.save.bind(this)}
/> />
</fieldset> </fieldset>
@ -50,23 +59,23 @@ class SettingsComponent extends React.Component<Props> {
<legend>Blacklist</legend> <legend>Blacklist</legend>
<BlacklistForm <BlacklistForm
value={form.blacklist} value={form.blacklist}
onChange={value => this.bindForm('blacklist', value)} onChange={this.bindBlacklistForm.bind(this)}
onBlur={this.save.bind(this)} onBlur={this.save.bind(this)}
/> />
</fieldset> </fieldset>
<fieldset> <fieldset>
<legend>Properties</legend> <legend>Properties</legend>
<PropertiesForm <PropertiesForm
types={properties.types} types={types}
value={form.properties} value={form.properties}
onChange={value => this.bindForm('properties', value)} onChange={this.bindPropertiesForm.bind(this)}
onBlur={this.save.bind(this)} onBlur={this.save.bind(this)}
/> />
</fieldset> </fieldset>
</div>; </div>;
} }
renderJsonFields(json: string, error: string) { renderJsonFields(json: JSONSettings, error: string) {
return <div> return <div>
<Input <Input
type='textarea' type='textarea'
@ -76,7 +85,7 @@ class SettingsComponent extends React.Component<Props> {
error={error} error={error}
onValueChange={this.bindJson.bind(this)} onValueChange={this.bindJson.bind(this)}
onBlur={this.save.bind(this)} onBlur={this.save.bind(this)}
value={json} value={json.toJSON()}
/> />
</div>; </div>;
} }
@ -87,7 +96,8 @@ class SettingsComponent extends React.Component<Props> {
if (this.props.source === 'form') { if (this.props.source === 'form') {
fields = this.renderFormFields(this.props.form); fields = this.renderFormFields(this.props.form);
} else if (this.props.source === 'json') { } else if (this.props.source === 'json') {
fields = this.renderJsonFields(this.props.json, this.props.error); fields = this.renderJsonFields(
this.props.json as JSONSettings, this.props.error);
} }
return ( return (
<div> <div>
@ -117,45 +127,73 @@ class SettingsComponent extends React.Component<Props> {
); );
} }
bindForm(name: string, value: any) { bindKeymapsForm(value: FormKeymaps) {
let settings = { let data = new SettingData({
source: this.props.source,
form: (this.props.form as FormSettings).buildWithKeymaps(value),
});
this.props.dispatch(settingActions.set(data));
}
bindSearchForm(value: any) {
let data = new SettingData({
source: this.props.source,
form: (this.props.form as FormSettings).buildWithSearch(
FormSearch.valueOf(value)),
});
this.props.dispatch(settingActions.set(data));
}
bindBlacklistForm(value: any) {
let data = new SettingData({
source: this.props.source,
form: (this.props.form as FormSettings).buildWithBlacklist(
settings.blacklistValueOf(value)),
});
this.props.dispatch(settingActions.set(data));
}
bindPropertiesForm(value: any) {
let data = new SettingData({
source: this.props.source, source: this.props.source,
json: this.props.json, form: (this.props.form as FormSettings).buildWithProperties(
form: { ...this.props.form }, settings.propertiesValueOf(value)),
}; });
settings.form[name] = value; this.props.dispatch(settingActions.set(data));
this.props.dispatch(settingActions.set(settings));
} }
bindJson(_name: string, value: string) { bindJson(_name: string, value: string) {
let settings = { let data = new SettingData({
source: this.props.source, source: this.props.source,
json: value, json: JSONSettings.valueOf(value),
form: this.props.form, });
}; this.props.dispatch(settingActions.set(data));
this.props.dispatch(settingActions.set(settings));
} }
bindSource(_name: string, value: string) { bindSource(_name: string, value: string) {
let from = this.props.source; let from = this.props.source;
if (from === 'form' && value === 'json') { if (from === 'form' && value === 'json') {
this.props.dispatch(settingActions.switchToJson(this.props.form)); this.props.dispatch(settingActions.switchToJson(
this.props.form as FormSettings));
} else if (from === 'json' && value === 'form') { } else if (from === 'json' && value === 'form') {
let b = window.confirm(DO_YOU_WANT_TO_CONTINUE); let b = window.confirm(DO_YOU_WANT_TO_CONTINUE);
if (!b) { if (!b) {
this.forceUpdate(); this.forceUpdate();
return; return;
} }
this.props.dispatch(settingActions.switchToForm(this.props.json)); this.props.dispatch(
settingActions.switchToForm(this.props.json as JSONSettings));
} }
} }
save() { save() {
let settings = this.props.store.getState(); let { source, json, form } = this.props.store.getState();
this.props.dispatch(settingActions.save(settings)); this.props.dispatch(settingActions.save(
new SettingData({ source, json, form }),
));
} }
} }
const mapStateToProps = (state: any) => state; const mapStateToProps = (state: AppState) => ({ ...state });
export default connect(mapStateToProps)(SettingsComponent); export default connect(mapStateToProps)(SettingsComponent);

@ -66,9 +66,6 @@ const fields = [
] ]
]; ];
const allowedOps = [].concat(...fields.map(group => group.map(e => e[0])));
export default { export default {
fields, fields,
allowedOps,
}; };

@ -1,23 +1,25 @@
import * as actions from '../actions'; import * as actions from '../actions';
import {
JSONSettings, FormSettings, SettingSource,
} from '../../shared/SettingData';
interface State { export interface State {
source: string; source: SettingSource;
json: string; json?: JSONSettings;
form: any; form?: FormSettings;
error: string; error: string;
} }
const defaultState: State = { const defaultState: State = {
source: '', source: SettingSource.JSON,
json: '', json: JSONSettings.valueOf(''),
form: null,
error: '', error: '',
}; };
export default function reducer( export default function reducer(
state = defaultState, state = defaultState,
action: actions.SettingAction, action: actions.SettingAction,
) { ): State {
switch (action.type) { switch (action.type) {
case actions.SETTING_SET_SETTINGS: case actions.SETTING_SET_SETTINGS:
return { ...state, return { ...state,
@ -32,12 +34,12 @@ export default function reducer(
case actions.SETTING_SWITCH_TO_FORM: case actions.SETTING_SWITCH_TO_FORM:
return { ...state, return { ...state,
error: '', error: '',
source: 'form', source: SettingSource.Form,
form: action.form, }; form: action.form, };
case actions.SETTING_SWITCH_TO_JSON: case actions.SETTING_SWITCH_TO_JSON:
return { ...state, return { ...state,
error: '', error: '',
source: 'json', source: SettingSource.JSON,
json: action.json, }; json: action.json, };
default: default:
return state; return state;

@ -0,0 +1,15 @@
import SettingData, { DefaultSettingData } from '../shared/SettingData';
export const load = async(): Promise<SettingData> => {
let { settings } = await browser.storage.local.get('settings');
if (!settings) {
return DefaultSettingData;
}
return SettingData.valueOf(settings);
};
export const save = (data: SettingData) => {
return browser.storage.local.set({
settings: data.toJSON(),
});
};

@ -0,0 +1,414 @@
import * as operations from './operations';
import Settings, * as settings from './Settings';
export class FormKeymaps {
private data: {[op: string]: string};
constructor(data: {[op: string]: string}) {
this.data = data;
}
toKeymaps(): settings.Keymaps {
let keymaps: settings.Keymaps = {};
for (let name of Object.keys(this.data)) {
let [type, argStr] = name.split('?');
let args = {};
if (argStr) {
args = JSON.parse(argStr);
}
let key = this.data[name];
keymaps[key] = operations.valueOf({ type, ...args });
}
return keymaps;
}
toJSON(): {[op: string]: string} {
return this.data;
}
buildWithOverride(op: string, keys: string): FormKeymaps {
let newData = {
...this.data,
[op]: keys,
};
return new FormKeymaps(newData);
}
static valueOf(o: ReturnType<FormKeymaps['toJSON']>): FormKeymaps {
let data: {[op: string]: string} = {};
for (let op of Object.keys(o)) {
data[op] = o[op] as string;
}
return new FormKeymaps(data);
}
static fromKeymaps(keymaps: settings.Keymaps): FormKeymaps {
let data: {[op: string]: string} = {};
for (let key of Object.keys(keymaps)) {
let op = keymaps[key];
let args = { ...op };
delete args.type;
let name = op.type;
if (Object.keys(args).length > 0) {
name += '?' + JSON.stringify(args);
}
data[name] = key;
}
return new FormKeymaps(data);
}
}
export class FormSearch {
private default: string;
private engines: string[][];
constructor(defaultEngine: string, engines: string[][]) {
this.default = defaultEngine;
this.engines = engines;
}
toSearchSettings(): settings.Search {
return {
default: this.default,
engines: this.engines.reduce(
(o: {[key: string]: string}, [name, url]) => {
o[name] = url;
return o;
}, {}),
};
}
toJSON(): {
default: string;
engines: string[][];
} {
return {
default: this.default,
engines: this.engines,
};
}
static valueOf(o: ReturnType<FormSearch['toJSON']>): FormSearch {
if (!Object.prototype.hasOwnProperty.call(o, 'default')) {
throw new TypeError(`"default" field not set`);
}
if (!Object.prototype.hasOwnProperty.call(o, 'engines')) {
throw new TypeError(`"engines" field not set`);
}
return new FormSearch(o.default, o.engines);
}
static fromSearch(search: settings.Search): FormSearch {
let engines = Object.entries(search.engines).reduce(
(o: string[][], [name, url]) => {
return o.concat([[name, url]]);
}, []);
return new FormSearch(search.default, engines);
}
}
export class JSONSettings {
private json: string;
constructor(json: any) {
this.json = json;
}
toSettings(): Settings {
return settings.valueOf(JSON.parse(this.json));
}
toJSON(): string {
return this.json;
}
static valueOf(o: ReturnType<JSONSettings['toJSON']>): JSONSettings {
return new JSONSettings(o);
}
static fromSettings(data: Settings): JSONSettings {
return new JSONSettings(JSON.stringify(data, undefined, 2));
}
}
export class FormSettings {
private keymaps: FormKeymaps;
private search: FormSearch;
private properties: settings.Properties;
private blacklist: string[];
constructor(
keymaps: FormKeymaps,
search: FormSearch,
properties: settings.Properties,
blacklist: string[],
) {
this.keymaps = keymaps;
this.search = search;
this.properties = properties;
this.blacklist = blacklist;
}
buildWithKeymaps(keymaps: FormKeymaps): FormSettings {
return new FormSettings(
keymaps,
this.search,
this.properties,
this.blacklist,
);
}
buildWithSearch(search: FormSearch): FormSettings {
return new FormSettings(
this.keymaps,
search,
this.properties,
this.blacklist,
);
}
buildWithProperties(props: settings.Properties): FormSettings {
return new FormSettings(
this.keymaps,
this.search,
props,
this.blacklist,
);
}
buildWithBlacklist(blacklist: string[]): FormSettings {
return new FormSettings(
this.keymaps,
this.search,
this.properties,
blacklist,
);
}
toSettings(): Settings {
return settings.valueOf({
keymaps: this.keymaps.toKeymaps(),
search: this.search.toSearchSettings(),
properties: this.properties,
blacklist: this.blacklist,
});
}
toJSON(): {
keymaps: ReturnType<FormKeymaps['toJSON']>;
search: ReturnType<FormSearch['toJSON']>;
properties: settings.Properties;
blacklist: string[];
} {
return {
keymaps: this.keymaps.toJSON(),
search: this.search.toJSON(),
properties: this.properties,
blacklist: this.blacklist,
};
}
static valueOf(o: ReturnType<FormSettings['toJSON']>): FormSettings {
for (let name of ['keymaps', 'search', 'properties', 'blacklist']) {
if (!Object.prototype.hasOwnProperty.call(o, name)) {
throw new Error(`"${name}" field not set`);
}
}
return new FormSettings(
FormKeymaps.valueOf(o.keymaps),
FormSearch.valueOf(o.search),
settings.propertiesValueOf(o.properties),
settings.blacklistValueOf(o.blacklist),
);
}
static fromSettings(data: Settings): FormSettings {
return new FormSettings(
FormKeymaps.fromKeymaps(data.keymaps),
FormSearch.fromSearch(data.search),
data.properties,
data.blacklist);
}
}
export enum SettingSource {
JSON = 'json',
Form = 'form',
}
export default class SettingData {
private source: SettingSource;
private json?: JSONSettings;
private form?: FormSettings;
constructor({
source, json, form
}: {
source: SettingSource,
json?: JSONSettings,
form?: FormSettings,
}) {
this.source = source;
this.json = json;
this.form = form;
}
getSource(): SettingSource {
return this.source;
}
getJSON(): JSONSettings {
if (!this.json) {
throw new TypeError('json settings not set');
}
return this.json;
}
getForm(): FormSettings {
if (!this.form) {
throw new TypeError('form settings not set');
}
return this.form;
}
toJSON(): any {
switch (this.source) {
case SettingSource.JSON:
return {
source: this.source,
json: (this.json as JSONSettings).toJSON(),
};
case SettingSource.Form:
return {
source: this.source,
form: (this.form as FormSettings).toJSON(),
};
}
throw new Error(`unknown settings source: ${this.source}`);
}
toSettings(): Settings {
switch (this.source) {
case SettingSource.JSON:
return this.getJSON().toSettings();
case SettingSource.Form:
return this.getForm().toSettings();
}
throw new Error(`unknown settings source: ${this.source}`);
}
static valueOf(o: {
source: string;
json?: string;
form?: ReturnType<FormSettings['toJSON']>;
}): SettingData {
switch (o.source) {
case SettingSource.JSON:
return new SettingData({
source: o.source,
json: JSONSettings.valueOf(
o.json as ReturnType<JSONSettings['toJSON']>),
});
case SettingSource.Form:
return new SettingData({
source: o.source,
form: FormSettings.valueOf(
o.form as ReturnType<FormSettings['toJSON']>),
});
}
throw new Error(`unknown settings source: ${o.source}`);
}
}
export const DefaultSettingData: SettingData = SettingData.valueOf({
source: 'json',
json: `{
"keymaps": {
"0": { "type": "scroll.home" },
":": { "type": "command.show" },
"o": { "type": "command.show.open", "alter": false },
"O": { "type": "command.show.open", "alter": true },
"t": { "type": "command.show.tabopen", "alter": false },
"T": { "type": "command.show.tabopen", "alter": true },
"w": { "type": "command.show.winopen", "alter": false },
"W": { "type": "command.show.winopen", "alter": true },
"b": { "type": "command.show.buffer" },
"a": { "type": "command.show.addbookmark", "alter": true },
"k": { "type": "scroll.vertically", "count": -1 },
"j": { "type": "scroll.vertically", "count": 1 },
"h": { "type": "scroll.horizonally", "count": -1 },
"l": { "type": "scroll.horizonally", "count": 1 },
"<C-U>": { "type": "scroll.pages", "count": -0.5 },
"<C-D>": { "type": "scroll.pages", "count": 0.5 },
"<C-B>": { "type": "scroll.pages", "count": -1 },
"<C-F>": { "type": "scroll.pages", "count": 1 },
"gg": { "type": "scroll.top" },
"G": { "type": "scroll.bottom" },
"$": { "type": "scroll.end" },
"d": { "type": "tabs.close" },
"D": { "type": "tabs.close.right" },
"!d": { "type": "tabs.close.force" },
"u": { "type": "tabs.reopen" },
"K": { "type": "tabs.prev" },
"J": { "type": "tabs.next" },
"gT": { "type": "tabs.prev" },
"gt": { "type": "tabs.next" },
"g0": { "type": "tabs.first" },
"g$": { "type": "tabs.last" },
"<C-6>": { "type": "tabs.prevsel" },
"r": { "type": "tabs.reload", "cache": false },
"R": { "type": "tabs.reload", "cache": true },
"zp": { "type": "tabs.pin.toggle" },
"zd": { "type": "tabs.duplicate" },
"zi": { "type": "zoom.in" },
"zo": { "type": "zoom.out" },
"zz": { "type": "zoom.neutral" },
"f": { "type": "follow.start", "newTab": false },
"F": { "type": "follow.start", "newTab": true, "background": false },
"m": { "type": "mark.set.prefix" },
"'": { "type": "mark.jump.prefix" },
"H": { "type": "navigate.history.prev" },
"L": { "type": "navigate.history.next" },
"[[": { "type": "navigate.link.prev" },
"]]": { "type": "navigate.link.next" },
"gu": { "type": "navigate.parent" },
"gU": { "type": "navigate.root" },
"gi": { "type": "focus.input" },
"gf": { "type": "page.source" },
"gh": { "type": "page.home" },
"gH": { "type": "page.home", "newTab": true },
"y": { "type": "urls.yank" },
"p": { "type": "urls.paste", "newTab": false },
"P": { "type": "urls.paste", "newTab": true },
"/": { "type": "find.start" },
"n": { "type": "find.next" },
"N": { "type": "find.prev" },
"<S-Esc>": { "type": "addon.toggle.enabled" }
},
"search": {
"default": "google",
"engines": {
"google": "https://google.com/search?q={}",
"yahoo": "https://search.yahoo.com/search?p={}",
"bing": "https://www.bing.com/search?q={}",
"duckduckgo": "https://duckduckgo.com/?q={}",
"twitter": "https://twitter.com/search?q={}",
"wikipedia": "https://en.wikipedia.org/w/index.php?search={}"
}
},
"properties": {
"hintchars": "abcdefghijklmnopqrstuvwxyz",
"smoothscroll": false,
"complete": "sbh"
},
"blacklist": [
]
}`,
});

@ -0,0 +1,200 @@
import * as operations from './operations';
import * as PropertyDefs from './property-defs';
export type Keymaps = {[key: string]: operations.Operation};
export interface Search {
default: string;
engines: { [key: string]: string };
}
export interface Properties {
hintchars: string;
smoothscroll: boolean;
complete: string;
}
export default interface Settings {
keymaps: Keymaps;
search: Search;
properties: Properties;
blacklist: string[];
// eslint-disable-next-line semi
}
const DefaultProperties: Properties = PropertyDefs.defs.reduce(
(o: {[name: string]: PropertyDefs.Type}, def) => {
o[def.name] = def.defaultValue;
return o;
}, {}) as Properties;
export const keymapsValueOf = (o: any): Keymaps => {
return Object.keys(o).reduce((keymaps: Keymaps, key: string): Keymaps => {
let op = operations.valueOf(o[key]);
keymaps[key] = op;
return keymaps;
}, {});
};
export const searchValueOf = (o: any): Search => {
if (typeof o.default !== 'string') {
throw new TypeError('string field "default" not set"');
}
for (let name of Object.keys(o.engines)) {
if ((/\s/).test(name)) {
throw new TypeError(
`While space in the search engine not allowed: "${name}"`);
}
let url = o.engines[name];
if (typeof url !== 'string') {
throw new TypeError('"engines" not an object of string');
}
let matches = url.match(/{}/g);
if (matches === null) {
throw new TypeError(`No {}-placeholders in URL of "${name}"`);
} else if (matches.length > 1) {
throw new TypeError(`Multiple {}-placeholders in URL of "${name}"`);
}
}
if (!Object.prototype.hasOwnProperty.call(o.engines, o.default)) {
throw new TypeError(`Default engine "${o.default}" not found`);
}
return {
default: o.default as string,
engines: { ...o.engines },
};
};
export const propertiesValueOf = (o: any): Properties => {
let defNames = new Set(PropertyDefs.defs.map(def => def.name));
let unknownName = Object.keys(o).find(name => !defNames.has(name));
if (unknownName) {
throw new TypeError(`Unknown property name: "${unknownName}"`);
}
for (let def of PropertyDefs.defs) {
if (!Object.prototype.hasOwnProperty.call(o, def.name)) {
continue;
}
if (typeof o[def.name] !== def.type) {
throw new TypeError(`property "${def.name}" is not ${def.type}`);
}
}
return {
...DefaultProperties,
...o,
};
};
export const blacklistValueOf = (o: any): string[] => {
if (!Array.isArray(o)) {
throw new TypeError(`"blacklist" is not an array of string`);
}
for (let x of o) {
if (typeof x !== 'string') {
throw new TypeError(`"blacklist" is not an array of string`);
}
}
return o as string[];
};
export const valueOf = (o: any): Settings => {
let settings = { ...DefaultSetting };
if (Object.prototype.hasOwnProperty.call(o, 'keymaps')) {
settings.keymaps = keymapsValueOf(o.keymaps);
}
if (Object.prototype.hasOwnProperty.call(o, 'search')) {
settings.search = searchValueOf(o.search);
}
if (Object.prototype.hasOwnProperty.call(o, 'properties')) {
settings.properties = propertiesValueOf(o.properties);
}
if (Object.prototype.hasOwnProperty.call(o, 'blacklist')) {
settings.blacklist = blacklistValueOf(o.blacklist);
}
return settings;
};
const DefaultSetting: Settings = {
keymaps: {
'0': { 'type': 'scroll.home' },
':': { 'type': 'command.show' },
'o': { 'type': 'command.show.open', 'alter': false },
'O': { 'type': 'command.show.open', 'alter': true },
't': { 'type': 'command.show.tabopen', 'alter': false },
'T': { 'type': 'command.show.tabopen', 'alter': true },
'w': { 'type': 'command.show.winopen', 'alter': false },
'W': { 'type': 'command.show.winopen', 'alter': true },
'b': { 'type': 'command.show.buffer' },
'a': { 'type': 'command.show.addbookmark', 'alter': true },
'k': { 'type': 'scroll.vertically', 'count': -1 },
'j': { 'type': 'scroll.vertically', 'count': 1 },
'h': { 'type': 'scroll.horizonally', 'count': -1 },
'l': { 'type': 'scroll.horizonally', 'count': 1 },
'<C-U>': { 'type': 'scroll.pages', 'count': -0.5 },
'<C-D>': { 'type': 'scroll.pages', 'count': 0.5 },
'<C-B>': { 'type': 'scroll.pages', 'count': -1 },
'<C-F>': { 'type': 'scroll.pages', 'count': 1 },
'gg': { 'type': 'scroll.top' },
'G': { 'type': 'scroll.bottom' },
'$': { 'type': 'scroll.end' },
'd': { 'type': 'tabs.close' },
'D': { 'type': 'tabs.close.right' },
'!d': { 'type': 'tabs.close.force' },
'u': { 'type': 'tabs.reopen' },
'K': { 'type': 'tabs.prev' },
'J': { 'type': 'tabs.next' },
'gT': { 'type': 'tabs.prev' },
'gt': { 'type': 'tabs.next' },
'g0': { 'type': 'tabs.first' },
'g$': { 'type': 'tabs.last' },
'<C-6>': { 'type': 'tabs.prevsel' },
'r': { 'type': 'tabs.reload', 'cache': false },
'R': { 'type': 'tabs.reload', 'cache': true },
'zp': { 'type': 'tabs.pin.toggle' },
'zd': { 'type': 'tabs.duplicate' },
'zi': { 'type': 'zoom.in' },
'zo': { 'type': 'zoom.out' },
'zz': { 'type': 'zoom.neutral' },
'f': { 'type': 'follow.start', 'newTab': false, 'background': false },
'F': { 'type': 'follow.start', 'newTab': true, 'background': false },
'm': { 'type': 'mark.set.prefix' },
'\'': { 'type': 'mark.jump.prefix' },
'H': { 'type': 'navigate.history.prev' },
'L': { 'type': 'navigate.history.next' },
'[[': { 'type': 'navigate.link.prev' },
']]': { 'type': 'navigate.link.next' },
'gu': { 'type': 'navigate.parent' },
'gU': { 'type': 'navigate.root' },
'gi': { 'type': 'focus.input' },
'gf': { 'type': 'page.source' },
'gh': { 'type': 'page.home', 'newTab': false },
'gH': { 'type': 'page.home', 'newTab': true },
'y': { 'type': 'urls.yank' },
'p': { 'type': 'urls.paste', 'newTab': false },
'P': { 'type': 'urls.paste', 'newTab': true },
'/': { 'type': 'find.start' },
'n': { 'type': 'find.next' },
'N': { 'type': 'find.prev' },
'<S-Esc>': { 'type': 'addon.toggle.enabled' }
},
search: {
default: 'google',
engines: {
'google': 'https://google.com/search?q={}',
'yahoo': 'https://search.yahoo.com/search?p={}',
'bing': 'https://www.bing.com/search?q={}',
'duckduckgo': 'https://duckduckgo.com/?q={}',
'twitter': 'https://twitter.com/search?q={}',
'wikipedia': 'https://en.wikipedia.org/w/index.php?search={}'
}
},
properties: {
hintchars: 'abcdefghijklmnopqrstuvwxyz',
smoothscroll: false,
complete: 'sbh'
},
blacklist: []
};

@ -443,5 +443,5 @@ export const valueOf = (o: any): Operation => {
case MARK_JUMP_PREFIX: case MARK_JUMP_PREFIX:
return { type: o.type }; return { type: o.type };
} }
throw new Error('unknown operation type: ' + o.type); throw new TypeError('unknown operation type: ' + o.type);
}; };

@ -0,0 +1,50 @@
export type Type = string | number | boolean;
export class Def {
private name0: string;
private description0: string;
private defaultValue0: Type;
constructor(
name: string,
description: string,
defaultValue: Type,
) {
this.name0 = name;
this.description0 = description;
this.defaultValue0 = defaultValue;
}
public get name(): string {
return this.name0;
}
public get defaultValue(): Type {
return this.defaultValue0;
}
public get description(): Type {
return this.description0;
}
public get type(): string {
return typeof this.defaultValue;
}
}
export const defs: Def[] = [
new Def(
'hintchars',
'hint characters on follow mode',
'abcdefghijklmnopqrstuvwxyz'),
new Def(
'smoothscroll',
'smooth scroll',
false),
new Def(
'complete',
'which are completed at the open page',
'sbh'),
];

@ -0,0 +1,50 @@
export type Type = string | number | boolean;
export class Def {
private name0: string;
private description0: string;
private defaultValue0: Type;
constructor(
name: string,
description: string,
defaultValue: Type,
) {
this.name0 = name;
this.description0 = description;
this.defaultValue0 = defaultValue;
}
public get name(): string {
return this.name0;
}
public get defaultValue(): Type {
return this.defaultValue0;
}
public get description(): Type {
return this.description0;
}
public get type(): string {
return typeof this.defaultValue;
}
}
export const defs: Def[] = [
new Def(
'hintchars',
'hint characters on follow mode',
'abcdefghijklmnopqrstuvwxyz'),
new Def(
'smoothscroll',
'smooth scroll',
false),
new Def(
'complete',
'which are completed at the open page',
'sbh'),
];

@ -1,85 +0,0 @@
export default {
source: 'json',
json: `{
"keymaps": {
"0": { "type": "scroll.home" },
":": { "type": "command.show" },
"o": { "type": "command.show.open", "alter": false },
"O": { "type": "command.show.open", "alter": true },
"t": { "type": "command.show.tabopen", "alter": false },
"T": { "type": "command.show.tabopen", "alter": true },
"w": { "type": "command.show.winopen", "alter": false },
"W": { "type": "command.show.winopen", "alter": true },
"b": { "type": "command.show.buffer" },
"a": { "type": "command.show.addbookmark", "alter": true },
"k": { "type": "scroll.vertically", "count": -1 },
"j": { "type": "scroll.vertically", "count": 1 },
"h": { "type": "scroll.horizonally", "count": -1 },
"l": { "type": "scroll.horizonally", "count": 1 },
"<C-U>": { "type": "scroll.pages", "count": -0.5 },
"<C-D>": { "type": "scroll.pages", "count": 0.5 },
"<C-B>": { "type": "scroll.pages", "count": -1 },
"<C-F>": { "type": "scroll.pages", "count": 1 },
"gg": { "type": "scroll.top" },
"G": { "type": "scroll.bottom" },
"$": { "type": "scroll.end" },
"d": { "type": "tabs.close" },
"D": { "type": "tabs.close.right" },
"!d": { "type": "tabs.close.force" },
"u": { "type": "tabs.reopen" },
"K": { "type": "tabs.prev", "count": 1 },
"J": { "type": "tabs.next", "count": 1 },
"gT": { "type": "tabs.prev", "count": 1 },
"gt": { "type": "tabs.next", "count": 1 },
"g0": { "type": "tabs.first" },
"g$": { "type": "tabs.last" },
"<C-6>": { "type": "tabs.prevsel" },
"r": { "type": "tabs.reload", "cache": false },
"R": { "type": "tabs.reload", "cache": true },
"zp": { "type": "tabs.pin.toggle" },
"zd": { "type": "tabs.duplicate" },
"zi": { "type": "zoom.in" },
"zo": { "type": "zoom.out" },
"zz": { "type": "zoom.neutral" },
"f": { "type": "follow.start", "newTab": false },
"F": { "type": "follow.start", "newTab": true, "background": false },
"m": { "type": "mark.set.prefix" },
"'": { "type": "mark.jump.prefix" },
"H": { "type": "navigate.history.prev" },
"L": { "type": "navigate.history.next" },
"[[": { "type": "navigate.link.prev" },
"]]": { "type": "navigate.link.next" },
"gu": { "type": "navigate.parent" },
"gU": { "type": "navigate.root" },
"gi": { "type": "focus.input" },
"gf": { "type": "page.source" },
"gh": { "type": "page.home" },
"gH": { "type": "page.home", "newTab": true },
"y": { "type": "urls.yank" },
"p": { "type": "urls.paste", "newTab": false },
"P": { "type": "urls.paste", "newTab": true },
"/": { "type": "find.start" },
"n": { "type": "find.next" },
"N": { "type": "find.prev" },
"<S-Esc>": { "type": "addon.toggle.enabled" }
},
"search": {
"default": "google",
"engines": {
"google": "https://google.com/search?q={}",
"yahoo": "https://search.yahoo.com/search?p={}",
"bing": "https://www.bing.com/search?q={}",
"duckduckgo": "https://duckduckgo.com/?q={}",
"twitter": "https://twitter.com/search?q={}",
"wikipedia": "https://en.wikipedia.org/w/index.php?search={}"
}
},
"properties": {
"hintchars": "abcdefghijklmnopqrstuvwxyz",
"smoothscroll": false,
"complete": "sbh"
},
"blacklist": [
]
}`,
};

@ -1,24 +0,0 @@
// describe types of a propety as:
// mystr: 'string',
// mynum: 'number',
// mybool: 'boolean',
const types: { [key: string]: string } = {
hintchars: 'string',
smoothscroll: 'boolean',
complete: 'string',
};
// describe default values of a property
const defaults: { [key: string]: string | number | boolean } = {
hintchars: 'abcdefghijklmnopqrstuvwxyz',
smoothscroll: false,
complete: 'sbh',
};
const docs: { [key: string]: string } = {
hintchars: 'hint characters on follow mode',
smoothscroll: 'smooth scroll',
complete: 'which are completed at the open page',
};
export { types, defaults, docs };

@ -1,32 +0,0 @@
import DefaultSettings from './default';
import * as settingsValues from './values';
const loadRaw = async(): Promise<any> => {
let { settings } = await browser.storage.local.get('settings');
if (!settings) {
return DefaultSettings;
}
return { ...DefaultSettings, ...settings as object };
};
const loadValue = async() => {
let settings = await loadRaw();
let value = JSON.parse(DefaultSettings.json);
if (settings.source === 'json') {
value = settingsValues.valueFromJson(settings.json);
} else if (settings.source === 'form') {
value = settingsValues.valueFromForm(settings.form);
}
if (!value.properties) {
value.properties = {};
}
return { ...settingsValues.valueFromJson(DefaultSettings.json), ...value };
};
const save = (settings: any): Promise<any> => {
return browser.storage.local.set({
settings,
});
};
export { loadRaw, loadValue, save };

@ -1,76 +0,0 @@
import * as operations from '../operations';
import * as properties from './properties';
const VALID_TOP_KEYS = ['keymaps', 'search', 'blacklist', 'properties'];
const VALID_OPERATION_VALUES = Object.keys(operations).map((key) => {
return operations[key];
});
const validateInvalidTopKeys = (settings: any): void => {
let invalidKey = Object.keys(settings).find((key) => {
return !VALID_TOP_KEYS.includes(key);
});
if (invalidKey) {
throw Error(`Unknown key: "${invalidKey}"`);
}
};
const validateKeymaps = (keymaps: any): void => {
for (let key of Object.keys(keymaps)) {
let value = keymaps[key];
if (!VALID_OPERATION_VALUES.includes(value.type)) {
throw Error(`Unknown operation: "${value.type}"`);
}
}
};
const validateSearch = (search: any): void => {
let engines = search.engines;
for (let key of Object.keys(engines)) {
if ((/\s/).test(key)) {
throw new Error(
`While space in search engine name is not allowed: "${key}"`
);
}
let url = engines[key];
if (!url.match(/{}/)) {
throw new Error(`No {}-placeholders in URL of "${key}"`);
}
if (url.match(/{}/g).length > 1) {
throw new Error(`Multiple {}-placeholders in URL of "${key}"`);
}
}
if (!search.default) {
throw new Error(`Default engine is not set`);
}
if (!Object.keys(engines).includes(search.default)) {
throw new Error(`Default engine "${search.default}" not found`);
}
};
const validateProperties = (props: any): void => {
for (let name of Object.keys(props)) {
if (!properties.types[name]) {
throw new Error(`Unknown property name: "${name}"`);
}
if (typeof props[name] !== properties.types[name]) {
throw new Error(`Invalid type for property: "${name}"`);
}
}
};
const validate = (settings: any): void => {
validateInvalidTopKeys(settings);
if (settings.keymaps) {
validateKeymaps(settings.keymaps);
}
if (settings.search) {
validateSearch(settings.search);
}
if (settings.properties) {
validateProperties(settings.properties);
}
};
export { validate };

@ -1,108 +0,0 @@
import * as properties from './properties';
const operationFromFormName = (name: string): any => {
let [type, argStr] = name.split('?');
let args = {};
if (argStr) {
args = JSON.parse(argStr);
}
return { type, ...args };
};
const operationToFormName = (op: any): string => {
let type = op.type;
let args = { ...op };
delete args.type;
if (Object.keys(args).length === 0) {
return type;
}
return op.type + '?' + JSON.stringify(args);
};
const valueFromJson = (json: string): object => {
return JSON.parse(json);
};
const valueFromForm = (form: any): object => {
let keymaps: any = undefined;
if (form.keymaps) {
keymaps = {};
for (let name of Object.keys(form.keymaps)) {
let keys = form.keymaps[name];
keymaps[keys] = operationFromFormName(name);
}
}
let search: any = undefined;
if (form.search) {
search = { default: form.search.default };
if (form.search.engines) {
search.engines = {};
for (let [name, url] of form.search.engines) {
search.engines[name] = url;
}
}
}
return {
keymaps,
search,
blacklist: form.blacklist,
properties: form.properties
};
};
const jsonFromValue = (value: any): string => {
return JSON.stringify(value, undefined, 2);
};
const formFromValue = (value: any, allowedOps: any[]): any => {
let keymaps: any = undefined;
if (value.keymaps) {
let allowedSet = new Set(allowedOps);
keymaps = {};
for (let keys of Object.keys(value.keymaps)) {
let op = operationToFormName(value.keymaps[keys]);
if (allowedSet.has(op)) {
keymaps[op] = keys;
}
}
}
let search: any = undefined;
if (value.search) {
search = { default: value.search.default };
if (value.search.engines) {
search.engines = Object.keys(value.search.engines).map((name) => {
return [name, value.search.engines[name]];
});
}
}
let formProperties = { ...properties.defaults, ...value.properties };
return {
keymaps,
search,
blacklist: value.blacklist,
properties: formProperties,
};
};
const jsonFromForm = (form: any): string => {
return jsonFromValue(valueFromForm(form));
};
const formFromJson = (json: string, allowedOps: any[]): any => {
let value = valueFromJson(json);
return formFromValue(value, allowedOps);
};
export {
valueFromJson, valueFromForm, jsonFromValue, formFromValue,
jsonFromForm, formFromJson
};

@ -3,45 +3,32 @@ import * as parsers from 'background/usecases/parsers';
describe("shared/commands/parsers", () => { describe("shared/commands/parsers", () => {
describe("#parsers.parseSetOption", () => { describe("#parsers.parseSetOption", () => {
it('parse set string', () => { it('parse set string', () => {
let [key, value] = parsers.parseSetOption('encoding=utf-8', { encoding: 'string' }); let [key, value] = parsers.parseSetOption('hintchars=abcdefgh');
expect(key).to.equal('encoding'); expect(key).to.equal('hintchars');
expect(value).to.equal('utf-8'); expect(value).to.equal('abcdefgh');
}); });
it('parse set empty string', () => { it('parse set empty string', () => {
let [key, value] = parsers.parseSetOption('encoding=', { encoding: 'string' }); let [key, value] = parsers.parseSetOption('hintchars=');
expect(key).to.equal('encoding'); expect(key).to.equal('hintchars');
expect(value).to.equal(''); expect(value).to.equal('');
}); });
it('parse set string', () => {
let [key, value] = parsers.parseSetOption('history=50', { history: 'number' });
expect(key).to.equal('history');
expect(value).to.equal(50);
});
it('parse set boolean', () => { it('parse set boolean', () => {
let [key, value] = parsers.parseSetOption('paste', { paste: 'boolean' }); let [key, value] = parsers.parseSetOption('smoothscroll');
expect(key).to.equal('paste'); expect(key).to.equal('smoothscroll');
expect(value).to.be.true; expect(value).to.be.true;
[key, value] = parsers.parseSetOption('nopaste', { paste: 'boolean' }); [key, value] = parsers.parseSetOption('nosmoothscroll');
expect(key).to.equal('paste'); expect(key).to.equal('smoothscroll');
expect(value).to.be.false; expect(value).to.be.false;
}); });
it('throws error on unknown property', () => { it('throws error on unknown property', () => {
expect(() => parsers.parseSetOption('charset=utf-8', {})).to.throw(Error, 'Unknown'); expect(() => parsers.parseSetOption('encoding=utf-8')).to.throw(Error, 'Unknown');
expect(() => parsers.parseSetOption('smoothscroll', {})).to.throw(Error, 'Unknown'); expect(() => parsers.parseSetOption('paste')).to.throw(Error, 'Unknown');
expect(() => parsers.parseSetOption('nosmoothscroll', {})).to.throw(Error, 'Unknown'); expect(() => parsers.parseSetOption('nopaste')).to.throw(Error, 'Unknown');
}) expect(() => parsers.parseSetOption('smoothscroll=yes')).to.throw(Error, 'Invalid argument');
});
it('throws error on invalid property', () => {
expect(() => parsers.parseSetOption('charset=utf-8', { charset: 'number' })).to.throw(Error, 'Not number');
expect(() => parsers.parseSetOption('charset=utf-8', { charset: 'boolean' })).to.throw(Error, 'Invalid');
expect(() => parsers.parseSetOption('charset=', { charset: 'boolean' })).to.throw(Error, 'Invalid');
expect(() => parsers.parseSetOption('smoothscroll', { smoothscroll: 'string' })).to.throw(Error, 'Invalid');
expect(() => parsers.parseSetOption('smoothscroll', { smoothscroll: 'number' })).to.throw(Error, 'Invalid');
})
}); });
}); });

@ -4,32 +4,40 @@ import * as settingActions from 'content/actions/setting';
describe("setting actions", () => { describe("setting actions", () => {
describe("set", () => { describe("set", () => {
it('create SETTING_SET action', () => { it('create SETTING_SET action', () => {
let action = settingActions.set({ red: 'apple', yellow: 'banana' }); let action = settingActions.set({
keymaps: {
'dd': 'remove current tab',
'z<C-A>': 'increment',
},
search: {
default: "google",
engines: {
google: 'https://google.com/search?q={}',
}
},
properties: {
hintchars: 'abcd1234',
},
blacklist: [],
});
expect(action.type).to.equal(actions.SETTING_SET); expect(action.type).to.equal(actions.SETTING_SET);
expect(action.value.red).to.equal('apple'); expect(action.settings.properties.hintchars).to.equal('abcd1234');
expect(action.value.yellow).to.equal('banana');
expect(action.value.keymaps).to.be.empty;
}); });
it('converts keymaps', () => { it('overrides cancel keys', () => {
let action = settingActions.set({ let action = settingActions.set({
keymaps: { keymaps: {
'dd': 'remove current tab', "k": { "type": "scroll.vertically", "count": -1 },
'z<C-A>': 'increment', "j": { "type": "scroll.vertically", "count": 1 },
} }
}); });
let keymaps = action.value.keymaps; let keymaps = action.settings.keymaps;
let map = new Map(keymaps); expect(action.settings.keymaps).to.deep.equals({
expect(map).to.have.deep.all.keys( "k": { type: "scroll.vertically", count: -1 },
[ "j": { type: "scroll.vertically", count: 1 },
[{ key: 'Esc', shiftKey: false, ctrlKey: false, altKey: false, metaKey: false }], '<Esc>': { type: 'cancel' },
[{ key: '[', shiftKey: false, ctrlKey: true, altKey: false, metaKey: false }], '<C-[>': { type: 'cancel' },
[{ key: 'd', shiftKey: false, ctrlKey: false, altKey: false, metaKey: false }, });
{ key: 'd', shiftKey: false, ctrlKey: false, altKey: false, metaKey: false }],
[{ key: 'z', shiftKey: false, ctrlKey: false, altKey: false, metaKey: false },
{ key: 'a', shiftKey: false, ctrlKey: true, altKey: false, metaKey: false }],
]
);
}); });
}); });
}); });

@ -9,9 +9,24 @@ describe("content setting reducer", () => {
it('return next state for SETTING_SET', () => { it('return next state for SETTING_SET', () => {
let newSettings = { red: 'apple', yellow: 'banana' }; let newSettings = { red: 'apple', yellow: 'banana' };
let action = { type: actions.SETTING_SET, value: newSettings }; let action = {
type: actions.SETTING_SET,
settings: {
keymaps: {
"zz": { type: "zoom.neutral" },
"<S-Esc>": { "type": "addon.toggle.enabled" }
},
"blacklist": []
}
}
let state = settingReducer(undefined, action); let state = settingReducer(undefined, action);
expect(state).to.deep.equal(newSettings); console.log(JSON.stringify(state.keymaps));
expect(state).not.to.equal(newSettings); // assert deep copy expect(state.keymaps).to.have.deep.all.members([
{ key: [{ key: 'z', shiftKey: false, ctrlKey: false, altKey: false, metaKey: false },
{ key: 'z', shiftKey: false, ctrlKey: false, altKey: false, metaKey: false }],
op: { type: 'zoom.neutral' }},
{ key: [{ key: 'Esc', shiftKey: true, ctrlKey: false, altKey: false, metaKey: false }],
op: { type: 'addon.toggle.enabled' }},
]);
}); });
}); });

@ -2,15 +2,17 @@ import React from 'react';
import ReactDOM from 'react-dom'; import ReactDOM from 'react-dom';
import ReactTestRenderer from 'react-test-renderer'; import ReactTestRenderer from 'react-test-renderer';
import ReactTestUtils from 'react-dom/test-utils'; import ReactTestUtils from 'react-dom/test-utils';
import KeymapsForm from 'settings/components/form/KeymapsForm' import KeymapsForm from '../../../../src/settings/components/form/KeymapsForm'
import { FormKeymaps } from 'shared/SettingData';
import { expect } from 'chai';
describe("settings/form/KeymapsForm", () => { describe("settings/form/KeymapsForm", () => {
describe('render', () => { describe('render', () => {
it('renders keymap fields', () => { it('renders keymap fields', () => {
let root = ReactTestRenderer.create(<KeymapsForm value={{ let root = ReactTestRenderer.create(<KeymapsForm value={FormKeymaps.valueOf({
'scroll.vertically?{"count":1}': 'j', 'scroll.vertically?{"count":1}': 'j',
'scroll.vertically?{"count":-1}': 'k', 'scroll.vertically?{"count":-1}': 'k',
}} />).root })} />).root
let inputj = root.findByProps({ id: 'scroll.vertically?{"count":1}' }); let inputj = root.findByProps({ id: 'scroll.vertically?{"count":1}' });
let inputk = root.findByProps({ id: 'scroll.vertically?{"count":-1}' }); let inputk = root.findByProps({ id: 'scroll.vertically?{"count":-1}' });
@ -46,12 +48,12 @@ describe("settings/form/KeymapsForm", () => {
it('invokes onChange event on edit', (done) => { it('invokes onChange event on edit', (done) => {
ReactTestUtils.act(() => { ReactTestUtils.act(() => {
ReactDOM.render(<KeymapsForm ReactDOM.render(<KeymapsForm
value={{ value={FormKeymaps.valueOf({
'scroll.vertically?{"count":1}': 'j', 'scroll.vertically?{"count":1}': 'j',
'scroll.vertically?{"count":-1}': 'k', 'scroll.vertically?{"count":-1}': 'k',
}} })}
onChange={value => { onChange={value => {
expect(value['scroll.vertically?{"count":1}']).to.equal('jjj'); expect(value.toJSON()['scroll.vertically?{"count":1}']).to.equal('jjj');
done(); done();
}} />, container); }} />, container);
}); });

@ -3,14 +3,15 @@ import ReactDOM from 'react-dom';
import ReactTestRenderer from 'react-test-renderer'; import ReactTestRenderer from 'react-test-renderer';
import ReactTestUtils from 'react-dom/test-utils'; import ReactTestUtils from 'react-dom/test-utils';
import SearchForm from 'settings/components/form/SearchForm' import SearchForm from 'settings/components/form/SearchForm'
import { FormSearch } from 'shared/SettingData';
describe("settings/form/SearchForm", () => { describe("settings/form/SearchForm", () => {
describe('render', () => { describe('render', () => {
it('renders SearchForm', () => { it('renders SearchForm', () => {
let root = ReactTestRenderer.create(<SearchForm value={{ let root = ReactTestRenderer.create(<SearchForm value={FormSearch.valueOf({
default: 'google', default: 'google',
engines: [['google', 'google.com'], ['yahoo', 'yahoo.com']], engines: [['google', 'google.com'], ['yahoo', 'yahoo.com']],
}} />).root; })} />).root;
let names = root.findAllByProps({ name: 'name' }); let names = root.findAllByProps({ name: 'name' });
expect(names).to.have.lengthOf(2); expect(names).to.have.lengthOf(2);
@ -22,28 +23,6 @@ describe("settings/form/SearchForm", () => {
expect(urls[0].props.value).to.equal('google.com'); expect(urls[0].props.value).to.equal('google.com');
expect(urls[1].props.value).to.equal('yahoo.com'); expect(urls[1].props.value).to.equal('yahoo.com');
}); });
it('renders blank value', () => {
let root = ReactTestRenderer.create(<SearchForm />).root;
let names = root.findAllByProps({ name: 'name' });
expect(names).to.be.empty;
let urls = root.findAllByProps({ name: 'url' });
expect(urls).to.be.empty;
});
it('renders blank engines', () => {
let root = ReactTestRenderer.create(
<SearchForm value={{ default: 'google' }} />,
).root;
let names = root.findAllByProps({ name: 'name' });
expect(names).to.be.empty;
let urls = root.findAllByProps({ name: 'url' });
expect(urls).to.be.empty;
});
}); });
describe('onChange event', () => { describe('onChange event', () => {
@ -62,14 +41,15 @@ describe("settings/form/SearchForm", () => {
it('invokes onChange event on edit', (done) => { it('invokes onChange event on edit', (done) => {
ReactTestUtils.act(() => { ReactTestUtils.act(() => {
ReactDOM.render(<SearchForm ReactDOM.render(<SearchForm
value={{ value={FormSearch.valueOf({
default: 'google', default: 'google',
engines: [['google', 'google.com'], ['yahoo', 'yahoo.com']] engines: [['google', 'google.com'], ['yahoo', 'yahoo.com']]
}} })}
onChange={value => { onChange={value => {
expect(value.default).to.equal('louvre'); let json = value.toJSON();
expect(value.engines).to.have.lengthOf(2) expect(json.default).to.equal('louvre');
expect(value.engines).to.have.deep.members( expect(json.engines).to.have.lengthOf(2)
expect(json.engines).to.have.deep.members(
[['louvre', 'google.com'], ['yahoo', 'yahoo.com']] [['louvre', 'google.com'], ['yahoo', 'yahoo.com']]
); );
done(); done();
@ -87,14 +67,15 @@ describe("settings/form/SearchForm", () => {
it('invokes onChange event on delete', (done) => { it('invokes onChange event on delete', (done) => {
ReactTestUtils.act(() => { ReactTestUtils.act(() => {
ReactDOM.render(<SearchForm value={{ ReactDOM.render(<SearchForm value={FormSearch.valueOf({
default: 'yahoo', default: 'yahoo',
engines: [['louvre', 'google.com'], ['yahoo', 'yahoo.com']] engines: [['louvre', 'google.com'], ['yahoo', 'yahoo.com']]
}} })}
onChange={value => { onChange={value => {
expect(value.default).to.equal('yahoo'); let json = value.toJSON();
expect(value.engines).to.have.lengthOf(1) expect(json.default).to.equal('yahoo');
expect(value.engines).to.have.deep.members( expect(json.engines).to.have.lengthOf(1)
expect(json.engines).to.have.deep.members(
[['yahoo', 'yahoo.com']] [['yahoo', 'yahoo.com']]
); );
done(); done();
@ -107,14 +88,15 @@ describe("settings/form/SearchForm", () => {
it('invokes onChange event on add', (done) => { it('invokes onChange event on add', (done) => {
ReactTestUtils.act(() => { ReactTestUtils.act(() => {
ReactDOM.render(<SearchForm value={{ ReactDOM.render(<SearchForm value={FormSearch.valueOf({
default: 'yahoo', default: 'yahoo',
engines: [['google', 'google.com']] engines: [['google', 'google.com']]
}} })}
onChange={value => { onChange={value => {
expect(value.default).to.equal('yahoo'); let json = value.toJSON();
expect(value.engines).to.have.lengthOf(2) expect(json.default).to.equal('yahoo');
expect(value.engines).to.have.deep.members( expect(json.engines).to.have.lengthOf(2)
expect(json.engines).to.have.deep.members(
[['google', 'google.com'], ['', '']], [['google', 'google.com'], ['', '']],
); );
done(); done();

@ -4,8 +4,7 @@ import settingReducer from 'settings/reducers/setting';
describe("settings setting reducer", () => { describe("settings setting reducer", () => {
it('return the initial state', () => { it('return the initial state', () => {
let state = settingReducer(undefined, {}); let state = settingReducer(undefined, {});
expect(state).to.have.deep.property('json', ''); expect(state).to.have.deep.property('source', 'json');
expect(state).to.have.deep.property('form', null);
expect(state).to.have.deep.property('error', ''); expect(state).to.have.deep.property('error', '');
}); });

@ -0,0 +1,293 @@
import SettingData, {
FormKeymaps, JSONSettings, FormSettings,
} from '../../src/shared/SettingData';
import Settings, { Keymaps } from '../../src/shared/Settings';
import { expect } from 'chai';
describe('shared/SettingData', () => {
describe('FormKeymaps', () => {
describe('#valueOF to #toKeymaps', () => {
it('parses form keymaps and convert to operations', () => {
let data = {
'scroll.vertically?{"count":1}': 'j',
'scroll.home': '0',
}
let keymaps = FormKeymaps.valueOf(data).toKeymaps();
expect(keymaps).to.deep.equal({
'j': { type: 'scroll.vertically', count: 1 },
'0': { type: 'scroll.home' },
});
});
});
describe('#fromKeymaps to #toJSON', () => {
it('create from a Keymaps and create a JSON object', () => {
let data: Keymaps = {
'j': { type: 'scroll.vertically', count: 1 },
'0': { type: 'scroll.home' },
}
let keymaps = FormKeymaps.fromKeymaps(data).toJSON();
expect(keymaps).to.deep.equal({
'scroll.vertically?{"count":1}': 'j',
'scroll.home': '0',
});
});
});
});
describe('JSONSettings', () => {
describe('#valueOf to #toSettings', () => {
it('parse object and create a Settings', () => {
let o = `{
"keymaps": {},
"search": {
"default": "google",
"engines": {
"google": "https://google.com/search?q={}"
}
},
"properties": {
"hintchars": "abcdefghijklmnopqrstuvwxyz",
"smoothscroll": false,
"complete": "sbh"
},
"blacklist": []
}`;
let settings = JSONSettings.valueOf(o).toSettings();
expect(settings).to.deep.equal(JSON.parse(o));
});
});
describe('#fromSettings to #toJSON', () => {
it('create from a Settings and create a JSON string', () => {
let o = {
keymaps: {},
search: {
default: "google",
engines: {
google: "https://google.com/search?q={}",
},
},
properties: {
hintchars: "abcdefghijklmnopqrstuvwxyz",
smoothscroll: false,
complete: "sbh"
},
blacklist: [],
};
let json = JSONSettings.fromSettings(o).toJSON();
expect(JSON.parse(json)).to.deep.equal(o);
});
});
});
describe('FormSettings', () => {
describe('#valueOf to #toSettings', () => {
it('parse object and create a Settings', () => {
let data = {
keymaps: {
'scroll.vertically?{"count":1}': 'j',
'scroll.home': '0',
},
search: {
default: "google",
engines: [
["google", "https://google.com/search?q={}"],
]
},
properties: {
hintchars: "abcdefghijklmnopqrstuvwxyz",
smoothscroll: false,
complete: "sbh"
},
blacklist: []
};
let settings = FormSettings.valueOf(data).toSettings();
expect(settings).to.deep.equal({
keymaps: {
'j': { type: 'scroll.vertically', count: 1 },
'0': { type: 'scroll.home' },
},
search: {
default: "google",
engines: {
"google": "https://google.com/search?q={}"
}
},
properties: {
hintchars: "abcdefghijklmnopqrstuvwxyz",
smoothscroll: false,
complete: "sbh"
},
blacklist: []
});
});
});
describe('#fromSettings to #toJSON', () => {
it('create from a Settings and create a JSON string', () => {
let data: Settings = {
keymaps: {
'j': { type: 'scroll.vertically', count: 1 },
'0': { type: 'scroll.home' },
},
search: {
default: "google",
engines: {
"google": "https://google.com/search?q={}"
}
},
properties: {
hintchars: "abcdefghijklmnopqrstuvwxyz",
smoothscroll: false,
complete: "sbh"
},
blacklist: []
};
let json = FormSettings.fromSettings(data).toJSON();
expect(json).to.deep.equal({
keymaps: {
'scroll.vertically?{"count":1}': 'j',
'scroll.home': '0',
},
search: {
default: "google",
engines: [
["google", "https://google.com/search?q={}"],
]
},
properties: {
hintchars: "abcdefghijklmnopqrstuvwxyz",
smoothscroll: false,
complete: "sbh"
},
blacklist: [],
});
});
});
});
describe('SettingData', () => {
describe('#valueOf to #toJSON', () => {
it('parse object from json source', () => {
let data = {
source: 'json',
json: `{
"keymaps": {},
"search": {
"default": "google",
"engines": {
"google": "https://google.com/search?q={}"
}
},
"properties": {
"hintchars": "abcdefghijklmnopqrstuvwxyz",
"smoothscroll": false,
"complete": "sbh"
},
"blacklist": []
}`,
};
let j = SettingData.valueOf(data).toJSON();
expect(j.source).to.equal('json');
expect(j.json).to.be.a('string');
});
it('parse object from form source', () => {
let data = {
source: 'form',
form: {
keymaps: {},
search: {
default: "yahoo",
engines: [
['yahoo', 'https://yahoo.com/search?q={}'],
],
},
properties: {
hintchars: "abcdefghijklmnopqrstuvwxyz",
smoothscroll: false,
complete: "sbh"
},
blacklist: [],
},
};
let j = SettingData.valueOf(data).toJSON();
expect(j.source).to.equal('form');
expect(j.form).to.deep.equal({
keymaps: {},
search: {
default: "yahoo",
engines: [
['yahoo', 'https://yahoo.com/search?q={}'],
],
},
properties: {
hintchars: "abcdefghijklmnopqrstuvwxyz",
smoothscroll: false,
complete: "sbh"
},
blacklist: [],
});
});
});
describe('#toSettings', () => {
it('parse object from json source', () => {
let data = {
source: 'json',
json: `{
"keymaps": {},
"search": {
"default": "google",
"engines": {
"google": "https://google.com/search?q={}"
}
},
"properties": {
"hintchars": "abcdefghijklmnopqrstuvwxyz",
"smoothscroll": false,
"complete": "sbh"
},
"blacklist": []
}`,
};
let settings = SettingData.valueOf(data).toSettings();
expect(settings.search.default).to.equal('google');
});
it('parse object from form source', () => {
let data = {
source: 'form',
form: {
keymaps: {},
search: {
default: "yahoo",
engines: [
['yahoo', 'https://yahoo.com/search?q={}'],
],
},
properties: {
hintchars: "abcdefghijklmnopqrstuvwxyz",
smoothscroll: false,
complete: "sbh"
},
blacklist: [],
},
};
let settings = SettingData.valueOf(data).toSettings();
expect(settings.search.default).to.equal('yahoo');
});
});
});
});

@ -0,0 +1,190 @@
import * as settings from '../../src/shared/Settings';
import { expect } from 'chai';
describe('Settings', () => {
describe('#keymapsValueOf', () => {
it('returns empty object by empty settings', () => {
let keymaps = settings.keymapsValueOf({});
expect(keymaps).to.be.empty;
});
it('returns keymaps by valid settings', () => {
let keymaps = settings.keymapsValueOf({
k: { type: "scroll.vertically", count: -1 },
j: { type: "scroll.vertically", count: 1 },
});
expect(keymaps['k']).to.deep.equal({ type: "scroll.vertically", count: -1 });
expect(keymaps['j']).to.deep.equal({ type: "scroll.vertically", count: 1 });
});
it('throws a TypeError by invalid settings', () => {
expect(() => settings.keymapsValueOf(null)).to.throw(TypeError);
expect(() => settings.keymapsValueOf({
k: { type: "invalid.operation" },
})).to.throw(TypeError);
});
});
describe('#searchValueOf', () => {
it('returns search settings by valid settings', () => {
let search = settings.searchValueOf({
default: "google",
engines: {
"google": "https://google.com/search?q={}",
"yahoo": "https://search.yahoo.com/search?p={}",
}
});
expect(search).to.deep.equal({
default: "google",
engines: {
"google": "https://google.com/search?q={}",
"yahoo": "https://search.yahoo.com/search?p={}",
}
});
});
it('throws a TypeError by invalid settings', () => {
expect(() => settings.searchValueOf(null)).to.throw(TypeError);
expect(() => settings.searchValueOf({})).to.throw(TypeError);
expect(() => settings.searchValueOf([])).to.throw(TypeError);
expect(() => settings.searchValueOf({
default: 123,
engines: {}
})).to.throw(TypeError);
expect(() => settings.searchValueOf({
default: "google",
engines: {
"google": 123456,
}
})).to.throw(TypeError);
expect(() => settings.searchValueOf({
default: "wikipedia",
engines: {
"google": "https://google.com/search?q={}",
"yahoo": "https://search.yahoo.com/search?p={}",
}
})).to.throw(TypeError);
expect(() => settings.searchValueOf({
default: "g o o g l e",
engines: {
"g o o g l e": "https://google.com/search?q={}",
}
})).to.throw(TypeError);
expect(() => settings.searchValueOf({
default: "google",
engines: {
"google": "https://google.com/search",
}
})).to.throw(TypeError);
expect(() => settings.searchValueOf({
default: "google",
engines: {
"google": "https://google.com/search?q={}&r={}",
}
})).to.throw(TypeError);
});
});
describe('#propertiesValueOf', () => {
it('returns with default properties by empty settings', () => {
let props = settings.propertiesValueOf({});
expect(props).to.deep.equal({
hintchars: "abcdefghijklmnopqrstuvwxyz",
smoothscroll: false,
complete: "sbh"
})
});
it('returns properties by valid settings', () => {
let props = settings.propertiesValueOf({
hintchars: "abcdefgh",
smoothscroll: false,
complete: "sbh"
});
expect(props).to.deep.equal({
hintchars: "abcdefgh",
smoothscroll: false,
complete: "sbh"
});
});
it('throws a TypeError by invalid settings', () => {
expect(() => settings.keymapsValueOf(null)).to.throw(TypeError);
expect(() => settings.keymapsValueOf({
smoothscroll: 'false',
})).to.throw(TypeError);
expect(() => settings.keymapsValueOf({
unknown: 'xyz'
})).to.throw(TypeError);
});
});
describe('#blacklistValueOf', () => {
it('returns empty array by empty settings', () => {
let blacklist = settings.blacklistValueOf([]);
expect(blacklist).to.be.empty;
});
it('returns blacklist by valid settings', () => {
let blacklist = settings.blacklistValueOf([
"github.com",
"circleci.com",
]);
expect(blacklist).to.deep.equal([
"github.com",
"circleci.com",
]);
});
it('throws a TypeError by invalid settings', () => {
expect(() => settings.blacklistValueOf(null)).to.throw(TypeError);
expect(() => settings.blacklistValueOf({})).to.throw(TypeError);
expect(() => settings.blacklistValueOf([1,2,3])).to.throw(TypeError);
});
});
describe('#valueOf', () => {
it('returns settings by valid settings', () => {
let x = settings.valueOf({
keymaps: {},
"search": {
"default": "google",
"engines": {
"google": "https://google.com/search?q={}",
}
},
"properties": {},
"blacklist": []
});
expect(x).to.deep.equal({
keymaps: {},
search: {
default: "google",
engines: {
google: "https://google.com/search?q={}",
}
},
properties: {
hintchars: "abcdefghijklmnopqrstuvwxyz",
smoothscroll: false,
complete: "sbh"
},
blacklist: []
});
});
it('sets default settings', () => {
let value = settings.valueOf({});
expect(value.keymaps).to.not.be.empty;
expect(value.properties).to.not.be.empty;
expect(value.search.default).to.be.a('string');
expect(value.search.engines).to.be.an('object');
expect(value.blacklist).to.be.empty;
});
});
});

@ -0,0 +1,18 @@
import * as settings from 'shared/settings';
describe('properties', () => {
describe('Def class', () => {
it('returns property definitions', () => {
let def = new proerties.Def(
'smoothscroll',
'smooth scroll',
false);
expect(def.name).to.equal('smoothscroll');
expect(def.describe).to.equal('smooth scroll');
expect(def.defaultValue).to.equal(false);
expect(def.type).to.equal('boolean');
});
});
});

@ -0,0 +1,18 @@
import * as settings from 'shared/settings';
describe('properties', () => {
describe('Def class', () => {
it('returns property definitions', () => {
let def = new proerties.Def(
'smoothscroll',
'smooth scroll',
false);
expect(def.name).to.equal('smoothscroll');
expect(def.describe).to.equal('smooth scroll');
expect(def.defaultValue).to.equal(false);
expect(def.type).to.equal('boolean');
});
});
});

@ -1,81 +0,0 @@
import { validate } from 'shared/settings/validator';
describe("setting validator", () => {
describe("unknown top keys", () => {
it('throws an error for unknown settings', () => {
let settings = { keymaps: {}, poison: 123 };
let fn = validate.bind(undefined, settings)
expect(fn).to.throw(Error, 'poison');
})
});
describe("keymaps settings", () => {
it('throws an error for unknown operation', () => {
let settings = {
keymaps: {
a: { 'type': 'scroll.home' },
b: { 'type': 'poison.dressing' },
}
};
let fn = validate.bind(undefined, settings)
expect(fn).to.throw(Error, 'poison.dressing');
});
});
describe("search settings", () => {
it('throws an error for invalid search engine name', () => {
let settings = {
search: {
default: 'google',
engines: {
'google': 'https://google.com/search?q={}',
'cherry pie': 'https://cherypie.com/search?q={}',
}
}
};
let fn = validate.bind(undefined, settings)
expect(fn).to.throw(Error, 'cherry pie');
});
it('throws an error for no {}-placeholder', () => {
let settings = {
search: {
default: 'google',
engines: {
'google': 'https://google.com/search?q={}',
'yahoo': 'https://search.yahoo.com/search',
}
}
};
let fn = validate.bind(undefined, settings)
expect(fn).to.throw(Error, 'yahoo');
});
it('throws an error for no default engines', () => {
let settings = {
search: {
engines: {
'google': 'https://google.com/search?q={}',
'yahoo': 'https://search.yahoo.com/search?q={}',
}
}
};
let fn = validate.bind(undefined, settings)
expect(fn).to.throw(Error, 'Default engine');
});
it('throws an error for invalid default engine', () => {
let settings = {
search: {
default: 'twitter',
engines: {
'google': 'https://google.com/search?q={}',
'yahoo': 'https://search.yahoo.com/search?q={}',
}
}
};
let fn = validate.bind(undefined, settings)
expect(fn).to.throw(Error, 'twitter');
});
});
});

@ -1,138 +0,0 @@
import * as values from 'shared/settings/values';
describe("settings values", () => {
describe('valueFromJson', () => {
it('return object from json string', () => {
let json = `{
"keymaps": { "0": {"type": "scroll.home"}},
"search": { "default": "google", "engines": { "google": "https://google.com/search?q={}" }},
"blacklist": [ "*.slack.com"],
"properties": {
"mystr": "value",
"mynum": 123,
"mybool": true
}
}`;
let value = values.valueFromJson(json);
expect(value.keymaps).to.deep.equal({ 0: {type: "scroll.home"}});
expect(value.search).to.deep.equal({ default: "google", engines: { google: "https://google.com/search?q={}"} });
expect(value.blacklist).to.deep.equal(["*.slack.com"]);
expect(value.properties).to.have.property('mystr', 'value');
expect(value.properties).to.have.property('mynum', 123);
expect(value.properties).to.have.property('mybool', true);
});
});
describe('valueFromForm', () => {
it('returns value from form', () => {
let form = {
keymaps: {
'scroll.vertically?{"count":1}': 'j',
'scroll.home': '0',
},
search: {
default: 'google',
engines: [['google', 'https://google.com/search?q={}']],
},
blacklist: ['*.slack.com'],
"properties": {
"mystr": "value",
"mynum": 123,
"mybool": true,
}
};
let value = values.valueFromForm(form);
expect(value.keymaps).to.have.deep.property('j', { type: "scroll.vertically", count: 1 });
expect(value.keymaps).to.have.deep.property('0', { type: "scroll.home" });
expect(JSON.stringify(value.search)).to.deep.equal(JSON.stringify({ default: "google", engines: { google: "https://google.com/search?q={}"} }));
expect(value.search).to.deep.equal({ default: "google", engines: { google: "https://google.com/search?q={}"} });
expect(value.blacklist).to.deep.equal(["*.slack.com"]);
expect(value.properties).to.have.property('mystr', 'value');
expect(value.properties).to.have.property('mynum', 123);
expect(value.properties).to.have.property('mybool', true);
});
it('convert from empty form', () => {
let form = {};
let value = values.valueFromForm(form);
expect(value).to.not.have.key('keymaps');
expect(value).to.not.have.key('search');
expect(value).to.not.have.key('blacklist');
expect(value).to.not.have.key('properties');
});
it('override keymaps', () => {
let form = {
keymaps: {
'scroll.vertically?{"count":1}': 'j',
'scroll.vertically?{"count":-1}': 'j',
}
};
let value = values.valueFromForm(form);
expect(value.keymaps).to.have.key('j');
});
it('override search engine', () => {
let form = {
search: {
default: 'google',
engines: [
['google', 'https://google.com/search?q={}'],
['google', 'https://google.co.jp/search?q={}'],
]
}
};
let value = values.valueFromForm(form);
expect(value.search.engines).to.have.property('google', 'https://google.co.jp/search?q={}');
});
});
describe('jsonFromValue', () => {
});
describe('formFromValue', () => {
it('convert empty value to form', () => {
let value = {};
let form = values.formFromValue(value);
expect(value).to.not.have.key('keymaps');
expect(value).to.not.have.key('search');
expect(value).to.not.have.key('blacklist');
});
it('convert value to form', () => {
let value = {
keymaps: {
j: { type: 'scroll.vertically', count: 1 },
JJ: { type: 'scroll.vertically', count: 100 },
0: { type: 'scroll.home' },
},
search: { default: 'google', engines: { google: 'https://google.com/search?q={}' }},
blacklist: [ '*.slack.com'],
properties: {
"mystr": "value",
"mynum": 123,
"mybool": true,
}
};
let allowed = ['scroll.vertically?{"count":1}', 'scroll.home' ];
let form = values.formFromValue(value, allowed);
expect(form.keymaps).to.have.property('scroll.vertically?{"count":1}', 'j');
expect(form.keymaps).to.not.have.property('scroll.vertically?{"count":100}');
expect(form.keymaps).to.have.property('scroll.home', '0');
expect(Object.keys(form.keymaps)).to.have.lengthOf(2);
expect(form.search).to.have.property('default', 'google');
expect(form.search).to.have.deep.property('engines', [['google', 'https://google.com/search?q={}']]);
expect(form.blacklist).to.have.lengthOf(1);
expect(form.blacklist).to.include('*.slack.com');
expect(form.properties).to.have.property('mystr', 'value');
expect(form.properties).to.have.property('mynum', 123);
expect(form.properties).to.have.property('mybool', true);
});
});
});