fix: 🐛 fixed recursive extraction and excluded subcrates from workspaces

Author: arctic-hen7

bonnie.toml

@@ -10,7 +10,6 @@ dev.subcommands.serve.cmd = [
 	"bonnie serve %server"
 ]
 dev.subcommands.serve.args = [ "server" ]
-# TODO fix this with an example
 dev.subcommands.cli = [
 	"cd packages/perseus-cli",
 	"cargo run -- %%"

examples/basic/.gitignore

@@ -1 +1,2 @@
-.perseus/
+
+.perseus/

packages/perseus-cli/src/bin/main.rs

@@ -8,7 +8,7 @@ use lib::errors::*;
 fn main() {
     // In development, we'll test in the `basic` example
     if cfg!(debug_assertions) {
-        env::set_current_dir("../../examples/cli").unwrap();
+        env::set_current_dir("../../examples/basic").unwrap();
     }
     let exit_code = real_main();
     std::process::exit(exit_code)
@@ -77,6 +77,10 @@ fn core(dir: PathBuf) -> Result<i32> {
                 prepare(dir.clone())?;
 		    	let exit_code = serve(dir, &prog_args)?;
                 Ok(exit_code)
+            } else if prog_args[0] == "prep" {
+                // Set up the '.perseus/' directory if needed
+                prepare(dir.clone())?;
+                Ok(0)
             } else if prog_args[0] == "clean" {
 		    	// Just delete the '.perseus/' directory directly, as we'd do in a corruption
                 delete_bad_dir(dir)?;

packages/perseus-cli/src/extraction.rs

@@ -0,0 +1,30 @@
+// This file contains a temporary fix for the issues with recursive extraction in `include_dir`
+// Tracking issue is https://github.com/Michael-F-Bryan/include_dir/issues/59
+
+use std::path::Path;
+use include_dir::Dir;
+use std::io::Write;
+
+/// Extracts a directory included with `include_dir!` until issue #59 is fixed on that module (recursive extraction support).
+pub fn extract_dir<S: AsRef<Path>>(dir: Dir, path: S) -> std::io::Result<()> {
+    let path = path.as_ref();
+
+    // Create all the subdirectories in here (but not their files yet)
+    for dir in dir.dirs() {
+        std::fs::create_dir_all(path.join(dir.path()))?;
+        // Recurse for this directory
+        extract_dir(*dir, path)?;
+    }
+
+    // Write all the files at the root of this directory
+    for file in dir.files() {
+        let mut fsf = std::fs::OpenOptions::new()
+            .write(true)
+            .create_new(true)
+            .open(path.join(file.path()))?;
+        fsf.write_all(file.contents())?;
+        fsf.sync_all()?;
+    }
+
+    Ok(())
+}

packages/perseus-cli/src/lib.rs

@@ -5,6 +5,8 @@ mod build;
 mod serve;
 mod cmd;
 
+mod extraction;
+
 use errors::*;
 use std::fs;
 use std::path::PathBuf;

packages/perseus-cli/src/prepare.rs

@@ -8,12 +8,11 @@ use std::process::Command;
 use cargo_toml::Manifest;
 use crate::errors::*;
 use crate::PERSEUS_VERSION;
+use crate::extraction::extract_dir;
 
 /// This literally includes the entire subcrate in the program, allowing more efficient development.
 const SUBCRATES: Dir = include_dir!("../../examples/cli/.perseus");
-// const SUBCRATES: Dir = include_dir!("./test");
 
-// BUG: `include_dir` currently doesn't support recursive extraction, tracking issue is https://github.com/Michael-F-Bryan/include_dir/issues/59
 /// Prepares the user's project by copying in the `.perseus/` subcrates. We use these subcrates to do all the building/serving, we just
 /// have to execute the right commands in the CLI. We can essentially treat the subcrates themselves as a blackbox of just a folder.
 pub fn prepare(dir: PathBuf) -> Result<()> {
@@ -32,7 +31,7 @@ pub fn prepare(dir: PathBuf) -> Result<()> {
             bail!(ErrorKind::ExtractionFailed(target.to_str().map(|s| s.to_string()), err.to_string()))
         }
         // Notably, this function will not do anything or tell us if the directory already exists...
-        if let Err(err) = SUBCRATES.extract(&target) {
+        if let Err(err) =  extract_dir(SUBCRATES, &target) {
             bail!(ErrorKind::ExtractionFailed(target.to_str().map(|s| s.to_string()), err.to_string()))
         }
         // Use the current version of this crate (and thus all Perseus crates) to replace the relative imports
@@ -56,12 +55,15 @@ pub fn prepare(dir: PathBuf) -> Result<()> {
         };
         // Replace the relative path references to Perseus packages
         // Also update the name of the user's crate (Cargo needs more than just a path and an alias)
+        // Also add an empty `[workspace]` key so we exclude from any of the user's workspace settings
         let updated_root_manifest = root_manifest_contents
             .replace("{ path = \"../../../packages/perseus\" }", &format!("\"{}\"", PERSEUS_VERSION))
-            .replace("perseus-example-cli", &user_crate_name);
+            .replace("perseus-example-cli", &user_crate_name)
+            + "\n[workspace]";
         let updated_server_manifest = server_manifest_contents
             .replace("{ path = \"../../../../packages/perseus-actix-web\" }", &format!("\"{}\"", PERSEUS_VERSION))
-            .replace("perseus-example-cli", &user_crate_name);
+            .replace("perseus-example-cli", &user_crate_name)
+            + "\n[workspace]";
         // Write the updated manifests back
         if let Err(err) = fs::write(&root_manifest, updated_root_manifest) {
             bail!(ErrorKind::ManifestUpdateFailed(root_manifest.to_str().map(|s| s.to_string()), err.to_string()))