Readme, license and DependencyGetter

LICENSE.md

@@ -0,0 +1,7 @@
+Copyright 2020 Xavier "jglrxavpok" Niochaut & Minestom Team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,46 @@
+# Dependency-Getter
+Abstraction layer over dependencies.
+Allows downloading artifacts from a coordinate.
+
+This library is centered around resolvers. Resolvers are the objects responsible for finding the dependency
+inside its locations (repositories for Maven, for instance).
+
+Throws an `UnresolvedDependencyException` if the dependency could not be resolved.
+
+# On Maven resolvers
+Maven resolvers will download to the given target folder. They also use this target folder as a local
+maven repository: any already downloaded artifact will not be redownloaded (with the exception of snapshots).
+
+They also create a temporary folder `.tmp` inside the target folder to store a Maven `settings.xml` file to specify
+a local repository and remote repositories.
+
+# Example
+
+## Hello Dependency
+```kotlin
+val dependencyGetter = DependencyGetter()
+    .addResolver(MyResolver())
+    .addMavenResolver(repositories = listOf(
+        MavenRepository.Jitpack,
+        MavenRepository.Central,
+        MavenRepository.JCenter,
+        MavenRepository("Minecraft Libs", "https://libraries.minecraft.net"),
+        MavenRepository("Sponge", "https://repo.spongepowered.org/maven"),
+    ))
+val resolved = dependencyGetter.get("com.github.Minestom:Minestom:32d13dcbd1", targetFolder)
+resolved.printTree()
+```
+
+## Using a Resolver directly
+```kotlin
+val repositories = listOf(
+    MavenRepository.Jitpack,
+    MavenRepository.Central,
+    MavenRepository.JCenter,
+    MavenRepository("Minecraft Libs", "https://libraries.minecraft.net"),
+    MavenRepository("Sponge", "https://repo.spongepowered.org/maven"),
+)
+val resolver = MavenResolver(repositories)
+val resolved = resolver.resolve("com.github.Minestom:Minestom:32d13dcbd1", targetFolder)
+resolved.printTree()
+```

src/main/kotlin/net/minestom/dependencies/DependencyGetter.kt

@@ -0,0 +1,32 @@
+package net.minestom.dependencies
+
+import net.minestom.dependencies.maven.MavenRepository
+import net.minestom.dependencies.maven.MavenResolver
+import java.io.File
+
+class DependencyGetter {
+
+    private val resolverList = mutableListOf<DependencyResolver>()
+    val resolvers: List<DependencyResolver> get()= resolvers
+
+    fun addResolver(resolver: DependencyResolver): DependencyGetter {
+        resolverList += resolver
+        return this
+    }
+
+    /**
+     * Shorthand to add a MavenResolver with the given repositories
+     */
+    fun addMavenResolver(repositories: List<MavenRepository>) = addResolver(MavenResolver(repositories))
+
+    fun get(id: String, targetFolder: File): ResolvedDependency {
+        for(resolver in resolverList) {
+            try {
+                return resolver.resolve(id, targetFolder)
+            } catch (e: UnresolvedDependencyException) {
+                // silence and go to next resolver
+            }
+        }
+        throw UnresolvedDependencyException("Could not find $id inside resolver list: ${resolverList.joinToString { it.toString() }}")
+    }
+}

src/main/kotlin/net/minestom/dependencies/maven/MavenResolver.kt

@@ -3,6 +3,7 @@ package net.minestom.dependencies.maven
 import net.minestom.dependencies.DependencyResolver
 import net.minestom.dependencies.ResolvedDependency
 import net.minestom.dependencies.UnresolvedDependencyException
+import org.jboss.shrinkwrap.resolver.api.CoordinateParseException
 import org.jboss.shrinkwrap.resolver.api.NoResolvedResultException
 import org.jboss.shrinkwrap.resolver.api.maven.Maven
 import org.jboss.shrinkwrap.resolver.api.maven.MavenResolvedArtifact
@@ -13,17 +14,13 @@ import java.util.logging.LogManager
  * Resolves maven dependencies.
  * *Does not use the local maven repository, but uses the folder passed as an argument in resolve(String, File)*
  *
+ * Creates a temporary folder `.tmp` inside the target folder to store a Maven `settings.xml` file to specify
+ * a local repository and remote repositories.
+ *
  * @param repositories list of repositories to use to resolve artifacts
  */
 class MavenResolver(val repositories: List<MavenRepository>): DependencyResolver {
 
-    companion object {
-        init {
-            // prevents ShrinkWrap's resolver's verbose output when trying to find which repository holds an artifact
-            LogManager.getLogManager().readConfiguration(javaClass.getResourceAsStream("/logging.properties"))
-        }
-    }
-
     /**
      * Resolves and downloads maven artifacts related to the given id.
      */
@@ -69,6 +66,8 @@ class MavenResolver(val repositories: List<MavenRepository>): DependencyResolver
             }
             val coords = artifacts[0].coordinate
             return ResolvedDependency(coords.groupId, coords.artifactId, coords.version, artifacts[0].asFile().toURI().toURL(), dependencies)
+        } catch(e: CoordinateParseException) {
+            throw UnresolvedDependencyException("Failed to resolve $id (not a Maven coordinate)", e)
         } catch(e: NoResolvedResultException) {
             throw UnresolvedDependencyException("Failed to resolve $id", e)
         } finally {
@@ -79,4 +78,8 @@ class MavenResolver(val repositories: List<MavenRepository>): DependencyResolver
     private fun convertToDependency(artifact: MavenResolvedArtifact): ResolvedDependency {
         return ResolvedDependency(artifact.coordinate.groupId, artifact.coordinate.artifactId, artifact.coordinate.version, artifact.asFile().toURI().toURL(), emptyList())
     }
+
+    override fun toString(): String {
+        return "MavenResolver[${repositories.joinToString { "${it.name} ${it.url.toExternalForm()}" }}]"
+    }
 }

src/test/kotlin/Tests.kt

@@ -1,3 +1,6 @@
+import net.minestom.dependencies.DependencyGetter
+import net.minestom.dependencies.DependencyResolver
+import net.minestom.dependencies.ResolvedDependency
 import net.minestom.dependencies.UnresolvedDependencyException
 import net.minestom.dependencies.maven.MavenRepository
 import net.minestom.dependencies.maven.MavenResolver
@@ -67,4 +70,28 @@ class Tests {
             val resolved = resolver.resolve("com.google.guava:guava:30.0-jre", targetFolder)
         }
     }
+
+    @Test
+    fun helloDependency() {
+        class MyResolver: DependencyResolver {
+            override fun resolve(id: String, targetFolder: File): ResolvedDependency {
+                throw UnresolvedDependencyException(id)
+            }
+        }
+
+        val dependencyGetter = DependencyGetter()
+            .addResolver(MyResolver())
+            .addMavenResolver(repositories = listOf(
+                MavenRepository.Jitpack,
+                MavenRepository.Central,
+                MavenRepository.JCenter,
+                MavenRepository("Minecraft Libs", "https://libraries.minecraft.net"),
+                MavenRepository("Sponge", "https://repo.spongepowered.org/maven"),
+            ))
+        val resolved = dependencyGetter.get("com.github.Minestom:Minestom:32d13dcbd1", targetFolder)
+        resolved.printTree()
+        assertThrows(UnresolvedDependencyException::class.java) {
+            dependencyGetter.get("somethingthatdoesnotexist.xyz", targetFolder)
+        }
+    }
 }