nextsv 0.19.30

use std::{cmp::Ordering, fmt};

use git2::Repository;
use regex::Regex;

use crate::Error;

use super::Semantic;

/// The VersionTag data structure represents a git tag containing a
/// semantic version number.
///
#[derive(Debug, Default, Clone)]
pub(crate) struct VersionTag {
    pub(crate) refs: String,
    pub(crate) tag_prefix: String,
    pub(crate) version_prefix: String,
    pub(crate) semantic_version: Semantic,
}

impl PartialEq for VersionTag {
    fn eq(&self, other: &Self) -> bool {
        self.semantic_version == other.semantic_version
    }
}

impl Eq for VersionTag {}

impl PartialOrd for VersionTag {
    fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
        Some(self.cmp(other))
    }
}

impl Ord for VersionTag {
    fn cmp(&self, other: &Self) -> Ordering {
        self.semantic_version.cmp(&other.semantic_version)
    }
}

impl fmt::Display for VersionTag {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(
            f,
            "{}{}{}{}",
            self.refs, self.tag_prefix, self.version_prefix, self.semantic_version
        )
    }
}

impl VersionTag {
    // Create a new struct specifying each of the semantic version components.
    fn new(
        refs: String,
        tag_prefix: String,
        version_prefix: String,
        semantic_version: Semantic,
    ) -> Self {
        VersionTag {
            refs,
            tag_prefix,
            version_prefix,
            semantic_version,
        }
    }
    /// # Parse a tag and return a struct
    /// String format expect: <version_prefix>x.y.z<-pre_release><+build_data>
    ///
    /// ## Fields
    ///
    /// tag - the tag proposed as a semantic version tag
    /// version_prefix - any string before the semantic version number
    ///
    /// # Example
    ///
    /// Parse a tag into a semantic version number where "v" is used to identify
    /// tags representing semantic version numbers.
    ///
    /// ```no_comp
    /// # fn main() -> Result<(), nextsv::Error> {
    /// use self::VersionTag;
    ///
    /// let tag = "refs/tags/v0.2.3";
    /// let semantic_version = VersionTag::parse(tag, "v")?;
    ///
    /// assert_eq!(0, semantic_version.version().major());
    /// assert_eq!(2, semantic_version.version().minor());
    /// assert_eq!(3, semantic_version.version().patch());
    ///
    /// # Ok(())
    /// # }
    /// ```
    /// to identify tags with semantic version numbers
    /// the tag name can be parsed
    pub(crate) fn parse(tag: &str, version_prefix: &str) -> Result<Self, Error> {
        let re_tag = format!(
            r"(?<refs>(refs/tags/)*)(?<tag_prefix>.*)(?<version_prefix>{version_prefix})(?<major>0|[1-9]\d*)\.(?<minor>0|[1-9]\d*)\.(?<patch>0|[1-9]\d*)(?:-(?<pre_release>(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+(?<build_meta_data>[0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$"
        );

        let re = Regex::new(&re_tag).unwrap();

        log::trace!("Parsing git tag `{tag}` into VersionTag");
        let caps_res = re.captures(tag);
        log::trace!("Regex captures result: {caps_res:?}");
        let Some(caps) = caps_res else {
            version_number_valid(tag, version_prefix)?;
            panic!("Tag validation failed");
        };

        let semantic_version = Semantic::new(
            caps.name("major").unwrap().as_str(),
            caps.name("minor").unwrap().as_str(),
            caps.name("patch").unwrap().as_str(),
            caps.name("pre_release").map_or("", |m| m.as_str()),
            caps.name("build_meta_data").map_or("", |m| m.as_str()),
        );

        Ok(VersionTag::new(
            caps.name("refs").map_or("", |m| m.as_str()).to_string(),
            caps.name("tag_prefix")
                .map_or("", |m| m.as_str())
                .to_string(),
            version_prefix.to_string(),
            semantic_version,
        ))
    }

    /// Provide a mutable reference to the semantic version
    pub(crate) fn version_mut(&mut self) -> &mut Semantic {
        &mut self.semantic_version
    }

    /// Find the latest version tag in a repo
    ///
    pub(crate) fn find_in_repo(
        repo: &Repository,
        package: &str,
        version_prefix: &str,
    ) -> Result<Self, Error> {
        log::debug!("Repository opened to find latest version tag.");

        let version_prefix = get_tag_prefix(package, version_prefix);

        // Setup regex to test the tag for a version number: major.minor,patch
        let re_version = build_version_regex(&version_prefix);
        log::debug!("Regex to search for version tags is: `{re_version}`.");
        let re = match Regex::new(&re_version) {
            Ok(r) => r,
            Err(e) => return Err(Error::CorruptVersionRegex(e)),
        };

        let mut versions = vec![];
        repo.tag_foreach(|_id, tag| {
            if let Ok(tag) = String::from_utf8(tag.to_owned()) {
                log::trace!("Is git tag `{tag}` a version tag?");
                if let Some(version) = re.captures(&tag) {
                    log::trace!("Captured version: {version:?}");
                    let version = VersionTag::parse(&tag, &version_prefix).unwrap();
                    versions.push(version);
                }
            }
            true
        })?;

        trace_items(versions.clone(), &version_prefix);
        log::trace!("Original last version: {:?}", versions.last());
        versions.sort();
        log::debug!("Version tags have been sorted");
        trace_items(versions.clone(), &version_prefix);

        let current_version = match versions.last().cloned() {
            Some(v) => {
                log::trace!("latest version found is {:?}", &v);
                v
            }
            None => return Err(Error::NoVersionTag),
        };
        Ok(current_version)
    }
}

/// Build the regex pattern for matching version tags.
///
/// Anchors after `refs/tags/` so that prefix "v" only matches workspace
/// tags like `refs/tags/v1.0.0` and not crate tags like
/// `refs/tags/gen-changelog-v1.0.0`.
fn build_version_regex(version_prefix: &str) -> String {
    format!(r"^refs/tags/{version_prefix}\d+\.\d+\.\d+")
}

fn get_tag_prefix(package: &str, prefix: &str) -> String {
    if !package.is_empty() {
        format!("{package}-v")
    } else {
        prefix.to_string()
    }
}

fn trace_items(versions: Vec<VersionTag>, prefix: &str) {
    log::trace!("Tags with semantic version numbers prefixed with `{prefix}`");
    for ver in &versions {
        log::trace!("\t{ver}");
    }
}

fn version_number_valid(tag: &str, version_prefix: &str) -> Result<(), Error> {
    log::debug!("Validating the tag `{tag}` with version identified by `{version_prefix}`");
    let tag = tag.trim_start_matches("refs/tags/");
    log::debug!("The tag after git prefix is stripped is `{tag}`");

    let mut version = if !version_prefix.is_empty() {
        let re = Regex::new(version_prefix).unwrap();
        let m_res = re.find(tag);

        // the tag string must start with the version_prefix
        let Some(m) = m_res else {
            return Err(Error::NotVersionTag(
                version_prefix.to_string(),
                tag.to_string(),
            ));
        };

        log::debug!("The prefix was found: {m:?}");
        let (_prefix, remainder) = tag.split_at(m.end());
        remainder
    } else {
        tag
    };
    log::debug!("The version string is: {version}");
    // Remove any build data from the end
    if let Some((v, _build)) = version.rsplit_once('+') {
        log::debug!("The version after build is stripped is: {v}");
        version = v;
    };
    // Remove any build data from the end
    if let Some((v, _pre_release)) = version.rsplit_once('-') {
        log::debug!("The version after pre release is stripped is: {v}");
        version = v;
    };

    let components: Vec<&str> = version.split('.').collect();

    log::debug!("The components of the version string are {components:?}");

    let mut count = 0;
    let mut numbers = vec![];

    for item in components {
        count += 1;
        if count > 3 {
            return Err(Error::TooManyComponents(count));
        }
        numbers.push(match item.parse::<usize>() {
            Ok(n) => n,
            Err(_) => return Err(Error::MustBeNumber(item.to_string())),
        });
    }

    log::debug!("count complete with {count} numbers found: {numbers:?}.");

    if count < 3 {
        return Err(Error::TooFewComponents(count));
    };

    Ok(())
}

#[cfg(test)]
mod tests {

    use log::LevelFilter;
    use rstest::rstest;

    use crate::test_utils::*;
    use crate::version::PreRelease;

    use super::*;

    fn get_test_logger() {
        let mut builder = env_logger::Builder::new();
        builder.filter(None, LevelFilter::Debug);
        builder.format_timestamp_secs().format_module_path(false);
        let _ = builder.try_init();
    }

    fn version_tag_example_one() -> VersionTag {
        let pre_release = PreRelease::new("alpha.4");
        gen_current_version("v", 2, 9, 17, Some(pre_release), Some("2000".to_string()))
    }

    fn version_tag_example_two() -> VersionTag {
        let pre_release = PreRelease::new("beta.1");
        gen_current_version("v", 1, 17, 3, Some(pre_release), Some("2000".to_string()))
    }

    #[test]
    fn test_partial_eq() {
        let tag1 = version_tag_example_one();
        let tag2 = version_tag_example_one();
        assert_eq!(tag1, tag2);
    }

    #[test]
    fn test_eq() {
        let tag1 = version_tag_example_one();
        let tag2 = version_tag_example_one();
        assert!(tag1 == tag2);
    }

    #[test]
    fn test_partial_ord() {
        let tag1 = version_tag_example_one();
        let tag2 = version_tag_example_two();
        assert!(tag1 > tag2);
    }

    #[test]
    fn test_ord() {
        let tag1 = version_tag_example_one();
        let tag2 = version_tag_example_two();
        assert_eq!(tag1.cmp(&tag2), std::cmp::Ordering::Greater);
    }

    #[rstest]
    #[case::non_prod("v", 0, 7, 9, "", "", "refs/tags/v0.7.9")]
    #[case::first_alpha("v", 1, 0, 0, "alpha.1", "", "refs/tags/v1.0.0-alpha.1")]
    #[case::alpha_with_build("v", 1, 0, 0, "alpha.2", "10", "refs/tags/v1.0.0-alpha.2+10")]
    #[case::beta_with_build("v", 1, 0, 0, "beta.1", "30", "refs/tags/v1.0.0-beta.1+30")]
    #[case::release_candidate("v", 1, 0, 0, "rc.1", "40", "refs/tags/v1.0.0-rc.1+40")]
    #[case::first_version("v", 1, 0, 0, "", "", "refs/tags/v1.0.0")]
    #[case::patched_first_version("v", 1, 0, 1, "", "", "refs/tags/v1.0.1")]
    #[case::minor_update_first_version("v", 1, 1, 0, "", "", "refs/tags/v1.1.0")]
    #[case::custom_pre_release(
        "v",
        2,
        0,
        0,
        "pre.1",
        "circle.1",
        "refs/tags/v2.0.0-pre.1+circle.1"
    )]
    #[case::alphanumeric_build(
        "v",
        2,
        0,
        0,
        "pre.2",
        "circle.14",
        "refs/tags/v2.0.0-pre.2+circle.14"
    )]
    fn test_display_value(
        #[case] prefix: &str,
        #[case] major: u32,
        #[case] minor: u32,
        #[case] patch: u32,
        #[case] pre_release: &str,
        #[case] build_meta_data: &str,
        #[case] expected: &str,
    ) {
        let pre_release = if !pre_release.is_empty() {
            Some(PreRelease::new(pre_release))
        } else {
            None
        };
        let build_meta_data = if build_meta_data.is_empty() {
            None
        } else {
            Some(build_meta_data.to_string())
        };
        let test_version =
            gen_current_version(prefix, major, minor, patch, pre_release, build_meta_data);
        assert_eq!(expected, test_version.to_string().as_str());
    }

    #[rstest]
    #[case::simple_version("refs/tags/v0.7.9", "v", true)]
    #[case::pre_release_version("refs/tags/ver1.0.0-alpha.1", "ver", true)]
    #[case::alpha_with_build("refs/tags/1.0.0-alpha.2+10", "", true)]
    #[case::invalid_version_prefix("refs/tags/ver1.0.0-beta.1+30", "v", false)]
    #[case::invalid_version_number("refs/tags/v1.a.0-rc.1+40", "v", false)]
    #[case::first_version("refs/tags/v1.0.0", "v", true)]
    #[case::patched_first_version("refs/tags/v1.0.1", "v", true)]
    #[case::minor_update_first_version("refs/tags/v1.1.0", "v", true)]
    #[case::custom_pre_release("refs/tags/v2.0.0-pre.1+circle.1", "v", true)]
    #[case::alphanumeric_build("refs/tags/v2.0.0-pre.2+circle.14", "v", true)]
    #[case::no_refs("v2.0.0-pre.2+circle.14", "v", true)]
    fn test_parse_value(#[case] input: &str, #[case] version_prefix: &str, #[case] expected: bool) {
        get_test_logger();

        let result = VersionTag::parse(input, version_prefix);
        log::debug!("the result is:{result:?}");
        assert_eq!(expected, result.is_ok());
        if result.is_ok() {
            let version = result.unwrap();
            assert_eq!(input, version.to_string().as_str());
        }
    }

    #[rstest]
    #[case::valid_alpha_with_build("refs/tags/v1.0.0-alpha.2+10", "v", "Ok(())", true)]
    #[case::valid_simple_version("refs/tags/v0.7.9", "v", "Ok(())", true)]
    #[case::valid_no_version_marker("refs/tags/1.0.0-alpha.1", "", "Ok(())", true)]
    #[case::invalid_version_prefix(
        "refs/tags/ver1.a.0-rc.1+40",
        "var",
        r#"Err(NotVersionTag("var", "ver1.a.0-rc.1+40"))"#,
        false
    )]
    #[case::invalid_version_number(
        "refs/tags/v1.a.0-rc.1+40",
        "v",
        r#"Err(MustBeNumber("a"))"#,
        false
    )]
    #[case::invalid_version_prefix_incomplete(
        "refs/tags/ver1.0.0-beta.1+30",
        "v",
        r#"Err(MustBeNumber("er1"))"#,
        false
    )]
    #[case::invalid_too_many_components_in_version(
        "refs/tags/v1.0.0.0",
        "v",
        r#"Err(TooManyComponents(4))"#,
        false
    )]
    #[case::invalid_too_few_components_in_version(
        "refs/tags/v1.0",
        "v",
        r#"Err(TooFewComponents(2))"#,
        false
    )]
    fn test_version_number_validation(
        #[case] input: &str,
        #[case] version_prefix: &str,
        #[case] expected_result: &str,
        #[case] expected_pass: bool,
    ) {
        get_test_logger();

        let result = version_number_valid(input, version_prefix);
        println!("result: {result:?}");
        assert_eq!(expected_result, format!("{result:?}"));
        assert_eq!(expected_pass, result.is_ok());
    }
    #[rstest]
    #[case::prefix_set("", "test-v", "test-v")]
    #[case::package_set("nextsv", "v", "nextsv-v")]
    #[case::package_and_prefix_set("nextsv", "test-v", "nextsv-v")]

    fn test_get_package_prefix(
        #[case] package: &str,
        #[case] prefix: &str,
        #[case] expected_result: &str,
    ) {
        get_test_logger();

        let version_prefix = get_tag_prefix(package, prefix);
        println!("result: {version_prefix:?}");
        assert_eq!(expected_result.to_string(), version_prefix);
    }

    /// Test that the version tag regex correctly discriminates between
    /// workspace tags (prefix "v") and crate tags (prefix "gen-changelog-v").
    ///
    /// Regression test for <https://github.com/jerus-org/nextsv/issues/443>:
    /// The unanchored regex `(v\d+\.\d+\.\d+)` incorrectly matches "v0.1.6"
    /// inside "refs/tags/gen-changelog-v0.1.6".
    #[rstest]
    #[case::workspace_prefix_matches_workspace_tag("v", "refs/tags/v0.1.6", true)]
    #[case::workspace_prefix_must_not_match_crate_tag("v", "refs/tags/gen-changelog-v0.1.6", false)]
    #[case::crate_prefix_matches_crate_tag(
        "gen-changelog-v",
        "refs/tags/gen-changelog-v0.1.6",
        true
    )]
    #[case::crate_prefix_must_not_match_workspace_tag("gen-changelog-v", "refs/tags/v0.1.6", false)]
    #[case::workspace_prefix_matches_higher_version("v", "refs/tags/v1.2.3", true)]
    #[case::workspace_prefix_must_not_match_other_crate("v", "refs/tags/nextsv-v2.0.0", false)]
    #[case::crate_prefix_matches_own_crate("nextsv-v", "refs/tags/nextsv-v2.0.0", true)]
    #[case::crate_prefix_must_not_match_different_crate(
        "nextsv-v",
        "refs/tags/gen-changelog-v0.1.6",
        false
    )]
    fn test_version_tag_regex_anchoring(
        #[case] version_prefix: &str,
        #[case] tag: &str,
        #[case] should_match: bool,
    ) {
        get_test_logger();

        let re_version = build_version_regex(version_prefix);
        let re = Regex::new(&re_version).unwrap();
        let matched = re.is_match(tag);
        assert_eq!(
            should_match, matched,
            "prefix={version_prefix:?} tag={tag:?}: expected match={should_match} got={matched}"
        );
    }

    #[test]
    fn tag_broken_down_correctly() {
        let tag = "refs/tags/hcaptcha-v2.3.1-Beta.3+20876.675";

        let test_version = VersionTag::parse(tag, "v").unwrap();

        assert_eq!("refs/tags/", test_version.refs);
        assert_eq!("hcaptcha-", test_version.tag_prefix);
        assert_eq!("v", test_version.version_prefix);
        assert_eq!(
            "2.3.1-Beta.3+20876.675",
            test_version.semantic_version.to_string().as_str()
        );
        assert_eq!(2, test_version.semantic_version.major);
        assert_eq!(3, test_version.semantic_version.minor);
        assert_eq!(1, test_version.semantic_version.patch);
        assert_eq!(
            "Beta.3",
            test_version
                .semantic_version
                .pre_release
                .unwrap()
                .to_string()
                .as_str()
        );
        assert_eq!(
            "20876.675",
            test_version
                .semantic_version
                .build_meta_data
                .as_ref()
                .unwrap()
        );
    }
}