Merge remote-tracking branch 'origin/develop'

BentoBoxWorld · Aug 9, 2021 · 70457af · 70457af
2 parents db3b1fe + 55ec1de
commit 70457af
Show file tree

Hide file tree

Showing 29 changed files with 679 additions and 561 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -0,0 +1,38 @@
+name: Build
+on:
+  push:
+    branches:
+      - develop
+      - master
+  pull_request:
+    types: [opened, synchronize, reopened]
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0  # Shallow clones should be disabled for a better relevancy of analysis
+      - name: Set up JDK 16
+        uses: actions/setup-java@v2
+        with:
+          distribution: 'adopt'
+          java-version: '16'
+      - name: Cache SonarCloud packages
+        uses: actions/cache@v2
+        with:
+          path: ~/.sonar/cache
+          key: ${{ runner.os }}-sonar
+          restore-keys: ${{ runner.os }}-sonar
+      - name: Cache Maven packages
+        uses: actions/cache@v2
+        with:
+          path: ~/.m2
+          key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
+          restore-keys: ${{ runner.os }}-m2
+      - name: Build and analyze
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}  # Needed to get PR information, if any
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+        run: mvn -B verify org.sonarsource.scanner.maven:sonar-maven-plugin:sonar
diff --git a/.travis.yml b/.travis.yml
diff --git a/README.md b/README.md
@@ -5,6 +5,8 @@ to disable use by gamemode.
 
 ## How to use
 
+### Note: Java 16 and Minecraft 17, or later are required.
+
 1. Place the jar in the addons folder of the BentoBox plugin
 2. Restart the server
 3. The addon will create a data folder and inside the folder will be a config.yml

diff --git a/pom.xml b/pom.xml
@@ -54,19 +54,23 @@
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
-        <java.version>1.8</java.version>
+        <java.version>16</java.version>
         <!-- Non-minecraft related dependencies -->
-        <powermock.version>2.0.2</powermock.version>
+        <powermock.version>2.0.9</powermock.version>
         <!-- More visible way how to change dependency versions -->
-        <spigot.version>1.16.3-R0.1-SNAPSHOT</spigot.version>
-        <bentobox.version>1.15.4</bentobox.version>
-        <level.version>1.5.0</level.version>
+        <spigot.version>1.17-R0.1-SNAPSHOT</spigot.version>
+        <bentobox.version>1.17.0</bentobox.version>
+        <level.version>2.7.0-SNAPSHOT</level.version>
         <!-- Revision variable removes warning about dynamic version -->
         <revision>${build.version}-SNAPSHOT</revision>
         <!-- Do not change unless you want different name for local builds. -->
         <build.number>-LOCAL</build.number>
         <!-- This allows to change between versions. -->
-        <build.version>1.10.2</build.version>
+        <build.version>1.11.1</build.version>
+        <!-- Sonar Cloud -->
+        <sonar.projectKey>BentoBoxWorld_Warps</sonar.projectKey>
+        <sonar.organization>bentobox-world</sonar.organization>
+        <sonar.host.url>https://sonarcloud.io</sonar.host.url>
     </properties>
 
     <!-- Profiles will allow to automatically change build version. -->
@@ -109,30 +113,6 @@
                 <build.number></build.number>
             </properties>
         </profile>
-        <profile>
-            <id>sonar</id>
-            <properties>
-                <sonar.host.url>https://sonarcloud.io</sonar.host.url>
-                <sonar.organization>bentobox-world</sonar.organization>
-            </properties>
-            <build>
-                <plugins>
-                    <plugin>
-                        <groupId>org.sonarsource.scanner.maven</groupId>
-                        <artifactId>sonar-maven-plugin</artifactId>
-                        <version>3.6.0.1398</version>
-                        <executions>
-                            <execution>
-                                <phase>verify</phase>
-                                <goals>
-                                    <goal>sonar</goal>
-                                </goals>
-                            </execution>
-                        </executions>
-                    </plugin>
-                </plugins>
-            </build>
-        </profile>
     </profiles>
 
     <repositories>
@@ -162,7 +142,7 @@
         <dependency>
             <groupId>org.mockito</groupId>
             <artifactId>mockito-core</artifactId>
-            <version>3.0.0</version>
+            <version>3.11.1</version>
             <scope>test</scope>
         </dependency>
         <dependency>
@@ -196,7 +176,7 @@
         <dependency>
             <groupId>org.eclipse.jdt</groupId>
             <artifactId>org.eclipse.jdt.annotation</artifactId>
-            <version>2.2.200</version>
+            <version>2.2.600</version>
         </dependency>
     </dependencies>
 
@@ -246,7 +226,12 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-surefire-plugin</artifactId>
-                <version>2.22.0</version>
+                <version>3.0.0-M5</version>
+                <configuration>
+                    <argLine>
+                        --illegal-access=permit
+                    </argLine>
+                </configuration>
             </plugin>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
@@ -256,15 +241,18 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-javadoc-plugin</artifactId>
-                <version>3.0.1</version>
+                <version>3.1.1</version>
                 <configuration>
-                    <show>public</show>
+                    <source>16</source>
+                    <show>private</show>
                     <failOnError>false</failOnError>
                     <additionalJOption>-Xdoclint:none</additionalJOption>
+                    <javadocExecutable>${java.home}/bin/javadoc</javadocExecutable>
                 </configuration>
                 <executions>
                     <execution>
                         <id>attach-javadocs</id>
+                        <phase>install</phase>
                         <goals>
                             <goal>jar</goal>
                         </goals>
@@ -284,14 +272,6 @@
                     </execution>
                 </executions>
             </plugin>
-            <plugin>
-                <groupId>org.apache.maven.plugins</groupId>
-                <artifactId>maven-shade-plugin</artifactId>
-                <version>3.1.1</version>
-                <configuration>
-                    <minimizeJar>false</minimizeJar>
-                </configuration>
-            </plugin>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-install-plugin</artifactId>

diff --git a/src/main/java/world/bentobox/warps/SignCacheItem.java b/src/main/java/world/bentobox/warps/SignCacheItem.java
@@ -12,18 +12,28 @@
  *
  */
 public class SignCacheItem {
+
     @Expose
     private final List<String> signText;
     @Expose
     private final Material type;
     /**
-     * @param signText
-     * @param type
+     * @param signText sign text
+     * @param type material of sign
      */
     public SignCacheItem(List<String> signText, Material type) {
         this.signText = signText;
         this.type = type;
     }
+
+    /**
+     * This sign is not real
+     */
+    public SignCacheItem() {
+        this.signText = null;
+        this.type = null;
+    }
+
     /**
      * @return the signText
      */
@@ -36,5 +46,12 @@ public List<String> getSignText() {
     public Material getType() {
         return type;
     }
+    /**
+     * @return the isReal
+     */
+    public boolean isReal() {
+        return getType() != null;
+    }
+
 
 }
diff --git a/src/main/java/world/bentobox/warps/SignCacheManager.java b/src/main/java/world/bentobox/warps/SignCacheManager.java
@@ -1,22 +1,22 @@
 package world.bentobox.warps;
 
 import java.util.HashMap;
-import java.util.List;
 import java.util.Map;
 import java.util.UUID;
 
 import org.bukkit.Bukkit;
 import org.bukkit.Material;
 import org.bukkit.World;
+import org.eclipse.jdt.annotation.NonNull;
 
 import world.bentobox.bentobox.database.Database;
 import world.bentobox.warps.objects.SignCache;
 
 public class SignCacheManager {
-    private Map<World, Map<UUID, SignCacheItem>> cachedSigns = new HashMap<>();
-    private Warp addon;
+    private final Map<World, Map<UUID, SignCacheItem>> cachedSigns = new HashMap<>();
+    private final Warp addon;
     // Database handler for level data
-    private Database<SignCache> handler;
+    private final Database<SignCache> handler;
 
     public SignCacheManager(Warp addon) {
         this.addon = addon;
@@ -26,9 +26,11 @@ public SignCacheManager(Warp addon) {
     }
 
     private void loadCache() {
+        cachedSigns.clear();
         handler.loadObjects().forEach(w -> {
             World world = Bukkit.getWorld(w.getUniqueId());
             if (world != null) {
+                w.getSigns().values().removeIf(sci -> sci.getType().equals(Material.AIR));
                 cachedSigns.put(world, w.getSigns());
             }
         });
@@ -38,43 +40,41 @@ void saveCache() {
         cachedSigns.forEach((w, m) -> handler.saveObjectAsync(new SignCache(w, m)));
     }
 
-    Material getSignIcon(World world, UUID warpOwner) {
-        // Add the worlds if we haven't seen this before
-        cachedSigns.putIfAbsent(world, new HashMap<>());
-        if (cachedSigns.get(world).containsKey(warpOwner)) {
-            return cachedSigns.get(world).get(warpOwner).getType();
-        }
-        // Not in cache
-        SignCacheItem sc = addon.getWarpSignsManager().getSignInfo(world, warpOwner);
-        cachedSigns.get(world).put(warpOwner, sc);
-        return sc.getType();
-    }
-
     /**
-     * Gets sign text and cache it
-     * @param playerUUID
-     * @return sign text in a list
+     * Get the sign item from cache or get it from the world if it is not in the cache
+     * @param world - world
+     * @param warpOwner - warp owner
+     * @return SignCacheItem
      */
-    List<String> getSign(World world, UUID playerUUID) {
+    @NonNull
+    SignCacheItem getSignItem(World world, UUID warpOwner) {
         // Add the worlds if we haven't seen this before
         cachedSigns.putIfAbsent(world, new HashMap<>());
-        if (cachedSigns.get(world).containsKey(playerUUID)) {
-            return cachedSigns.get(world).get(playerUUID).getSignText();
+        // Get from cache if available
+        if (cachedSigns.get(world).containsKey(warpOwner)) {
+            return cachedSigns.get(world).get(warpOwner);
+        }
+        // Generate and add to cache
+        SignCacheItem result = addon.getWarpSignsManager().getSignInfo(world, warpOwner);
+        if (result.isReal()) {
+            cachedSigns.get(world).put(warpOwner, result);
+        } else {
+            cachedSigns.get(world).remove(warpOwner);
         }
-        SignCacheItem result = addon.getWarpSignsManager().getSignInfo(world, playerUUID);
-        cachedSigns.get(world).put(playerUUID, result);
-        return result.getSignText();
+        return result;
     }
 
     /**
      * Removes sign text from the cache
      * @param world - world
      * @param key - uuid of owner
+     * @return true if item is removed from cache
      */
-    void removeWarp(World world, UUID key) {
+    boolean removeWarp(World world, UUID key) {
         if (cachedSigns.containsKey(world)) {
-            cachedSigns.get(world).remove(key);
+            return cachedSigns.get(world).remove(key) != null;
         }
+        return false;
     }
 
 }