pixelsrc 0.2.0

Pixelsrc - GenAI-native pixel art format and compiler
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

//! Explain Command Demo Tests
//!
//! Demonstrates the `pxl explain` command functionality for providing
//! human-readable explanations of sprites, palettes, and other objects.

use pixelsrc::explain::{
    explain_animation, explain_composition, explain_palette, explain_sprite, format_explanation,
    resolve_palette_colors, Explanation,
};
use pixelsrc::models::{Animation, Composition, PaletteRef, Sprite};
use std::collections::HashMap;

/// Helper to create a simple sprite for testing
fn make_sprite(name: &str, grid: Vec<&str>, palette: PaletteRef) -> Sprite {
    Sprite {
        name: name.to_string(),
        size: None,
        palette,
        grid: grid.into_iter().map(String::from).collect(),
        source: None,
        transform: None,
        metadata: None,
    }
}

// ============================================================================
// Sprite Explanation Tests
// ============================================================================

/// @demo cli/explain#sprite_basic
/// @title Explain Basic Sprite
/// @description `pxl explain` provides a human-readable breakdown of sprite structure.
#[test]
fn test_explain_basic_sprite() {
    let sprite = make_sprite(
        "star",
        vec!["{_}{y}{_}", "{y}{y}{y}", "{_}{y}{_}"],
        PaletteRef::Inline(HashMap::from([
            ("{_}".to_string(), "#00000000".to_string()),
            ("{y}".to_string(), "#FFD700".to_string()),
        ])),
    );

    let palette_colors = resolve_palette_colors(&sprite.palette, &HashMap::new());
    let explanation = explain_sprite(&sprite, palette_colors.as_ref());

    assert_eq!(explanation.name, "star");
    assert_eq!(explanation.width, 3);
    assert_eq!(explanation.height, 3);
    assert_eq!(explanation.total_cells, 9);
    assert!(
        explanation.tokens.len() >= 2,
        "Should list all tokens used"
    );
}

/// @demo cli/explain#sprite_tokens
/// @title Explain Token Usage
/// @description Shows token frequency and percentage of total grid cells.
#[test]
fn test_explain_token_usage() {
    let sprite = make_sprite(
        "checker",
        vec![
            "{a}{b}{a}{b}",
            "{b}{a}{b}{a}",
            "{a}{b}{a}{b}",
            "{b}{a}{b}{a}",
        ],
        PaletteRef::Inline(HashMap::from([
            ("{a}".to_string(), "#FF0000".to_string()),
            ("{b}".to_string(), "#00FF00".to_string()),
        ])),
    );

    let palette_colors = resolve_palette_colors(&sprite.palette, &HashMap::new());
    let explanation = explain_sprite(&sprite, palette_colors.as_ref());

    // Both tokens should be 50% each
    for token in &explanation.tokens {
        assert!(
            (token.percentage - 50.0).abs() < 1.0,
            "Each token should be ~50% in a checkerboard"
        );
        assert_eq!(token.count, 8, "Each token should appear 8 times in 4x4");
    }
}

/// @demo cli/explain#sprite_transparency
/// @title Explain Transparency Ratio
/// @description Shows percentage of transparent vs opaque cells.
#[test]
fn test_explain_transparency_ratio() {
    let sprite = make_sprite(
        "diamond",
        vec!["{_}{x}{_}", "{x}{x}{x}", "{_}{x}{_}"],
        PaletteRef::Inline(HashMap::from([
            ("{_}".to_string(), "#00000000".to_string()),
            ("{x}".to_string(), "#FF0000".to_string()),
        ])),
    );

    let palette_colors = resolve_palette_colors(&sprite.palette, &HashMap::new());
    let explanation = explain_sprite(&sprite, palette_colors.as_ref());

    // 4 transparent out of 9
    assert_eq!(explanation.transparent_count, 4);
    let expected_ratio = 4.0 / 9.0 * 100.0;
    assert!(
        (explanation.transparency_ratio - expected_ratio).abs() < 1.0,
        "Transparency ratio should be ~44.4%"
    );
}

// ============================================================================
// Palette Explanation Tests
// ============================================================================

/// @demo cli/explain#palette
/// @title Explain Palette
/// @description Shows palette name, color count, and color mappings.
#[test]
fn test_explain_palette() {
    let colors = HashMap::from([
        ("{_}".to_string(), "#00000000".to_string()),
        ("{skin}".to_string(), "#FFD5B4".to_string()),
        ("{hair}".to_string(), "#8B4513".to_string()),
        ("{shirt}".to_string(), "#4169E1".to_string()),
    ]);

    let explanation = explain_palette("hero_colors", &colors);

    assert_eq!(explanation.name, "hero_colors");
    assert_eq!(explanation.color_count, 4);
    assert!(!explanation.is_builtin);

    // Colors should be listed
    let token_names: Vec<_> = explanation.colors.iter().map(|(t, _, _)| t.clone()).collect();
    assert!(token_names.contains(&"{skin}".to_string()));
    assert!(token_names.contains(&"{hair}".to_string()));
}

// ============================================================================
// Animation Explanation Tests
// ============================================================================

/// @demo cli/explain#animation
/// @title Explain Animation
/// @description Shows frame sequence, timing, and loop settings.
#[test]
fn test_explain_animation() {
    let animation = Animation {
        name: "walk_cycle".to_string(),
        frames: vec![
            "walk_1".to_string(),
            "walk_2".to_string(),
            "walk_3".to_string(),
            "walk_4".to_string(),
        ],
        keyframes: None,
        source: None,
        transform: None,
        duration: Some(pixelsrc::models::Duration::Milliseconds(150)),
        timing_function: None,
        r#loop: None,
        palette_cycle: None,
        tags: None,
        frame_metadata: None,
        attachments: None,
    };

    let explanation = explain_animation(&animation);

    assert_eq!(explanation.name, "walk_cycle");
    assert_eq!(explanation.frame_count, 4);
    assert_eq!(explanation.duration_ms, 150);
    assert_eq!(explanation.frames, vec!["walk_1", "walk_2", "walk_3", "walk_4"]);
}

// ============================================================================
// Composition Explanation Tests
// ============================================================================

/// @demo cli/explain#composition
/// @title Explain Composition
/// @description Shows composition structure including layers and base sprite.
#[test]
fn test_explain_composition() {
    let composition = Composition {
        name: "scene".to_string(),
        base: Some("background".to_string()),
        size: Some([64, 64]),
        cell_size: Some([8, 8]),
        sprites: HashMap::from([
            ("a".to_string(), Some("player".to_string())),
            ("b".to_string(), Some("enemy".to_string())),
        ]),
        layers: vec![],
    };

    let explanation = explain_composition(&composition);

    assert_eq!(explanation.name, "scene");
    assert_eq!(explanation.base, Some("background".to_string()));
    assert_eq!(explanation.size, Some([64, 64]));
    assert_eq!(explanation.sprite_count, 2);
}

// ============================================================================
// Format Explanation Tests
// ============================================================================

/// @demo cli/explain#format_output
/// @title Formatted Explanation Output
/// @description Explanations can be formatted as human-readable text.
#[test]
fn test_format_explanation() {
    let sprite = make_sprite(
        "coin",
        vec![
            "{_}{g}{g}{_}",
            "{g}{g}{g}{g}",
            "{g}{g}{g}{g}",
            "{_}{g}{g}{_}",
        ],
        PaletteRef::Inline(HashMap::from([
            ("{_}".to_string(), "#0000".to_string()),
            ("{g}".to_string(), "#FFD700".to_string()),
        ])),
    );

    let palette_colors = resolve_palette_colors(&sprite.palette, &HashMap::new());
    let explanation = explain_sprite(&sprite, palette_colors.as_ref());
    let formatted = format_explanation(&Explanation::Sprite(explanation));

    // Formatted output should contain key information
    assert!(formatted.contains("coin"), "Should mention sprite name");
    assert!(formatted.contains("4") || formatted.contains("4x4"), "Should show dimensions");
}

// ============================================================================
// Edge Cases
// ============================================================================

/// @demo cli/explain#inline_vs_named
/// @title Explain Inline vs Named Palette
/// @description Explanation distinguishes between inline and named palette references.
#[test]
fn test_explain_inline_vs_named_palette() {
    // Inline palette
    let sprite_inline = make_sprite(
        "inline_test",
        vec!["{x}"],
        PaletteRef::Inline(HashMap::from([
            ("{x}".to_string(), "#FF0000".to_string()),
        ])),
    );

    let palette_colors = resolve_palette_colors(&sprite_inline.palette, &HashMap::new());
    let explanation = explain_sprite(&sprite_inline, palette_colors.as_ref());
    assert_eq!(explanation.palette_ref, "inline");

    // Named palette
    let sprite_named = make_sprite(
        "named_test",
        vec!["{x}"],
        PaletteRef::Named("my_palette".to_string()),
    );

    let empty_palettes = HashMap::new();
    let palette_colors = resolve_palette_colors(&sprite_named.palette, &empty_palettes);
    let explanation = explain_sprite(&sprite_named, palette_colors.as_ref());
    assert_eq!(explanation.palette_ref, "my_palette");
}

/// @demo cli/explain#inconsistent_rows
/// @title Explain Inconsistent Row Widths
/// @description Detects and reports when grid rows have different widths.
#[test]
fn test_explain_inconsistent_rows() {
    let sprite = make_sprite(
        "uneven",
        vec![
            "{x}{x}{x}",   // 3 tokens
            "{x}{x}",      // 2 tokens - inconsistent!
            "{x}{x}{x}",   // 3 tokens
        ],
        PaletteRef::Inline(HashMap::from([
            ("{x}".to_string(), "#FF0000".to_string()),
        ])),
    );

    let palette_colors = resolve_palette_colors(&sprite.palette, &HashMap::new());
    let explanation = explain_sprite(&sprite, palette_colors.as_ref());

    assert!(
        !explanation.consistent_rows,
        "Should detect inconsistent row widths"
    );
}