feat(build): auto-add web starter when sample code is enabled

Author: bsayli

src/main/java/io/github/blueprintplatform/codegen/adapter/out/profile/springboot/maven/java/build/MavenPomBuildConfigurationAdapter.java

@@ -63,6 +63,10 @@ private List<BuildDependency> buildPomDependencies(ProjectBlueprint bp) {
     deps.add(MavenPomBuildModel.CORE_STARTER);
     deps.addAll(buildDependencyMapper.from(bp.getDependencies()));
 
+    if (isSampleEnabled(bp) && !isWebSelected(bp)) {
+      deps.add(MavenPomBuildModel.WEB_STARTER);
+    }
+
     if (isJpaSelected(bp)) {
       deps.add(MavenPomBuildModel.H2_DB);
     }
@@ -76,6 +80,18 @@ private List<BuildDependency> buildPomDependencies(ProjectBlueprint bp) {
     return List.copyOf(deps);
   }
 
+  private boolean isSampleEnabled(ProjectBlueprint bp) {
+    var arch = bp.getArchitecture();
+    return arch != null && arch.sampleCodeOptions() != null && arch.sampleCodeOptions().isEnabled();
+  }
+
+  private boolean isWebSelected(ProjectBlueprint bp) {
+    var deps = bp.getDependencies();
+    return deps != null
+        && !deps.isEmpty()
+        && deps.asList().stream().anyMatch(MavenPomBuildModel.WEB_STARTER_FEATURE.matches());
+  }
+
   private boolean isJpaSelected(ProjectBlueprint bp) {
     var deps = bp.getDependencies();
     return deps != null

src/main/java/io/github/blueprintplatform/codegen/adapter/out/profile/springboot/maven/java/build/MavenPomBuildModel.java

@@ -13,6 +13,7 @@ final class MavenPomBuildModel {
   static final String KEY_PROJECT_NAME = "projectName";
   static final String KEY_PROJECT_DESCRIPTION = "projectDescription";
   static final String KEY_POM_PROPERTIES = "pomProperties";
+
   static final String ARCH_UNIT_VERSION_KEY = "archunit.version";
   static final String ARCH_UNIT_VERSION = "1.4.1";
   static final BuildDependency H2_DB = BuildDependency.of("com.h2database", "h2", null, null);
@@ -22,10 +23,18 @@ final class MavenPomBuildModel {
   private static final String SPRING_BOOT_GROUP_ID = "org.springframework.boot";
   static final DependencyFeature JPA_STARTER =
       new DependencyFeature("jpa", SPRING_BOOT_GROUP_ID, "spring-boot-starter-data-jpa");
+
+  static final DependencyFeature WEB_STARTER_FEATURE =
+      new DependencyFeature("web", SPRING_BOOT_GROUP_ID, "spring-boot-starter-web");
+
   static final BuildDependency CORE_STARTER =
       BuildDependency.of(SPRING_BOOT_GROUP_ID, "spring-boot-starter");
+
   static final BuildDependency TEST_STARTER =
       BuildDependency.of(SPRING_BOOT_GROUP_ID, "spring-boot-starter-test", null, "test");
 
+  static final BuildDependency WEB_STARTER =
+      BuildDependency.of(SPRING_BOOT_GROUP_ID, "spring-boot-starter-web");
+
   private MavenPomBuildModel() {}
 }

src/test/java/io/github/blueprintplatform/codegen/adapter/out/profile/springboot/maven/java/build/MavenPomBuildConfigurationAdapterTest.java

@@ -52,29 +52,30 @@ class MavenPomBuildConfigurationAdapterTest {
   private static final String BASE_PATH = "springboot/maven/java/";
 
   private static ProjectBlueprint blueprint(
-      ArchitectureGovernance governance, Dependencies dependencies) {
+          ArchitectureGovernance governance, Dependencies dependencies, SampleCodeOptions sample) {
+
     ProjectMetadata metadata =
-        new ProjectMetadata(
-            new ProjectIdentity(new GroupId("com.acme"), new ArtifactId("demo-app")),
-            new ProjectName("Demo App"),
-            new ProjectDescription("Sample Project"),
-            new PackageName("com.acme.demo"));
+            new ProjectMetadata(
+                    new ProjectIdentity(new GroupId("com.acme"), new ArtifactId("demo-app")),
+                    new ProjectName("Demo App"),
+                    new ProjectDescription("Sample Project"),
+                    new PackageName("com.acme.demo"));
 
     TechStack techStack = new TechStack(Framework.SPRING_BOOT, BuildTool.MAVEN, Language.JAVA);
     PlatformTarget target = new SpringBootJvmTarget(JavaVersion.JAVA_21, SpringBootVersion.V3_5);
     PlatformSpec platform = new PlatformSpec(techStack, target);
 
     ArchitectureSpec architecture =
-        new ArchitectureSpec(ProjectLayout.STANDARD, governance, SampleCodeOptions.none());
+            new ArchitectureSpec(ProjectLayout.STANDARD, governance, sample);
 
     return ProjectBlueprint.of(metadata, platform, architecture, dependencies);
   }
 
   private static Dependency dep(String groupId, String artifactId) {
     return new Dependency(
-        new DependencyCoordinates(new GroupId(groupId), new ArtifactId(artifactId)),
-        new DependencyVersion("1.0.0"),
-        DependencyScope.RUNTIME);
+            new DependencyCoordinates(new GroupId(groupId), new ArtifactId(artifactId)),
+            new DependencyVersion("1.0.0"),
+            DependencyScope.RUNTIME);
   }
 
   @Test
@@ -106,7 +107,8 @@ void generate_shouldBuildModel_withoutJpa_withoutGovernance() {
 
     ProjectBlueprint bp =
         blueprint(
-            ArchitectureGovernance.none(), Dependencies.of(List.of(dep("org.acme", "custom-dep"))));
+            ArchitectureGovernance.none(),
+                Dependencies.of(List.of(dep("org.acme", "custom-dep"))), SampleCodeOptions.none());
 
     renderer.nextFile =
         new GeneratedTextResource(Path.of("pom.xml"), "<project/>", StandardCharsets.UTF_8);
@@ -139,6 +141,42 @@ void generate_shouldBuildModel_withoutJpa_withoutGovernance() {
     assertThat(deps.get(2)).isEqualTo(MavenPomBuildModel.TEST_STARTER);
   }
 
+  @Test
+  @DisplayName("generate() should add WEB starter when sample code is enabled and web is not selected")
+  void generate_shouldAddWeb_whenSampleEnabled_andWebNotSelected() {
+    CapturingTemplateRenderer renderer = new CapturingTemplateRenderer();
+
+    List<BuildDependency> mapped =
+            List.of(BuildDependency.of("org.acme", "custom-dep", "1.0.0", "runtime"));
+    RecordingBuildDependencyMapper mapper = new RecordingBuildDependencyMapper(mapped);
+
+    ArtifactSpec artifactSpec =
+            new ArtifactSpec(BASE_PATH, List.of(new TemplateSpec("pom.ftl", "pom.xml")));
+    MavenPomBuildConfigurationAdapter adapter =
+            new MavenPomBuildConfigurationAdapter(renderer, artifactSpec, mapper);
+
+    ProjectBlueprint bp =
+            blueprint(
+                    ArchitectureGovernance.none(),
+                    Dependencies.of(List.of(dep("org.acme", "custom-dep"))),
+                    SampleCodeOptions.basic());
+
+    renderer.nextFile =
+            new GeneratedTextResource(Path.of("pom.xml"), "<project/>", StandardCharsets.UTF_8);
+
+    adapter.generate(bp);
+
+    @SuppressWarnings("unchecked")
+    List<BuildDependency> deps =
+            (List<BuildDependency>) renderer.capturedModel.get(MavenPomBuildModel.KEY_DEPENDENCIES);
+
+    assertThat(deps).hasSize(4);
+    assertThat(deps.get(0)).isEqualTo(MavenPomBuildModel.CORE_STARTER);
+    assertThat(deps.get(1)).isSameAs(mapped.getFirst());
+    assertThat(deps.get(2)).isEqualTo(MavenPomBuildModel.WEB_STARTER);
+    assertThat(deps.get(3)).isEqualTo(MavenPomBuildModel.TEST_STARTER);
+  }
+
   @Test
   @DisplayName("generate() should add H2 dependency when JPA starter is selected")
   void generate_shouldAddH2_whenJpaSelected() {
@@ -164,7 +202,7 @@ void generate_shouldAddH2_whenJpaSelected() {
     ProjectBlueprint bp =
         blueprint(
             ArchitectureGovernance.none(),
-            Dependencies.of(List.of(dep("org.acme", "custom-dep"), jpaStarter)));
+            Dependencies.of(List.of(dep("org.acme", "custom-dep"), jpaStarter)), SampleCodeOptions.none());
 
     renderer.nextFile =
         new GeneratedTextResource(Path.of("pom.xml"), "<project/>", StandardCharsets.UTF_8);
@@ -213,7 +251,7 @@ void generate_shouldAddArchUnit_whenGovernanceEnabled() {
     ProjectBlueprint bp =
         blueprint(
             ArchitectureGovernance.basic(),
-            Dependencies.of(List.of(dep("org.acme", "custom-dep"), jpaStarter)));
+            Dependencies.of(List.of(dep("org.acme", "custom-dep"), jpaStarter)), SampleCodeOptions.none());
 
     renderer.nextFile =
         new GeneratedTextResource(Path.of("pom.xml"), "<project/>", StandardCharsets.UTF_8);
@@ -239,4 +277,5 @@ void generate_shouldAddArchUnit_whenGovernanceEnabled() {
     assertThat(deps.get(3)).isEqualTo(MavenPomBuildModel.ARCH_UNIT_TEST);
     assertThat(deps.get(4)).isEqualTo(MavenPomBuildModel.TEST_STARTER);
   }
+
 }