[AB-76] replaced usage templates for commands with a generated usage string, removed possibility to define the usage directly on the help

added Google guava dependency
minor fixes in documentation
fixed versions in main pom

abstracto-application/core/core-impl/src/main/java/dev/sheldan/abstracto/core/command/service/CommandServiceBean.java

@@ -1,9 +1,11 @@
 package dev.sheldan.abstracto.core.command.service;
 
+import com.google.common.collect.Iterables;
 import dev.sheldan.abstracto.core.command.Command;
 import dev.sheldan.abstracto.core.command.condition.CommandCondition;
 import dev.sheldan.abstracto.core.command.condition.ConditionResult;
 import dev.sheldan.abstracto.core.command.condition.ConditionalCommand;
+import dev.sheldan.abstracto.core.command.config.CommandConfiguration;
 import dev.sheldan.abstracto.core.command.execution.CommandContext;
 import dev.sheldan.abstracto.core.command.models.database.ACommand;
 import dev.sheldan.abstracto.core.command.models.database.ACommandInAServer;
@@ -27,6 +29,8 @@ import java.util.List;
 public class CommandServiceBean implements CommandService {
 
     public static final String NO_FEATURE_COMMAND_FOUND_EXCEPTION_TEMPLATE = "no_feature_command_found_exception";
+    private static final String[] MANDATORY_ENCLOSING = {"<", ">"};
+    private static final String[] OPTIONAL_ENCLOSING = {"[", "]"};
 
     @Autowired
     private ModuleManagementService moduleManagementService;
@@ -91,6 +95,26 @@ public class CommandServiceBean implements CommandService {
         commandForServer.setRestricted(true);
     }
 
+    @Override
+    public String generateUsage(Command command) {
+        StringBuilder builder = new StringBuilder();
+        CommandConfiguration commandConfig = command.getConfiguration();
+        builder.append(commandConfig.getName());
+        if(!commandConfig.getParameters().isEmpty()) {
+            builder.append(" ");
+        }
+        commandConfig.getParameters().forEach(parameter -> {
+            String[] enclosing = parameter.isOptional() ? OPTIONAL_ENCLOSING : MANDATORY_ENCLOSING;
+            builder.append(enclosing[0]);
+            builder.append(parameter.getName());
+            builder.append(enclosing[1]);
+            if(!parameter.equals(Iterables.getLast(commandConfig.getParameters()))) {
+                builder.append(" ");
+            }
+        });
+        return builder.toString();
+    }
+
     @Override
     public void unRestrictCommand(ACommand aCommand, AServer server) {
         ACommandInAServer commandForServer = commandInServerManagementService.getCommandForServer(aCommand, server);

abstracto-application/core/core-impl/src/main/java/dev/sheldan/abstracto/core/commands/help/Help.java

@@ -94,6 +94,7 @@ public class Help implements Command {
                     model.setAllowedRoles(roleService.getRolesFromGuild(aCommandInAServer.getAllowedRoles()));
                     model.setRestricted(true);
                 }
+                model.setUsage(commandService.generateUsage(command));
                 model.setCommand(command.getConfiguration());
                 MessageToSend messageToSend = templateService.renderEmbedTemplate("help_command_details_response", model);
                 channelService.sendMessageToSendToChannel(messageToSend, commandContext.getChannel());

abstracto-application/core/core-impl/src/test/java/dev/sheldan/abstracto/core/command/service/CommandServiceBeanTest.java

@@ -0,0 +1,95 @@
+package dev.sheldan.abstracto.core.command.service;
+
+import dev.sheldan.abstracto.core.command.Command;
+import dev.sheldan.abstracto.core.command.config.CommandConfiguration;
+import dev.sheldan.abstracto.core.command.config.Parameter;
+import org.junit.Assert;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.InjectMocks;
+import org.mockito.Mockito;
+import org.mockito.junit.MockitoJUnitRunner;
+
+import java.util.Arrays;
+
+import static org.mockito.Mockito.*;
+
+@RunWith(MockitoJUnitRunner.class)
+public class CommandServiceBeanTest {
+
+    private static final String COMMAND_NAME = "test";
+    private static final String PARAMETER_1_NAME = "param1";
+    private static final String PARAMETER_2_NAME = "param2";
+
+    @InjectMocks
+    private CommandServiceBean commandServiceBean;
+
+    @Test
+    public void testUsageWithoutParameters() {
+        executeTest("test", commandWithConfig(getNoParameters()));
+    }
+
+    @Test
+    public void testUsageWithOptionalParameter() {
+        executeTest("test [param1]", commandWithConfig(getOptionalParameterConfig()));
+    }
+
+    @Test
+    public void testUsageWithMandatoryParameter() {
+        executeTest("test <param1>", commandWithConfig(getMandatoryParameterConfig()));
+    }
+
+    @Test
+    public void testUsageWithMixedParameters() {
+        executeTest("test <param1> [param2]", commandWithConfig(getMixedParameterConfig()));
+    }
+
+    private void executeTest(String expectedUsage, Command commandToExecute) {
+        String generatedUsage = commandServiceBean.generateUsage(commandToExecute);
+        Assert.assertEquals(expectedUsage, generatedUsage);
+    }
+
+    private Command commandWithConfig(CommandConfiguration commandConfiguration) {
+        Command command = Mockito.mock(Command.class);
+        when(command.getConfiguration()).thenReturn(commandConfiguration);
+        return command;
+    }
+
+    private CommandConfiguration getNoParameters() {
+        return CommandConfiguration
+                .builder()
+                .name(COMMAND_NAME)
+                .build();
+    }
+
+    private CommandConfiguration getOptionalParameterConfig() {
+        return CommandConfiguration
+                .builder()
+                .name(COMMAND_NAME)
+                .parameters(Arrays.asList(getOptionalParameter(true)))
+                .build();
+    }
+
+    private CommandConfiguration getMandatoryParameterConfig() {
+        return CommandConfiguration
+                .builder()
+                .name(COMMAND_NAME)
+                .parameters(Arrays.asList(getOptionalParameter(false)))
+                .build();
+    }
+
+    private CommandConfiguration getMixedParameterConfig() {
+        Parameter param1 = Parameter.builder().name(PARAMETER_1_NAME).optional(false).build();
+        Parameter param2 = Parameter.builder().name(PARAMETER_2_NAME).optional(true).build();
+        return CommandConfiguration
+                .builder()
+                .name(COMMAND_NAME)
+                .parameters(Arrays.asList(param1, param2))
+                .build();
+    }
+
+    private Parameter getOptionalParameter(boolean b) {
+        return Parameter.builder().name(PARAMETER_1_NAME).optional(b).build();
+    }
+
+}

abstracto-application/core/core-interface/src/main/java/dev/sheldan/abstracto/core/command/config/HelpInfo.java

@@ -6,7 +6,6 @@ import lombok.Getter;
 @Getter
 @Builder
 public class HelpInfo {
-    private String usage;
     private String longHelp;
     private String example;
     @Builder.Default

abstracto-application/core/core-interface/src/main/java/dev/sheldan/abstracto/core/command/service/CommandService.java

@@ -16,6 +16,7 @@ public interface CommandService {
     void makeRoleImmuneForCommand(ACommand aCommand, ARole role);
     void makeRoleAffectedByCommand(ACommand aCommand, ARole role);
     void restrictCommand(ACommand aCommand, AServer server);
+    String generateUsage(Command command);
     void unRestrictCommand(ACommand aCommand, AServer server);
     void disAllowCommandForRole(ACommand aCommand, ARole role);
     void disAllowFeatureForRole(FeatureEnum featureEnum, ARole role);

abstracto-application/core/core-interface/src/main/java/dev/sheldan/abstracto/core/models/template/commands/help/HelpCommandDetailsModel.java

@@ -14,6 +14,7 @@ import java.util.List;
 @SuperBuilder
 public class HelpCommandDetailsModel extends UserInitiatedServerContext {
     private CommandConfiguration command;
+    private String usage;
     private List<Role> allowedRoles;
     private List<Role> immuneRoles;
     private Boolean restricted;

abstracto-application/core/core-interface/src/test/java/dev/sheldan/abstracto/core/utils/ContextUtilsTest.java

@@ -17,8 +17,6 @@ import org.mockito.InjectMocks;
 import org.mockito.Mock;
 import org.mockito.junit.MockitoJUnitRunner;
 
-import java.util.Optional;
-
 import static org.junit.Assert.assertEquals;
 import static org.mockito.ArgumentMatchers.eq;
 import static org.mockito.Mockito.when;

abstracto-application/coverage/pom.xml

@@ -66,6 +66,11 @@
             <groupId>dev.sheldan.abstracto.scheduling</groupId>
             <artifactId>scheduling-impl</artifactId>
         </dependency>
+
+        <dependency>
+            <groupId>dev.sheldan.abstracto.core</groupId>
+            <artifactId>core-impl</artifactId>
+        </dependency>
     </dependencies>
 
     <build>

abstracto-application/documentation/src/main/docs/asciidoc/features/core.adoc

@@ -33,7 +33,7 @@ Echo::
 * Description: Echos `text` in the same channel this command as executed in.
 Changing the prefix::
 * Usage: `setPrefix <prefix>`
-* Description: Changes the prefix of the bot on this value to `prefix`. This can be one or multiple characters.
+* Description: Changes the prefix of the bot in this guild to `prefix`. This can be one or multiple characters.
 Changing a post target::
 * Usage: `posttarget <key> <channel>`
 * Description: Changes the given post target identified by `key` to the given channel. All messages using this post target will be send to this channel from now on.

abstracto-application/documentation/src/main/docs/asciidoc/main.adoc

@@ -26,7 +26,7 @@ Weeks in this case are just a short hand for 7 days.
 Pagination navigation:: If a pagination is used for the output of a command you can navigate the pages with `◀️` and `▶️` and `⏹️` to close the pagination.
 Role as parameter:: Whenever a role is a parameter for a command, this can be done by either providing the role ID or mentioning the role.
 Channel groups:: This concept enables you to group channels together into channel groups and enact certain restrictions or features on this whole group.
-System configuration:: Some properties can be configured while the bot is running.
+System configuration:: Some properties can be configured while the bot is running and can be changed for each guild respectively.
 In the respective features they are noted under `Relevant system configuration`.
 In order to change this you need to use the command `setConfig` with the provided key and the new desired value.
 Emotes:: The features have section of the keys of used emotes in the feature, you can change this emote with the `setEmote` command.

abstracto-application/pom.xml

@@ -58,6 +58,14 @@
         <jruby.version>9.2.11.1</jruby.version>
         <maven.compiler.target>1.8</maven.compiler.target>
         <maven.compiler.source>1.8</maven.compiler.source>
+        <guava.version>29.0-jre</guava.version>
+        <gson.version>2.8.6</gson.version>
+        <commons-lang3.version>3.9</commons-lang3.version>
+        <commons-io.version>2.6</commons-io.version>
+        <mockito-core.version>3.3.3</mockito-core.version>
+        <commons-collections.version>4.3</commons-collections.version>
+        <spring-boot-starter.version>2.3.1.RELEASE</spring-boot-starter.version>
+        <junit.version>4.13</junit.version>
     </properties>
 
     <build>
@@ -119,43 +127,49 @@
             <dependency>
                 <groupId>org.apache.commons</groupId>
                 <artifactId>commons-lang3</artifactId>
-                <version>3.9</version>
+                <version>${commons-lang3.version}</version>
             </dependency>
             <dependency>
                 <groupId>commons-io</groupId>
                 <artifactId>commons-io</artifactId>
-                <version>2.6</version>
+                <version>${commons-io.version}</version>
             </dependency>
             <dependency>
                 <groupId>org.apache.commons</groupId>
                 <artifactId>commons-collections4</artifactId>
-                <version>4.3</version>
+                <version>${commons-collections.version}</version>
             </dependency>
 
             <dependency>
                 <groupId>com.google.code.gson</groupId>
                 <artifactId>gson</artifactId>
-                <version>2.8.6</version>
+                <version>${gson.version}</version>
             </dependency>
 
             <dependency>
                 <groupId>org.mockito</groupId>
                 <artifactId>mockito-core</artifactId>
                 <scope>test</scope>
-                <version>3.3.3</version>
+                <version>${mockito-core.version}</version>
+            </dependency>
+
+            <dependency>
+                <groupId>com.google.guava</groupId>
+                <artifactId>guava</artifactId>
+                <version>${guava.version}</version>
             </dependency>
 
             <dependency>
                 <groupId>junit</groupId>
                 <artifactId>junit</artifactId>
-                <version>4.13</version>
+                <version>${junit.version}</version>
                 <scope>test</scope>
             </dependency>
 
             <dependency>
                 <groupId>org.springframework.boot</groupId>
                 <artifactId>spring-boot-starter-test</artifactId>
-                <version>2.2.6.RELEASE</version>
+                <version>${spring-boot-starter.version}</version>
                 <scope>test</scope>
             </dependency>
 
@@ -172,6 +186,11 @@
             <artifactId>commons-lang3</artifactId>
         </dependency>
 
+        <dependency>
+            <groupId>com.google.guava</groupId>
+            <artifactId>guava</artifactId>
+        </dependency>
+
         <dependency>
             <groupId>org.mockito</groupId>
             <artifactId>mockito-core</artifactId>

abstracto-application/test-commons/src/test/java/dev/sheldan/abstracto/test/command/CommandConfigValidator.java

@@ -31,11 +31,9 @@ public class CommandConfigValidator {
         Assert.assertNotNull(helpInfo);
         if(helpInfo.isTemplated()) {
             Assert.assertNull(helpInfo.getLongHelp());
-            Assert.assertNull(helpInfo.getUsage());
             Assert.assertNull(helpInfo.getExample());
         } else {
             Assert.assertNotNull(helpInfo.getLongHelp());
-            Assert.assertNotNull(helpInfo.getUsage());
             if(helpInfo.isHasExample()) {
                 Assert.assertNotNull(helpInfo.getExample());
             } else {

bundled-licenses/direct/guava/COPYING

@@ -0,0 +1,202 @@
+
+                                 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.

bundled-licenses/direct/guava/info.txt

@@ -0,0 +1 @@
+https://github.com/google/guava