Skip to content

[PRIVATE-REPO] feat: add use_badges parameter to build_table #24

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
luqven wants to merge 1 commit into from
Closed

[PRIVATE-REPO] feat: add use_badges parameter to build_table #24

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions src/main.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -219,8 +219,13 @@ async fn main() -> Result<(), Box<dyn Error>> {
build_pr_stack_for_repo(&identifier, repository, &credentials, get_excluded(m))
.await?;

let table =
markdown::build_table(&stack, &identifier, m.value_of("prelude"), repository);
let table = markdown::build_table(
&stack,
&identifier,
m.value_of("prelude"),
repository,
false,
);

for (pr, _) in stack.iter() {
println!("{}: {}", pr.number(), pr.title());
Expand Down
241 changes: 162 additions & 79 deletions src/markdown.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ pub fn build_table(
title: &str,
prelude_path: Option<&str>,
repository: &str,
use_badges: bool,
) -> String {
let is_complete = deps
.iter()
Expand All @@ -27,89 +28,104 @@ pub fn build_table(
out.push('\n');
}

out.push_str("| PR | Title | Status | Merges Into |\n");
out.push_str("|:--:|:------|:-------|:-------------:|\n");
if use_badges {
out.push_str("| PR | Title | Status | Merges Into |\n");
out.push_str("|:--:|:------|:-------|:-----------:|\n");
} else {
out.push_str("| PR | Title | Merges Into |\n");
out.push_str("|:--:|:------|:-----------:|\n");
}

for (node, parent) in deps {
let review_state = match node.review_state() {
PullRequestReviewState::APPROVED => {
format!(
"![](https://img.shields.io/github/pulls/detail/state/{}/{}?label={})",
repository,
&node.number().to_string(),
"Approved"
)
}
PullRequestReviewState::MERGED => {
format!(
"![](https://img.shields.io/github/pulls/detail/state/{}/{}?label={})",
repository,
&node.number().to_string(),
"%20"
)
}
PullRequestReviewState::PENDING => {
format!(
"![](https://img.shields.io/github/pulls/detail/state/{}/{}?label={})",
repository,
&node.number().to_string(),
"Pending"
)
}
PullRequestReviewState::CHANGES_REQUESTED => {
format!(
"![](https://img.shields.io/github/pulls/detail/state/{}/{}?label={})",
repository,
&node.number().to_string(),
"Changes Requested"
)
}
PullRequestReviewState::DISMISSED => {
format!(
"![](https://img.shields.io/github/pulls/detail/state/{}/{}?label={})",
repository,
&node.number().to_string(),
"Dismissed"
)
}
PullRequestReviewState::COMMENTED => {
let review_state = if use_badges {
let state = match node.review_state() {
PullRequestReviewState::APPROVED => {
format!(
"![](https://img.shields.io/github/pulls/detail/state/{}/{}?label={})",
repository,
&node.number().to_string(),
"Approved"
)
}
PullRequestReviewState::MERGED => {
format!(
"![](https://img.shields.io/github/pulls/detail/state/{}/{}?label={})",
repository,
&node.number().to_string(),
"%20"
)
}
PullRequestReviewState::PENDING => {
format!(
"![](https://img.shields.io/github/pulls/detail/state/{}/{}?label={})",
repository,
&node.number().to_string(),
"Pending"
)
}
PullRequestReviewState::CHANGES_REQUESTED => {
format!(
"![](https://img.shields.io/github/pulls/detail/state/{}/{}?label={})",
repository,
&node.number().to_string(),
"Changes Requested"
)
}
PullRequestReviewState::DISMISSED => {
format!(
"![](https://img.shields.io/github/pulls/detail/state/{}/{}?label={})",
repository,
&node.number().to_string(),
"Dismissed"
)
}
PullRequestReviewState::COMMENTED => {
format!(
"![](https://img.shields.io/github/pulls/detail/state/{}/{}?label={})",
repository,
&node.number().to_string(),
"Commented"
)
}
};

if node.review_state() != PullRequestReviewState::MERGED
&& *node.state() == PullRequestStatus::Closed
{
format!(
"![](https://img.shields.io/github/pulls/detail/state/{}/{}?label={})",
repository,
&node.number().to_string(),
"Commented"
"Closed"
)
} else {
state
}
};

let review_state = if node.review_state() != PullRequestReviewState::MERGED
&& *node.state() == PullRequestStatus::Closed
{
format!(
"![](https://img.shields.io/github/pulls/detail/state/{}/{}?label={})",
repository,
&node.number().to_string(),
"Closed"
)
} else {
review_state
String::new()
};

let row = match (node.state(), parent) {
(_, None) => format!(
"|#{}|{}|{}|{}|\n",
node.number(),
node.title(),
review_state,
"-"
),
(_, Some(parent)) => format!(
"|#{}|{}|{}|#{}|\n",
node.number(),
node.title(),
review_state,
parent.number(),
),
let row = if use_badges {
match parent {
None => format!("|#{}|{}|{}|-|\n", node.number(), node.title(), review_state),
Some(parent) => format!(
"|#{}|{}|{}|#{}|\n",
node.number(),
node.title(),
review_state,
parent.number()
),
}
} else {
match parent {
None => format!("|#{}|{}|-|\n", node.number(), node.title()),
Some(parent) => format!(
"|#{}|{}|#{}|\n",
node.number(),
node.title(),
parent.number()
),
}
};

out.push_str(&row);
Expand Down Expand Up @@ -158,7 +174,7 @@ mod tests {
);
let deps: FlatDep = vec![(pr, None)];

let table = build_table(&deps, "JIRA-123", None, "user/repo");
let table = build_table(&deps, "JIRA-123", None, "user/repo", false);
insta::assert_snapshot!(table);
}

Expand Down Expand Up @@ -198,7 +214,7 @@ mod tests {
(pr3.clone(), Some(pr2.clone())),
];

let table = build_table(&deps, "STACK-456", None, "org/project");
let table = build_table(&deps, "STACK-456", None, "org/project", false);
insta::assert_snapshot!(table);
}

Expand All @@ -215,7 +231,7 @@ mod tests {
);
let deps: FlatDep = vec![(pr, None)];

let table = build_table(&deps, "DRAFT-TEST", None, "user/repo");
let table = build_table(&deps, "DRAFT-TEST", None, "user/repo", false);
insta::assert_snapshot!(table);
}

Expand All @@ -232,7 +248,7 @@ mod tests {
);
let deps: FlatDep = vec![(pr, None)];

let table = build_table(&deps, "CLOSED-TEST", None, "user/repo");
let table = build_table(&deps, "CLOSED-TEST", None, "user/repo", false);
insta::assert_snapshot!(table);
}

Expand All @@ -249,7 +265,7 @@ mod tests {
);
let deps: FlatDep = vec![(pr, None)];

let table = build_table(&deps, "MERGED-TEST", None, "user/repo");
let table = build_table(&deps, "MERGED-TEST", None, "user/repo", false);
insta::assert_snapshot!(table);
}

Expand All @@ -276,7 +292,7 @@ mod tests {

let deps: FlatDep = vec![(pr1.clone(), None), (pr2.clone(), Some(pr1.clone()))];

let table = build_table(&deps, "COMPLETE-STACK", None, "user/repo");
let table = build_table(&deps, "COMPLETE-STACK", None, "user/repo", false);
insta::assert_snapshot!(table);
}

Expand Down Expand Up @@ -316,7 +332,74 @@ mod tests {
(pr3.clone(), Some(pr2.clone())),
];

let table = build_table(&deps, "MIXED-STACK", None, "org/repo");
let table = build_table(&deps, "MIXED-STACK", None, "org/repo", false);
insta::assert_snapshot!(table);
}

#[test]
fn test_build_table_with_badges() {
let pr1 = make_pr(
1,
"feature-1",
"main",
"Base feature",
PullRequestStatus::Open,
false,
None,
);
let pr2 = make_pr(
2,
"feature-2",
"feature-1",
"Second feature",
PullRequestStatus::Open,
false,
None,
);

let deps: FlatDep = vec![(pr1.clone(), None), (pr2.clone(), Some(pr1.clone()))];

let table = build_table(&deps, "BADGES-TEST", None, "org/project", true);
insta::assert_snapshot!(table);
}

#[test]
fn test_build_table_with_badges_mixed_states() {
let pr1 = make_pr(
1,
"feature-1",
"main",
"Merged base",
PullRequestStatus::Closed,
false,
Some("2024-01-15T10:00:00Z".to_string()),
);
let pr2 = make_pr(
2,
"feature-2",
"feature-1",
"Open follow-up",
PullRequestStatus::Open,
false,
None,
);
let pr3 = make_pr(
3,
"feature-3",
"feature-2",
"Draft WIP",
PullRequestStatus::Open,
true,
None,
);

let deps: FlatDep = vec![
(pr1.clone(), None),
(pr2.clone(), Some(pr1.clone())),
(pr3.clone(), Some(pr2.clone())),
];

let table = build_table(&deps, "BADGES-MIXED", None, "org/repo", true);
insta::assert_snapshot!(table);
}
}
8 changes: 4 additions & 4 deletions src/snapshots/gh_stack__markdown__tests__build_table_all_closed_shows_checkmark.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ source: src/markdown.rs
expression: table
---
### ✅ Stacked PR Chain: COMPLETE-STACK
| PR | Title | Status | Merges Into |
|:--:|:------|:-------|:-------------:|
|#1|~~First~~|![](https://img.shields.io/github/pulls/detail/state/user/repo/1?label=Closed)|-|
|#2|~~Second~~|![](https://img.shields.io/github/pulls/detail/state/user/repo/2?label=Closed)|#1|
| PR | Title | Merges Into |
|:--:|:------|:-----------:|
|#1|~~First~~|-|
|#2|~~Second~~|#1|
10 changes: 5 additions & 5 deletions src/snapshots/gh_stack__markdown__tests__build_table_linear_stack.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ source: src/markdown.rs
expression: table
---
### Stacked PR Chain: STACK-456
| PR | Title | Status | Merges Into |
|:--:|:------|:-------|:-------------:|
|#1|Base feature|![](https://img.shields.io/github/pulls/detail/state/org/project/1?label=Pending)|-|
|#2|Second feature|![](https://img.shields.io/github/pulls/detail/state/org/project/2?label=Pending)|#1|
|#3|Third feature|![](https://img.shields.io/github/pulls/detail/state/org/project/3?label=Pending)|#2|
| PR | Title | Merges Into |
|:--:|:------|:-----------:|
|#1|Base feature|-|
|#2|Second feature|#1|
|#3|Third feature|#2|
10 changes: 5 additions & 5 deletions src/snapshots/gh_stack__markdown__tests__build_table_mixed_states.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ source: src/markdown.rs
expression: table
---
### Stacked PR Chain: MIXED-STACK
| PR | Title | Status | Merges Into |
|:--:|:------|:-------|:-------------:|
|#1|~~Merged base~~|![](https://img.shields.io/github/pulls/detail/state/org/repo/1?label=%20)|-|
|#2|Open follow-up|![](https://img.shields.io/github/pulls/detail/state/org/repo/2?label=Pending)|#1|
|#3|*(Draft) Draft WIP*|![](https://img.shields.io/github/pulls/detail/state/org/repo/3?label=Pending)|#2|
| PR | Title | Merges Into |
|:--:|:------|:-----------:|
|#1|~~Merged base~~|-|
|#2|Open follow-up|#1|
|#3|*(Draft) Draft WIP*|#2|
6 changes: 3 additions & 3 deletions src/snapshots/gh_stack__markdown__tests__build_table_single_pr.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@ source: src/markdown.rs
expression: table
---
### Stacked PR Chain: JIRA-123
| PR | Title | Status | Merges Into |
|:--:|:------|:-------|:-------------:|
|#1|Add new feature|![](https://img.shields.io/github/pulls/detail/state/user/repo/1?label=Pending)|-|
| PR | Title | Merges Into |
|:--:|:------|:-----------:|
|#1|Add new feature|-|
9 changes: 9 additions & 0 deletions src/snapshots/gh_stack__markdown__tests__build_table_with_badges.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
source: src/markdown.rs
expression: table
---
### Stacked PR Chain: BADGES-TEST
| PR | Title | Status | Merges Into |
|:--:|:------|:-------|:-----------:|
|#1|Base feature|![](https://img.shields.io/github/pulls/detail/state/org/project/1?label=Pending)|-|
|#2|Second feature|![](https://img.shields.io/github/pulls/detail/state/org/project/2?label=Pending)|#1|
Loading