flutter_rust_bridge_codegen 2.12.0

Flutter/Dart <-> Rust binding generator, feature-rich, but seamless and simple
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

use crate::binary::commands::{GenerateCommandArgs, GenerateCommandArgsPrimary};
use anyhow::{Context, Result};
use lib_flutter_rust_bridge_codegen::codegen::{Config, MetaConfig, RustOpaqueCodecMode};

pub(crate) fn compute_codegen_config(args: GenerateCommandArgsPrimary) -> Result<Config> {
    let config_from_file = if let Some(config_file) = &args.config_file {
        Config::from_config_file(config_file)?.context("Cannot find config_file")?
    } else {
        Config::from_files_auto_option()?.unwrap_or_default()
    };

    let config_from_args = compute_codegen_config_from_naive_command_args(args);

    Ok(Config::merge(config_from_args, config_from_file))
}

pub(crate) fn compute_codegen_meta_config(args: &GenerateCommandArgs) -> MetaConfig {
    MetaConfig { watch: args.watch }
}

fn compute_codegen_config_from_naive_command_args(args: GenerateCommandArgsPrimary) -> Config {
    fn positive_bool_arg(x: bool) -> Option<bool> {
        x.then_some(true)
    }

    // arg like "no_something"
    fn negative_bool_arg(x: bool) -> Option<bool> {
        x.then_some(false)
    }

    Config {
        base_dir: None,
        rust_input: args.rust_input,
        dart_output: args.dart_output,
        c_output: args.c_output,
        duplicated_c_output: args.duplicated_c_output,
        rust_root: args.rust_root,
        rust_output: args.rust_output,
        dart_entrypoint_class_name: args.dart_entrypoint_class_name,
        dart_format_line_length: args.dart_format_line_length,
        dart_preamble: args.dart_preamble,
        rust_preamble: args.rust_preamble,
        dart_enums_style: negative_bool_arg(args.no_dart_enums_style),
        add_mod_to_lib: negative_bool_arg(args.no_add_mod_to_lib),
        llvm_path: args.llvm_path,
        llvm_compiler_opts: args.llvm_compiler_opts,
        dart_root: args.dart_root,
        build_runner: negative_bool_arg(args.no_build_runner),
        extra_headers: args.extra_headers,
        web: negative_bool_arg(args.no_web),
        deps_check: negative_bool_arg(args.no_deps_check),
        dart3: negative_bool_arg(args.no_dart3),
        full_dep: positive_bool_arg(args.full_dep),
        default_rust_opaque_codec: args
            .default_rust_opaque_codec
            .map(RustOpaqueCodecMode::from),
        local: positive_bool_arg(args.local),
        default_external_library_loader_web_prefix: args.default_external_library_loader_web_prefix,
        wasm_bindgen_name: args.wasm_bindgen_name,
        dart_type_rename: None, // complex type, not supported on command line yet
        enable_lifetime: positive_bool_arg(args.enable_lifetime),
        type_64bit_int: positive_bool_arg(args.type_64bit_int),
        default_dart_async: negative_bool_arg(args.no_default_dart_async),
        auto_upgrade_dependency: negative_bool_arg(args.no_auto_upgrade_dependency),
        parse_const: positive_bool_arg(args.parse_const),
        dart_format: negative_bool_arg(args.no_dart_format),
        dart_fix: negative_bool_arg(args.no_dart_fix),
        rust_format: negative_bool_arg(args.no_rust_format),
        stop_on_error: positive_bool_arg(args.stop_on_error),
        dump: args.dump,
        dump_all: positive_bool_arg(args.dump_all),
        rust_features: args.rust_features,
    }
}

#[cfg(test)]
mod tests {
    use crate::binary::commands::{Cli, Commands};
    use crate::binary::commands_parser::compute_codegen_config;
    use crate::binary::test_utils::set_cwd_test_fixture;
    use clap::Parser;
    use itertools::concat;
    use lib_flutter_rust_bridge_codegen::utils::logs::configure_opinionated_test_logging;
    use lib_flutter_rust_bridge_codegen::{codegen, if_then_some};
    use serial_test::serial;

    // need to run serially, otherwise working directory will override each other
    #[test]
    #[serial]
    fn test_compute_codegen_config_mode_from_files_auto_flutter_rust_bridge_yaml(
    ) -> anyhow::Result<()> {
        configure_opinionated_test_logging();
        set_cwd_test_fixture("binary/commands_parser/flutter_rust_bridge_yaml")?;

        let config = run_command_line(vec!["", "generate"])?;
        assert_eq!(config.rust_input.unwrap(), "crate::hello".to_string());
        assert!(!config.dart3.unwrap());

        Ok(())
    }

    #[test]
    #[serial]
    fn test_compute_codegen_config_mode_from_files_auto_pubspec_yaml() -> anyhow::Result<()> {
        configure_opinionated_test_logging();
        set_cwd_test_fixture("binary/commands_parser/pubspec_yaml")?;

        let config = run_command_line(vec!["", "generate"])?;
        assert_eq!(config.rust_input.unwrap(), "crate::hello".to_string());
        assert!(!config.dart3.unwrap());

        Ok(())
    }

    #[test]
    #[serial]
    fn test_compute_codegen_config_mode_from_files_auto_pubspec_yaml_faulty() -> anyhow::Result<()>
    {
        configure_opinionated_test_logging();
        set_cwd_test_fixture("binary/commands_parser/faulty_pubspec_yaml")?;

        let result = run_command_line(vec!["", "generate"]);
        assert!(result.is_err());
        assert!(result
            .unwrap_err()
            .source()
            .unwrap()
            .to_string()
            .contains("misspelled_dart3"));

        Ok(())
    }

    #[test]
    #[serial]
    fn test_compute_codegen_config_mode_config_file() -> anyhow::Result<()> {
        configure_opinionated_test_logging();
        set_cwd_test_fixture("binary/commands_parser/config_file")?;

        let config = run_command_line(vec!["", "generate", "--config-file", "hello.yaml"])?;
        assert_eq!(config.rust_input.unwrap(), "crate::hello".to_string());
        assert!(!config.dart3.unwrap());

        Ok(())
    }

    #[test]
    #[serial]
    fn test_compute_codegen_config_mode_config_file_faulty_file() -> anyhow::Result<()> {
        configure_opinionated_test_logging();
        set_cwd_test_fixture("binary/commands_parser/flutter_rust_bridge_yaml")?;
        let result = run_command_line(vec![
            "",
            "generate",
            "--config-file",
            "faulty_flutter_rust_bridge.yaml",
        ]);
        assert!(result.is_err());
        assert!(result
            .unwrap_err()
            .source()
            .unwrap()
            .to_string()
            .contains("misspelled_dart3"));
        Ok(())
    }

    #[test]
    #[serial]
    fn test_compute_codegen_config_mode_from_naive_generate_command_args() {
        configure_opinionated_test_logging();
        set_cwd_test_fixture("binary/commands_parser").unwrap(); // use whatever folder without config file

        // bool flags
        let common_args = vec![
            "",
            "generate",
            "--rust-input",
            "crate::hello",
            "--dart-output",
            "hello.dart",
            "--c-output",
            "hello.h",
        ];
        let config = run_command_line(common_args.clone()).expect("failed to parse cli args");
        assert_eq!(config.dart3, None);
        assert_eq!(config.rust_input.unwrap(), "crate::hello".to_string());
        assert_eq!(
            run_command_line(concat([common_args.clone(), vec!["--no-dart3"]]))
                .expect("failed to parse cli args")
                .dart3,
            Some(false)
        );
    }

    #[test]
    #[serial]
    fn test_compute_codegen_config_from_both_file_and_command_line() -> anyhow::Result<()> {
        configure_opinionated_test_logging();
        set_cwd_test_fixture("binary/commands_parser/flutter_rust_bridge_yaml")?;

        let config = run_command_line(vec!["", "generate", "--llvm-path", "/my/path"])?;
        assert_eq!(config.rust_input.unwrap(), "crate::hello".to_string());
        assert!(!config.dart3.unwrap());
        assert_eq!(config.llvm_path, Some(vec!["/my/path".to_owned()]));

        Ok(())
    }

    fn run_command_line(args: Vec<&'static str>) -> anyhow::Result<codegen::Config> {
        let cli = Cli::parse_from(args);
        let args = if_then_some!(let Commands::Generate(args) = cli.command, args).unwrap();
        compute_codegen_config(args.primary)
    }
}