gem-audit 2.7.0

Ultra-fast, standalone security auditor for Gemfile.lock
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

/// A parsed Ruby interpreter version from a Gemfile.lock `RUBY VERSION` section.
///
/// Example inputs:
/// - `"ruby 3.0.0p0"` -> engine="ruby", version="3.0.0"
/// - `"jruby 9.3.6.0"` -> engine="jruby", version="9.3.6.0"
/// - `"ruby 3.2.1"` -> engine="ruby", version="3.2.1"
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct RubyVersion {
    /// The Ruby engine (e.g., "ruby", "jruby", "mruby").
    pub engine: String,
    /// The version string with patchlevel stripped (e.g., "3.0.0").
    pub version: String,
}

impl RubyVersion {
    /// Parse a Ruby version string from a Gemfile.lock `RUBY VERSION` section.
    ///
    /// Expects format: `"<engine> <version>[p<patchlevel>]"`
    ///
    /// Returns `None` if the input doesn't match the expected format.
    pub fn parse(input: &str) -> Option<Self> {
        let trimmed = input.trim();
        let (engine, version_raw) = trimmed.split_once(' ')?;
        let version = strip_patchlevel(version_raw);

        Some(RubyVersion {
            engine: engine.to_string(),
            version,
        })
    }
}

/// Strip the patchlevel suffix (e.g., "p0", "p219") from a Ruby version string.
///
/// - `"3.0.0p0"` -> `"3.0.0"`
/// - `"2.7.6p219"` -> `"2.7.6"`
/// - `"9.3.6.0"` -> `"9.3.6.0"` (no patchlevel)
fn strip_patchlevel(version: &str) -> String {
    // Ruby patchlevel format: digits followed by 'p' followed by digits at end
    if let Some(pos) = version.rfind('p') {
        let before = &version[..pos];
        let after = &version[pos + 1..];
        // Only strip if the part after 'p' is all digits (patchlevel)
        // and the part before ends with a digit (not e.g. "pre")
        if !after.is_empty()
            && after.chars().all(|c| c.is_ascii_digit())
            && before.ends_with(|c: char| c.is_ascii_digit())
        {
            return before.to_string();
        }
    }
    version.to_string()
}

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

    #[test]
    fn parse_ruby_with_patchlevel() {
        let rv = RubyVersion::parse("ruby 3.0.0p0").unwrap();
        assert_eq!(rv.engine, "ruby");
        assert_eq!(rv.version, "3.0.0");
    }

    #[test]
    fn parse_ruby_with_high_patchlevel() {
        let rv = RubyVersion::parse("ruby 2.7.6p219").unwrap();
        assert_eq!(rv.engine, "ruby");
        assert_eq!(rv.version, "2.7.6");
    }

    #[test]
    fn parse_ruby_without_patchlevel() {
        let rv = RubyVersion::parse("ruby 3.2.1").unwrap();
        assert_eq!(rv.engine, "ruby");
        assert_eq!(rv.version, "3.2.1");
    }

    #[test]
    fn parse_jruby() {
        let rv = RubyVersion::parse("jruby 9.3.6.0").unwrap();
        assert_eq!(rv.engine, "jruby");
        assert_eq!(rv.version, "9.3.6.0");
    }

    #[test]
    fn parse_mruby() {
        let rv = RubyVersion::parse("mruby 3.1.0").unwrap();
        assert_eq!(rv.engine, "mruby");
        assert_eq!(rv.version, "3.1.0");
    }

    #[test]
    fn parse_with_leading_whitespace() {
        let rv = RubyVersion::parse("  ruby 3.0.0p0  ").unwrap();
        assert_eq!(rv.engine, "ruby");
        assert_eq!(rv.version, "3.0.0");
    }

    #[test]
    fn parse_empty_string() {
        assert!(RubyVersion::parse("").is_none());
    }

    #[test]
    fn parse_no_space() {
        assert!(RubyVersion::parse("ruby").is_none());
    }

    #[test]
    fn parse_empty_version() {
        assert!(RubyVersion::parse("ruby ").is_none());
    }

    #[test]
    fn strip_patchlevel_with_p0() {
        assert_eq!(strip_patchlevel("3.0.0p0"), "3.0.0");
    }

    #[test]
    fn strip_patchlevel_with_p219() {
        assert_eq!(strip_patchlevel("2.7.6p219"), "2.7.6");
    }

    #[test]
    fn strip_patchlevel_no_patchlevel() {
        assert_eq!(strip_patchlevel("3.2.1"), "3.2.1");
    }

    #[test]
    fn strip_patchlevel_preserves_pre_release() {
        // "pre" contains 'p' but it's not a patchlevel
        assert_eq!(strip_patchlevel("1.0.0.pre1"), "1.0.0.pre1");
    }
}