forked from Incendo/cloud
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
✨ Implement predicate permissions (Incendo#210)
Co-authored-by: Josh Taylor <me@broccol.ai>
- Loading branch information
1 parent
81dabff
commit ee106d6
Showing
7 changed files
with
212 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
75 changes: 75 additions & 0 deletions
75
cloud-core/src/main/java/cloud/commandframework/permission/PredicatePermission.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| // | ||
| // MIT License | ||
| // | ||
| // Copyright (c) 2020 Alexander Söderberg & Contributors | ||
| // | ||
| // 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. | ||
| // | ||
| package cloud.commandframework.permission; | ||
|
|
||
| import cloud.commandframework.keys.CloudKey; | ||
| import cloud.commandframework.keys.CloudKeyHolder; | ||
| import cloud.commandframework.keys.SimpleCloudKey; | ||
| import org.checkerframework.checker.nullness.qual.NonNull; | ||
|
|
||
| import java.util.Collection; | ||
| import java.util.Collections; | ||
| import java.util.function.Predicate; | ||
|
|
||
| /** | ||
| * A functional {@link CommandPermission} implementation | ||
| * | ||
| * @param <C> Command sender type | ||
| * @since 1.4.0 | ||
| */ | ||
| @FunctionalInterface | ||
| public interface PredicatePermission<C> extends CommandPermission, CloudKeyHolder<Void> { | ||
|
|
||
| /** | ||
| * Create a new predicate permission | ||
| * | ||
| * @param key Key that identifies the permission node | ||
| * @param predicate Predicate that determines whether or not the sender has the permission | ||
| * @param <C> Command sender type | ||
| * @return Created permission node | ||
| */ | ||
| static <C> PredicatePermission<C> of(final @NonNull CloudKey<Void> key, final @NonNull Predicate<C> predicate) { | ||
| return new WrappingPredicatePermission<>(key, predicate); | ||
| } | ||
|
|
||
| @Override | ||
| @SuppressWarnings("FunctionalInterfaceMethodChanged") | ||
| default @NonNull CloudKey<Void> getKey() { | ||
| return SimpleCloudKey.of(this.getClass().getSimpleName()); | ||
| } | ||
|
|
||
| /** | ||
| * Check whether or not the given sender has this permission | ||
| * | ||
| * @param sender Sender to check for | ||
| * @return {@code true} if the sender has the given permission, else {@code false} | ||
| */ | ||
| boolean hasPermission(C sender); | ||
|
|
||
| @Override | ||
| default @NonNull Collection<@NonNull CommandPermission> getPermissions() { | ||
| return Collections.singleton(this); | ||
| } | ||
|
|
||
| } |
59 changes: 59 additions & 0 deletions
59
cloud-core/src/main/java/cloud/commandframework/permission/WrappingPredicatePermission.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| // | ||
| // MIT License | ||
| // | ||
| // Copyright (c) 2020 Alexander Söderberg & Contributors | ||
| // | ||
| // 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. | ||
| // | ||
| package cloud.commandframework.permission; | ||
|
|
||
| import cloud.commandframework.keys.CloudKey; | ||
| import org.checkerframework.checker.nullness.qual.NonNull; | ||
|
|
||
| import java.util.function.Predicate; | ||
|
|
||
| final class WrappingPredicatePermission<C> implements PredicatePermission<C> { | ||
|
|
||
| private final CloudKey<Void> key; | ||
| private final Predicate<C> predicate; | ||
|
|
||
| WrappingPredicatePermission( | ||
| final @NonNull CloudKey<Void> key, | ||
| final @NonNull Predicate<C> predicate | ||
| ) { | ||
| this.key = key; | ||
| this.predicate = predicate; | ||
| } | ||
|
|
||
| @Override | ||
| public boolean hasPermission(final C sender) { | ||
| return this.predicate.test(sender); | ||
| } | ||
|
|
||
| @Override | ||
| public @NonNull CloudKey<Void> getKey() { | ||
| return this.key; | ||
| } | ||
|
|
||
| @Override | ||
| public String toString() { | ||
| return this.key.getName(); | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters