@gapi/schematics 1.8.122

package/src/lib/effect/effect.factory.ts

@@ -0,0 +1,91 @@
+import { join, Path, strings } from '@angular-devkit/core';
+import {
+  apply,
+  branchAndMerge,
+  chain,
+  filter,
+  mergeWith,
+  move,
+  noop,
+  Rule,
+  SchematicContext,
+  SchematicsException,
+  template,
+  Tree,
+  url,
+} from '@angular-devkit/schematics';
+import { isNullOrUndefined } from 'util';
+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 { ServiceOptions } from './effect.schema';
+
+export function main(options: ServiceOptions): Rule {
+  options = transform(options);
+  return (tree: Tree, context: SchematicContext) => {
+    return branchAndMerge(
+      chain([
+        mergeSourceRoot(options),
+        addDeclarationToModule(options),
+        mergeWith(generate(options)),
+      ]),
+    )(tree, context);
+  };
+}
+
+function transform(source: ServiceOptions): ServiceOptions {
+  const target: ServiceOptions = Object.assign({}, source);
+  target.metadata = 'effects';
+  target.type = 'effect';
+
+  if (isNullOrUndefined(target.name)) {
+    throw new SchematicsException('Option (name) is required.');
+  }
+  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: ServiceOptions) {
+  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: ServiceOptions): 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/effect/effect.schema.d.ts

@@ -0,0 +1,44 @@
+import { Path } from '@angular-devkit/core';
+
+export interface ServiceOptions {
+  /**
+   * The name of the service.
+   */
+  name: string;
+  /**
+   * The path to create the service.
+   */
+  path?: string;
+  /**
+   * The path to insert the service declaration.
+   */
+  module?: Path;
+  /**
+   * Directive to insert declaration in module.
+   */
+  skipImport?: boolean;
+  /**
+   * Metadata name affected by declaration insertion.
+   */
+  metadata?: string;
+  /**
+   * Nest element type name
+   */
+  type?: string;
+  /**
+   * 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/effect/files/js/__name__.effect.js

@@ -0,0 +1,11 @@
+import { Effect, OfType } from '@gapi/core';
+
+@Effect()
+export class <%= classify(name) %>Effect {
+
+    @OfType<any>('<%= classify(name) %>')
+    <%= classify(name) %>Action(result, payload, context) {
+        console.log(result, payload, context);
+    }
+
+}

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

@@ -0,0 +1,17 @@
+import 'jest';
+import { Container, createTestBed } from '@gapi/core';
+import { <%= classify(name) %>Effect } from './<%= name %>.effect';
+
+describe('<%= classify(name) %> Effect', () => {
+  beforeAll(async () => {
+    await createTestBed({
+      imports: [],
+      effects: [<%= classify(name) %>Effect]
+    }).toPromise();
+  });
+
+  it('should be defined', done => {
+    expect(Container.has(<%= classify(name) %>Effect)).toBeTruthy();
+    done();
+  });
+});

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

@@ -0,0 +1,17 @@
+import 'jest';
+import { Container, createTestBed } from '@gapi/core';
+import { <%= classify(name) %>Effect } from './<%= name %>.effect';
+
+describe('<%= classify(name) %> Effect', () => {
+  beforeAll(async () => {
+    await createTestBed({
+      imports: [],
+      effects: [<%= classify(name) %>Effect]
+    }).toPromise();
+  });
+
+  it('should be defined', done => {
+    expect(Container.has(<%= classify(name) %>Effect)).toBeTruthy();
+    done();
+  });
+});

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

@@ -0,0 +1,11 @@
+import { Effect, OfType } from '@gapi/core';
+
+@Effect()
+export class <%= classify(name) %>Effect {
+
+    @OfType<any>('<%= classify(name) %>')
+    <%= classify(name) %>Action(result, payload, context) {
+        console.log(result, payload, context);
+    }
+
+}

package/src/lib/effect/schema.json

@@ -0,0 +1,39 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "id": "SchematicsGapiEffect",
+  "title": "Gapi Effect Options Schema",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "description": "The name of the effect.",
+      "$default": {
+        "$source": "argv",
+        "index": 0
+      },
+      "x-prompt": "What name would you like to use for the effect?"
+    },
+    "path": {
+      "type": "string",
+      "format": "path",
+      "description": "The path to create the effect."
+    },
+    "language": {
+      "type": "string",
+      "description": "Gapi effect language (ts/js)."
+    },
+    "sourceRoot": {
+      "type": "string",
+      "description": "Gapi effect source root directory."
+    },
+    "flat": {
+      "default": false,
+      "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/filter/files/js/__name__.filter.js

@@ -0,0 +1,6 @@
+import { Catch } from '@nestjs/common';
+
+@Catch()
+export class <%= classify(name) %>Filter {
+  catch(exception, host) {}
+}

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

@@ -0,0 +1,7 @@
+import { <%= classify(name) %>Filter } from './<%= name %>.filter';
+
+describe('<%= classify(name) %>Filter', () => {
+  it('should be defined', () => {
+    expect(new <%= classify(name) %>Filter()).toBeDefined();
+  });
+});

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

@@ -0,0 +1,7 @@
+import { <%= classify(name) %>Filter } from './<%= name %>.filter';
+
+describe('<%= classify(name) %>Filter', () => {
+  it('should be defined', () => {
+    expect(new <%= classify(name) %>Filter()).toBeDefined();
+  });
+});

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

@@ -0,0 +1,6 @@
+import { ArgumentsHost, Catch, ExceptionFilter } from '@nestjs/common';
+
+@Catch()
+export class <%= classify(name) %>Filter<T> implements ExceptionFilter {
+  catch(exception: T, host: ArgumentsHost) {}
+}

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

@@ -0,0 +1,147 @@
+import {
+  SchematicTestRunner,
+  UnitTestTree,
+} from '@angular-devkit/schematics/testing';
+import * as path from 'path';
+import { FilterOptions } from './filter.schema';
+
+describe('Filter Factory', () => {
+  const runner: SchematicTestRunner = new SchematicTestRunner(
+    '.',
+    path.join(process.cwd(), 'src/collection.json'),
+  );
+
+  it('should manage name only', () => {
+    const options: FilterOptions = {
+      name: 'foo',
+    };
+    const tree: UnitTestTree = runner.runSchematic('filter', options);
+    const files: string[] = tree.files;
+    expect(files.find(filename => filename === '/foo.filter.ts')).toBeDefined();
+    expect(tree.readContent('/foo.filter.ts')).toEqual(
+      "import { ArgumentsHost, Catch, ExceptionFilter } from '@nestjs/common';\n" +
+        '\n' +
+        '@Catch()\n' +
+        'export class FooFilter<T> implements ExceptionFilter {\n' +
+        '  catch(exception: T, host: ArgumentsHost) {}\n' +
+        '}\n',
+    );
+  });
+
+  it('should manage name has a path', () => {
+    const options: FilterOptions = {
+      name: 'bar/foo',
+    };
+    const tree: UnitTestTree = runner.runSchematic('filter', options);
+    const files: string[] = tree.files;
+    expect(
+      files.find(filename => filename === '/bar/foo.filter.ts'),
+    ).toBeDefined();
+    expect(tree.readContent('/bar/foo.filter.ts')).toEqual(
+      "import { ArgumentsHost, Catch, ExceptionFilter } from '@nestjs/common';\n" +
+        '\n' +
+        '@Catch()\n' +
+        'export class FooFilter<T> implements ExceptionFilter {\n' +
+        '  catch(exception: T, host: ArgumentsHost) {}\n' +
+        '}\n',
+    );
+  });
+
+  it('should manage name and path', () => {
+    const options: FilterOptions = {
+      name: 'foo',
+      path: 'baz',
+    };
+    const tree: UnitTestTree = runner.runSchematic('filter', options);
+    const files: string[] = tree.files;
+    expect(
+      files.find(filename => filename === '/baz/foo.filter.ts'),
+    ).toBeDefined();
+    expect(tree.readContent('/baz/foo.filter.ts')).toEqual(
+      "import { ArgumentsHost, Catch, ExceptionFilter } from '@nestjs/common';\n" +
+        '\n' +
+        '@Catch()\n' +
+        'export class FooFilter<T> implements ExceptionFilter {\n' +
+        '  catch(exception: T, host: ArgumentsHost) {}\n' +
+        '}\n',
+    );
+  });
+
+  it('should manage name to dasherize', () => {
+    const options: FilterOptions = {
+      name: 'fooBar',
+    };
+    const tree: UnitTestTree = runner.runSchematic('filter', options);
+    const files: string[] = tree.files;
+    expect(
+      files.find(filename => filename === '/foo-bar.filter.ts'),
+    ).toBeDefined();
+    expect(tree.readContent('/foo-bar.filter.ts')).toEqual(
+      "import { ArgumentsHost, Catch, ExceptionFilter } from '@nestjs/common';\n" +
+        '\n' +
+        '@Catch()\n' +
+        'export class FooBarFilter<T> implements ExceptionFilter {\n' +
+        '  catch(exception: T, host: ArgumentsHost) {}\n' +
+        '}\n',
+    );
+  });
+
+  it('should manage path to dasherize', () => {
+    const options: FilterOptions = {
+      name: 'barBaz/foo',
+    };
+    const tree: UnitTestTree = runner.runSchematic('filter', options);
+    const files: string[] = tree.files;
+    expect(
+      files.find(filename => filename === '/bar-baz/foo.filter.ts'),
+    ).toBeDefined();
+    expect(tree.readContent('/bar-baz/foo.filter.ts')).toEqual(
+      "import { ArgumentsHost, Catch, ExceptionFilter } from '@nestjs/common';\n" +
+        '\n' +
+        '@Catch()\n' +
+        'export class FooFilter<T> implements ExceptionFilter {\n' +
+        '  catch(exception: T, host: ArgumentsHost) {}\n' +
+        '}\n',
+    );
+  });
+
+  it('should manage javascript file', () => {
+    const options: FilterOptions = {
+      name: 'foo',
+      language: 'js',
+    };
+    const tree: UnitTestTree = runner.runSchematic('filter', options);
+    const files: string[] = tree.files;
+    expect(files.find(filename => filename === '/foo.filter.js')).toBeDefined();
+    expect(tree.readContent('/foo.filter.js')).toEqual(
+      "import { Catch } from '@nestjs/common';\n" +
+        '\n' +
+        '@Catch()\n' +
+        'export class FooFilter {\n' +
+        '  catch(exception, host) {}\n' +
+        '}\n',
+    );
+  });
+
+  it('should add source root to path', () => {
+    const options: FilterOptions = {
+      name: 'foo',
+      language: 'js',
+    };
+    let tree: UnitTestTree = runner.runSchematic('application', { name: '' });
+    tree = runner.runSchematic('filter', options, tree);
+
+    const files: string[] = tree.files;
+    expect(
+      files.find(filename => filename === '/src/foo.filter.js'),
+    ).toBeDefined();
+    expect(tree.readContent('/src/foo.filter.js')).toEqual(
+      "import { Catch } from '@nestjs/common';\n" +
+        '\n' +
+        '@Catch()\n' +
+        'export class FooFilter {\n' +
+        '  catch(exception, host) {}\n' +
+        '}\n',
+    );
+  });
+});

package/src/lib/filter/filter.factory.ts

@@ -0,0 +1,51 @@
+import { join, Path, strings } from '@angular-devkit/core';
+import {
+  apply,
+  chain,
+  filter,
+  mergeWith,
+  move,
+  noop,
+  Rule,
+  SchematicContext,
+  SchematicsException,
+  Source,
+  template,
+  url,
+} from '@angular-devkit/schematics';
+import { Location, NameParser } from '../../utils/name.parser';
+import { mergeSourceRoot } from '../../utils/source-root.helpers';
+import { FilterOptions } from './filter.schema';
+
+export function main(options: FilterOptions): Rule {
+  options = transform(options);
+  return chain([mergeSourceRoot(options), mergeWith(generate(options))]);
+}
+
+function transform(options: FilterOptions): FilterOptions {
+  const target: FilterOptions = Object.assign({}, options);
+  if (!target.name) {
+    throw new SchematicsException('Option (name) is required.');
+  }
+  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: FilterOptions): 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);
+}