116 java9 module support (#141)

* Add module-info for annotation and processor
* Add module descriptor to released jars
* Test jpms in ci and update docs

Author: cuzfrog

.github/workflows/ci.yaml

@@ -44,8 +44,10 @@ jobs:
         with:
           path: ~/.m2/repository
           key: build_maven
-      - name: Build
+      - name: Build And Test
         run: ./mvnw install -e --ntp -B
+      - name: Test JPMS
+        run: ./mvnw clean verify -pl it/java8 -P it-jpms -e --ntp -B
       - name: Javadoc
         run: ./mvnw -P release javadoc:javadoc --ntp -B
       - name: Upload generated sources

README.md

@@ -36,11 +36,11 @@ pub struct User {
 ```
 
 ## Features
-* Java8 support.
+* Java8 compatible; Java 9 module (Jigsaw) compatible.
 * Generics support.
-* Constant support.
+* Compile-time constant support.
 * Client source dependency is only `@SharedType` retained at source code level.
-* SharedType AP has only 2 small dependencies: jsr305 annotations and [mustache](https://github.com/spullara/mustache.java).
+* SharedType annotation processor has only 1 dependency: [mustache](https://github.com/spullara/mustache.java).
 * Parsing takes milliseconds with `-proc:only`.
 * Intuitive defaults, put `@SharedType` and there you go. Global + class level options.
 

annotation/pom.xml

@@ -14,4 +14,32 @@
     <description>
         SharedType is an annotation processor to generate type information from Java source code into different target languages or schemas.
     </description>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-compiler-plugin</artifactId>
+                <executions>
+                    <execution>
+                        <id>default-compile</id>
+                        <configuration>
+                            <release>9</release>
+                        </configuration>
+                    </execution>
+                    <execution>
+                        <id>base-compile</id>
+                        <goals>
+                            <goal>compile</goal>
+                        </goals>
+                        <configuration>
+                            <excludes>
+                                <exclude>module-info.java</exclude>
+                            </excludes>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
+        </plugins>
+    </build>
 </project>

annotation/src/main/java/module-info.java

@@ -0,0 +1,4 @@
+module online.sharedtype.annotation {
+    exports online.sharedtype;
+    requires java.base;
+}

doc/Development.md

@@ -29,11 +29,14 @@ Optionally mount tmpfs to save your disk by:
 ```
 Optionally setup `MVND_HOME` to use [maven daemon](https://github.com/apache/maven-mvnd) by `./mvnd`
 
+Choose maven profiles in IDE accordingly as below.
+
 ### Maven profiles
 * `dev` and `release` - control whether to include test maven modules during build.
 * `it` - enable integration test profile. `internal` folder is shared source between `processor` and `it`,
 IDE may not able to properly resolve classes in `internal` folder for both modules.
 Enable this profile to enable `it` modules in IDE, and disable it when developing against `processor` module.
+* `it-no-jpms` and `it-jpms` - control whether to enable Java 9 Jigsaw module test in `it`. `it/java8` sources are reused to test on jdk9. Turn on `it-jpms` for IDE to correctly resolve `it/java8` classes.
 
 ## Development
 ### Run test
@@ -53,6 +56,11 @@ Setup `JAVA8_HOME` to point to your Java8 installation. Open a new terminal and
 . setenv 8
 ./mvnw verify -pl it/java8
 ```
+#### Verify JDK9 JPMS compatibility locally:
+```bash
+./mvnw verify -pl it/java8 -P it-jpms
+```
+
 #### Run client tests locally:
 Client tests are run in target languages in respective dir inside `./client-test`. They do basic type checking.
 * Typescript - `. setenv && npm i && npm run test`

internal/src/main/java/online/sharedtype/processor/domain/MappableType.java

@@ -2,7 +2,7 @@
 
 import online.sharedtype.SharedType;
 
-import javax.annotation.Nullable;
+import online.sharedtype.processor.support.annotation.Nullable;
 
 public interface MappableType {
     String qualifiedName();

internal/src/main/java/online/sharedtype/processor/domain/type/ConcreteTypeInfo.java

@@ -8,7 +8,7 @@
 import online.sharedtype.processor.domain.MappableType;
 import online.sharedtype.processor.domain.def.TypeDef;
 
-import javax.annotation.Nullable;
+import online.sharedtype.processor.support.annotation.Nullable;
 import java.util.Collections;
 import java.util.EnumMap;
 import java.util.List;

internal/src/main/java/online/sharedtype/processor/domain/type/DateTimeInfo.java

@@ -5,7 +5,7 @@
 import online.sharedtype.SharedType;
 import online.sharedtype.processor.domain.MappableType;
 
-import javax.annotation.Nullable;
+import online.sharedtype.processor.support.annotation.Nullable;
 import java.util.EnumMap;
 import java.util.Map;
 

internal/src/main/java/online/sharedtype/processor/domain/type/NoTypeInfo.java

@@ -0,0 +1,19 @@
+package online.sharedtype.processor.domain.type;
+
+import online.sharedtype.processor.domain.def.TypeDef;
+
+/**
+ * Present no type info.
+ * @see online.sharedtype.processor.parser.type.TypeInfoParser
+ * @author Cause Chung
+ */
+final class NoTypeInfo implements TypeInfo {
+    private static final long serialVersionUID = 1773678739237108430L;
+
+    static final NoTypeInfo INSTANCE = new NoTypeInfo();
+    private NoTypeInfo() {}
+
+    @Override
+    public void addReferencingType(TypeDef typeDef) {
+    }
+}

internal/src/main/java/online/sharedtype/processor/domain/type/TypeInfo.java

@@ -31,6 +31,7 @@ default boolean resolved() {
 
     /**
      * Replace type variables with type arguments.
+     *
      * @param mappings key is a type variable e.g. T
      *                 value is a type argument, a concrete type e.g. Integer, or a generic type with concrete type parameter, e.g. {@code Tuple<String, String>}
      * @return a newly created type info if updated.
@@ -41,7 +42,14 @@ default TypeInfo reify(Map<TypeVariableInfo, TypeInfo> mappings) {
 
     /**
      * Mark this type as referenced by another type. Used for e.g. cyclic reference detection.
+     *
      * @param typeDef type that references this type
      */
     void addReferencingType(TypeDef typeDef);
+
+    /**
+     * Represents no type. This can happen when a type is not visible, e.g. not on module path.
+     * @see online.sharedtype.processor.parser.type.TypeInfoParser
+     */
+    TypeInfo NO_TYPE_INFO = NoTypeInfo.INSTANCE;
 }