version_spec 0.11.0

A specification for working with partial, full, or aliased versions. Supports semver and calver.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166

use compact_str::CompactString;
use version_spec::{Version, VersionKind, VersionSpec};

mod resolved_spec {
    use super::*;

    #[test]
    fn canary() {
        assert_eq!(VersionSpec::parse("canary").unwrap(), VersionSpec::Canary);
    }

    #[test]
    fn aliases() {
        assert_eq!(
            VersionSpec::parse("latest").unwrap(),
            VersionSpec::Alias(CompactString::new("latest"))
        );
        assert_eq!(
            VersionSpec::parse("stable").unwrap(),
            VersionSpec::Alias(CompactString::new("stable"))
        );
        assert_eq!(
            VersionSpec::parse("legacy-2023").unwrap(),
            VersionSpec::Alias(CompactString::new("legacy-2023"))
        );
        assert_eq!(
            VersionSpec::parse("future/202x").unwrap(),
            VersionSpec::Alias(CompactString::new("future/202x"))
        );
    }

    #[test]
    fn versions() {
        assert_eq!(
            VersionSpec::parse("v1.2.3").unwrap(),
            VersionSpec::Version(Version::semantic(1, 2, 3))
        );
        assert_eq!(
            VersionSpec::parse("1.2.3").unwrap(),
            VersionSpec::Version(Version::semantic(1, 2, 3))
        );
        assert_eq!(
            VersionSpec::parse("1.2.3-0").unwrap(),
            VersionSpec::Version(Version {
                prerelease: Some("0".into()),
                ..Version::semantic(1, 2, 3)
            })
        );
        assert_eq!(
            VersionSpec::parse("1.2.3-alpha").unwrap(),
            VersionSpec::Version(Version {
                prerelease: Some("alpha".into()),
                ..Version::semantic(1, 2, 3)
            })
        );
        assert_eq!(
            VersionSpec::parse("1.2.3-alpha.1").unwrap(),
            VersionSpec::Version(Version {
                prerelease: Some("alpha.1".into()),
                ..Version::semantic(1, 2, 3)
            })
        );

        // calver
        assert_eq!(
            VersionSpec::parse("2024-02").unwrap(),
            VersionSpec::Version(Version {
                kind: VersionKind::Calendar,
                major: 2024,
                minor: 2,
                ..Default::default()
            })
        );
        assert_eq!(
            VersionSpec::parse("2024-2-26").unwrap(),
            VersionSpec::Version(Version::calendar(2024, 2, 26))
        );
    }

    #[test]
    fn scoped_versions() {
        assert_eq!(
            VersionSpec::parse("node-1.2.3").unwrap(),
            VersionSpec::Version(Version {
                scope: Some("node".into()),
                ..Version::semantic(1, 2, 3)
            })
        );
        assert_eq!(
            VersionSpec::parse("v8-1.2.3").unwrap(),
            VersionSpec::Version(Version {
                scope: Some("v8".into()),
                ..Version::semantic(1, 2, 3)
            })
        );

        // calver
        assert_eq!(
            VersionSpec::parse("node-2024-02").unwrap(),
            VersionSpec::Version(Version {
                kind: VersionKind::Calendar,
                scope: Some("node".into()),
                major: 2024,
                minor: 2,
                ..Default::default()
            })
        );
        assert_eq!(
            VersionSpec::parse("foo-bar-2024-2-26").unwrap(),
            VersionSpec::Version(Version {
                scope: Some("foo-bar".into()),
                ..Version::calendar(2024, 2, 26)
            })
        );
    }

    #[test]
    fn serde_roundtrip() {
        for value in [
            "canary",
            "latest",
            "legacy-2023",
            "1.2.3",
            "1.2.3-alpha.1",
            "node-1.2.3",
            "2024-02-26",
            "node-2024-02",
        ] {
            let spec = VersionSpec::parse(value).unwrap();
            let json = serde_json::to_string(&spec).unwrap();

            assert_eq!(serde_json::from_str::<VersionSpec>(&json).unwrap(), spec);
        }
    }

    #[test]
    #[should_panic(expected = "FailedVersionParse")]
    fn error_invalid_char() {
        VersionSpec::parse("%").unwrap();
    }

    #[test]
    fn compares_against_version() {
        let version = Version::semantic(1, 2, 3);

        assert_eq!(VersionSpec::Version(version.clone()), version);
        assert_ne!(
            VersionSpec::Version(Version {
                scope: Some("scope".into()),
                ..version.clone()
            }),
            version
        );

        let version = Version::calendar(2024, 2, 26);

        assert_eq!(VersionSpec::Version(version.clone()), version);
        assert_ne!(
            VersionSpec::Version(Version {
                scope: Some("scope".into()),
                ..version.clone()
            }),
            version
        );
    }
}