sigil-stitch 0.6.8

Type-safe, import-aware, width-aware code generation for multiple languages
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

//! Test helpers for exact rendered-code assertions.

use crate::code_block::CodeBlock;
use crate::error::SigilStitchError;
use crate::lang::CodeLang;
use crate::spec::file_spec::FileSpec;

/// Render a `CodeBlock` through `FileSpec` for tests.
///
/// This exercises the same import collection and language rendering path as a
/// real file render. The filename is synthetic and based on the language's file
/// extension.
pub fn render_block_for_test(
    lang: impl CodeLang,
    block: &CodeBlock,
    width: usize,
) -> Result<String, SigilStitchError> {
    let filename = format!("test.{}", lang.file_extension());
    FileSpec::builder_with(&filename, lang)
        .add_code(block.clone())
        .build()?
        .render(width)
}

/// Assert that a `CodeBlock` renders exactly through `FileSpec`.
///
/// The assertion is exact: leading whitespace, trailing whitespace, and final
/// newlines are significant.
#[macro_export]
macro_rules! assert_rendered {
    ($lang:expr, width = $width:expr, $block:expr, $expected:expr $(,)?) => {{
        let __sigil_block = $block;
        let __sigil_actual = $crate::testing::render_block_for_test($lang, &__sigil_block, $width)
            .expect("failed to render CodeBlock in assert_rendered!");
        let __sigil_expected = $expected;
        assert_eq!(
            __sigil_actual, __sigil_expected,
            "rendered code mismatch\n\n--- expected ---\n{}\n--- actual ---\n{}",
            __sigil_expected, __sigil_actual,
        );
    }};
    ($lang:expr, $block:expr, $expected:expr $(,)?) => {{
        $crate::assert_rendered!($lang, width = 80, $block, $expected);
    }};
}

/// Assert that an inline `sigil_quote!` body renders exactly.
///
/// The language type must be in scope and provide `new()`. For configured
/// language instances, build the quote separately and use [`assert_rendered!`].
#[macro_export]
macro_rules! assert_quote {
    ($lang:ident, width = $width:expr, { $($body:tt)* }, $expected:expr $(,)?) => {{
        let __sigil_block = $crate::prelude::sigil_quote!($lang { $($body)* })
            .expect("failed to build CodeBlock in assert_quote!");
        $crate::assert_rendered!($lang::new(), width = $width, __sigil_block, $expected);
    }};
    ($lang:ident, { $($body:tt)* }, $expected:expr $(,)?) => {{
        $crate::assert_quote!($lang, width = 80, { $($body)* }, $expected);
    }};
}