Release 3.2.0: Add Spring Modulith dependency and refactor to clarify…

… app modules

pom.xml

@@ -11,13 +11,15 @@
 
 	<groupId>org.keen</groupId>
 	<artifactId>solar</artifactId>
-	<version>3.1.0</version>
+	<version>3.2.0</version>
 
 	<name>solar</name>
 	<description>Retrieves solar data from a Fronius inverter and persists it to a data store.</description>
 
 	<properties>
 		<java.version>21</java.version>
+
+		<spring-modulith-bom.version>1.2.4</spring-modulith-bom.version>
 	</properties>
 
 	<dependencies>
@@ -69,8 +71,30 @@
 			<artifactId>commons-lang3</artifactId>
 			<scope>test</scope>
 		</dependency>
+
+		<dependency>
+			<groupId>org.springframework.modulith</groupId>
+			<artifactId>spring-modulith-starter-test</artifactId>
+			<scope>test</scope>
+		</dependency>
+		<dependency>
+			<groupId>org.springframework.modulith</groupId>
+			<artifactId>spring-modulith-api</artifactId>
+		</dependency>
 	</dependencies>
 
+	<dependencyManagement>
+		<dependencies>
+			<dependency>
+				<groupId>org.springframework.modulith</groupId>
+				<artifactId>spring-modulith-bom</artifactId>
+				<version>${spring-modulith-bom.version}</version>
+				<scope>import</scope>
+				<type>pom</type>
+			</dependency>
+		</dependencies>
+	</dependencyManagement>
+
 	<build>
 		<plugins>
 			<plugin>
@@ -88,7 +112,7 @@
 						<exclude>**/ForecastRetrieverIT.java</exclude>
 						<!-- Excluding tests which call the Fronius API and hence will only run locally -->
 						<exclude>**/CurrentPowerRetrieverIT.java</exclude>
-						<exclude>**/StringDataRetrieverIT.java</exclude>
+						<exclude>**/StringPowerRetrieverIT.java</exclude>
 					</excludes>
 				</configuration>
 				<executions>

src/main/java/org/keen/solar/config/DalConfiguration.java

@@ -11,7 +11,9 @@
 import javax.sql.DataSource;
 
 @Configuration
-@EnableJdbcRepositories({"org.keen.solar.forecast.dal","org.keen.solar.power.dal"})
+@EnableJdbcRepositories({"org.keen.solar.solcast.forecast.dal",
+        "org.keen.solar.string.dal",
+        "org.keen.solar.system.dal"})
 public class DalConfiguration extends AbstractJdbcConfiguration {
 
     @Autowired

src/main/java/org/keen/solar/forecast/solcast/ForecastPersister.java → src/main/java/org/keen/solar/solcast/forecast/ForecastPersister.java

@@ -1,7 +1,7 @@
-package org.keen.solar.forecast.solcast;
+package org.keen.solar.solcast.forecast;
 
-import org.keen.solar.forecast.dal.ForecastRepository;
-import org.keen.solar.forecast.domain.GenerationForecast;
+import org.keen.solar.solcast.forecast.dal.ForecastRepository;
+import org.keen.solar.solcast.forecast.domain.GenerationForecast;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.scheduling.annotation.Scheduled;
 import org.springframework.web.bind.annotation.PostMapping;

src/main/java/org/keen/solar/forecast/solcast/ForecastRetriever.java → src/main/java/org/keen/solar/solcast/forecast/ForecastRetriever.java

@@ -1,7 +1,7 @@
-package org.keen.solar.forecast.solcast;
+package org.keen.solar.solcast.forecast;
 
-import org.keen.solar.forecast.domain.Forecasts;
-import org.keen.solar.forecast.domain.GenerationForecast;
+import org.keen.solar.solcast.forecast.domain.Forecasts;
+import org.keen.solar.solcast.forecast.domain.GenerationForecast;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Value;

src/main/java/org/keen/solar/forecast/solcast/ForecastsDeserializer.java → src/main/java/org/keen/solar/solcast/forecast/ForecastsDeserializer.java

@@ -1,12 +1,12 @@
-package org.keen.solar.forecast.solcast;
+package org.keen.solar.solcast.forecast;
 
 import com.fasterxml.jackson.core.JsonParser;
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.databind.DeserializationContext;
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.deser.std.StdDeserializer;
-import org.keen.solar.forecast.domain.Forecasts;
-import org.keen.solar.forecast.domain.GenerationForecast;
+import org.keen.solar.solcast.forecast.domain.Forecasts;
+import org.keen.solar.solcast.forecast.domain.GenerationForecast;
 
 import java.io.IOException;
 import java.time.Duration;

src/main/java/org/keen/solar/forecast/dal/ForecastRepository.java → src/main/java/org/keen/solar/solcast/forecast/dal/ForecastRepository.java

@@ -1,6 +1,6 @@
-package org.keen.solar.forecast.dal;
+package org.keen.solar.solcast.forecast.dal;
 
-import org.keen.solar.forecast.domain.GenerationForecast;
+import org.keen.solar.solcast.forecast.domain.GenerationForecast;
 import org.springframework.data.jdbc.repository.query.Query;
 import org.springframework.data.repository.CrudRepository;
 

src/main/java/org/keen/solar/forecast/domain/Forecasts.java → src/main/java/org/keen/solar/solcast/forecast/domain/Forecasts.java

@@ -1,7 +1,7 @@
-package org.keen.solar.forecast.domain;
+package org.keen.solar.solcast.forecast.domain;
 
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
-import org.keen.solar.forecast.solcast.ForecastsDeserializer;
+import org.keen.solar.solcast.forecast.ForecastsDeserializer;
 
 import java.util.List;
 

src/main/java/org/keen/solar/forecast/domain/GenerationForecast.java → src/main/java/org/keen/solar/solcast/forecast/domain/GenerationForecast.java

@@ -1,4 +1,4 @@
-package org.keen.solar.forecast.domain;
+package org.keen.solar.solcast.forecast.domain;
 
 import org.springframework.data.annotation.Id;
 

src/main/java/org/keen/solar/solcast/forecast/package-info.java

@@ -0,0 +1,5 @@
+/**
+ * This package provides functionality to retrieve and persist solar forecasts
+ * from Solcast.
+ */
+package org.keen.solar.solcast.forecast;

src/main/java/org/keen/solar/power/solcast/MeasurementSerializer.java → src/main/java/org/keen/solar/solcast/measurement/MeasurementSerializer.java

@@ -1,9 +1,9 @@
-package org.keen.solar.power.solcast;
+package org.keen.solar.solcast.measurement;
 
 import com.fasterxml.jackson.core.JsonGenerator;
 import com.fasterxml.jackson.databind.SerializerProvider;
 import com.fasterxml.jackson.databind.ser.std.StdSerializer;
-import org.keen.solar.power.domain.Measurement;
+import org.keen.solar.solcast.measurement.domain.Measurement;
 
 import java.io.IOException;
 import java.time.format.DateTimeFormatter;

src/main/java/org/keen/solar/power/solcast/MeasurementUploader.java → src/main/java/org/keen/solar/solcast/measurement/MeasurementUploader.java

@@ -1,10 +1,10 @@
-package org.keen.solar.power.solcast;
+package org.keen.solar.solcast.measurement;
 
-import org.keen.solar.power.dal.CurrentPowerRepository;
-import org.keen.solar.power.domain.CurrentPower;
-import org.keen.solar.power.domain.Measurement;
-import org.keen.solar.power.domain.MeasurementResponse;
-import org.keen.solar.power.domain.Measurements;
+import org.keen.solar.system.dal.CurrentPowerRepository;
+import org.keen.solar.system.domain.CurrentPower;
+import org.keen.solar.solcast.measurement.domain.Measurement;
+import org.keen.solar.solcast.measurement.domain.MeasurementResponse;
+import org.keen.solar.solcast.measurement.domain.Measurements;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Value;

src/main/java/org/keen/solar/power/solcast/MeasurementsSerializer.java → src/main/java/org/keen/solar/solcast/measurement/MeasurementsSerializer.java

@@ -1,9 +1,9 @@
-package org.keen.solar.power.solcast;
+package org.keen.solar.solcast.measurement;
 
 import com.fasterxml.jackson.core.JsonGenerator;
 import com.fasterxml.jackson.databind.SerializerProvider;
 import com.fasterxml.jackson.databind.ser.std.StdSerializer;
-import org.keen.solar.power.domain.Measurements;
+import org.keen.solar.solcast.measurement.domain.Measurements;
 
 import java.io.IOException;
 

src/main/java/org/keen/solar/power/solcast/UploadScheduleConfig.java → src/main/java/org/keen/solar/solcast/measurement/UploadScheduleConfig.java

@@ -1,4 +1,4 @@
-package org.keen.solar.power.solcast;
+package org.keen.solar.solcast.measurement;
 
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.context.event.ApplicationReadyEvent;

src/main/java/org/keen/solar/power/domain/Measurement.java → src/main/java/org/keen/solar/solcast/measurement/domain/Measurement.java

@@ -1,7 +1,8 @@
-package org.keen.solar.power.domain;
+package org.keen.solar.solcast.measurement.domain;
 
 import com.fasterxml.jackson.databind.annotation.JsonSerialize;
-import org.keen.solar.power.solcast.MeasurementSerializer;
+import org.keen.solar.system.domain.CurrentPower;
+import org.keen.solar.solcast.measurement.MeasurementSerializer;
 
 import java.time.Duration;
 import java.time.OffsetDateTime;

src/main/java/org/keen/solar/power/domain/MeasurementResponse.java → src/main/java/org/keen/solar/solcast/measurement/domain/MeasurementResponse.java

@@ -1,4 +1,4 @@
-package org.keen.solar.power.domain;
+package org.keen.solar.solcast.measurement.domain;
 
 import java.util.List;
 

src/main/java/org/keen/solar/power/domain/Measurements.java → src/main/java/org/keen/solar/solcast/measurement/domain/Measurements.java

@@ -1,7 +1,7 @@
-package org.keen.solar.power.domain;
+package org.keen.solar.solcast.measurement.domain;
 
 import com.fasterxml.jackson.databind.annotation.JsonSerialize;
-import org.keen.solar.power.solcast.MeasurementsSerializer;
+import org.keen.solar.solcast.measurement.MeasurementsSerializer;
 
 import java.util.ArrayList;
 import java.util.List;

src/main/java/org/keen/solar/solcast/measurement/package-info.java

@@ -0,0 +1,5 @@
+/**
+ * This package provides functionality to retrieve persisted power generation
+ * information, summarise it and upload it to Solcast.
+ */
+package org.keen.solar.solcast.measurement;

src/main/java/org/keen/solar/power/dal/StringPowerRepository.java → src/main/java/org/keen/solar/string/dal/StringPowerRepository.java

@@ -1,6 +1,6 @@
-package org.keen.solar.power.dal;
+package org.keen.solar.string.dal;
 
-import org.keen.solar.power.domain.StringPower;
+import org.keen.solar.string.domain.StringPower;
 import org.springframework.data.repository.CrudRepository;
 
 public interface StringPowerRepository extends CrudRepository<StringPower, Long> {

src/main/java/org/keen/solar/power/domain/StringPower.java → src/main/java/org/keen/solar/string/domain/StringPower.java

@@ -1,4 +1,4 @@
-package org.keen.solar.power.domain;
+package org.keen.solar.string.domain;
 
 
 import org.springframework.data.annotation.Id;

src/main/java/org/keen/solar/power/domain/StringPowers.java → src/main/java/org/keen/solar/string/domain/StringPowers.java

@@ -1,7 +1,7 @@
-package org.keen.solar.power.domain;
+package org.keen.solar.string.domain;
 
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
-import org.keen.solar.power.fronius.StringPowersDeserializer;
+import org.keen.solar.string.fronius.StringPowersDeserializer;
 
 import java.util.List;
 

src/main/java/org/keen/solar/string/fronius/StringPowerConfiguration.java

@@ -0,0 +1,17 @@
+package org.keen.solar.string.fronius;
+
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.scheduling.annotation.EnableAsync;
+import org.springframework.scheduling.annotation.EnableScheduling;
+
+@Configuration
+@EnableScheduling
+@EnableAsync
+public class StringPowerConfiguration {
+
+    @Bean
+    public StringPowerPersister stringPowerPersister() {
+        return new StringPowerPersister();
+    }
+}

src/main/java/org/keen/solar/power/fronius/StringPowerPersister.java → src/main/java/org/keen/solar/string/fronius/StringPowerPersister.java

@@ -1,14 +1,14 @@
-package org.keen.solar.power.fronius;
+package org.keen.solar.string.fronius;
 
-import org.keen.solar.power.dal.StringPowerRepository;
+import org.keen.solar.string.dal.StringPowerRepository;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.scheduling.annotation.Async;
 import org.springframework.scheduling.annotation.Scheduled;
 
 public class StringPowerPersister {
 
     @Autowired
-    private StringDataRetriever retriever;
+    private StringPowerRetriever retriever;
 
     @Autowired
     private StringPowerRepository repository;

src/main/java/org/keen/solar/power/fronius/StringDataRetriever.java → src/main/java/org/keen/solar/string/fronius/StringPowerRetriever.java

@@ -1,7 +1,7 @@
-package org.keen.solar.power.fronius;
+package org.keen.solar.string.fronius;
 
-import org.keen.solar.power.domain.StringPower;
-import org.keen.solar.power.domain.StringPowers;
+import org.keen.solar.string.domain.StringPower;
+import org.keen.solar.string.domain.StringPowers;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.boot.web.client.RestTemplateBuilder;
 import org.springframework.stereotype.Service;
@@ -17,7 +17,7 @@
  * Retrieves the power output per "string" of panels
  */
 @Service
-public class StringDataRetriever {
+public class StringPowerRetriever {
 
     public static final DateTimeFormatter FORMATTER = DateTimeFormatter.ISO_OFFSET_DATE_TIME;
 
@@ -26,7 +26,7 @@ public class StringDataRetriever {
     @Value("${app.inverter.host}")
     private String inverterApiHost;
 
-    public StringDataRetriever(RestTemplateBuilder restTemplateBuilder) {
+    public StringPowerRetriever(RestTemplateBuilder restTemplateBuilder) {
         this.restTemplate = restTemplateBuilder.build();
     }
 

src/main/java/org/keen/solar/power/fronius/StringPowersDeserializer.java → src/main/java/org/keen/solar/string/fronius/StringPowersDeserializer.java

@@ -1,11 +1,11 @@
-package org.keen.solar.power.fronius;
+package org.keen.solar.string.fronius;
 
 import com.fasterxml.jackson.core.JsonParser;
 import com.fasterxml.jackson.databind.DeserializationContext;
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.deser.std.StdDeserializer;
-import org.keen.solar.power.domain.StringPower;
-import org.keen.solar.power.domain.StringPowers;
+import org.keen.solar.string.domain.StringPower;
+import org.keen.solar.string.domain.StringPowers;
 
 import java.io.IOException;
 import java.time.OffsetDateTime;

src/main/java/org/keen/solar/string/package-info.java

@@ -0,0 +1,8 @@
+/**
+ * This package provides functionality to retrieve and persist power generation
+ * per "string" of panels attached to an inverter.<br/>
+ * A string of solar panels is formed when multiple panels are connected
+ * together in series and then connected into the string inverter.
+ * String inverters can support multiple strings.
+ */
+package org.keen.solar.string;

src/main/java/org/keen/solar/power/dal/CurrentPowerRepository.java → src/main/java/org/keen/solar/system/dal/CurrentPowerRepository.java

@@ -1,6 +1,6 @@
-package org.keen.solar.power.dal;
+package org.keen.solar.system.dal;
 
-import org.keen.solar.power.domain.CurrentPower;
+import org.keen.solar.system.domain.CurrentPower;
 import org.springframework.data.repository.CrudRepository;
 
 import java.util.List;

src/main/java/org/keen/solar/system/dal/package-info.java

@@ -0,0 +1,2 @@
+@org.springframework.modulith.NamedInterface("dal")
+package org.keen.solar.system.dal;

src/main/java/org/keen/solar/power/domain/CurrentPower.java → src/main/java/org/keen/solar/system/domain/CurrentPower.java

@@ -1,7 +1,7 @@
-package org.keen.solar.power.domain;
+package org.keen.solar.system.domain;
 
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
-import org.keen.solar.power.fronius.GetPowerFlowRealtimeDataDeserializer;
+import org.keen.solar.system.fronius.GetPowerFlowRealtimeDataDeserializer;
 import org.springframework.data.annotation.Id;
 
 /**

src/main/java/org/keen/solar/system/domain/package-info.java

@@ -0,0 +1,2 @@
+@org.springframework.modulith.NamedInterface("domain")
+package org.keen.solar.system.domain;

src/main/java/org/keen/solar/config/ApplicationConfiguration.java → src/main/java/org/keen/solar/system/fronius/CurrentPowerConfiguration.java

@@ -1,7 +1,5 @@
-package org.keen.solar.config;
+package org.keen.solar.system.fronius;
 
-import org.keen.solar.power.fronius.CurrentPowerPersister;
-import org.keen.solar.power.fronius.StringPowerPersister;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.scheduling.annotation.EnableAsync;
@@ -10,15 +8,11 @@
 @Configuration
 @EnableScheduling
 @EnableAsync
-public class ApplicationConfiguration {
+public class CurrentPowerConfiguration {
 
     @Bean
     public CurrentPowerPersister currentPowerPersister() {
         return new CurrentPowerPersister();
     }
 
-    @Bean
-    public StringPowerPersister stringPowerPersister() {
-        return new StringPowerPersister();
-    }
 }

src/main/java/org/keen/solar/power/fronius/CurrentPowerPersister.java → src/main/java/org/keen/solar/system/fronius/CurrentPowerPersister.java

@@ -1,6 +1,6 @@
-package org.keen.solar.power.fronius;
+package org.keen.solar.system.fronius;
 
-import org.keen.solar.power.dal.CurrentPowerRepository;
+import org.keen.solar.system.dal.CurrentPowerRepository;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.scheduling.annotation.Async;
 import org.springframework.scheduling.annotation.Scheduled;