diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..3284ae1 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,7 @@ +version: 2 +updates: + # Maintain dependencies for GitHub Actions + - package-ecosystem: github-actions + directory: / + schedule: + interval: daily \ No newline at end of file diff --git a/.github/workflows/gradle.yml b/.github/workflows/gradle.yml new file mode 100644 index 0000000..58fff25 --- /dev/null +++ b/.github/workflows/gradle.yml @@ -0,0 +1,35 @@ +# This workflow will build a Java project with Gradle +# For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-gradle + +name: Java CI with Gradle + +on: + push: + branches: + - master + tags: + - '*' + +jobs: + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - name: Import GPG + id: import_gpg + uses: crazy-max/ghaction-import-gpg@v2.2.0 + env: + GPG_PRIVATE_KEY: ${{ secrets.GPG_PRIVATE_KEY }} + - uses: actions/setup-java@v1 + with: + java-version: 8 + - name: build + run: ./gradlew check + - name: publish + if: ${{ contains(github.ref, 'refs/tags/') }} + run: ./gradlew publish + env: + ORG_GRADLE_PROJECT_OSSRHUsername: ${{ secrets.OSSRH_USERNAME }} + ORG_GRADLE_PROJECT_OSSRHPassword: ${{ secrets.OSSRH_TOKEN }} + ORG_GRADLE_PROJECT_GitHubPackagesUsername: ${{ secrets.GITHUB_ACTOR }} + ORG_GRADLE_PROJECT_GitHubPackagesPassword: ${{ secrets.GITHUB_TOKEN }} diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..9f2a078 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +build/ +.gradle/ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + 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 + + http://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. diff --git a/README.adoc b/README.adoc new file mode 100644 index 0000000..cccf9d6 --- /dev/null +++ b/README.adoc @@ -0,0 +1,86 @@ += `spring-factory` + +:icons: font + +Manage your spring factories (`META-INF/spring.factories`) by annotation much like `link:https://github.com/google/auto/tree/master/service[AutoService]` does for `META-INF/services`. + +* @SpringFactory accepts multiple classes +* link:https://docs.gradle.org/current/userguide/java_plugin.html#sec:incremental_annotation_processing[Gradle incremental annotation processing] supported +* Separate artifacts for annotation processor and annotations +* Bill of Materials artifact included + +== Gradle Dependency + +image:https://img.shields.io/maven-central/v/io.github.joke.spring-factory/bom?label=latest%20version[link=https://search.maven.org/artifact/io.github.joke.spring-factory] + +[source,groovy] +---- +dependencies { + annotationProcessor platform('io.github.joke.spring-factory:bom:1.0.0') + annotationProcessor 'io.github.joke.spring-factory:processor' + + compileOnly platform('io.github.joke.spring-factory:bom:1.0.0') + compileOnly 'io.github.joke.spring-factory:annotations' +} +---- + +== Maven Dependency + +.pom.xml +[source,xml] +---- + + + + io.github.joke.spring-factory + annotations + 1.0.0 + + + + + org.apache.maven.plugins + maven-compiler-plugin + 3.8.1 + + 1.8 + 1.8 + + + io.github.joke.spring-factory + processor + 1.0.0 + + + + + + +---- + +== Usage + +Manage your Spring auto `META-INF/spring.factories` by annotation. +Simply annotate your classes and let the annotation processor do the rest. + +This works in the same fashion as `link:https://github.com/google/auto/tree/master/service[AutoService]` +but for Spring's factory meta files. + +[source,java] +---- +@SpringFactory(EnableAutoConfiguration.class) +public class MyAutoConfiguration {} + +@SpringFactory({EnableAutoConfiguration.class, AutoConfigureDataMongo.class}) +public class MyMongoAutoConfiguration {} +---- + +[source,properties] +---- +org.springframework.boot.autoconfigure.EnableAutoConfiguration=\ +package.name.of.first.class.MyAutoConfiguration,\ +package.name.of.second.class.MyMongoAutoConfiguration +org.springframework.boot.test.autoconfigure.data.mongo.AutoConfigureDataMongo=\ +package.name.of.second.class.MyMongoAutoConfiguration +---- + diff --git a/annotations/build.gradle b/annotations/build.gradle new file mode 100644 index 0000000..8cd5bed --- /dev/null +++ b/annotations/build.gradle @@ -0,0 +1,15 @@ +plugins { + id 'java-library' + id 'maven-publish' +} + +dependencies { +} + +publishing { + publications { + annotations(MavenPublication) { + from components.java + } + } +} \ No newline at end of file diff --git a/annotations/src/main/java/io/github/joke/springfactory/SpringFactory.java b/annotations/src/main/java/io/github/joke/springfactory/SpringFactory.java new file mode 100644 index 0000000..a87a784 --- /dev/null +++ b/annotations/src/main/java/io/github/joke/springfactory/SpringFactory.java @@ -0,0 +1,24 @@ +package io.github.joke.springfactory; + +import java.lang.annotation.Retention; +import java.lang.annotation.Target; + +import static java.lang.annotation.ElementType.TYPE; +import static java.lang.annotation.RetentionPolicy.CLASS; + +/** + * Annotation for spring factories. + *

+ * Annotate your spring factories and the annotation processor will + * generate the the META-INF/spring.factories file. + */ +@Target(TYPE) +@Retention(CLASS) +public @interface SpringFactory { + + /** + * @return List of interfaces implemented by this spring factory. + */ + Class[] value(); + +} \ No newline at end of file diff --git a/annotations/src/test/build.gradle b/annotations/src/test/build.gradle new file mode 100644 index 0000000..2feee8d --- /dev/null +++ b/annotations/src/test/build.gradle @@ -0,0 +1,11 @@ +plugins { + id 'java' +} + +dependencies { + annotationProcessor project(':spring-factory') + + compileOnly project(':spring-factory-annotations') + + testImplementation 'org.junit.jupiter:junit-jupiter-api:5.6.2' +} diff --git a/bom/build.gradle b/bom/build.gradle new file mode 100644 index 0000000..c296aca --- /dev/null +++ b/bom/build.gradle @@ -0,0 +1,23 @@ +plugins { + id 'java-platform' + id 'maven-publish' +} + +javaPlatform { + allowDependencies() +} + +dependencies { + constraints { + api project(':processor') + api project(':annotations') + } +} + +publishing { + publications { + bom(MavenPublication) { + from components.javaPlatform + } + } +} \ No newline at end of file diff --git a/build.gradle b/build.gradle new file mode 100644 index 0000000..75be140 --- /dev/null +++ b/build.gradle @@ -0,0 +1,90 @@ +plugins { + id 'idea' + id 'io.freefair.git-version' version '5.1.1' +} + +allprojects { project -> + group 'io.github.joke.spring-factory' + description 'annotation processor for spring factories' + version '1.0.0' + + repositories { + mavenCentral() + } + + plugins.withType(JavaBasePlugin) { + sourceCompatibility = JavaVersion.VERSION_1_8 + targetCompatibility = JavaVersion.VERSION_1_8 + } + + plugins.withType(MavenPublishPlugin) { + project.plugins.apply 'signing' + + plugins.withType(JavaPlugin) { + java { + withJavadocJar() + withSourcesJar() + } + } + + plugins.withType(SigningPlugin) { + afterEvaluate { + signing { + required { + gradle.taskGraph.hasTask('publish') + } + useGpgCmd() + sign publishing.publications + } + } + } + + publishing { + repositories { + maven { + name = 'OSSRH' + url = 'https://oss.sonatype.org/service/local/staging/deploy/maven2/' + credentials(PasswordCredentials) + } + maven { + name = 'GitHubPackages' + url = uri('https://maven.pkg.github.com/joke/spring-factory') + credentials(PasswordCredentials) + } + } + afterEvaluate { + tasks.withType(AbstractPublishToMaven)*.dependsOn(check) + publications.each { publication -> + publication.pom { + name = project.name + description = project.description + url = "https://github.com/joke/${project.name}" + licenses { + license { + name = 'Apache License, Version 2.0' + url = 'https://www.apache.org/licenses/LICENSE-2.0' + } + } + developers { + developer { + id = 'joke' + name = 'Joke de Buhr' + email = 'joke@seiken.de' + } + } + scm { + connection = "scm:git:git://github.com/joke/${project.name}.git" + developerConnection = "scm:git:git://github.com/joke/${project.name}.git" + url = "http://github.com/joke/${project.name}/tree/master" + } + } + } + } + } + } +} + +wrapper { + distributionType = Wrapper.DistributionType.ALL + gradleVersion = '6.6.1' +} \ No newline at end of file diff --git a/dependencies/build.gradle b/dependencies/build.gradle new file mode 100644 index 0000000..1fcf5d6 --- /dev/null +++ b/dependencies/build.gradle @@ -0,0 +1,16 @@ +plugins { + id 'java-platform' +} + +javaPlatform { + allowDependencies() +} + +dependencies { + constraints { + api 'com.google.auto.service:auto-service-annotations:1.0-rc7' + api 'com.google.auto.service:auto-service:1.0-rc7' + api 'commons-io:commons-io:2.7' + api 'org.junit.jupiter:junit-jupiter:5.6.2' + } +} diff --git a/gradle.properties b/gradle.properties new file mode 100644 index 0000000..98d2d90 --- /dev/null +++ b/gradle.properties @@ -0,0 +1,5 @@ +signing.gnupg.keyName=0x86AA80787A77AAD9 +OSSRHUsername= +OSSRHPassword= +GitHubPackagesUsername= +GitHubPackagesPassword= \ No newline at end of file diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..e708b1c Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..33682bb --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,5 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-6.6.1-all.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100755 index 0000000..4f906e0 --- /dev/null +++ b/gradlew @@ -0,0 +1,185 @@ +#!/usr/bin/env sh + +# +# Copyright 2015 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. +# + +############################################################################## +## +## Gradle start up script for UN*X +## +############################################################################## + +# Attempt to set APP_HOME +# Resolve links: $0 may be a link +PRG="$0" +# Need this for relative symlinks. +while [ -h "$PRG" ] ; do + ls=`ls -ld "$PRG"` + link=`expr "$ls" : '.*-> \(.*\)$'` + if expr "$link" : '/.*' > /dev/null; then + PRG="$link" + else + PRG=`dirname "$PRG"`"/$link" + fi +done +SAVED="`pwd`" +cd "`dirname \"$PRG\"`/" >/dev/null +APP_HOME="`pwd -P`" +cd "$SAVED" >/dev/null + +APP_NAME="Gradle" +APP_BASE_NAME=`basename "$0"` + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD="maximum" + +warn () { + echo "$*" +} + +die () { + echo + echo "$*" + echo + exit 1 +} + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "`uname`" in + CYGWIN* ) + cygwin=true + ;; + Darwin* ) + darwin=true + ;; + MINGW* ) + msys=true + ;; + NONSTOP* ) + nonstop=true + ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD="$JAVA_HOME/jre/sh/java" + else + JAVACMD="$JAVA_HOME/bin/java" + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD="java" + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then + MAX_FD_LIMIT=`ulimit -H -n` + if [ $? -eq 0 ] ; then + if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then + MAX_FD="$MAX_FD_LIMIT" + fi + ulimit -n $MAX_FD + if [ $? -ne 0 ] ; then + warn "Could not set maximum file descriptor limit: $MAX_FD" + fi + else + warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" + fi +fi + +# For Darwin, add options to specify how the application appears in the dock +if $darwin; then + GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" +fi + +# For Cygwin or MSYS, switch paths to Windows format before running java +if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then + APP_HOME=`cygpath --path --mixed "$APP_HOME"` + CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` + + JAVACMD=`cygpath --unix "$JAVACMD"` + + # We build the pattern for arguments to be converted via cygpath + ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` + SEP="" + for dir in $ROOTDIRSRAW ; do + ROOTDIRS="$ROOTDIRS$SEP$dir" + SEP="|" + done + OURCYGPATTERN="(^($ROOTDIRS))" + # Add a user-defined pattern to the cygpath arguments + if [ "$GRADLE_CYGPATTERN" != "" ] ; then + OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" + fi + # Now convert the arguments - kludge to limit ourselves to /bin/sh + i=0 + for arg in "$@" ; do + CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` + CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option + + if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition + eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` + else + eval `echo args$i`="\"$arg\"" + fi + i=`expr $i + 1` + done + case $i in + 0) set -- ;; + 1) set -- "$args0" ;; + 2) set -- "$args0" "$args1" ;; + 3) set -- "$args0" "$args1" "$args2" ;; + 4) set -- "$args0" "$args1" "$args2" "$args3" ;; + 5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; + 6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; + 7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; + 8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; + 9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; + esac +fi + +# Escape application args +save () { + for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done + echo " " +} +APP_ARGS=`save "$@"` + +# Collect all arguments for the java command, following the shell quoting and substitution rules +eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..ac1b06f --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,89 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%" == "" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/processor/build.gradle b/processor/build.gradle new file mode 100644 index 0000000..6a8c74f --- /dev/null +++ b/processor/build.gradle @@ -0,0 +1,22 @@ +plugins { + id 'java' + id 'maven-publish' +} + +dependencies { + annotationProcessor platform(project(':dependencies')) + annotationProcessor 'com.google.auto.service:auto-service' + + compileOnly platform(project(':dependencies')) + compileOnly 'com.google.auto.service:auto-service-annotations' + + implementation project(':annotations') +} + +publishing { + publications { + processor(MavenPublication) { + from components.java + } + } +} \ No newline at end of file diff --git a/processor/src/main/java/io/github/joke/springfactory/SpringFactoryProcessor.java b/processor/src/main/java/io/github/joke/springfactory/SpringFactoryProcessor.java new file mode 100644 index 0000000..a0c708f --- /dev/null +++ b/processor/src/main/java/io/github/joke/springfactory/SpringFactoryProcessor.java @@ -0,0 +1,105 @@ +package io.github.joke.springfactory; + +import com.google.auto.service.AutoService; + +import javax.annotation.processing.AbstractProcessor; +import javax.annotation.processing.ProcessingEnvironment; +import javax.annotation.processing.Processor; +import javax.annotation.processing.RoundEnvironment; +import javax.lang.model.SourceVersion; +import javax.lang.model.element.Element; +import javax.lang.model.element.TypeElement; +import javax.lang.model.type.MirroredTypesException; +import javax.lang.model.type.TypeMirror; +import javax.tools.FileObject; +import java.io.IOException; +import java.io.OutputStream; +import java.io.PrintStream; +import java.util.AbstractMap.SimpleEntry; +import java.util.Collection; +import java.util.HashMap; +import java.util.HashSet; +import java.util.Map; +import java.util.Set; +import java.util.stream.Stream; + +import static java.lang.String.join; +import static java.lang.System.lineSeparator; +import static java.nio.charset.StandardCharsets.UTF_8; +import static java.util.Collections.singleton; +import static javax.lang.model.SourceVersion.RELEASE_8; +import static javax.tools.StandardLocation.CLASS_OUTPUT; + +@AutoService(Processor.class) +public class SpringFactoryProcessor extends AbstractProcessor { + + final Set originatingElements = new HashSet<>(); + final Map> factories = new HashMap<>(); + + @Override + public synchronized void init(ProcessingEnvironment processingEnv) { + super.init(processingEnv); + } + + @Override + public boolean process(final Set annotations, final RoundEnvironment roundEnv) { + processAnnotations(annotations, roundEnv); + if (roundEnv.processingOver()) { + try { + writeSpringFactoriesFile(); + } catch (Exception e) { + throw new IllegalStateException("Failed to write spring.factories", e); + } + } + + return true; + } + + private void processAnnotations(final Set annotations, final RoundEnvironment roundEnv) { + annotations.stream() + .map(roundEnv::getElementsAnnotatedWith) + .flatMap(Collection::stream) + .peek(originatingElements::add) + .flatMap(SpringFactoryProcessor::streamOfFactoryToClassName) + .forEach(entry -> factories.computeIfAbsent(entry.getKey(), (ignored) -> new HashSet<>()).add(entry.getValue())); + } + + private void writeSpringFactoriesFile() throws IOException { + final Element[] elements = new Element[originatingElements.size()]; + originatingElements.toArray(elements); + final FileObject resource = processingEnv.getFiler().createResource(CLASS_OUTPUT, "", "META-INF/spring.factories", elements); + try (final OutputStream output = resource.openOutputStream(); final PrintStream printStream = new PrintStream(output, false, UTF_8.name())) { + factories.forEach((k, v) -> { + printStream.println(k + "=\\"); + printStream.println(join(",\\" + lineSeparator(), v)); + }); + } + } + + @Override + public Set getSupportedAnnotationTypes() { + return singleton(SpringFactory.class.getCanonicalName()); + } + + @Override + public SourceVersion getSupportedSourceVersion() { + return RELEASE_8; + } + + private static Stream> streamOfFactoryToClassName(final Element element) { + return SpringFactoryProcessor.getException(element.getAnnotation(SpringFactory.class)::value) + .getTypeMirrors().stream() + .map(TypeMirror::toString) + .map(valueClassName -> new SimpleEntry<>(valueClassName, element.toString())); + } + + @SuppressWarnings("unchecked") + private static T getException(final Runnable runnable) { + try { + runnable.run(); + } catch (Exception e) { + return (T) e; + } + throw new UnsupportedOperationException(); + } +} \ No newline at end of file diff --git a/processor/src/main/resources/META-INF/gradle/incremental.annotation.processors b/processor/src/main/resources/META-INF/gradle/incremental.annotation.processors new file mode 100644 index 0000000..0ed6c6f --- /dev/null +++ b/processor/src/main/resources/META-INF/gradle/incremental.annotation.processors @@ -0,0 +1 @@ +io.github.joke.springfactory.SpringFactoryProcessor,aggregating \ No newline at end of file diff --git a/processor/src/test/java/io/github/joke/springfactory/SpringFactoryProcessorTest.java b/processor/src/test/java/io/github/joke/springfactory/SpringFactoryProcessorTest.java new file mode 100644 index 0000000..1d15c65 --- /dev/null +++ b/processor/src/test/java/io/github/joke/springfactory/SpringFactoryProcessorTest.java @@ -0,0 +1,5 @@ +package io.github.joke.springfactory; + +public class SpringFactoryProcessorTest { + +} \ No newline at end of file diff --git a/settings.gradle b/settings.gradle new file mode 100644 index 0000000..c722ccd --- /dev/null +++ b/settings.gradle @@ -0,0 +1,7 @@ +rootProject.name = 'spring-factory' + +include 'annotations' +include 'bom' +include 'dependencies' +include 'processor' +include 'test' diff --git a/test/build.gradle b/test/build.gradle new file mode 100644 index 0000000..7d469e2 --- /dev/null +++ b/test/build.gradle @@ -0,0 +1,17 @@ +plugins { + id 'java' +} + +dependencies { + annotationProcessor project(':processor') + + compileOnly project(':annotations') + + testImplementation platform(project(':dependencies')) + testImplementation 'org.junit.jupiter:junit-jupiter' + testImplementation 'commons-io:commons-io' +} + +test { + useJUnitPlatform() +} \ No newline at end of file diff --git a/test/src/main/java/io/github/joke/springfactory/FactoryWithNoAnnotation.java b/test/src/main/java/io/github/joke/springfactory/FactoryWithNoAnnotation.java new file mode 100644 index 0000000..c8d2466 --- /dev/null +++ b/test/src/main/java/io/github/joke/springfactory/FactoryWithNoAnnotation.java @@ -0,0 +1,4 @@ +package io.github.joke.springfactory; + +public class FactoryWithNoAnnotation { +} diff --git a/test/src/main/java/io/github/joke/springfactory/FactoryWithOneAnnotation.java b/test/src/main/java/io/github/joke/springfactory/FactoryWithOneAnnotation.java new file mode 100644 index 0000000..2abd4ab --- /dev/null +++ b/test/src/main/java/io/github/joke/springfactory/FactoryWithOneAnnotation.java @@ -0,0 +1,5 @@ +package io.github.joke.springfactory; + +@SpringFactory(Integer.class) +public class FactoryWithOneAnnotation { +} diff --git a/test/src/main/java/io/github/joke/springfactory/FactoryWithTwoAnnotations.java b/test/src/main/java/io/github/joke/springfactory/FactoryWithTwoAnnotations.java new file mode 100644 index 0000000..0e471a9 --- /dev/null +++ b/test/src/main/java/io/github/joke/springfactory/FactoryWithTwoAnnotations.java @@ -0,0 +1,5 @@ +package io.github.joke.springfactory; + +@SpringFactory({Integer.class, String.class}) +public class FactoryWithTwoAnnotations { +} diff --git a/test/src/test/java/io/github/joke/springfactory/SpringFactoryProcessorTest.java b/test/src/test/java/io/github/joke/springfactory/SpringFactoryProcessorTest.java new file mode 100644 index 0000000..346b7d7 --- /dev/null +++ b/test/src/test/java/io/github/joke/springfactory/SpringFactoryProcessorTest.java @@ -0,0 +1,22 @@ +package io.github.joke.springfactory; + +import org.junit.jupiter.api.Test; + +import java.io.IOException; +import java.util.Properties; + +import static org.apache.commons.io.IOUtils.resourceToURL; +import static org.junit.jupiter.api.Assertions.assertEquals; + +public class SpringFactoryProcessorTest { + + @Test + void checkSpringFactories() throws IOException { + final Properties springFactories = new Properties(); + springFactories.load(resourceToURL("/META-INF/spring.factories").openStream()); + + assertEquals(springFactories.getProperty("java.lang.Integer"), "io.github.joke.springfactory.FactoryWithOneAnnotation,io.github.joke.springfactory.FactoryWithTwoAnnotations"); + assertEquals(springFactories.getProperty("java.lang.String"), "io.github.joke.springfactory.FactoryWithTwoAnnotations"); + } + +} \ No newline at end of file