lux_lib/project/
mod.rs

1use itertools::Itertools;
2use miette::{Diagnostic, NamedSource, SourceSpan};
3use path_slash::PathBufExt;
4use project_toml::{
5    LocalProjectTomlValidationError, PartialProjectToml, RemoteProjectTomlValidationError,
6};
7use std::{
8    io,
9    ops::Deref,
10    path::{Path, PathBuf},
11    str::FromStr,
12};
13use thiserror::Error;
14use toml_edit::{DocumentMut, Item};
15
16use crate::fs;
17
18use crate::{
19    config::Config,
20    git::{
21        self,
22        shorthand::RemoteGitUrlShorthand,
23        url::RemoteGitUrl,
24        utils::{GitError, SemVerTagOrSha},
25    },
26    lua_rockspec::{
27        LocalLuaRockspec, LuaRockspecError, LuaVersionError, PartialLuaRockspec,
28        PartialRockspecError, RemoteLuaRockspec,
29    },
30    lua_version::LuaVersion,
31    package::SpecRev,
32    package_db::PackageDB,
33    rockspec::{
34        lua_dependency::{DependencyType, LuaDependencySpec, LuaDependencyType},
35        LuaVersionCompatibility,
36    },
37};
38use crate::{
39    lockfile::PinnedState,
40    package::{PackageName, PackageReq, PackageVersionReq},
41};
42
43pub(crate) mod gen;
44pub mod project_toml;
45
46pub use project_toml::PROJECT_TOML;
47
48pub const EXTRA_ROCKSPEC: &str = "extra.rockspec";
49
50/// A wrapper around [`toml::de::Error`] plus the original source code and the byte range where the
51/// error occurred so that `miette` can render the failure with line numbers and context.
52#[derive(Debug, Error, Diagnostic)]
53#[error("{message}", message = _inner.message())]
54#[diagnostic(
55    code(lux_lib::toml::deserialize),
56    help("check that the file is valid TOML and matches the expected schema"),
57    url("https://lux.lumen-labs.org/reference/lux-toml")
58)]
59pub struct TomlDeError {
60    #[source]
61    _inner: Box<toml::de::Error>,
62    #[source_code]
63    src: NamedSource<String>,
64    #[label("here")]
65    span: SourceSpan,
66}
67
68impl TomlDeError {
69    pub fn new(name: &str, src: &str, inner: toml::de::Error) -> Self {
70        let src = NamedSource::new(name, src.to_string());
71        let span = inner.span().unwrap_or(0..0).into();
72        Self {
73            _inner: Box::new(inner),
74            src,
75            span,
76        }
77    }
78
79    pub fn inner(&self) -> &toml::de::Error {
80        &self._inner
81    }
82}
83
84pub(crate) fn parse_toml<T>(name: &str, src: &str) -> Result<T, TomlDeError>
85where
86    T: serde::de::DeserializeOwned,
87{
88    toml::from_str(src).map_err(|e| TomlDeError::new(name, src, e))
89}
90
91#[derive(Error, Debug, Diagnostic)]
92#[non_exhaustive]
93#[error(transparent)]
94pub enum ProjectError {
95    #[error(transparent)]
96    #[diagnostic(transparent)]
97    Fs(#[from] fs::FsError),
98    #[diagnostic(transparent)]
99    Project(#[from] LocalProjectTomlValidationError),
100    #[diagnostic(transparent)]
101    Toml(#[from] TomlDeError),
102    #[error("error when parsing 'extra.rockspec'")]
103    #[diagnostic(forward(0))]
104    Rockspec(#[from] PartialRockspecError),
105}
106
107#[derive(Error, Debug, Diagnostic)]
108#[non_exhaustive]
109#[error(transparent)]
110pub enum IntoLocalRockspecError {
111    LocalProjectTomlValidationError(Box<LocalProjectTomlValidationError>),
112    RockspecError(Box<LuaRockspecError>),
113}
114
115#[derive(Error, Debug, Diagnostic)]
116#[non_exhaustive]
117#[error(transparent)]
118pub enum IntoRemoteRockspecError {
119    RocksTomlValidationError(Box<RemoteProjectTomlValidationError>),
120    RockspecError(Box<LuaRockspecError>),
121}
122
123#[derive(Error, Debug, Diagnostic)]
124#[non_exhaustive]
125pub enum ProjectEditError {
126    #[error(transparent)]
127    Io(#[from] tokio::io::Error),
128    #[error(transparent)]
129    #[diagnostic(transparent)]
130    Fs(#[from] fs::FsError),
131    #[error(transparent)]
132    Toml(#[from] toml_edit::TomlError),
133    #[error("error parsing {PROJECT_TOML} after edit. This is probably a bug.")]
134    #[diagnostic(forward(0))]
135    TomlDe(#[from] TomlDeError),
136    #[error(transparent)]
137    #[diagnostic(transparent)]
138    Git(#[from] GitError),
139    #[error("unable to query latest version for '{0}'")]
140    #[diagnostic(help("check your server config and ensure the package has been published"))]
141    LatestVersionNotFound(PackageName),
142    #[error("expected field to be a value, but got '{0}'")]
143    #[diagnostic(
144        help("ensure your {PROJECT_TOML} matches the specification"),
145        url("https://lux.lumen-labs.org/reference/lux-toml")
146    )]
147    ExpectedValue(Box<toml_edit::Item>),
148    #[error("expected string, but got '{0}'")]
149    #[diagnostic(
150        help("ensure your {PROJECT_TOML} matches the specification"),
151        url("https://lux.lumen-labs.org/reference/lux-toml")
152    )]
153    ExpectedString(Box<toml_edit::Value>),
154    #[error(transparent)]
155    #[diagnostic(transparent)]
156    GitUrlShorthandParse(#[from] git::shorthand::ParseError),
157}
158
159#[derive(Error, Debug, Diagnostic)]
160#[non_exhaustive]
161pub enum PinError {
162    #[error("package '{0}' not found in dependencies")]
163    #[diagnostic(help("to add it, run 'lx add {0}'"))]
164    PackageNotFound(PackageName),
165    #[error("dependency '{dep}' is already {}pinned!", if *.pin_state == PinnedState::Unpinned { "un" } else { "" })]
166    PinStateUnchanged {
167        pin_state: PinnedState,
168        dep: PackageName,
169    },
170    #[error("unable to parse {toml_path} for editing")]
171    #[diagnostic(
172        code(lux_lib::toml_edit::parse),
173        help("check that the file is valid TOML and matches the expected schema"),
174        url("https://lux.lumen-labs.org/reference/lux-toml")
175    )]
176    ParseTomlEdit {
177        toml_path: String,
178        source: toml_edit::TomlError,
179    },
180    #[error("error parsing lux.toml after edit. This is probably a bug.")]
181    #[diagnostic(forward(0))]
182    TomlDe(#[from] TomlDeError),
183    #[error(transparent)]
184    Io(#[from] tokio::io::Error),
185    #[error(transparent)]
186    #[diagnostic(transparent)]
187    Fs(#[from] fs::FsError),
188}
189
190/// A newtype for the project root directory.
191/// This is used to ensure that the project root is a valid project directory.
192#[derive(Clone, Debug)]
193#[cfg_attr(test, derive(Default))]
194pub struct ProjectRoot(PathBuf);
195
196impl ProjectRoot {
197    pub(crate) fn new() -> Self {
198        Self(PathBuf::new())
199    }
200}
201
202impl AsRef<Path> for ProjectRoot {
203    fn as_ref(&self) -> &Path {
204        self.0.as_ref()
205    }
206}
207
208impl Deref for ProjectRoot {
209    type Target = PathBuf;
210
211    fn deref(&self) -> &Self::Target {
212        &self.0
213    }
214}
215
216/// Lux project, with methods for managing dependencies, etc.
217#[derive(Clone, Debug)]
218pub struct Project {
219    /// The path where the `lux.toml` resides.
220    lux_toml_dir: ProjectRoot,
221    /// The project root. This is the same as [`Project::lux_toml_dir`],
222    /// unless overridden by the `[project] root_dir` field.
223    root: ProjectRoot,
224    /// The parsed lux.toml.
225    toml: PartialProjectToml,
226}
227
228impl Project {
229    /// Load a project at the specified path, if it exists
230    #[tracing::instrument(level = "trace", skip_all)]
231    pub fn from_exact(start: impl AsRef<Path>) -> Result<Option<Self>, ProjectError> {
232        if !start.as_ref().exists() {
233            return Ok(None);
234        }
235
236        if start.as_ref().join(PROJECT_TOML).exists() {
237            let project_toml_path = start.as_ref().join(PROJECT_TOML);
238            let toml_content = fs::sync::read_to_string(&project_toml_path)?;
239            let root = start.as_ref();
240
241            let toml = PartialProjectToml::new(
242                &project_toml_path.to_string_lossy(),
243                &toml_content,
244                ProjectRoot(root.to_path_buf()),
245            )?;
246            let mut project = Project {
247                lux_toml_dir: ProjectRoot(root.to_path_buf()),
248                root: toml.project.root.clone(),
249                toml,
250            };
251
252            if let Some(extra_rockspec) = project.extra_rockspec()? {
253                project.toml = project.toml.merge(extra_rockspec);
254            }
255
256            Ok(Some(project))
257        } else {
258            Ok(None)
259        }
260    }
261
262    /// Get the `lux.toml` path.
263    pub fn toml_path(&self) -> PathBuf {
264        self.lux_toml_dir.join(PROJECT_TOML)
265    }
266
267    /// Get the `extra.rockspec` path.
268    pub fn extra_rockspec_path(&self) -> PathBuf {
269        self.lux_toml_dir.join(EXTRA_ROCKSPEC)
270    }
271
272    pub fn root(&self) -> &ProjectRoot {
273        &self.root
274    }
275
276    pub fn toml(&self) -> &PartialProjectToml {
277        &self.toml
278    }
279
280    pub fn local_rockspec(&self) -> Result<LocalLuaRockspec, IntoLocalRockspecError> {
281        self.toml()
282            .into_local()
283            .map_err(|err| IntoLocalRockspecError::LocalProjectTomlValidationError(Box::new(err)))?
284            .to_lua_rockspec()
285            .map_err(|err| IntoLocalRockspecError::RockspecError(Box::new(err)))
286    }
287
288    /// Returns this project's rockspec as a [`RemoteLuaRockspec`] whose source points at the
289    /// project's own directory, so it can be built like any other package.
290    pub fn local_remote_rockspec(&self) -> Result<RemoteLuaRockspec, IntoLocalRockspecError> {
291        self.toml()
292            .into_local()
293            .map_err(|err| IntoLocalRockspecError::LocalProjectTomlValidationError(Box::new(err)))?
294            .to_local_rockspec()
295            .map_err(|err| IntoLocalRockspecError::RockspecError(Box::new(err)))
296    }
297
298    pub fn remote_rockspec(
299        &self,
300        specrev: Option<SpecRev>,
301    ) -> Result<RemoteLuaRockspec, IntoRemoteRockspecError> {
302        self.toml()
303            .into_remote(specrev)
304            .map_err(|err| IntoRemoteRockspecError::RocksTomlValidationError(Box::new(err)))?
305            .to_lua_rockspec()
306            .map_err(|err| IntoRemoteRockspecError::RockspecError(Box::new(err)))
307    }
308
309    pub fn extra_rockspec(&self) -> Result<Option<PartialLuaRockspec>, PartialRockspecError> {
310        if self.extra_rockspec_path().exists() {
311            Ok(Some(PartialLuaRockspec::new(
312                &fs::sync::read_to_string(self.extra_rockspec_path()).map_err(io::Error::other)?,
313            )?))
314        } else {
315            Ok(None)
316        }
317    }
318
319    pub fn lua_version(&self, config: &Config) -> Result<LuaVersion, LuaVersionError> {
320        self.toml().lua_version_matches(config)
321    }
322
323    pub async fn add(
324        &mut self,
325        dependencies: DependencyType<&PackageReq>,
326        package_db: &PackageDB,
327    ) -> Result<(), ProjectEditError> {
328        let mut project_toml =
329            toml_edit::DocumentMut::from_str(&fs::tokio::read_to_string(self.toml_path()).await?)?;
330
331        prepare_dependency_tables(&mut project_toml);
332        let table = match dependencies {
333            DependencyType::Regular(_) => &mut project_toml["dependencies"],
334            DependencyType::Build(_) => &mut project_toml["build_dependencies"],
335            DependencyType::Test(_) => &mut project_toml["test_dependencies"],
336            DependencyType::External(_) => &mut project_toml["external_dependencies"],
337        };
338
339        match dependencies {
340            DependencyType::Regular(ref deps)
341            | DependencyType::Build(ref deps)
342            | DependencyType::Test(ref deps) => {
343                for dep in deps {
344                    let dep_version_str = if dep.version_req().is_any() {
345                        let latest_version =
346                            package_db.latest_version(dep.name()).await.ok_or_else(|| {
347                                ProjectEditError::LatestVersionNotFound(dep.name().clone())
348                            })?;
349                        latest_version
350                            .to_pessimistic_version_req()
351                            .unwrap_or_else(|| latest_version.to_string())
352                    } else {
353                        dep.version_req().to_string()
354                    };
355                    table[dep.name().to_string()] = toml_edit::value(dep_version_str);
356                }
357            }
358            DependencyType::External(ref deps) => {
359                for (name, dep) in deps {
360                    if let Some(path) = &dep.header {
361                        table[name]["header"] = toml_edit::value(path.to_slash_lossy().to_string());
362                    }
363                    if let Some(path) = &dep.library {
364                        table[name]["library"] =
365                            toml_edit::value(path.to_slash_lossy().to_string());
366                    }
367                }
368            }
369        };
370
371        let toml_content = project_toml.to_string();
372        fs::tokio::write(self.toml_path(), &toml_content).await?;
373        self.toml = PartialProjectToml::new(
374            self.toml_path().to_str().unwrap_or("<lux.toml>"),
375            &toml_content,
376            self.lux_toml_dir.clone(),
377        )?;
378
379        Ok(())
380    }
381
382    pub async fn add_git(
383        &mut self,
384        dependencies: LuaDependencyType<&RemoteGitUrlShorthand>,
385        config: &Config,
386    ) -> Result<(), ProjectEditError> {
387        let mut project_toml =
388            toml_edit::DocumentMut::from_str(&fs::tokio::read_to_string(self.toml_path()).await?)?;
389
390        prepare_dependency_tables(&mut project_toml);
391        let table = match dependencies {
392            LuaDependencyType::Regular(_) => &mut project_toml["dependencies"],
393            LuaDependencyType::Build(_) => &mut project_toml["build_dependencies"],
394            LuaDependencyType::Test(_) => &mut project_toml["test_dependencies"],
395        };
396
397        match dependencies {
398            LuaDependencyType::Regular(urls)
399            | LuaDependencyType::Build(urls)
400            | LuaDependencyType::Test(urls) => {
401                for url in urls {
402                    let git_url: RemoteGitUrl = url.clone().into();
403                    let mut dep_entry = toml_edit::table();
404                    match git::utils::latest_semver_tag_or_commit_sha(&git_url, config)? {
405                        SemVerTagOrSha::SemVerTag(tag) => {
406                            dep_entry["git"] = Item::Value(url.to_string().into());
407                            dep_entry["version"] = Item::Value(tag.clone().into());
408                            if tag.contains("-") {
409                                // Tag contains a specrev.
410                                dep_entry["rev"] = Item::Value(tag.into());
411                            }
412                        }
413                        SemVerTagOrSha::CommitSha(sha) => {
414                            dep_entry["git"] = Item::Value(url.to_string().into());
415                            dep_entry["version"] = Item::Value(sha.into());
416                        }
417                    }
418                    table[git_url.repo()] = dep_entry;
419                }
420            }
421        }
422
423        let toml_content = project_toml.to_string();
424        fs::tokio::write(self.toml_path(), &toml_content).await?;
425        self.toml = PartialProjectToml::new(
426            self.toml_path().to_str().unwrap_or("<lux.toml>"),
427            &toml_content,
428            self.lux_toml_dir.clone(),
429        )?;
430
431        Ok(())
432    }
433
434    pub async fn remove(
435        &mut self,
436        dependencies: DependencyType<&PackageName>,
437    ) -> Result<(), ProjectEditError> {
438        let mut project_toml =
439            toml_edit::DocumentMut::from_str(&fs::tokio::read_to_string(self.toml_path()).await?)?;
440
441        prepare_dependency_tables(&mut project_toml);
442        let table = match dependencies {
443            DependencyType::Regular(_) => &mut project_toml["dependencies"],
444            DependencyType::Build(_) => &mut project_toml["build_dependencies"],
445            DependencyType::Test(_) => &mut project_toml["test_dependencies"],
446            DependencyType::External(_) => &mut project_toml["external_dependencies"],
447        };
448
449        match dependencies {
450            DependencyType::Regular(ref deps)
451            | DependencyType::Build(ref deps)
452            | DependencyType::Test(ref deps) => {
453                for dep in deps {
454                    table[dep.to_string()] = Item::None;
455                }
456            }
457            DependencyType::External(ref deps) => {
458                for (name, dep) in deps {
459                    if dep.header.is_some() {
460                        table[name]["header"] = Item::None;
461                    }
462                    if dep.library.is_some() {
463                        table[name]["library"] = Item::None;
464                    }
465                }
466            }
467        };
468
469        let toml_content = project_toml.to_string();
470        fs::tokio::write(self.toml_path(), &toml_content).await?;
471        self.toml = PartialProjectToml::new(
472            self.toml_path().to_str().unwrap_or("<lux.toml>"),
473            &toml_content,
474            self.lux_toml_dir.clone(),
475        )?;
476
477        Ok(())
478    }
479
480    pub async fn upgrade(
481        &mut self,
482        dependencies: LuaDependencyType<&PackageName>,
483        package_db: &PackageDB,
484        config: &Config,
485    ) -> Result<(), ProjectEditError> {
486        let mut project_toml =
487            toml_edit::DocumentMut::from_str(&fs::tokio::read_to_string(self.toml_path()).await?)?;
488
489        prepare_dependency_tables(&mut project_toml);
490        let table = match dependencies {
491            LuaDependencyType::Regular(_) => &mut project_toml["dependencies"],
492            LuaDependencyType::Build(_) => &mut project_toml["build_dependencies"],
493            LuaDependencyType::Test(_) => &mut project_toml["test_dependencies"],
494        };
495
496        match dependencies {
497            LuaDependencyType::Regular(deps)
498            | LuaDependencyType::Build(deps)
499            | LuaDependencyType::Test(deps) => {
500                for dep in deps {
501                    upgrade_dependency(table, dep, package_db, config).await?;
502                }
503            }
504        }
505
506        let toml_content = project_toml.to_string();
507        fs::tokio::write(self.toml_path(), &toml_content).await?;
508        self.toml = PartialProjectToml::new(
509            self.toml_path().to_str().unwrap_or("<lux.toml>"),
510            &toml_content,
511            self.lux_toml_dir.clone(),
512        )?;
513
514        Ok(())
515    }
516
517    pub async fn upgrade_all(
518        &mut self,
519        package_db: &PackageDB,
520        config: &Config,
521    ) -> Result<(), ProjectEditError> {
522        if let Some(dependencies) = &self.toml().dependencies {
523            let packages = dependencies
524                .iter()
525                .map(|dep| dep.name())
526                .cloned()
527                .collect_vec();
528            self.upgrade(
529                LuaDependencyType::Regular(packages.iter().collect()),
530                package_db,
531                config,
532            )
533            .await?;
534        }
535        if let Some(dependencies) = &self.toml().build_dependencies {
536            let packages = dependencies
537                .iter()
538                .map(|dep| dep.name())
539                .cloned()
540                .collect_vec();
541            self.upgrade(
542                LuaDependencyType::Build(packages.iter().collect()),
543                package_db,
544                config,
545            )
546            .await?;
547        }
548        if let Some(dependencies) = &self.toml().test_dependencies {
549            let packages = dependencies
550                .iter()
551                .map(|dep| dep.name())
552                .cloned()
553                .collect_vec();
554            self.upgrade(
555                LuaDependencyType::Test(packages.iter().collect()),
556                package_db,
557                config,
558            )
559            .await?;
560        }
561        Ok(())
562    }
563
564    pub async fn set_pinned_state(
565        &mut self,
566        dependencies: LuaDependencyType<&PackageName>,
567        pin: PinnedState,
568    ) -> Result<(), PinError> {
569        let mut project_toml =
570            toml_edit::DocumentMut::from_str(&fs::tokio::read_to_string(self.toml_path()).await?)
571                .map_err(|source| PinError::ParseTomlEdit {
572                toml_path: self.toml_path().to_slash_lossy().to_string(),
573                source,
574            })?;
575
576        prepare_dependency_tables(&mut project_toml);
577        let table = match dependencies {
578            LuaDependencyType::Regular(_) => &mut project_toml["dependencies"],
579            LuaDependencyType::Build(_) => &mut project_toml["build_dependencies"],
580            LuaDependencyType::Test(_) => &mut project_toml["test_dependencies"],
581        };
582
583        match dependencies {
584            LuaDependencyType::Regular(ref _deps) => {
585                self.toml.dependencies = Some(
586                    self.toml
587                        .dependencies
588                        .take()
589                        .unwrap_or_default()
590                        .into_iter()
591                        .map(|dep| LuaDependencySpec { pin, ..dep })
592                        .collect(),
593                )
594            }
595            LuaDependencyType::Build(ref _deps) => {
596                self.toml.build_dependencies = Some(
597                    self.toml
598                        .build_dependencies
599                        .take()
600                        .unwrap_or_default()
601                        .into_iter()
602                        .map(|dep| LuaDependencySpec { pin, ..dep })
603                        .collect(),
604                )
605            }
606            LuaDependencyType::Test(ref _deps) => {
607                self.toml.test_dependencies = Some(
608                    self.toml
609                        .test_dependencies
610                        .take()
611                        .unwrap_or_default()
612                        .into_iter()
613                        .map(|dep| LuaDependencySpec { pin, ..dep })
614                        .collect(),
615                )
616            }
617        }
618
619        match dependencies {
620            LuaDependencyType::Regular(ref deps)
621            | LuaDependencyType::Build(ref deps)
622            | LuaDependencyType::Test(ref deps) => {
623                for dep in deps {
624                    let mut dep_item = table[dep.to_string()].clone();
625                    match dep_item {
626                        version @ Item::Value(_) => match &pin {
627                            PinnedState::Unpinned => {}
628                            PinnedState::Pinned => {
629                                if let Ok(mut dep_entry) = toml_edit::table().into_table() {
630                                    dep_entry.set_implicit(true);
631                                    dep_entry["version"] = version;
632                                    dep_entry["pin"] = toml_edit::value(true);
633                                    table[dep.to_string()] = toml_edit::Item::Table(dep_entry);
634                                }
635                            }
636                        },
637                        Item::Table(_) => {
638                            dep_item["pin".to_string()] = toml_edit::value(pin.as_bool());
639                            table[dep.to_string()] = dep_item;
640                        }
641                        _ => {}
642                    }
643                }
644            }
645        }
646
647        let toml_content = project_toml.to_string();
648        fs::tokio::write(self.toml_path(), &toml_content).await?;
649        self.toml = PartialProjectToml::new(
650            self.toml_path().to_str().unwrap_or("<lux.toml>"),
651            &toml_content,
652            self.lux_toml_dir.clone(),
653        )?;
654
655        Ok(())
656    }
657
658    pub fn project_files(&self) -> Vec<PathBuf> {
659        project_files(&self.root().0)
660    }
661}
662
663/// Get the files that Lux treats as project files
664/// This respects ignore files and excludes hidden files and directories.
665pub(crate) fn project_files(src: &Path) -> Vec<PathBuf> {
666    ignore::WalkBuilder::new(src)
667        .add(src.join(".cargo"))
668        .follow_links(false)
669        .build()
670        .filter_map(Result::ok)
671        .filter(|entry| entry.file_type().is_some_and(|ft| ft.is_file()))
672        .map(|entry| entry.into_path())
673        .collect_vec()
674}
675
676async fn upgraded_version_req(
677    existing: Option<&str>,
678    dep: &PackageName,
679    package_db: &PackageDB,
680) -> Result<Option<String>, ProjectEditError> {
681    if let Some(existing) = existing.and_then(|existing| PackageVersionReq::parse(existing).ok()) {
682        let latest = package_db
683            .latest_version(dep)
684            .await
685            .ok_or(ProjectEditError::LatestVersionNotFound(dep.clone()))?;
686        Ok(latest.upgrade_version_req(&existing))
687    } else {
688        Ok(None)
689    }
690}
691
692async fn upgrade_dependency(
693    table: &mut Item,
694    dep: &PackageName,
695    package_db: &PackageDB,
696    config: &Config,
697) -> Result<(), ProjectEditError> {
698    let mut dep_item = table[dep.to_string()].clone();
699    match &dep_item {
700        Item::Value(val) => {
701            if let Some(upgraded) = upgraded_version_req(val.as_str(), dep, package_db).await? {
702                table[dep.to_string()] = toml_edit::value(upgraded);
703            }
704        }
705        Item::Table(tbl) => {
706            if let Some(git_item) = tbl.get("git") {
707                let latest = resolve_git_latest(git_url_from_item(git_item)?, config)?;
708                apply_git_latest(table, dep, latest);
709            } else {
710                if let Some(upgraded) = upgraded_version_req(
711                    dep_item.get("version").and_then(Item::as_str),
712                    dep,
713                    package_db,
714                )
715                .await?
716                {
717                    dep_item["version"] = toml_edit::value(upgraded);
718                }
719                table[dep.to_string()] = dep_item;
720            }
721        }
722        _ => {}
723    }
724    Ok(())
725}
726
727fn git_url_from_item(git_item: &Item) -> Result<RemoteGitUrlShorthand, ProjectEditError> {
728    let git_value = git_item
729        .clone()
730        .into_value()
731        .map_err(|err| ProjectEditError::ExpectedValue(Box::new(err)))?;
732    let git_url_str = git_value
733        .as_str()
734        .ok_or(ProjectEditError::ExpectedString(Box::new(
735            git_value.clone(),
736        )))?;
737    Ok(git_url_str.parse()?)
738}
739
740fn resolve_git_latest(
741    url: RemoteGitUrlShorthand,
742    config: &Config,
743) -> Result<SemVerTagOrSha, ProjectEditError> {
744    Ok(git::utils::latest_semver_tag_or_commit_sha(
745        &url.into(),
746        config,
747    )?)
748}
749
750fn apply_git_latest(table: &mut Item, dep: &PackageName, latest: SemVerTagOrSha) {
751    match latest {
752        SemVerTagOrSha::SemVerTag(latest_tag) => {
753            table[dep.to_string()]["version"] = Item::Value(latest_tag.clone().into());
754            if latest_tag.contains("-") {
755                table[dep.to_string()]["rev"] = Item::Value(latest_tag.into());
756            }
757        }
758        SemVerTagOrSha::CommitSha(latest_sha) => {
759            table[dep.to_string()]["version"] = Item::Value(latest_sha.into());
760        }
761    }
762}
763
764fn prepare_dependency_tables(project_toml: &mut DocumentMut) {
765    if !project_toml.contains_table("dependencies") {
766        if let Ok(mut table) = toml_edit::table().into_table() {
767            table.set_implicit(true);
768            project_toml["dependencies"] = toml_edit::Item::Table(table);
769        }
770    }
771    if !project_toml.contains_table("build_dependencies") {
772        if let Ok(mut table) = toml_edit::table().into_table() {
773            table.set_implicit(true);
774            project_toml["build_dependencies"] = toml_edit::Item::Table(table);
775        }
776    }
777    if !project_toml.contains_table("test_dependencies") {
778        if let Ok(mut table) = toml_edit::table().into_table() {
779            table.set_implicit(true);
780            project_toml["test_dependencies"] = toml_edit::Item::Table(table);
781        }
782    }
783    if !project_toml.contains_table("external_dependencies") {
784        if let Ok(mut table) = toml_edit::table().into_table() {
785            table.set_implicit(true);
786            project_toml["external_dependencies"] = toml_edit::Item::Table(table);
787        }
788    }
789}
790
791// TODO: More project-based test
792#[cfg(test)]
793mod tests {
794    use std::collections::HashMap;
795
796    use assert_fs::prelude::{PathChild, PathCopy, PathCreateDir};
797    use url::Url;
798
799    use super::*;
800    use crate::{
801        config::ConfigBuilder,
802        fs,
803        lua_rockspec::ExternalDependencySpec,
804        manifest::{Manifest, ManifestMetadata},
805        package::PackageReq,
806        package_db::PackageDB,
807        rockspec::Rockspec,
808    };
809
810    #[tokio::test]
811    async fn test_add_various_dependencies() {
812        let sample_project = PathBuf::from(env!("CARGO_MANIFEST_DIR"))
813            .join("resources/test/sample-projects/no-build-spec/");
814        let project_root = assert_fs::TempDir::new().unwrap();
815        project_root.copy_from(&sample_project, &["**"]).unwrap();
816        let project_root: PathBuf = project_root.path().into();
817        let mut project = Project::from_exact(&project_root).unwrap().unwrap();
818        let add_dependencies = [PackageReq::new("busted".into(), Some(">= 1.0.0".into())).unwrap()];
819        let expected_dependencies = vec![PackageReq::new("busted".into(), Some(">= 1.0.0".into()))
820            .unwrap()
821            .into()];
822
823        let test_manifest_path =
824            PathBuf::from(env!("CARGO_MANIFEST_DIR")).join("resources/test/manifest-5.1");
825        let content = String::from_utf8(std::fs::read(&test_manifest_path).unwrap()).unwrap();
826        let metadata = ManifestMetadata::new(&content).unwrap();
827        let config = ConfigBuilder::new().unwrap().build().unwrap();
828        let package_db = PackageDB::from_manifest(
829            Manifest::new(
830                Url::parse("https://example.com").unwrap(),
831                metadata,
832                Default::default(),
833            ),
834            &config,
835        );
836
837        project
838            .add(
839                DependencyType::Regular(add_dependencies.iter().collect_vec()),
840                &package_db,
841            )
842            .await
843            .unwrap();
844
845        project
846            .add(
847                DependencyType::Build(add_dependencies.iter().collect_vec()),
848                &package_db,
849            )
850            .await
851            .unwrap();
852        project
853            .add(
854                DependencyType::Test(add_dependencies.iter().collect_vec()),
855                &package_db,
856            )
857            .await
858            .unwrap();
859
860        project
861            .add(
862                DependencyType::External(HashMap::from([(
863                    "lib".into(),
864                    ExternalDependencySpec {
865                        library: Some("path.so".into()),
866                        header: None,
867                    },
868                )])),
869                &package_db,
870            )
871            .await
872            .unwrap();
873
874        // Reparse the lux.toml (not usually necessary, but we want to test that the file was
875        // written correctly)
876        let project = Project::from_exact(&project_root).unwrap().unwrap();
877        let validated_toml = project.toml().into_remote(None).unwrap();
878
879        assert_eq!(
880            validated_toml.dependencies().current_platform(),
881            &expected_dependencies
882        );
883        assert_eq!(
884            validated_toml.build_dependencies().current_platform(),
885            &expected_dependencies
886        );
887        assert_eq!(
888            validated_toml.test_dependencies().current_platform(),
889            &expected_dependencies
890        );
891        assert_eq!(
892            validated_toml
893                .external_dependencies()
894                .current_platform()
895                .get("lib")
896                .unwrap(),
897            &ExternalDependencySpec {
898                library: Some("path.so".into()),
899                header: None
900            }
901        );
902    }
903
904    #[tokio::test]
905    async fn test_add_unpublished_package_does_not_edit_toml() {
906        let sample_project = PathBuf::from(env!("CARGO_MANIFEST_DIR"))
907            .join("resources/test/sample-projects/no-build-spec/");
908        let project_root = assert_fs::TempDir::new().unwrap();
909        project_root.copy_from(&sample_project, &["**"]).unwrap();
910        let project_root: PathBuf = project_root.path().into();
911        let mut project = Project::from_exact(&project_root).unwrap().unwrap();
912        let toml_before = fs::sync::read_to_string(project.toml_path()).unwrap();
913
914        let test_manifest_path =
915            PathBuf::from(env!("CARGO_MANIFEST_DIR")).join("resources/test/manifest-5.1");
916        let content = String::from_utf8(std::fs::read(&test_manifest_path).unwrap()).unwrap();
917        let metadata = ManifestMetadata::new(&content).unwrap();
918        let config = ConfigBuilder::new().unwrap().build().unwrap();
919        let package_db = PackageDB::from_manifest(
920            Manifest::new(
921                Url::parse("https://example.com").unwrap(),
922                metadata,
923                Default::default(),
924            ),
925            &config,
926        );
927
928        let unknown_dependencies = [PackageReq::from_str("not-a-package-in-any-manifest").unwrap()];
929        let err = project
930            .add(
931                DependencyType::Regular(unknown_dependencies.iter().collect_vec()),
932                &package_db,
933            )
934            .await
935            .unwrap_err();
936
937        assert!(matches!(err, ProjectEditError::LatestVersionNotFound(_)));
938        assert_eq!(
939            fs::sync::read_to_string(project.toml_path()).unwrap(),
940            toml_before
941        );
942    }
943
944    #[tokio::test]
945    async fn test_upgrade_preserves_version_req_style() {
946        let sample_project = PathBuf::from(env!("CARGO_MANIFEST_DIR"))
947            .join("resources/test/sample-projects/no-build-spec/");
948        let project_root = assert_fs::TempDir::new().unwrap();
949        project_root.copy_from(&sample_project, &["**"]).unwrap();
950        let project_root: PathBuf = project_root.path().into();
951        let toml_path = project_root.join("lux.toml");
952
953        let test_manifest_path =
954            PathBuf::from(env!("CARGO_MANIFEST_DIR")).join("resources/test/manifest-5.1");
955        let content = String::from_utf8(std::fs::read(&test_manifest_path).unwrap()).unwrap();
956        let metadata = ManifestMetadata::new(&content).unwrap();
957        let config = ConfigBuilder::default().build().unwrap();
958        let package_db = PackageDB::from_manifest(
959            Manifest::new(
960                Url::parse("https://example.com").unwrap(),
961                metadata,
962                Default::default(),
963            ),
964            &config,
965        );
966
967        let base = r#"package = "sample-project-no-build-spec"
968version = "0.1.0"
969lua = ">=5.1"
970
971[source]
972url = "https://github.com/lumen-oss/luarocks-stub"
973
974[build]
975type = "builtin"
976"#;
977        for (input, expected) in [
978            ("30log = \"~> 1.0\"", "30log = \"~> 1.3\""),
979            ("30log = \"~> 1\"", "30log = \"~> 1\""),
980            ("30log = \">= 1.0.0\"", "30log = \">= 1.0.0\""),
981            ("30log = \"1.0.0\"", "30log = \"1.3.0\""),
982        ] {
983            std::fs::write(&toml_path, format!("{base}\n[dependencies]\n{input}\n")).unwrap();
984            let mut project = Project::from_exact(&project_root).unwrap().unwrap();
985            let packages = [PackageName::from("30log")];
986            project
987                .upgrade(
988                    LuaDependencyType::Regular(packages.iter().collect()),
989                    &package_db,
990                    &config,
991                )
992                .await
993                .unwrap();
994            let rewritten = std::fs::read_to_string(&toml_path).unwrap();
995            assert!(rewritten.contains(expected), "input {input}: {rewritten}");
996        }
997    }
998
999    #[tokio::test]
1000    async fn test_remove_dependencies() {
1001        let sample_project = PathBuf::from(env!("CARGO_MANIFEST_DIR"))
1002            .join("resources/test/sample-projects/dependencies/");
1003        let project_root = assert_fs::TempDir::new().unwrap();
1004        project_root.copy_from(&sample_project, &["**"]).unwrap();
1005        let project_root: PathBuf = project_root.path().into();
1006        let mut project = Project::from_exact(&project_root).unwrap().unwrap();
1007        let lua_cjson = "lua-cjson".into();
1008        let plenary_nvim = "plenary.nvim".into();
1009        let remove_dependencies = vec![&lua_cjson, &plenary_nvim];
1010        project
1011            .remove(DependencyType::Regular(remove_dependencies.clone()))
1012            .await
1013            .unwrap();
1014        let check = |project: &Project| {
1015            for name in &remove_dependencies {
1016                assert!(!project
1017                    .toml()
1018                    .dependencies
1019                    .clone()
1020                    .unwrap_or_default()
1021                    .iter()
1022                    .any(|dep| &dep.name() == name));
1023            }
1024        };
1025        check(&project);
1026        // check again after reloading lux.toml
1027        let reloaded_project = Project::from_exact(&project_root).unwrap().unwrap();
1028        check(&reloaded_project);
1029    }
1030
1031    #[tokio::test]
1032    async fn test_extra_rockspec_parsing() {
1033        let sample_project = PathBuf::from(env!("CARGO_MANIFEST_DIR"))
1034            .join("resources/test/sample-projects/extra-rockspec/");
1035        let project_root = assert_fs::TempDir::new().unwrap();
1036        project_root.copy_from(&sample_project, &["**"]).unwrap();
1037        let project_root: PathBuf = project_root.path().into();
1038        let project = Project::from_exact(project_root).unwrap().unwrap();
1039
1040        let extra_rockspec = project.extra_rockspec().unwrap();
1041
1042        assert!(extra_rockspec.is_some());
1043
1044        let rocks = project.toml().into_remote(None).unwrap();
1045
1046        assert_eq!(rocks.package().to_string(), "custom-package");
1047    }
1048
1049    #[tokio::test]
1050    async fn test_pin_dependencies() {
1051        test_pin_unpin_dependencies(PinnedState::Pinned).await
1052    }
1053
1054    #[tokio::test]
1055    async fn test_unpin_dependencies() {
1056        test_pin_unpin_dependencies(PinnedState::Unpinned).await
1057    }
1058
1059    async fn test_pin_unpin_dependencies(pin: PinnedState) {
1060        let sample_project = PathBuf::from(env!("CARGO_MANIFEST_DIR"))
1061            .join("resources/test/sample-projects/dependencies/");
1062        let project_root = assert_fs::TempDir::new().unwrap();
1063        project_root.copy_from(&sample_project, &["**"]).unwrap();
1064        let project_root: PathBuf = project_root.path().into();
1065        let mut project = Project::from_exact(&project_root).unwrap().unwrap();
1066        let lua_cjson = "lua-cjson".into();
1067        let plenary_nvim = "plenary.nvim".into();
1068        let pin_dependencies = vec![&lua_cjson, &plenary_nvim];
1069        project
1070            .set_pinned_state(LuaDependencyType::Regular(pin_dependencies.clone()), pin)
1071            .await
1072            .unwrap();
1073        let check = |project: &Project| {
1074            for name in &pin_dependencies {
1075                assert!(project
1076                    .toml()
1077                    .dependencies
1078                    .clone()
1079                    .unwrap_or_default()
1080                    .iter()
1081                    .any(|dep| &dep.name() == name && dep.pin == pin));
1082            }
1083        };
1084        check(&project);
1085        // check again after reloading lux.toml
1086        let reloaded_project = Project::from_exact(&project_root).unwrap().unwrap();
1087        check(&reloaded_project);
1088    }
1089
1090    #[tokio::test]
1091    async fn project_files_includes_cargo_directory() {
1092        let project_root = assert_fs::TempDir::new().unwrap();
1093        let cargo_dir = project_root.child(".cargo");
1094        cargo_dir.create_dir_all().unwrap();
1095        let cargo_config = cargo_dir.join("config.toml");
1096        fs::tokio::write(&cargo_config, "").await.unwrap();
1097        let project_files = project_files(&project_root);
1098        assert!(project_files.contains(&cargo_config.to_path_buf()));
1099    }
1100
1101    #[tokio::test]
1102    async fn project_root_dir_override() {
1103        let root_dir = assert_fs::TempDir::new().unwrap();
1104        let lux_toml_dir = root_dir.child("proj");
1105        lux_toml_dir.create_dir_all().unwrap();
1106        fs::tokio::write(
1107            lux_toml_dir.join(PROJECT_TOML),
1108            r#"
1109            package = "my-package"
1110            version = "1.0.0"
1111            lua = "5.1"
1112
1113            [project]
1114            root_dir = ".."
1115
1116            [build]
1117            type = "builtin"
1118            "#,
1119        )
1120        .await
1121        .unwrap();
1122        let project = Project::from_exact(lux_toml_dir.path()).unwrap().unwrap();
1123        assert_eq!(
1124            std::fs::canonicalize(project.root()).unwrap(),
1125            std::fs::canonicalize(root_dir.path()).unwrap()
1126        );
1127        // The `lux.toml` path must still point to the directory containing the `lux.toml`.
1128        assert_eq!(project.toml_path(), lux_toml_dir.join(PROJECT_TOML));
1129    }
1130
1131    #[tokio::test]
1132    async fn from_exact_on_nonexistent_directory() {
1133        let empty_dir = assert_fs::TempDir::new().unwrap();
1134        assert!(Project::from_exact(&empty_dir).unwrap().is_none());
1135    }
1136}
lux_lib/project/mod.rs

lux_lib/project/
mod.rs
