alef 0.25.39

Opinionated polyglot binding generator for Rust libraries
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

//! Dart pub.dev package — archives the Flutter Rust Bridge source tree for distribution.

use super::PackageArtifact;
use super::util::{copy_dir_recursive, copy_optional_file};
use crate::core::config::ResolvedCrateConfig;
use crate::publish::dart_native::stage_dart_native_libraries;
use anyhow::{Context, Result};
use std::fs;
use std::path::Path;

/// Package Dart bindings into a source tarball suitable for pub.dev.
///
/// Produces: `{pubspec_name}-{version}.tar.gz` containing:
/// - `pubspec.yaml` — copied from `packages/dart/pubspec.yaml`
/// - `lib/` — Dart wrappers (including `lib/src/` for FRB bridge code)
/// - `lib/src/native/{rid}/` — prebuilt native libraries (if available)
/// - `rust/` — Rust-side FRB crate
/// - `README.md`, `CHANGELOG.md`, `LICENSE` if present in workspace root
///
/// Note: this is a source archive for archival and review. Actual pub.dev uploads
/// are performed by `dart pub publish` from the package directory, which enforces
/// the pub.dev package layout itself.
pub fn package_dart(
    config: &ResolvedCrateConfig,
    workspace_root: &Path,
    output_dir: &Path,
    version: &str,
) -> Result<PackageArtifact> {
    let pubspec_name = config.dart_pubspec_name();
    let pkg_dir = config.package_dir(crate::core::config::extras::Language::Dart);

    let pkg_name = format!("{pubspec_name}-{version}");
    let staging = output_dir.join(&pkg_name);

    if staging.exists() {
        fs::remove_dir_all(&staging)?;
    }
    fs::create_dir_all(&staging)?;

    // Copy the full dart package directory into staging.
    let pkg_src = workspace_root.join(&pkg_dir);
    if !pkg_src.exists() {
        anyhow::bail!("Dart package directory not found: {}", pkg_dir);
    }
    copy_dir_recursive(&pkg_src, &staging).context("copying Dart package directory")?;

    // Stage prebuilt native libraries if available.
    // This allows published packages to work without requiring consumers to build Rust code.
    let lib_stem = format!("{}_dart", pubspec_name.replace('-', "_"));
    stage_dart_native_libraries(workspace_root, &staging, &lib_stem)
        .context("staging native libraries for Dart package")?;

    // Copy optional top-level docs into the staging root.
    for filename in ["README.md", "CHANGELOG.md", "LICENSE"] {
        copy_optional_file(workspace_root, filename, &staging)
            .with_context(|| format!("staging {filename} for Dart package"))?;
    }

    // Create tarball.
    let archive_name = format!("{pkg_name}.tar.gz");
    let archive_path = output_dir.join(&archive_name);
    super::create_tar_gz(&staging, &archive_path)?;

    // Clean up staging.
    fs::remove_dir_all(&staging).ok();

    Ok(PackageArtifact {
        path: archive_path,
        name: archive_name,
        checksum: None,
    })
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::core::config::{NewAlefConfig, ResolvedCrateConfig};
    use std::fs;

    fn minimal_config(name: &str) -> ResolvedCrateConfig {
        let toml = format!(
            r#"
[workspace]
languages = ["dart"]
[[crates]]
name = "{name}"
sources = []
"#
        );
        let cfg: NewAlefConfig = toml::from_str(&toml).expect("valid config");
        cfg.resolve().unwrap().remove(0)
    }

    #[test]
    fn package_dart_errors_when_pkg_dir_missing() {
        let config = minimal_config("my-lib");
        let tmp = tempfile::tempdir().expect("tempdir");
        let output = tmp.path().join("out");
        fs::create_dir_all(&output).unwrap();

        let err = package_dart(&config, tmp.path(), &output, "0.1.0").unwrap_err();
        assert!(
            err.to_string().contains("Dart package directory not found"),
            "unexpected error: {err}"
        );
    }

    #[test]
    fn package_dart_produces_tarball() {
        let config = minimal_config("my-lib");
        let tmp = tempfile::tempdir().expect("tempdir");

        // Create a minimal packages/dart/ tree.
        let dart_pkg = tmp.path().join("packages/dart");
        fs::create_dir_all(dart_pkg.join("lib/src")).unwrap();
        fs::write(dart_pkg.join("pubspec.yaml"), "name: my_lib\nversion: 0.1.0\n").unwrap();
        fs::write(dart_pkg.join("lib/my_lib.dart"), "// generated\n").unwrap();
        fs::write(dart_pkg.join("lib/src/bridge.dart"), "// bridge\n").unwrap();

        let output = tmp.path().join("out");
        fs::create_dir_all(&output).unwrap();

        let artifact = package_dart(&config, tmp.path(), &output, "0.1.0").unwrap();
        assert!(artifact.path.exists(), "tarball should exist");
        assert_eq!(artifact.name, "my_lib-0.1.0.tar.gz");
    }
}