Make WordResult fail on empty string

kordlib · Sep 16, 2020 · 5301906 · 5301906
1 parent a9f5336
commit 5301906
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,9 @@
+# 0.3.4
+
+## Fixes
+
+* Fixed an issue where SingleWordArgument based classes could complete on blank or empty strings.
+
 # 0.3.3
 
 ## Fixes

diff --git a/...x-commands-runtime/src/main/kotlin/com/gitlab/kordlib/kordx/commands/argument/Argument.kt b/...x-commands-runtime/src/main/kotlin/com/gitlab/kordlib/kordx/commands/argument/Argument.kt
@@ -42,16 +42,21 @@ interface Argument<out T, in CONTEXT> {
 abstract class SingleWordArgument<T, CONTEXT> : StateArgument<T, CONTEXT>() {
 
     override suspend fun ParseState.parse(context: CONTEXT): ArgumentResult<T> {
+        if(ended) return unexpectedEnd()
+
         val cursorBefore = cursor
         val word = flush { consumeWord() }
 
+        if(word.isBlank()){
+            return ArgumentResult.Failure("Expected word.", cursor)
+        }
+
         val result = parse(word, context)
         require(result.wordsTaken <= 1) {
             "Single word arguments cannot take more than one word: $result"
         }
 
-        val argumentResult = result.toArgumentResult(cursorBefore, word)
-        return  argumentResult
+        return result.toArgumentResult(cursorBefore, word)
     }
 
     /**

diff --git a/...ntime/src/test/kotlin/com/gitlab/kordlib/kordx/commands/argument/text/WordArgumentTest.kt b/...ntime/src/test/kotlin/com/gitlab/kordlib/kordx/commands/argument/text/WordArgumentTest.kt
@@ -1,5 +1,6 @@
 package com.gitlab.kordlib.kordx.commands.argument.text
 
+import com.gitlab.kordlib.kordx.commands.argument.requireFailure
 import com.gitlab.kordlib.kordx.commands.argument.requireItem
 import kotlinx.coroutines.ExperimentalCoroutinesApi
 import kotlinx.coroutines.test.runBlockingTest
@@ -19,11 +20,23 @@ class WordArgumentTest {
         argument.parse(text, 0, Unit).requireItem(text)
     }
 
+    @ParameterizedTest
+    @MethodSource("failingSources")
+    fun `correctly fails arguments`(text: String) = runBlockingTest {
+        argument.parse(text, 0, Unit).requireFailure()
+    }
+
     companion object {
         @JvmStatic
         fun sources() = listOf(
                 Arguments.of("word")
         )
+
+        @JvmStatic
+        fun failingSources() = listOf(
+                Arguments.of(""),
+                Arguments.of(" "),
+        )
     }
 
 }