alef 0.59.0

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
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

//! Tests for `[[crates]] crate_attributes` — per-crate custom inner attribute
//! injection (`#![...]`) into every generated Rust `lib.rs` for that crate, across
//! every Rust-emitting backend (ffi, jni, node, python, php, wasm, ruby, elixir, R,
//! swift, dart).
//!
//! Mirrors `tests/workspace_extra_clippy_allows_test.rs`, scoped one level down:
//! `extra_clippy_allows` is a workspace-wide default: `crate_attributes` is set
//! per `[[crates]]` entry.

use alef::backends::ffi::FfiBackend;
use alef::backends::jni::JniBackend;
use alef::backends::napi::NapiBackend;
use alef::core::backend::Backend;
use alef::core::config::{NewAlefConfig, ResolvedCrateConfig};
use alef::core::ir::ApiSurface;

// ---------------------------------------------------------------------------

/// Build a single resolved crate from an inline `alef.toml`. `languages` is the
/// raw (already-quoted) contents of the `[workspace] languages` array, e.g.
/// `r#""ffi""#`. `crate_body` is appended verbatim inside the `[[crates]]` entry
/// (and may include trailing `[crates.*]` sub-tables).
fn make_config(languages: &str, crate_body: &str) -> ResolvedCrateConfig {
    let toml_src = format!(
        r#"
[workspace]
languages = [{languages}]

[[crates]]
name = "test-lib"
sources = ["src/lib.rs"]
{crate_body}
"#
    );
    let cfg: NewAlefConfig = toml::from_str(&toml_src).expect("config parses");
    cfg.resolve().expect("config resolves").remove(0)
}

fn try_resolve(languages: &str, crate_body: &str) -> Result<ResolvedCrateConfig, alef::core::config::ResolveError> {
    let toml_src = format!(
        r#"
[workspace]
languages = [{languages}]

[[crates]]
name = "test-lib"
sources = ["src/lib.rs"]
{crate_body}
"#
    );
    let cfg: NewAlefConfig = toml::from_str(&toml_src).expect("config parses");
    cfg.resolve().map(|mut v| v.remove(0))
}

fn empty_api() -> ApiSurface {
    ApiSurface {
        crate_name: "test_lib".to_string(),
        version: "0.1.0".to_string(),
        ..ApiSurface::default()
    }
}

fn lib_rs_content(files: &[alef::core::backend::GeneratedFile]) -> &str {
    &files
        .iter()
        .find(|f| f.path.to_string_lossy().ends_with("lib.rs"))
        .expect("lib.rs present")
        .content
}

// ---------------------------------------------------------------------------
// Config parsing / defaulting
// ---------------------------------------------------------------------------

#[test]
fn crate_config_parses_crate_attributes_in_configured_order() {
    let cfg = make_config(
        r#""ffi""#,
        r#"crate_attributes = ["recursion_limit = \"256\"", "feature(async_closure)"]"#,
    );
    assert_eq!(
        cfg.crate_attributes,
        vec![
            "recursion_limit = \"256\"".to_string(),
            "feature(async_closure)".to_string()
        ]
    );
}

#[test]
fn crate_attributes_defaults_to_empty() {
    let cfg = make_config(r#""ffi""#, "");
    assert!(cfg.crate_attributes.is_empty());
}

// ---------------------------------------------------------------------------
// format_crate_attributes
// ---------------------------------------------------------------------------

#[test]
fn format_crate_attributes_returns_empty_vec_when_unset() {
    let result = alef::codegen::shared::format_crate_attributes(&[]);
    assert!(result.is_empty(), "empty input must format to no attributes");
}

#[test]
fn format_crate_attributes_preserves_configured_order() {
    let attrs = vec![
        "recursion_limit = \"256\"".to_string(),
        "feature(async_closure)".to_string(),
    ];
    let result = alef::codegen::shared::format_crate_attributes(&attrs);
    assert_eq!(
        result,
        vec![
            "recursion_limit = \"256\"".to_string(),
            "feature(async_closure)".to_string()
        ],
        "entries must not be merged or reordered, unlike format_extra_clippy_allows"
    );
}

// ---------------------------------------------------------------------------
// ffi backend (previously unwired — no extras hook of any kind)
// ---------------------------------------------------------------------------

#[test]
fn ffi_backend_emits_crate_attribute_before_any_item() {
    let cfg = make_config(r#""ffi""#, r#"crate_attributes = ["recursion_limit = \"256\""]"#);
    let api = empty_api();
    let files = FfiBackend.generate_bindings(&api, &cfg).expect("ffi generates");
    let content = lib_rs_content(&files);

    assert!(
        content.contains("#![recursion_limit = \"256\"]\n"),
        "expected the exact inner attribute line, got:\n{content}"
    );

    let attr_pos = content
        .find("#![recursion_limit = \"256\"]")
        .expect("attribute present");
    let first_use_pos = content.find("use ").expect("a use import exists");
    assert!(
        attr_pos < first_use_pos,
        "inner attribute must precede every use/item (rustc E0753 otherwise)"
    );
}

#[test]
fn ffi_backend_emits_multiple_crate_attributes_in_order() {
    let cfg = make_config(
        r#""ffi""#,
        r#"crate_attributes = ["recursion_limit = \"256\"", "feature(async_closure)"]"#,
    );
    let api = empty_api();
    let files = FfiBackend.generate_bindings(&api, &cfg).expect("ffi generates");
    let content = lib_rs_content(&files);

    let recursion_pos = content
        .find("#![recursion_limit = \"256\"]")
        .expect("recursion_limit attribute present");
    let feature_pos = content
        .find("#![feature(async_closure)]")
        .expect("feature attribute present");
    assert!(
        recursion_pos < feature_pos,
        "attributes must appear in configured order"
    );
}

#[test]
fn ffi_backend_no_crate_attribute_when_unset() {
    let cfg = make_config(r#""ffi""#, "");
    let api = empty_api();
    let files = FfiBackend.generate_bindings(&api, &cfg).expect("ffi generates");
    let content = lib_rs_content(&files);

    assert!(
        !content.contains("recursion_limit"),
        "no-config baseline must be byte-identical to output with no crate_attributes set"
    );
}

// ---------------------------------------------------------------------------
// jni backend (previously unwired — Jinja-template splice path)
// ---------------------------------------------------------------------------

#[test]
fn jni_backend_emits_crate_attribute() {
    let cfg = make_config(
        r#""kotlin_android", "jni""#,
        "crate_attributes = [\"recursion_limit = \\\"256\\\"\"]\n\n[crates.kotlin_android]\n",
    );
    let api = empty_api();
    let files = JniBackend.generate_bindings(&api, &cfg).expect("jni generates");
    let content = lib_rs_content(&files);

    assert!(
        content.contains("#![recursion_limit = \"256\"]\n"),
        "expected the exact inner attribute line, got:\n{content}"
    );
    let attr_pos = content
        .find("#![recursion_limit = \"256\"]")
        .expect("attribute present");
    let use_pos = content.find("use ").expect("a use import exists");
    assert!(attr_pos < use_pos, "inner attribute must precede every use/item");
}

#[test]
fn jni_backend_no_crate_attribute_when_unset() {
    let cfg = make_config(r#""kotlin_android", "jni""#, "\n[crates.kotlin_android]\n");
    let api = empty_api();
    let files = JniBackend.generate_bindings(&api, &cfg).expect("jni generates");
    let content = lib_rs_content(&files);

    assert!(
        !content.contains("recursion_limit"),
        "no-config baseline must be byte-identical to output with no crate_attributes set"
    );
}

// ---------------------------------------------------------------------------
// Composability with extra_clippy_allows (workspace-level, pre-existing knob)
// ---------------------------------------------------------------------------

#[test]
fn napi_backend_composes_crate_attributes_with_extra_clippy_allows() {
    let toml_src = r#"
[workspace]
languages = ["node"]
extra_clippy_allows = ["single_match"]

[[crates]]
name = "test-lib"
sources = ["src/lib.rs"]
crate_attributes = ["recursion_limit = \"256\""]
"#;
    let cfg: NewAlefConfig = toml::from_str(toml_src).expect("config parses");
    let resolved = cfg.resolve().expect("config resolves").remove(0);
    let api = empty_api();
    let files = NapiBackend.generate_bindings(&api, &resolved).expect("napi generates");
    let content = lib_rs_content(&files);

    assert!(
        content.contains("#![allow(clippy::single_match)]\n"),
        "extra_clippy_allows attribute must still be emitted, got:\n{content}"
    );
    assert!(
        content.contains("#![recursion_limit = \"256\"]\n"),
        "crate_attributes attribute must be emitted, got:\n{content}"
    );

    let clippy_pos = content.find("#![allow(clippy::single_match)]").unwrap();
    let recursion_pos = content.find("#![recursion_limit").unwrap();
    assert!(
        clippy_pos < recursion_pos,
        "extra_clippy_allows must be spliced before crate_attributes, neither clobbering the other"
    );
}

// ---------------------------------------------------------------------------
// Malformed entries are rejected loudly at config-resolve time
// ---------------------------------------------------------------------------

#[test]
fn malformed_crate_attribute_full_syntax_wrapper_is_rejected() {
    // Not a raw string: the TOML entry embeds `"#` (from `#![...]`), which would
    // prematurely close an `r#"..."#` raw-string literal.
    let crate_body = "crate_attributes = [\"#![recursion_limit = \\\"256\\\"]\"]";
    let err = try_resolve(r#""ffi""#, crate_body).expect_err("full #![...] syntax must be rejected");
    assert!(
        err.to_string().contains("must not include the `#![...]` wrapper"),
        "unexpected error message: {err}"
    );
}

#[test]
fn malformed_crate_attribute_empty_string_is_rejected() {
    let err = try_resolve(r#""ffi""#, r#"crate_attributes = [""]"#).expect_err("empty entry must be rejected");
    assert!(
        err.to_string().contains("empty or whitespace-only"),
        "unexpected error message: {err}"
    );
}

#[test]
fn malformed_crate_attribute_invalid_path_is_rejected() {
    let err = try_resolve(r#""ffi""#, r#"crate_attributes = ["not a real lint; evil"]"#)
        .expect_err("garbage attribute body must be rejected");
    assert!(
        err.to_string().contains("is malformed"),
        "unexpected error message: {err}"
    );
}

#[test]
fn malformed_crate_attribute_multiline_is_rejected() {
    let err = try_resolve(
        r#""ffi""#,
        "crate_attributes = [\"recursion_limit = \\\"256\\\"\\nfeature(x)\"]",
    )
    .expect_err("multi-line entry must be rejected");
    assert!(
        err.to_string().contains("must not contain a newline"),
        "unexpected error message: {err}"
    );
}

#[test]
fn well_formed_crate_attribute_with_nested_call_syntax_is_accepted() {
    let cfg = make_config(r#""ffi""#, r#"crate_attributes = ["feature(async_closure)"]"#);
    assert_eq!(cfg.crate_attributes, vec!["feature(async_closure)".to_string()]);
}