From 2ba30dddd4acb3bd789b4e487ed0647984576e8c Mon Sep 17 00:00:00 2001
From: Senmori <thesenmori@gmail.com>
Date: Fri, 20 Jul 2018 13:14:30 -0400
Subject: Clarify NamespacedKey error messages.

Add new tests for NamespacedKeys.
---
 src/main/java/org/bukkit/NamespacedKey.java     | 18 ++++++++++++------
 src/test/java/org/bukkit/NamespacedKeyTest.java | 10 ++++++++++
 2 files changed, 22 insertions(+), 6 deletions(-)

(limited to 'src')

diff --git a/src/main/java/org/bukkit/NamespacedKey.java b/src/main/java/org/bukkit/NamespacedKey.java
index 1ed8f7e4..43239f84 100644
--- a/src/main/java/org/bukkit/NamespacedKey.java
+++ b/src/main/java/org/bukkit/NamespacedKey.java
@@ -44,8 +44,8 @@ public final class NamespacedKey {
      */
     @Deprecated
     public NamespacedKey(String namespace, String key) {
-        Preconditions.checkArgument(namespace != null && VALID_NAMESPACE.matcher(namespace).matches(), "namespace");
-        Preconditions.checkArgument(key != null && VALID_KEY.matcher(key).matches(), "key");
+        Preconditions.checkArgument(namespace != null && VALID_NAMESPACE.matcher(namespace).matches(), "Invalid namespace. Must be [a-z0-9._-]: %s", namespace);
+        Preconditions.checkArgument(key != null && VALID_KEY.matcher(key).matches(), "Invalid key. Must be [a-z0-9/._-]: %s", key);
 
         this.namespace = namespace;
         this.key = key;
@@ -56,20 +56,26 @@ public final class NamespacedKey {
 
     /**
      * Create a key in the plugin's namespace.
+     * <p>
+     * Namespaces may only contain lowercase alphanumeric characters, periods,
+     * underscores, and hyphens.
+     * <p>
+     * Keys may only contain lowercase alphanumeric characters, periods,
+     * underscores, hyphens, and forward slashes.
      *
      * @param plugin the plugin to use for the namespace
      * @param key the key to create
      */
     public NamespacedKey(Plugin plugin, String key) {
-        Preconditions.checkArgument(plugin != null, "plugin");
-        Preconditions.checkArgument(key != null, "key");
+        Preconditions.checkArgument(plugin != null, "Plugin cannot be null");
+        Preconditions.checkArgument(key != null, "Key cannot be null");
 
         this.namespace = plugin.getName().toLowerCase(Locale.ROOT);
         this.key = key.toLowerCase().toLowerCase(Locale.ROOT);
 
         // Check validity after normalization
-        Preconditions.checkArgument(VALID_NAMESPACE.matcher(this.namespace).matches(), "namespace");
-        Preconditions.checkArgument(VALID_KEY.matcher(this.key).matches(), "key");
+        Preconditions.checkArgument(VALID_NAMESPACE.matcher(this.namespace).matches(), "Invalid namespace. Must be [a-z0-9._-]: %s", this.namespace);
+        Preconditions.checkArgument(VALID_KEY.matcher(this.key).matches(), "Invalid key. Must be [a-z0-9/._-]: %s", this.key);
 
         String string = toString();
         Preconditions.checkArgument(string.length() < 256, "NamespacedKey must be less than 256 characters (%s)", string);
diff --git a/src/test/java/org/bukkit/NamespacedKeyTest.java b/src/test/java/org/bukkit/NamespacedKeyTest.java
index 7c71aabf..8c5e5ca7 100644
--- a/src/test/java/org/bukkit/NamespacedKeyTest.java
+++ b/src/test/java/org/bukkit/NamespacedKeyTest.java
@@ -29,6 +29,16 @@ public class NamespacedKeyTest {
         new NamespacedKey("minecraft/test", "foo").toString();
     }
 
+    @Test(expected = IllegalArgumentException.class)
+    public void testInvalidNamespaceCasing() {
+        new NamespacedKey("Minecraft", "foo").toString();
+    }
+
+    @Test(expected = IllegalArgumentException.class)
+    public void testInvalidKeyCasing() {
+        new NamespacedKey("minecraft", "Foo").toString();
+    }
+
     @Test(expected = IllegalArgumentException.class)
     public void testInvalidKey() {
         new NamespacedKey("minecraft", "foo!").toString();
-- 
cgit v1.2.3