rune 0.14.2

The Rune Language, an embeddable dynamic programming language for Rust.
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

#![cfg(feature = "doc")]

prelude!();

use std::sync::Arc;

use codespan_reporting::term::termcolor::{ColorChoice, StandardStream};

use crate::diagnostics::Diagnostic;

use self::diagnostics::{RuntimeWarningDiagnosticKind, WarningDiagnosticKind};

fn create_context() -> Result<Context> {
    #[derive(Debug, rune::Any)]
    #[rune(item = ::abc)]
    pub struct TestStruct {}

    /// Creates a new TestStruct
    #[rune::function(free, path = TestStruct::new)]
    pub fn new() -> TestStruct {
        TestStruct {}
    }

    let mut module = Module::with_crate("abc")?;
    module.ty::<TestStruct>()?;
    module.function_meta(new)?;

    module
        .field_function(&Protocol::GET, "hello", |_this: &TestStruct| 1)?
        .deprecated("Deprecated get field fn")?;

    module
        .function("abc", || 1)
        .build()?
        .deprecated("Deprecated function")?;

    module
        .associated_function("test", |_this: &TestStruct| 1)?
        .deprecated("Deprecated associated fn")?;

    let mut context = Context::with_default_modules()?;
    context.install(module)?;
    Ok(context)
}

fn create_sources() -> Result<Sources> {
    Ok(sources! {
        entry => {
            #[test]
            pub fn main() {
                let x = abc::abc();
                let ts = abc::TestStruct::new();
                x += ts.test();
                x += ts.hello;
            }
        }
    })
}

fn check_diagnostic(context: &Context, diagnostic: &Diagnostic, msg: &str) {
    match diagnostic {
        Diagnostic::Warning(w) => match w.kind() {
            WarningDiagnosticKind::UsedDeprecated { message, .. } => {
                assert_eq!(message, msg);
            }
            kind => panic!("Unexpected warning: {kind:?}"),
        },
        Diagnostic::RuntimeWarning(w) => match w.kind() {
            RuntimeWarningDiagnosticKind::UsedDeprecated { hash, .. } => {
                let message = context.lookup_deprecation(*hash);
                assert_eq!(message, Some(msg));
            }
        },
        kind => panic!("Unexpected diagnostics: {kind:?}"),
    };
}

#[test]
fn test_deprecation_warnings() -> Result<()> {
    let context = create_context()?;
    let mut sources = create_sources()?;
    let mut diagnostics = Diagnostics::new();

    let unit = Arc::new(
        rune::prepare(&mut sources)
            .with_context(&context)
            .with_diagnostics(&mut diagnostics)
            .build()?,
    );

    let mut vm = Vm::new(Arc::new(context.runtime()?), unit.clone());
    vm.call_with_diagnostics(["main"], (), Some(&mut diagnostics))?;

    // print diagnostics - just for manual check
    if !diagnostics.is_empty() {
        diagnostics.emit_detailed(
            &mut StandardStream::stdout(ColorChoice::Auto),
            &sources,
            &unit,
            &context,
        )?;
    }

    // check that the diagnostics are properly found
    let mut iter = diagnostics.diagnostics().iter();
    check_diagnostic(&context, iter.next().unwrap(), "Deprecated function");
    check_diagnostic(&context, iter.next().unwrap(), "Deprecated associated fn");
    check_diagnostic(&context, iter.next().unwrap(), "Deprecated get field fn");
    Ok(())
}

#[tokio::test]
async fn test_deprecation_warnings_async() -> Result<()> {
    let context = create_context()?;
    let mut sources = create_sources()?;
    let mut diagnostics = Diagnostics::new();

    let unit = rune::prepare(&mut sources)
        .with_context(&context)
        .with_diagnostics(&mut diagnostics)
        .build()?;

    let vm = Vm::new(Arc::new(context.runtime()?), Arc::new(unit));
    let future = vm.send_execute(["main"], ())?;
    let _ = future
        .async_complete_with_diagnostics(Some(&mut diagnostics))
        .await;

    // print diagnostics - just for manual check
    if !diagnostics.is_empty() {
        diagnostics.emit(&mut StandardStream::stdout(ColorChoice::Auto), &sources)?;
    }

    // check that the diagnostics are properly found
    let mut iter = diagnostics.diagnostics().iter();
    check_diagnostic(&context, iter.next().unwrap(), "Deprecated function");
    check_diagnostic(&context, iter.next().unwrap(), "Deprecated associated fn");
    check_diagnostic(&context, iter.next().unwrap(), "Deprecated get field fn");

    Ok(())
}