WIP: templates

Author: Niko Matsakis

Cargo.lock

@@ -22,4 +22,5 @@ aws-config = "1.5.8"
 aws-sdk-bedrock = "1.57.0"
 aws-sdk-bedrockruntime = "1.55.0"
 tokio = { version = "1.41.0", features = ["full"] }
-handlebars = "6.1.0"
+handlebars = { version = "6.1.0", features = ["dir_source"] }
+comrak = "0.29.0"

mdbook-goals/2024h2.md

@@ -92,7 +92,7 @@ struct TrackingIssue {
     state: ExistingIssueState,
 }
 
-#[derive(Serialize)]
+#[derive(Serialize, Debug)]
 pub enum Progress {
     /// We could not find any checkboxes or other deatils on the tracking issue.
     /// So all we have is "open" or "closed".
@@ -120,23 +120,6 @@ struct TrackingIssueUpdate {
     pub url: String,
 }
 
-impl Progress {
-    /// Returns the number of completed and total items. Returns (0, 0) in the case of an error.
-    pub fn completed_total(&self) -> (u32, u32) {
-        match *self {
-            Progress::Binary { is_closed } => {
-                if is_closed {
-                    (1, 1)
-                } else {
-                    (0, 1)
-                }
-            }
-            Progress::Tracked { completed, total } => (completed, total),
-            Progress::Error { .. } => (0, 0),
-        }
-    }
-}
-
 /// Identify how many sub-items have been completed.
 /// These can be encoded in two different ways:
 ///

mdbook-goals/Cargo.toml

@@ -18,6 +18,7 @@ mod re;
 mod rfc;
 mod team;
 mod team_repo;
+mod templates;
 mod updates;
 mod util;
 

mdbook-goals/src/json.rs

@@ -0,0 +1,105 @@
+use std::path::{Path, PathBuf};
+
+use handlebars::{DirectorySourceOptions, Handlebars};
+use serde::Serialize;
+
+use crate::json::Progress;
+
+pub struct Templates<'h> {
+    reg: Handlebars<'h>,
+}
+
+impl<'h> Templates<'h> {
+    pub fn new() -> anyhow::Result<Self> {
+        let templates = PathBuf::from(env!("CARGO_MANIFEST_DIR")).join("../templates");
+        Self::from_templates_dir(&templates)
+    }
+
+    pub fn from_templates_dir(dir_path: impl AsRef<Path>) -> anyhow::Result<Self> {
+        let dir_path = dir_path.as_ref();
+        let mut reg = Handlebars::new();
+
+        reg.set_strict_mode(true);
+
+        reg.register_templates_directory(dir_path, DirectorySourceOptions::default())?;
+        assert!(reg.get_template("updates").is_some());
+
+        reg.register_helper("markdown_to_html", Box::new(markdown_to_html));
+
+        Ok(Templates { reg })
+    }
+}
+
+handlebars::handlebars_helper!(markdown_to_html: |md: String| comrak::markdown_to_html(&md, &Default::default()));
+
+/// The parameters expected by the `updates.md` template.
+#[derive(Serialize, Debug)]
+pub struct Updates {
+    pub milestone: String,
+    pub flagship_goals: Vec<UpdatesFlagshipGoal>,
+    pub other_goals: Vec<UpdatesOtherGoal>,
+}
+
+impl Updates {
+    pub fn render(self) -> anyhow::Result<String> {
+        let templates = Templates::new()?;
+        Ok(templates.reg.render("updates", &self)?)
+    }
+}
+
+#[derive(Serialize, Debug)]
+pub struct UpdatesFlagshipGoal {
+    /// Title of the tracking issue
+    pub title: String,
+
+    /// Tracking issue number on the project goals repository
+    pub issue_number: u64,
+
+    /// Comma-separated list of assignees
+    pub issue_assignees: String,
+
+    /// URL of the tracking issue
+    pub issue_url: String,
+
+    /// Progress towards the goal
+    pub progress: Progress,
+
+    /// Updates provided towards the goal
+    pub updates: Vec<UpdatesFlagshipGoalUpdate>,
+}
+
+#[derive(Serialize, Debug)]
+pub struct UpdatesFlagshipGoalUpdate {
+    /// Username of the person who wrote the update
+    pub author: String,
+
+    /// Formatted like "Oct 26"
+    pub date: String,
+
+    /// Text of the update
+    pub update: String,
+
+    /// URL of the comment
+    pub url: String,
+}
+
+#[derive(Serialize, Debug)]
+pub struct UpdatesOtherGoal {
+    /// Title of the tracking issue
+    pub title: String,
+
+    /// Tracking issue number on the project goals repository
+    pub issue_number: u64,
+
+    /// Comma-separated list of assignees
+    pub issue_assignees: String,
+
+    /// URL of the tracking issue
+    pub issue_url: String,
+
+    /// Markdown with update text (bullet list)
+    pub updates_markdown: String,
+
+    /// Progress towards the goal
+    pub progress: Progress,
+}