builder rewrite wip

Fix/8 progress jumps

.gitignore

@@ -1,6 +1,6 @@
 /target
 dist
-/docs
 res/test/docs/slides/revealjs
+res/test/asciidocs/slides/revealjs
 res/test/result
 result

README.md

@@ -112,6 +112,10 @@ home.packages = with pkgs; [
 ]
 ```
 
+## Configuration
+
+You can configure some of the cli arguments with a config file. It is always located relatively to the current directory under `./docki.config.toml`. Available options and their defaults can be found in the [config.rs](src/app/config/config.rs) file. CLI arguments with the same names as in the config usually have also the same default values.
+
 ## Development
 
 ### Running it

res/test/asciidocs/index.adoc

@@ -0,0 +1,16 @@
+= My Project
+:toc:
+:toc-title:
+:toclevels: 2
+
+== Introduction
+
+This is my project.
+
+== Slides
+
+* link:slides/index.html[Presentation]
+
+== License
+
+This project is licensed under the MIT License - see the link:LICENSE[LICENSE] file for details.

res/test/asciidocs/slides/index.adoc

@@ -0,0 +1,19 @@
+# Slides
+
+## Slide 1
+
+* First
+* Second
+* Third
+
+## Slide 2
+
+* First
+* Second
+* Third
+
+### Slide 3
+
+* First
+* Second
+* Third

res/test/docki.config.toml

@@ -1 +1,3 @@
+docs_dir = "./docs"
 port = 6969
+offline_reveal = false

res/test/docs/index.adoc

@@ -0,0 +1,16 @@
+= My Project
+:toc:
+:toc-title:
+:toclevels: 2
+
+== Introduction
+
+This is my project.
+
+== Slides
+
+* link:slides/index.html[Presentation]
+
+== License
+
+This project is licensed under the MIT License - see the link:LICENSE[LICENSE] file for details.

res/test/docs/slides/index.adoc

@@ -1,11 +1,19 @@
-= My cool presentation
+# Slides
-:author: John Doe
-:email: john@doe.com
 
-== First slide
+## Slide 1
 
-Content
+* First
+* Second
+* Third
 
-== Second slide
+## Slide 2
 
-Content
+* First
+* Second
+* Third
+
+### Slide 3
+
+* First
+* Second
+* Third

src/app/build/asciidoctor.rs

@@ -12,9 +12,13 @@ fn exec_command(command: &mut process::Command) -> Result<(), String> {
         }
     } else {
         println!("{}", result.unwrap_err());
-        return Err(
+
-            "asciidoctor not installed. For more information run docki health!".to_string(),
+        let binary_name = command.get_program().to_str().unwrap_or("Something is");
-        );
+
+        return Err(format!(
+            "{} not installed. For more information run docki health!",
+            binary_name
+        ));
     }
 }
 
@@ -31,11 +35,11 @@ fn asciidoctor_docs(in_path: &str, out_path: &str) -> process::Command {
 fn asciidoctor_slides(in_path: &str, out_path: &str, offline_reveal: bool) -> process::Command {
     let mut command = process::Command::new(format!("asciidoctor-revealjs"));
     let out_dir = parent_path(out_path);
-	let revealjs_path = if offline_reveal {
+    let revealjs_path = if offline_reveal {
-		path_between(out_dir.to_string(), "./dist/slides/revealjs".to_string())
+        path_between(out_dir.to_string(), "./dist/slides/revealjs".to_string())
-	} else {
+    } else {
-		"https://cdn.jsdelivr.net/npm/reveal.js@5.2.1".to_string()
+        "https://cdn.jsdelivr.net/npm/reveal.js@5.2.1".to_string()
-	};
+    };
 
     command
         .arg(format!("{in_path}"))

src/app/build/mod.rs

@@ -1,54 +1 @@
-use std::fs;
-
-use self::asciidoctor::{build_doc, build_slide};
-
-use super::fs_util;
-
 pub mod asciidoctor;
-
-pub fn docki_build(in_path: &str, offline_reveal: bool) -> DockiBuildResult {
-    let out_path = in_path.replace("/docs/", "/dist/");
-    let convert_out_path = out_path.replace(".adoc", ".html");
-
-    if in_path.starts_with("./docs/slides/") && in_path.ends_with(".adoc") {
-        if let Err(err) = build_slide(&in_path, &convert_out_path, offline_reveal) {
-            return DockiBuildResult::Err(err);
-        }
-
-        DockiBuildResult::Slide(convert_out_path)
-    } else if in_path.ends_with(".adoc") {
-        if let Err(err) = build_doc(&in_path, &convert_out_path) {
-            return DockiBuildResult::Err(err);
-        }
-
-        DockiBuildResult::Doc(convert_out_path)
-    } else {
-		if in_path.starts_with("./docs/slides/revealjs") && !offline_reveal {
-			return DockiBuildResult::Silent;
-		}
-
-        if let Err(err) = copy(&in_path, &out_path) {
-            return DockiBuildResult::Err(err);
-        }
-
-        DockiBuildResult::Copy(out_path)
-    }
-}
-
-fn copy(in_path: &str, out_path: &str) -> Result<(), String> {
-    fs_util::create_parent_dir_recursive(out_path);
-
-    if let Err(err) = fs::copy(in_path, out_path) {
-        return Err(err.to_string());
-    }
-
-    Ok(())
-}
-
-pub enum DockiBuildResult {
-    Slide(String),
-    Doc(String),
-    Copy(String),
-    Err(String),
-	Silent,
-}

src/app/commands/build.rs

@@ -1,6 +1,10 @@
+use crate::app::config::config::Config;
+
 use super::executions::build_execution::BuildExecution;
 
-pub async fn build(offline_reveal: bool) -> () {
+pub async fn build(config: &Config) -> () {
-    let mut build_execution = BuildExecution::new();
+    let mut build_execution = BuildExecution::new(config);
-    build_execution.execute(offline_reveal).await.expect("build failed")
+
+	build_execution.prepare().await.expect("could not prepare for build");
+    build_execution.build_dir().expect("build failed")
 }

src/app/commands/executions/build_execution.rs

@@ -1,52 +1,41 @@
 use std::{
-    io::Cursor,
+    fs, io::Cursor, path::PathBuf
-    path::PathBuf
 };
 
 use crate::app::{
-    build::{docki_build, DockiBuildResult},
+    build::{asciidoctor::build_slide, asciidoctor::build_doc}, config::config::Config, fs_util::{self, create_dir_recursive}, log::display_status
-    fs_util::{self, create_dir_recursive}, log::display_status,
 };
 
-pub struct BuildExecution {
+pub struct BuildExecution<'a> {
     progress: usize,
     goal: usize,
+	config: &'a Config
 }
 
-impl BuildExecution {
+impl <'a> BuildExecution <'a> {
-    pub fn new() -> Self {
+    pub fn new(config: &'a Config) -> Self {
-        return BuildExecution {
+        return Self {
             progress: 0,
             goal: 0,
+			config: config
         };
     }
 
-    pub async fn execute(&mut self, offline_reveal: bool) -> Result<(), String> {
+    pub async fn prepare(&self) -> Result<(), String> {
-        let path = "./docs/".to_string();
+        if !fs_util::directory_exists(&self.config.input_dir) {
-
-        if !fs_util::directory_exists(&path) {
             return Err(
                 "docs directory does not exist it. Create it or use the template".to_string(),
             );
         }
 
-        if let Err(error) = Self::prepare(offline_reveal).await {
+		if !self.config.offline_reveal {
-            return Err(error);
-        }
-
-        return self.build_dir(&path, offline_reveal);
-    }
-
-
-    async fn prepare(offline_reveal: bool) -> Result<(), String> {
-		if !offline_reveal {
 			return Ok(())
 		}
 
         let reveal_version = "5.2.1";
         let target = format!("https://github.com/hakimel/reveal.js/archive/{reveal_version}.zip");
 
-        create_dir_recursive("./docs/slides");
+        create_dir_recursive(format!("{}/slides", self.config.input_dir).as_str());
 
 		reqwest::get(target.clone()).await.unwrap();
         let Ok(response) = reqwest::get(target).await else {
@@ -57,7 +46,7 @@ impl BuildExecution {
             return Err("could not extract bytes".to_string())
         };
 
-        let out = PathBuf::from("./docs/slides/revealjs");
+        let out = PathBuf::from(format!("{}/slides/revealjs", self.config.input_dir));
 
         if zip_extract::extract(Cursor::new(bytes), &out, true).is_err() {
             return Err("could not write extracted archive to disk".to_string());
@@ -66,36 +55,83 @@ impl BuildExecution {
         return Ok(());
     }
 
-    fn build_dir(&mut self, path: &str, offline_reveal: bool) -> Result<(), String> {
+    pub fn build_dir(&mut self) -> Result<(), String> {
-        let result = fs_util::fetch_paths_recursive(&path);
+        let result = fs_util::fetch_paths_recursive(&self.config.input_dir);
-
         let Ok(paths) = result else {
             return Err(result.unwrap_err())
         };
 
+		let reveal_dir = format!("{}/slides/revealjs", self.config.input_dir);
+		let paths = paths.into_iter()
+			.filter(|path| self.config.offline_reveal || !path.starts_with(reveal_dir.as_str()))
+			.collect::<Vec<String>>();
+
+		self.goal = paths.len();
+
         for (index, in_path) in paths.iter().enumerate() {
             self.progress = index + 1;
-            self.goal = paths.len();
+            let result = self.build_file(&in_path);
-            let result = docki_build(&in_path, offline_reveal);
 
             match result {
                 DockiBuildResult::Err(err) => {
-                    self.display_building_status("Error", in_path, "");
+                    self.display_building_status("Error", &in_path, "");
                     println!("{}", err)
                 },
                 DockiBuildResult::Copy(out_path) => self.display_building_status("Copy", &in_path, &out_path),
                 DockiBuildResult::Slide(out_path) => self.display_building_status("Slide", &in_path, &out_path),
                 DockiBuildResult::Doc(out_path) => self.display_building_status("Doc", &in_path, &out_path),
-				DockiBuildResult::Silent => ()
             }
         }
 
         return Ok(());
     }
 
+	pub fn build_file(&mut self, path: &str) -> DockiBuildResult {
+		let out_path = path.replace(&self.config.input_dir, "./dist");
+		let convert_out_path = out_path.replace(".adoc", ".html");
+
+		if path.starts_with(format!("{}/slides/", &self.config.input_dir).as_str()) && path.ends_with(".adoc") {
+			if let Err(err) = build_slide(&path, &convert_out_path, self.config.offline_reveal) {
+				return DockiBuildResult::Err(err);
+			}
+
+			DockiBuildResult::Slide(convert_out_path)
+		} else if path.ends_with(".adoc") {
+			if let Err(err) = build_doc(&path, &convert_out_path) {
+				return DockiBuildResult::Err(err);
+			}
+
+			DockiBuildResult::Doc(convert_out_path)
+		} else {
+			if let Err(err) = Self::copy(&path, &out_path) {
+				return DockiBuildResult::Err(err);
+			}
+
+			DockiBuildResult::Copy(out_path)
+		}
+	}
+
+	fn copy(in_path: &str, out_path: &str) -> Result<(), String> {
+		fs_util::create_parent_dir_recursive(out_path);
+
+		if let Err(err) = fs::copy(in_path, out_path) {
+			return Err(err.to_string());
+		}
+
+		Ok(())
+	}
+
     fn display_building_status(&self, status_type: &str, in_path: &str, out_path: &str) -> () {
         let progress_str = format!("{} / {}", self.progress, self.goal);
         display_status(&progress_str, status_type, in_path, out_path);
     }
 
 }
+
+
+pub enum DockiBuildResult {
+    Slide(String),
+    Doc(String),
+    Copy(String),
+    Err(String),
+}

src/app/commands/serve.rs

@@ -7,79 +7,104 @@ use notify::{
 };
 use std::{env, path::Path};
 
-use crate::app::{ watcher::watcher, build::{docki_build, DockiBuildResult}, commands::build::build, log::display_status};
+use crate::app::{ commands::executions::build_execution::{self, BuildExecution, DockiBuildResult}, config::config::Config, log::display_status, watcher::watcher};
 
-
+pub async fn serve(config: &Config) {
-pub async fn serve(port: u16) {
+	let build_execution = BuildExecution::new(config);
-    build(false).await;
+	let mut server = Server::new(build_execution, config);
-    tokio::join!(watch_and_build(), start_server(port));
+	server.serve().await;
 }
 
-async fn watch_and_build() {
+struct Server<'a> {
-    watch(Path::new("./docs"))
+	build_execution: BuildExecution<'a>,
-        .await
+	config: &'a Config,
-        .expect("something went wrong")
+}
+
+impl <'a> Server <'a> {
+	pub fn new(build_execution: BuildExecution<'a>, config: &'a Config) -> Self {
+		return Self {
+			build_execution: build_execution,
+			config: config
+		}
+	}
+
+	async fn serve(&mut self) {
+		self.build_execution.prepare().await.expect("could not prepare for build");
+		self.build_execution.build_dir().expect("build failed");
+		tokio::join!(self.start_server(), self.watch_and_build());
+	}
+
+	async fn start_server(&self) {
+		let link = &format!("http://localhost:{}", self.config.port);
+		let hyperlink = Green.paint(link).hyperlink(link);
+
+		println!(
+			"\nServing at {}",
+			hyperlink
+		);
+
+		let Ok(()) = listen("localhost", self.config.port, "./dist").await else {
+			panic!("could not start server")
+		};
+	}
+
+	async fn watch_and_build(&mut self) {
+		self.watch()
+			.await
+			.expect("something went wrong")
+	}
+
+	async fn watch(&mut self) -> notify::Result<()> {
+		let path = Path::new(&self.config.input_dir);
+		let (mut watcher, mut rx) = watcher()?;
+
+		watcher.watch(path.as_ref(), RecursiveMode::Recursive)?;
+
+		while let Some(res) = rx.next().await {
+			let event = res.expect("watching failed");
+			self.file_change(event)
+		}
+
+		Ok(())
+
+	}
+
+	fn file_change(&mut self, event: Event) {
+		match event.kind {
+			EventKind::Modify(ModifyKind::Data(_)) => self.build_file(event.paths),
+			_ => (),
+		}
+	}
+
+	fn build_file(&mut self, paths: Vec<std::path::PathBuf>) {
+		let invalid_path_message = "changed path is invalid";
+		let in_path = paths
+			.first()
+			.expect(invalid_path_message)
+			.strip_prefix(&current_dir())
+			.expect(invalid_path_message)
+			.to_str()
+			.expect(invalid_path_message);
+
+		let in_path = format!("./{}", in_path);
+		let result = self.build_execution.build_file(&in_path);
+
+		match result {
+			DockiBuildResult::Slide(out_path) => display_rebuilding_status("Slide", &in_path, &out_path),
+			DockiBuildResult::Doc(out_path) => display_rebuilding_status("Doc", &in_path, &out_path),
+			DockiBuildResult::Copy(out_path) => display_rebuilding_status("Copy", &in_path, &out_path),
+			DockiBuildResult::Err(err) => {
+				display_rebuilding_status("Error", &in_path, "");
+				println!("{}", err);
+			},
+		}
+	}
 }
 
 
-async fn start_server(port: u16) {
-	let link = &format!("http://localhost:{}", port);
-	let hyperlink = Green.paint(link).hyperlink(link);
 
-    println!(
-        "\nServing at {}",
-        hyperlink
-    );
 
-    let Ok(()) = listen("localhost", port, "./dist").await else {
-        panic!("could not start server")
-    };
-}
 
-async fn watch(path: &Path) -> notify::Result<()> {
-    let (mut watcher, mut rx) = watcher()?;
-
-    watcher.watch(path.as_ref(), RecursiveMode::Recursive)?;
-
-    while let Some(res) = rx.next().await {
-        let event = res.expect("watching failed");
-        file_change(event)
-    }
-
-    Ok(())
-}
-
-fn file_change(event: Event) {
-    match event.kind {
-        EventKind::Modify(ModifyKind::Data(_)) => build_file(event.paths),
-        _ => (),
-    }
-}
-
-fn build_file(paths: Vec<std::path::PathBuf>) {
-    let invalid_path_message = "changed path is invalid";
-    let in_path = paths
-        .first()
-        .expect(invalid_path_message)
-		.strip_prefix(&current_dir())
-		.expect(invalid_path_message)
-        .to_str()
-        .expect(invalid_path_message);
-
-	let in_path = format!("./{}", in_path);
-    let result = docki_build(&in_path, false);
-
-    match result {
-        DockiBuildResult::Slide(out_path) => display_rebuilding_status("Slide", &in_path, &out_path),
-        DockiBuildResult::Doc(out_path) => display_rebuilding_status("Doc", &in_path, &out_path),
-        DockiBuildResult::Copy(out_path) => display_rebuilding_status("Copy", &in_path, &out_path),
-        DockiBuildResult::Err(err) => {
-            display_rebuilding_status("Error", &in_path, "");
-            println!("{}", err);
-        },
-		DockiBuildResult::Silent => ()
-    }
-}
 
 fn display_rebuilding_status(context: &str, in_path: &str, out_path: &str) {
     display_status("Rebuildng", context, in_path, out_path)

src/app/config/arguments.rs

@@ -1,13 +1,27 @@
-use super::config::Config;
 use clap::{Parser, Subcommand};
+use nu_ansi_term::{AnsiGenericString, Style};
+
+fn github_hyperlink() -> AnsiGenericString<'static, str> {
+    return Style::new()
+        .bold()
+        .underline()
+        .paint("https://github.com/quirinecker/docki")
+        .hyperlink("https://github.com/quirinecker/docki");
+}
 
 #[derive(Parser)]
+#[command(after_help = format!("More information like defaults can be found at {}", github_hyperlink()))]
 pub struct Args {
     #[command(subcommand)]
     pub command: CommandArg,
 
-    #[arg(short, long)]
+    /// The directory where the documentation is located
-    pub docs_dir: Option<String>,
+    #[arg(short, long, global = true)]
+    pub input_dir: Option<String>,
+
+    /// The directory where the documentation will be built
+    #[arg(short, long, global = true)]
+    pub output_dir: Option<String>,
 }
 
 #[derive(Subcommand)]

src/app/config/config.rs

@@ -5,44 +5,46 @@ use crate::app::config::arguments::CommandArg;
 #[derive(Deserialize, Debug)]
 #[serde(default)]
 pub struct Config {
-	pub port: u16,
+    pub port: u16,
-	pub docs_dir: String,
+    pub input_dir: String,
-	pub offline_reveal: bool,
+    pub offline_reveal: bool,
+	pub output_dir: String
 }
 
 impl Config {
     pub fn load() -> Result<Self, config::ConfigError> {
-
         let s = config::Config::builder()
             .add_source(config::File::with_name("./docki.config.toml"))
             .build()?;
         s.try_deserialize()
     }
 
-	pub fn merge_with_args(self, args: &super::arguments::Args) -> Self {
+    pub fn merge_with_args(self, args: &super::arguments::Args) -> Self {
-		Self {
+        Self {
-			port: match args.command {
+            port: match args.command {
-				CommandArg::Serve { port } => port.unwrap_or(self.port),
+                CommandArg::Serve { port } => port.unwrap_or(self.port),
-				_ => self.port,
+                _ => self.port,
-			},
+            },
-			docs_dir: args.docs_dir.clone().unwrap_or(self.docs_dir),
+            input_dir: args.input_dir.clone().unwrap_or(self.input_dir),
-			offline_reveal: {
+			output_dir: args.output_dir.clone().unwrap_or(self.output_dir),
-				if let CommandArg::Build { offline_reveal } = args.command {
+            offline_reveal: {
-					offline_reveal
+                if let CommandArg::Build { offline_reveal } = args.command {
-				} else {
+                    offline_reveal
-					self.offline_reveal
+                } else {
-				}
+                    self.offline_reveal
-			}
+                }
-		}
+            },
-	}
+        }
+    }
 }
 
 impl Default for Config {
-	fn default() -> Self {
+    fn default() -> Self {
-		Self {
+        Self {
-			port: 8080,
+            port: 8080,
-			docs_dir: "./docs".to_string(),
+            input_dir: "./docs".to_string(),
-			offline_reveal: false,
+			output_dir: "./dist".to_string(),
-		}
+            offline_reveal: false,
-	}
+        }
+    }
 }

src/app/mod.rs

@@ -26,10 +26,10 @@ impl App {
         Self::setup_environment_variables();
 
         match args.command {
-            CommandArg::Build { .. } => build(config.offline_reveal).await,
+            CommandArg::Build { .. } => build(&config).await,
             CommandArg::Health => health(),
             CommandArg::InstallReveal => install_reveal().await,
-            CommandArg::Serve { .. } => serve(config.port).await,
+            CommandArg::Serve { .. } => serve(&config).await,
             CommandArg::Completions { shell } => completions(shell)
         };
     }