multiversx_sc_meta_lib/cargo_toml/
cargo_toml_deps.rs

1use std::path::PathBuf;
2
3use crate::version::FrameworkVersion;
4
5use super::{DependencyRawValue, VersionReq};
6
7/// A dependency reference to a git commit. We mostly use git commits when referencing git.
8#[derive(Debug, Clone, PartialEq, Eq)]
9pub struct GitCommitReference {
10    pub git: String,
11    pub rev: String,
12}
13
14/// A dependency reference to a git branch.
15#[derive(Debug, Clone, PartialEq, Eq)]
16pub struct GitBranchReference {
17    pub git: String,
18    pub branch: String,
19}
20
21/// A dependency reference to a git tag.
22#[derive(Debug, Clone, PartialEq, Eq)]
23pub struct GitTagReference {
24    pub git: String,
25    pub tag: String,
26}
27
28/// Models how a dependency is expressed in Cargo.toml.
29#[derive(Debug, Clone, PartialEq, Eq)]
30pub enum DependencyReference {
31    Version(VersionReq),
32    GitCommit(GitCommitReference),
33    GitBranch(GitBranchReference),
34    GitTag(GitTagReference),
35    Path(PathBuf),
36    Unsupported(String),
37}
38
39impl DependencyReference {
40    pub fn is_framework_version(&self, version: &FrameworkVersion) -> bool {
41        if let DependencyReference::Version(version_req) = self {
42            &version_req.semver == version
43        } else {
44            false
45        }
46    }
47}
48
49impl DependencyRawValue {
50    /// Interprets the raw dependency value as one of several possible formats.
51    pub fn interpret(self) -> DependencyReference {
52        // path is top priority
53        if let Some(path) = self.path {
54            return DependencyReference::Path(path);
55        }
56
57        if let Some(git) = self.git {
58            return match (self.rev, self.branch, self.tag) {
59                (Some(rev), None, None) => {
60                    DependencyReference::GitCommit(GitCommitReference { git, rev })
61                }
62                (None, Some(branch), None) => {
63                    DependencyReference::GitBranch(GitBranchReference { git, branch })
64                }
65
66                (None, None, Some(tag)) => {
67                    DependencyReference::GitTag(GitTagReference { git, tag })
68                }
69
70                (None, None, None) => DependencyReference::Unsupported(
71                    "need at least one of: git commit, git branch, or git tag".to_owned(),
72                ),
73                _ => DependencyReference::Unsupported(
74                    "can only have one of: git commit, git branch, or git tag".to_owned(),
75                ),
76            };
77        }
78
79        // explicit version = "..."
80        // handled last, because it has the lowest priority, both path and git fields override it
81        if let Some(version) = self.version {
82            if let Some(version_req) = VersionReq::from_version_str(&version) {
83                return DependencyReference::Version(version_req);
84            } else {
85                return DependencyReference::Unsupported(format!(
86                    "unknown framework version: {version}"
87                ));
88            }
89        }
90
91        DependencyReference::Unsupported("expected at least one of: version, git, path".to_owned())
92    }
93}