@gapi/schematics 1.8.122

package/src/lib/filter/filter.schema.d.ts

@@ -0,0 +1,28 @@
+import { Path } from '@angular-devkit/core';
+
+export interface FilterOptions {
+  /**
+   * The name of the filter.
+   */
+  name: string;
+  /**
+   * The path to create the filter.
+   */
+  path?: string | Path;
+  /**
+   * Application language.
+   */
+  language?: string;
+  /**
+   * The source root path
+   */
+  sourceRoot?: string;
+  /**
+   * Specifies if a spec file is generated.
+   */
+  spec?: boolean;
+  /**
+   * Flag to indicate if a directory is created.
+   */
+  flat?: boolean;
+}

package/src/lib/filter/schema.json

@@ -0,0 +1,39 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "id": "SchematicsNestFilter",
+  "title": "Nest Filter Options Schema",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "description": "The name of the filter.",
+      "$default": {
+        "$source": "argv",
+        "index": 0
+      },
+      "x-prompt": "What name would you like to use for the filter?"
+    },
+    "path": {
+      "type": "string",
+      "format": "path",
+      "description": "The path to create the filter."
+    },
+    "language": {
+      "type": "string",
+      "description": "Nest filter language (ts/js)."
+    },
+    "sourceRoot": {
+      "type": "string",
+      "description": "Nest filter source root directory."
+    },
+    "flat": {
+      "default": true,
+      "description": "Flag to indicate if a directory is created."
+    },
+    "spec": {
+      "default": true,
+      "description": "Specifies if a spec file is generated."
+    }
+  },
+  "required": ["name"]
+}

package/src/lib/gateway/files/js/__name__.gateway.js

@@ -0,0 +1,9 @@
+import { SubscribeMessage, WebSocketGateway } from '@nestjs/websockets';
+
+@WebSocketGateway()
+export class <%= classify(name) %>Gateway {
+  @SubscribeMessage('message')
+  handleMessage(client, payload) {
+    return 'Hello world!';
+  }
+}

package/src/lib/gateway/files/js/__name__.gateway.spec.js

@@ -0,0 +1,18 @@
+import { Test } from '@nestjs/testing';
+import { <%= classify(name) %>Gateway } from './<%= name %>.gateway';
+
+describe('<%= classify(name) %>Gateway', () => {
+  let gateway;
+
+  beforeEach(async () => {
+    const module = await Test.createTestingModule({
+      providers: [<%= classify(name) %>Gateway],
+    }).compile();
+
+    gateway = module.get(<%= classify(name) %>Gateway);
+  });
+
+  it('should be defined', () => {
+    expect(gateway).toBeDefined();
+  });
+});

package/src/lib/gateway/files/ts/__name__.gateway.spec.ts

@@ -0,0 +1,18 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import { <%= classify(name) %>Gateway } from './<%= name %>.gateway';
+
+describe('<%= classify(name) %>Gateway', () => {
+  let gateway: <%= classify(name) %>Gateway;
+
+  beforeEach(async () => {
+    const module: TestingModule = await Test.createTestingModule({
+      providers: [<%= classify(name) %>Gateway],
+    }).compile();
+
+    gateway = module.get<<%= classify(name) %>Gateway>(<%= classify(name) %>Gateway);
+  });
+
+  it('should be defined', () => {
+    expect(gateway).toBeDefined();
+  });
+});

package/src/lib/gateway/files/ts/__name__.gateway.ts

@@ -0,0 +1,9 @@
+import { SubscribeMessage, WebSocketGateway } from '@nestjs/websockets';
+
+@WebSocketGateway()
+export class <%= classify(name) %>Gateway {
+  @SubscribeMessage('message')
+  handleMessage(client: any, payload: any): string {
+    return 'Hello world!';
+  }
+}

package/src/lib/gateway/gateway.factory.test.ts

@@ -0,0 +1,147 @@
+import {
+  SchematicTestRunner,
+  UnitTestTree,
+} from '@angular-devkit/schematics/testing';
+import * as path from 'path';
+import { GatewayOptions } from './gateway.schema';
+
+describe('Gateway Factory', () => {
+  const runner: SchematicTestRunner = new SchematicTestRunner(
+    '.',
+    path.join(process.cwd(), 'src/collection.json'),
+  );
+  it('should manage name only', () => {
+    const options: GatewayOptions = {
+      name: 'foo',
+      flat: false,
+    };
+    const tree: UnitTestTree = runner.runSchematic('gateway', options);
+    const files: string[] = tree.files;
+    expect(
+      files.find(filename => filename === '/foo/foo.gateway.ts'),
+    ).not.toBeUndefined();
+    expect(tree.readContent('/foo/foo.gateway.ts')).toEqual(
+      "import { SubscribeMessage, WebSocketGateway } from '@nestjs/websockets';\n" +
+        '\n' +
+        '@WebSocketGateway()\n' +
+        'export class FooGateway {\n' +
+        "  @SubscribeMessage('message')\n" +
+        '  handleMessage(client: any, payload: any): string {\n' +
+        "    return 'Hello world!';\n" +
+        '  }\n' +
+        '}\n',
+    );
+  });
+  it('should manage name as a path', () => {
+    const options: GatewayOptions = {
+      name: 'bar/foo',
+      flat: false,
+    };
+    const tree: UnitTestTree = runner.runSchematic('gateway', options);
+    const files: string[] = tree.files;
+    expect(
+      files.find(filename => filename === '/bar/foo/foo.gateway.ts'),
+    ).not.toBeUndefined();
+    expect(tree.readContent('/bar/foo/foo.gateway.ts')).toEqual(
+      "import { SubscribeMessage, WebSocketGateway } from '@nestjs/websockets';\n" +
+        '\n' +
+        '@WebSocketGateway()\n' +
+        'export class FooGateway {\n' +
+        "  @SubscribeMessage('message')\n" +
+        '  handleMessage(client: any, payload: any): string {\n' +
+        "    return 'Hello world!';\n" +
+        '  }\n' +
+        '}\n',
+    );
+  });
+  it('should manage name and path', () => {
+    const options: GatewayOptions = {
+      name: 'foo',
+      path: 'baz',
+      flat: false,
+    };
+    const tree: UnitTestTree = runner.runSchematic('gateway', options);
+    const files: string[] = tree.files;
+    expect(
+      files.find(filename => filename === '/baz/foo/foo.gateway.ts'),
+    ).not.toBeUndefined();
+    expect(tree.readContent('/baz/foo/foo.gateway.ts')).toEqual(
+      "import { SubscribeMessage, WebSocketGateway } from '@nestjs/websockets';\n" +
+        '\n' +
+        '@WebSocketGateway()\n' +
+        'export class FooGateway {\n' +
+        "  @SubscribeMessage('message')\n" +
+        '  handleMessage(client: any, payload: any): string {\n' +
+        "    return 'Hello world!';\n" +
+        '  }\n' +
+        '}\n',
+    );
+  });
+  it('should manage name to dasherize', () => {
+    const options: GatewayOptions = {
+      name: 'fooBar',
+      flat: false,
+    };
+    const tree: UnitTestTree = runner.runSchematic('gateway', options);
+    const files: string[] = tree.files;
+    expect(
+      files.find(filename => filename === '/foo-bar/foo-bar.gateway.ts'),
+    ).not.toBeUndefined();
+    expect(tree.readContent('/foo-bar/foo-bar.gateway.ts')).toEqual(
+      "import { SubscribeMessage, WebSocketGateway } from '@nestjs/websockets';\n" +
+        '\n' +
+        '@WebSocketGateway()\n' +
+        'export class FooBarGateway {\n' +
+        "  @SubscribeMessage('message')\n" +
+        '  handleMessage(client: any, payload: any): string {\n' +
+        "    return 'Hello world!';\n" +
+        '  }\n' +
+        '}\n',
+    );
+  });
+  it('should manage path to dasherize', () => {
+    const options: GatewayOptions = {
+      name: 'barBaz/foo',
+      flat: false,
+    };
+    const tree: UnitTestTree = runner.runSchematic('gateway', options);
+    const files: string[] = tree.files;
+    expect(
+      files.find(filename => filename === '/bar-baz/foo/foo.gateway.ts'),
+    ).not.toBeUndefined();
+    expect(tree.readContent('/bar-baz/foo/foo.gateway.ts')).toEqual(
+      "import { SubscribeMessage, WebSocketGateway } from '@nestjs/websockets';\n" +
+        '\n' +
+        '@WebSocketGateway()\n' +
+        'export class FooGateway {\n' +
+        "  @SubscribeMessage('message')\n" +
+        '  handleMessage(client: any, payload: any): string {\n' +
+        "    return 'Hello world!';\n" +
+        '  }\n' +
+        '}\n',
+    );
+  });
+  it('should manage javascript file', () => {
+    const options: GatewayOptions = {
+      name: 'foo',
+      language: 'js',
+      flat: false,
+    };
+    const tree: UnitTestTree = runner.runSchematic('gateway', options);
+    const files: string[] = tree.files;
+    expect(
+      files.find(filename => filename === '/foo/foo.gateway.js'),
+    ).not.toBeUndefined();
+    expect(tree.readContent('/foo/foo.gateway.js')).toEqual(
+      "import { SubscribeMessage, WebSocketGateway } from '@nestjs/websockets';\n" +
+        '\n' +
+        '@WebSocketGateway()\n' +
+        'export class FooGateway {\n' +
+        "  @SubscribeMessage('message')\n" +
+        '  handleMessage(client, payload) {\n' +
+        "    return 'Hello world!';\n" +
+        '  }\n' +
+        '}\n',
+    );
+  });
+});

package/src/lib/gateway/gateway.factory.ts

@@ -0,0 +1,92 @@
+import { join, Path, strings } from '@angular-devkit/core';
+import {
+  apply,
+  branchAndMerge,
+  chain,
+  filter,
+  mergeWith,
+  move,
+  noop,
+  Rule,
+  SchematicContext,
+  SchematicsException,
+  Source,
+  template,
+  Tree,
+  url,
+} from '@angular-devkit/schematics';
+import {
+  DeclarationOptions,
+  ModuleDeclarator,
+} from '../../utils/module.declarator';
+import { ModuleFinder } from '../../utils/module.finder';
+import { Location, NameParser } from '../../utils/name.parser';
+import { mergeSourceRoot } from '../../utils/source-root.helpers';
+import { ProviderOptions } from '../provider/provider.schema';
+import { GatewayOptions } from './gateway.schema';
+
+export function main(options: GatewayOptions): Rule {
+  options = transform(options);
+  return (tree: Tree, context: SchematicContext) => {
+    return branchAndMerge(
+      chain([
+        mergeSourceRoot(options),
+        addDeclarationToModule(options),
+        mergeWith(generate(options)),
+      ]),
+    )(tree, context);
+  };
+}
+
+function transform(options: GatewayOptions): GatewayOptions {
+  const target: GatewayOptions = Object.assign({}, options);
+  if (!target.name) {
+    throw new SchematicsException('Option (name) is required.');
+  }
+  target.metadata = 'providers';
+  target.type = 'gateway';
+
+  const location: Location = new NameParser().parse(target);
+  target.name = strings.dasherize(location.name);
+  target.path = strings.dasherize(location.path);
+  target.language = target.language !== undefined ? target.language : 'ts';
+
+  target.path = target.flat
+    ? target.path
+    : join(target.path as Path, target.name);
+  return target;
+}
+
+function generate(options: GatewayOptions): Source {
+  return (context: SchematicContext) =>
+    apply(url(join('./files' as Path, options.language)), [
+      options.spec ? noop() : filter(path => !path.endsWith('.spec.ts')),
+      template({
+        ...strings,
+        ...options,
+      }),
+      move(options.path),
+    ])(context);
+}
+
+function addDeclarationToModule(options: ProviderOptions): Rule {
+  return (tree: Tree) => {
+    if (options.skipImport !== undefined && options.skipImport) {
+      return tree;
+    }
+    options.module = new ModuleFinder(tree).find({
+      name: options.name,
+      path: options.path as Path,
+    });
+    if (!options.module) {
+      return tree;
+    }
+    const content = tree.read(options.module).toString();
+    const declarator: ModuleDeclarator = new ModuleDeclarator();
+    tree.overwrite(
+      options.module,
+      declarator.declare(content, options as DeclarationOptions),
+    );
+    return tree;
+  };
+}

package/src/lib/gateway/gateway.schema.d.ts

@@ -0,0 +1,36 @@
+import { Path } from '@angular-devkit/core';
+
+export interface GatewayOptions {
+  /**
+   * The name of the gateway.
+   */
+  name: string;
+  /**
+   * The path to create the gateway.
+   */
+  path?: string | Path;
+  /**
+   * Application language.
+   */
+  language?: string;
+  /**
+   * The source root path
+   */
+  sourceRoot?: string;
+  /**
+   * Specifies if a spec file is generated.
+   */
+  spec?: boolean;
+  /**
+   * Flag to indicate if a directory is created.
+   */
+  flat?: boolean;
+  /**
+   * Metadata name affected by declaration insertion.
+   */
+  metadata?: string;
+  /**
+   * Nest element type name
+   */
+  type?: string;
+}

package/src/lib/gateway/schema.json

@@ -0,0 +1,39 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "id": "SchematicsNestGateway",
+  "title": "Nest Gateway Options Schema",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "description": "The name of the gateway.",
+      "$default": {
+        "$source": "argv",
+        "index": 0
+      },
+      "x-prompt": "What name would you like to use for the gateway?"
+    },
+    "path": {
+      "type": "string",
+      "format": "path",
+      "description": "The path to create the gateway."
+    },
+    "language": {
+      "type": "string",
+      "description": "Nest gateway language (ts/js)."
+    },
+    "sourceRoot": {
+      "type": "string",
+      "description": "Nest gateway source root directory."
+    },
+    "flat": {
+      "default": true,
+      "description": "Flag to indicate if a directory is created."
+    },
+    "spec": {
+      "default": true,
+      "description": "Specifies if a spec file is generated."
+    }
+  },
+  "required": ["name"]
+}