Merge pull request #466 from pascalgrimaud/npm-add-dependency

Package Manager NPM: add method for adding dependency
jhipster · Jan 5, 2022 · f91c2ac · f91c2ac
2 parents 0ba5c6d + d77b3e3
commit f91c2ac
Show file tree

Hide file tree

Showing 10 changed files with 167 additions and 4 deletions.
diff --git a/src/main/java/tech/jhipster/lite/common/domain/WordUtils.java b/src/main/java/tech/jhipster/lite/common/domain/WordUtils.java
@@ -6,6 +6,10 @@
 public class WordUtils {
 
   public static final int DEFAULT_INDENTATION = 2;
+  public static final String DQ = "\"";
+
+  public static final String OB = "\\{";
+  public static final String CB = "\\}";
 
   private WordUtils() {}
 

diff --git a/...va/tech/jhipster/lite/generator/packagemanager/npm/application/NpmApplicationService.java b/...va/tech/jhipster/lite/generator/packagemanager/npm/application/NpmApplicationService.java
@@ -9,6 +9,10 @@ public class NpmApplicationService {
 
   private final NpmService npmService;
 
+  public void addDependency(Project project, String dependency, String version) {
+    this.npmService.addDependency(project, dependency, version);
+  }
+
   public NpmApplicationService(NpmService npmService) {
     this.npmService = npmService;
   }

diff --git a/src/main/java/tech/jhipster/lite/generator/packagemanager/npm/domain/NpmDomainService.java b/src/main/java/tech/jhipster/lite/generator/packagemanager/npm/domain/NpmDomainService.java
@@ -1,19 +1,52 @@
 package tech.jhipster.lite.generator.packagemanager.npm.domain;
 
+import static tech.jhipster.lite.common.domain.WordUtils.*;
+import static tech.jhipster.lite.generator.project.domain.Constants.PACKAGE_JSON;
+import static tech.jhipster.lite.generator.project.domain.DefaultConfig.*;
+
 import tech.jhipster.lite.generator.project.domain.CommandRepository;
 import tech.jhipster.lite.generator.project.domain.Project;
+import tech.jhipster.lite.generator.project.domain.ProjectRepository;
 
 public class NpmDomainService implements NpmService {
 
+  public static final String DEPENDENCIES = DQ + "dependencies" + DQ;
+  public static final String DEV_DEPENDENCIES = DQ + "devDependencies" + DQ;
+  public static final String SCRIPTS = DQ + "scripts" + DQ;
+
   private final CommandRepository commandRepository;
+  private final ProjectRepository projectRepository;
 
-  public NpmDomainService(CommandRepository commandRepository) {
+  public NpmDomainService(CommandRepository commandRepository, ProjectRepository projectRepository) {
     this.commandRepository = commandRepository;
+    this.projectRepository = projectRepository;
   }
 
   @Override
   public void addDependency(Project project, String dependency, String version) {
-    // Need to be implemented
+    project.addDefaultConfig(PRETTIER_DEFAULT_INDENT);
+    int indent = (Integer) project.getConfig(PRETTIER_DEFAULT_INDENT).orElse(2);
+
+    String needle = DEPENDENCIES + ": " + OB;
+    String newText = needle + System.lineSeparator() + indent(2, indent) + DQ + dependency + DQ + ": " + DQ + version + DQ;
+
+    String devDependenciesNeedle = DEV_DEPENDENCIES + ": " + OB;
+    if (!projectRepository.containsRegexp(project, "", PACKAGE_JSON, needle)) {
+      newText =
+        newText +
+        System.lineSeparator() +
+        indent(1, indent) +
+        CB +
+        "," +
+        System.lineSeparator() +
+        indent(1, indent) +
+        devDependenciesNeedle;
+      projectRepository.replaceText(project, "", PACKAGE_JSON, devDependenciesNeedle, newText);
+    } else if (projectRepository.containsRegexp(project, "", PACKAGE_JSON, needle + CB)) {
+      projectRepository.replaceText(project, "", PACKAGE_JSON, needle, newText + System.lineSeparator() + indent(1, indent));
+    } else {
+      projectRepository.replaceText(project, "", PACKAGE_JSON, needle, newText + ",");
+    }
   }
 
   @Override

diff --git a/...hipster/lite/generator/packagemanager/npm/infrastructure/config/NpmBeanConfiguration.java b/...hipster/lite/generator/packagemanager/npm/infrastructure/config/NpmBeanConfiguration.java
@@ -5,18 +5,21 @@
 import tech.jhipster.lite.generator.packagemanager.npm.domain.NpmDomainService;
 import tech.jhipster.lite.generator.packagemanager.npm.domain.NpmService;
 import tech.jhipster.lite.generator.project.domain.CommandRepository;
+import tech.jhipster.lite.generator.project.domain.ProjectRepository;
 
 @Configuration
 public class NpmBeanConfiguration {
 
   private final CommandRepository commandRepository;
+  private final ProjectRepository projectRepository;
 
-  public NpmBeanConfiguration(CommandRepository commandRepository) {
+  public NpmBeanConfiguration(CommandRepository commandRepository, ProjectRepository projectRepository) {
     this.commandRepository = commandRepository;
+    this.projectRepository = projectRepository;
   }
 
   @Bean
   public NpmService npmService() {
-    return new NpmDomainService(commandRepository);
+    return new NpmDomainService(commandRepository, projectRepository);
   }
 }
diff --git a/src/test/java/tech/jhipster/lite/TestUtils.java b/src/test/java/tech/jhipster/lite/TestUtils.java
@@ -95,6 +95,24 @@ public static Project tmpProjectWithPackageJson() {
     return project;
   }
 
+  public static Project tmpProjectWithPackageJsonNoDependencies() {
+    Project project = tmpProject();
+    copyPackageJsonByName(project, "package-no-dependencies.json");
+    return project;
+  }
+
+  public static Project tmpProjectWithPackageJsonEmpty() {
+    Project project = tmpProject();
+    copyPackageJsonByName(project, "package-empty.json");
+    return project;
+  }
+
+  public static Project tmpProjectWithPackageJsonComplete() {
+    Project project = tmpProject();
+    copyPackageJsonByName(project, "package-complete.json");
+    return project;
+  }
+
   public static Project tmpProjectWithBuildGradle() {
     Project project = tmpProject();
     copyBuildGradle(project);
@@ -143,6 +161,15 @@ public static void copyPackageJson(Project project) {
     }
   }
 
+  public static void copyPackageJsonByName(Project project, String packageJsonFilename) {
+    try {
+      FileUtils.createFolder(project.getFolder());
+      Files.copy(getPathOf("src/test/resources/generator/command/", packageJsonFilename), getPathOf(project.getFolder(), PACKAGE_JSON));
+    } catch (IOException e) {
+      throw new AssertionError(e);
+    }
+  }
+
   public static void copySpringBootProperties(Project project) {
     try {
       FileUtils.createFolder(getPath(project.getFolder(), MAIN_RESOURCES, "config"));

diff --git a/.../tech/jhipster/lite/generator/packagemanager/npm/application/NpmApplicationServiceIT.java b/.../tech/jhipster/lite/generator/packagemanager/npm/application/NpmApplicationServiceIT.java
@@ -3,7 +3,9 @@
 import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.Mockito.verify;
 import static tech.jhipster.lite.TestUtils.*;
+import static tech.jhipster.lite.generator.project.domain.Constants.PACKAGE_JSON;
 
+import java.util.List;
 import org.junit.jupiter.api.Test;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.test.mock.mockito.SpyBean;
@@ -20,6 +22,40 @@ class NpmApplicationServiceIT {
   @SpyBean
   CommandRepository commandRepository;
 
+  @Test
+  void shouldAddDependencyWhenNoDependencyEntry() {
+    Project project = tmpProjectWithPackageJsonNoDependencies();
+    String dependency = "husky";
+    String version = "7.0.4";
+
+    npmApplicationService.addDependency(project, dependency, version);
+
+    assertFileContent(project, PACKAGE_JSON, List.of("\"dependencies\": {", "\"husky\": \"7.0.4\"", "},", "\"devDependencies\": {"));
+  }
+
+  @Test
+  void shouldAddDependencyWhenDependencyEmpty() {
+    Project project = tmpProjectWithPackageJsonEmpty();
+    String dependency = "husky";
+    String version = "7.0.4";
+
+    npmApplicationService.addDependency(project, dependency, version);
+
+    assertFileContent(project, PACKAGE_JSON, List.of("\"dependencies\": {", "\"husky\": \"7.0.4\""));
+    assertFileNoContent(project, PACKAGE_JSON, List.of("\"dependencies\": {", "\"husky\": \"7.0.4\","));
+  }
+
+  @Test
+  void shouldAddDependency() {
+    Project project = tmpProjectWithPackageJsonComplete();
+    String dependency = "husky";
+    String version = "7.0.4";
+
+    npmApplicationService.addDependency(project, dependency, version);
+
+    assertFileContent(project, PACKAGE_JSON, List.of("\"dependencies\": {", "\"husky\": \"7.0.4\","));
+  }
+
   @Test
   void shouldNpmInstall() {
     Project project = tmpProjectWithPackageJson();

diff --git a/...est/java/tech/jhipster/lite/generator/packagemanager/npm/domain/NpmDomainServiceTest.java b/...est/java/tech/jhipster/lite/generator/packagemanager/npm/domain/NpmDomainServiceTest.java
@@ -2,6 +2,7 @@
 
 import static org.assertj.core.api.Assertions.assertThatCode;
 import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.ArgumentMatchers.anyString;
 import static org.mockito.Mockito.verify;
 import static tech.jhipster.lite.TestUtils.tmpProject;
 
@@ -13,6 +14,7 @@
 import tech.jhipster.lite.UnitTest;
 import tech.jhipster.lite.generator.project.domain.CommandRepository;
 import tech.jhipster.lite.generator.project.domain.Project;
+import tech.jhipster.lite.generator.project.domain.ProjectRepository;
 
 @UnitTest
 @ExtendWith(MockitoExtension.class)
@@ -21,6 +23,9 @@ class NpmDomainServiceTest {
   @Mock
   CommandRepository commandRepository;
 
+  @Mock
+  ProjectRepository projectRepository;
+
   @InjectMocks
   NpmDomainService npmDomainService;
 
@@ -31,6 +36,8 @@ void shouldAddDependency() {
     String version = "2.5.1";
 
     assertThatCode(() -> npmDomainService.addDependency(project, dependency, version)).doesNotThrowAnyException();
+
+    verify(projectRepository).replaceText(any(Project.class), anyString(), anyString(), anyString(), anyString());
   }
 
   @Test

diff --git a/src/test/resources/generator/command/package-complete.json b/src/test/resources/generator/command/package-complete.json
@@ -0,0 +1,18 @@
+{
+  "name": "jhlite",
+  "version": "0.0.1",
+  "scripts": {
+    "prettier:check": "prettier --check \"{,src/**/}*.{md,json,yml,html,js,ts,tsx,css,scss,vue,java,xml}\"",
+    "prettier:format": "prettier --write \"{,src/**/}*.{md,json,yml,html,js,ts,tsx,css,scss,vue,java,xml}\""
+  },
+  "dependencies": {
+    "prettier": "2.5.1"
+  },
+  "devDependencies": {
+    "prettier": "2.5.1"
+  },
+  "engines": {
+    "node": ">=14.18.1"
+  },
+  "cacheDirectories": ["node_modules"]
+}
diff --git a/src/test/resources/generator/command/package-empty.json b/src/test/resources/generator/command/package-empty.json
@@ -0,0 +1,16 @@
+{
+  "name": "jhlite",
+  "version": "0.0.1",
+  "scripts": {
+    "prettier:check": "prettier --check \"{,src/**/}*.{md,json,yml,html,js,ts,tsx,css,scss,vue,java,xml}\"",
+    "prettier:format": "prettier --write \"{,src/**/}*.{md,json,yml,html,js,ts,tsx,css,scss,vue,java,xml}\""
+  },
+  "dependencies": {},
+  "devDependencies": {
+    "prettier": "2.5.1"
+  },
+  "engines": {
+    "node": ">=14.18.1"
+  },
+  "cacheDirectories": ["node_modules"]
+}
diff --git a/src/test/resources/generator/command/package-no-dependencies.json b/src/test/resources/generator/command/package-no-dependencies.json
@@ -0,0 +1,15 @@
+{
+  "name": "jhlite",
+  "version": "0.0.1",
+  "scripts": {
+    "prettier:check": "prettier --check \"{,src/**/}*.{md,json,yml,html,js,ts,tsx,css,scss,vue,java,xml}\"",
+    "prettier:format": "prettier --write \"{,src/**/}*.{md,json,yml,html,js,ts,tsx,css,scss,vue,java,xml}\""
+  },
+  "devDependencies": {
+    "prettier": "2.5.1"
+  },
+  "engines": {
+    "node": ">=14.18.1"
+  },
+  "cacheDirectories": ["node_modules"]
+}