Merge branch 'develop'

tobiasstamann · tobiasstamann · commit 0255192a66ed · 2022-05-12T03:29:17.000+02:00
diff --git a/README.md b/README.md
@@ -70,6 +70,17 @@ Then add the SpiServiceLocator annotation in it:
 
 The locator will be created in the annotated package. It is named like the SPI suffixed with ServiceLocator (ExampleSpiInterfaceServiceLocator in this example)
 
+To create multiple service locators in the same package use @SpiServiceLocators:
+
+
+    @SpiServiceLocators({
+        @SpiServiceLocator(FirstExampleSpiInterface.class),
+        @SpiServiceLocator(SecondExampleSpiInterface.class),
+    })
+    package your.target.package;
+
+    import io.toolisticon.spiap.api.SpiServiceLocator;
+    import your.spi.package.ExampleSpiInterface;
 
 ## How to register a service implementation
 Just add a Service annotation to your service implementation:
diff --git a/api/pom.xml b/api/pom.xml
@@ -7,7 +7,7 @@
     <parent>
         <groupId>io.toolisticon.spiap</groupId>
         <artifactId>spiap-parent</artifactId>
-        <version>0.8.1</version>
+        <version>0.8.2</version>
     </parent>
 
     <name>spiap-api</name>
diff --git a/api/src/main/java/io/toolisticon/spiap/api/SpiServiceLocators.java b/api/src/main/java/io/toolisticon/spiap/api/SpiServiceLocators.java
@@ -0,0 +1,19 @@
+package io.toolisticon.spiap.api;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Binder for supporting several {@link SpiServiceLocator} in a single class.
+ *
+ * @since 0.8.2
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target(value = {ElementType.PACKAGE})
+public @interface SpiServiceLocators {
+
+    SpiServiceLocator[] value();
+
+}
diff --git a/example/api/pom.xml b/example/api/pom.xml
@@ -8,7 +8,7 @@
     <parent>
         <groupId>io.toolisticon.spiap</groupId>
         <artifactId>example-parent</artifactId>
-        <version>0.8.1</version>
+        <version>0.8.2</version>
     </parent>
 
     <name>example-api</name>
diff --git a/example/pom.xml b/example/pom.xml
@@ -7,7 +7,7 @@
     <parent>
         <groupId>io.toolisticon.spiap</groupId>
         <artifactId>spiap-parent</artifactId>
-        <version>0.8.1</version>
+        <version>0.8.2</version>
     </parent>
 
     <name>example-parent</name>
diff --git a/example/service/pom.xml b/example/service/pom.xml
@@ -8,7 +8,7 @@
     <parent>
         <groupId>io.toolisticon.spiap</groupId>
         <artifactId>example-parent</artifactId>
-        <version>0.8.1</version>
+        <version>0.8.2</version>
     </parent>
 
     <name>example-service</name>
diff --git a/example/usage/pom.xml b/example/usage/pom.xml
@@ -8,7 +8,7 @@
     <parent>
         <groupId>io.toolisticon.spiap</groupId>
         <artifactId>example-parent</artifactId>
-        <version>0.8.1</version>
+        <version>0.8.2</version>
     </parent>
 
     <name>example-usage</name>
diff --git a/integrationTest/baseCode/pom.xml b/integrationTest/baseCode/pom.xml
@@ -8,7 +8,7 @@
     <parent>
         <groupId>io.toolisticon.spiap</groupId>
         <artifactId>integrationTest-parent</artifactId>
-        <version>0.8.1</version>
+        <version>0.8.2</version>
     </parent>
 
     <name>integrationTest-baseCode</name>
diff --git a/integrationTest/pom.xml b/integrationTest/pom.xml
@@ -7,7 +7,7 @@
     <parent>
         <groupId>io.toolisticon.spiap</groupId>
         <artifactId>spiap-parent</artifactId>
-        <version>0.8.1</version>
+        <version>0.8.2</version>
     </parent>
 
     <name>integrationTest</name>
diff --git a/integrationTest/withSpiapApi/pom.xml b/integrationTest/withSpiapApi/pom.xml
@@ -7,7 +7,7 @@
     <parent>
         <groupId>io.toolisticon.spiap</groupId>
         <artifactId>integrationTest-parent</artifactId>
-        <version>0.8.1</version>
+        <version>0.8.2</version>
     </parent>
 
     <name>integrationTest-withSpiapApi</name>
diff --git a/integrationTest/withoutSpiapApi/pom.xml b/integrationTest/withoutSpiapApi/pom.xml
@@ -7,7 +7,7 @@
     <parent>
         <groupId>io.toolisticon.spiap</groupId>
         <artifactId>integrationTest-parent</artifactId>
-        <version>0.8.1</version>
+        <version>0.8.2</version>
     </parent>
 
     <name>integrationTest-withoutSpiapApi</name>
diff --git a/pom.xml b/pom.xml
@@ -4,7 +4,7 @@
 
     <groupId>io.toolisticon.spiap</groupId>
     <artifactId>spiap-parent</artifactId>
-    <version>0.8.1</version>
+    <version>0.8.2</version>
     <packaging>pom</packaging>
 
     <name>spiap-parent</name>
diff --git a/processor/pom.xml b/processor/pom.xml
@@ -8,7 +8,7 @@
     <parent>
         <groupId>io.toolisticon.spiap</groupId>
         <artifactId>spiap-parent</artifactId>
-        <version>0.8.1</version>
+        <version>0.8.2</version>
     </parent>
 
     <name>spiap-processor</name>
diff --git a/processor/src/main/java/io/toolisticon/spiap/processor/SpiProcessor.java b/processor/src/main/java/io/toolisticon/spiap/processor/SpiProcessor.java
@@ -7,13 +7,13 @@
 import io.toolisticon.aptk.tools.generators.SimpleJavaWriter;
 import io.toolisticon.spiap.api.Spi;
 import io.toolisticon.spiap.api.SpiServiceLocator;
+import io.toolisticon.spiap.api.SpiServiceLocators;
 
 import javax.annotation.processing.RoundEnvironment;
 import javax.lang.model.element.Element;
 import javax.lang.model.element.ElementKind;
 import javax.lang.model.element.PackageElement;
 import javax.lang.model.element.TypeElement;
-import javax.lang.model.type.TypeMirror;
 import java.io.IOException;
 import java.util.HashMap;
 import java.util.Map;
@@ -24,7 +24,8 @@
  */
 public class SpiProcessor extends AbstractAnnotationProcessor {
 
-    private final static Set<String> SUPPORTED_ANNOTATIONS = createSupportedAnnotationSet(Spi.class, SpiServiceLocator.class);
+    private final static Set<String> SUPPORTED_ANNOTATIONS =
+        createSupportedAnnotationSet(Spi.class, SpiServiceLocator.class, SpiServiceLocators.class);
 
 
     @Override
@@ -36,7 +37,7 @@ public Set<String> getSupportedAnnotationTypes() {
     public boolean processAnnotations(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
 
         handleSpiAnnotation(roundEnv);
-        handeSpiServiceLocatorAnnotation(roundEnv);
+        handleSpiServiceLocatorAnnotation(roundEnv);
 
         return false;
     }
@@ -57,11 +58,11 @@ private void handleSpiAnnotation(RoundEnvironment roundEnv) {
 
             // Generate service locator depending on settings configured in Spi annotation
             SpiWrapper spiAnnotation = SpiWrapper.wrapAnnotationOfElement(element);
-            if (spiAnnotation.generateServiceLocator()) {
+            if (spiAnnotation != null && spiAnnotation.generateServiceLocator()) {
 
                 // Now create the service locator
                 TypeElement typeElement = ElementUtils.CastElement.castInterface(element);
-                PackageElement packageElement = (PackageElement) ElementUtils.AccessEnclosingElements.getFirstEnclosingElementOfKind(typeElement, ElementKind.PACKAGE);
+                PackageElement packageElement = ElementUtils.AccessEnclosingElements.getFirstEnclosingElementOfKind(typeElement, ElementKind.PACKAGE);
 
                 // generate service locator
                 generateServiceLocator(element, packageElement, typeElement);
@@ -71,43 +72,64 @@ private void handleSpiAnnotation(RoundEnvironment roundEnv) {
 
     }
 
-    private void handeSpiServiceLocatorAnnotation(RoundEnvironment roundEnv) {
+    private void handleSpiServiceLocatorAnnotation(RoundEnvironment roundEnv) {
 
-        // handle Spi annotation
+        // handle SpiServiceLocator annotation
         for (Element element : roundEnv.getElementsAnnotatedWith(SpiServiceLocator.class)) {
 
             MessagerUtils.info(element, "Process : " + element.getSimpleName() + " annotated with SpiServiceLocator annotation");
 
             // get type from annotation
-            SpiServiceLocatorWrapper annotationWrapper =  SpiServiceLocatorWrapper.wrapAnnotationOfElement(element);
-            TypeMirror typeMirror = annotationWrapper.valueAsTypeMirror();
-            if (typeMirror == null) {
-                MessagerUtils.error(element, "Couldn't get type from annotations attributes");
-                continue;
-            }
+            SpiServiceLocatorWrapper spiWrapper =  SpiServiceLocatorWrapper.wrapAnnotationOfElement(element);
+            handleSpiServiceLocationWrapper(spiWrapper, element);
 
-            TypeElement serviceLocatorInterfaceElement = annotationWrapper.valueAsTypeMirrorWrapper().getTypeElement();
+        }
 
-            // check if it is place on interface
-            if (!ElementUtils.CheckKindOfElement.isInterface(serviceLocatorInterfaceElement)) {
-                MessagerUtils.error(element, SpiProcessorMessages.ERROR_SERVICE_LOCATOR_PASSED_SPI_CLASS_MUST_BE_AN_INTERFACE);
+        // handle SpiServiceLocator annotation
+        for (Element element : roundEnv.getElementsAnnotatedWith(SpiServiceLocators.class)) {
+
+            MessagerUtils.info(element, "Process : " + element.getSimpleName() + " annotated with SpiServiceLocator annotation");
+
+            // get type from annotation
+            SpiServiceLocatorsWrapper annotationWrapper = SpiServiceLocatorsWrapper.wrapAnnotationOfElement(element);
+            if (annotationWrapper == null) {
                 continue;
             }
 
+            for (SpiServiceLocatorWrapper spiWrapper : annotationWrapper.value()) {
+                handleSpiServiceLocationWrapper(spiWrapper, element);
+            }
 
-            // Now create the service locator
-            TypeElement typeElement = ElementUtils.CastElement.castInterface(serviceLocatorInterfaceElement);
-            PackageElement packageElement = (PackageElement) element;
+        }
 
+    }
 
-            // generate service locator
-            generateServiceLocator(element, packageElement, typeElement);
+    private void handleSpiServiceLocationWrapper(
+        final SpiServiceLocatorWrapper annotationWrapper, final Element element) {
 
+        if (annotationWrapper == null || annotationWrapper.valueAsTypeMirror() == null) {
+            MessagerUtils.error(element, "Couldn't get type from annotations attributes");
+            return;
         }
 
-    }
+        TypeElement serviceLocatorInterfaceElement = annotationWrapper.valueAsTypeMirrorWrapper().getTypeElement();
+
+        // check if it is place on interface
+        if (!ElementUtils.CheckKindOfElement.isInterface(serviceLocatorInterfaceElement)) {
+            MessagerUtils.error(element, SpiProcessorMessages.ERROR_SERVICE_LOCATOR_PASSED_SPI_CLASS_MUST_BE_AN_INTERFACE);
+            return;
+        }
 
 
+        // Now create the service locator
+        TypeElement typeElement = ElementUtils.CastElement.castInterface(serviceLocatorInterfaceElement);
+        PackageElement packageElement = (PackageElement) element;
+
+
+        // generate service locator
+        generateServiceLocator(element, packageElement, typeElement);
+    }
+
     private void generateServiceLocator(Element annotatedElement, PackageElement packageElement, TypeElement typeElement) {
 
         // create Model
diff --git a/processor/src/main/java/io/toolisticon/spiap/processor/package-info.java b/processor/src/main/java/io/toolisticon/spiap/processor/package-info.java
@@ -1,11 +1,12 @@
 /**
  * This package contains the annotation processors.
  */
-@AnnotationWrapper({Service.class, Services.class, SpiServiceLocator.class, Spi.class})
+@AnnotationWrapper({Service.class, Services.class, SpiServiceLocator.class, SpiServiceLocators.class, Spi.class})
 package io.toolisticon.spiap.processor;
 
 import io.toolisticon.aptk.annotationwrapper.api.AnnotationWrapper;
 import io.toolisticon.spiap.api.Service;
 import io.toolisticon.spiap.api.Services;
 import io.toolisticon.spiap.api.Spi;
-import io.toolisticon.spiap.api.SpiServiceLocator;
+import io.toolisticon.spiap.api.SpiServiceLocator;
+import io.toolisticon.spiap.api.SpiServiceLocators;
diff --git a/processor/src/test/java/io/toolisticon/spiap/processor/SpiServiceLocatorsProcessorTest.java b/processor/src/test/java/io/toolisticon/spiap/processor/SpiServiceLocatorsProcessorTest.java
@@ -0,0 +1,38 @@
+package io.toolisticon.spiap.processor;
+
+import io.toolisticon.aptk.tools.MessagerUtils;
+import io.toolisticon.cute.CompileTestBuilder;
+import io.toolisticon.cute.JavaFileObjectUtils;
+import javax.tools.StandardLocation;
+import org.junit.Before;
+import org.junit.Test;
+
+/**
+ * Tests of {@link SpiProcessor}.
+ */
+
+public class SpiServiceLocatorsProcessorTest {
+
+
+    @Before
+    public void init() {
+        MessagerUtils.setPrintMessageCodes(true);
+    }
+
+    private CompileTestBuilder.CompilationTestBuilder compileTestBuilder = CompileTestBuilder
+            .compilationTest()
+            .addProcessors(SpiProcessor.class);
+
+    @Test
+    public void test_validUsage() {
+
+        compileTestBuilder
+                .addSources("spiprocessor/spiservicelocator/multipleSpiLocators/package-info.java")
+                .compilationShouldSucceed()
+            .expectThatGeneratedSourceFileExists("io.toolisticon.spiap.processor.TestSpiServiceLocator")
+            .expectThatGeneratedSourceFileExists("io.toolisticon.spiap.processor.AnotherTestSpiServiceLocator")
+            .executeTest();
+
+    }
+
+}
diff --git a/processor/src/test/resources/spiprocessor/spiservicelocator/multipleSpiLocators/package-info.java b/processor/src/test/resources/spiprocessor/spiservicelocator/multipleSpiLocators/package-info.java
@@ -0,0 +1,13 @@
+/**
+ * This package contains the annotation processors.
+ */
+@SpiServiceLocators({
+    @SpiServiceLocator(TestSpi.class),
+    @SpiServiceLocator(AnotherTestSpi.class)
+})
+package io.toolisticon.spiap.processor;
+
+import io.toolisticon.spiap.api.SpiServiceLocator;
+import io.toolisticon.spiap.api.SpiServiceLocators;
+import io.toolisticon.spiap.processor.serviceprocessortest.AnotherTestSpi;
+import io.toolisticon.spiap.processor.serviceprocessortest.TestSpi;
