CacheRemove done

src/main/java/ortus/boxlang/modules/compat/bifs/cache/CacheDelete.java → src/main/java/ortus/boxlang/modules/compat/bifs/cache/CacheRemove.java

@@ -24,21 +24,22 @@
 import ortus.boxlang.runtime.scopes.ArgumentsScope;
 import ortus.boxlang.runtime.scopes.Key;
 import ortus.boxlang.runtime.types.Argument;
+import ortus.boxlang.runtime.types.Array;
 import ortus.boxlang.runtime.types.exceptions.BoxRuntimeException;
 import ortus.boxlang.runtime.validation.Validator;
 
 @BoxBIF
-public class CacheDelete extends BIF {
+public class CacheRemove extends BIF {
 
 	private static final Validator cacheExistsValidator = new CacheExistsValidator();
 
 	/**
 	 * Constructor
 	 */
-	public CacheDelete() {
+	public CacheRemove() {
 		super();
 		declaredArguments = new Argument[] {
-		    new Argument( true, Argument.STRING, Key.id ),
+		    new Argument( true, Argument.ANY, Key.id ),
 		    new Argument( false, Argument.BOOLEAN, Key.throwOnError, false ),
 		    new Argument( false, Argument.STRING, Key.cacheName, Key._DEFAULT, Set.of( cacheExistsValidator ) )
 		};
@@ -50,28 +51,36 @@ public CacheDelete() {
 	 * @param context   The context in which the BIF is being invoked.
 	 * @param arguments Argument scope for the BIF.
 	 *
-	 * @argument.id The id to clear
+	 * @argument.id A single ID or an array of IDs to remove from the cache.
 	 *
 	 * @argument.throwOnError If true, throw an exception if the key is not found. Default is false.
 	 *
 	 * @argument.cacheName The name of the cache to get the keys from. Default is the default cache.
 	 *
-	 * @return Clears the key if found, else it throws an exception
+	 * @return Clears the key if found, else it throws an exception. If the key is an array,
+	 *         it returns a Struct with the keys and their results.
 	 */
 	public Object _invoke( IBoxContext context, ArgumentsScope arguments ) {
 		ICacheProvider	cache			= cacheService.getCache( arguments.getAsKey( Key.cacheName ) );
 		Boolean			throwOnError	= arguments.getAsBoolean( Key.throwOnError );
-		String			cacheKey		= arguments.getAsString( Key.id );
+		Boolean			results			= false;
 
-		// Clear one
-		if ( cache.clear( cacheKey ) ) {
-			return true;
+		// One key
+		if ( arguments.get( Key.id ) instanceof String castedKey ) {
+			results = cache.clear( castedKey );
+		}
+
+		// Array of keys
+		if ( arguments.get( Key.id ) instanceof Array castedArrayOfKeys ) {
+			// Get the ids from the array to native java Array
+			String[] keys = castedArrayOfKeys.toArray( String[]::new );
+			return cache.clear( keys );
 		}
 
 		// Throw it
-		if ( throwOnError ) {
+		if ( !results && throwOnError ) {
 			throw new BoxRuntimeException(
-			    "Cache id [" + cacheKey + "] not found in cache [" + arguments.getAsKey( Key.cacheName ) + "]"
+			    "Cache id [" + arguments.get( Key.id ).toString() + "] not found in cache [" + arguments.getAsKey( Key.cacheName ) + "]"
 			);
 		}
 

src/test/java/ortus/boxlang/modules/compat/bifs/cache/CacheRemoveTest.java

@@ -0,0 +1,92 @@
+/**
+ * [BoxLang]
+ *
+ * Copyright [2023] [Ortus Solutions, Corp]
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package ortus.boxlang.modules.compat.bifs.cache;
+
+import static com.google.common.truth.Truth.assertThat;
+import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;
+import static org.junit.jupiter.api.Assertions.assertThrows;
+
+import org.junit.jupiter.api.DisplayName;
+import org.junit.jupiter.api.Test;
+
+import ortus.boxlang.runtime.types.exceptions.BoxRuntimeException;
+
+public class CacheRemoveTest extends BaseCacheTest {
+
+	@Test
+	@DisplayName( "Can get a key from the default cache" )
+	public void canGetDefaultCache() {
+		runtime.executeSource(
+		    """
+		    cacheRemove( "tdd" );
+		    """,
+		    context );
+
+		assertThat( boxCache.lookup( "tdd" ) ).isFalse();
+	}
+
+	@Test
+	@DisplayName( "Can get a key from a specific cache" )
+	public void canGetSpecificCache() {
+		runtime.executeSource(
+		    """
+		    cacheRemove( "tdd", false, "default" );
+		    """,
+		    context );
+
+		assertThat( boxCache.lookup( "tdd" ) ).isFalse();
+	}
+
+	@Test
+	@DisplayName( "Can remove an invalid key without throwing an error" )
+	public void canRemoveInvalidKey() {
+		assertDoesNotThrow( () -> {
+			runtime.executeSource(
+			    """
+			    cacheRemove( "bogus" );
+			    """,
+			    context );
+		} );
+	}
+
+	@Test
+	@DisplayName( "Can remove an invalid key by throwing an error" )
+	public void canRemoveInvalidKeyThrowingError() {
+		assertThrows( BoxRuntimeException.class, () -> {
+			runtime.executeSource(
+			    """
+			    cacheRemove( "bogus", true );
+			    """,
+			    context );
+		} );
+	}
+
+	@Test
+	@DisplayName( "Can remove an array of keys " )
+	public void canRemoveArrayOfKeys() {
+		runtime.executeSource(
+		    """
+		    cacheRemove( [ "tdd", "bdd" ] );
+		    """,
+		    context );
+
+		assertThat( boxCache.lookup( "tdd" ) ).isFalse();
+		assertThat( boxCache.lookup( "bdd" ) ).isFalse();
+	}
+
+}