Start sketching out scripting ideas

Cargo.toml

@@ -64,18 +64,19 @@ byte-unit = "4.0.19"
 # dev dependencies
 tempfile = "3.5.0"
 aho-corasick = "1.0"
+rstest = "0.17"
+quickcheck = "1"
+quickcheck_macros = "1"
+pretty_assertions = "1"
 
 # infer file and MIME type by magic number
 infer = "0.13"
 mime = "0.3"
 
-rstest = "0.17"
-quickcheck = "1"
-quickcheck_macros = "1"
-pretty_assertions = "1"
+# Scripting
+rhai = { version = "1.14.0", features = ["serde"] }
 
 # TODO: Needed Dependencies
-# rhai = { version = "1.14.0", features = ["serde"] }
 # czkawka_core = "4.1.0"
 # + Lazy-regex?
 # https://crates.io/crates/lazy-regex
@@ -132,6 +133,8 @@ itertools = { workspace = true }
 clap_complete = { workspace = true }
 indicatif = { workspace = true }
 winnow = { workspace = true }
+rhai = { workspace = true }
+
 
 [dev-dependencies]
 abscissa_core = { workspace = true, features = ["testing"] }

README.md

@@ -22,7 +22,7 @@ This is a Rust implementation of the same concept.
 
 - Filter `files`, which are `smaller than` 20KB in one location:
 
-  `organize filter size -l C:\Users\dailyuse\dev-src\organize\docs\screenshots -t files --condition ..20KB`
+  `organize filter size -l C:\Users\dailyuse\dev-src\organize\docs\screenshots -t files --range ..20KB`
 
   This filter uses the `range` syntax (always inclusive) of Rust:
 

justfile

@@ -123,3 +123,7 @@ inv-ft *ARGS:
 # Checks the public api against the latest pubished version
 pa:
 	cargo public-api diff latest
+
+# Run a sample script
+run:
+	cargo run -- run-script --path C:\Users\dailyuse\dev-src\organize\scripts\test.rhai

scripts/test.rhai

@@ -0,0 +1,16 @@
+print("Hello from rhai script!");
+
+let folder = "C:\\Users\\dailyuse\\dev-src\\organize\\tests";
+
+let apps_ext = ["exe", "msi", "apk"];
+
+let entries = init_organize(folder);
+let ext_entries = filter::by_extension(entries, apps_ext);
+let last_modified = filter::by_last_modified(ext_entries, "..7d")
+
+action::move(last_modified, "~/backup/INBOX/@Apps/")
+
+let app_inbox_folder = "~/backup/INBOX/@Apps/";
+filter::by_extension(entries, apps_ext) move_to app_inbox_folder;
+
+filter(folder->by_extension(apps_ext)) => action(move->app_inbox_folder);

src/commands.rs

@@ -1,9 +1,10 @@
 //! Organize Subcommands
 
-mod action;
+pub mod action;
 mod completions;
 mod docs;
-mod filter;
+pub mod filter;
+mod run_script;
 
 // Old approach
 // mod edit;
@@ -13,7 +14,10 @@ mod filter;
 // mod sim;
 
 use crate::{
-    commands::{action::ActionCmd, completions::CompletionsCmd, docs::DocsCmd, filter::FilterCmd},
+    commands::{
+        action::ActionCmd, completions::CompletionsCmd, docs::DocsCmd, filter::FilterCmd,
+        run_script::RunScriptCmd,
+    },
     config::OrganizeConfig,
 };
 use abscissa_core::{Command, Configurable, FrameworkError, Runnable};
@@ -48,6 +52,8 @@ pub enum OrganizeCmd {
     Filter(FilterCmd),
     /// Generate Completions for your shell
     Completions(CompletionsCmd),
+    /// Run a `rhai` script
+    RunScript(RunScriptCmd),
 }
 
 #[allow(clippy::struct_excessive_bools)]

src/commands/action.rs

@@ -11,7 +11,7 @@ use organize_rs_core::rules::actions::OrganizeAction;
 /// for a more comprehensive example:
 ///
 /// <https://docs.rs/clap/>
-#[derive(Command, Debug, Args)]
+#[derive(Command, Debug, Args, Clone)]
 pub struct ActionCmd {
     #[clap(subcommand)]
     actions: OrganizeAction,

src/commands/completions.rs

@@ -11,7 +11,7 @@ use clap::{Args, CommandFactory, ValueEnum};
 use clap_complete::{generate, shells, Generator};
 
 /// `completions` subcommand
-#[derive(Args, Command, Debug)]
+#[derive(Args, Command, Debug, Clone)]
 pub struct CompletionsCmd {
     /// Shell to generate completions for
     #[arg(value_enum)]

src/commands/docs.rs

@@ -4,7 +4,7 @@ use abscissa_core::{Command, Runnable};
 use clap::Args;
 
 /// Opens the documentation.
-#[derive(Command, Debug, Args)]
+#[derive(Command, Debug, Args, Clone)]
 pub struct DocsCmd {}
 
 impl Runnable for DocsCmd {

src/commands/filter.rs

@@ -1,6 +1,6 @@
 //! Filters that organize can apply
 
-use std::fs::FileType;
+use std::{fs::FileType, path::PathBuf};
 
 use abscissa_core::{Command, Runnable};
 use clap::Args;
@@ -20,14 +20,14 @@ use organize_rs_core::{
 /// for a more comprehensive example:
 ///
 /// <https://docs.rs/clap/>
-#[derive(Command, Debug, Args)]
+#[derive(Command, Debug, Args, Clone)]
 pub struct FilterCmd {
     #[clap(subcommand)]
     filters: OrganizeFilter,
 
     /// Locations to operate on
     #[arg(short, long, global = true)]
-    locations: Vec<String>,
+    locations: Vec<PathBuf>,
 
     /// Words in file names to be ignored
     #[arg(long, global = true)]

src/commands/run_script.rs

@@ -0,0 +1,48 @@
+//! `run` subcommand
+
+use std::{
+    fs::read_to_string,
+    path::{Path, PathBuf},
+};
+
+use abscissa_core::{status_err, Application, Command, Runnable, Shutdown};
+use clap::Parser;
+use rhai::{Engine, EvalAltResult};
+
+use crate::{application::ORGANIZE_APP, commands::filter::FilterCmd, scripting::add};
+
+/// Run a *.rhai script with organize
+#[derive(Command, Debug, Parser)]
+pub struct RunScriptCmd {
+    /// Path to the *.rhai script that should be run
+    #[clap(long)]
+    path: PathBuf,
+}
+
+impl Runnable for RunScriptCmd {
+    /// Start the application.
+    fn run(&self) {
+        match start_scripting_engine(&self.path) {
+            Ok(_) => {}
+            Err(err) => {
+                status_err!("failed to execute script: {}", err);
+                ORGANIZE_APP.shutdown(Shutdown::Crash)
+            }
+        };
+    }
+}
+
+fn start_scripting_engine(path: impl Into<PathBuf>) -> Result<(), Box<EvalAltResult>> {
+    // Create an 'Engine'
+    let mut engine = Engine::new();
+
+    engine.register_fn("add", add);
+
+    // engine.build_type::<FilterCmd>();
+
+    // Run the script
+    engine.run_file(path.into())?;
+
+    // Done!
+    Ok(())
+}

src/lib.rs

@@ -31,3 +31,4 @@ pub mod commands;
 pub mod config;
 pub mod error;
 pub mod prelude;
+pub mod scripting;