feat(templs): more on subpages and fixes

fiji-flo · fiji-flo · commit 792c40734bc4 · 2024-08-09T15:07:50.000+02:00
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/crates/diff-test/Cargo.toml b/crates/diff-test/Cargo.toml
@@ -20,3 +20,4 @@ itertools = "0.13"
 similar = "2"
 regex = "1"
 htmldiff = "0.1"
+rayon = "1"
diff --git a/crates/diff-test/src/main.rs b/crates/diff-test/src/main.rs
@@ -4,6 +4,8 @@ use std::fs;
 use std::fs::File;
 use std::io::Write;
 use std::path::Path;
+use std::sync::atomic::AtomicUsize;
+use std::sync::atomic::Ordering::Relaxed;
 use std::sync::LazyLock;
 
 use anyhow::{anyhow, Error};
@@ -14,6 +16,7 @@ use ignore::WalkBuilder;
 use itertools::Itertools;
 use jsonpath_lib::Compiled;
 use prettydiff::diff_words;
+use rayon::prelude::*;
 use regex::Regex;
 use serde_json::Value;
 
@@ -172,6 +175,7 @@ const IGNORE: &[&str] = &[
     "doc.sidebarMacro",
     "doc.hasMathML",
     "doc.other_translations",
+    "doc.summary",
 ];
 
 static WS_DIFF: LazyLock<Regex> =
@@ -287,14 +291,14 @@ fn main() -> Result<(), anyhow::Error> {
             let b = gather(&arg.root_b, arg.query.as_deref())?;
 
             let hits = max(a.len(), b.len());
-            let mut same = 0;
+            let same = AtomicUsize::new(0);
             if arg.html {
                 let mut out = Vec::new();
                 out.push("<ul>".to_string());
-                for (k, v) in a.iter() {
+                out.extend(a.par_iter().filter_map(|(k, v)| {
                     if b.get(k) == Some(v) {
-                        same += 1;
-                        continue;
+                        same.fetch_add(1, Relaxed);
+                        return None;
                     }
 
                     if arg.value {
@@ -303,14 +307,14 @@ fn main() -> Result<(), anyhow::Error> {
                         let mut diff = BTreeMap::new();
                         full_diff(left, right, &[], &mut diff);
                         if !diff.is_empty() {
-                            out.push(format!(
+                            return Some(format!(
                                 r#"<li><span>{k}</span><div class="r"><pre><code>{}</code></pre></div></li>"#,
                                 serde_json::to_string_pretty(&diff).unwrap_or_default(),
                             ));
                         } else {
-                            same += 1;
+                            same.fetch_add(1, Relaxed);
                         }
-                        continue;
+                        None
                     } else {
                         let left = &v.as_str().unwrap_or_default();
                         let right = b
@@ -336,24 +340,29 @@ fn main() -> Result<(), anyhow::Error> {
                         let left = left.replace(broken_link, "");
                         if left == right {
                             println!("only broken links differ");
-                            same += 1;
-                            continue;
+                            same.fetch_add(1, Relaxed);
+                            return None;
                         }
                         if arg.inline {
                             println!("{}", diff_words(&left, right));
                         }
-                        out.push(format!(
+                        Some(format!(
                     r#"<li><span>{k}</span><div class="a">{}</div><div class="b">{}</div></li>"#,
                     left, right
                 ))
                     }
                 }
+                ).collect::<Vec<_>>());
                 out.push("</ul>".to_string());
                 let mut file = File::create(&arg.out)?;
                 file.write_all(html(&out.into_iter().collect::<String>()).as_bytes())?;
             }
 
-            println!("Took: {:?} - {same}/{hits}", start.elapsed());
+            println!(
+                "Took: {:?} - {}/{hits}",
+                start.elapsed(),
+                same.load(Relaxed)
+            );
         }
     }
     Ok(())
diff --git a/crates/rari-doc/src/docs/build.rs b/crates/rari-doc/src/docs/build.rs
@@ -22,7 +22,7 @@ use super::title::{page_title, transform_title};
 use crate::baseline::get_baseline;
 use crate::error::DocError;
 use crate::html::bubble_up::bubble_up_curriculum_page;
-use crate::html::modifier::add_missing_ids;
+use crate::html::modifier::{add_missing_ids, remove_empty_p};
 use crate::html::rewriter::{post_process_html, post_process_inline_sidebar};
 use crate::html::sections::{split_sections, BuildSection, BuildSectionType, Splitted};
 use crate::html::sidebar::{
@@ -153,6 +153,7 @@ pub fn build_content<T: PageLike>(page: &T) -> Result<PageContent, DocError> {
     if page.page_type() == PageType::Curriculum {
         bubble_up_curriculum_page(&mut fragment)?;
     }
+    remove_empty_p(&mut fragment)?;
     add_missing_ids(&mut fragment)?;
     expand_details_and_mark_current_for_inline_sidebar(&mut fragment, page.url())?;
     let Splitted {
diff --git a/crates/rari-doc/src/helpers/subpages.rs b/crates/rari-doc/src/helpers/subpages.rs
@@ -61,7 +61,7 @@ impl SubPagesSorter {
 }
 
 pub fn write_li_with_badges(
-    out: &mut impl Write,
+    out: &mut String,
     page: &Page,
     locale: Locale,
     closed: bool,
@@ -77,6 +77,14 @@ pub fn write_li_with_badges(
         locale_page.url(),
         html_escape::encode_safe(locale_page.short_title().unwrap_or(locale_page.title()))
     )?;
+    add_inline_badges(out, page, locale)?;
+    if closed {
+        write!(out, "</li>")?;
+    }
+    Ok(())
+}
+
+pub fn add_inline_badges(out: &mut String, page: &Page, locale: Locale) -> Result<(), DocError> {
     if page.status().contains(&FeatureStatus::Experimental) {
         write_experimental(out, locale)?;
     }
@@ -86,9 +94,6 @@ pub fn write_li_with_badges(
     if page.status().contains(&FeatureStatus::Deprecated) {
         write_deprecated(out, locale)?;
     }
-    if closed {
-        write!(out, "</li>")?;
-    }
     Ok(())
 }
 
@@ -101,11 +106,11 @@ pub fn list_sub_pages_reverse_internal(
 ) -> Result<(), DocError> {
     let sub_pages = get_sub_pages(url, Some(1), sorter.unwrap_or_default())?;
 
-    for sub_page in sub_pages {
+    for sub_page in sub_pages.iter().rev() {
         if !page_types.is_empty() && !page_types.contains(&sub_page.page_type()) {
             continue;
         }
-        write_li_with_badges(out, &sub_page, locale, true)?;
+        write_li_with_badges(out, sub_page, locale, true)?;
     }
     Ok(())
 }
diff --git a/crates/rari-doc/src/html/links.rs b/crates/rari-doc/src/html/links.rs
@@ -41,9 +41,7 @@ pub fn render_internal_link(
     if modifier.code {
         out.push_str("<code>");
     }
-    let content = html_escape::decode_html_entities(content);
-    let content = html_escape::encode_safe(&content);
-    out.push_str(&content);
+    out.push_str(content);
     if modifier.code {
         out.push_str("</code>");
     }
@@ -67,7 +65,14 @@ pub fn render_link_from_page(
     page: &Page,
     modifier: &LinkModifier,
 ) -> Result<(), DocError> {
-    let content = html_escape::encode_safe(page.short_title().unwrap_or(page.title()));
+    let content = page.short_title().unwrap_or(page.title());
+    let decoded_content = html_escape::decode_html_entities(content);
+    let encoded_content = html_escape::encode_safe(&decoded_content);
+    let content = if content != encoded_content {
+        Cow::Owned(encoded_content.into_owned())
+    } else {
+        Cow::Borrowed(content)
+    };
     render_internal_link(out, page.url(), None, &content, None, modifier)
 }
 
@@ -91,7 +96,18 @@ pub fn render_link_via_page(
         match RariApi::get_page(url) {
             Ok(page) => {
                 let url = page.url();
-                let content = content.unwrap_or(page.short_title().unwrap_or(page.title()));
+                let content = if let Some(content) = content {
+                    Cow::Borrowed(content)
+                } else {
+                    let content = page.short_title().unwrap_or(page.title());
+                    let decoded_content = html_escape::decode_html_entities(content);
+                    let encoded_content = html_escape::encode_safe(&decoded_content);
+                    if content != encoded_content {
+                        Cow::Owned(encoded_content.into_owned())
+                    } else {
+                        Cow::Borrowed(content)
+                    }
+                };
                 return render_internal_link(
                     out,
                     url,
@@ -100,7 +116,7 @@ pub fn render_link_via_page(
                     } else {
                         Some(anchor)
                     },
-                    content,
+                    &content,
                     title,
                     &LinkModifier {
                         badges: if with_badges { page.status() } else { &[] },
diff --git a/crates/rari-doc/src/html/modifier.rs b/crates/rari-doc/src/html/modifier.rs
@@ -84,3 +84,14 @@ pub fn add_missing_ids(html: &mut Html) -> Result<(), DocError> {
     }
     Ok(())
 }
+
+pub fn remove_empty_p(html: &mut Html) -> Result<(), DocError> {
+    let selector = Selector::parse("p:empty").unwrap();
+    let dels = html.select(&selector).map(|el| el.id()).collect::<Vec<_>>();
+
+    for id in dels {
+        html.tree.get_mut(id).unwrap().detach();
+    }
+
+    Ok(())
+}
diff --git a/crates/rari-doc/src/templ/templs/banners.rs b/crates/rari-doc/src/templ/templs/banners.rs
@@ -80,7 +80,7 @@ pub fn non_standard_header() -> Result<String, DocError> {
     let copy = rari_l10n::l10n_json_data("Template", "non_standard_header_copy", env.locale)?;
 
     Ok([
-        r#"<div class="notecard nonstadard"><p><strong>"#,
+        r#"<div class="notecard nonstandard"><p><strong>"#,
         title,
         ":</strong> ",
         copy,
diff --git a/crates/rari-doc/src/templ/templs/embeds/livesample.rs b/crates/rari-doc/src/templ/templs/embeds/livesample.rs
@@ -5,7 +5,7 @@ use rari_types::AnyArg;
 
 use crate::error::DocError;
 use crate::templ::api::RariApi;
-use crate::utils::trim_ws;
+use crate::utils::dedup_ws;
 
 #[allow(clippy::too_many_arguments)]
 #[rari_f]
@@ -18,7 +18,7 @@ pub fn live_sample(
     _deprecated_5: Option<String>,
     allowed_features: Option<String>,
 ) -> Result<String, DocError> {
-    let title = trim_ws(&id.replace('_', " "));
+    let title = dedup_ws(&id.replace('_', " "));
     let id = RariApi::anchorize(&id);
     let mut out = String::new();
     out.push_str(r#"<div class="code-example"><div class="example-header"></div><iframe class="sample-code-frame" title=""#);
diff --git a/crates/rari-doc/src/templ/templs/glossary.rs b/crates/rari-doc/src/templ/templs/glossary.rs
@@ -2,11 +2,11 @@ use rari_templ_func::rari_f;
 
 use crate::error::DocError;
 use crate::templ::api::RariApi;
-use crate::utils::trim_ws;
+use crate::utils::dedup_ws;
 
 #[rari_f]
 pub fn glossary(term_name: String, display_name: Option<String>) -> Result<String, DocError> {
-    let url = format!("/Glossary/{}", trim_ws(&term_name).replace(' ', "_"));
+    let url = format!("/Glossary/{}", dedup_ws(&term_name).replace(' ', "_"));
     RariApi::link(
         &url,
         Some(env.locale),
diff --git a/crates/rari-doc/src/templ/templs/links/htmlxref.rs b/crates/rari-doc/src/templ/templs/links/htmlxref.rs
@@ -21,7 +21,7 @@ pub fn htmlxref(
             Cow::Borrowed(element_name.as_str())
         } else {
             code = true;
-            Cow::Owned(format!("<{element_name}>"))
+            Cow::Owned(format!("&lt;{element_name}&gt;"))
         }
     });
     let mut url = format!(
diff --git a/crates/rari-doc/src/templ/templs/links/mathmlxref.rs b/crates/rari-doc/src/templ/templs/links/mathmlxref.rs
@@ -6,7 +6,7 @@ use crate::templ::api::RariApi;
 #[rari_f]
 pub fn mathmlxref(element_name: String) -> Result<String, DocError> {
     let element_name = element_name.to_lowercase();
-    let display = format!("<{element_name}>");
+    let display = format!("&lt;{element_name}&gt;");
     let url = format!(
         "/{}/docs/Web/MathML/Element/{}",
         env.locale.as_url_str(),
diff --git a/crates/rari-doc/src/templ/templs/links/svgxref.rs b/crates/rari-doc/src/templ/templs/links/svgxref.rs
@@ -11,7 +11,7 @@ pub fn svgxref(element_name: String, _: Option<AnyArg>) -> Result<String, DocErr
 }
 
 pub fn svgxref_internal(element_name: &str, locale: Locale) -> Result<String, DocError> {
-    let display = format!("<{element_name}>");
+    let display = format!("&lt;{element_name}&gt;");
     let url = format!(
         "/{}/docs/Web/SVG/Element/{}",
         locale.as_url_str(),
diff --git a/crates/rari-doc/src/templ/templs/list_subpages_for_sidebar.rs b/crates/rari-doc/src/templ/templs/list_subpages_for_sidebar.rs
@@ -0,0 +1,60 @@
+use rari_templ_func::rari_f;
+use rari_types::AnyArg;
+
+use crate::docs::page::{
+    url_path_to_page, url_path_to_page_with_other_locale_and_fallback, PageLike,
+};
+use crate::error::DocError;
+use crate::helpers::subpages::{add_inline_badges, get_sub_pages, SubPagesSorter};
+
+/// List sub pages for sidebar
+#[rari_f]
+pub fn list_subpages_for_sidebar(
+    url: String,
+    no_code: Option<AnyArg>,
+    include_parent: Option<AnyArg>,
+    title_only_after: Option<String>,
+    title_only_before: Option<String>,
+) -> Result<String, DocError> {
+    let mut out = String::new();
+    let include_parent = include_parent.map(|i| i.as_bool()).unwrap_or_default();
+    let mut sub_pages = get_sub_pages(&url, Some(1), SubPagesSorter::Title)?;
+    if sub_pages.is_empty() && !include_parent {
+        return Ok(out);
+    }
+    let code = !no_code.map(|b| b.as_bool()).unwrap_or_default();
+    if include_parent {
+        let parent = url_path_to_page(&url)?;
+        sub_pages.insert(0, parent);
+    }
+
+    out.push_str("<ol>");
+    for page in sub_pages {
+        let locale_page = if env.locale != Default::default() {
+            &url_path_to_page_with_other_locale_and_fallback(page.url(), Some(env.locale))?
+        } else {
+            &page
+        };
+        let title = locale_page.short_title().unwrap_or(locale_page.title());
+        let title = &title[title
+            .find(title_only_after.as_deref().unwrap_or_default())
+            .unwrap_or(0)..];
+        let title = &title[..=title
+            .find(title_only_before.as_deref().unwrap_or_default())
+            .unwrap_or(title.len())];
+        out.extend([
+            r#"<li><a href=""#,
+            locale_page.url(),
+            r#"">"#,
+            if code { "<code>" } else { "" },
+            &html_escape::encode_safe(title),
+            if code { "</code>" } else { "" },
+            r#"</a>"#,
+        ]);
+        add_inline_badges(&mut out, &page, env.locale)?;
+        out.push_str("</li>");
+    }
+    out.push_str("</ol>");
+
+    Ok(out)
+}
diff --git a/crates/rari-doc/src/templ/templs/mod.rs b/crates/rari-doc/src/templ/templs/mod.rs
@@ -11,11 +11,13 @@ pub mod inheritance_diagram;
 pub mod inline_labels;
 pub mod js_property_attributes;
 pub mod links;
+pub mod list_subpages_for_sidebar;
 pub mod listsubpages;
 pub mod previous_menu_next;
 pub mod quick_links_with_subpages;
 pub mod sidebars;
 pub mod specification;
+pub mod subpages_with_summaries;
 pub mod svginfo;
 pub mod web_ext_examples;
 pub mod xsltref;
@@ -75,6 +77,10 @@ pub fn invoke(
 
         // hacky
         "glossarydisambiguation" => glossarydisambiguation::glossarydisambiguation_any,
+        "listsubpagesforsidebar" => list_subpages_for_sidebar::list_subpages_for_sidebar_any,
+        "subpageswithsummaries" | "landingpagelistsubpages" => {
+            subpages_with_summaries::subpages_with_summaries_any
+        }
 
         // prev menu next
         "previousmenunext" => previous_menu_next::previous_next_menu_any,
diff --git a/crates/rari-doc/src/templ/templs/subpages_with_summaries.rs b/crates/rari-doc/src/templ/templs/subpages_with_summaries.rs
diff --git a/crates/rari-doc/src/utils.rs b/crates/rari-doc/src/utils.rs
diff --git a/crates/rari-md/src/anchor.rs b/crates/rari-md/src/anchor.rs
