clarify status and pretty print

Author: Niko Matsakis

crates/mdbook-goals/src/mdbook_preprocessor.rs

@@ -37,7 +37,6 @@ impl Preprocessor for GoalPreprocessor {
 
 pub struct GoalPreprocessorWithContext<'c> {
     team_asks: &'static Regex,
-    goal_list: &'static Regex,
     goal_count: &'static Regex,
     username: &'static Regex,
     ctx: &'c PreprocessorContext,
@@ -116,7 +115,6 @@ impl<'c> GoalPreprocessorWithContext<'c> {
         Ok(GoalPreprocessorWithContext {
             ctx,
             team_asks: &re::TEAM_ASKS,
-            goal_list: &re::GOAL_LIST,
             goal_count: &re::GOAL_COUNT,
             username: &re::USERNAME,
             links,
@@ -163,7 +161,7 @@ impl<'c> GoalPreprocessorWithContext<'c> {
 
         let count = goals
             .iter()
-            .filter(|g| g.metadata.status != Status::NotAccepted)
+            .filter(|g| g.metadata.status.is_not_not_accepted())
             .count();
 
         chapter.content = self
@@ -175,54 +173,54 @@ impl<'c> GoalPreprocessorWithContext<'c> {
     }
 
     fn replace_goal_lists(&mut self, chapter: &mut Chapter) -> anyhow::Result<()> {
-        let Some(m) = self.goal_list.captures(&chapter.content) else {
-            return Ok(());
-        };
-        let range = m.get(0).unwrap().range();
-        let statuses = m[1]
-            .split(',')
-            .map(|s| s.trim())
-            .map(Status::try_from)
-            .collect::<anyhow::Result<Vec<Status>>>()?;
-
-        let Some(chapter_path) = &chapter.path else {
-            anyhow::bail!("found `<!-- GOALS -->` but chapter has no path")
-        };
-
-        // Extract out the list of goals with the given status.
-        let goals = self.goal_documents(chapter_path)?;
-        let mut goals_with_status: Vec<&GoalDocument> = statuses
-            .iter()
-            .flat_map(|&status| goals.iter().filter(move |g| g.metadata.status == status))
-            .collect();
-
-        goals_with_status.sort_by_key(|g| &g.metadata.title);
-
-        // Format the list of goals and replace the `<!-- -->` comment with that.
-        let output = goal::format_goal_table(&goals_with_status)?;
-        chapter.content.replace_range(range, &output);
-
-        // Populate with children if this is not README
-        if chapter_path.file_stem() != Some("README".as_ref()) {
-            let mut parent_names = chapter.parent_names.clone();
-            parent_names.push(chapter.name.clone());
-            for (goal, index) in goals_with_status.iter().zip(0..) {
-                let content = std::fs::read_to_string(&goal.path)
-                    .with_context(|| format!("reading `{}`", goal.path.display()))?;
-                let path = goal.path.strip_prefix(&self.ctx.config.book.src).unwrap();
-                let mut new_chapter =
-                    Chapter::new(&goal.metadata.title, content, path, parent_names.clone());
-
-                if let Some(mut number) = chapter.number.clone() {
-                    number.0.push(index + 1);
-                    new_chapter.number = Some(number);
+        self.replace_goal_lists_helper(chapter, &re::FLAGSHIP_GOAL_LIST, |status| status.is_flagship && status.is_not_not_accepted())?;
+        self.replace_goal_lists_helper(chapter, &re::OTHER_GOAL_LIST, |status| !status.is_flagship && status.is_not_not_accepted())?;
+        self.replace_goal_lists_helper(chapter, &re::GOAL_LIST, |status| status.is_not_not_accepted())?;
+        self.replace_goal_lists_helper(chapter, &re::GOAL_NOT_ACCEPTED_LIST, |status| !status.is_not_not_accepted())?;
+        Ok(())
+    }
+    
+    fn replace_goal_lists_helper(&mut self, chapter: &mut Chapter, regex: &Regex, filter: impl Fn(Status) -> bool) -> anyhow::Result<()> {
+        loop {
+            let Some(m) = regex.find(&chapter.content) else {
+                return Ok(());
+            };
+            let range = m.range();
+
+            let Some(chapter_path) = &chapter.path else {
+                anyhow::bail!("found `{regex}` but chapter has no path")
+            };
+
+            // Extract out the list of goals with the given status.
+            let goals = self.goal_documents(chapter_path)?;
+            let mut goals_with_status: Vec<&GoalDocument> = goals.iter().filter(|g| filter(g.metadata.status)).collect();
+
+            goals_with_status.sort_by_key(|g| &g.metadata.title);
+
+            // Format the list of goals and replace the `<!-- -->` comment with that.
+            let output = goal::format_goal_table(&goals_with_status)?;
+            chapter.content.replace_range(range, &output);
+
+            // Populate with children if this is not README
+            if chapter_path.file_stem() != Some("README".as_ref()) {
+                let mut parent_names = chapter.parent_names.clone();
+                parent_names.push(chapter.name.clone());
+                for (goal, index) in goals_with_status.iter().zip(0..) {
+                    let content = std::fs::read_to_string(&goal.path)
+                        .with_context(|| format!("reading `{}`", goal.path.display()))?;
+                    let path = goal.path.strip_prefix(&self.ctx.config.book.src).unwrap();
+                    let mut new_chapter =
+                        Chapter::new(&goal.metadata.title, content, path, parent_names.clone());
+
+                    if let Some(mut number) = chapter.number.clone() {
+                        number.0.push(index + 1);
+                        new_chapter.number = Some(number);
+                    }
+
+                    chapter.sub_items.push(BookItem::Chapter(new_chapter));
                 }
-
-                chapter.sub_items.push(BookItem::Chapter(new_chapter));
             }
         }
-
-        self.replace_goal_lists(chapter)
     }
 
     /// Look for `<!-- TEAM ASKS -->` in the chapter content and replace it with the team asks.
@@ -239,7 +237,7 @@ impl<'c> GoalPreprocessorWithContext<'c> {
         let goals = self.goal_documents(path)?;
         let asks_of_any_team: Vec<&TeamAsk> = goals
             .iter()
-            .filter(|g| g.metadata.status != Status::NotAccepted)
+            .filter(|g| g.metadata.status.is_not_not_accepted())
             .flat_map(|g| &g.team_asks)
             .collect();
         let format_team_asks = format_team_asks(&asks_of_any_team)?;

crates/rust-project-goals-cli/src/rfc.rs

@@ -18,7 +18,7 @@ use rust_project_goals::{
         },
         labels::GhLabel,
     },
-    goal::{self, GoalDocument, GoalPlan, ParsedOwners, Status},
+    goal::{self, GoalDocument, GoalPlan, ParsedOwners},
     team::{get_person_data, TeamName},
 };
 
@@ -305,7 +305,7 @@ fn issue<'doc>(timeframe: &str, document: &'doc GoalDocument) -> anyhow::Result<
     }
 
     let mut labels = vec!["C-tracking-issue".to_string()];
-    if let Status::Flagship = document.metadata.status {
+    if document.metadata.status.is_flagship {
         labels.push("Flagship Goal".to_string());
     }
     for team in document.teams_with_asks() {

crates/rust-project-goals/src/goal.rs

@@ -125,11 +125,10 @@ impl GoalDocument {
 
         let link_path = Arc::new(link_path.to_path_buf());
 
-        let goal_plans = match metadata.status {
-            Status::Flagship | Status::Accepted | Status::Proposed => {
-                extract_plan_items(&sections)?
-            }
-            Status::NotAccepted => vec![],
+        let goal_plans = if metadata.status.is_not_not_accepted() {
+            extract_plan_items(&sections)?
+        } else {
+            vec![]
         };
 
         let mut team_asks = vec![];
@@ -164,10 +163,7 @@ impl GoalDocument {
 
     /// True if this goal is a candidate (may yet be accepted)
     pub fn is_not_not_accepted(&self) -> bool {
-        match self.metadata.status {
-            Status::Flagship | Status::Accepted | Status::Proposed => true,
-            Status::NotAccepted => false,
-        }
+        self.metadata.status.is_not_not_accepted()
     }
 
     /// Modify the goal document on disk to link to the given issue number in the metadata.
@@ -176,9 +172,19 @@ impl GoalDocument {
         metadata_table.add_key_value_row(TRACKING_ISSUE_ROW, &number);
         self.metadata
             .table
+
             .overwrite_in_path(&self.path, &metadata_table)?;
         Ok(())
     }
+
+    /// In goal lists, we render our point-of-contact as "Help Wanted" if this is an invited goal.
+    pub fn point_of_contact_for_goal_list(&self) -> String {
+        if self.metadata.status.is_invited {
+            "![Help Wanted][]".to_string()
+        } else {
+            self.metadata.pocs.clone()
+        }
+    }
 }
 
 /// Format a set of team asks into a table, with asks separated by team and grouped by kind.
@@ -243,7 +249,7 @@ pub fn format_team_asks(asks_of_any_team: &[&TeamAsk]) -> anyhow::Result<String>
 
 pub fn format_goal_table(goals: &[&GoalDocument]) -> anyhow::Result<String> {
     // If any of the goals have tracking issues, include those in the table.
-    let goals_are_proposed = goals.iter().any(|g| g.metadata.status == Status::Proposed);
+    let goals_are_proposed = goals.iter().any(|g| g.metadata.status.acceptance == AcceptanceStatus::Proposed);
 
     let mut table;
 
@@ -276,7 +282,7 @@ pub fn format_goal_table(goals: &[&GoalDocument]) -> anyhow::Result<String> {
 
             table.push(vec![
                 format!("[{}]({})", goal.metadata.title, goal.link_path.display()),
-                goal.metadata.pocs.clone(),
+                goal.point_of_contact_for_goal_list(),
                 progress_bar,
             ]);
         }
@@ -297,7 +303,7 @@ pub fn format_goal_table(goals: &[&GoalDocument]) -> anyhow::Result<String> {
             let teams: Vec<&TeamName> = teams.into_iter().collect();
             table.push(vec![
                 format!("[{}]({})", goal.metadata.title, goal.link_path.display()),
-                goal.metadata.pocs.clone(),
+                goal.point_of_contact_for_goal_list(),
                 commas(&teams),
             ]);
         }
@@ -306,38 +312,60 @@ pub fn format_goal_table(goals: &[&GoalDocument]) -> anyhow::Result<String> {
 }
 
 #[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Copy, Clone)]
-pub enum Status {
-    Flagship,
-    Accepted,
-    Proposed,
-    NotAccepted,
+pub struct Status {
+    /// If true, this is a flagship goal (or a flagship candidate)
+    pub is_flagship: bool,
+
+    pub acceptance: AcceptanceStatus,
+
+    /// If true, this is an INVITED goal, meaning that it lacks a primary owner
+    pub is_invited: bool,
+}
+
+impl Status {
+    /// True if this goal has not yet been rejected
+    pub fn is_not_not_accepted(&self) -> bool {
+        self.acceptance != AcceptanceStatus::NotAccepted
+    }
 }
 
 impl TryFrom<&str> for Status {
     type Error = anyhow::Error;
 
     fn try_from(value: &str) -> anyhow::Result<Self> {
-        let status_values = &[
-            ("Flagship", Status::Flagship),
-            ("Accepted", Status::Accepted),
-            ("Proposed", Status::Proposed),
-            ("Not accepted", Status::NotAccepted),
+        let value = value.trim();
+
+        let valid_values = [
+            ("Flagship", Status { is_flagship: true, acceptance: AcceptanceStatus::Accepted, is_invited: false }),
+            ("Accepted", Status { is_flagship: false, acceptance: AcceptanceStatus::Accepted, is_invited: false }),
+            ("Invited", Status { is_flagship: false, acceptance: AcceptanceStatus::Accepted, is_invited: true }),
+            ("Proposed", Status { is_flagship: false, acceptance: AcceptanceStatus::Proposed, is_invited: false }),
+            ("Proposed for flagship", Status { is_flagship: true, acceptance: AcceptanceStatus::Proposed, is_invited: true }),
+            ("Proposed for mentorship", Status { is_flagship: false, acceptance: AcceptanceStatus::Proposed, is_invited: true }),
+            ("Not accepted", Status { is_flagship: false, acceptance: AcceptanceStatus::NotAccepted, is_invited: false }),
         ];
 
-        status_values
-            .iter()
-            .find(|pair| value == pair.0)
-            .map(|pair| pair.1)
-            .ok_or_else(|| {
-                anyhow::anyhow!(
-                    "unrecognized status `{}`, expected one of: {}",
-                    value,
-                    commas(status_values.iter().map(|pair| pair.0))
-                )
-            })
+        for (valid_value, status) in valid_values {
+            if value == valid_value {
+                return Ok(status);
+            }
+        }
+
+        anyhow::bail!(
+            "unrecognized status `{}`, expected one of {:?}", 
+            value,
+            valid_values.iter().map(|(s, _)| s).collect::<Vec<_>>(),
+        )
     }
 }
 
+#[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Copy, Clone)]
+pub enum AcceptanceStatus {
+    Proposed,
+    Accepted,
+    NotAccepted,
+}
+
 fn extract_metadata(sections: &[Section]) -> anyhow::Result<Option<Metadata>> {
     let Some(first_section) = sections.first() else {
         anyhow::bail!("no markdown sections found in input")

crates/rust-project-goals/src/re.rs

@@ -5,8 +5,24 @@ lazy_static! {
     pub static ref TEAM_ASKS: Regex = Regex::new(r"<!-- TEAM ASKS -->").unwrap();
 }
 
+// List of all goals, flagship or otherwise
 lazy_static! {
-    pub static ref GOAL_LIST: Regex = Regex::new(r"<!-- GOALS '(.*)' -->").unwrap();
+    pub static ref GOAL_LIST: Regex = Regex::new(r"<!-- GOALS -->").unwrap();
+}
+
+// List of flagship goals (accepted or pending)
+lazy_static! {
+    pub static ref FLAGSHIP_GOAL_LIST: Regex = Regex::new(r"<!-- FLAGSHIP GOALS -->").unwrap();
+}
+
+// List of non-flagship goals (accepted or pending)
+lazy_static! {
+    pub static ref OTHER_GOAL_LIST: Regex = Regex::new(r"<!-- OTHER GOALS -->").unwrap();
+}
+
+// List of not accepted goals
+lazy_static! {
+    pub static ref GOAL_NOT_ACCEPTED_LIST: Regex = Regex::new(r"<!-- GOALS NOT ACCEPTED -->").unwrap();
 }
 
 lazy_static! {

src/2024h2/accepted.md

@@ -4,4 +4,4 @@ This page lists the project goals accepted for 2024h2, with the exception of [fl
 
 Some goals here do not yet have an owner (look for the ![Help wanted][] badge). Teams have reserved some capacity to pursue these goals but until an appropriate owner is found they are only considered provisionally accepted. If you are interested in serving as the owner for one of these orphaned goals, reach out to the mentor listed in the goal to discuss.
 
-<!-- GOALS 'Accepted' -->
+<!-- GOALS -->

src/2024h2/flagship.md

@@ -1,3 +1,3 @@
 # Flagship goals
 
-<!-- GOALS 'Flagship' -->
+<!-- FLAGSHIP GOALS -->

src/2024h2/goals.md

@@ -6,12 +6,12 @@ This page lists the <!-- #GOALS --> project goals accepted for 2024h2.
 
 Flagship goals represent the goals expected to have the broadest overall impact. 
 
-<!-- GOALS 'Flagship' -->
+<!-- FLAGSHIP GOALS -->
 
 ## Other goals
 
-These are the other accepted goals. 
+This is the full list of goals (including flagship).
 
-**Orphaned goals.** Some goals here are marked with the ![Help wanted][] badge for their owner. These goals are called "orphaned goals". Teams have reserved some capacity to pursue these goals but until an appropriate owner is found they are only considered provisionally accepted. If you are interested in serving as the owner for one of these orphaned goals, reach out to the mentor listed in the goal to discuss.
+**Invited goals.** Some goals here are marked with the ![Help wanted][] badge for their point of contact. These goals are called "invited goals". Teams have reserved some capacity to pursue these goals but until an appropriate owner is found they are only considered provisionally accepted. If you are interested in serving as the owner for one of these invited goals, reach out to the point of contact listed in the goal description.
 
-<!-- GOALS 'Accepted' -->
+<!-- OTHER GOALS -->

src/2024h2/not_accepted.md

@@ -2,4 +2,4 @@
 
 This section contains goals that were proposed but ultimately not accepted, either for want of resources or consensus. In many cases, narrower versions of these goals were accepted.
 
-<!-- GOALS 'Not accepted' -->
+<!-- GOALS NOT ACCEPTED -->

src/2024h2/user-wide-cache.md

@@ -1,11 +1,11 @@
 # User-wide build cache
 
-| Metadata       |                                    |
-|----------------|------------------------------------|
-| Point of contact | @epage                   |
-| Teams          | [cargo]                            |
-| Status         | Accepted                           |
-| Tracking issue | [rust-lang/rust-project-goals#124] |
+| Metadata         |                                    |
+|------------------|------------------------------------|
+| Point of contact | @epage                             |
+| Teams            | [cargo]                            |
+| Status           | Invited                            |
+| Tracking issue   | [rust-lang/rust-project-goals#124] |
 
 
 ## Summary