@rhtml/schematics 0.0.132 → 0.0.134

package/collection.json

@@ -20,6 +20,11 @@
       "factory": "./dist/lib/service/service.factory#main",
       "description": "Create a @rhtml service.",
       "schema": "./dist/lib/service/schema.json"
+    },
+    "controller": {
+      "factory": "./dist/lib/controller/controller.factory#main",
+      "description": "Create a @rhtml controller.",
+      "schema": "./dist/lib/controller/schema.json"
     }
   }
-}
+}

package/dist/lib/component/schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/schema",
-  "id": "SchematicsRHTMLComponent",
+  "$id": "SchematicsRHTMLComponent",
   "title": "@rhtml Component Options Schema",
   "type": "object",
   "properties": {

package/dist/lib/controller/controller.factory.d.ts

@@ -0,0 +1,3 @@
+import { Rule } from '@angular-devkit/schematics';
+import { ControllerOptions } from './controller.schema';
+export declare function main(options: ControllerOptions): Rule;

package/dist/lib/controller/controller.factory.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.main = void 0;
+const core_1 = require("@angular-devkit/core");
+const schematics_1 = require("@angular-devkit/schematics");
+const module_declarator_1 = require("../../utils/module.declarator");
+const module_finder_1 = require("../../utils/module.finder");
+const name_parser_1 = require("../../utils/name.parser");
+const source_root_helpers_1 = require("../../utils/source-root.helpers");
+const defaults_1 = require("../defaults");
+const ELEMENT_METADATA = 'bootstrap';
+const ELEMENT_TYPE = 'controller';
+function main(options) {
+    options = transform(options);
+    return (tree, context) => {
+        return (0, schematics_1.branchAndMerge)((0, schematics_1.chain)([
+            (0, source_root_helpers_1.mergeSourceRoot)(options),
+            (0, schematics_1.mergeWith)(generate(options)),
+            addDeclarationToModule(options),
+        ]))(tree, context);
+    };
+}
+exports.main = main;
+function transform(source) {
+    const target = Object.assign({}, source);
+    target.metadata = ELEMENT_METADATA;
+    target.type = ELEMENT_TYPE;
+    const location = new name_parser_1.NameParser().parse(target);
+    target.name = core_1.strings.dasherize(location.name);
+    target.path = core_1.strings.dasherize(location.path);
+    target.language =
+        target.language !== undefined ? target.language : defaults_1.DEFAULT_LANGUAGE;
+    target.path = target.flat
+        ? target.path
+        : (0, core_1.join)(target.path, target.name);
+    return target;
+}
+function generate(options) {
+    return (context) => (0, schematics_1.apply)((0, schematics_1.url)((0, core_1.join)('./files', options.language)), [
+        options.spec ? (0, schematics_1.noop)() : (0, schematics_1.filter)((path) => !path.endsWith('.spec.ts')),
+        (0, schematics_1.template)(Object.assign(Object.assign({}, core_1.strings), options)),
+        (0, schematics_1.move)(options.path),
+    ])(context);
+}
+function addDeclarationToModule(options) {
+    return (tree) => {
+        if (options.skipImport !== undefined && options.skipImport) {
+            return tree;
+        }
+        options.module = new module_finder_1.ModuleFinder(tree).find({
+            name: options.name,
+            path: options.path,
+        });
+        if (!options.module) {
+            return tree;
+        }
+        const content = tree.read(options.module).toString();
+        const declarator = new module_declarator_1.ModuleDeclarator();
+        tree.overwrite(options.module, declarator.declare(content, options));
+        return tree;
+    };
+}

package/dist/lib/controller/controller.factory.ts

@@ -0,0 +1,92 @@
+import { join, Path, strings } from '@angular-devkit/core';
+import {
+  apply,
+  branchAndMerge,
+  chain,
+  filter,
+  mergeWith,
+  move,
+  noop,
+  Rule,
+  SchematicContext,
+  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 { DEFAULT_LANGUAGE } from '../defaults';
+import { ControllerOptions } from './controller.schema';
+
+const ELEMENT_METADATA = 'bootstrap';
+const ELEMENT_TYPE = 'controller';
+
+export function main(options: ControllerOptions): Rule {
+  options = transform(options);
+  return (tree: Tree, context: SchematicContext) => {
+    return branchAndMerge(
+      chain([
+        mergeSourceRoot(options),
+        mergeWith(generate(options)),
+        addDeclarationToModule(options),
+      ])
+    )(tree, context);
+  };
+}
+
+function transform(source: ControllerOptions): ControllerOptions {
+  const target: ControllerOptions = Object.assign({}, source);
+  target.metadata = ELEMENT_METADATA;
+  target.type = ELEMENT_TYPE;
+
+  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 : DEFAULT_LANGUAGE;
+
+  target.path = target.flat
+    ? target.path
+    : join(target.path as Path, target.name);
+  return target;
+}
+
+function generate(options: ControllerOptions) {
+  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: ControllerOptions): 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/dist/lib/controller/files/ts/__name__.controller.spec.ts

@@ -0,0 +1,33 @@
+import { Bootstrap, get, Module } from '@rhtml/di'
+import { FastifyModule } from '@rhtml/fastify'
+import fastify from 'fastify'
+
+import { <%= classify(name) %>Controller } from './<%= name %>.controller';
+
+describe('<%= classify(name) %> Controller', () => {
+  let <%= decamelize(name) %>Controller: <%= classify(name) %>Controller
+
+  beforeAll(async () => {
+    @Module({
+      imports: [
+        FastifyModule.forRoot(fastify, {
+          logger: true,
+        }),
+      ],
+      bootstrap: [<%= classify(name) %>Controller],
+    })
+    class AppModule {}
+
+    await Bootstrap(AppModule)
+    <%= decamelize(name) %>Controller = get(<%= classify(name) %>Controller)
+
+  });
+
+  it('e2e: get => (<%= classify(name) %>) : Should sucessfully return expected result', async () => {
+    const response = {
+        hello: 'world',
+      }
+      const result = await <%= decamelize(name) %>Controller.get<%= classify(name) %>()
+      expect(result).toEqual(response)
+  });
+});

package/dist/lib/controller/files/ts/__name__.controller.ts

@@ -0,0 +1,16 @@
+import { Controller, Route } from '@rhtml/fastify'
+
+@Controller({
+  route: '/<%= decamelize(name) %>',
+})
+export class <%= classify(name) %>Controller {
+
+    @Route({
+      method: 'GET',
+    })
+    get<%= classify(name) %>() {
+      return {
+        hello: 'world'
+      }
+    }
+}

package/dist/lib/controller/schema.json

@@ -0,0 +1,49 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "$id": "SchematicsRHTMLController",
+  "title": "RHTML Controller Options Schema",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "description": "The name of the controller.",
+      "$default": {
+        "$source": "argv",
+        "index": 0
+      },
+      "x-prompt": "What name would you like to use for the controller?"
+    },
+    "path": {
+      "type": "string",
+      "format": "path",
+      "description": "The path to create the controller."
+    },
+    "language": {
+      "type": "string",
+      "description": "RHTML controller language (ts/js)."
+    },
+    "sourceRoot": {
+      "type": "string",
+      "description": "RHTML controller source root directory."
+    },
+    "skipImport": {
+      "description": "Flag to skip the module import.",
+      "default": false
+    },
+    "module": {
+      "type": "string",
+      "description": "Allows specification of the declaring module."
+    },
+    "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/dist/lib/module/schema.json

@@ -1,7 +1,7 @@
 {
   "$schema": "http://json-schema.org/schema",
-  "id": "SchematicsNestModule",
-  "title": "Nest Module Options Schema",
+  "$id": "SchematicsRhtmlModule",
+  "title": "Rhtml Module Options Schema",
   "type": "object",
   "properties": {
     "name": {
@@ -25,11 +25,11 @@
     },
     "language": {
       "type": "string",
-      "description": "Nest module language (ts/js)."
+      "description": "Rhtml module language (ts/js)."
     },
     "sourceRoot": {
       "type": "string",
-      "description": "Nest module source root directory."
+      "description": "Rhtml module source root directory."
     },
     "skipImport": {
       "description": "Flag to skip the module import.",

package/dist/lib/provider/schema.json

@@ -1,7 +1,7 @@
 {
   "$schema": "http://json-schema.org/schema",
-  "id": "SchematicsNestProvider",
-  "title": "Nest Provider Options Schema",
+  "$id": "SchematicsRhtmlProvider",
+  "title": "Rhtml Provider Options Schema",
   "type": "object",
   "properties": {
     "name": {
@@ -20,11 +20,11 @@
     },
     "language": {
       "type": "string",
-      "description": "Nest provider language (ts/js)."
+      "description": "Rhtml provider language (ts/js)."
     },
     "sourceRoot": {
       "type": "string",
-      "description": "Nest provider source root directory."
+      "description": "Rhtml provider source root directory."
     },
     "flat": {
       "default": true,

package/dist/lib/service/schema.json

@@ -1,7 +1,7 @@
 {
   "$schema": "http://json-schema.org/schema",
-  "id": "SchematicsNestService",
-  "title": "Nest Service Options Schema",
+  "$id": "SchematicsRhtmlService",
+  "title": "Rhtml Service Options Schema",
   "type": "object",
   "properties": {
     "name": {
@@ -20,7 +20,7 @@
     },
     "language": {
       "type": "string",
-      "description": "Nest service language (ts/js)."
+      "description": "Rhtml service language (ts/js)."
     },
     "sourceRoot": {
       "type": "string",

package/dist/lib/service/service.factory.js

@@ -3,7 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.main = void 0;
 const core_1 = require("@angular-devkit/core");
 const schematics_1 = require("@angular-devkit/schematics");
-const util_1 = require("util");
 const module_declarator_1 = require("../../utils/module.declarator");
 const module_finder_1 = require("../../utils/module.finder");
 const name_parser_1 = require("../../utils/name.parser");
@@ -30,7 +29,7 @@ function transform(source) {
     const target = Object.assign({}, source);
     target.metadata = 'providers';
     target.type = 'service';
-    if ((0, util_1.isNullOrUndefined)(target.name)) {
+    if (!target.name) {
         throw new schematics_1.SchematicsException('Option (name) is required.');
     }
     const location = new name_parser_1.NameParser().parse(target);

package/dist/lib/service/service.factory.ts

@@ -14,7 +14,6 @@ import {
   Tree,
   url,
 } from '@angular-devkit/schematics';
-import { isNullOrUndefined } from 'util';
 
 import {
   DeclarationOptions,
@@ -52,7 +51,7 @@ function transform(source: ServiceOptions): ServiceOptions {
   target.metadata = 'providers';
   target.type = 'service';
 
-  if (isNullOrUndefined(target.name)) {
+  if (!target.name) {
     throw new SchematicsException('Option (name) is required.');
   }
   const location: Location = new NameParser().parse(target);

package/dist/utils/metadata.manager.d.ts

@@ -1,13 +1,76 @@
 import { DeclarationOptions } from './module.declarator';
+/**
+ * The `MetadataManager` class provides utilities for managing metadata entries
+ * within a `@Module` decorator in a TypeScript source file. It allows for the
+ * insertion of new metadata entries, merging symbols with static options, and
+ * handling various scenarios such as empty module decorators or existing metadata
+ * properties.
+ */
 export declare class MetadataManager {
     private content;
     constructor(content: string);
-    insert(metadata: string, symbol: string, staticOptions?: DeclarationOptions['staticOptions']): string;
-    private getDecoratorMetadata;
+    /**
+     * Inserts a new metadata entry into the `@Module` decorator.
+     *
+     * @param metadata - The metadata key to insert.
+     * @param symbol - The symbol to insert.
+     * @param staticOptions - The static options to insert.
+     * @returns The new content string.
+     */
+    insert(metadata: string, symbol: string, staticOptions?: DeclarationOptions['staticOptions']): string | undefined;
+    /**
+     * Finds the first `@Module` decorator metadata in the source file.
+     *
+     * @param source - The source file to search.
+     * @param identifier - The identifier to match.
+     * @returns The first matching `ObjectLiteralExpression` or undefined.
+     */
+    private findFirstDecoratorMetadata;
+    /**
+     * Returns an array of all nodes in the source file.
+     */
     private getSourceNodes;
+    /**
+     * Inserts a new metadata entry into an empty `@Module` decorator.
+     * This method is called when the `@Module` decorator has no properties.
+     * It inserts the metadata and symbol into the decorator.
+     * @param expr - The `@Module` decorator node.
+     * @param metadata - The metadata key to insert.
+     * @param symbol - The symbol to insert.
+     * @returns The new content string.
+     */
     private insertMetadataToEmptyModuleDecorator;
+    /**
+     * Inserts a new symbol into an existing metadata property in the `@Module` decorator.
+     * This method is called when the metadata property already exists in the decorator.
+     * It inserts the symbol into the existing metadata property.
+     * @param source - The source file.
+     * @param matchingProperties - The matching metadata properties.
+     * @param symbol - The symbol to insert.
+     * @param staticOptions - The static options to insert.
+     * @returns The new content string.
+     */
     private insertNewMetadataToDecorator;
+    /**
+     * Inserts a new symbol into an existing metadata property in the `@Module` decorator.
+     * This method is called when the metadata property already exists in the decorator.
+     * It inserts the symbol into the existing metadata property.
+     * @param source - The source file.
+     * @param matchingProperties - The matching metadata properties.
+     * @param symbol - The symbol to insert.
+     * @param staticOptions - The static options to insert.
+     * @returns The new content string.
+     */
     private insertSymbolToMetadata;
+    /**
+     * Merges a symbol with static options into a single string.
+     * @param symbol - The symbol to merge.
+     * @param staticOptions - The static options to merge.
+     * @returns The merged string.
+     */
     private mergeSymbolAndExpr;
+    /**
+     * Adds blank lines around an expression.
+     */
     private addBlankLines;
 }