Tests (#20)

Add test coverage + more unit tests

Author: kylepls

.travis.yml

@@ -18,3 +18,5 @@ deploy:
   name: $project_version
 install:
   mvn --settings .maven.xml clean install -DskipTests=true -Dgpg.skip -Dmaven.javadoc.skip=true -B -V
+after_success:
+  - mvn clean test jacoco:report coveralls:report

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Kyle
+
+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

@@ -1,4 +1,4 @@
-# mcspring [![Build Status](https://travis-ci.org/kylepls/mcspring.svg?branch=master)](https://travis-ci.org/kylepls/mcspring) ![Maven Central](https://img.shields.io/maven-central/v/in.kyle.mcspring/mcspring)
+# mcspring [![Build Status](https://travis-ci.org/kylepls/mcspring.svg?branch=master)](https://travis-ci.org/kylepls/mcspring) ![Maven Central](https://img.shields.io/maven-central/v/in.kyle.mcspring/mcspring-starter) [![Coverage Status](https://coveralls.io/repos/github/kylepls/mcspring/badge.svg)](https://coveralls.io/github/kylepls/mcspring)
 
 Writing Bukkit plugins is a nightmare. I often lay awake in my bed late at night unable to sleep
  because Bukkit made events an annotation but commands are created by implementing a class. 

mcspring-api/mcspring-base/pom.xml

@@ -33,6 +33,10 @@
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-loader</artifactId>
         </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-aop</artifactId>
+        </dependency>
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter</artifactId>
@@ -50,17 +54,13 @@
             <scope>provided</scope>
         </dependency>
         <dependency>
-            <groupId>org.springframework.boot</groupId>
-            <artifactId>spring-boot-starter-aop</artifactId>
+            <groupId>org.projectlombok</groupId>
+            <artifactId>lombok</artifactId>
         </dependency>
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-test</artifactId>
             <scope>test</scope>
         </dependency>
-        <dependency>
-            <groupId>org.projectlombok</groupId>
-            <artifactId>lombok</artifactId>
-        </dependency>
     </dependencies>
 </project>

mcspring-api/mcspring-base/src/main/java/in/kyle/mcspring/RequiresSpigot.java

@@ -0,0 +1,14 @@
+package in.kyle.mcspring;
+
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+@Target(ElementType.TYPE)
+@Retention(RetentionPolicy.RUNTIME)
+@ConditionalOnProperty("spigot.plugin")
+public @interface RequiresSpigot {
+}

mcspring-api/mcspring-base/src/main/java/in/kyle/mcspring/SpringPlugin.java

@@ -10,7 +10,6 @@
 import org.springframework.core.io.DefaultResourceLoader;
 import org.springframework.core.io.ResourceLoader;
 
-import java.util.Arrays;
 import java.util.LinkedHashMap;
 import java.util.Map;
 
@@ -26,20 +25,6 @@ public class SpringPlugin {
     @Getter
     private ConfigurableApplicationContext context;
 
-    public static void setup(Plugin plugin, Class<?> config) {
-        setupLogger();
-        SpringPlugin springPlugin = new SpringPlugin(plugin);
-        springPlugin.initSpring(config);
-        SETUP_PLUGINS.put(plugin, springPlugin);
-    }
-    
-    public static void teardown(Plugin plugin) {
-        SpringPlugin springPlugin = SETUP_PLUGINS.remove(plugin);
-        if (springPlugin != null) {
-            springPlugin.onDisable(plugin);
-        }
-    }
-    
     public final void onDisable(Plugin plugin) {
         if (context != null) {
             context.close();
@@ -50,20 +35,30 @@ public final void onDisable(Plugin plugin) {
 
     private void initSpring(Class<?> config) {
         SpringApplicationBuilder builder = new SpringApplicationBuilder();
-        ClassLoader classLoader = plugin.getClass().getClassLoader();
-        ResourceLoader loader = new DefaultResourceLoader(classLoader);
-        Class<?>[] sources = new Class[]{config, SpringSpigotSupport.class};
         if (!SETUP_PLUGINS.isEmpty()) {
             SpringPlugin parent = findParentCandidate();
             builder.parent(parent.getContext());
-            sources = Arrays.copyOfRange(sources, 0, 1);
         }
-        context = builder.sources(sources)
-                .resourceLoader(loader)
-                .bannerMode(Banner.Mode.OFF)
-                .properties("spigot.plugin=" + plugin.getName())
-                .logStartupInfo(true)
-                .run();
+    
+        ClassLoader classLoader = plugin.getClass().getClassLoader();
+        Class<?>[] sources = new Class[]{config, SpringSpigotSupport.class};
+        ResourceLoader loader = new DefaultResourceLoader(classLoader);
+        
+        runWithContextClassLoader(classLoader, () -> {
+            context = builder.sources(sources)
+                    .resourceLoader(loader)
+                    .bannerMode(Banner.Mode.OFF)
+                    .properties("spigot.plugin=" + plugin.getName())
+                    .logStartupInfo(true)
+                    .run();
+        });
+    }
+    
+    private void runWithContextClassLoader(ClassLoader classLoader, Runnable runnable) {
+        ClassLoader temp = Thread.currentThread().getContextClassLoader();
+        Thread.currentThread().setContextClassLoader(classLoader);
+        runnable.run();
+        Thread.currentThread().setContextClassLoader(temp);
     }
 
     private static void setupLogger() {
@@ -80,4 +75,18 @@ private SpringPlugin findParentCandidate() {
                 .map(Map.Entry::getValue)
                 .orElse(null);
     }
+    
+    public static void setup(Plugin plugin, Class<?> config) {
+        setupLogger();
+        SpringPlugin springPlugin = new SpringPlugin(plugin);
+        springPlugin.initSpring(config);
+        SETUP_PLUGINS.put(plugin, springPlugin);
+    }
+    
+    public static void teardown(Plugin plugin) {
+        SpringPlugin springPlugin = SETUP_PLUGINS.remove(plugin);
+        if (springPlugin != null) {
+            springPlugin.onDisable(plugin);
+        }
+    }
 }

mcspring-api/mcspring-base/src/main/java/in/kyle/mcspring/SpringSpigotSupport.java

@@ -2,6 +2,7 @@
 
 import org.bukkit.Bukkit;
 import org.bukkit.Server;
+import org.bukkit.command.CommandMap;
 import org.bukkit.configuration.file.FileConfiguration;
 import org.bukkit.plugin.Plugin;
 import org.bukkit.plugin.PluginDescriptionFile;
@@ -17,13 +18,15 @@
 import org.springframework.context.annotation.EnableAspectJAutoProxy;
 import org.springframework.scheduling.annotation.EnableScheduling;
 
+import java.lang.reflect.Field;
 import java.util.logging.Logger;
 
 @Configuration
 @ComponentScan(basePackageClasses = SpringPlugin.class)
 @EnableScheduling
 @EnableAspectJAutoProxy
-class SpringSpigotSupport {
+@RequiresSpigot
+public class SpringSpigotSupport {
 
     @Bean
     Plugin plugin(@Value("${spigot.plugin}") String pluginName) {
@@ -74,4 +77,11 @@ BukkitScheduler scheduler(Server server) {
     PluginLoader pluginLoader(Plugin plugin) {
         return plugin.getPluginLoader();
     }
+    
+    @Bean
+    CommandMap getCommandMap(Server server) throws Exception {
+        Field bukkitCommandMap = Bukkit.getServer().getClass().getDeclaredField("commandMap");
+        bukkitCommandMap.setAccessible(true);
+        return (CommandMap) bukkitCommandMap.get(server);
+    }
 }

mcspring-api/mcspring-base/src/main/java/in/kyle/mcspring/command/CommandController.java

@@ -1,6 +1,7 @@
 package in.kyle.mcspring.command;
 
-import org.springframework.context.annotation.Lazy;
+import com.google.common.annotations.VisibleForTesting;
+
 import org.springframework.stereotype.Component;
 import org.springframework.util.ClassUtils;
 
@@ -13,6 +14,7 @@
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
+import in.kyle.mcspring.command.registration.Resolver;
 import lombok.RequiredArgsConstructor;
 import lombok.SneakyThrows;
 import lombok.var;
@@ -21,15 +23,17 @@
  * Used to inject method parameters
  * Does not support annotated parameters
  */
-@Lazy
 @Component
 @RequiredArgsConstructor
 public class SimpleMethodInjection {
 
     private final List<Resolver> resolvers;
 
     @SneakyThrows
-    public Object invoke(Method method, Object object, List<Resolver> resolvers, Object... contextObjects) {
+    public Object invoke(Method method,
+                         Object object,
+                         List<Resolver> resolvers,
+                         Object... contextObjects) {
         Object[] params = getParameters(method, resolvers, contextObjects);
         method.setAccessible(true);
         if (params.length != 0) {
@@ -39,7 +43,8 @@ public Object invoke(Method method, Object object, List<Resolver> resolvers, Obj
         }
     }
 
-    private List<Resolver> makeResolvers(Object... contextObjects) {
+    @VisibleForTesting
+    List<Resolver> makeResolvers(Object... contextObjects) {
         return Stream.of(contextObjects)
                 .filter(Objects::nonNull)
                 .map(o -> (Resolver) parameter -> ClassUtils.isAssignable(parameter.getType(),
@@ -49,17 +54,25 @@ private List<Resolver> makeResolvers(Object... contextObjects) {
                 .collect(Collectors.toList());
     }
 
-    public Object[] getParameters(Method method, List<Resolver> contextResolvers, Object... contextObjects) {
+    public Object[] getParameters(Method method,
+                                  List<Resolver> contextResolvers,
+                                  Object... contextObjects) {
+        List<Resolver> methodResolvers = new ArrayList<>();
+        methodResolvers.addAll(contextResolvers);
+        methodResolvers.addAll(makeResolvers(contextObjects));
+        return getParameters(method, methodResolvers);
+    }
+    
+    public Object[] getParameters(Method method, List<Resolver> contextResolvers) {
         Parameter[] parameters = method.getParameters();
         Object[] params = new Object[parameters.length];
 
         List<Resolver> methodResolvers = new ArrayList<>();
         methodResolvers.addAll(contextResolvers);
-        methodResolvers.addAll(makeResolvers(contextObjects));
         methodResolvers.addAll(resolvers);
         for (int i = 0; i < parameters.length; i++) {
             Parameter parameter = parameters[i];
-    
+            
             for (int j = 0; j < methodResolvers.size(); j++) {
                 Resolver methodResolver = methodResolvers.get(j);
                 Optional<Object> resolved = methodResolver.resolve(parameter);
@@ -70,7 +83,7 @@ public Object[] getParameters(Method method, List<Resolver> contextResolvers, Ob
                     break;
                 }
             }
-    
+            
             if (params[i] == null) {
                 throw new RuntimeException(
                         "Unable to resolve parameter " + parameter.getType() + " for " +

mcspring-api/mcspring-base/src/main/java/in/kyle/mcspring/command/SimpleMethodInjection.java

@@ -0,0 +1,32 @@
+package in.kyle.mcspring.command.injection;
+
+import org.springframework.beans.factory.annotation.Qualifier;
+import org.springframework.context.ApplicationContext;
+import org.springframework.core.annotation.Order;
+import org.springframework.stereotype.Component;
+
+import java.lang.reflect.Parameter;
+import java.util.Optional;
+
+import in.kyle.mcspring.command.registration.Resolver;
+import lombok.RequiredArgsConstructor;
+
+@Order(1)
+@Component
+@RequiredArgsConstructor
+class QualifierResolver implements Resolver {
+    
+    private final ApplicationContext context;
+    
+    @Override
+    public Optional<Object> resolve(Parameter parameter) {
+        Qualifier qualifier = parameter.getAnnotation(Qualifier.class);
+        if (qualifier != null) {
+            Object bean = context.getBean(qualifier.value(), parameter.getType());
+            // spring will error out if mismatched type
+            return Optional.of(bean);
+        } else {
+            return Optional.empty();
+        }
+    }
+}