Merge pull request #139 from nikomatsakis/progress-bars

Progress bars

Author: nikomatsakis

.github/workflows/check.yml

@@ -16,7 +16,6 @@ jobs:
 
     steps:
     - uses: actions/checkout@v4
-    - name: Build
-      run: cargo build --verbose
-    - name: Check for consistency
-      run: cargo run -- check
+    - uses: extractions/setup-just@v2
+    - name: Build and check
+      run: just check

.github/workflows/mdbook.yml

@@ -41,13 +41,12 @@ jobs:
           curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf -y | sh
           rustup update
           cargo install --version ${MDBOOK_VERSION} mdbook
+      - uses: extractions/setup-just@v2
       - name: Setup Pages
         id: pages
         uses: actions/configure-pages@v5
-      - name: Build with mdBook
-        run: mdbook build
-      - name: Generate JSON data
-        run: cargo run -- json 2024h2 --json-path book/html/api/2024h2.json
+      - name: Build
+        run: just build
         env:
           GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       - name: Upload artifact

.gitignore

@@ -1,3 +1,4 @@
 book
 target
 .cache
+src/api

book.toml

@@ -27,6 +27,7 @@ command = "cargo run -p mdbook-goals --"
 git-repository-url = "https://github.com/rust-lang/rust-project-goals"
 edit-url-template = "https://github.com/rust-lang/rust-project-goals/edit/main/{path}"
 site-url = "/rust-project-goals/"
+additional-js = ["src/update-progress-bars.js"]
 
 [output.html.fold]
 enable = true

justfile

@@ -0,0 +1,13 @@
+api:
+    cargo run -- json 2024h2 --json-path src/api/2024h2.json
+    
+serve: api
+    mdbook serve
+
+build: api
+    mdbook build
+
+check:
+    cargo build
+    cargo run -- check
+    

mdbook-goals/src/gh/issue_id.rs

@@ -1,21 +1,62 @@
-use crate::re::TRACKING_ISSUE;
+use crate::re::{REPOSITORY, TRACKING_ISSUE};
 use std::fmt::Display;
 
+#[derive(PartialEq, Eq, PartialOrd, Ord, Clone, Debug)]
+pub struct Repository {
+    /// Something like `rust-lang`
+    pub org: String,
+
+    /// Something like `rust-project-goals`
+    pub repo: String,
+}
+
+impl Repository {
+    pub fn new(org: &(impl Display + ?Sized), repo: &(impl Display + ?Sized)) -> Self {
+        Self {
+            org: org.to_string(),
+            repo: repo.to_string(),
+        }
+    }
+}
+
+impl std::fmt::Display for Repository {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        let Repository { org, repo } = self;
+        write!(f, "{org}/{repo}")
+    }
+}
+
+impl std::str::FromStr for Repository {
+    type Err = anyhow::Error;
+
+    fn from_str(s: &str) -> Result<Self, Self::Err> {
+        let Some(c) = REPOSITORY.captures(s) else {
+            anyhow::bail!("invalid repository `{s}`")
+        };
+
+        Ok(Repository::new(&c[1], &c[2]))
+    }
+}
+
 #[derive(PartialEq, Eq, PartialOrd, Ord, Clone)]
 pub struct IssueId {
-    /// Something like `rust-lang/rust-project-goals`
-    pub repository: String,
+    pub repository: Repository,
 
     /// Something like `22`
     pub number: u64,
 }
 
 impl IssueId {
-    pub fn new(repository: &(impl Display + ?Sized), number: u64) -> Self {
-        Self {
-            repository: repository.to_string(),
+    pub fn new(repository: Repository, number: u64) -> Self {
+        Self { repository, number }
+    }
+
+    pub fn url(&self) -> String {
+        let IssueId {
+            repository: Repository { org, repo },
             number,
-        }
+        } = self;
+        format!("https://github.com/{org}/{repo}/issues/{number}")
     }
 }
 
@@ -27,12 +68,11 @@ impl std::fmt::Debug for IssueId {
 
 impl std::fmt::Display for IssueId {
     fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
-        write!(
-            f,
-            "[{repository}#{number}]",
-            repository = self.repository,
-            number = self.number,
-        )
+        let IssueId {
+            repository: Repository { org, repo },
+            number,
+        } = self;
+        write!(f, "[{org}/{repo}#{number}]")
     }
 }
 
@@ -44,6 +84,6 @@ impl std::str::FromStr for IssueId {
             anyhow::bail!("invalid issue-id")
         };
 
-        Ok(IssueId::new(&c[1], c[2].parse()?))
+        Ok(IssueId::new(Repository::new(&c[1], &c[2]), c[3].parse()?))
     }
 }

mdbook-goals/src/gh/issues.rs

@@ -8,7 +8,7 @@ use serde::{Deserialize, Serialize};
 
 use crate::util::comma;
 
-use super::labels::GhLabel;
+use super::{issue_id::Repository, labels::GhLabel};
 
 #[derive(Debug, Serialize, Deserialize, PartialEq, Eq, PartialOrd, Ord)]
 pub struct ExistingGithubIssue {
@@ -77,13 +77,54 @@ impl std::fmt::Display for ExistingIssueState {
     }
 }
 
+pub struct CountIssues {
+    pub open: u32,
+    pub closed: u32,
+}
+
+pub fn count_issues_matching_search(
+    repository: &Repository,
+    search: &str,
+) -> anyhow::Result<CountIssues> {
+    #[derive(Deserialize)]
+    struct JustState {
+        state: ExistingIssueState,
+    }
+
+    let output = Command::new("gh")
+        .arg("-R")
+        .arg(&repository.to_string())
+        .arg("issue")
+        .arg("list")
+        .arg("-S")
+        .arg(search)
+        .arg("-s")
+        .arg("all")
+        .arg("--json")
+        .arg("state")
+        .output()?;
+
+    let existing_issues: Vec<JustState> = serde_json::from_slice(&output.stdout)?;
+
+    let mut count_issues = CountIssues { open: 0, closed: 0 };
+
+    for issue in &existing_issues {
+        match issue.state {
+            ExistingIssueState::Open => count_issues.open += 1,
+            ExistingIssueState::Closed => count_issues.closed += 1,
+        }
+    }
+
+    Ok(count_issues)
+}
+
 pub fn list_issue_titles_in_milestone(
-    repository: &str,
+    repository: &Repository,
     timeframe: &str,
 ) -> anyhow::Result<BTreeMap<String, ExistingGithubIssue>> {
     let output = Command::new("gh")
         .arg("-R")
-        .arg(repository)
+        .arg(&repository.to_string())
         .arg("issue")
         .arg("list")
         .arg("-m")
@@ -124,7 +165,7 @@ pub fn list_issue_titles_in_milestone(
 }
 
 pub fn create_issue(
-    repository: &str,
+    repository: &Repository,
     body: &str,
     title: &str,
     labels: &[String],
@@ -133,7 +174,7 @@ pub fn create_issue(
 ) -> anyhow::Result<()> {
     let output = Command::new("gh")
         .arg("-R")
-        .arg(&repository)
+        .arg(&repository.to_string())
         .arg("issue")
         .arg("create")
         .arg("-b")
@@ -160,15 +201,15 @@ pub fn create_issue(
 }
 
 pub fn sync_assignees(
-    repository: &str,
+    repository: &Repository,
     number: u64,
     remove_owners: &BTreeSet<String>,
     add_owners: &BTreeSet<String>,
 ) -> anyhow::Result<()> {
     let mut command = Command::new("gh");
     command
         .arg("-R")
-        .arg(&repository)
+        .arg(&repository.to_string())
         .arg("issue")
         .arg("edit")
         .arg(number.to_string());
@@ -203,10 +244,10 @@ impl ExistingGithubIssue {
     }
 }
 
-pub fn lock_issue(repository: &str, number: u64) -> anyhow::Result<()> {
+pub fn lock_issue(repository: &Repository, number: u64) -> anyhow::Result<()> {
     let output = Command::new("gh")
         .arg("-R")
-        .arg(repository)
+        .arg(&repository.to_string())
         .arg("issue")
         .arg("lock")
         .arg(number.to_string())
@@ -225,7 +266,7 @@ pub fn lock_issue(repository: &str, number: u64) -> anyhow::Result<()> {
     // Leave a comment explaining what is going on.
     let output = Command::new("gh")
         .arg("-R")
-        .arg(repository)
+        .arg(&repository.to_string())
         .arg("issue")
         .arg("comment")
         .arg(number.to_string())

mdbook-goals/src/gh/labels.rs

@@ -2,17 +2,19 @@ use std::process::Command;
 
 use serde::{Deserialize, Serialize};
 
+use super::issue_id::Repository;
+
 #[derive(Debug, Serialize, Deserialize, PartialEq, Eq, PartialOrd, Ord)]
 pub struct GhLabel {
     pub name: String,
     pub color: String,
 }
 
 impl GhLabel {
-    pub fn list(repository: &str) -> anyhow::Result<Vec<GhLabel>> {
+    pub fn list(repository: &Repository) -> anyhow::Result<Vec<GhLabel>> {
         let output = Command::new("gh")
             .arg("-R")
-            .arg(repository)
+            .arg(&repository.to_string())
             .arg("label")
             .arg("list")
             .arg("--json")
@@ -24,10 +26,10 @@ impl GhLabel {
         Ok(labels)
     }
 
-    pub fn create(&self, repository: &str) -> anyhow::Result<()> {
+    pub fn create(&self, repository: &Repository) -> anyhow::Result<()> {
         let output = Command::new("gh")
             .arg("-R")
-            .arg(repository)
+            .arg(&repository.to_string())
             .arg("label")
             .arg("create")
             .arg(&self.name)