feat: add machine factory

closes #10

Author: antongolub

package.json

@@ -25,7 +25,8 @@
     "coveralls_push": "cat ./coverage/lcov.info | coveralls",
     "docs": "typedoc src/main --ignoreCompilerErrors || exit 0",
     "tsfix": "replace-in-file --configFile=./src/libdef/ts/replace.js",
-    "flowfix": "replace-in-file --configFile=./src/libdef/flow/replace.js"
+    "flowfix": "replace-in-file --configFile=./src/libdef/flow/replace.js && yarn flowfix_import",
+    "flowfix_import": "node -r esm src/libdef/flow/import.js"
   },
   "files": [
     "README.md",
@@ -59,8 +60,10 @@
     "coveralls": "^3.0.2",
     "dts-generator": "^3.0.0",
     "eslint-plugin-typescript": "^0.14.0",
+    "esm": "^3.1.1",
     "flowgen": "^1.3.0",
     "jest": "^23.6.0",
+    "lodash": "^4.17.11",
     "semantic-release": "^15.13.3",
     "ts-jest": "^23.10.5",
     "tslib": "^1.9.3",

src/libdef/flow/append.js

@@ -1,9 +1,11 @@
 declare module "@qiwi/cyclone/lib/es5/index" {
   declare export * from '@qiwi/cyclone/lib/es5/machine';
   declare export * from '@qiwi/cyclone/lib/es5/error';
+  declare export * from '@qiwi/cyclone/lib/es5/factory';
 }
 
 declare module "@qiwi/cyclone" {
   declare export * from '@qiwi/cyclone/lib/es5/machine';
   declare export * from '@qiwi/cyclone/lib/es5/error';
+  declare export * from '@qiwi/cyclone/lib/es5/factory';
 }

src/libdef/flow/import.js

@@ -0,0 +1,58 @@
+// NOTE flowgen completely ignores module imports
+// So we need this dirty hack
+
+import {readFileSync, writeFileSync} from 'fs'
+import {resolve} from 'path'
+import {each} from 'lodash'
+
+const DTS = resolve(__dirname, '../../../typings/index.d.ts')
+const FLOW = resolve(__dirname, '../../../typings/index.flow.js')
+
+const dts = readFileSync(DTS, 'utf-8')
+const flow = readFileSync(FLOW, 'utf-8')
+let out = flow
+
+const tree = dts
+  .split('declare module')
+  .reduce((m, v, k) => {
+    if (v) {
+      const [first, ...lines] = v.split('\n')
+      const name = first.replace(/[^@a-z\d\-\/]/g, '')
+      const imports = lines
+        .filter(line => /^\timport/.test(line))
+        .map(v => {
+          const [full, rawdeps, name] = /^\timport { (.+) } from \'(.+)\';$/.exec(v)
+          const deps = rawdeps.split(', ')
+
+          const types = deps.filter(d => /^I[A-Z].+/.test(d))
+          const vars = deps.filter(d => !types.includes(d))
+
+          return {
+            types,
+            vars,
+            deps,
+            name
+          }
+        })
+      const exports = lines.filter(line => /^\texport/.test(line))
+
+      m[name] = {
+        imports,
+        exports
+      }
+    }
+
+    return m
+  }, {})
+
+each(tree, ({imports}, name) => {
+  if (imports && imports.length) {
+    each(imports, ({deps, name: from}) => {
+      out = out.replace(`declare module "${name}" {`, `declare module "${name}" {
+  import type { ${deps.join(', ')} } from "${from}"
+`)
+    })
+  }
+})
+
+writeFileSync(FLOW, out, 'utf-8')

src/libdef/flow/replace.js

@@ -1,5 +1,5 @@
 module.exports = {
-  files: 'typings/**/*.js',
+  files: 'typings/*.js',
   from: [
     'this',
     'mixins IMachine ',

src/libdef/ts/append.js

@@ -1,4 +1,5 @@
 declare module "@qiwi/cyclone" {
   export * from '@qiwi/cyclone/lib/es5/error';
   export * from '@qiwi/cyclone/lib/es5/machine';
+  export * from '@qiwi/cyclone/lib/es5/factory';
 }

src/main/factory.ts

@@ -0,0 +1,43 @@
+import {
+  Machine,
+  IMachine,
+  IMachineOpts,
+  DEFAULT_OPTS as DEFAULT_MACHINE_OPTS
+} from './machine'
+
+import {
+  Registry
+} from './registry'
+
+export const DEFAULT_TEMPLATE = {}
+export const DEFAULT_TEMPLATE_REGISTRY = new Registry()
+export const DEFAULT_MACHINE_REGISTRY = new Registry()
+
+type IFactoryOpts = {
+  machine?: IMachineOpts,
+  template?: string | Object,
+  templateRegistry?: Registry,
+  machineRegistry?: Registry
+}
+
+export const factory = (opts: IFactoryOpts): IMachine => {
+  // NOTE flowgen throws error on typed args destruction
+  const { machine, template, templateRegistry = DEFAULT_TEMPLATE_REGISTRY, machineRegistry = DEFAULT_MACHINE_REGISTRY } = opts
+  const _template = getTemplate(template, templateRegistry)
+  const machineOpts: IMachineOpts = { ...DEFAULT_MACHINE_OPTS, ..._template, ...machine }
+  const instance = new Machine(machineOpts)
+
+  machineRegistry.add(Math.random() + '', instance)
+
+  return instance
+}
+
+export const getTemplate = (template: string | Object | void, templateRegistry: Registry): any => {
+  return typeof template === 'string'
+    ? templateRegistry.get(template)
+    : template
+}
+
+export {
+  IFactoryOpts
+}

src/main/index.ts

@@ -1,2 +1,3 @@
 export * from './error'
 export * from './machine'
+export * from './factory'

src/main/registry.ts

@@ -0,0 +1,19 @@
+export class Registry {
+  store: { [key: string]: any }
+
+  constructor () {
+    this.store = {}
+  }
+
+  get (key: string): void {
+    return this.store[key]
+  }
+
+  add (key: string, value: any): void {
+    this.store[key] = value
+  }
+
+  remove (key: string): void {
+    delete this.store[key]
+  }
+}

src/test/factory.ts

@@ -0,0 +1,58 @@
+import { Registry } from '../main/registry'
+import { Machine } from '../main/machine'
+import {
+  factory,
+  getTemplate,
+  DEFAULT_TEMPLATE,
+  DEFAULT_MACHINE_REGISTRY,
+  DEFAULT_TEMPLATE_REGISTRY
+} from '../main/factory'
+
+describe('factory', () => {
+  it('exposes defaults', () => {
+    expect(DEFAULT_TEMPLATE_REGISTRY).toBeInstanceOf(Registry)
+    expect(DEFAULT_MACHINE_REGISTRY).toBeInstanceOf(Registry)
+    expect(DEFAULT_TEMPLATE).not.toBeUndefined()
+  })
+
+  describe('produces a Machine instance', () => {
+    DEFAULT_TEMPLATE_REGISTRY.add('foo', {
+      transitions: {
+        handle: true
+      }
+    })
+
+    const templateRegistry = new Registry()
+    const machineRegistry = new Registry()
+    const machine1 = factory({
+      machine: { transitions: {} },
+      template: 'foo'
+    })
+    const machine2 = factory({
+      machine: { transitions: {} },
+      templateRegistry,
+      machineRegistry
+    })
+
+    expect(machine1).toBeInstanceOf(Machine)
+    expect(machine2).toBeInstanceOf(Machine)
+    expect(Object.keys(machineRegistry.store).length).toBe(1)
+    expect(Object.keys(DEFAULT_MACHINE_REGISTRY.store).length).toBe(1)
+  })
+})
+
+describe('getTemplate', () => {
+  const tpl = {}
+  const registry = new Registry()
+  registry.add('foo', tpl)
+
+  it('returns template literal if passed', () => {
+    const tpl = {}
+    expect(getTemplate(tpl, registry)).toBe(tpl)
+  })
+
+  it('searches template by name', () => {
+    expect(getTemplate('foo', registry)).toBe(tpl)
+    expect(getTemplate('bar', registry)).toBeUndefined()
+  })
+})

src/test/index.ts

@@ -1,5 +1,6 @@
 import {
   Machine,
+  factory,
   DEFAULT_HANDLER,
   DELIMITER,
   DEFAULT_OPTS
@@ -8,6 +9,7 @@ import {
 describe('index', () => {
   it('properly exposes default and inners', () => {
     expect(Machine).toEqual(expect.any(Function))
+    expect(factory).toEqual(expect.any(Function))
     expect(DEFAULT_HANDLER).toEqual(expect.any(Function))
     expect(DEFAULT_OPTS).not.toBeUndefined()
     expect(DELIMITER).not.toBeUndefined()

src/test/registry.ts

@@ -0,0 +1,41 @@
+import { Registry } from '../main/registry'
+
+describe('Registry', () => {
+  describe('constructor', () => {
+    it('returns proper instance', () => {
+      const registry = new Registry()
+
+      expect(registry).toBeInstanceOf(Registry)
+      expect(registry.store).toEqual({})
+    })
+  })
+
+  describe('proto', () => {
+    const registry = new Registry()
+
+    describe('#add', () => {
+      it('saves value', () => {
+        registry.add('foo', 'bar')
+        expect(registry.store.foo).toBe('bar')
+      })
+    })
+
+    describe('#get', () => {
+      it('gets value by key', () => {
+        expect(registry.get('foo')).toBe('bar')
+      })
+
+      it('returns undefined if not found', () => {
+        expect(registry.get('qux')).toBeUndefined()
+      })
+    })
+
+    describe('#remove', () => {
+      it('drops value', () => {
+        expect(registry.store.foo).toBe('bar')
+        registry.remove('foo')
+        expect(registry.get('foo')).toBeUndefined()
+      })
+    })
+  })
+})

yarn.lock

@@ -1443,7 +1443,7 @@ debug@^4.0.0:
   dependencies:
     ms "^2.1.1"
 
-debuglog@*, debuglog@^1.0.1:
+debuglog@^1.0.1:
   version "1.0.1"
   resolved "https://registry.yarnpkg.com/debuglog/-/debuglog-1.0.1.tgz#aa24ffb9ac3df9a2351837cfb2d279360cd78492"
   integrity sha1-qiT/uaw9+aI1GDfPstJ5NgzXhJI=
@@ -1764,6 +1764,11 @@ eslint-visitor-keys@^1.0.0:
   resolved "https://registry.yarnpkg.com/eslint-visitor-keys/-/eslint-visitor-keys-1.0.0.tgz#3f3180fb2e291017716acb4c9d6d5b5c34a6a81d"
   integrity sha512-qzm/XxIbxm/FHyH341ZrbnMUpe+5Bocte9xkmFMzPMjRaZMcXww+MpBptFvtU+79L362nqiLhekCxCxDPaUMBQ==
 
+esm@^3.1.1:
+  version "3.1.1"
+  resolved "https://registry.yarnpkg.com/esm/-/esm-3.1.1.tgz#810d1144522547801a58a8ea01d6566d61578223"
+  integrity sha512-Md2pR4IbR37UqubbgbA4+wiBorOEFB05Oo+g4WJW7W2ajiOhUfjZt77NzzCoQdrCb40GdKcflitm+XHDF053OQ==
+
 esprima@^3.1.3:
   version "3.1.3"
   resolved "https://registry.yarnpkg.com/esprima/-/esprima-3.1.3.tgz#fdca51cee6133895e3c88d535ce49dbff62a4633"
@@ -2574,7 +2579,7 @@ import-local@^1.0.0:
     pkg-dir "^2.0.0"
     resolve-cwd "^2.0.0"
 
-imurmurhash@*, imurmurhash@^0.1.4:
+imurmurhash@^0.1.4:
   version "0.1.4"
   resolved "https://registry.yarnpkg.com/imurmurhash/-/imurmurhash-0.1.4.tgz#9218b9b2b928a238b13dc4fb6b6d576f231453ea"
   integrity sha1-khi5srkoojixPcT7a21XbyMUU+o=
@@ -3687,11 +3692,6 @@ lockfile@^1.0.4:
   dependencies:
     signal-exit "^3.0.2"
 
-lodash._baseindexof@*:
-  version "3.1.0"
-  resolved "https://registry.yarnpkg.com/lodash._baseindexof/-/lodash._baseindexof-3.1.0.tgz#fe52b53a1c6761e42618d654e4a25789ed61822c"
-  integrity sha1-/lK1OhxnYeQmGNZU5KJXie1hgiw=
-
 lodash._baseuniq@~4.6.0:
   version "4.6.0"
   resolved "https://registry.yarnpkg.com/lodash._baseuniq/-/lodash._baseuniq-4.6.0.tgz#0ebb44e456814af7905c6212fa2c9b2d51b841e8"
@@ -3700,33 +3700,11 @@ lodash._baseuniq@~4.6.0:
     lodash._createset "~4.0.0"
     lodash._root "~3.0.0"
 
-lodash._bindcallback@*:
-  version "3.0.1"
-  resolved "https://registry.yarnpkg.com/lodash._bindcallback/-/lodash._bindcallback-3.0.1.tgz#e531c27644cf8b57a99e17ed95b35c748789392e"
-  integrity sha1-5THCdkTPi1epnhftlbNcdIeJOS4=
-
-lodash._cacheindexof@*:
-  version "3.0.2"
-  resolved "https://registry.yarnpkg.com/lodash._cacheindexof/-/lodash._cacheindexof-3.0.2.tgz#3dc69ac82498d2ee5e3ce56091bafd2adc7bde92"
-  integrity sha1-PcaayCSY0u5ePOVgkbr9Ktx73pI=
-
-lodash._createcache@*:
-  version "3.1.2"
-  resolved "https://registry.yarnpkg.com/lodash._createcache/-/lodash._createcache-3.1.2.tgz#56d6a064017625e79ebca6b8018e17440bdcf093"
-  integrity sha1-VtagZAF2JeeevKa4AY4XRAvc8JM=
-  dependencies:
-    lodash._getnative "^3.0.0"
-
 lodash._createset@~4.0.0:
   version "4.0.3"
   resolved "https://registry.yarnpkg.com/lodash._createset/-/lodash._createset-4.0.3.tgz#0f4659fbb09d75194fa9e2b88a6644d363c9fe26"
   integrity sha1-D0ZZ+7CddRlPqeK4imZE02PJ/iY=
 
-lodash._getnative@*, lodash._getnative@^3.0.0:
-  version "3.9.1"
-  resolved "https://registry.yarnpkg.com/lodash._getnative/-/lodash._getnative-3.9.1.tgz#570bc7dede46d61cdcde687d65d3eecbaa3aaff5"
-  integrity sha1-VwvH3t5G1hzc3mh9ZdPuy6o6r/U=
-
 lodash._root@~3.0.0:
   version "3.0.1"
   resolved "https://registry.yarnpkg.com/lodash._root/-/lodash._root-3.0.1.tgz#fba1c4524c19ee9a5f8136b4609f017cf4ded692"
@@ -3767,11 +3745,6 @@ lodash.pick@^4.4.0:
   resolved "https://registry.yarnpkg.com/lodash.pick/-/lodash.pick-4.4.0.tgz#52f05610fff9ded422611441ed1fc123a03001b3"
   integrity sha1-UvBWEP/53tQiYRRB7R/BI6AwAbM=
 
-lodash.restparam@*:
-  version "3.6.1"
-  resolved "https://registry.yarnpkg.com/lodash.restparam/-/lodash.restparam-3.6.1.tgz#936a4e309ef330a7645ed4145986c85ae5b20805"
-  integrity sha1-k2pOMJ7zMKdkXtQUWYbIWuWyCAU=
-
 lodash.set@^4.3.2:
   version "4.3.2"
   resolved "https://registry.yarnpkg.com/lodash.set/-/lodash.set-4.3.2.tgz#d8757b1da807dde24816b0d6a84bea1a76230b23"
@@ -3812,7 +3785,7 @@ lodash.without@~4.4.0:
   resolved "https://registry.yarnpkg.com/lodash.without/-/lodash.without-4.4.0.tgz#3cd4574a00b67bae373a94b748772640507b7aac"
   integrity sha1-PNRXSgC2e643OpS3SHcmQFB7eqw=
 
-lodash@^4.13.1, lodash@^4.17.10, lodash@^4.17.4, lodash@^4.2.1:
+lodash@^4.13.1, lodash@^4.17.10, lodash@^4.17.11, lodash@^4.17.4, lodash@^4.2.1:
   version "4.17.11"
   resolved "https://registry.yarnpkg.com/lodash/-/lodash-4.17.11.tgz#b39ea6229ef607ecd89e2c8df12536891cac9b8d"
   integrity sha512-cQKh8igo5QUhZ7lg38DYWAxMvjSAKG0A8wGSVimP07SIUEK2UO+arSRKbRZWtelMtN5V0Hkwh5ryOto/SshYIg==
@@ -5362,7 +5335,7 @@ readable-stream@~1.1.10:
     isarray "0.0.1"
     string_decoder "~0.10.x"
 
-readdir-scoped-modules@*, readdir-scoped-modules@^1.0.0:
+readdir-scoped-modules@^1.0.0:
   version "1.0.2"
   resolved "https://registry.yarnpkg.com/readdir-scoped-modules/-/readdir-scoped-modules-1.0.2.tgz#9fafa37d286be5d92cbaebdee030dc9b5f406747"
   integrity sha1-n6+jfShr5dksuuve4DDcm19AZ0c=