Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add some tests and remove assert. #77

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add some tests and remove assert. #77

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 38 additions & 8 deletions src/main/java/net/minestom/server/utils/NamespaceID.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,29 @@

import net.kyori.adventure.key.Key;
import org.intellij.lang.annotations.Pattern;
import org.jetbrains.annotations.Contract;
import org.jetbrains.annotations.NotNull;

import java.util.Objects;

/**
* Represents a namespaced ID
* https://minecraft.wiki/w/Namespaced_ID
* @deprecated Use {@link Key} instead!
*/
@Deprecated
public record NamespaceID(@NotNull String domain, @NotNull String path) implements CharSequence, Key {
private static final String LEGAL_LETTERS = "[0123456789abcdefghijklmnopqrstuvwxyz_-]+";
private static final String LEGAL_PATH_LETTERS = "[0123456789abcdefghijklmnopqrstuvwxyz./_-]+";

private static final java.util.regex.Pattern LEGAL_LETTERS = java.util.regex.Pattern.compile("[a-z0-9_-]+");
private static final java.util.regex.Pattern LEGAL_PATH_LETTERS = java.util.regex.Pattern.compile("[0-9a-z./_-]+");

/**
* Creates a new {@link NamespaceID} from the given namespace
* @param namespace the namespace
* @return a new {@link NamespaceID}
* @deprecated Use {@link Key#key(String)} instead!
* @throws IllegalArgumentException if the domain or path contains illegal characters
*/
@Contract("_ -> new")
public static @NotNull NamespaceID from(@NotNull String namespace) {
final int index = namespace.indexOf(Key.DEFAULT_SEPARATOR);
final String domain;
Expand All @@ -28,20 +39,39 @@ public record NamespaceID(@NotNull String domain, @NotNull String path) implemen
return new NamespaceID(domain, path);
}

/**
* Creates a new {@link NamespaceID} from the given domain and path
* @param domain the domain
* @param path the path
* @return a new {@link NamespaceID}
* @deprecated Use {@link Key#key(String, String)} instead!
* @throws IllegalArgumentException if the domain or path contains illegal characters
*/
@Contract("_, _ -> new")
public static @NotNull NamespaceID from(@NotNull String domain, @NotNull String path) {
return new NamespaceID(domain, path);
}

/**
* Creates a new {@link NamespaceID} from the given key
* @param key the key
* @return a new {@link NamespaceID}
* @deprecated Use {@link Key#namespace()} and {@link Key#value()} instead!
* @throws IllegalArgumentException if the domain or path contains illegal characters
*/
@Deprecated
@Contract("_ -> new")
public static @NotNull NamespaceID from(@NotNull Key key) {
return new NamespaceID(key.namespace(), key.value());
}

public NamespaceID {
domain = domain.intern();
path = path.intern();
assert !domain.contains(".") && !domain.contains("/") : "Domain cannot contain a dot nor a slash character (" + asString() + ")";
assert domain.matches(LEGAL_LETTERS) : "Illegal character in domain (" + asString() + "). Must match " + LEGAL_LETTERS;
assert path.matches(LEGAL_PATH_LETTERS) : "Illegal character in path (" + asString() + "). Must match " + LEGAL_PATH_LETTERS;
if (!LEGAL_LETTERS.matcher(domain).matches()) {
throw new IllegalArgumentException("Illegal character in domain. Must match " + LEGAL_LETTERS);
}
if (!LEGAL_PATH_LETTERS.matcher(path).matches()) {
throw new IllegalArgumentException("Illegal character in path. Must match " + LEGAL_PATH_LETTERS);
}
}

@Override
Expand Down
25 changes: 13 additions & 12 deletions src/test/java/net/minestom/server/utils/NamespaceIDTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
import org.junit.jupiter.api.Test;

import static org.junit.jupiter.api.Assertions.*;
import static org.junit.jupiter.api.Assertions.assertThrows;

class NamespaceIDTest {

Expand Down Expand Up @@ -39,49 +40,49 @@ void hashCodeConsistentWithEquals() {

@Test
void atMostOneColon() {
assertThrows(AssertionError.class, () -> NamespaceID.from("minecraft:block:wool"));
assertThrows(IllegalArgumentException.class, () -> NamespaceID.from("minecraft:block:wool"));
}

@Test
void noSlashInDomain() {
assertThrows(AssertionError.class, () -> NamespaceID.from("minecraft/java_edition:any"));
assertThrows(IllegalArgumentException.class, () -> NamespaceID.from("minecraft/java_edition:any"));
}

@Test
void noDotInDomain() {
assertThrows(AssertionError.class, () -> NamespaceID.from("minecraft.java:game"));
assertThrows(IllegalArgumentException.class, () -> NamespaceID.from("minecraft.java:game"));
}

@Test
void noUppercase() {
assertThrows(AssertionError.class, () -> NamespaceID.from("Minecraft:any"));
assertThrows(AssertionError.class, () -> NamespaceID.from("minecraft:Any"));
assertThrows(IllegalArgumentException.class, () -> NamespaceID.from("Minecraft:any"));
assertThrows(IllegalArgumentException.class, () -> NamespaceID.from("minecraft:Any"));
}

@Test
void noSpace() {
assertThrows(AssertionError.class, () -> NamespaceID.from("minecraft:a n y"));
assertThrows(IllegalArgumentException.class, () -> NamespaceID.from("minecraft:a n y"));
}

@Test
void onlyLatinLowercase() {
assertThrows(AssertionError.class, () -> NamespaceID.from("Minecraft:voilà"));
assertThrows(AssertionError.class, () -> NamespaceID.from("minecraft:où_ça"));
assertThrows(AssertionError.class, () -> NamespaceID.from("minecraft:schrödingers_var"));
assertThrows(IllegalArgumentException.class, () -> NamespaceID.from("Minecraft:voilà"));
assertThrows(IllegalArgumentException.class, () -> NamespaceID.from("minecraft:où_ça"));
assertThrows(IllegalArgumentException.class, () -> NamespaceID.from("minecraft:schrödingers_var"));
}

@Test
void numbersAllowed() {
NamespaceID.from("0xc1:468786471");
assertDoesNotThrow(() -> NamespaceID.from("0xc1:468786471"));
}

@Test
void dotAllowedInPath() {
NamespaceID.from("minecraft:ambient.cave");
assertDoesNotThrow(() -> NamespaceID.from("minecraft:ambient.cave"));
}

@Test
void slashAllowedInPath() {
NamespaceID.from("minecraft:textures/blocks/dirt.png");
assertDoesNotThrow(() -> NamespaceID.from("minecraft:textures/blocks/dirt.png"));
}
}
Loading