Sheldan/abstracto
1
0
Fork 0
mirror of https://github.com/Sheldan/abstracto.git synced 2026-03-23 21:39:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

[AB-179] adding command to show documentation

Browse Source
This commit is contained in:
Sheldan
2021-03-22 00:42:40 +01:00
parent 84ddcbe54b
commit 0b8e24f5f5
7 changed files with 92 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
abstracto-application/core/core-impl/src/main/java/dev/sheldan/abstracto/core/commands/help/Documentation.java Normal file
View File

@@ -0,0 +1,50 @@
package dev.sheldan.abstracto.core.commands.help;
import dev.sheldan.abstracto.core.command.Command;
import dev.sheldan.abstracto.core.command.config.CommandConfiguration;
import dev.sheldan.abstracto.core.command.config.HelpInfo;
import dev.sheldan.abstracto.core.command.config.features.CoreFeatureDefinition;
import dev.sheldan.abstracto.core.command.execution.CommandContext;
import dev.sheldan.abstracto.core.command.execution.CommandResult;
import dev.sheldan.abstracto.core.config.FeatureDefinition;
import dev.sheldan.abstracto.core.service.ChannelService;
import dev.sheldan.abstracto.core.utils.FutureUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import java.util.Arrays;
import java.util.concurrent.CompletableFuture;
@Component
public class Documentation implements Command {
@Autowired
private ChannelService channelService;
private static final String DOCUMENTATION_RESPONSE_TEMPLATE_KEY = "documentation_response";
@Override
public CompletableFuture<CommandResult> executeAsync(CommandContext commandContext) {
return FutureUtils.toSingleFutureGeneric(channelService.sendEmbedTemplateInMessageChannelList(DOCUMENTATION_RESPONSE_TEMPLATE_KEY, new Object(), commandContext.getChannel()))
.thenApply(unused -> CommandResult.fromIgnored());
}
@Override
public CommandConfiguration getConfiguration() {
HelpInfo helpInfo = HelpInfo.builder().templated(true).build();
return CommandConfiguration.builder()
.name("documentation")
.async(true)
.aliases(Arrays.asList("docu", "docs"))
.module(SupportModuleDefinition.SUPPORT)
.help(helpInfo)
.templated(true)
.causesReaction(true)
.build();
}
@Override
public FeatureDefinition getFeature() {
return CoreFeatureDefinition.CORE_FEATURE;
}
}

1
abstracto-application/core/core-impl/src/main/java/dev/sheldan/abstracto/core/commands/help/SupportModuleDefinition.java
View File

@@ -7,7 +7,6 @@ import org.springframework.stereotype.Component;
@Component
public class SupportModuleDefinition implements ModuleDefinition {
public static final String SUPPORT = "support";
@Override

10
abstracto-application/core/core-impl/src/main/resources/migrations/1.1-core/collection.xml Normal file
View File

@@ -0,0 +1,10 @@
<?xml version="1.1" encoding="UTF-8" standalone="no"?>
<databaseChangeLog xmlns="http://www.liquibase.org/xml/ns/dbchangelog"
xmlns:ext="http://www.liquibase.org/xml/ns/dbchangelog-ext"
xmlns:pro="http://www.liquibase.org/xml/ns/pro"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog ../dbchangelog-3.8.xsd
http://www.liquibase.org/xml/ns/dbchangelog-ext ../dbchangelog-3.8.xsd
http://www.liquibase.org/xml/ns/pro ../dbchangelog-3.8.xsd" >
<include file="core-seedData/data.xml" relativeToChangelogFile="true"/>
</databaseChangeLog>

18
abstracto-application/core/core-impl/src/main/resources/migrations/1.1-core/core-seedData/command.xml Normal file
View File

@@ -0,0 +1,18 @@
<?xml version="1.1" encoding="UTF-8" standalone="no"?>
<databaseChangeLog xmlns="http://www.liquibase.org/xml/ns/dbchangelog"
xmlns:ext="http://www.liquibase.org/xml/ns/dbchangelog-ext"
xmlns:pro="http://www.liquibase.org/xml/ns/pro"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog ../../dbchangelog-3.8.xsd
http://www.liquibase.org/xml/ns/dbchangelog-ext ../../dbchangelog-3.8.xsd
http://www.liquibase.org/xml/ns/pro ../../dbchangelog-3.8.xsd" >
<property name="coreFeature" value="(SELECT id FROM feature WHERE key = 'core')"/>
<property name="helpModule" value="(SELECT id FROM module WHERE name = 'support')"/>
<changeSet author="Sheldan" id="documentation-command">
<insert tableName="command">
<column name="name" value="documentation"/>
<column name="module_id" valueComputed="${helpModule}"/>
<column name="feature_id" valueComputed="${coreFeature}"/>
</insert>
</changeSet>
</databaseChangeLog>

10
abstracto-application/core/core-impl/src/main/resources/migrations/1.1-core/core-seedData/data.xml Normal file
View File

@@ -0,0 +1,10 @@
<?xml version="1.1" encoding="UTF-8" standalone="no"?>
<databaseChangeLog xmlns="http://www.liquibase.org/xml/ns/dbchangelog"
xmlns:ext="http://www.liquibase.org/xml/ns/dbchangelog-ext"
xmlns:pro="http://www.liquibase.org/xml/ns/pro"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog ../../dbchangelog-3.8.xsd
http://www.liquibase.org/xml/ns/dbchangelog-ext ../../dbchangelog-3.8.xsd
http://www.liquibase.org/xml/ns/pro ../../dbchangelog-3.8.xsd" >
<include file="command.xml" relativeToChangelogFile="true"/>
</databaseChangeLog>

1
abstracto-application/core/core-impl/src/main/resources/migrations/core-changeLog.xml
View File

@@ -8,4 +8,5 @@
http://www.liquibase.org/xml/ns/pro dbchangelog-3.8.xsd" >
<include file="1.0-core/collection.xml" relativeToChangelogFile="true"/>
<include file="1.0-templating/collection.xml" relativeToChangelogFile="true"/>
<include file="1.1-core/collection.xml" relativeToChangelogFile="true"/>
</databaseChangeLog>

3
abstracto-application/documentation/src/main/docs/asciidoc/modules/core.adoc
View File

@@ -140,6 +140,9 @@ Retrieving the current customized template for this server::
Resetting a customized template to the default template::
* Usage `resetTemplate <templateKey>`
* Description: Resets the template identified by `templateKey` to the default content.
Show a link to documentation::
* Usage `documentation`
* Description: Shows links to access the documentation.
.What does it mean if a role is immune?