microformats 0.18.1

A union library of the Microformats types and associated parser.
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
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
#![cfg(all(test, feature = "metaformats"))]

use crate::parse::Parser;
use microformats_types::{Document, PropertyValue};

/// Test comprehensive meta-tag scenarios
/// Covers Open Graph, Twitter Cards, and Article properties
#[yare::parameterized(
    // Open Graph tags
    og_tags = { 
        r#"
<!DOCTYPE html>
<html>
    <head>
        <meta property="og:title" content="OG Title">
        <meta property="og:description" content="OG Description">
        <meta property="og:type" content="article">
        <meta property="og:image" content="https://example.com/image.jpg">
    </head>
    <body>
        <div class="h-entry" id="entry1">
            <span class="p-name">Main Entry</span>
        </div>
    </body>
</html>
        "#,
        serde_json::from_value(serde_json::json!({
            "items": [
                {
                    "id": "entry1",
                    "type": ["h-entry"],
                    "properties": {
                        "name": ["Main Entry"]
                    }
                }
            ],
            "url": "http://example.com/page.html",
            "rels": {},
            "rel-urls": {},
            "meta-item": {
                "type": ["h-entry"],
                "properties": {
                    "name": ["OG Title"],
                    "summary": ["OG Description"],
                    "photo": ["https://example.com/image.jpg"]
                }
            }
        })).unwrap()
    },

    // Twitter Card tags
    twitter_tags = {
        r#"
<!DOCTYPE html>
<html>
    <head>
        <meta name="twitter:card" content="summary">
        <meta name="twitter:title" content="Twitter Title">
        <meta name="twitter:description" content="Twitter Description">
        <meta name="twitter:image" content="https://example.com/twitter-image.jpg">
    </head>
    <body>
        <div class="h-entry" id="entry1">
            <span class="p-name">Main Entry</span>
        </div>
    </body>
</html>
        "#,
        serde_json::from_value(serde_json::json!({
            "items": [
                {
                    "id": "entry1",
                    "type": ["h-entry"],
                    "properties": {
                        "name": ["Main Entry"]
                    }
                }
            ],
            "url": "http://example.com/page.html",
            "rels": {},
            "rel-urls": {},
            "meta-item": {
                "type": ["h-entry"],
                "properties": {
                    "name": ["Twitter Title"],
                    "summary": ["Twitter Description"],
                    "photo": ["https://example.com/twitter-image.jpg"]
                }
            }
        })).unwrap()
    },

    // Article:* datetime properties
    article_datetime = {
        r#"
<!DOCTYPE html>
<html>
    <head>
        <meta property="og:title" content="Article Title">
        <meta property="article:published_time" content="2024-01-15T10:30:00Z">
        <meta property="article:modified_time" content="2024-01-16T15:45:00Z">
        <meta property="article:author" content="Jane Doe">
        <meta property="og:type" content="article">
    </head>
    <body>
        <div class="h-entry" id="entry1">
            <span class="p-name">Main Entry</span>
        </div>
    </body>
</html>
        "#,
        serde_json::from_value(serde_json::json!({
            "items": [
                {
                    "id": "entry1",
                    "type": ["h-entry"],
                    "properties": {
                        "name": ["Main Entry"]
                    }
                }
            ],
            "url": "http://example.com/page.html",
            "rels": {},
            "rel-urls": {},
            "meta-item": {
                "type": ["h-entry"],
                "properties": {
                    "name": ["Article Title"],
                    "published": ["2024-01-15T10:30:00Z"],
                    "updated": ["2024-01-16T15:45:00Z"],
                    "author": ["Jane Doe"]
                }
            }
        })).unwrap()
    },
)]
fn parse_metaformats_scenarios(html: &str, expected: Document) -> Result<(), crate::Error> {
    let mut parser = Parser::from_html(html.to_string())?;
    let result = parser.into_document(Some("http://example.com/page.html".parse()?));

    similar_asserts::assert_serde_eq!(
        actual: result.map_err(|e| e.to_string()),
        expected: Ok(expected),
        "meta-item should be created from meta tags"
    );

    Ok(())
}

/// Test home page detection logic
/// Home pages (/ or /index.html) should create h-card, regular pages should create h-entry
#[yare::parameterized(
    // Home page with OG tags - should be h-card
    home_page_og = {
        r#"
<!DOCTYPE html>
<html>
    <head>
        <meta property="og:title" content="My Site">
        <meta property="og:type" content="article">
    </head>
    <body>
        <div class="h-entry" id="entry1">
            <span class="p-name">Content</span>
        </div>
    </body>
</html>
        "#,
        "http://example.com/",
        "h-card"
    },

    // Home page with OG tags (index.html variant) - should be h-card
    home_page_og_index = {
        r#"
<!DOCTYPE html>
<html>
    <head>
        <meta property="og:title" content="My Site">
        <meta property="og:type" content="article">
    </head>
    <body>
        <div class="h-entry" id="entry1">
            <span class="p-name">Content</span>
        </div>
    </body>
</html>
        "#,
        "http://example.com/index.html",
        "h-card"
    },

    // Regular page with OG tags - should be h-entry
    regular_page_og = {
        r#"
<!DOCTYPE html>
<html>
    <head>
        <meta property="og:title" content="Article">
        <meta property="og:type" content="article">
    </head>
    <body>
        <div class="h-entry" id="entry1">
            <span class="p-name">Content</span>
        </div>
    </body>
</html>
        "#,
        "http://example.com/page.html",
        "h-entry"
    },

    // Home page with Twitter card - should be h-card
    home_page_twitter = {
        r#"
<!DOCTYPE html>
<html>
    <head>
        <meta name="twitter:card" content="summary">
        <meta name="twitter:title" content="My Site">
    </head>
    <body>
        <div class="h-entry" id="entry1">
            <span class="p-name">Content</span>
        </div>
    </body>
</html>
        "#,
        "http://example.com/",
        "h-card"
    },

    // Regular page with Twitter card - should be h-entry
    regular_page_twitter = {
        r#"
<!DOCTYPE html>
<html>
    <head>
        <meta name="twitter:card" content="summary">
        <meta name="twitter:title" content="Article">
    </head>
    <body>
        <div class="h-entry" id="entry1">
            <span class="p-name">Content</span>
        </div>
    </body>
</html>
        "#,
        "http://example.com/page.html",
        "h-entry"
    },
)]
fn parse_home_page_detection(
    html: &str,
    url: &str,
    expected_item_type: &str,
) -> Result<(), crate::Error> {
    let mut parser = Parser::from_html(html.to_string())?;
    let result = parser.into_document(Some(url.parse()?));

    assert!(result.is_ok(), "parsing should succeed");
    let doc = result?;

    assert!(doc.meta_item.is_some(), "meta-item should be created");
    let meta_item = doc.meta_item.as_ref().unwrap();

    assert_eq!(meta_item.r#type.len(), 1, "meta-item should have one type");
    let actual_type = &meta_item.r#type[0];
    assert_eq!(
        actual_type.to_string(),
        expected_item_type,
        "meta-item type should be {} for {} URL",
        expected_item_type,
        url
    );

    Ok(())
}

/// Test fallback properties and icon support
/// Covers title/description fallbacks and various icon conventions
#[yare::parameterized(
    // Fallback to <title> element
    title_fallback = {
        r#"
<!DOCTYPE html>
<html>
    <head>
        <title>Page Title from Title Tag</title>
        <meta name="twitter:card" content="summary">
    </head>
    <body>
        <div class="h-entry" id="entry1">
            <span class="p-name">Content</span>
        </div>
    </body>
</html>
        "#,
        "name",
        "Page Title from Title Tag"
    },

    // Fallback to <meta name="description">
    description_fallback = {
        r#"
<!DOCTYPE html>
<html>
    <head>
        <meta name="description" content="Meta Description">
        <meta name="twitter:card" content="summary">
    </head>
    <body>
        <div class="h-entry" id="entry1">
            <span class="p-name">Content</span>
        </div>
    </body>
</html>
        "#,
        "summary",
        "Meta Description"
    },

    // Icon fallback with rel="icon"
    icon_fallback = {
        r#"
<!DOCTYPE html>
<html>
    <head>
        <meta name="twitter:card" content="summary">
        <meta name="twitter:title" content="Test">
        <link rel="icon" href="/favicon.ico">
    </head>
    <body>
        <div class="h-entry" id="entry1">
            <span class="p-name">Content</span>
        </div>
    </body>
</html>
        "#,
        "photo",
        "http://example.com/favicon.ico"
    },

    // MS icon with rel="shortcut icon" (MS convention)
    ms_shortcut_icon = {
        r#"
<!DOCTYPE html>
<html>
    <head>
        <meta name="twitter:card" content="summary">
        <meta name="twitter:title" content="Test">
        <link rel="shortcut icon" href="/tile.png">
    </head>
    <body>
        <div class="h-entry" id="entry1">
            <span class="p-name">Content</span>
        </div>
    </body>
</html>
        "#,
        "photo",
        "http://example.com/tile.png"
    },

    // apple-touch-icon fallback
    apple_touch_icon = {
        r#"
<!DOCTYPE html>
<html>
    <head>
        <meta name="twitter:card" content="summary">
        <meta name="twitter:title" content="Test">
        <link rel="apple-touch-icon" href="/apple-touch-icon.png">
    </head>
    <body>
        <div class="h-entry" id="entry1">
            <span class="p-name">Content</span>
        </div>
    </body>
</html>
        "#,
        "photo",
        "http://example.com/apple-touch-icon.png"
    },

    // MS tile icon with type="image/png"
    ms_tile_icon = {
        r#"
<!DOCTYPE html>
<html>
    <head>
        <meta name="twitter:card" content="summary">
        <meta name="twitter:title" content="Test">
        <link rel="icon" type="image/png" href="/tile.png">
    </head>
    <body>
        <div class="h-entry" id="entry1">
            <span class="p-name">Content</span>
        </div>
    </body>
</html>
        "#,
        "photo",
        "http://example.com/tile.png"
    },
)]
fn parse_metaformats_fallbacks(
    html: &str,
    expected_property: &str,
    expected_value: &str,
) -> Result<(), crate::Error> {
    let mut parser = Parser::from_html(html.to_string())?;
    let result = parser.into_document(Some("http://example.com".parse()?));

    assert!(result.is_ok(), "parsing should succeed");
    let doc = result?;

    assert!(doc.meta_item.is_some(), "meta-item should be created");
    let meta_item = doc.meta_item.as_ref().unwrap();

    let values = meta_item
        .properties
        .get(expected_property)
        .unwrap_or_else(|| panic!("{} property should be present", expected_property));

    assert_eq!(
        values.len(),
        1,
        "{} should have one value",
        expected_property
    );

    let actual_value = match &values[0] {
        PropertyValue::Plain(s) => s.to_string(),
        PropertyValue::Url(u) => u.to_string(),
        PropertyValue::Temporal(t) => t.to_string(),
        _ => panic!("Unexpected property value type"),
    };

    assert_eq!(
        actual_value, expected_value,
        "{} should match expected value",
        expected_property
    );

    Ok(())
}