New array_clear command

CHANGELOG.md

@@ -5,6 +5,7 @@
 * New set_new command.
 * New is_set command.
 * New unset command.
+* New array_clear command.
 * New array_contains command.
 * New map_contains_value command.
 * New map_contains_key command.

docs/sdk.md

@@ -7,6 +7,7 @@
 * [std::Release (release)](#std__Release)
 * [std::ShowCommandDocumentation (man)](#std__ShowCommandDocumentation)
 * [std::collections::Array (array)](#std__collections__Array)
+* [std::collections::ArrayClear (array_clear)](#std__collections__ArrayClear)
 * [std::collections::ArrayConcat (array_concat)](#std__collections__ArrayConcat)
 * [std::collections::ArrayContains (array_contains)](#std__collections__ArrayContains)
 * [std::collections::ArrayGet (array_get)](#std__collections__ArrayGet)
@@ -429,6 +430,45 @@ release ${handle}
 #### Aliases:
 array
 
+<a name="std__collections__ArrayClear"></a>
+## std::collections::ArrayClear
+```sh
+result = array_clear handle
+```
+
+Clears the provided array.
+
+#### Parameters
+
+The array handle.
+
+#### Return Value
+
+True if successful.
+
+#### Examples
+
+```sh
+handle = array
+
+result = array_push ${handle} 1
+
+result = array_is_empty ${handle}
+assert_false ${result}
+
+result array_clear ${handle}
+assert ${result}
+
+result = array_is_empty ${handle}
+assert ${result}
+
+release ${handle}
+```
+
+
+#### Aliases:
+array_clear
+
 <a name="std__collections__ArrayConcat"></a>
 ## std::collections::ArrayConcat
 

duckscript_sdk/src/sdk/std/collections/array_clear/help.md

@@ -0,0 +1,32 @@
+```sh
+result = array_clear handle
+```
+
+Clears the provided array.
+
+#### Parameters
+
+The array handle.
+
+#### Return Value
+
+True if successful.
+
+#### Examples
+
+```sh
+handle = array
+
+result = array_push ${handle} 1
+
+result = array_is_empty ${handle}
+assert_false ${result}
+
+result array_clear ${handle}
+assert ${result}
+
+result = array_is_empty ${handle}
+assert ${result}
+
+release ${handle}
+```

duckscript_sdk/src/sdk/std/collections/array_clear/mod.rs

@@ -0,0 +1,73 @@
+use crate::utils::pckg;
+use crate::utils::state::{get_handles_sub_state, mutate_list};
+use duckscript::types::command::{Command, CommandResult, Commands};
+use duckscript::types::instruction::Instruction;
+use duckscript::types::runtime::StateValue;
+use std::collections::HashMap;
+
+#[cfg(test)]
+#[path = "./mod_test.rs"]
+mod mod_test;
+
+#[derive(Clone)]
+pub(crate) struct CommandImpl {
+    package: String,
+}
+
+impl Command for CommandImpl {
+    fn name(&self) -> String {
+        pckg::concat(&self.package, "ArrayClear")
+    }
+
+    fn aliases(&self) -> Vec<String> {
+        vec!["array_clear".to_string()]
+    }
+
+    fn help(&self) -> String {
+        include_str!("help.md").to_string()
+    }
+
+    fn clone_and_box(&self) -> Box<dyn Command> {
+        Box::new((*self).clone())
+    }
+
+    fn requires_context(&self) -> bool {
+        true
+    }
+
+    fn run_with_context(
+        &self,
+        arguments: Vec<String>,
+        state: &mut HashMap<String, StateValue>,
+        _variables: &mut HashMap<String, String>,
+        _output_variable: Option<String>,
+        _instructions: &Vec<Instruction>,
+        _commands: &mut Commands,
+        _line: usize,
+    ) -> CommandResult {
+        if arguments.is_empty() {
+            CommandResult::Error("Array handle not provided.".to_string())
+        } else {
+            let state = get_handles_sub_state(state);
+
+            let key = arguments[0].clone();
+
+            let result = mutate_list(key, state, |list| {
+                list.clear();
+
+                Ok(None)
+            });
+
+            match result {
+                Ok(_) => CommandResult::Continue(Some("true".to_string())),
+                Err(error) => CommandResult::Error(error),
+            }
+        }
+    }
+}
+
+pub(crate) fn create(package: &str) -> Box<dyn Command> {
+    Box::new(CommandImpl {
+        package: package.to_string(),
+    })
+}

duckscript_sdk/src/sdk/std/collections/array_clear/mod_test.rs

@@ -0,0 +1,41 @@
+use super::*;
+use crate::sdk::std::collections::{array, array_length, array_push};
+use crate::test;
+use crate::test::CommandValidation;
+
+#[test]
+fn common_functions() {
+    test::test_common_command_functions(create(""));
+}
+
+#[test]
+fn run_no_args() {
+    test::run_script_and_error(vec![create("")], "out = array_clear", "out");
+}
+
+#[test]
+fn run_not_found() {
+    test::run_script_and_error(vec![create("")], "out = array_clear bad_handle", "out");
+}
+
+#[test]
+fn run_found() {
+    test::run_script_and_validate(
+        vec![
+            create(""),
+            array::create(""),
+            array_length::create(""),
+            array_push::create(""),
+        ],
+        r#"
+        handle = array
+        array_push ${handle} 1
+        array_push ${handle} 2
+        array_push ${handle} 3
+        array_push ${handle} 4
+        array_clear ${handle}
+        out = array_length ${handle}
+        "#,
+        CommandValidation::Match("out".to_string(), "0".to_string()),
+    );
+}

duckscript_sdk/src/sdk/std/collections/mod.rs

@@ -1,4 +1,5 @@
 pub(crate) mod array;
+mod array_clear;
 mod array_concat;
 mod array_contains;
 mod array_get;
@@ -38,6 +39,7 @@ pub(crate) fn load(commands: &mut Commands, parent: &str) -> Result<(), ScriptEr
     let package = pckg::concat(parent, PACKAGE);
 
     commands.set(array::create(&package))?;
+    commands.set(array_clear::create(&package))?;
     commands.set(array_concat::create(&package)?)?;
     commands.set(array_contains::create(&package)?)?;
     commands.set(array_get::create(&package))?;

test/std/collections/array_clear_test.ds

@@ -0,0 +1,29 @@
+
+fn clear_not_empty
+    handle = array
+
+    result = array_push ${handle} 1
+
+    result = array_is_empty ${handle}
+    assert_false ${result}
+
+    result array_clear ${handle}
+    assert ${result}
+
+    result = array_is_empty ${handle}
+    assert ${result}
+
+    release ${handle}
+end
+
+fn clear_empty
+    handle = array
+
+    result array_clear ${handle}
+    assert ${result}
+
+    result = array_is_empty ${handle}
+    assert ${result}
+
+    release ${handle}
+end