feat(data) create schematics to generate entity data (#2135)

Author: norato

modules/schematics/collection.json

@@ -56,14 +56,20 @@
       "schema": "./src/store/schema.json",
       "description": "Adds initial setup for state management"
     },
-
     "selector": {
       "aliases": ["se"],
       "factory": "./src/selector",
       "schema": "./src/selector/schema.json",
       "description": "Add selectors"
     },
 
+    "data": {
+      "aliases": ["dt"],
+      "factory": "./src/data",
+      "schema": "./src/data/schema.json",
+      "description": "Adds a data entity service"
+    },
+
     "ng-add": {
       "aliases": ["init"],
       "factory": "./src/ng-add",

modules/schematics/src/data/files/__name@dasherize@if-flat__/__name@dasherize__.service.spec.ts.template

@@ -0,0 +1,28 @@
+import { TestBed } from '@angular/core/testing';
+import {
+  EntityCollectionServiceElementsFactory
+} from '@ngrx/data';
+import { <%= classify(name) %>Service } from './<%= dasherize(name) %>.service';
+
+describe('<%= classify(name) %>Service', () => {
+  let service: <%= classify(name) %>Service;
+
+  beforeEach(async () => {
+    await TestBed.configureTestingModule({
+      providers: [
+        EntityCollectionServiceElementsFactory,
+        <%= classify(name) %>Service
+      ]
+    });
+
+    await TestBed.compileComponents();
+  });
+
+  beforeEach(() => {
+    service = TestBed.get(<%= classify(name) %>Service)
+  });
+
+  it('should create an instance', () => {
+    expect(service).toBeTruthy();
+  });
+});

modules/schematics/src/data/files/__name@dasherize@if-flat__/__name@dasherize__.service.ts.template

@@ -0,0 +1,13 @@
+import { Injectable } from '@angular/core';
+import {
+  EntityCollectionServiceBase,
+  EntityCollectionServiceElementsFactory
+} from '@ngrx/data';
+import { <%= classify(name) %> } from './<%= dasherize(name) %>';
+
+@Injectable({ providedIn: 'root' })
+export class <%= classify(name) %>Service extends EntityCollectionServiceBase<<%= classify(name) %>> {
+  constructor(serviceElementsFactory: EntityCollectionServiceElementsFactory) {
+    super('<%= classify(name) %>', serviceElementsFactory);
+  }
+}

modules/schematics/src/data/files/__name@dasherize@if-flat__/__name@dasherize__.ts.template

@@ -0,0 +1,3 @@
+export interface <%= classify(name) %> {
+  id?: any;
+}

modules/schematics/src/data/index.spec.ts

@@ -0,0 +1,121 @@
+import {
+  SchematicTestRunner,
+  UnitTestTree,
+} from '@angular-devkit/schematics/testing';
+import * as path from 'path';
+import { Schema as DataOptions } from './schema';
+import {
+  getTestProjectPath,
+  createWorkspace,
+  defaultWorkspaceOptions,
+  defaultAppOptions,
+} from '../../../schematics-core/testing';
+
+describe('Data Schematic', () => {
+  const schematicRunner = new SchematicTestRunner(
+    '@ngrx/schematics',
+    path.join(__dirname, '../../collection.json')
+  );
+  const defaultOptions: DataOptions = {
+    name: 'foo',
+    project: 'bar',
+    spec: false,
+    group: false,
+    flat: true,
+  };
+
+  const projectPath = getTestProjectPath();
+
+  let appTree: UnitTestTree;
+
+  beforeEach(async () => {
+    appTree = await createWorkspace(schematicRunner, appTree);
+  });
+
+  it('should create the data service to a specified project if provided', () => {
+    const options = { ...defaultOptions, project: 'baz' };
+
+    const specifiedProjectPath = getTestProjectPath(defaultWorkspaceOptions, {
+      ...defaultAppOptions,
+      name: 'baz',
+    });
+
+    const tree = schematicRunner.runSchematic('data', options, appTree);
+    const files = tree.files;
+    expect(
+      files.indexOf(`${specifiedProjectPath}/src/lib/foo.service.ts`)
+    ).toBeGreaterThanOrEqual(0);
+    expect(
+      files.indexOf(`${specifiedProjectPath}/src/lib/foo.ts`)
+    ).toBeGreaterThanOrEqual(0);
+  });
+
+  it('should create the service and model files', () => {
+    const tree = schematicRunner.runSchematic('data', defaultOptions, appTree);
+    expect(
+      tree.files.indexOf(`${projectPath}/src/app/foo.service.ts`)
+    ).toBeGreaterThanOrEqual(0);
+    expect(
+      tree.files.indexOf(`${projectPath}/src/app/foo.ts`)
+    ).toBeGreaterThanOrEqual(0);
+  });
+
+  it('should create two files if spec is true', () => {
+    const options = {
+      ...defaultOptions,
+      spec: true,
+    };
+    const tree = schematicRunner.runSchematic('data', options, appTree);
+    expect(
+      tree.files.indexOf(`${projectPath}/src/app/foo.service.spec.ts`)
+    ).toBeGreaterThanOrEqual(0);
+    expect(
+      tree.files.indexOf(`${projectPath}/src/app/foo.service.ts`)
+    ).toBeGreaterThanOrEqual(0);
+  });
+
+  describe('service class', () => {
+    it('should import the correct model', () => {
+      const options = { ...defaultOptions, spec: true };
+      const tree = schematicRunner.runSchematic('data', options, appTree);
+      const fileContent = tree.readContent(
+        `${projectPath}/src/app/foo.service.ts`
+      );
+
+      expect(fileContent).toMatch(/import { Foo } from '.\/foo';/);
+    });
+
+    it('should extending EntityCollectionServiceBase', () => {
+      const options = { ...defaultOptions, spec: true };
+      const tree = schematicRunner.runSchematic('data', options, appTree);
+      const fileContent = tree.readContent(
+        `${projectPath}/src/app/foo.service.ts`
+      );
+
+      expect(fileContent).toMatch(
+        /export class FooService extends EntityCollectionServiceBase<Foo>/
+      );
+
+      expect(fileContent).toMatch(/super\('Foo', serviceElementsFactory\);/);
+    });
+  });
+
+  it('should create model', () => {
+    const options = { ...defaultOptions, spec: true };
+    const tree = schematicRunner.runSchematic('data', options, appTree);
+    const fileContent = tree.readContent(`${projectPath}/src/app/foo.ts`);
+
+    expect(fileContent).toMatch(/export interface Foo {/);
+    expect(fileContent).toMatch(/id\?: any;/);
+  });
+
+  it('should create spec class with right imports', () => {
+    const options = { ...defaultOptions, spec: true };
+    const tree = schematicRunner.runSchematic('data', options, appTree);
+    const fileContent = tree.readContent(
+      `${projectPath}/src/app/foo.service.spec.ts`
+    );
+
+    expect(fileContent).toMatch(/import { FooService } from '.\/foo.service'/);
+  });
+});

modules/schematics/src/data/index.ts

@@ -0,0 +1,48 @@
+import {
+  apply,
+  applyTemplates,
+  branchAndMerge,
+  chain,
+  filter,
+  mergeWith,
+  move,
+  noop,
+  Rule,
+  SchematicContext,
+  Tree,
+  url,
+} from '@angular-devkit/schematics';
+import {
+  getProjectPath,
+  parseName,
+  stringUtils,
+} from '@ngrx/schematics/schematics-core';
+import { Schema as DataOptions } from './schema';
+
+export default function(options: DataOptions): Rule {
+  return (host: Tree, context: SchematicContext) => {
+    options.path = getProjectPath(host, options);
+
+    const parsedPath = parseName(options.path, options.name);
+    options.name = parsedPath.name;
+    options.path = parsedPath.path;
+
+    const templateSource = apply(url('./files'), [
+      options.spec
+        ? noop()
+        : filter(path => !path.endsWith('.spec.ts.template')),
+      applyTemplates({
+        ...stringUtils,
+        'if-flat': (s: string) =>
+          stringUtils.group(options.flat ? '' : s, options.group ? 'data' : ''),
+        ...options,
+      }),
+      move(parsedPath.path),
+    ]);
+
+    return chain([branchAndMerge(chain([mergeWith(templateSource)]))])(
+      host,
+      context
+    );
+  };
+}

modules/schematics/src/data/schema.json

@@ -0,0 +1,44 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "id": "SchematicsNgRxData",
+  "title": "NgRx Data Options Schema",
+  "type": "object",
+  "properties": {
+    "name": {
+      "description": "The name of the data entity.",
+      "type": "string",
+      "$default": {
+        "$source": "argv",
+        "index": 0
+      }
+    },
+    "path": {
+      "type": "string",
+      "format": "path",
+      "description": "The path to create the service.",
+      "visible": false
+    },
+    "project": {
+      "type": "string",
+      "description": "The name of the project.",
+      "aliases": ["p"]
+    },
+    "spec": {
+      "type": "boolean",
+      "description": "Specifies if a spec file is generated.",
+      "default": false
+    },
+    "flat": {
+      "type": "boolean",
+      "default": true,
+      "description": "Flag to indicate if a dir is created."
+    },
+    "group": {
+      "type": "boolean",
+      "default": false,
+      "description": "Group the services within relative subfolders",
+      "aliases": ["g"]
+    }
+  },
+  "required": []
+}

modules/schematics/src/data/schema.ts

@@ -0,0 +1,32 @@
+export interface Schema {
+  /**
+   * The name of the component.
+   */
+  name: string;
+
+  /**
+   * The path to create the component.
+   */
+  path?: string;
+
+  /**
+   * The name of the project.
+   */
+  project?: string;
+
+  /**
+   * Specifies if a spec file is generated.
+   */
+  spec?: boolean;
+
+  /**
+   * Flag to indicate if a dir is created.
+   */
+
+  flat?: boolean;
+
+  /**
+   * Group entity metadata files within 'data' folder
+   */
+  group?: boolean;
+}

projects/ngrx.io/content/guide/schematics/data.md

@@ -0,0 +1,66 @@
+# Data
+
+---
+
+## Overview
+
+Generates the data entity model and service.
+
+## Command
+
+```sh
+ng generate data EntityName [options]
+```
+
+##### OR
+
+```sh
+ng generate dt EntityName [options]
+```
+
+### Options
+
+Provide the project name where the entity files will be created.
+
+- `--project`
+  - Alias: `-p`
+  - Type: `string`
+
+Nest the data entity files within a folder based on the `data`.
+
+- `--flat`
+  - Type: `boolean`
+  - Default: `true`
+
+Group the data entity files within an `data` folder.
+
+- `--group`
+  - Alias: `-g`
+  - Type: `boolean`
+  - Default: `false`
+
+Generate a spec file alongside the data entity files.
+
+- `--spec`
+  - Type: `boolean`
+  - Default: `false`
+
+#### Examples
+
+Generate a `User` data entity files with an associated spec file.
+
+```sh
+ng generate data User --spec
+```
+
+Generate a `User` data entity files within a nested folder
+
+```sh
+ng generate data User --flat false
+```
+
+Generate a `User` data entity file within a nested `data` folder
+
+```sh
+ng generate data User --group
+```