feat: make it easier to use Maudit as a library (#37)

* feat: make it easier to build routes individually

* feat: library example

* fix: do content sources serially

* refactor: always use routes

Author: Princesseuh

Cargo.lock

@@ -9,7 +9,7 @@ struct Params {
 }
 
 impl Page<Params> for Article {
-    fn routes(&self, context: &mut DynamicRouteContext) -> Vec<Route<Params>> {
+    fn routes(&self, context: &DynamicRouteContext) -> Routes<Params> {
         context
             .content
             .get_source::<UntypedMarkdownContent>("articles")

benchmarks/md-benchmark/src/page.rs

@@ -36,7 +36,7 @@ pub fn route(attrs: TokenStream, item: TokenStream) -> TokenStream {
                 self.render(ctx).into()
             }
 
-            fn routes_internal(&self, ctx: &mut maudit::page::DynamicRouteContext) -> Vec<(maudit::page::RouteParams, Box<dyn std::any::Any + Send + Sync>, Box<dyn std::any::Any + Send + Sync>)> {
+            fn routes_internal(&self, ctx: &maudit::page::DynamicRouteContext) -> Vec<(maudit::page::RouteParams, Box<dyn std::any::Any + Send + Sync>, Box<dyn std::any::Any + Send + Sync>)> {
                 self.routes(ctx)
                     .into_iter()
                     .map(|route| {

crates/maudit-macros/src/lib.rs

@@ -6,23 +6,22 @@
 
 - [9cd5fdd](https://github.com/bruits/maudit/commit/9cd5fdd8abe3044bd09d48b96217e3a0d2878b13) Updates default quality for webp to 80 to match sharp — Thanks @Princesseuh!
 
-
 ## 0.5.0
 
 ### Minor changes
 
 - [d5a7fad](https://github.com/bruits/maudit/commit/d5a7fad563e9642be46b24d8db500e753c1175f5) The data URI and average RGBA for thumbnails is now calculated lazily, as such the `average_rgba` and `data_uri` fields have been replaced by methods. — Thanks @Princesseuh!
 - [0403ac9](https://github.com/bruits/maudit/commit/0403ac9996f9d4e79945758fe06e7510729e383e) Add `is_dev()` function to allow one to toggle off things whenever running in dev — Thanks @Princesseuh!
 - [39db004](https://github.com/bruits/maudit/commit/39db004b63ab7aa582a92593082e1261bae55b92) Added support for shortcodes in Markdown. Shortcodes allows you to substitute custom content in your Markdown files. This feature is useful for embedding dynamic content or reusable components within your Markdown documents.
-  
+
   For instance, you might define a shortcode for embedding YouTube videos using only the video ID, or for inserting custom alerts or notes.
-  
+
   ```markdown
   {{ youtube id="FbJ63spk48s" }}
   ```
-  
+
   Would render to:
-  
+
   ```html
   <iframe
     width="560"
@@ -35,35 +34,34 @@
     allowfullscreen
   ></iframe>
   ```
-  
+
   To define and register shortcodes, pass a MarkdownShortcodes instance to the MarkdownOptions when rendering Markdown content.
-  
+
   ```rust
   let mut shortcodes = MarkdownShortcodes::new();
-  
+
   shortcodes.register("youtube", |args, _ctx| {
       let id: String = args.get_required("id");
       format!(
           r#"<iframe width="560" height="315" src="https://www.youtube.com/embed/{}" frameborder="0" allowfullscreen></iframe>"#,
           id
       )
   });
-  
+
   MarkdownOptions {
       shortcodes,
       ..Default::default()
   }
-  
+
   // Then pass options to, i.e. glob_markdown in a content source
   ```
-  
+
   Note that shortcodes are expanded before Markdown is rendered, so you can use shortcodes anywhere in your Markdown content, for instance in your frontmatter. Additionally, shortcodes may expand to Markdown content, which will then be rendered as part of the overall Markdown rendering process. — Thanks @Princesseuh!
 
 ### Patch changes
 
 - [d5a7fad](https://github.com/bruits/maudit/commit/d5a7fad563e9642be46b24d8db500e753c1175f5) Added caching mechanism to placeholder and image transformation — Thanks @Princesseuh!
 
-
 ## 0.4.0
 
 ### Minor changes
@@ -96,6 +94,7 @@ impl Page for ImagePage {
 ```
 
 See the [Assets documentation](https://maudit.org/docs/assets/) for more details. — Thanks @Princesseuh!
+
 - [52eda9e](https://github.com/bruits/maudit/commit/52eda9ea4eac8efd3efd945d00f39a1b99f284ab) Adds support for dynamic routes with properties. In addition to its parameters, a dynamic route can now provide additional properties that can be used during rendering.
 
 ```rs
@@ -126,7 +125,7 @@ impl Page<Params, Props> for Post {
     ).into()
   }
 
-  fn routes(&self, ctx: &mut DynamicRouteContext) -> Routes<Params, Props> {
+  fn routes(&self, ctx: &DynamicRouteContext) -> Routes<Params, Props> {
     vec![Route::from_params_and_props(
       Params {
         slug: "hello-world".to_string(),
@@ -145,4 +144,3 @@ For more information on dynamic routes, see the [Routing documentation](https://
 ### Patch changes
 
 - Updated dependencies: maudit-macros@0.4.0
-

crates/maudit/CHANGELOG.md

@@ -3,7 +3,6 @@ use dyn_eq::DynEq;
 use log::debug;
 use rustc_hash::FxHashSet;
 use std::hash::Hash;
-use std::sync::OnceLock;
 use std::time::Instant;
 use std::{fs, path::PathBuf};
 use xxhash_rust::xxh3::xxh3_64;
@@ -18,17 +17,39 @@ pub use style::{Style, StyleOptions};
 
 #[derive(Default)]
 pub struct PageAssets {
-    pub(crate) images: FxHashSet<Image>,
-    pub(crate) scripts: FxHashSet<Script>,
-    pub(crate) styles: FxHashSet<Style>,
-
-    pub(crate) included_styles: Vec<Style>,
-    pub(crate) included_scripts: Vec<Script>,
+    pub images: FxHashSet<Image>,
+    pub scripts: FxHashSet<Script>,
+    pub styles: FxHashSet<Style>,
 
     pub(crate) assets_dir: PathBuf,
 }
 
 impl PageAssets {
+    pub fn new(assets_dir: PathBuf) -> Self {
+        Self {
+            assets_dir,
+            ..Default::default()
+        }
+    }
+
+    pub fn assets(&self) -> impl Iterator<Item = &dyn Asset> {
+        self.images
+            .iter()
+            .map(|asset| asset as &dyn Asset)
+            .chain(self.scripts.iter().map(|asset| asset as &dyn Asset))
+            .chain(self.styles.iter().map(|asset| asset as &dyn Asset))
+    }
+
+    /// Get all styles that are marked as included
+    pub fn included_styles(&self) -> impl Iterator<Item = &Style> {
+        self.styles.iter().filter(|s| s.included)
+    }
+
+    /// Get all scripts that are marked as included
+    pub fn included_scripts(&self) -> impl Iterator<Item = &Script> {
+        self.scripts.iter().filter(|s| s.included)
+    }
+
     /// Add an image to the page assets, causing the file to be created in the output directory. The image is resolved relative to the current working directory.
     ///
     /// The image will not automatically be included in the page, but can be included through the `.url()` method on the returned `Image` object.
@@ -64,7 +85,6 @@ impl PageAssets {
             } else {
                 Some(options)
             },
-            __cache_placeholder: OnceLock::new(),
         };
 
         self.images.insert(image.clone());
@@ -94,6 +114,7 @@ impl PageAssets {
             path: path.clone(),
             assets_dir: self.assets_dir.clone(),
             hash: calculate_hash(&path, None),
+            included: false,
         };
 
         self.scripts.insert(script.clone());
@@ -115,10 +136,10 @@ impl PageAssets {
             path: path.clone(),
             assets_dir: self.assets_dir.clone(),
             hash: calculate_hash(&path, None),
+            included: true,
         };
 
-        self.scripts.insert(script.clone());
-        self.included_scripts.push(script);
+        self.scripts.insert(script);
     }
 
     /// Add a style to the page assets, causing the file to be created in the output directory. The style is resolved relative to the current working directory.
@@ -149,6 +170,7 @@ impl PageAssets {
             assets_dir: self.assets_dir.clone(),
             hash: calculate_hash(&path, Some(HashConfig::Style(&options))),
             tailwind: options.tailwind,
+            included: false,
         };
 
         self.styles.insert(style.clone());
@@ -184,10 +206,10 @@ impl PageAssets {
             assets_dir: self.assets_dir.clone(),
             hash,
             tailwind: options.tailwind,
+            included: true,
         };
 
-        self.styles.insert(style.clone());
-        self.included_styles.push(style);
+        self.styles.insert(style);
     }
 }
 
@@ -333,7 +355,7 @@ mod tests {
         page_assets.include_style(temp_dir.join("style.css"));
 
         assert!(page_assets.styles.len() == 1);
-        assert!(page_assets.included_styles.len() == 1);
+        assert!(page_assets.included_styles().count() == 1);
     }
 
     #[test]
@@ -359,7 +381,7 @@ mod tests {
         page_assets.include_script(temp_dir.join("script.js"));
 
         assert!(page_assets.scripts.len() == 1);
-        assert!(page_assets.included_scripts.len() == 1);
+        assert!(page_assets.included_scripts().count() == 1);
     }
 
     #[test]
@@ -459,7 +481,7 @@ mod tests {
         let image_webp = page_assets.add_image_with_options(
             &image_path,
             ImageOptions {
-                format: Some(ImageFormat::Webp),
+                format: Some(ImageFormat::WebP),
                 ..Default::default()
             },
         );
@@ -476,7 +498,7 @@ mod tests {
             ImageOptions {
                 width: Some(100),
                 height: Some(100),
-                format: Some(ImageFormat::Webp),
+                format: Some(ImageFormat::WebP),
             },
         );
 
@@ -617,6 +639,7 @@ mod tests {
                 Some(HashConfig::Style(&StyleOptions::default())),
             ),
             tailwind: false,
+            included: false,
         };
 
         assert_ne!(

crates/maudit/src/assets.rs

@@ -10,11 +10,11 @@ use super::image_cache::ImageCache;
 use crate::assets::{Asset, InternalAsset};
 use crate::is_dev;
 
-#[derive(Clone, PartialEq, Eq, Hash)]
+#[derive(Clone, Debug, PartialEq, Eq, Hash)]
 pub enum ImageFormat {
     Png,
     Jpeg,
-    Webp,
+    WebP,
     Avif,
     Gif,
 }
@@ -24,7 +24,7 @@ impl ImageFormat {
         match self {
             ImageFormat::Png => "png",
             ImageFormat::Jpeg => "jpg",
-            ImageFormat::Webp => "webp",
+            ImageFormat::WebP => "webp",
             ImageFormat::Avif => "avif",
             ImageFormat::Gif => "gif",
         }
@@ -34,7 +34,7 @@ impl ImageFormat {
         match self {
             ImageFormat::Png => 1,
             ImageFormat::Jpeg => 2,
-            ImageFormat::Webp => 3,
+            ImageFormat::WebP => 3,
             ImageFormat::Gif => 4,
             ImageFormat::Avif => 5,
         }
@@ -46,59 +46,36 @@ impl From<ImageFormat> for image::ImageFormat {
         match val {
             ImageFormat::Png => image::ImageFormat::Png,
             ImageFormat::Jpeg => image::ImageFormat::Jpeg,
-            ImageFormat::Webp => image::ImageFormat::WebP,
+            ImageFormat::WebP => image::ImageFormat::WebP,
             ImageFormat::Avif => image::ImageFormat::Avif,
             ImageFormat::Gif => image::ImageFormat::Gif,
         }
     }
 }
 
-#[derive(Default, Clone, PartialEq, Eq, Hash)]
+#[derive(Default, Debug, Clone, PartialEq, Eq, Hash)]
 pub struct ImageOptions {
     pub width: Option<u32>,
     pub height: Option<u32>,
     pub format: Option<ImageFormat>,
 }
 
-#[derive(Clone)]
-#[non_exhaustive]
+#[derive(Clone, Debug, Hash, PartialEq, Eq)]
 pub struct Image {
     pub path: PathBuf,
     pub width: u32,
     pub height: u32,
     pub(crate) assets_dir: PathBuf,
     pub(crate) hash: String,
     pub(crate) options: Option<ImageOptions>,
-    pub(crate) __cache_placeholder: OnceLock<ImagePlaceholder>,
 }
 
-impl Hash for Image {
-    fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
-        self.path.hash(state);
-        self.assets_dir.hash(state);
-        self.hash.hash(state);
-        self.options.hash(state);
-    }
-}
-
-impl PartialEq for Image {
-    fn eq(&self, other: &Self) -> bool {
-        self.path == other.path
-            && self.assets_dir == other.assets_dir
-            && self.hash == other.hash
-            && self.options == other.options
-    }
-}
-
-impl Eq for Image {}
-
 impl Image {
     /// Get a placeholder for the image, which can be used for low-quality image placeholders (LQIP) or similar techniques.
     ///
     /// This uses the [ThumbHash](https://evanw.github.io/thumbhash/) algorithm to generate a very small placeholder image.
-    pub fn placeholder(&self) -> &ImagePlaceholder {
-        self.__cache_placeholder
-            .get_or_init(|| get_placeholder(&self.path))
+    pub fn placeholder(&self) -> ImagePlaceholder {
+        get_placeholder(&self.path)
     }
 }
 

crates/maudit/src/assets/image.rs

@@ -8,6 +8,7 @@ pub struct Script {
     pub path: PathBuf,
     pub(crate) assets_dir: PathBuf,
     pub(crate) hash: String,
+    pub(crate) included: bool,
 }
 
 impl InternalAsset for Script {

crates/maudit/src/assets/script.rs

@@ -14,6 +14,7 @@ pub struct Style {
     pub(crate) assets_dir: PathBuf,
     pub(crate) hash: String,
     pub(crate) tailwind: bool,
+    pub(crate) included: bool,
 }
 
 impl InternalAsset for Style {