generator-jhipster 7.1.0 → 7.4.0

package/generators/spring-boot/config.cjs

@@ -0,0 +1,30 @@
+/**
+ * Copyright 2013-2021 the original author or authors from the JHipster project.
+ *
+ * This file is part of the JHipster project, see https://www.jhipster.tech/
+ * for more information.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+const { SPRING_BOOT_PARENT_BOM, SPRING_BOOT_PARENT_BOM_DEFAULT_VALUE } = require('./constants.cjs');
+
+/** Config required at .yo-rc.json */
+const requiredConfig = {};
+
+/** Default config for templates */
+const defaultConfig = {
+  ...requiredConfig,
+  [SPRING_BOOT_PARENT_BOM]: SPRING_BOOT_PARENT_BOM_DEFAULT_VALUE,
+};
+
+module.exports = { requiredConfig, defaultConfig };

package/generators/spring-boot/constants.cjs

@@ -0,0 +1,28 @@
+/**
+ * Copyright 2013-2021 the original author or authors from the JHipster project.
+ *
+ * This file is part of the JHipster project, see https://www.jhipster.tech/
+ * for more information.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+const { SPRING_BOOT_VERSION } = require('../generator-constants');
+
+const SPRING_BOOT_PARENT_BOM = 'springBootParentBom';
+const SPRING_BOOT_PARENT_BOM_DEFAULT_VALUE = true;
+
+module.exports = {
+  SPRING_BOOT_VERSION,
+  SPRING_BOOT_PARENT_BOM,
+  SPRING_BOOT_PARENT_BOM_DEFAULT_VALUE,
+};

package/generators/spring-boot/files.cjs

@@ -0,0 +1,46 @@
+/**
+ * Copyright 2013-2021 the original author or authors from the JHipster project.
+ *
+ * This file is part of the JHipster project, see https://www.jhipster.tech/
+ * for more information.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+const { JAVA_SOURCE_DIR, JAVA_RESOURCE_DIR, JAVA_TEST_DIR } = require('../java/constants.cjs');
+
+module.exports.files = {
+  springBootProject: [
+    {
+      templates: ['pom.xml.jhi.spring-boot', 'build.gradle.jhi.spring-boot'],
+    },
+    {
+      path: JAVA_RESOURCE_DIR,
+      templates: ['application.properties.jhi'],
+    },
+    {
+      path: JAVA_SOURCE_DIR,
+      templates: [
+        { file: 'package/Application.java.jhi', renameTo: generator => `${generator.packageFolder}/${generator.javaMainClass}.java.jhi` },
+      ],
+    },
+    {
+      path: JAVA_TEST_DIR,
+      templates: [
+        {
+          file: 'package/ApplicationTests.java.jhi',
+          renameTo: generator => `${generator.packageFolder}/${generator.javaMainClass}Tests.java.jhi`,
+        },
+      ],
+    },
+  ],
+};

package/generators/spring-boot/generator.spec.cjs

@@ -0,0 +1,64 @@
+/**
+ * Copyright 2013-2021 the original author or authors from the JHipster project.
+ *
+ * This file is part of the JHipster project, see https://www.jhipster.tech/
+ * for more information.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+const expect = require('expect');
+const path = require('path');
+
+const { skipPrettierHelpers: helpers } = require('../../test/utils/utils');
+
+const { basicTests, testBlueprintSupport } = require('../../test/support/index.cjs');
+const { requiredConfig, defaultConfig } = require('./config.cjs');
+const { GENERATOR_SPRING_BOOT } = require('../generator-list');
+
+const generatorPath = path.join(__dirname, 'index.cjs');
+const generator = path.basename(__dirname);
+
+describe(`JHipster ${generator} generator`, () => {
+  it('generator-list constant matches folder name', () => {
+    expect(GENERATOR_SPRING_BOOT).toBe(generator);
+  });
+  basicTests({
+    requiredConfig,
+    defaultConfig,
+    customPrompts: {},
+    generatorPath,
+  });
+  describe('blueprint support', () => testBlueprintSupport(generator));
+  describe('with', () => {
+    describe('default config', () => {
+      let runResult;
+      before(async () => {
+        runResult = await helpers.run(generatorPath);
+      });
+      it('should write java files and match snapshot', () => {
+        expect(runResult.getStateSnapshot()).toMatchSnapshot();
+      });
+    });
+  });
+  describe('with add option and', () => {
+    describe('default config', () => {
+      let runResult;
+      before(async () => {
+        runResult = await helpers.run(generatorPath).withOptions({ add: true });
+      });
+      it('should write only spring-boot files and match snapshot', () => {
+        expect(runResult.getStateSnapshot()).toMatchSnapshot();
+      });
+    });
+  });
+});

package/generators/spring-boot/index.cjs

@@ -0,0 +1,162 @@
+/**
+ * Copyright 2013-2021 the original author or authors from the JHipster project.
+ *
+ * This file is part of the JHipster project, see https://www.jhipster.tech/
+ * for more information.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/* eslint-disable consistent-return */
+const chalk = require('chalk');
+const { generateMixedChain } = require('../../lib/support/mixin.cjs');
+const {
+  INITIALIZING_PRIORITY,
+  CONFIGURING_PRIORITY,
+  COMPOSING_PRIORITY,
+  LOADING_PRIORITY,
+  PREPARING_PRIORITY,
+  WRITING_PRIORITY,
+} = require('../../lib/constants/priorities.cjs');
+
+const { GENERATOR_SPRING_BOOT } = require('../generator-list');
+const { files } = require('./files.cjs');
+const { dependencyChain } = require('./mixin.cjs');
+
+const MixedChain = generateMixedChain(GENERATOR_SPRING_BOOT);
+
+module.exports = class extends MixedChain {
+  constructor(args, options, features) {
+    super(args, options, { jhipsterModular: true, unique: 'namespace', ...features });
+
+    // Register options available to cli.
+    if (!this.fromBlueprint) {
+      this.registerCommonOptions();
+      this.registerChainOptions();
+    }
+
+    if (this.options.help) return;
+
+    // Application context for templates
+    this.application = {};
+
+    if (this.options.defaults) {
+      this.configureChain();
+    }
+  }
+
+  async _beforeQueue() {
+    if (!this.fromBlueprint) {
+      const configure = this.options.configure || !this.shouldComposeModular();
+      for (const generator of dependencyChain) {
+        await this.dependsOnJHipster(generator, [], { configure });
+      }
+      await this.composeWithBlueprints(GENERATOR_SPRING_BOOT);
+    }
+  }
+
+  get initializing() {
+    return {
+      validateFromCli() {
+        this.checkInvocationFromCLI();
+      },
+      sayHello() {
+        if (!this.showHello()) return;
+        this.log(chalk.white('⬢ Welcome to the JHipster Spring Boot ⬢'));
+      },
+      loadRuntimeOptions() {
+        this.loadRuntimeOptions();
+      },
+      loadOptionsConstants() {
+        this.loadChainOptionsConstants();
+      },
+    };
+  }
+
+  get [INITIALIZING_PRIORITY]() {
+    if (this.delegateToBlueprint) return;
+    return this.initializing;
+  }
+
+  get configuring() {
+    return {
+      configure() {
+        this.configureSpringBoot();
+      },
+    };
+  }
+
+  get [CONFIGURING_PRIORITY]() {
+    if (this.delegateToBlueprint) return;
+    return this.configuring;
+  }
+
+  get composing() {
+    return {
+      async compose() {
+        if (!this.shouldComposeModular()) return;
+        await this.composeWithSpringBootConfig();
+      },
+    };
+  }
+
+  get [COMPOSING_PRIORITY]() {
+    if (this.delegateToBlueprint) return;
+    return this.composing;
+  }
+
+  get loading() {
+    return {
+      configureChain() {
+        this.configureChain();
+      },
+      loadConstants() {
+        this.loadChainConstants(this.application);
+      },
+      loadConfig() {
+        this.loadChainConfig(this.application);
+      },
+    };
+  }
+
+  get [LOADING_PRIORITY]() {
+    if (this.delegateToBlueprint) return;
+    return this.loading;
+  }
+
+  get preparing() {
+    return {
+      prepareDerivedProperties() {
+        this.prepareChainDerivedProperties(this.application);
+      },
+    };
+  }
+
+  get [PREPARING_PRIORITY]() {
+    if (this.delegateToBlueprint) return;
+    return this.preparing;
+  }
+
+  get writing() {
+    return {
+      async writeFiles() {
+        if (this.shouldSkipFiles()) return;
+        await this.writeFiles({ sections: files, context: this.application });
+      },
+    };
+  }
+
+  get [WRITING_PRIORITY]() {
+    if (this.delegateToBlueprint) return;
+    return this.writing;
+  }
+};

package/generators/spring-boot/mixin.cjs

@@ -0,0 +1,82 @@
+/**
+ * Copyright 2013-2021 the original author or authors from the JHipster project.
+ *
+ * This file is part of the JHipster project, see https://www.jhipster.tech/
+ * for more information.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+const { defaults } = require('lodash');
+
+const { requiredConfig, defaultConfig } = require('./config.cjs');
+const { options } = require('./options.cjs');
+const { SPRING_BOOT_VERSION, SPRING_BOOT_PARENT_BOM } = require('./constants.cjs');
+
+const { GENERATOR_JAVA } = require('../generator-list');
+
+module.exports.dependencyChain = [GENERATOR_JAVA];
+
+module.exports.mixin = parent =>
+  class extends parent {
+    /**
+     * Load spring-boot options constants.
+     */
+    loadSpringBootOptionsConstants(into = this) {}
+
+    /**
+     * Register and parse spring-boot options.
+     */
+    getSpringBootOptions() {
+      return options;
+    }
+
+    /**
+     * Load required spring-boot configs into config.
+     */
+    configureSpringBoot() {
+      this.config.defaults(requiredConfig);
+    }
+
+    /**
+     * Load spring-boot configs into into.
+     * all variables should be set to into,
+     * all variables should be referred from config,
+     * @param {any} config - config to load config from
+     * @param {any} into - destination context to use default is context
+     */
+    loadSpringBootConfig(into = this, config = this.jhipsterConfig) {
+      config = defaults({}, config, defaultConfig);
+      into[SPRING_BOOT_PARENT_BOM] = config[SPRING_BOOT_PARENT_BOM];
+    }
+
+    /**
+     * Prepare derived spring-boot properties into fromInto.
+     * @param {any} fromInto - source/destination context
+     */
+    prepareSpringBootDerivedProperties(fromInto = this) {}
+
+    /**
+     * Load spring-boot constants into 'into'.
+     * @param {Object} into - destination context
+     */
+    loadSpringBootConstants(into = this) {
+      into.SPRING_BOOT_VERSION = SPRING_BOOT_VERSION;
+    }
+
+    /**
+     * Compose with selected spring-boot configuration.
+     */
+    async composeWithSpringBootConfig(config = this.jhipsterConfig) {
+      config = defaults({}, config, defaultConfig);
+    }
+  };

package/generators/spring-boot/options.cjs

@@ -0,0 +1,19 @@
+/**
+ * Copyright 2013-2021 the original author or authors from the JHipster project.
+ *
+ * This file is part of the JHipster project, see https://www.jhipster.tech/
+ * for more information.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+module.exports.options = {};

package/generators/spring-boot/templates/build.gradle.jhi.spring-boot.ejs

@@ -0,0 +1,29 @@
+<%#
+ Copyright 2013-2021 the original author or authors from the JHipster project.
+
+ This file is part of the JHipster project, see https://www.jhipster.tech/
+ for more information.
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+      https://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-%>
+<&_ if (fragment.pluginsSection) { -&>
+  id 'org.springframework.boot' version '<%= SPRING_BOOT_VERSION %>'
+  id 'io.spring.dependency-management' version '1.0.11.RELEASE'
+<&_ } -&>
+<&_ if (fragment.dependenciesSection) { -&>
+  implementation 'org.springframework.boot:spring-boot-starter'
+  testImplementation 'org.springframework.boot:spring-boot-starter-test'
+<&_ } -&>
+<&_ if (fragment.testSection) { -&>
+  useJUnitPlatform()
+<&_ } -&>

package/generators/spring-boot/templates/pom.xml.jhi.spring-boot.ejs

@@ -0,0 +1,45 @@
+<%#
+ Copyright 2013-2021 the original author or authors from the JHipster project.
+
+ This file is part of the JHipster project, see https://www.jhipster.tech/
+ for more information.
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+      https://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-%>
+<%_ if (springBootParentBom) { -%>
+<&_ if (fragment.parentSection) { -&>
+    <parent>
+        <groupId>org.springframework.boot</groupId>
+        <artifactId>spring-boot-starter-parent</artifactId>
+        <version><%= SPRING_BOOT_VERSION %></version>
+        <relativePath/> <!-- lookup parent from repository -->
+    </parent>
+<&_ } -&>
+<%_ } -%>
+<&_ if (fragment.dependenciesSection) { -&>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-test</artifactId>
+            <scope>test</scope>
+        </dependency>
+<&_ } -&>
+<&_ if (fragment.buildPluginsSection) { -&>
+            <plugin>
+                <groupId>org.springframework.boot</groupId>
+                <artifactId>spring-boot-maven-plugin</artifactId>
+            </plugin>
+<&_ } -&>

package/generators/spring-boot/templates/src/main/java/package/Application.java.jhi.ejs

@@ -0,0 +1,31 @@
+<%#
+ Copyright 2013-2021 the original author or authors from the JHipster project.
+
+ This file is part of the JHipster project, see https://www.jhipster.tech/
+ for more information.
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+      https://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-%>
+package <%= packageName %>;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+@SpringBootApplication
+public class <%= javaMainClass %> {
+
+	public static void main(String[] args) {
+		SpringApplication.run(<%= javaMainClass %>.class, args);
+	}
+
+}

package/generators/spring-boot/templates/src/main/resources/application.properties.jhi.ejs

@@ -0,0 +1,19 @@
+<%#
+ Copyright 2013-2021 the original author or authors from the JHipster project.
+
+ This file is part of the JHipster project, see https://www.jhipster.tech/
+ for more information.
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+      https://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-%>
+<&- fragments.render({ join: '\n\n' }) &>

package/generators/spring-boot/templates/src/test/java/package/ApplicationTests.java.jhi.ejs

@@ -0,0 +1,31 @@
+<%#
+ Copyright 2013-2021 the original author or authors from the JHipster project.
+
+ This file is part of the JHipster project, see https://www.jhipster.tech/
+ for more information.
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+      https://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-%>
+package <%= packageName %>;
+
+import org.junit.jupiter.api.Test;
+import org.springframework.boot.test.context.SpringBootTest;
+
+@SpringBootTest
+class <%= javaMainClass %>Tests {
+
+  @Test
+  void contextLoads() {
+  }
+
+}

package/generators/spring-controller/esm.mjs

@@ -0,0 +1,21 @@
+/**
+ * Copyright 2013-2021 the original author or authors from the JHipster project.
+ *
+ * This file is part of the JHipster project, see https://www.jhipster.tech/
+ * for more information.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import generator from './index.js';
+
+export default generator;

package/generators/spring-controller/generator.spec.mjs

@@ -0,0 +1,47 @@
+/**
+ * Copyright 2013-2021 the original author or authors from the JHipster project.
+ *
+ * This file is part of the JHipster project, see https://www.jhipster.tech/
+ * for more information.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import expect from 'expect';
+import lodash from 'lodash';
+import { basename, dirname } from 'path';
+import { fileURLToPath } from 'url';
+
+import testSupport from '../../test/support/index.cjs';
+import Generator from './index.js';
+
+const { snakeCase } = lodash;
+const { testBlueprintSupport } = testSupport;
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+const generator = basename(__dirname);
+
+describe(`JHipster ${generator} generator`, () => {
+  it('generator-list constant matches folder name', async () => {
+    await expect((await import('../generator-list.js')).default[`GENERATOR_${snakeCase(generator).toUpperCase()}`]).toBe(generator);
+  });
+  it('should be exported at package.json', async () => {
+    await expect((await import(`generator-jhipster/esm/generators/${generator}`)).default).toBe(Generator);
+  });
+  it('should support features parameter', () => {
+    const instance = new Generator([], { help: true }, { bar: true });
+    expect(instance.features.bar).toBe(true);
+  });
+  describe.skip('blueprint support', () => testBlueprintSupport(generator));
+});