chaste_types/
module_path.rs

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
// SPDX-FileCopyrightText: 2024 The Chaste Authors
// SPDX-License-Identifier: Apache-2.0 OR BSD-2-Clause

use std::sync::LazyLock;

use crate::error::{Error, Result};
use crate::name::{package_name, PackageName, PackageNameBorrowed, PackageNamePositions};

pub static ROOT_MODULE_PATH: LazyLock<ModulePath> =
    LazyLock::new(|| ModulePath::new("".to_string()).unwrap());

#[derive(Debug, PartialEq, Eq, Clone)]
enum ModulePathSegmentInternal {
    Arbitrary(usize),
    NodeModules(usize),
    PackageName(usize, PackageNamePositions),
}

impl ModulePathSegmentInternal {
    fn end_idx(&self) -> usize {
        match self {
            Self::Arbitrary(i) => *i,
            Self::NodeModules(i) => *i,
            Self::PackageName(i, _) => *i,
        }
    }
}

#[derive(Debug, Clone)]
pub struct ModulePath {
    inner: String,
    segments: Vec<ModulePathSegmentInternal>,
}

impl ModulePath {
    pub fn new(value: String) -> Result<Self> {
        let mut segments = Vec::new();
        let mut end_idx = 0usize;
        let mut inside_node_modules = false;
        let mut inside_scoped = false;
        for (i, segment) in value.split("/").enumerate() {
            end_idx += segment.len();
            if i != 0 {
                end_idx += 1;
            }
            match segment {
                "" => {
                    // Empty value is a special case for root path
                    if value.is_empty() {
                        break;
                    }
                    return Err(Error::InvalidModulePath(value.to_string()));
                }
                "node_modules" => {
                    inside_node_modules = true;
                    segments.push(ModulePathSegmentInternal::NodeModules(end_idx));
                }
                seg if inside_node_modules && !inside_scoped && seg.starts_with("@") => {
                    inside_scoped = true;
                }
                _ if inside_node_modules => {
                    let last_seg = segments.last().unwrap();
                    if matches!(last_seg, ModulePathSegmentInternal::PackageName(..)) {
                        return Err(Error::InvalidModulePath(value.to_string()));
                    }
                    let start_idx = last_seg.end_idx() + 1;
                    let pn_str = &value[start_idx..end_idx];
                    let (remaining, pn_positions) = package_name(pn_str)
                        .map_err(|_| Error::InvalidPackageName(pn_str.to_string()))?;
                    if !remaining.is_empty() {
                        return Err(Error::InvalidPackageName(pn_str.to_string()));
                    }
                    segments.push(ModulePathSegmentInternal::PackageName(
                        end_idx,
                        pn_positions,
                    ));

                    inside_scoped = false;
                }
                _ => {
                    segments.push(ModulePathSegmentInternal::Arbitrary(end_idx));
                }
            }
        }
        if inside_scoped
            || segments
                .last()
                .is_some_and(|s| matches!(s, ModulePathSegmentInternal::NodeModules(_)))
        {
            return Err(Error::InvalidModulePath(value.to_string()));
        }

        debug_assert_eq!(
            segments.last().map(|s| s.end_idx()).unwrap_or(0),
            value.len()
        );

        Ok(Self {
            inner: value,
            segments,
        })
    }

    pub fn implied_package_name(&self) -> Option<PackageName> {
        let iter = self.iter();
        match iter.last() {
            Some(ModulePathSegment::PackageName(pn)) => Some(pn.to_owned()),
            Some(ModulePathSegment::Arbitrary(a)) => match self.segments.len() {
                1 => PackageName::new(a.to_string()).ok(),
                2 if self.inner.starts_with("@") => PackageName::new(self.inner.clone()).ok(),
                0 => unreachable!(),
                len => {
                    let scope_start = self.segments.get(len - 2).unwrap().end_idx() + 1;
                    PackageName::new(self.inner[scope_start..].to_string()).ok()
                }
            },
            Some(ModulePathSegment::NodeModules(_)) => unreachable!(),
            None => None,
        }
    }
}

impl AsRef<str> for ModulePath {
    fn as_ref(&self) -> &str {
        &self.inner
    }
}

#[derive(Debug, PartialEq, Eq)]
pub enum ModulePathSegment<'a> {
    Arbitrary(&'a str),
    NodeModules(&'a str),
    PackageName(PackageNameBorrowed<'a>),
}

pub struct ModulePathIter<'a> {
    inner: &'a ModulePath,
    idx: usize,
}

impl<'a> Iterator for ModulePathIter<'a> {
    type Item = ModulePathSegment<'a>;

    fn next(&mut self) -> Option<Self::Item> {
        let seg_idx = self.idx;
        self.idx += 1;
        let seg_int = self.inner.segments.get(seg_idx)?;
        let start_idx = if seg_idx == 0 {
            0
        } else {
            self.inner
                .segments
                .get(seg_idx - 1)
                .map(|s| s.end_idx() + 1)
                .unwrap()
        };
        let slic = &self.inner.inner[start_idx..seg_int.end_idx()];
        Some(match seg_int {
            ModulePathSegmentInternal::Arbitrary(_) => ModulePathSegment::Arbitrary(slic),
            ModulePathSegmentInternal::NodeModules(_) => ModulePathSegment::NodeModules(slic),
            ModulePathSegmentInternal::PackageName(_, package_name_positions) => {
                ModulePathSegment::PackageName(PackageNameBorrowed {
                    inner: slic,
                    positions: package_name_positions,
                })
            }
        })
    }
}

impl ModulePath {
    pub fn iter(&self) -> ModulePathIter {
        ModulePathIter {
            inner: self,
            idx: 0,
        }
    }
}

#[cfg(test)]
mod tests {
    use std::sync::LazyLock;

    use crate::error::Result;
    use crate::name::PackageName;

    use super::{ModulePath, ModulePathSegment};

    static SEMVER_PN: LazyLock<PackageName> =
        LazyLock::new(|| PackageName::new("semver".to_string()).unwrap());
    static TESTCASE_PN: LazyLock<PackageName> =
        LazyLock::new(|| PackageName::new("@chastelock/testcase".to_string()).unwrap());

    #[test]
    fn basic_mod() -> Result<()> {
        let path = ModulePath::new("node_modules/semver".to_string())?;
        let mut segments = path.iter();
        assert_eq!(
            segments.next(),
            Some(ModulePathSegment::NodeModules("node_modules"))
        );
        assert_eq!(
            segments.next(),
            Some(ModulePathSegment::PackageName(SEMVER_PN.as_borrowed()))
        );
        assert_eq!(segments.next(), None);

        Ok(())
    }

    #[test]
    fn basic_mod_scoped() -> Result<()> {
        let path = ModulePath::new("node_modules/@chastelock/testcase".to_string())?;
        let mut segments = path.iter();
        assert_eq!(
            segments.next(),
            Some(ModulePathSegment::NodeModules("node_modules"))
        );
        assert_eq!(
            segments.next(),
            Some(ModulePathSegment::PackageName(TESTCASE_PN.as_borrowed()))
        );
        assert_eq!(segments.next(), None);

        Ok(())
    }

    #[test]
    fn empty() -> Result<()> {
        let path = ModulePath::new("".to_string())?;
        let mut segments = path.iter();
        assert_eq!(segments.next(), None);

        Ok(())
    }

    #[test]
    fn mod_inside_workspace_member() -> Result<()> {
        let path =
            ModulePath::new("arbitrary/prefix/node_modules/@chastelock/testcase".to_string())?;
        let mut segments = path.iter();
        assert_eq!(
            segments.next(),
            Some(ModulePathSegment::Arbitrary("arbitrary"))
        );
        assert_eq!(
            segments.next(),
            Some(ModulePathSegment::Arbitrary("prefix"))
        );
        assert_eq!(
            segments.next(),
            Some(ModulePathSegment::NodeModules("node_modules"))
        );
        assert_eq!(
            segments.next(),
            Some(ModulePathSegment::PackageName(TESTCASE_PN.as_borrowed()))
        );
        assert_eq!(segments.next(), None);

        Ok(())
    }

    #[test]
    fn bs_paths() -> Result<()> {
        fn invalid(input: &str) {
            assert!(ModulePath::new(input.to_string()).is_err());
        }
        invalid("/");
        invalid("a/");
        invalid("node_modules");
        invalid("node_modules/@chastelock/testcase/something/deeper");
        invalid("node_modules/@chastelock");
        Ok(())
    }
}