jayver 1.0.0

A calendar versioning scheme for binaries developed by Emmett Jayhart
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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
//! Jayhart Version type and implementations.

use std::{
    convert::TryFrom,
    fmt::{Display, Formatter, Result as FmtResult},
    str::FromStr,
};

use nom::{combinator::all_consuming, Parser};
#[cfg(feature = "serialization")]
use serde::{Deserialize, Serialize};
use time::{Date, OffsetDateTime, Weekday};

use crate::{
    error::{Error, Result},
    parser::parse_version,
};

/// ISO week-numbering year minus 2000.
pub type Year = i32;
/// ISO 8601 Week number.
pub type Week = u8;
/// Micro patch number.
pub type Patch = u32;

/// Represents a JayVer version in YY.WW.PATCH format.
///
/// - YY: ISO week-numbering year minus 2000 (e.g., 25 for 2025)
/// - WW: ISO 8601 week number (1-53)
/// - PATCH: Incremental number starting at 0
///
/// # Examples
///
/// ```
/// use jayver::Version;
///
/// let v = Version::parse("25.16.0").unwrap();
/// assert_eq!(v.year, 25); // Year 2025 (25 + 2000)
/// assert_eq!(v.week, 16);
/// assert_eq!(v.patch, 0);
/// ```
///
/// Using year 2000 (represented as 0):
///
/// ```
/// use jayver::Version;
///
/// let v = Version::parse("0.1.0").unwrap();
/// assert_eq!(v.year, 0); // Year 2000 (0 + 2000)
/// assert_eq!(Version::full_year(v.year), 2000);
/// assert_eq!(v.week, 1);
/// assert_eq!(v.patch, 0);
/// ```
///
/// Pre-2000 years are represented as negative numbers:
///
/// ```
/// use jayver::Version;
///
/// // Pre-2000 years are represented as negative numbers
/// let v = Version::parse("-5.20.0").unwrap();
/// assert_eq!(v.year, -5); // Year 1995 (-5 + 2000)
/// assert_eq!(Version::full_year(v.year), 1995);
/// assert_eq!(v.week, 20);
/// assert_eq!(v.patch, 0);
/// ```
///
/// Compare versions chronologically:
///
/// ```
/// use jayver::Version;
///
/// let v1 = Version::parse("25.10.0").unwrap();
/// let v2 = Version::parse("25.20.0").unwrap();
/// let v3 = Version::parse("26.1.0").unwrap();
///
/// assert!(v1 < v2); // Week 10 is before week 20 in the same year
/// assert!(v2 < v3); // Year 25 (2025) is before year 26 (2026)
/// ```
#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[cfg_attr(feature = "serialization", derive(Serialize, Deserialize))]
pub struct Version {
    /// Year component (ISO week-numbering year - 2000)
    pub year: Year,
    /// ISO Week component (1-53)
    pub week: Week,
    /// Patch component
    pub patch: Patch,
}

impl Version {
    /// Create a new Version with validation.
    ///
    /// The `year` parameter should be the ISO week-numbering year minus 2000.
    ///
    /// Returns an error if the year/week combination is invalid.
    ///
    /// # Examples
    ///
    /// ```
    /// use jayver::Version;
    ///
    /// let v = Version::new(25, 16, 0).unwrap(); // Year 2025, week 16
    /// assert_eq!(v.to_string(), "25.16.0");
    ///
    /// // Invalid week
    /// assert!(Version::new(25, 54, 0).is_err());
    /// ```
    pub fn new(year: Year, week: Week, patch: Patch) -> Result<Self> {
        // Validate week range
        if !(1..=53).contains(&week) {
            return Err(Error::InvalidWeek {
                week,
            });
        }

        // Ensure this is a valid ISO week
        let full_year = Self::full_year(year);
        match Date::from_iso_week_date(full_year, week, Weekday::Monday) {
            Ok(_) => Ok(Self {
                year,
                week,
                patch,
            }),
            Err(_) => Err(Error::InvalidYearWeek {
                year,
                week,
            }),
        }
    }

    /// Parse a version string.
    ///
    /// # Examples
    ///
    /// ```
    /// use jayver::Version;
    ///
    /// let v = Version::parse("25.16.0").unwrap();
    /// assert_eq!(v.year, 25); // Year 2025
    /// ```
    pub fn parse<S>(text: S) -> Result<Self>
    where
        S: AsRef<str>,
    {
        let text = text.as_ref();
        text.parse().map_err(|_| Error::invalid_version(text))
    }

    /// Create a version representing the current date with patch 0.
    ///
    /// # Examples
    ///
    /// ```
    /// use jayver::Version;
    ///
    /// let today = Version::today();
    /// println!("Today's version: {}", today);
    /// ```
    pub fn today() -> Self {
        let now = OffsetDateTime::now_utc();
        let year = now.year();
        let week = now.iso_week();

        // Always subtract 2000 from the year
        let short_year = Self::short_year(year);

        Self {
            year: short_year,
            week,
            patch: 0,
        }
    }

    /// Increment the patch component.
    ///
    /// # Examples
    ///
    /// ```
    /// use jayver::Version;
    ///
    /// let mut v = Version::parse("25.16.0").unwrap();
    /// v.increment_patch();
    /// assert_eq!(v.patch, 1);
    /// ```
    pub fn increment_patch(&mut self) -> &mut Self {
        self.patch += 1;
        self
    }

    /// Move to the next week with patch reset to 0.
    ///
    /// # Examples
    ///
    /// ```
    /// use jayver::Version;
    ///
    /// let mut v = Version::parse("25.16.5").unwrap();
    /// v.next_week().unwrap();
    /// assert_eq!(v.week, 17);
    /// assert_eq!(v.patch, 0);
    /// ```
    pub fn next_week(&mut self) -> Result<&mut Self> {
        self.week += 1;

        // Handle week rollover to next year
        if self.week > 53 {
            self.year += 1;
            self.week = 1;
        }

        // Validate the new year/week combination
        let full_year = Self::full_year(self.year);
        match Date::from_iso_week_date(full_year, self.week, Weekday::Monday) {
            Ok(_) => {
                self.patch = 0;
                Ok(self)
            },
            Err(_) => {
                // If invalid, try the next week until we find a valid one
                self.week += 1;
                if self.week > 53 {
                    self.year += 1;
                    self.week = 1;
                }
                self.patch = 0;
                Ok(self)
            },
        }
    }

    /// Convert a full ISO week-numbering year (e.g., 2025) to short form (e.g.,
    /// 25)
    ///
    /// # Examples
    ///
    /// ```
    /// use jayver::Version;
    ///
    /// assert_eq!(Version::short_year(2025), 25);
    /// assert_eq!(Version::short_year(1995), -5);
    /// ```
    pub fn short_year(year: Year) -> Year {
        year - 2000
    }

    /// Convert a short year (e.g., 25) to full ISO week-numbering year (e.g.,
    /// 2025)
    ///
    /// # Examples
    ///
    /// ```
    /// use jayver::Version;
    ///
    /// assert_eq!(Version::full_year(25), 2025);
    /// assert_eq!(Version::full_year(-5), 1995);
    /// ```
    pub fn full_year(year: Year) -> Year {
        year + 2000
    }

    /// Return true if this version is from the same week as another version.
    ///
    /// # Examples
    ///
    /// ```
    /// use jayver::Version;
    ///
    /// let v1 = Version::parse("25.16.0").unwrap();
    /// let v2 = Version::parse("25.16.5").unwrap();
    /// assert!(v1.same_week(&v2));
    /// ```
    pub fn same_week(&self, other: &Self) -> bool {
        self.year == other.year && self.week == other.week
    }
}

impl FromStr for Version {
    type Err = Error;

    fn from_str(s: &str) -> Result<Self> {
        if s.is_empty() {
            return Err(Error::invalid_version("empty string"));
        }

        Version::try_from(s)
    }
}

impl TryFrom<&str> for Version {
    type Error = Error;

    fn try_from(s: &str) -> Result<Self> {
        all_consuming(parse_version)
            .parse(s)
            .map(|(_, version)| version)
            .map_err(|e| match e {
                nom::Err::Error(err) | nom::Err::Failure(err) => Error::from_nom(s, err),
                nom::Err::Incomplete(_) => Error::format(s),
            })
    }
}

impl Display for Version {
    fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult {
        write!(f, "{}.{}.{}", self.year, self.week, self.patch)
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_version_parse() {
        let v: Version = "25.12.3".parse().unwrap();
        assert_eq!(v, Version {
            year: 25,
            week: 12,
            patch: 3
        });
    }

    #[test]
    fn test_version_from_str_invalid() {
        assert!("25.54.1".parse::<Version>().is_err());
        assert!("invalid.version".parse::<Version>().is_err());
    }

    #[test]
    fn test_version_display() {
        let version = Version {
            year: 25,
            week: 12,
            patch: 3,
        };
        assert_eq!(version.to_string(), "25.12.3");
    }

    #[test]
    fn test_version_ordering() {
        let v1 = Version {
            year: 25,
            week: 10,
            patch: 1,
        };
        let v2 = Version {
            year: 25,
            week: 10,
            patch: 2,
        };
        let v3 = Version {
            year: 25,
            week: 11,
            patch: 1,
        };
        let v4 = Version {
            year: 26,
            week: 1,
            patch: 1,
        };

        assert!(v1 < v2);
        assert!(v2 < v3);
        assert!(v3 < v4);
    }

    #[test]
    fn test_today() {
        let today = Version::today();
        // This test is time-dependent, but we can at least ensure
        // the basic properties are valid
        assert!(today.week >= 1 && today.week <= 53);
        assert_eq!(today.patch, 0);
    }

    #[test]
    fn test_increment_patch() {
        let mut v = Version {
            year: 25,
            week: 10,
            patch: 1,
        };
        v.increment_patch();
        assert_eq!(v.patch, 2);
    }

    #[test]
    fn test_next_week() {
        let mut v = Version {
            year: 25,
            week: 10,
            patch: 5,
        };
        v.next_week().unwrap();
        assert_eq!(v.week, 11);
        assert_eq!(v.patch, 0);
    }

    #[test]
    fn test_next_week_year_rollover() {
        let mut v = Version {
            year: 25,
            week: 52,
            patch: 1,
        };
        v.next_week().unwrap();
        // Either week 53 of year 25 or week 1 of year 26,
        // depending on the calendar
        assert!((v.year == 25 && v.week == 53) || (v.year == 26 && v.week == 1));
        assert_eq!(v.patch, 0);
    }

    #[test]
    fn test_full_year() {
        assert_eq!(Version::full_year(25), 2025);
        assert_eq!(Version::full_year(-5), 1995);
    }

    #[test]
    fn test_short_year() {
        assert_eq!(Version::short_year(2025), 25);
        assert_eq!(Version::short_year(1995), -5);
    }

    #[test]
    fn test_same_week() {
        let v1 = Version {
            year: 25,
            week: 10,
            patch: 1,
        };
        let v2 = Version {
            year: 25,
            week: 10,
            patch: 5,
        };
        let v3 = Version {
            year: 25,
            week: 11,
            patch: 1,
        };

        assert!(v1.same_week(&v2));
        assert!(!v1.same_week(&v3));
    }

    #[test]
    fn test_year_2000() {
        // Test year 2000 (represented as 0)
        let version = Version::parse("0.1.0").unwrap();
        assert_eq!(version.year, 0);
        assert_eq!(Version::full_year(version.year), 2000);

        // Test creation and validation
        let created = Version::new(0, 1, 0).unwrap();
        assert_eq!(created.to_string(), "0.1.0");

        // Ensure proper ordering
        let v1 = Version::parse("0.52.0").unwrap();
        let v2 = Version::parse("1.1.0").unwrap();
        assert!(v1 < v2);
    }
}