Provoke a more visible and intuitive error if a user tries to use ParameterParser without ANTLR runtime

Author: Vampire

config/codenarc/codenarc.groovy

@@ -499,7 +499,10 @@ ruleset {
     UnusedObject
     UnusedPrivateField
     UnusedPrivateMethod {
-        doNotApplyToClassNames = 'net.kautler.command.integ.test.spock.AddBeansExtension'
+        doNotApplyToClassNames = [
+                'net.kautler.command.integ.test.spock.AddBeansExtension',
+                'net.kautler.command.integ.test.spock.VetoBeansExtension'
+        ].join(', ')
     }
     UnusedPrivateMethodParameter
     UnusedVariable

src/integTestCommon/groovy/net/kautler/command/integ/test/spock/AddBean.groovy

@@ -1,5 +1,5 @@
 /*
- * Copyright 2019 Björn Kautler
+ * Copyright 2020 Björn Kautler
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -21,10 +21,11 @@ import java.lang.annotation.Retention
 import java.lang.annotation.Target
 
 import static java.lang.annotation.ElementType.METHOD
+import static java.lang.annotation.ElementType.TYPE
 import static java.lang.annotation.RetentionPolicy.RUNTIME
 
 @Retention(RUNTIME)
-@Target(METHOD)
+@Target([TYPE, METHOD])
 @Repeatable(AddBeans)
 @interface AddBean {
     Class<?> value()

src/integTestCommon/groovy/net/kautler/command/integ/test/spock/AddBeans.groovy

@@ -1,5 +1,5 @@
 /*
- * Copyright 2019 Björn Kautler
+ * Copyright 2020 Björn Kautler
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -20,10 +20,11 @@ import java.lang.annotation.Retention
 import java.lang.annotation.Target
 
 import static java.lang.annotation.ElementType.METHOD
+import static java.lang.annotation.ElementType.TYPE
 import static java.lang.annotation.RetentionPolicy.RUNTIME
 
 @Retention(RUNTIME)
-@Target(METHOD)
+@Target([TYPE, METHOD])
 @interface AddBeans {
     AddBean[] value()
 }

src/integTestCommon/groovy/net/kautler/command/integ/test/spock/CDIExtension.groovy

@@ -1,5 +1,5 @@
 /*
- * Copyright 2019 Björn Kautler
+ * Copyright 2020 Björn Kautler
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -30,10 +30,13 @@ class CDIExtension extends AbstractGlobalExtension {
     void visitSpec(SpecInfo spec) {
         spec.allFeatures.featureMethod.each { featureMethod ->
             featureMethod.addInterceptor { invocation ->
+                def annotatedElements = [spec.reflection, featureMethod.reflection]
                 def seContainer = SeContainerInitializer.newInstance()
                         .addProperty('javax.enterprise.inject.scan.implicit', TRUE)
                         .addExtensions(new AddBeansExtension(
-                                featureMethod.reflection.getAnnotationsByType(AddBean)*.value()))
+                                annotatedElements*.getAnnotationsByType(AddBean).flatten()*.value()))
+                        .addExtensions(new VetoBeansExtension(
+                                annotatedElements*.getAnnotationsByType(VetoBean).flatten()*.value()))
                         .initialize()
                 try {
                     invocation.proceed()

src/integTestCommon/groovy/net/kautler/command/integ/test/spock/VetoBean.groovy

@@ -0,0 +1,32 @@
+/*
+ * Copyright 2020 Björn Kautler
+ *
+ * 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.
+ */
+
+package net.kautler.command.integ.test.spock
+
+import java.lang.annotation.Repeatable
+import java.lang.annotation.Retention
+import java.lang.annotation.Target
+
+import static java.lang.annotation.ElementType.METHOD
+import static java.lang.annotation.ElementType.TYPE
+import static java.lang.annotation.RetentionPolicy.RUNTIME
+
+@Retention(RUNTIME)
+@Target([TYPE, METHOD])
+@Repeatable(VetoBeans)
+@interface VetoBean {
+    Class<?> value()
+}

src/integTestCommon/groovy/net/kautler/command/integ/test/spock/VetoBeans.groovy

@@ -0,0 +1,30 @@
+/*
+ * Copyright 2020 Björn Kautler
+ *
+ * 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.
+ */
+
+package net.kautler.command.integ.test.spock
+
+import java.lang.annotation.Retention
+import java.lang.annotation.Target
+
+import static java.lang.annotation.ElementType.METHOD
+import static java.lang.annotation.ElementType.TYPE
+import static java.lang.annotation.RetentionPolicy.RUNTIME
+
+@Retention(RUNTIME)
+@Target([TYPE, METHOD])
+@interface VetoBeans {
+    VetoBean[] value()
+}

src/integTestCommon/groovy/net/kautler/command/integ/test/spock/VetoBeansExtension.groovy

@@ -0,0 +1,35 @@
+/*
+ * Copyright 2020 Björn Kautler
+ *
+ * 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.
+ */
+
+package net.kautler.command.integ.test.spock
+
+import javax.enterprise.event.Observes
+import javax.enterprise.inject.spi.Extension
+import javax.enterprise.inject.spi.ProcessAnnotatedType
+
+class VetoBeansExtension implements Extension {
+    def beans
+
+    VetoBeansExtension(Collection<Class<?>> beans) {
+        this.beans = beans
+    }
+
+    private void vetoBean(@Observes ProcessAnnotatedType processAnnotatedType) {
+        if (processAnnotatedType.annotatedType.javaClass in beans) {
+            processAnnotatedType.veto()
+        }
+    }
+}

src/javacordIntegTest/groovy/net/kautler/command/integ/test/javacord/parameter/MissingDependencyParameterParserIntegTest.groovy

@@ -0,0 +1,97 @@
+/*
+ * Copyright 2020 Björn Kautler
+ *
+ * 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.
+ */
+
+package net.kautler.command.integ.test.javacord.parameter
+
+import net.kautler.command.api.Command
+import net.kautler.command.api.parameter.ParameterParser
+import net.kautler.command.integ.test.spock.AddBean
+import net.kautler.command.integ.test.spock.VetoBean
+import net.kautler.command.parameter.parser.UntypedParameterParser
+import net.kautler.command.parameter.parser.missingdependency.MissingDependencyParameterParser
+import org.javacord.api.entity.channel.ServerTextChannel
+import org.javacord.api.entity.message.Message
+import spock.lang.Specification
+import spock.lang.Subject
+import spock.util.concurrent.BlockingVariable
+import spock.util.concurrent.PollingConditions
+
+import javax.enterprise.context.ApplicationScoped
+import javax.enterprise.inject.Vetoed
+import javax.inject.Inject
+
+import static org.apache.logging.log4j.Level.ERROR
+import static org.apache.logging.log4j.test.appender.ListAppender.getListAppender
+
+@Subject(MissingDependencyParameterParser)
+@VetoBean(UntypedParameterParser)
+class MissingDependencyParameterParserIntegTest extends Specification {
+    @AddBean(PingCommand)
+    def 'missing dependency parameter parser should throw UnsupportedOperationException'(
+            ServerTextChannel serverTextChannelAsBot, ServerTextChannel serverTextChannelAsUser) {
+        given:
+            def commandReceived = new BlockingVariable<Boolean>(System.properties.testResponseTimeout as double)
+
+        and:
+            def listenerManager = serverTextChannelAsBot.addMessageCreateListener {
+                if ((it.message.userAuthor.orElse(null) == serverTextChannelAsUser.api.yourself) &&
+                        (it.message.content == '!ping')) {
+                    commandReceived.set(true)
+                }
+            }
+
+        when:
+            serverTextChannelAsUser
+                    .sendMessage('!ping')
+                    .join()
+
+        then:
+            commandReceived.get()
+
+        and:
+            new PollingConditions(timeout: System.properties.testResponseTimeout as double).eventually {
+                getListAppender('Test Appender')
+                        .events
+                        .any {
+                            (it.level == ERROR) &&
+                                    (it.thrown instanceof UnsupportedOperationException) &&
+                                    (it.thrown.message == 'ANTLR runtime is missing')
+                        }
+            }
+
+        cleanup:
+            listenerManager?.remove()
+
+        and:
+            getListAppender('Test Appender').@events.removeIf {
+                (it.level == ERROR) &&
+                        (it.thrown instanceof UnsupportedOperationException) &&
+                        (it.thrown.message == 'ANTLR runtime is missing')
+            }
+    }
+
+    @Vetoed
+    @ApplicationScoped
+    static class PingCommand implements Command<Message> {
+        @Inject
+        ParameterParser parameterParser
+
+        @Override
+        void execute(Message incomingMessage, String prefix, String usedAlias, String parameterString) {
+            parameterParser.toString()
+        }
+    }
+}

src/javacordIntegTest/groovy/net/kautler/command/integ/test/javacord/parameter/TypedParameterParserIntegTest.groovy

@@ -24,7 +24,9 @@ import net.kautler.command.api.parameter.ParameterParser
 import net.kautler.command.api.parameter.ParameterParser.Typed
 import net.kautler.command.api.parameter.ParameterType
 import net.kautler.command.integ.test.spock.AddBean
+import net.kautler.command.integ.test.spock.VetoBean
 import net.kautler.command.parameter.parser.TypedParameterParser
+import net.kautler.command.parameter.parser.missingdependency.MissingDependencyParameterParser
 import org.javacord.api.entity.channel.ServerTextChannel
 import org.javacord.api.entity.message.Message
 import org.javacord.api.util.logging.ExceptionLogger
@@ -41,6 +43,7 @@ import javax.inject.Inject
 import static java.util.UUID.randomUUID
 
 @Subject(TypedParameterParser)
+@VetoBean(MissingDependencyParameterParser)
 class TypedParameterParserIntegTest extends Specification {
     @AddBean(PingCommand)
     @AddBean(CustomStringsConverter)

src/javacordIntegTest/groovy/net/kautler/command/integ/test/javacord/parameter/UntypedParameterParserIntegTest.groovy

@@ -20,7 +20,9 @@ import net.kautler.command.api.Command
 import net.kautler.command.api.annotation.Usage
 import net.kautler.command.api.parameter.ParameterParser
 import net.kautler.command.integ.test.spock.AddBean
+import net.kautler.command.integ.test.spock.VetoBean
 import net.kautler.command.parameter.parser.UntypedParameterParser
+import net.kautler.command.parameter.parser.missingdependency.MissingDependencyParameterParser
 import org.javacord.api.entity.channel.ServerTextChannel
 import org.javacord.api.entity.message.Message
 import org.javacord.api.util.logging.ExceptionLogger
@@ -35,6 +37,7 @@ import javax.inject.Inject
 import static java.util.UUID.randomUUID
 
 @Subject(UntypedParameterParser)
+@VetoBean(MissingDependencyParameterParser)
 class UntypedParameterParserIntegTest extends Specification {
     @AddBean(PingCommand)
     def 'untyped parameter parser should work properly'(