thymeleaf 0.1.0-beta.1

A framework-neutral Thymeleaf-compatible dynamic template engine for Rust
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
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
#![expect(
    dead_code,
    reason = "直接消费者 ProcessorTemplateHandler 将在同一 Engine 批次后续接入"
)]

use std::cmp::Ordering;
use std::sync::Arc;

use crate::element::IElementProcessor;
use crate::exceptions::TemplateProcessingException;

use super::AbstractProcessableElementTag;

/// 在标签属性动态变化时保持已访问状态的元素 Processor 迭代器。
///
/// 新出现的 Processor 即使优先级高于最后执行项也会被执行;仍存在的 Processor
/// 保留 visited 状态;被删除项从快照消失。还支持处理器要求立即重复自身的流程。
///
/// 对应 Java: `org.thymeleaf.engine.ElementProcessorIterator`。
pub(crate) struct ElementProcessorIterator {
    last: isize,
    processors: Vec<Arc<dyn IElementProcessor>>,
    visited: Vec<bool>,
    current_tag_identity: Option<u64>,
    last_to_be_repeated: bool,
    last_was_repeated: bool,
}

impl ElementProcessorIterator {
    /// 创建尚未绑定标签的迭代器。
    pub(crate) const fn new() -> Self {
        Self {
            last: -1,
            processors: Vec::new(),
            visited: Vec::new(),
            current_tag_identity: None,
            last_to_be_repeated: false,
            last_was_repeated: false,
        }
    }

    /// 清除当前迭代状态并复用已分配空间。
    /// 对应 Java: `ElementProcessorIterator#reset()`。
    pub(crate) fn reset(&mut self) {
        self.processors.clear();
        self.visited.clear();
        self.last = -1;
        self.current_tag_identity = None;
        self.last_to_be_repeated = false;
        self.last_was_repeated = false;
    }

    /// 返回下一未访问 Processor,必要时按新标签快照重算。
    /// 对应 Java: `ElementProcessorIterator#next()`。
    pub(crate) fn next(
        &mut self,
        tag: &AbstractProcessableElementTag,
    ) -> Result<Option<Arc<dyn IElementProcessor>>, TemplateProcessingException> {
        let tag_identity = tag.identity();
        if self.last_to_be_repeated {
            if self.current_tag_identity != Some(tag_identity) {
                return Err(TemplateProcessingException::new(Some(
                    "Cannot return last processor to be repeated: changes were made and processor recompute is needed!"
                        .to_owned(),
                )));
            }
            let processor = self
                .processors
                .get(self.last as usize)
                .cloned()
                .ok_or_else(|| {
                    TemplateProcessingException::new(Some(
                        "Cannot return last processor to be repeated: no processors in tag!"
                            .to_owned(),
                    ))
                })?;
            self.last_to_be_repeated = false;
            self.last_was_repeated = true;
            return Ok(Some(processor));
        }
        self.last_was_repeated = false;
        if self.current_tag_identity != Some(tag_identity) {
            self.recompute(tag)?;
            self.current_tag_identity = Some(tag_identity);
            self.last = -1;
        }
        let start = usize::try_from(self.last + 1).unwrap_or(0);
        if let Some(index) = (start..self.processors.len()).find(|index| !self.visited[*index]) {
            self.visited[index] = true;
            self.last = index as isize;
            return Ok(Some(Arc::clone(&self.processors[index])));
        }
        self.last = self.processors.len() as isize;
        Ok(None)
    }

    /// 返回上次结果是否来自显式重复请求。
    pub(crate) const fn last_was_repeated(&self) -> bool {
        self.last_was_repeated
    }

    /// 要求下一次返回当前标签最后一个 Processor。
    /// 对应 Java: `ElementProcessorIterator#setLastToBeRepeated()`。
    pub(crate) fn set_last_to_be_repeated(
        &mut self,
        tag: &AbstractProcessableElementTag,
    ) -> Result<(), TemplateProcessingException> {
        if self.current_tag_identity != Some(tag.identity()) {
            return Err(TemplateProcessingException::new(Some(
                "Cannot set last processor to be repeated: processor recompute is needed!"
                    .to_owned(),
            )));
        }
        if self.processors.is_empty() || self.last < 0 {
            return Err(TemplateProcessingException::new(Some(
                "Cannot set last processor to be repeated: no processors in tag!".to_owned(),
            )));
        }
        self.last_to_be_repeated = true;
        Ok(())
    }

    /// 复制原迭代器的处理快照和访问进度。
    /// 对应 Java: `ElementProcessorIterator#resetAsCloneOf()`。
    pub(crate) fn reset_as_clone_of(&mut self, original: &Self) {
        self.last = original.last;
        self.processors.clone_from(&original.processors);
        self.visited.clone_from(&original.visited);
        self.current_tag_identity = original.current_tag_identity;
        self.last_to_be_repeated = original.last_to_be_repeated;
        self.last_was_repeated = original.last_was_repeated;
    }

    fn recompute(
        &mut self,
        tag: &AbstractProcessableElementTag,
    ) -> Result<(), TemplateProcessingException> {
        let associated_processors = tag.get_associated_processors().map_err(|error| {
            TemplateProcessingException::with_cause(
                Some("Could not recompute associated element processors".to_owned()),
                error,
            )
        })?;
        let old_processors = std::mem::take(&mut self.processors);
        let old_visited = std::mem::take(&mut self.visited);
        self.visited = vec![false; associated_processors.len()];
        for (new_index, new_processor) in associated_processors.iter().enumerate() {
            if let Some(old_index) = old_processors
                .iter()
                .position(|old_processor| Arc::ptr_eq(new_processor, old_processor))
            {
                self.visited[new_index] = old_visited[old_index];
            } else if old_processors.iter().any(|old_processor| {
                compare_processors(new_processor, old_processor) == Ordering::Equal
            }) {
                return Err(TemplateProcessingException::new(Some(format!(
                    "Two different registered processors have returned zero as a result of their comparison, which is forbidden. Offending processors are {} and {}",
                    new_processor.class_name(),
                    old_processors
                        .iter()
                        .find(|old_processor| {
                            compare_processors(new_processor, old_processor) == Ordering::Equal
                        })
                        .expect("the preceding equality check must identify an offending processor")
                        .class_name()
                ))));
            }
        }
        self.processors = associated_processors;
        Ok(())
    }
}

fn compare_processors(
    left: &Arc<dyn IElementProcessor>,
    right: &Arc<dyn IElementProcessor>,
) -> Ordering {
    if Arc::ptr_eq(left, right) {
        return Ordering::Equal;
    }
    crate::util::ProcessorComparators::compare_processors(left.as_ref(), right.as_ref())
}

#[cfg(test)]
mod tests {
    use std::collections::HashMap;
    use std::sync::Arc;

    use super::ElementProcessorIterator;
    use crate::element::{IElementProcessor, MatchingAttributeName};
    use crate::engine::{
        Attribute, AttributeDefinitionValue, AttributeDefinitions, ElementDefinitionValue,
        ElementDefinitions, ElementProcessorsByTemplateMode, OpenElementTag,
    };
    use crate::model::{AttributeValueQuotes, IProcessableElementTag};
    use crate::processor::IProcessor;
    use crate::templatemode::TemplateMode;
    use crate::util::Utf16String;

    /// 对应 Java: `ProcessorAggregationTestDialect.TestElementProcessor`。
    ///
    /// 该最小测试方言 Processor 只描述匹配规则与 precedence,实际关联、重建和
    /// 迭代均由生产 `AttributeDefinitions`、`ElementDefinitions` 与标签对象完成。
    struct TestElementProcessor {
        name: &'static str,
        precedence: i32,
        matching_attribute_name: MatchingAttributeName,
        matching_element_name: Option<crate::element::MatchingElementName>,
    }

    impl IProcessor for TestElementProcessor {
        fn as_element_processor(&self) -> Option<&dyn IElementProcessor> {
            Some(self)
        }

        fn class_name(&self) -> &'static str {
            self.name
        }

        fn get_template_mode(&self) -> Option<TemplateMode> {
            Some(TemplateMode::HTML)
        }

        fn get_precedence(&self) -> i32 {
            self.precedence
        }
    }

    impl IElementProcessor for TestElementProcessor {
        fn get_matching_element_name(&self) -> Option<&crate::element::MatchingElementName> {
            self.matching_element_name.as_ref()
        }

        fn get_matching_attribute_name(&self) -> Option<&MatchingAttributeName> {
            Some(&self.matching_attribute_name)
        }
    }

    fn java(value: &str) -> Utf16String {
        Utf16String::from_rust_str(value)
    }

    fn processor(
        name: &'static str,
        attribute: &str,
        precedence: i32,
    ) -> Arc<dyn IElementProcessor> {
        processor_full(name, attribute, precedence, None)
    }

    /// Java `ProcessorAggregationTestDialect` 的 `N-ELEMENT-{prec}-[*]{element}-{attr}`
    /// 规格构造:`element_name` 为 `None`(null)或元素名(`*a` → `a`)。
    fn processor_full(
        name: &'static str,
        attribute: &str,
        precedence: i32,
        element_name: Option<&str>,
    ) -> Arc<dyn IElementProcessor> {
        let matching_name = crate::engine::AttributeNames::for_html_name(Some(&java(attribute)))
            .expect("test attribute name");
        let matching_element_name = element_name.map(|element| {
            crate::element::MatchingElementName::for_element_name(
                Some(TemplateMode::HTML),
                Some(crate::engine::ElementNameValue::Html(
                    crate::engine::ElementNames::for_html_name(Some(&java(element)))
                        .expect("test element name"),
                )),
            )
            .expect("test matching element name")
        });
        Arc::new(TestElementProcessor {
            name,
            precedence,
            matching_attribute_name: MatchingAttributeName::for_attribute_name(
                Some(TemplateMode::HTML),
                Some(crate::engine::AttributeNameValue::Html(matching_name)),
            )
            .expect("test matching attribute name"),
            matching_element_name,
        })
    }

    fn definitions(
        processors: Vec<Arc<dyn IElementProcessor>>,
    ) -> (AttributeDefinitions, ElementDefinitions) {
        let processor_map: ElementProcessorsByTemplateMode =
            HashMap::from([(TemplateMode::HTML, processors)]);
        let attribute_definitions =
            AttributeDefinitions::new(processor_map.clone()).expect("test attribute definitions");
        let element_definitions =
            ElementDefinitions::new(processor_map).expect("test element definitions");
        (attribute_definitions, element_definitions)
    }

    fn tag_with_src(
        attribute_definitions: &AttributeDefinitions,
        element_definitions: &ElementDefinitions,
    ) -> Arc<OpenElementTag> {
        tag_for(attribute_definitions, element_definitions, "element")
    }

    /// 构造带 `th:src` 属性的标签(Java `computeHtmlTag("<... th:src='hello'>")`
    /// 的最后打开的标签;元素名由调用方指定)。
    fn tag_for(
        attribute_definitions: &AttributeDefinitions,
        element_definitions: &ElementDefinitions,
        element_name: &str,
    ) -> Arc<OpenElementTag> {
        let element_definition = ElementDefinitionValue::Html(
            element_definitions
                .for_html_name(Some(&java(element_name)))
                .expect("element definition"),
        );
        let src_definition = AttributeDefinitionValue::Html(
            attribute_definitions
                .for_html_name(Some(&java("data-th-src")))
                .expect("src definition"),
        );
        let attributes = crate::engine::Attributes::new(
            Some(vec![Arc::new(Attribute::new(
                src_definition,
                java("data-th-src"),
                None,
                Some(java("src")),
                Some(AttributeValueQuotes::DOUBLE),
                None,
                -1,
                -1,
            ))]),
            Some(vec![java(" ")]),
        );
        Arc::new(OpenElementTag::new(
            TemplateMode::HTML,
            element_definition,
            java(element_name),
            Some(attributes),
            false,
        ))
    }

    fn add_one(
        tag: &Arc<OpenElementTag>,
        definitions: &AttributeDefinitions,
    ) -> Arc<OpenElementTag> {
        let definition = AttributeDefinitionValue::Html(
            definitions
                .for_html_name(Some(&java("data-th-one")))
                .expect("one definition"),
        );
        tag.set_attribute(
            definitions,
            Some(&definition),
            java("data-th-one"),
            Some(java("one")),
            Some(AttributeValueQuotes::DOUBLE),
        )
        .expect("add one attribute")
    }

    fn next_precedence(iterator: &mut ElementProcessorIterator, tag: &OpenElementTag) -> String {
        iterator
            .next(
                tag.as_engine_processable_element_tag()
                    .expect("engine processable tag"),
            )
            .expect("iterator next")
            .map_or_else(
                || "null".to_owned(),
                |processor| processor.get_precedence().to_string(),
            )
    }

    fn assert_golden(case: &str, output: String) {
        let java_trace = include_str!("../../tests/fixtures/element_processor_iterator_golden.txt")
            .lines()
            .find_map(|line| line.strip_prefix(&format!("{case}=")))
            .expect("Java Golden case");
        let mut expected = java_trace
            .split("N-ELEMENT-")
            .skip(1)
            .map(|entry| {
                entry
                    .chars()
                    .take_while(char::is_ascii_digit)
                    .collect::<String>()
            })
            .collect::<Vec<_>>();
        if java_trace.ends_with("null") {
            expected.push("null".to_owned());
        }
        let expected = expected.join(",");
        assert_eq!(output, expected, "Java Golden {case}");
    }

    #[test]
    fn preserves_java_dynamic_attribute_processor_iteration_cases() {
        for (case, one_precedence, operation) in [
            ("case01", 0, "none"),
            ("case02", 15, "add_after_first"),
            ("case03", 7, "add_after_first"),
            ("case04", 2, "add_after_first"),
            ("case06", 0, "remove_before_first"),
            ("case07", 2, "remove_then_add"),
            ("case08", 2, "add_then_remove_after_first"),
            ("case09", 2, "add_after_first_then_remove"),
        ] {
            let mut processors = vec![
                processor("N-ELEMENT-5", "data-th-src", 5),
                processor("N-ELEMENT-10", "data-th-src", 10),
            ];
            if operation != "none" {
                processors.push(processor("N-ELEMENT-ONE", "data-th-one", one_precedence));
            }
            let (attribute_definitions, element_definitions) = definitions(processors);
            let mut tag = tag_with_src(&attribute_definitions, &element_definitions);
            let mut iterator = ElementProcessorIterator::new();
            let mut actual = Vec::new();

            match operation {
                "remove_before_first" => {
                    tag = tag
                        .remove_attribute(&java("data-th-src"))
                        .expect("remove src");
                }
                "remove_then_add" => {
                    tag = tag
                        .remove_attribute(&java("data-th-src"))
                        .expect("remove src");
                    tag = add_one(&tag, &attribute_definitions);
                }
                "add_after_first" => {
                    actual.push(next_precedence(&mut iterator, &tag));
                    tag = add_one(&tag, &attribute_definitions);
                }
                "add_then_remove_after_first" => {
                    actual.push(next_precedence(&mut iterator, &tag));
                    tag = add_one(&tag, &attribute_definitions);
                    tag = tag
                        .remove_attribute(&java("data-th-src"))
                        .expect("remove src");
                }
                "add_after_first_then_remove" => {
                    actual.push(next_precedence(&mut iterator, &tag));
                    tag = add_one(&tag, &attribute_definitions);
                    actual.push(next_precedence(&mut iterator, &tag));
                    tag = tag
                        .remove_attribute(&java("data-th-src"))
                        .expect("remove src");
                }
                "none" => {}
                _ => unreachable!("fixed test operation"),
            }
            while actual.last().is_none_or(|value| value != "null") {
                actual.push(next_precedence(&mut iterator, &tag));
            }
            assert_golden(case, actual.join(","));
        }
    }

    /// Java `TestElementProcessor#toString` 的完整追踪:
    /// `N-ELEMENT-{precedence}-{matchingElementName|null}-{matchingAttributeName}`
    /// (`MatchingElementName`/`MatchingAttributeName` 的 `to_utf16_string` 渲染
    /// 完整名称集,如 `{a}`、`{th:src,data-th-src}`)。
    fn next_trace(iterator: &mut ElementProcessorIterator, tag: &OpenElementTag) -> String {
        let Some(processor) = iterator
            .next(
                tag.as_engine_processable_element_tag()
                    .expect("engine processable tag"),
            )
            .expect("iterator next")
        else {
            return "null".to_owned();
        };
        let element = processor
            .get_matching_element_name()
            .map(|name| {
                name.to_utf16_string()
                    .map(|value| value.to_string_lossy())
                    .expect("matching element name string")
            })
            .unwrap_or_else(|| "null".to_owned());
        let attribute = processor
            .get_matching_attribute_name()
            .map(|name| {
                name.to_utf16_string()
                    .map(|value| value.to_string_lossy())
                    .expect("matching attribute name string")
            })
            .expect("test processor matches an attribute");
        format!(
            "N-ELEMENT-{}-{element}-{attribute}",
            processor.get_precedence()
        )
    }

    /// 对应 Java `testProcessorIteration05/10/11/12/13/14` —— 三处理器
    /// (N-ELEMENT-10-src / N-ELEMENT-5-src / N-ELEMENT-2-one)在迭代中
    /// `setAttribute`/`removeAttribute` 的动态语义:
    /// - 05:迭代前 set `th:one`,完整遍历(one → src-5 → src-10 → null)
    /// - 10:迭代后 set 再 remove(src-5 → one → null)
    /// - 11/12:父级元素包围的 `<a>`(Java 重复用例)
    /// - 13/14:匹配元素名 `*a` 的处理器(`{a}` 渲染 + 同上动态语义)
    #[test]
    fn preserves_java_dynamic_attribute_processor_iteration_cases_05_10_through_14() {
        let (attribute_definitions, element_definitions) = definitions(vec![
            processor_full("N-ELEMENT-10", "data-th-src", 10, None),
            processor_full("N-ELEMENT-5", "data-th-src", 5, None),
            processor_full("N-ELEMENT-2", "data-th-one", 2, None),
        ]);

        // Java 05:解析 `<a th:src='hello'>`,迭代前 setAttribute("th:one"),
        // 完整遍历:one → src-5 → src-10 → null。
        {
            let mut tag = tag_for(&attribute_definitions, &element_definitions, "a");
            tag = set_one(&tag, &attribute_definitions, "somevalue");
            let mut iterator = ElementProcessorIterator::new();
            assert_eq!(
                next_trace(&mut iterator, &tag),
                "N-ELEMENT-2-null-{th:one,data-th-one}"
            );
            assert_eq!(
                next_trace(&mut iterator, &tag),
                "N-ELEMENT-5-null-{th:src,data-th-src}"
            );
            assert_eq!(
                next_trace(&mut iterator, &tag),
                "N-ELEMENT-10-null-{th:src,data-th-src}"
            );
            assert_eq!(next_trace(&mut iterator, &tag), "null");
        }

        // Java 10/11/12:`<a th:src='hello'>`(11/12 带父级 div),第一次 next
        // 后 setAttribute("th:one"),再 removeAttribute("th:src")。
        for _ in 0..3 {
            let mut tag = tag_for(&attribute_definitions, &element_definitions, "a");
            let mut iterator = ElementProcessorIterator::new();
            assert_eq!(
                next_trace(&mut iterator, &tag),
                "N-ELEMENT-5-null-{th:src,data-th-src}"
            );
            tag = set_one(&tag, &attribute_definitions, "somevalue");
            assert_eq!(
                next_trace(&mut iterator, &tag),
                "N-ELEMENT-2-null-{th:one,data-th-one}"
            );
            tag = tag
                .remove_attribute(&java("data-th-src"))
                .expect("remove src");
            assert_eq!(next_trace(&mut iterator, &tag), "null");
        }

        // Java 13/14:`N-ELEMENT-5-*a-src`(匹配元素名 a),解析
        // `<div class='one'><p th:src='uuuh'><a th:src='hello'>` 的最后一个标签。
        let (attribute_definitions, element_definitions) = definitions(vec![
            processor_full("N-ELEMENT-10", "data-th-src", 10, None),
            processor_full("N-ELEMENT-5", "data-th-src", 5, Some("a")),
            processor_full("N-ELEMENT-2", "data-th-one", 2, None),
        ]);
        for _ in 0..2 {
            let mut tag = tag_for(&attribute_definitions, &element_definitions, "a");
            let mut iterator = ElementProcessorIterator::new();
            assert_eq!(
                next_trace(&mut iterator, &tag),
                "N-ELEMENT-5-{a}-{th:src,data-th-src}"
            );
            tag = set_one(&tag, &attribute_definitions, "somevalue");
            assert_eq!(
                next_trace(&mut iterator, &tag),
                "N-ELEMENT-2-null-{th:one,data-th-one}"
            );
            tag = tag
                .remove_attribute(&java("data-th-src"))
                .expect("remove src");
            assert_eq!(next_trace(&mut iterator, &tag), "null");
        }
    }

    /// 对应 Java `OpenElementTag#setAttribute(attributeDefinitions, null,
    /// "th:one", "somevalue", null)`。
    fn set_one(
        tag: &Arc<OpenElementTag>,
        definitions: &AttributeDefinitions,
        value: &str,
    ) -> Arc<OpenElementTag> {
        let definition = AttributeDefinitionValue::Html(
            definitions
                .for_html_name(Some(&java("data-th-one")))
                .expect("one definition"),
        );
        tag.set_attribute(
            definitions,
            Some(&definition),
            java("data-th-one"),
            Some(java(value)),
            Some(AttributeValueQuotes::DOUBLE),
        )
        .expect("set one attribute")
    }
}