lectito 0.3.0

Article extraction and readability parsing for Lectito.
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
448
449
450
use kuchiki::NodeRef;
use kuchiki::traits::TendrilSink;

use super::RenderContext;
use crate::{dom, patterns};

pub fn normalize_code_markup(root: &NodeRef) {
    remove_code_chrome(root);
    normalize_code_tables(root);
    normalize_standalone_code_containers(root);
    normalize_pre_blocks(root);
}

pub(super) fn render_code_block(node: &NodeRef, _ctx: RenderContext) -> String {
    CodeBlock::from_node(node).fenced_code_block()
}

pub(super) fn render_code_table(node: &NodeRef, _ctx: RenderContext) -> Option<String> {
    Some(CodeBlock::from_table(node)?.fenced_code_block())
}

pub(super) fn render_code_container(node: &NodeRef, ctx: RenderContext) -> Option<String> {
    if !is_standalone_code_container(node) {
        return None;
    }

    if let Some(pre) = dom::select_nodes(node, "pre").into_iter().next() {
        return Some(render_code_block(&pre, ctx));
    }

    let language = get_lang_id(node);
    let code = code_text(node);
    if code.trim().is_empty() {
        return None;
    }

    Some(CodeBlock::new(language, code).fenced_code_block())
}

fn code_text(node: &NodeRef) -> String {
    let line_nodes = code_line_nodes(node);
    if !line_nodes.is_empty() {
        return line_nodes
            .iter()
            .map(|line| code_text_fragment(line).trim_end().to_string())
            .collect::<Vec<_>>()
            .join("\n");
    }
    code_text_fragment(node)
}

fn code_line_nodes(root: &NodeRef) -> Vec<NodeRef> {
    dom::select_nodes(root, "*")
        .into_iter()
        .filter(is_code_line_node)
        .filter(|node| !has_code_line_ancestor(node, root))
        .collect()
}

fn has_code_line_ancestor(node: &NodeRef, root: &NodeRef) -> bool {
    let root_id = dom::node_id(root);
    let mut parent = node.parent();
    while let Some(ancestor) = parent {
        if dom::node_id(&ancestor) == root_id {
            return false;
        }
        if is_code_line_node(&ancestor) {
            return true;
        }
        parent = ancestor.parent();
    }
    false
}

fn code_text_fragment(node: &NodeRef) -> String {
    if let Some(text) = node.as_text() {
        return text.borrow().to_string();
    }

    if is_highlighter_chrome(node) || is_line_number_node(node) {
        return String::new();
    }

    if dom::node_name(node) == "br" {
        return "\n".to_string();
    }

    let mut output = String::new();
    for child in node.children() {
        output.push_str(&code_text_fragment(&child));
    }
    output
}

fn get_lang_id(node: &NodeRef) -> Option<String> {
    for attr in ["data-lang", "data-language", "language", "lang"] {
        if let Some(language) = dom::attr(node, attr).and_then(|value| clean_lang_id(&value)) {
            return Some(language);
        }
    }

    let class = dom::attr(node, "class")?;
    language_from_class(&class)
}

fn ancestor_lang_id(node: &NodeRef) -> Option<String> {
    node.ancestors()
        .skip(1)
        .take(4)
        .find_map(|ancestor| get_lang_id(&ancestor))
}

fn language_from_class(class: &str) -> Option<String> {
    class
        .split_whitespace()
        .find_map(clean_language_class)
        .or_else(|| class.split_once("brush:").and_then(|(_, value)| clean_lang_id(value)))
}

fn clean_language_class(class: &str) -> Option<String> {
    let value = class
        .strip_prefix("language-")
        .or_else(|| class.strip_prefix("lang-"))
        .or_else(|| class.strip_prefix("highlight-source-"))
        .or_else(|| class.strip_prefix("brush:"))
        .or_else(|| class.strip_prefix("syntax--"))?;
    clean_lang_id(value)
}

fn clean_lang_id(value: &str) -> Option<String> {
    let value = value
        .trim()
        .trim_matches(|c: char| c == ';' || c == ':' || c == ',' || c == '"' || c == '\'')
        .to_ascii_lowercase();
    let value = value
        .split_whitespace()
        .find(|part| !matches!(*part, "notranslate" | "highlight" | "syntax"))
        .unwrap_or_default()
        .trim_matches(|c: char| c == ';' || c == ':' || c == ',' || c == '"' || c == '\'');
    if value.is_empty() || matches!(value, "none" | "text" | "plain" | "plaintext") {
        None
    } else {
        Some(value.to_string())
    }
}

fn is_standalone_code_container(node: &NodeRef) -> bool {
    let class = dom::attr(node, "class").unwrap_or_default().to_ascii_lowercase();
    has_class_token(node, "codemirror-code")
        || has_class_token(node, "cm-content")
        || class.split_whitespace().any(|part| part == "sourcecode")
        || class.contains("react-syntax-highlighter")
        || class.contains("highlight")
        || class.contains("codeblock")
        || class.contains("code-block")
        || class.contains("codehilite")
}

fn is_code_line_node(node: &NodeRef) -> bool {
    if is_line_number_node(node) || is_highlighter_chrome(node) {
        return false;
    }
    let class = dom::attr(node, "class").unwrap_or_default();
    has_class_token_value(&class, "cm-line")
        || has_class_token_value(&class, "token-line")
        || has_class_token_value(&class, "line")
        || has_class_token_value(&class, "cl")
        || has_class_token_value(&class, "code-line")
        || dom::attr(node, "data-line").is_some()
}

fn is_line_number_node(node: &NodeRef) -> bool {
    let class = dom::attr(node, "class").unwrap_or_default();
    [
        "lineno",
        "linenos",
        "line-number",
        "line-numbers-rows",
        "line-numbers",
        "gutter",
        "rouge-gutter",
        "code-gutter",
        "highlight-line",
        "ln",
    ]
    .iter()
    .any(|token| has_class_token_value(&class, token))
}

pub(super) fn is_highlighter_chrome(node: &NodeRef) -> bool {
    let tag = dom::node_name(node);
    let class = dom::attr(node, "class").unwrap_or_default().to_ascii_lowercase();
    let id = dom::attr(node, "id").unwrap_or_default().to_ascii_lowercase();
    let role = dom::attr(node, "role").unwrap_or_default().to_ascii_lowercase();
    let chrome = [
        "toolbar",
        "copy-button",
        "clipboard",
        "filename",
        "language-name",
        "code-header",
        "code-title",
        "codemirror-gutters",
        "cm-gutters",
        "gutter-wrapper",
    ];
    if class.contains("code-toolbar") && dom::select_nodes(node, "pre").is_empty() {
        return true;
    }
    if chrome.iter().any(|needle| {
        if *needle == "toolbar" {
            has_class_token_value(&class, needle) || id == "toolbar"
        } else {
            class.contains(needle) || id.contains(needle)
        }
    }) {
        return true;
    }
    if role == "toolbar" {
        return true;
    }
    tag == "button" && is_copy_label(node)
}

fn is_copy_label(node: &NodeRef) -> bool {
    let label = dom::attr(node, "aria-label")
        .or_else(|| dom::attr(node, "title"))
        .unwrap_or_else(|| node.text_contents());
    matches!(
        patterns::normalize_spaces(&label).to_ascii_lowercase().as_str(),
        "copy" | "copy code" | "copied" | "copied!"
    )
}

fn has_class_token(node: &NodeRef, token: &str) -> bool {
    dom::attr(node, "class").is_some_and(|class| has_class_token_value(&class, token))
}

fn has_class_token_value(class: &str, token: &str) -> bool {
    class.split_whitespace().any(|part| part.eq_ignore_ascii_case(token))
}

fn remove_code_chrome(root: &NodeRef) {
    for node in dom::select_nodes(root, "*") {
        if is_highlighter_chrome(&node) || is_line_number_node(&node) {
            node.detach();
        }
    }
}

fn normalize_code_tables(root: &NodeRef) {
    for table in dom::select_nodes(root, "table") {
        let Some(code) = CodeBlock::from_table(&table) else {
            continue;
        };
        replace_with_pre(&table, code.language.as_deref(), &code.text);
    }
}

fn normalize_standalone_code_containers(root: &NodeRef) {
    for node in dom::select_nodes(root, "div") {
        if dom::select_nodes(&node, "pre").is_empty() && is_standalone_code_container(&node) {
            let code = CodeBlock { language: get_lang_id(&node), text: code_text(&node) };
            if !code.text.trim().is_empty() {
                replace_with_pre(&node, code.language.as_deref(), &code.text);
            }
        }
    }
}

fn normalize_pre_blocks(root: &NodeRef) {
    for pre in dom::select_nodes(root, "pre") {
        let code_node = dom::select_nodes(&pre, "code").into_iter().next();
        let language = get_lang_id(&pre)
            .or_else(|| code_node.as_ref().and_then(get_lang_id))
            .or_else(|| ancestor_lang_id(&pre));
        let text = code_text(code_node.as_ref().unwrap_or(&pre));
        replace_with_pre(&pre, language.as_deref(), text.trim_matches('\n'));
    }
}

struct CodeBlock {
    language: Option<String>,
    text: String,
}

impl CodeBlock {
    fn new(language: Option<String>, text: String) -> Self {
        Self { language, text }
    }

    fn from_node(node: &NodeRef) -> Self {
        let code_node = dom::select_nodes(node, "code").into_iter().next();
        Self::new(
            get_lang_id(node)
                .or_else(|| code_node.as_ref().and_then(get_lang_id))
                .or_else(|| ancestor_lang_id(node)),
            code_text(code_node.as_ref().unwrap_or(node)),
        )
    }

    fn from_table(node: &NodeRef) -> Option<CodeBlock> {
        if !(has_class_token(node, "highlighttable")
            || has_class_token(node, "rouge-table")
            || has_class_token(node, "highlight")
            || !dom::select_nodes(node, "td.linenos, td.rouge-gutter, td.gutter, td.code, td.rouge-code").is_empty())
        {
            return None;
        }

        let code_cell = dom::select_nodes(node, "td.code, td.rouge-code")
            .into_iter()
            .next()
            .or_else(|| {
                dom::select_nodes(node, "td")
                    .into_iter()
                    .filter(|cell| !is_line_number_node(cell))
                    .max_by_key(|cell| code_text(cell).trim().len())
            })?;
        let text = code_text(&code_cell);
        (!text.trim().is_empty())
            .then(|| CodeBlock { language: get_lang_id(node).or_else(|| get_lang_id(&code_cell)), text })
    }

    fn code(&self) -> String {
        self.text.trim_matches('\n').to_string()
    }

    fn language(&self) -> &str {
        self.language.as_deref().unwrap_or_default()
    }

    fn fenced_code_block(&self) -> String {
        let longest_run = self
            .code()
            .lines()
            .flat_map(|line| line.split(|c| c != '`').map(str::len))
            .max()
            .unwrap_or(0);

        format!(
            r#"{fence}{lang}
{code}
{fence}"#,
            lang = self.language(),
            fence = "`".repeat(longest_run.max(3)),
            code = self.code()
        )
    }
}

fn replace_with_pre(node: &NodeRef, language: Option<&str>, text: &str) {
    let fragment = kuchiki::parse_html().one("<html><body><pre><code></code></pre></body></html>");
    let Some(pre) = dom::select_nodes(&fragment, "pre").into_iter().next() else {
        return;
    };
    let Some(code) = dom::select_nodes(&pre, "code").into_iter().next() else {
        return;
    };
    if let Some(language) = language {
        dom::set_attr(&pre, "data-language", language);
        dom::set_attr(&code, "data-language", language);
    }
    code.append(NodeRef::new_text(text.to_string()));
    node.insert_before(pre);
    node.detach();
}

#[cfg(test)]
mod tests {
    use crate::markdown::html_to_markdown;

    #[test]
    fn preserves_code_fence_languages() {
        let markdown = html_to_markdown(
            r#"<pre data-lang="Rust"><code class="language-rust"><span class="token keyword">fn</span> main() {}</code></pre>"#,
        );

        assert!(markdown.contains("```rust\nfn main() {}\n```"), "{markdown}");
    }

    #[test]
    fn strips_code_block_chrome_and_line_numbers() {
        let markdown = html_to_markdown(
            r#"<div class="code-toolbar"><pre class="language-js"><code><span class="line"><span class="line-number">1</span><span class="token keyword">const</span> value = 1;</span><span class="line"><span class="line-number">2</span>console.log(value);</span></code></pre><div class="toolbar"><button>Copy code</button></div></div>"#,
        );

        assert!(
            markdown.contains("```js\nconst value = 1;\nconsole.log(value);\n```"),
            "{markdown}"
        );
        assert!(!markdown.contains("Copy"), "{markdown}");
        assert!(!markdown.contains("\n1const"), "{markdown}");
    }

    #[test]
    fn normalizes_pygments_rouge_code_tables() {
        let markdown = html_to_markdown(
            r#"<table class="highlighttable language-python"><tr><td class="linenos"><div>1<br>2</div></td><td class="code"><pre><span></span>def hello():
    return "world"</pre></td></tr></table>"#,
        );

        assert!(
            markdown.contains("```python\ndef hello():\n    return \"world\"\n```"),
            "{markdown}"
        );
        assert!(!markdown.contains("| --- |"), "{markdown}");
        assert!(!markdown.contains("1\n2"), "{markdown}");
    }

    #[test]
    fn normalizes_codemirror_line_containers() {
        let markdown = html_to_markdown(
            r#"<div class="cm-content language-ts"><div class="cm-line"><span class="cm-keyword">type</span> User = { id: string };</div><div class="cm-line">export default User;</div></div>"#,
        );

        assert!(
            markdown.contains("```ts\ntype User = { id: string };\nexport default User;\n```"),
            "{markdown}"
        );
    }

    #[test]
    fn inherits_language_from_code_block_wrapper() {
        let markdown = html_to_markdown(
            r#"<div language="jsx" numberoflines="4"><div data-component-part="code-block-root"><div><pre><code>export const Button = () =&gt; (
  &lt;button&gt;Save&lt;/button&gt;
);</code></pre></div></div></div>"#,
        );

        assert!(
            markdown.contains("```jsx\nexport const Button = () => (\n  <button>Save</button>\n);\n```"),
            "{markdown}"
        );
    }

    #[test]
    fn normalizes_mdn_language_classes_and_labels() {
        let markdown = html_to_markdown(
            r#"<div class="code-example"><div class="example-header"><span class="language-name">JavaScript</span></div><pre class="brush: js notranslate"><code>const proxy = new Proxy(target, handler);</code></pre></div>"#,
        );

        assert!(
            markdown.contains("```js\nconst proxy = new Proxy(target, handler);\n```"),
            "{markdown}"
        );
        assert!(!markdown.contains("JavaScript"), "{markdown}");
        assert!(!markdown.contains("notranslate"), "{markdown}");
    }
}