Make Properties class

src/shared/SettingData.ts

@@ -2,6 +2,7 @@ import * as operations from './operations';
 import Settings, * as settings from './Settings';
 import Keymaps from './settings/Keymaps';
 import Search from './settings/Search';
+import Properties from './settings/Properties';
 
 export class FormKeymaps {
   private data: {[op: string]: string};
@@ -143,14 +144,14 @@ export class FormSettings {
 
   private search: FormSearch;
 
-  private properties: settings.Properties;
+  private properties: Properties;
 
   private blacklist: string[];
 
   constructor(
     keymaps: FormKeymaps,
     search: FormSearch,
-    properties: settings.Properties,
+    properties: Properties,
     blacklist: string[],
   ) {
     this.keymaps = keymaps;
@@ -177,7 +178,7 @@ export class FormSettings {
     );
   }
 
-  buildWithProperties(props: settings.Properties): FormSettings {
+  buildWithProperties(props: Properties): FormSettings {
     return new FormSettings(
       this.keymaps,
       this.search,
@@ -199,7 +200,7 @@ export class FormSettings {
     return settings.valueOf({
       keymaps: this.keymaps.toKeymaps().toJSON(),
       search: this.search.toSearchSettings().toJSON(),
-      properties: this.properties,
+      properties: this.properties.toJSON(),
       blacklist: this.blacklist,
     });
   }
@@ -207,13 +208,13 @@ export class FormSettings {
   toJSON(): {
     keymaps: ReturnType<FormKeymaps['toJSON']>;
     search: ReturnType<FormSearch['toJSON']>;
-    properties: settings.Properties;
+    properties: ReturnType<Properties['toJSON']>;
     blacklist: string[];
     } {
     return {
       keymaps: this.keymaps.toJSON(),
       search: this.search.toJSON(),
-      properties: this.properties,
+      properties: this.properties.toJSON(),
       blacklist: this.blacklist,
     };
   }
@@ -227,7 +228,7 @@ export class FormSettings {
     return new FormSettings(
       FormKeymaps.valueOf(o.keymaps),
       FormSearch.valueOf(o.search),
-      settings.propertiesValueOf(o.properties),
+      Properties.fromJSON(o.properties),
       settings.blacklistValueOf(o.blacklist),
     );
   }

src/shared/Settings.ts

@@ -1,12 +1,6 @@
-import * as PropertyDefs from './property-defs';
 import Keymaps from './settings/Keymaps';
 import Search from './settings/Search';
-
-export interface Properties {
-  hintchars: string;
-  smoothscroll: boolean;
-  complete: string;
-}
+import Properties from './settings/Properties';
 
 export default interface Settings {
   keymaps: Keymaps;
@@ -15,27 +9,6 @@ export default interface Settings {
   blacklist: string[];
 }
 
-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 {
-    ...PropertyDefs.defaultValues,
-    ...o,
-  };
-};
-
 export const blacklistValueOf = (o: any): string[] => {
   if (!Array.isArray(o)) {
     throw new TypeError(`"blacklist" is not an array of string`);
@@ -59,7 +32,7 @@ export const valueOf = (o: any): Settings => {
       settings.search = Search.fromJSON(o.search);
       break;
     case 'properties':
-      settings.properties = propertiesValueOf(o.properties);
+      settings.properties = Properties.fromJSON(o.properties);
       break;
     case 'blacklist':
       settings.blacklist = blacklistValueOf(o.blacklist);
@@ -75,7 +48,7 @@ export const toJSON = (settings: Settings): any => {
   return {
     keymaps: settings.keymaps.toJSON(),
     search: settings.search.toJSON(),
-    properties: settings.properties,
+    properties: settings.properties.toJSON(),
     blacklist: settings.blacklist,
   };
 };
@@ -156,10 +129,10 @@ export const DefaultSetting: Settings = {
       'wikipedia': 'https://en.wikipedia.org/w/index.php?search={}'
     }
   }),
-  properties: {
+  properties: Properties.fromJSON({
     hintchars: 'abcdefghijklmnopqrstuvwxyz',
     smoothscroll: false,
     complete: 'sbh'
-  },
+  }),
   blacklist: []
 };

src/shared/properties.ts

@@ -1,50 +0,0 @@
-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'),
-];

src/shared/property-defs.ts

@@ -1,56 +0,0 @@
-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'),
-];
-
-export const defaultValues = {
-  hintchars: 'abcdefghijklmnopqrstuvwxyz',
-  smoothscroll: false,
-  complete: 'sbh',
-};

src/shared/settings/Properties.ts

@@ -0,0 +1,110 @@
+export type PropertiesJSON = {
+  hintchars?: string;
+  smoothscroll?: boolean;
+  complete?: string;
+};
+
+export type PropertyTypes = {
+  hintchars: string;
+  smoothscroll: string;
+  complete: string;
+};
+
+type PropertyName = 'hintchars' | 'smoothscroll' | 'complete';
+
+type PropertyDef = {
+  name: PropertyName;
+  description: string;
+  defaultValue: string | number | boolean;
+  type: 'string' | 'number' | 'boolean';
+};
+
+const defs: PropertyDef[] = [
+  {
+    name: 'hintchars',
+    description: 'hint characters on follow mode',
+    defaultValue: 'abcdefghijklmnopqrstuvwxyz',
+    type: 'string',
+  }, {
+    name: 'smoothscroll',
+    description: 'smooth scroll',
+    defaultValue: false,
+    type: 'boolean',
+  }, {
+    name: 'complete',
+    description: 'which are completed at the open page',
+    defaultValue: 'sbh',
+    type: 'string',
+  }
+];
+
+const defaultValues = {
+  hintchars: 'abcdefghijklmnopqrstuvwxyz',
+  smoothscroll: false,
+  complete: 'sbh',
+};
+
+export default class Properties {
+  public hintchars: string;
+
+  public smoothscroll: boolean;
+
+  public complete: string;
+
+  constructor({
+    hintchars,
+    smoothscroll,
+    complete,
+  }: {
+    hintchars?: string;
+    smoothscroll?: boolean;
+    complete?: string;
+  }) {
+    this.hintchars = hintchars || defaultValues.hintchars;
+    this.smoothscroll = smoothscroll || defaultValues.smoothscroll;
+    this.complete = complete || defaultValues.complete;
+  }
+
+  static fromJSON(json: any): Properties {
+    let defNames: Set<string> = new Set(defs.map(def => def.name));
+    let unknownName = Object.keys(json).find(name => !defNames.has(name));
+    if (unknownName) {
+      throw new TypeError(`Unknown property name: "${unknownName}"`);
+    }
+
+    for (let def of defs) {
+      if (!Object.prototype.hasOwnProperty.call(json, def.name)) {
+        continue;
+      }
+      if (typeof json[def.name] !== def.type) {
+        throw new TypeError(
+          `property "${def.name}" is not ${def.type}`);
+      }
+    }
+    return new Properties(json);
+  }
+
+  static types(): PropertyTypes {
+    return {
+      hintchars: 'string',
+      smoothscroll: 'boolean',
+      complete: 'string',
+    };
+  }
+
+  static def(name: string): PropertyDef | undefined {
+    return defs.find(p => p.name === name);
+  }
+
+  static defs(): PropertyDef[] {
+    return defs;
+  }
+
+  toJSON(): PropertiesJSON {
+    return {
+      hintchars: this.hintchars,
+      smoothscroll: this.smoothscroll,
+      complete: this.complete,
+    };
+  }
+}