init

Author: PillageDev

.github/workflows/publish-on-master-push.yml

@@ -0,0 +1,32 @@
+name: publish-on-master-push
+
+on:
+  push:
+    branches: [ master ]
+    paths-ignore:
+      - '**/README.md'
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up JDK 16
+        uses: actions/setup-java@v2
+        with:
+          distribution: 'adopt'
+          java-version: '16'
+      - name: Build with Gradle
+        run: ./gradlew build
+      - name: Archive test reports
+        if: ${{ failure() }}
+        uses: actions/upload-artifact@v2
+        with:
+          name: test-reports
+          path: |
+            build/reports/**/*
+      - name: Publish to GitHub Packages
+        run: ./gradlew publish
+        env:
+          GITHUB_ACTOR: ${{ github.actor }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/test-on-pr-or-dev-push.yml

@@ -0,0 +1,29 @@
+name: test-on-pr-or-dev-push
+
+on:
+  pull_request:
+    paths-ignore:
+      - '**/README.md'
+  push:
+    branches: [ dev ]
+    paths-ignore:
+      - '**/README.md'
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up JDK 16
+        uses: actions/setup-java@v2
+        with:
+          distribution: 'adopt'
+          java-version: '16'
+      - name: Test with Gradle
+        run: ./gradlew test
+      - name: Archive test reports
+        if: ${{ failure() }}
+        uses: actions/upload-artifact@v2
+        with:
+          name: test-reports
+          path: |
+            build/reports/**/*

.gitignore

@@ -0,0 +1,5 @@
+**/.idea
+**/out
+**/build
+
+**/.gradle

.travis.yml

@@ -0,0 +1,5 @@
+language: java
+jdk:
+  - oraclejdk8
+  - oraclejdk9
+  - oraclejdk10

ConfigLib-Bukkit/src/main/java/de/exlll/configlib/ConfigLib.java

@@ -0,0 +1,5 @@
+package de.exlll.configlib;
+
+import org.bukkit.plugin.java.JavaPlugin;
+
+public class ConfigLib extends JavaPlugin {}

ConfigLib-Bukkit/src/main/java/de/exlll/configlib/configs/yaml/BukkitYamlConfiguration.java

@@ -0,0 +1,56 @@
+package de.exlll.configlib.configs.yaml;
+
+import org.bukkit.configuration.file.YamlConstructor;
+import org.bukkit.configuration.file.YamlRepresenter;
+
+import java.nio.file.Path;
+
+/**
+ * A {@code BukkitYamlConfiguration} is a specialized form of a
+ * {@code YamlConfiguration} that uses better default values.
+ */
+public abstract class BukkitYamlConfiguration extends YamlConfiguration {
+    protected BukkitYamlConfiguration(Path path, BukkitYamlProperties properties) {
+        super(path, properties);
+    }
+
+    protected BukkitYamlConfiguration(Path path) {
+        this(path, BukkitYamlProperties.DEFAULT);
+    }
+
+    public static class BukkitYamlProperties extends YamlProperties {
+        public static final BukkitYamlProperties DEFAULT = builder().build();
+
+        private BukkitYamlProperties(Builder<?> builder) {
+            super(builder);
+        }
+
+        public static Builder<?> builder() {
+            return new Builder() {
+                @Override
+                protected Builder<?> getThis() {
+                    return this;
+                }
+            };
+        }
+
+        public static abstract class
+        Builder<B extends BukkitYamlProperties.Builder<B>>
+                extends YamlProperties.Builder<B> {
+
+            protected Builder() {
+                setConstructor(new YamlConstructor());
+                setRepresenter(new YamlRepresenter());
+            }
+
+            /**
+             * Builds a new {@code BukkitYamlProperties} instance using the values set.
+             *
+             * @return new {@code BukkitYamlProperties} instance
+             */
+            public BukkitYamlProperties build() {
+                return new BukkitYamlProperties(this);
+            }
+        }
+    }
+}

ConfigLib-Bukkit/src/main/resources/plugin.yml

@@ -0,0 +1,5 @@
+name: ConfigLib
+author: Exlll
+
+version: 2.2.0
+main: de.exlll.configlib.ConfigLib

ConfigLib-Bungee/src/main/java/de/exlll/configlib/ConfigLib.java

@@ -0,0 +1,5 @@
+package de.exlll.configlib;
+
+import net.md_5.bungee.api.plugin.Plugin;
+
+public class ConfigLib extends Plugin {}

ConfigLib-Bungee/src/main/resources/plugin.yml

@@ -0,0 +1,5 @@
+name: ConfigLib
+author: Exlll
+
+version: 2.2.0
+main: de.exlll.configlib.ConfigLib

ConfigLib-Core/src/main/java/de/exlll/configlib/Comments.java

@@ -0,0 +1,85 @@
+package de.exlll.configlib;
+
+import de.exlll.configlib.annotation.Comment;
+
+import java.lang.reflect.AnnotatedElement;
+import java.lang.reflect.Field;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.List;
+import java.util.Map;
+
+import static java.util.stream.Collectors.toMap;
+
+/**
+ * Instances of this class contain all comments of a {@link Configuration} class
+ * and its fields.
+ */
+public final class Comments {
+    private final List<String> classComments;
+    private final Map<String, List<String>> fieldComments;
+
+    private Comments(List<String> classComments,
+                     Map<String, List<String>> fieldComments) {
+        this.classComments = classComments;
+        this.fieldComments = fieldComments;
+    }
+
+    static Comments ofClass(Class<?> cls) {
+        List<String> classComments = getComments(cls);
+        Map<String, List<String>> fieldComments = Arrays
+                .stream(cls.getDeclaredFields())
+                .filter(Comments::isCommented)
+                .collect(toMap(Field::getName, Comments::getComments));
+        return new Comments(classComments, fieldComments);
+    }
+
+    private static boolean isCommented(AnnotatedElement element) {
+        return element.isAnnotationPresent(Comment.class);
+    }
+
+    private static List<String> getComments(AnnotatedElement element) {
+        Comment comment = element.getAnnotation(Comment.class);
+        return (comment != null)
+                ? Arrays.asList(comment.value())
+                : Collections.emptyList();
+    }
+
+    /**
+     * Returns if the {@code Configuration} this {@code Comments} object belongs to
+     * has class comments.
+     *
+     * @return true, if {@code Configuration} has class comments.
+     */
+    public boolean hasClassComments() {
+        return !classComments.isEmpty();
+    }
+
+    /**
+     * Returns if the {@code Configuration} this {@code Comments} object belongs to
+     * has field comments.
+     *
+     * @return true, if {@code Configuration} has field comments.
+     */
+    public boolean hasFieldComments() {
+        return !fieldComments.isEmpty();
+    }
+
+    /**
+     * Returns a list of class comments.
+     *
+     * @return list of class comments
+     */
+    public List<String> getClassComments() {
+        return classComments;
+    }
+
+    /**
+     * Returns lists of field comments mapped by field name.
+     *
+     * @return lists of field comments by field name
+     */
+    public Map<String, List<String>> getFieldComments() {
+        return fieldComments;
+    }
+}