GH-189 - Better artifact names for example projects.

spring-modulith-examples/spring-modulith-example-epr-jdbc/src/main/asciidoc/index.adoc

@@ -0,0 +1,16 @@
+= Spring Modulith Example Documentation
+:modulith-docs: ../../../target/spring-modulith-docs
+
+== Overview
+
+plantuml::{modulith-docs}/components.puml[format="svg"]
+
+== Inventory
+
+plantuml::{modulith-docs}/module-inventory.puml[format="svg"]
+include::{modulith-docs}/module-inventory.adoc[]
+
+== Orders
+
+plantuml::{modulith-docs}/module-order.puml[format="svg"]
+include::{modulith-docs}/module-order.adoc[]

spring-modulith-examples/spring-modulith-example-epr-jdbc/src/main/java/example/Application.java

@@ -0,0 +1,29 @@
+/*
+ * Copyright 2022-2023 the original author or authors.
+ *
+ * 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 example;
+
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+/**
+ * Spring Modulith example application
+ *
+ * @author Oliver Drotbohm
+ */
+@SpringBootApplication
+public class Application {
+
+	public static void main(String... args) throws Exception {}
+}

spring-modulith-examples/spring-modulith-example-epr-jdbc/src/main/java/example/inventory/InventoryManagement.java

@@ -0,0 +1,53 @@
+/*
+ * Copyright 2022-2023 the original author or authors.
+ *
+ * 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 example.inventory;
+
+import example.order.OrderCompleted;
+import lombok.RequiredArgsConstructor;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.context.ApplicationEventPublisher;
+import org.springframework.modulith.ApplicationModuleListener;
+import org.springframework.stereotype.Service;
+
+/**
+ * A Spring {@link Service} exposed by the inventory module.
+ *
+ * @author Oliver Drotbohm
+ */
+@Service
+@RequiredArgsConstructor
+class InventoryManagement {
+
+	private static final Logger LOG = LoggerFactory.getLogger(InventoryManagement.class);
+
+	private final ApplicationEventPublisher events;
+
+	@ApplicationModuleListener
+	void on(OrderCompleted event) throws InterruptedException {
+
+		var orderId = event.orderId();
+
+		LOG.info("Received order completion for {}.", orderId);
+
+		// Simulate busy work
+		Thread.sleep(1000);
+		events.publishEvent(new InventoryUpdated(orderId));
+
+		LOG.info("Finished order completion for {}.", orderId);
+	}
+}

spring-modulith-examples/spring-modulith-example-epr-jdbc/src/main/java/example/inventory/InventoryUpdated.java

@@ -0,0 +1,23 @@
+/*
+ * Copyright 2023 the original author or authors.
+ *
+ * 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 example.inventory;
+
+import java.util.UUID;
+
+/**
+ * @author Oliver Drotbohm
+ */
+public record InventoryUpdated(UUID orderId) {}

spring-modulith-examples/spring-modulith-example-epr-jdbc/src/main/java/example/inventory/package-info.java

@@ -0,0 +1,8 @@
+/**
+ * The logical application module inventory implemented as a single-package module. Allows to hide application
+ * components inside the module by using package scoped types.
+ *
+ * @see example.inventory.InventoryInternal
+ */
+@org.springframework.lang.NonNullApi
+package example.inventory;

spring-modulith-examples/spring-modulith-example-epr-jdbc/src/main/java/example/order/OrderCompleted.java

@@ -0,0 +1,25 @@
+/*
+ * Copyright 2022-2023 the original author or authors.
+ *
+ * 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 example.order;
+
+import java.util.UUID;
+
+import org.jmolecules.event.types.DomainEvent;
+
+/**
+ * @author Oliver Drotbohm
+ */
+public record OrderCompleted(UUID orderId) implements DomainEvent {}

spring-modulith-examples/spring-modulith-example-epr-jdbc/src/main/java/example/order/OrderManagement.java

@@ -0,0 +1,40 @@
+/*
+ * Copyright 2022-2023 the original author or authors.
+ *
+ * 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 example.order;
+
+import lombok.NonNull;
+import lombok.RequiredArgsConstructor;
+
+import java.util.UUID;
+
+import org.springframework.context.ApplicationEventPublisher;
+import org.springframework.stereotype.Service;
+import org.springframework.transaction.annotation.Transactional;
+
+/**
+ * @author Oliver Drotbohm
+ */
+@Service
+@RequiredArgsConstructor
+public class OrderManagement {
+
+	private final @NonNull ApplicationEventPublisher events;
+
+	@Transactional
+	public void complete() {
+		events.publishEvent(new OrderCompleted(UUID.randomUUID()));
+	}
+}

spring-modulith-examples/spring-modulith-example-epr-jdbc/src/main/java/example/order/package-info.java

@@ -0,0 +1,8 @@
+/**
+ * The logical application module order implemented as a multi-package module. Internal components located in nested
+ * packages are prevented from being accessed by the {@link org.springframework.modulith.core.ApplicationModules} type.
+ *
+ * @see example.ModularityTests
+ */
+@org.springframework.lang.NonNullApi
+package example.order;

spring-modulith-examples/spring-modulith-example-epr-jdbc/src/main/resources/application.properties

@@ -0,0 +1,2 @@
+spring.jpa.show-sql=true
+spring.modulith.events.jdbc.schema-initialization.enabled=true

spring-modulith-examples/spring-modulith-example-epr-jdbc/src/main/resources/logback.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<configuration>
+	
+	<include resource="org/springframework/boot/logging/logback/defaults.xml"/>
+	<include resource="org/springframework/boot/logging/logback/console-appender.xml" />
+	
+	<root level="INFO">
+		<appender-ref ref="CONSOLE" />
+	</root>
+	
+	<logger name="org.springframework.modulith" level="INFO"/>
+	<logger name="example" level="INFO" />
+	
+</configuration>