use anyhow::{Context, Result};
use indexmap::IndexMap;
use crate::config::CommitType;
use crate::emoji::ReplaceEmoji;
use crate::questions::Answers;
fn get_summary(
answer: &str,
use_emoji: bool,
commit_type: &str,
commit_types: &IndexMap<String, CommitType>,
) -> Result<String> {
let commit_type = commit_types
.get(commit_type)
.with_context(|| format!("unknown commit type `{commit_type}`"))?;
let summary = answer.replace_emoji_shortcodes();
match (use_emoji, &commit_type.emoji) {
(true, Some(emoji)) => Ok(format!("{emoji} {summary}")),
_ => Ok(summary),
}
}
fn into_breaking_footer(breaking_text: &Option<String>) -> Option<String> {
breaking_text
.as_ref()
.map(|b| format!("BREAKING CHANGE: {b}"))
}
fn get_amended_body(
body: &Option<String>,
issue_reference: &Option<String>,
breaking_text: &Option<String>,
) -> Option<String> {
let body = match (body, issue_reference, breaking_text) {
(Some(body), Some(issue_reference), Some(breaking_text)) => {
Some(format!("{body}\n\n{issue_reference}\n{breaking_text}"))
}
(Some(body), Some(issue_reference), None) => Some(format!("{body}\n\n{issue_reference}")),
(Some(body), None, Some(breaking_text)) => Some(format!("{body}\n\n{breaking_text}")),
(Some(body), None, None) => Some(body.into()),
(None, Some(issue_reference), Some(breaking_text)) => {
Some(format!("{issue_reference}\n{breaking_text}"))
}
(None, Some(issue_reference), None) => Some(issue_reference.to_owned()),
(None, None, Some(breaking_text)) => Some(breaking_text.to_owned()),
(None, None, None) => None,
};
body.map(|b| b.replace_emoji_shortcodes())
}
#[derive(Debug, PartialEq, Eq)]
pub struct ExtractedAnswers {
pub body: Option<String>,
pub commit_type: String,
pub is_breaking_change: bool,
pub scope: Option<String>,
pub summary: String,
}
pub fn get_extracted_answers(
answers: Answers,
emoji: bool,
commit_types: &IndexMap<String, CommitType>,
) -> Result<ExtractedAnswers> {
let breaking_change_footer: Option<String> = if answers.is_breaking_change {
into_breaking_footer(&answers.breaking_change_footer)
} else {
None
};
Ok(ExtractedAnswers {
commit_type: answers.commit_type.clone(),
scope: answers.scope.map(|s| s.replace_emoji_shortcodes()),
summary: get_summary(&answers.summary, emoji, &answers.commit_type, commit_types)?,
body: get_amended_body(
&answers.body,
&answers.issue_footer,
&breaking_change_footer,
),
is_breaking_change: answers.is_breaking_change,
})
}
#[cfg(test)]
mod tests {
use std::error::Error;
use std::result::Result;
use cocogitto::CocoGitto;
use indexmap::indexmap;
use super::*;
#[test]
fn test_get_summary() -> Result<(), Box<dyn Error>> {
let commit_types = indexmap! {
"docs".into() => CommitType {
name: "docs".into(),
description: "Changes to documentation".into(),
emoji: Some("📚".to_string()),
},
};
let answer = "needed more badges";
assert_eq!(
get_summary(answer, false, "docs", &commit_types)?,
"needed more badges"
);
Ok(())
}
#[test]
fn test_get_summary_with_emoji() -> Result<(), Box<dyn Error>> {
let commit_types = indexmap! {
"docs".into() => CommitType {
name: "docs".into(),
description: "Changes to documentation".into(),
emoji: Some("📚".to_string()),
},
};
let answer = "needed more badges";
assert_eq!(
get_summary(answer, true, "docs", &commit_types)?,
"📚 needed more badges"
);
Ok(())
}
#[test]
fn test_get_summary_with_non_configured_emoji() -> Result<(), Box<dyn Error>> {
let commit_types = indexmap! {
"docs".into() => CommitType {
name: "docs".into(),
description: "Changes to documentation".into(),
emoji: None,
},
};
let answer = "needed more badges";
assert_eq!(
get_summary(answer, true, "docs", &commit_types)?,
"needed more badges"
);
Ok(())
}
#[test]
fn test_get_summary_with_unknown_type_errors() {
let commit_types = indexmap! {};
let error = get_summary("summary", false, "nope", &commit_types).unwrap_err();
assert!(error.to_string().contains("nope"));
}
#[test]
fn test_get_summary_with_shortcode() -> Result<(), Box<dyn Error>> {
let commit_types = indexmap! {
"docs".into() => CommitType {
name: "docs".into(),
description: "Changes to documentation".into(),
emoji: None,
},
};
let answer = "needed more badges :badger:";
assert_eq!(
get_summary(answer, false, "docs", &commit_types)?,
"needed more badges 🦡"
);
Ok(())
}
#[test]
fn test_into_breaking_footer() -> Result<(), Box<dyn Error>> {
let breaking_text = Some("this is a breaking change".to_string());
assert_eq!(
into_breaking_footer(&breaking_text),
Some("BREAKING CHANGE: this is a breaking change".into())
);
let breaking_text = None;
assert_eq!(into_breaking_footer(&breaking_text), None);
Ok(())
}
#[test]
fn test_get_amended_body() -> Result<(), Box<dyn Error>> {
let body = Some("i _really_ like badges".to_string());
let issue_reference = Some("closes #1".to_string());
let breaking_text = Some("BREAKING CHANGE: this is a breaking change".to_string());
assert_eq!(
get_amended_body(&body, &issue_reference, &breaking_text),
Some(
"i _really_ like badges\n\ncloses #1\nBREAKING CHANGE: this is a breaking change"
.into()
)
);
assert_eq!(
get_amended_body(&body, &issue_reference, &None),
Some("i _really_ like badges\n\ncloses #1".into())
);
assert_eq!(
get_amended_body(&body, &None, &breaking_text),
Some("i _really_ like badges\n\nBREAKING CHANGE: this is a breaking change".into())
);
assert_eq!(
get_amended_body(&body, &None, &None),
Some("i _really_ like badges".into())
);
assert_eq!(
get_amended_body(&None, &issue_reference, &breaking_text),
Some("closes #1\nBREAKING CHANGE: this is a breaking change".into())
);
assert_eq!(
get_amended_body(&None, &issue_reference, &None),
Some("closes #1".into())
);
assert_eq!(
get_amended_body(&None, &None, &breaking_text),
Some("BREAKING CHANGE: this is a breaking change".into())
);
assert_eq!(get_amended_body(&None, &None, &None), None);
Ok(())
}
#[test]
fn test_get_extracted_answers() -> Result<(), Box<dyn Error>> {
let answers = Answers {
commit_type: "feat".into(),
scope: Some("space".into()),
summary: "add more space".into(),
body: Some("just never enough space!".into()),
issue_footer: Some("closes #554".into()),
is_breaking_change: true,
breaking_change_footer: Some("this is a breaking change".into()),
};
let commit_types = indexmap! {
"feat".into() => CommitType {
name: "feat".into(),
description: "A new feature".into(),
emoji: Some("✨".to_string()),
},
};
let extracted_answers = get_extracted_answers(answers, false, &commit_types)?;
assert_eq!(
extracted_answers,
ExtractedAnswers {
commit_type: "feat".into(),
scope: Some("space".into()),
summary: "add more space".into(),
body: Some("just never enough space!\n\ncloses #554\nBREAKING CHANGE: this is a breaking change".into()),
is_breaking_change: true,
}
);
let message = CocoGitto::get_conventional_message(
&extracted_answers.commit_type,
extracted_answers.scope,
extracted_answers.summary,
extracted_answers.body,
None,
extracted_answers.is_breaking_change,
)?;
assert_eq!(
message,
"feat(space)!: add more space\n\njust never enough space!\n\ncloses #554\nBREAKING CHANGE: this is a breaking change"
);
let answers = Answers {
commit_type: "feat".into(),
scope: Some("space".into()),
summary: "add more space".into(),
body: Some("just never enough space!".into()),
issue_footer: Some("closes #554".into()),
is_breaking_change: false,
breaking_change_footer: Some("this is a breaking change".into()),
};
let extracted_answers = get_extracted_answers(answers, false, &commit_types)?;
assert_eq!(
extracted_answers,
ExtractedAnswers {
commit_type: "feat".into(),
scope: Some("space".into()),
summary: "add more space".into(),
body: Some("just never enough space!\n\ncloses #554".into()),
is_breaking_change: false,
}
);
Ok(())
}
}