Merge pull request #2055 from DamnClin/modules-list

Simple modules screen

src/main/webapp/app/loader/primary/Loader.ts

@@ -0,0 +1,35 @@
+export class Loader<T> {
+  private assignedValue?: T;
+
+  private constructor(private loading: boolean) {}
+
+  public static loading<T>(): Loader<T> {
+    return new Loader(true);
+  }
+
+  public static loaded<T>(value: T): Loader<T> {
+    const result = this.loading<T>();
+
+    result.loaded(value);
+
+    return result;
+  }
+
+  isLoading(): boolean {
+    return this.loading;
+  }
+
+  loaded(value: T) {
+    this.assignedValue = value;
+
+    this.loading = false;
+  }
+
+  value(): T {
+    if (this.assignedValue === undefined) {
+      throw new Error('Trying to get the value of a loading item');
+    }
+
+    return this.assignedValue;
+  }
+}

src/main/webapp/app/main.ts

@@ -24,6 +24,7 @@ import 'bootstrap-icons/font/bootstrap-icons.css';
 import 'bootstrap';
 import '../content/css/custom.css';
 import { MittAlertListener } from '@/common/secondary/alert/MittAlertListener';
+import { RestModulesRepository } from './module/secondary/RestModulesRepository';
 
 const app = createApp(App);
 const pinia = createPinia();
@@ -45,6 +46,7 @@ const reactRepository = new ReactRepository(axiosHttp, projectHistoryRepository)
 const springBootRepository = new SpringBootRepository(axiosHttp, projectHistoryRepository);
 const svelteRepository = new SvelteRepository(axiosHttp, projectHistoryRepository);
 const vueRepository = new VueRepository(axiosHttp, projectHistoryRepository);
+const modulesRepository = new RestModulesRepository(axiosHttp);
 
 app.provide('alertBus', alertBus);
 app.provide('alertListener', alertListener);
@@ -60,6 +62,7 @@ app.provide('reactService', reactRepository);
 app.provide('springBootService', springBootRepository);
 app.provide('vueService', vueRepository);
 app.provide('svelteService', svelteRepository);
+app.provide('modules', modulesRepository);
 app.use(router);
 
 app.mount('#app');

src/main/webapp/app/module/domain/Category.ts

@@ -0,0 +1,8 @@
+import { Module } from './Module';
+
+type CategoryName = string;
+
+export interface Category {
+  name: CategoryName;
+  modules: Module[];
+}

src/main/webapp/app/module/domain/Module.ts

@@ -0,0 +1,8 @@
+import { ModuleSlug } from './ModuleSlug';
+
+type ModuleDescription = string;
+
+export interface Module {
+  slug: ModuleSlug;
+  description: ModuleDescription;
+}

src/main/webapp/app/module/domain/ModuleProperties.ts

@@ -0,0 +1,5 @@
+import { ModuleProperty } from './ModuleProperty';
+
+export interface ModuleProperties {
+  properties: ModuleProperty[];
+}

src/main/webapp/app/module/domain/ModuleProperty.ts

@@ -0,0 +1,12 @@
+export type ModulePropertyType = 'STRING' | 'INTEGER' | 'BOOLEAN';
+export type ModulePropertyKey = string;
+export type ModulePropertyDescription = string;
+export type ModulePropertyExample = string;
+
+export interface ModuleProperty {
+  type: ModulePropertyType;
+  mandatory: boolean;
+  key: ModulePropertyKey;
+  description?: ModulePropertyDescription;
+  example?: ModulePropertyExample;
+}

src/main/webapp/app/module/domain/ModuleSlug.ts

@@ -0,0 +1 @@
+export type ModuleSlug = string;

src/main/webapp/app/module/domain/Modules.ts

@@ -0,0 +1,5 @@
+import { Category } from './Category';
+
+export interface Modules {
+  categories: Category[];
+}

src/main/webapp/app/module/domain/ModulesRepository.ts

@@ -0,0 +1,8 @@
+import { ModuleProperties } from './ModuleProperties';
+import { Modules } from './Modules';
+import { ModuleSlug } from './ModuleSlug';
+
+export interface ModulesRepository {
+  list(): Promise<Modules>;
+  get(slug: ModuleSlug): Promise<ModuleProperties>;
+}

src/main/webapp/app/module/primary/modules-list/ModulesList.component.ts

@@ -0,0 +1,23 @@
+import { Loader } from '@/loader/primary/Loader';
+import { Modules } from '@/module/domain/Modules';
+import { ModulesRepository } from '@/module/domain/ModulesRepository';
+import { defineComponent, inject, onMounted, reactive } from 'vue';
+
+export default defineComponent({
+  name: 'ModulesListVue',
+  setup() {
+    const modules = inject('modules') as ModulesRepository;
+
+    const modulesContent = reactive({
+      content: Loader.loading<Modules>(),
+    });
+
+    onMounted(() => {
+      modules.list().then(response => modulesContent.content.loaded(response));
+    });
+
+    return {
+      content: modulesContent.content,
+    };
+  },
+});

src/main/webapp/app/module/primary/modules-list/ModulesList.html

@@ -0,0 +1,16 @@
+<div class="jhipster-modules-list">
+  <h1 data-selector="modules-title" class="jhister-modules-title">Modules</h1>
+
+  <div data-selector="modules-loader" v-if="content.isLoading()">Loading</div>
+  <div data-selector="modules-list" v-else>
+    <div v-for="category in content.value().categories">
+      <div class="jhipster-module-category">
+        <h2 class="jhipster-module-category--name">{{ category.name }}</h2>
+        <div v-for="module in category.modules" class="jhipster-module" :data-selector="`${module.slug}-module`">
+          <div class="jhipster-module--slug">{{ module.slug }}</div>
+          <div class="jhipster-module--description">{{ module.description}}</div>
+        </div>
+      </div>
+    </div>
+  </div>
+</div>

src/main/webapp/app/module/primary/modules-list/ModulesList.vue

@@ -0,0 +1,50 @@
+<template src="./ModulesList.html"></template>
+
+<script lang="ts" src="./ModulesList.component.ts"></script>
+
+<style>
+* {
+  color: #29293b;
+}
+
+.jhipster-modules-list {
+  max-width: 1200px;
+  margin: auto;
+}
+
+.jhister-modules-title {
+  font-size: 2em;
+}
+
+.jhipster-module {
+  border-radius: 2em;
+  border: 1px solid #29293b;
+  margin: 1em 0;
+  display: grid;
+  grid-template-columns: 25% auto;
+  grid-gap: 10px;
+  grid-auto-rows: minmax(2em, auto);
+  align-items: center;
+}
+
+.jhipster-module--slug {
+  grid-column: 1 / 2;
+  grid-row: 1;
+  border-radius: 2em;
+  padding: 0.5em 1.5em;
+  margin-right: 0.5em;
+  background-color: #29293b;
+  color: #fff;
+  font-weight: bold;
+  text-align: center;
+}
+
+.jhipster-module--description {
+  grid-column: 2 / 2;
+  grid-row: 1;
+}
+
+.jhipster-module-category--name {
+  font-size: 1.5em;
+}
+</style>

src/main/webapp/app/module/primary/modules-list/index.ts

@@ -0,0 +1,3 @@
+import ModulesListVue from './ModulesList.vue';
+
+export { ModulesListVue };

src/main/webapp/app/module/secondary/RestModulesRepository.ts

@@ -0,0 +1,73 @@
+import { AxiosHttp } from '@/http/AxiosHttp';
+import { AxiosResponse } from 'axios';
+import { Modules } from '../domain/Modules';
+import { Category } from '../domain/Category';
+import { Module } from '../domain/Module';
+import { ModulesRepository } from '../domain/ModulesRepository';
+import { ModuleProperties } from '../domain/ModuleProperties';
+import { ModuleSlug } from '../domain/ModuleSlug';
+import { ModuleProperty, ModulePropertyType } from '../domain/ModuleProperty';
+
+export interface RestModules {
+  categories: RestCategory[];
+}
+
+export interface RestCategory {
+  name: string;
+  modules: RestModule[];
+}
+
+export interface RestModule {
+  slug: string;
+  description: string;
+}
+
+export interface RestModuleProperties {
+  definitions: RestModuleProperty[];
+}
+
+export interface RestModuleProperty {
+  type: ModulePropertyType;
+  mandatory: boolean;
+  key: string;
+  description?: string;
+  example?: string;
+}
+
+export class RestModulesRepository implements ModulesRepository {
+  constructor(private axiosInstance: AxiosHttp) {}
+
+  list(): Promise<Modules> {
+    return this.axiosInstance.get<RestModules>('/api/modules').then(mapToModules);
+  }
+
+  get(slug: ModuleSlug): Promise<ModuleProperties> {
+    return this.axiosInstance.get<RestModuleProperties>(`/api/modules/${slug}`).then(mapToModule);
+  }
+}
+
+const mapToModules = (response: AxiosResponse<RestModules>): Modules => ({
+  categories: response.data.categories.map(toCategory),
+});
+
+const toCategory = (restCategory: RestCategory): Category => ({
+  name: restCategory.name,
+  modules: restCategory.modules.map(toModule),
+});
+
+const toModule = (restModule: RestModule): Module => ({
+  slug: restModule.slug,
+  description: restModule.description,
+});
+
+const mapToModule = (response: AxiosResponse<RestModuleProperties>): ModuleProperties => ({
+  properties: response.data.definitions.map(toProperty),
+});
+
+const toProperty = (restProperty: RestModuleProperty): ModuleProperty => ({
+  type: restProperty.type,
+  mandatory: restProperty.mandatory,
+  key: restProperty.key,
+  description: restProperty.description,
+  example: restProperty.example,
+});

src/main/webapp/app/router/index.ts

@@ -1,3 +1,4 @@
+import { ModulesListVue } from '@/module/primary/modules-list';
 import { GeneratorVue } from '@/springboot/primary';
 import { createRouter, createWebHistory } from 'vue-router';
 
@@ -11,6 +12,11 @@ const routes = [
     name: 'Generator',
     component: GeneratorVue,
   },
+  {
+    path: '/modules',
+    name: 'ModulesList',
+    component: ModulesListVue,
+  },
 ];
 
 const router = createRouter({

src/test/javascript/cypress/integration/Modules.spec.ts

@@ -0,0 +1,9 @@
+import { dataSelector } from '../support/selector';
+
+describe('Modules', () => {
+  it('Should display modules', () => {
+    cy.visit('/modules');
+
+    cy.get(dataSelector('modules-title')).contains('Modules');
+  });
+});

src/test/javascript/spec/WrappedElement.ts

@@ -0,0 +1 @@
+export const wrappedElement = (selector: string): string => `[data-selector="${selector}"]`;

src/test/javascript/spec/loader/primary/Loader.spec.ts

@@ -0,0 +1,27 @@
+import { Loader } from '@/loader/primary/Loader';
+
+describe('Loader', () => {
+  it('Should be loading for loading loader', () => {
+    expect(Loader.loading().isLoading()).toBe(true);
+  });
+
+  it('Should not get value for not loaded loader', () => {
+    expect(() => Loader.loading().value()).toThrow();
+  });
+
+  it('Should build loaded value', () => {
+    const loader = Loader.loaded('pouet');
+
+    expect(loader.isLoading()).toBe(false);
+    expect(loader.value()).toBe('pouet');
+  });
+
+  it('Should load value', () => {
+    const loader = Loader.loading();
+
+    loader.loaded('pouet');
+
+    expect(loader.isLoading()).toBe(false);
+    expect(loader.value()).toBe('pouet');
+  });
+});

src/test/javascript/spec/module/domain/Modules.fixture.ts

@@ -0,0 +1,49 @@
+import { Modules } from '@/module/domain/Modules';
+import { ModuleProperties } from '@/module/domain/ModuleProperties';
+import { ModulesRepository } from '@/module/domain/ModulesRepository';
+import sinon, { SinonStub } from 'sinon';
+
+interface ModulesRepositoryStub extends ModulesRepository {
+  list: SinonStub;
+}
+
+export const stubModulesRepository = (): ModulesRepositoryStub =>
+  ({
+    list: sinon.stub(),
+  } as ModulesRepositoryStub);
+
+export const defaultModules = (): Modules => ({
+  categories: [
+    {
+      name: 'Spring',
+      modules: [
+        {
+          slug: 'spring-cucumber',
+          description: 'Add cucumber to the application',
+        },
+      ],
+    },
+  ],
+});
+
+export const defaultModuleProperties = (): ModuleProperties => ({
+  properties: [
+    {
+      type: 'STRING',
+      mandatory: true,
+      key: 'baseName',
+      description: 'Application base name',
+      example: 'jhipster',
+    },
+    {
+      type: 'BOOLEAN',
+      mandatory: false,
+      key: 'optionalBoolean',
+    },
+    {
+      type: 'INTEGER',
+      mandatory: false,
+      key: 'optionalInteger',
+    },
+  ],
+});