feat(templs): many

- inheritance diagram
- web ext examples

and fixes

Author: fiji-flo

Diff for: crates/rari-deps/src/external_json.rs

@@ -0,0 +1,43 @@
+use std::fs::{self, File};
+use std::io::{BufWriter, Write};
+use std::path::{Path, PathBuf};
+
+use chrono::{DateTime, Duration, Utc};
+use serde::{Deserialize, Serialize};
+
+use crate::error::DepsError;
+
+#[derive(Deserialize, Serialize, Default, Debug)]
+pub struct LastChecked {
+    pub latest_last_check: Option<DateTime<Utc>>,
+}
+
+pub fn get_json(name: &str, url: &str, out_path: &Path) -> Result<Option<PathBuf>, DepsError> {
+    let package_path = out_path.join(name);
+    let last_check_path = package_path.join("last_check.json");
+    let now = Utc::now();
+    let current = fs::read_to_string(last_check_path)
+        .ok()
+        .and_then(|current| serde_json::from_str::<LastChecked>(&current).ok())
+        .unwrap_or_default();
+    if current.latest_last_check.unwrap_or_default() < now - Duration::days(1) {
+        if package_path.exists() {
+            fs::remove_dir_all(&package_path)?;
+        }
+        fs::create_dir_all(&package_path)?;
+        let buf = reqwest::blocking::get(url)?.bytes()?;
+
+        let out_file = package_path.join("data.json");
+        let file = File::create(out_file).unwrap();
+        let mut buffed = BufWriter::new(file);
+        buffed.write_all(buf.as_ref())?;
+
+        fs::write(
+            package_path.join("last_check.json"),
+            serde_json::to_string_pretty(&LastChecked {
+                latest_last_check: Some(now),
+            })?,
+        )?;
+    }
+    Ok(None)
+}

Diff for: crates/rari-deps/src/lib.rs

@@ -1,6 +1,8 @@
 pub mod bcd;
 pub mod error;
+pub mod external_json;
 pub mod mdn_data;
 pub mod npm;
+pub mod web_ext_examples;
 pub mod web_features;
 pub mod webref_css;

Diff for: crates/rari-deps/src/web_ext_examples.rs

@@ -0,0 +1,13 @@
+use std::path::Path;
+
+use crate::error::DepsError;
+use crate::external_json::get_json;
+
+pub fn update_web_ext_examples(base_path: &Path) -> Result<(), DepsError> {
+    get_json(
+        "web_ext_examples",
+        "https://raw.githubusercontent.com/mdn/webextensions-examples/main/examples.json",
+        base_path,
+    )?;
+    Ok(())
+}

Diff for: crates/rari-doc/src/helpers/api_inheritance.rs

@@ -0,0 +1,17 @@
+use super::json_data::json_data_interface;
+
+pub fn inheritance(main_if: &str) -> Vec<&str> {
+    let web_api_data = json_data_interface();
+    let mut inherited = vec![];
+
+    let mut interface = main_if;
+    while let Some(inherited_data) = web_api_data
+        .get(interface)
+        .map(|data| data.inh.as_str())
+        .filter(|ihn| !ihn.is_empty())
+    {
+        inherited.push(inherited_data);
+        interface = inherited_data;
+    }
+    inherited
+}

Diff for: crates/rari-doc/src/helpers/mod.rs

@@ -1,4 +1,6 @@
+pub mod api_inheritance;
 pub mod css_info;
 pub mod json_data;
 pub mod subpages;
 pub mod titles;
+pub mod web_ext_examples;

Diff for: crates/rari-doc/src/helpers/web_ext_examples.rs

@@ -0,0 +1,64 @@
+use std::collections::HashMap;
+use std::fs::read_to_string;
+
+use once_cell::sync::Lazy;
+use rari_types::globals::data_dir;
+use serde::Deserialize;
+use tracing::warn;
+
+use crate::error::DocError;
+
+#[derive(Deserialize, Debug, Clone)]
+pub struct WebExtExample {
+    pub description: String,
+    pub javascript_apis: Vec<String>,
+    pub name: String,
+}
+
+pub struct WebExtExamplesData {
+    pub by_module: HashMap<&'static str, Vec<&'static WebExtExample>>,
+    pub by_module_and_api: HashMap<&'static str, Vec<&'static WebExtExample>>,
+}
+
+pub static WEB_EXT_EXAMPLES_JSON: Lazy<Vec<WebExtExample>> = Lazy::new(|| {
+    match read_to_string(data_dir().join("web_ext_examples/data.json"))
+        .map_err(DocError::from)
+        .and_then(|s| serde_json::from_str(&s).map_err(DocError::from))
+    {
+        Ok(data) => data,
+        Err(e) => {
+            warn!("Error loading mdn/data: {e}");
+            Default::default()
+        }
+    }
+});
+
+pub fn web_ext_examples_json() -> &'static [WebExtExample] {
+    &WEB_EXT_EXAMPLES_JSON
+}
+
+pub static WEB_EXT_EXAMPLES_DATA: Lazy<WebExtExamplesData> = Lazy::new(|| {
+    let mut by_module = HashMap::new();
+    for example in web_ext_examples_json() {
+        for js_api in &example.javascript_apis {
+            let js_api = &js_api[..js_api.find('.').unwrap_or(js_api.len())];
+            by_module
+                .entry(js_api)
+                .and_modify(|e: &mut Vec<_>| e.push(example))
+                .or_insert(vec![example]);
+        }
+    }
+    let mut by_module_and_api = HashMap::new();
+    for example in web_ext_examples_json() {
+        for js_api in &example.javascript_apis {
+            by_module_and_api
+                .entry(js_api.as_str())
+                .and_modify(|e: &mut Vec<_>| e.push(example))
+                .or_insert(vec![example]);
+        }
+    }
+    WebExtExamplesData {
+        by_module,
+        by_module_and_api,
+    }
+});

Diff for: crates/rari-doc/src/html/modifier.rs

@@ -1,7 +1,7 @@
 use ego_tree::NodeId;
 use html5ever::{namespace_url, ns, QualName};
 use rari_md::anchor::anchorize;
-use scraper::{Html, Node, Selector};
+use scraper::{ElementRef, Html, Node, Selector};
 
 use crate::error::DocError;
 
@@ -20,25 +20,37 @@ pub fn add_attribute(html: &mut Html, node_id: NodeId, key: &str, value: &str) {
     }
 }
 
+pub fn remove_attribute(html: &mut Html, node_id: NodeId, key: &str) {
+    if let Some(mut details) = html.tree.get_mut(node_id) {
+        if let Node::Element(ref mut el) = details.value() {
+            el.attrs.swap_remove(&QualName {
+                prefix: None,
+                ns: ns!(),
+                local: key.into(),
+            });
+        }
+    }
+}
+
 pub fn add_missing_ids(html: &mut Html) -> Result<(), DocError> {
-    let a_selector = Selector::parse("*[id=---update-id]").unwrap();
-    let subs = html
-        .select(&a_selector)
-        .map(|el| {
-            let text = if let Some(text) = el
-                .first_child()
-                .and_then(|child| child.value().as_text().map(|t| t.to_string()))
-            {
-                text
-            } else {
-                el.text().collect::<String>()
-            };
-            let id = anchorize(&text);
-            (el.id(), id)
-        })
-        .collect::<Vec<_>>();
+    let selector = Selector::parse("*[data-update-id], h2:not([id]), h3:not([id])").unwrap();
+    let subs =
+        html.select(&selector)
+            .map(|el| {
+                let text = if let Some(text) = el.first_child().and_then(|child| {
+                    ElementRef::wrap(child).map(|el| el.text().collect::<String>())
+                }) {
+                    text
+                } else {
+                    el.text().collect::<String>()
+                };
+                let id = anchorize(&text);
+                (el.id(), id)
+            })
+            .collect::<Vec<_>>();
     for (el_id, id) in subs {
         add_attribute(html, el_id, "id", &id);
+        remove_attribute(html, el_id, "data-update-id");
     }
     Ok(())
 }

Diff for: crates/rari-doc/src/sidebars/apiref.rs

@@ -6,7 +6,8 @@ use tracing::error;
 use crate::docs::doc::Doc;
 use crate::docs::page::{Page, PageLike};
 use crate::error::DocError;
-use crate::helpers::json_data::{json_data_group, json_data_interface};
+use crate::helpers::api_inheritance::inheritance;
+use crate::helpers::json_data::json_data_group;
 use crate::helpers::subpages::{get_sub_pages, SubPagesSorter};
 use crate::helpers::titles::api_page_title;
 use crate::html::sidebar::{
@@ -37,7 +38,6 @@ pub fn sidebar(slug: &str, group: Option<&str>, locale: Locale) -> Result<MetaSi
         return Err(DocError::InvalidSlugForX(slug.to_string()));
     }
 
-    let web_api_data = json_data_interface();
     let web_api_groups = group.and_then(|group| json_data_group().get(group));
 
     let main_if_pages = get_sub_pages(
@@ -82,17 +82,7 @@ pub fn sidebar(slug: &str, group: Option<&str>, locale: Locale) -> Result<MetaSi
         v.push(page);
     }
 
-    let mut inherited = vec![];
-
-    let mut interface = main_if;
-    while let Some(inherited_data) = web_api_data
-        .get(interface)
-        .map(|data| data.inh.as_str())
-        .filter(|ihn| !ihn.is_empty())
-    {
-        inherited.push(inherited_data);
-        interface = inherited_data;
-    }
+    let inherited = inheritance(main_if);
 
     let mut entries = vec![];
 

Diff for: crates/rari-doc/src/templ/templs/badges.rs

@@ -24,12 +24,6 @@ pub fn deprecated() -> Result<String, DocError> {
     Ok(out)
 }
 
-#[rari_f]
-pub fn readonly() -> Result<String, DocError> {
-    let mut out = String::new();
-    write_readonly(&mut out, env.locale)?;
-    Ok(out)
-}
 #[rari_f]
 pub fn optional() -> Result<String, DocError> {
     let str = rari_l10n::l10n_json_data("Template", "optional", env.locale)?;
@@ -62,14 +56,6 @@ pub fn write_deprecated(out: &mut impl std::fmt::Write, locale: Locale) -> Resul
     Ok(write_badge(out, title, abbreviation, "deprecated")?)
 }
 
-pub fn write_readonly(out: &mut impl std::fmt::Write, locale: Locale) -> Result<(), DocError> {
-    let title = rari_l10n::l10n_json_data("Template", "readonly_badge_title", locale)?;
-    let abbreviation =
-        rari_l10n::l10n_json_data("Template", "readonly_badge_abbreviation", locale)?;
-
-    Ok(write_badge(out, title, abbreviation, "readonly")?)
-}
-
 pub fn write_badge(
     out: &mut impl std::fmt::Write,
     title: &str,

Diff for: crates/rari-doc/src/templ/templs/banners.rs

@@ -13,11 +13,11 @@ pub fn deprecated_header(version: Option<AnyArg>) -> Result<String, DocError> {
     let copy = rari_l10n::l10n_json_data("Template", "deprecated_header_copy", env.locale)?;
 
     Ok([
-        r#"<div class="notecard deprecated"><strong>"#,
+        r#"<div class="notecard deprecated"><p><strong>"#,
         title,
         ":</strong> ",
         copy,
-        "</div>",
+        "</p></div>",
     ]
     .join(""))
 }