From 5cd1c075a5ef6e3175e8de9f48b3b510d9ee586b Mon Sep 17 00:00:00 2001
From: Martin Berg Alstad <600878@stud.hvl.no>
Date: Sun, 14 Jul 2024 23:59:36 +0200
Subject: [PATCH] Read files macro for loading reading files to string at
 compile-time

Makefile for formatting and linting

Workspace for subcrates.

Moved crates to subdir and moved subcrate configs to workspace.*
---
 .github/workflows/build.yaml                  |   2 +-
 .idea/lib.iml                                 |   9 +-
 .../{Test.xml => All_Tests.xml}               |   6 +-
 .idea/runConfigurations/Release.xml           |  19 +++
 .idea/rust.xml                                |   6 +
 Cargo.lock                                    |  72 ++++++++--
 Cargo.toml                                    |  29 +++-
 Makefile                                      |   3 +
 README.md                                     |   3 +
 crates/into_response_derive/Cargo.toml        |  12 ++
 .../into_response_derive/src/derive.rs        |  13 +-
 crates/into_response_derive/src/lib.rs        |  13 ++
 crates/read_files/Cargo.toml                  |  13 ++
 crates/read_files/src/lib.rs                  |  34 +++++
 crates/read_files/src/read_files.rs           | 124 ++++++++++++++++++
 crates/read_files/tests/lib.rs                |  13 ++
 derive/Cargo.lock                             |  46 -------
 derive/Cargo.toml                             |  12 --
 src/lib.rs                                    |   8 +-
 19 files changed, 342 insertions(+), 95 deletions(-)
 rename .idea/runConfigurations/{Test.xml => All_Tests.xml} (72%)
 create mode 100644 .idea/runConfigurations/Release.xml
 create mode 100644 .idea/rust.xml
 create mode 100644 Makefile
 create mode 100644 README.md
 create mode 100644 crates/into_response_derive/Cargo.toml
 rename derive/src/lib.rs => crates/into_response_derive/src/derive.rs (56%)
 create mode 100644 crates/into_response_derive/src/lib.rs
 create mode 100644 crates/read_files/Cargo.toml
 create mode 100644 crates/read_files/src/lib.rs
 create mode 100644 crates/read_files/src/read_files.rs
 create mode 100644 crates/read_files/tests/lib.rs
 delete mode 100644 derive/Cargo.lock
 delete mode 100644 derive/Cargo.toml

diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml
index 54ff74f..bdcbe73 100644
--- a/.github/workflows/build.yaml
+++ b/.github/workflows/build.yaml
@@ -15,4 +15,4 @@ jobs:
       - name: Build
         run: cargo build --verbose
       - name: Run tests
-        run: cargo test --verbose --all-features
\ No newline at end of file
+        run: cargo test --verbose --all-features --workspace
\ No newline at end of file
diff --git a/.idea/lib.iml b/.idea/lib.iml
index df2683d..2235a63 100644
--- a/.idea/lib.iml
+++ b/.idea/lib.iml
@@ -2,13 +2,18 @@
 <module type="EMPTY_MODULE" version="4">
   <component name="NewModuleRootManager">
     <content url="file://$MODULE_DIR$">
-      <sourceFolder url="file://$MODULE_DIR$/derive/src" isTestSource="false" />
       <sourceFolder url="file://$MODULE_DIR$/src" isTestSource="false" />
       <sourceFolder url="file://$MODULE_DIR$/examples" isTestSource="false" />
       <sourceFolder url="file://$MODULE_DIR$/examples/multipart_file/src" isTestSource="false" />
-      <excludeFolder url="file://$MODULE_DIR$/derive/target" />
+      <sourceFolder url="file://$MODULE_DIR$/crates/into_response_derive/src" isTestSource="false" />
+      <sourceFolder url="file://$MODULE_DIR$/crates/read_files/src" isTestSource="false" />
+      <sourceFolder url="file://$MODULE_DIR$/crates/read_files/tests" isTestSource="true" />
+      <sourceFolder url="file://$MODULE_DIR$/crates/read_files/tests" isTestSource="true" />
+      <sourceFolder url="file://$MODULE_DIR$/tests" isTestSource="true" />
       <excludeFolder url="file://$MODULE_DIR$/target" />
       <excludeFolder url="file://$MODULE_DIR$/examples/multipart_file/target" />
+      <excludeFolder url="file://$MODULE_DIR$/crates/into_response_derive/target" />
+      <excludeFolder url="file://$MODULE_DIR$/crates/read_files/target" />
     </content>
     <orderEntry type="inheritedJdk" />
     <orderEntry type="sourceFolder" forTests="false" />
diff --git a/.idea/runConfigurations/Test.xml b/.idea/runConfigurations/All_Tests.xml
similarity index 72%
rename from .idea/runConfigurations/Test.xml
rename to .idea/runConfigurations/All_Tests.xml
index 88793f3..6736382 100644
--- a/.idea/runConfigurations/Test.xml
+++ b/.idea/runConfigurations/All_Tests.xml
@@ -1,12 +1,12 @@
 <component name="ProjectRunConfigurationManager">
-  <configuration default="false" name="Test" type="CargoCommandRunConfiguration" factoryName="Cargo Command">
-    <option name="command" value="test --package lib --lib tests --all-features" />
+  <configuration default="false" name="All Tests" type="CargoCommandRunConfiguration" factoryName="Cargo Command">
+    <option name="command" value="test --workspace" />
     <option name="workingDirectory" value="file://$PROJECT_DIR$" />
     <envs />
     <option name="emulateTerminal" value="true" />
     <option name="channel" value="DEFAULT" />
     <option name="requiredFeatures" value="true" />
-    <option name="allFeatures" value="false" />
+    <option name="allFeatures" value="true" />
     <option name="withSudo" value="false" />
     <option name="buildTarget" value="REMOTE" />
     <option name="backtrace" value="SHORT" />
diff --git a/.idea/runConfigurations/Release.xml b/.idea/runConfigurations/Release.xml
new file mode 100644
index 0000000..52d7023
--- /dev/null
+++ b/.idea/runConfigurations/Release.xml
@@ -0,0 +1,19 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="Release" type="CargoCommandRunConfiguration" factoryName="Cargo Command">
+    <option name="command" value="build --release --all-features" />
+    <option name="workingDirectory" value="file://$PROJECT_DIR$" />
+    <envs />
+    <option name="emulateTerminal" value="true" />
+    <option name="channel" value="DEFAULT" />
+    <option name="requiredFeatures" value="true" />
+    <option name="allFeatures" value="true" />
+    <option name="withSudo" value="false" />
+    <option name="buildTarget" value="REMOTE" />
+    <option name="backtrace" value="SHORT" />
+    <option name="isRedirectInput" value="false" />
+    <option name="redirectInputPath" value="" />
+    <method v="2">
+      <option name="CARGO.BUILD_TASK_PROVIDER" enabled="true" />
+    </method>
+  </configuration>
+</component>
\ No newline at end of file
diff --git a/.idea/rust.xml b/.idea/rust.xml
new file mode 100644
index 0000000..7bc91ea
--- /dev/null
+++ b/.idea/rust.xml
@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="RsVcsConfiguration">
+    <option name="rustFmt" value="true" />
+  </component>
+</project>
\ No newline at end of file
diff --git a/Cargo.lock b/Cargo.lock
index 685d8eb..5683333 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -17,6 +17,15 @@ version = "1.0.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "f26201604c87b1e01bd3d98f8d5d9a8fcbb815e8cedb41ffccbeb4bf593a35fe"
 
+[[package]]
+name = "aho-corasick"
+version = "1.1.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8e60d3430d3a69478ad0993f19238d2df97c507009a52b3c10addcd7f6bcb916"
+dependencies = [
+ "memchr",
+]
+
 [[package]]
 name = "async-trait"
 version = "0.1.80"
@@ -123,14 +132,6 @@ version = "1.0.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "baf1de4339761588bc0619e3cbc0120ee582ebb74b53b4efbf79117bd2da40fd"
 
-[[package]]
-name = "derive"
-version = "1.0.0"
-dependencies = [
- "quote",
- "syn",
-]
-
 [[package]]
 name = "encoding_rs"
 version = "0.8.34"
@@ -280,6 +281,14 @@ dependencies = [
  "tokio",
 ]
 
+[[package]]
+name = "into-response-derive"
+version = "1.1.0"
+dependencies = [
+ "quote",
+ "syn",
+]
+
 [[package]]
 name = "itoa"
 version = "1.0.11"
@@ -294,11 +303,12 @@ checksum = "bbd2bcb4c963f2ddae06a2efc7e9f3591312473c50c6685e1f298068316e66fe"
 
 [[package]]
 name = "lib"
-version = "1.3.5"
+version = "1.4.0"
 dependencies = [
  "axum",
- "derive",
+ "into-response-derive",
  "nom",
+ "read-files",
  "serde",
  "thiserror",
  "tokio",
@@ -479,6 +489,44 @@ dependencies = [
  "proc-macro2",
 ]
 
+[[package]]
+name = "read-files"
+version = "0.1.0"
+dependencies = [
+ "quote",
+ "regex",
+ "syn",
+]
+
+[[package]]
+name = "regex"
+version = "1.10.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b91213439dad192326a0d7c6ee3955910425f441d7038e0d6933b0aec5c4517f"
+dependencies = [
+ "aho-corasick",
+ "memchr",
+ "regex-automata",
+ "regex-syntax",
+]
+
+[[package]]
+name = "regex-automata"
+version = "0.4.7"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "38caf58cc5ef2fed281f89292ef23f6365465ed9a41b7a7754eb4e26496c92df"
+dependencies = [
+ "aho-corasick",
+ "memchr",
+ "regex-syntax",
+]
+
+[[package]]
+name = "regex-syntax"
+version = "0.8.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7a66a03ae7c801facd77a29370b4faec201768915ac14a721ba36f20bc9c209b"
+
 [[package]]
 name = "rustc-demangle"
 version = "0.1.24"
@@ -583,9 +631,9 @@ checksum = "6980e8d7511241f8acf4aebddbb1ff938df5eebe98691418c4468d0b72a96a67"
 
 [[package]]
 name = "syn"
-version = "2.0.67"
+version = "2.0.71"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "ff8655ed1d86f3af4ee3fd3263786bc14245ad17c4c7e85ba7187fb3ae028c90"
+checksum = "b146dcf730474b4bcd16c311627b31ede9ab149045db4d6088b3becaea046462"
 dependencies = [
  "proc-macro2",
  "quote",
diff --git a/Cargo.toml b/Cargo.toml
index b37a9e6..afd992a 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -1,10 +1,21 @@
-[package]
-name = "lib"
-version = "1.3.5"
+[workspace]
+members = ["crates/*"]
+
+[workspace.package]
 edition = "2021"
+rust-version = "1.79.0"
 authors = ["Martin Berg Alstad"]
 homepage = "emberal.github.io"
 
+[package]
+name = "lib"
+version = "1.4.0"
+description = "A library with utilities and helper fuctions."
+edition = { workspace = true }
+rust-version = { workspace = true }
+authors = { workspace = true }
+homepage = { workspace = true }
+
 [lib]
 
 [dependencies]
@@ -22,10 +33,15 @@ tracing = { version = "0.1.40", optional = true }
 tracing-subscriber = { version = "0.3.18", optional = true }
 # Parsing
 nom = { version = "7.1.3", optional = true }
+# Procedural macros
+into-response-derive = { path = "crates/into_response_derive", optional = true }
+read-files = { path = "crates/read_files", optional = true }
 # Serialization / Deserialization
 serde = { version = "1.0.203", optional = true, features = ["derive"] }
-# Derive macros
-derive = { path = "derive", optional = true }
+
+[workspace.dependencies]
+syn = "2.0.71"
+quote = "1.0.36"
 
 [features]
 axum = ["dep:axum", "dep:tower", "dep:tower-http", "dep:thiserror", "dep:tracing", "dep:tracing-subscriber", "dep:tokio"]
@@ -33,4 +49,5 @@ io = ["dep:tokio", "dep:tokio-util"]
 iter = []
 nom = ["dep:nom"]
 serde = ["dep:serde"]
-derive = ["dep:derive", "axum", "serde"]
+derive = ["dep:into-response-derive", "axum", "serde"]
+read-files = ["dep:read-files"]
diff --git a/Makefile b/Makefile
new file mode 100644
index 0000000..554d9f5
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,3 @@
+fmt:
+	cargo clippy --all-targets --all-features
+	cargo fmt
\ No newline at end of file
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..50c95e1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,3 @@
+# Lib
+
+-_-
diff --git a/crates/into_response_derive/Cargo.toml b/crates/into_response_derive/Cargo.toml
new file mode 100644
index 0000000..86b8671
--- /dev/null
+++ b/crates/into_response_derive/Cargo.toml
@@ -0,0 +1,12 @@
+[package]
+name = "into-response-derive"
+version = "1.1.0"
+edition = { workspace = true }
+rust-version = { workspace = true }
+
+[lib]
+proc-macro = true
+
+[dependencies]
+syn = { workspace = true }
+quote = { workspace = true }
diff --git a/derive/src/lib.rs b/crates/into_response_derive/src/derive.rs
similarity index 56%
rename from derive/src/lib.rs
rename to crates/into_response_derive/src/derive.rs
index 42d5146..f9ffba3 100644
--- a/derive/src/lib.rs
+++ b/crates/into_response_derive/src/derive.rs
@@ -1,16 +1,9 @@
-extern crate proc_macro;
-
 use proc_macro::TokenStream;
+
 use quote::quote;
-use syn::{parse_macro_input, DeriveInput};
+use syn::DeriveInput;
 
-#[proc_macro_derive(IntoResponse)]
-pub fn into_response_derive(input: TokenStream) -> TokenStream {
-    let input = parse_macro_input!(input as DeriveInput);
-    into_response_derive_impl(input)
-}
-
-fn into_response_derive_impl(input: DeriveInput) -> TokenStream {
+pub fn into_response_derive_impl(input: DeriveInput) -> TokenStream {
     let name = &input.ident;
 
     let expanded = quote! {
diff --git a/crates/into_response_derive/src/lib.rs b/crates/into_response_derive/src/lib.rs
new file mode 100644
index 0000000..5cdf5fe
--- /dev/null
+++ b/crates/into_response_derive/src/lib.rs
@@ -0,0 +1,13 @@
+extern crate proc_macro;
+use {
+    proc_macro::TokenStream,
+    syn::{parse_macro_input, DeriveInput},
+};
+
+mod derive;
+
+#[proc_macro_derive(IntoResponse)]
+pub fn into_response_derive(input: TokenStream) -> TokenStream {
+    let input = parse_macro_input!(input as DeriveInput);
+    derive::into_response_derive_impl(input)
+}
diff --git a/crates/read_files/Cargo.toml b/crates/read_files/Cargo.toml
new file mode 100644
index 0000000..6ee54fd
--- /dev/null
+++ b/crates/read_files/Cargo.toml
@@ -0,0 +1,13 @@
+[package]
+name = "read-files"
+version = "0.1.0"
+edition = { workspace = true }
+rust-version = { workspace = true }
+
+[lib]
+proc-macro = true
+
+[dependencies]
+syn = { workspace = true }
+quote = { workspace = true }
+regex = "1.10.5"
diff --git a/crates/read_files/src/lib.rs b/crates/read_files/src/lib.rs
new file mode 100644
index 0000000..3c98159
--- /dev/null
+++ b/crates/read_files/src/lib.rs
@@ -0,0 +1,34 @@
+extern crate proc_macro;
+use proc_macro::TokenStream;
+
+use syn::parse_macro_input;
+
+use crate::read_files::read_files_to_string_impl;
+
+mod read_files;
+
+/// Read files from a directory into a HashMap.
+/// The key is the file path relative to the root directory.
+/// The value is the file contents as a string.
+/// # Arguments
+/// * `path` - The directory to search for files, relative to the root directory.
+/// * `pattern` - The regex pattern to match files against. If missing, all files are matched.
+/// # Returns
+/// A HashMap containing the file paths and contents.
+/// # Example
+/// ```
+/// use read_files::read_files_to_string;
+///
+/// let files = read_files_to_string!("./src", ".rs$");
+/// assert!(!files.is_empty());
+/// ```
+/// # Panics
+/// If the path is empty. \
+/// If the pattern is invalid. \
+/// If the path does not exist. \
+/// If there are unexpected tokens. \
+#[proc_macro]
+pub fn read_files_to_string(input: TokenStream) -> TokenStream {
+    let args = parse_macro_input!(input as read_files::Args);
+    read_files_to_string_impl(args)
+}
diff --git a/crates/read_files/src/read_files.rs b/crates/read_files/src/read_files.rs
new file mode 100644
index 0000000..4c9e3d9
--- /dev/null
+++ b/crates/read_files/src/read_files.rs
@@ -0,0 +1,124 @@
+extern crate proc_macro;
+
+use proc_macro::TokenStream;
+use std::{
+    collections::HashMap,
+    fs::{metadata, read_dir, read_to_string},
+    io,
+    path::{Path, PathBuf},
+};
+
+use quote::quote;
+use syn::{
+    parse::{Parse, ParseStream},
+    LitStr, Token,
+};
+
+pub fn read_files_to_string_impl(args: Args) -> TokenStream {
+    let (keys, values) = split_hashmap(args);
+
+    let expanded = quote! {
+        {
+            let keys = vec![#( #keys, )*];
+            let values = vec![#( #values, )*];
+            keys.into_iter()
+                .zip(values.into_iter())
+                .collect::<std::collections::HashMap<&'static str, &'static str>>()
+        }
+    };
+    expanded.into()
+}
+
+pub struct Args {
+    pub path: String,
+    pub pattern: String,
+}
+
+struct Syntax {
+    path: LitStr,
+    /* Comma */
+    pattern: Option<LitStr>,
+}
+
+impl From<Syntax> for Args {
+    fn from(syntax: Syntax) -> Self {
+        Self {
+            path: syntax.path.value(),
+            pattern: syntax
+                .pattern
+                .map(|pattern| pattern.value())
+                .unwrap_or_default(),
+        }
+    }
+}
+
+impl Parse for Args {
+    fn parse(stream: ParseStream) -> syn::Result<Self> {
+        if stream.is_empty() {
+            panic!("Expected path argument");
+        }
+
+        let path: LitStr = stream.parse()?;
+        if path.value().is_empty() {
+            panic!("Path must not be empty");
+        }
+
+        let pattern = if stream.peek(Token![,]) {
+            stream.parse::<Token![,]>()?;
+            Some(stream.parse()?)
+        } else {
+            None
+        };
+
+        let syntax = Syntax { path, pattern };
+        if !stream.is_empty() {
+            panic!("Expected end of input");
+        }
+
+        Ok(syntax.into())
+    }
+}
+
+pub fn split_hashmap(args: Args) -> (Vec<String>, Vec<String>) {
+    read_files_to_string(Path::new(&args.path), &args.pattern)
+        .unwrap()
+        .into_iter()
+        .map(|(key, value)| (key.to_string_lossy().to_string(), value))
+        .collect()
+}
+
+/// Find files within a directory and load them into a HashMap.
+/// The key is the file path relative to the root directory.
+/// The value is the file contents as a string.
+/// # Arguments
+/// * `path` - The directory to search for files.
+/// * `extension` - The pattern to match files against.
+/// # Returns
+/// A HashMap containing the file paths and contents.
+pub fn read_files_to_string(
+    path: &Path,
+    pattern: &str,
+) -> Result<HashMap<PathBuf, String>, io::Error> {
+    use regex::Regex;
+
+    let mut files: HashMap<PathBuf, String> = HashMap::new();
+    let dir = read_dir(path)?;
+
+    for entry in dir {
+        let entry = entry?;
+        let path = entry.path();
+        let file_name = entry.file_name();
+        let file_name = file_name.to_string_lossy();
+        let metadata = metadata(&path)?;
+
+        let regex =
+            Regex::new(pattern).map_err(|e| io::Error::new(io::ErrorKind::InvalidInput, e))?;
+        if metadata.is_file() && regex.is_match(file_name.as_ref()) {
+            let file = read_to_string(&path)?;
+            files.insert(path, file);
+        } else if metadata.is_dir() {
+            files.extend(read_files_to_string(&path, pattern)?);
+        }
+    }
+    Ok(files)
+}
diff --git a/crates/read_files/tests/lib.rs b/crates/read_files/tests/lib.rs
new file mode 100644
index 0000000..4d92ee6
--- /dev/null
+++ b/crates/read_files/tests/lib.rs
@@ -0,0 +1,13 @@
+use read_files::read_files_to_string;
+
+#[test]
+fn test_load_files() {
+    let files = read_files_to_string!("./src", ".rs$");
+    assert!(!files.is_empty());
+}
+
+#[test]
+fn test_load_all_files() {
+    let files = read_files_to_string!("./src");
+    assert!(!files.is_empty());
+}
diff --git a/derive/Cargo.lock b/derive/Cargo.lock
deleted file mode 100644
index dbf0312..0000000
--- a/derive/Cargo.lock
+++ /dev/null
@@ -1,46 +0,0 @@
-# This file is automatically @generated by Cargo.
-# It is not intended for manual editing.
-version = 3
-
-[[package]]
-name = "derive"
-version = "1.0.0"
-dependencies = [
- "quote",
- "syn",
-]
-
-[[package]]
-name = "proc-macro2"
-version = "1.0.85"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "22244ce15aa966053a896d1accb3a6e68469b97c7f33f284b99f0d576879fc23"
-dependencies = [
- "unicode-ident",
-]
-
-[[package]]
-name = "quote"
-version = "1.0.36"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "0fa76aaf39101c457836aec0ce2316dbdc3ab723cdda1c6bd4e6ad4208acaca7"
-dependencies = [
- "proc-macro2",
-]
-
-[[package]]
-name = "syn"
-version = "2.0.67"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "ff8655ed1d86f3af4ee3fd3263786bc14245ad17c4c7e85ba7187fb3ae028c90"
-dependencies = [
- "proc-macro2",
- "quote",
- "unicode-ident",
-]
-
-[[package]]
-name = "unicode-ident"
-version = "1.0.12"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "3354b9ac3fae1ff6755cb6db53683adb661634f67557942dea4facebec0fee4b"
diff --git a/derive/Cargo.toml b/derive/Cargo.toml
deleted file mode 100644
index bf9ab2b..0000000
--- a/derive/Cargo.toml
+++ /dev/null
@@ -1,12 +0,0 @@
-[package]
-name = "derive"
-version = "1.0.0"
-edition = "2021"
-authors = ["Martin Berg Alstad"]
-
-[lib]
-proc-macro = true
-
-[dependencies]
-syn = "2.0.66"
-quote = "1.0.36"
diff --git a/src/lib.rs b/src/lib.rs
index 7e22a9c..a329b70 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -1,5 +1,10 @@
 #![allow(dead_code)]
 
+#[cfg(all(feature = "derive", feature = "serde"))]
+pub extern crate into_response_derive;
+#[cfg(feature = "load-files")]
+pub extern crate load_files;
+
 #[cfg(feature = "axum")]
 pub mod axum;
 #[cfg(feature = "io")]
@@ -11,6 +16,3 @@ pub mod serde;
 pub mod traits;
 #[cfg(feature = "iter")]
 pub mod vector;
-
-#[cfg(all(feature = "derive", feature = "serde"))]
-pub extern crate derive;