feat(spas): initial support for spas

starting with contributor spotlight.

Author: fiji-flo

Diff for: crates/rari-doc/src/build.rs

@@ -8,10 +8,13 @@ use rayon::iter::{IntoParallelIterator, ParallelIterator};
 use tracing::{error, span, Level};
 
 use crate::cached_readers::{blog_files, curriculum_files};
-use crate::docs::build::{build_blog_post, build_curriculum, build_doc, build_dummy};
-use crate::docs::dummy::Dummy;
-use crate::docs::page::{Page, PageLike};
 use crate::error::DocError;
+use crate::pages::build::{
+    build_blog_post, build_contributor_spotlight, build_curriculum, build_doc, build_dummy,
+    copy_additional_files,
+};
+use crate::pages::page::{Page, PageLike};
+use crate::pages::types::dummy::Dummy;
 use crate::resolve::url_to_path_buf;
 
 pub fn build_single_page(page: &Page) {
@@ -24,6 +27,7 @@ pub fn build_single_page(page: &Page) {
         Page::BlogPost(post) => build_blog_post(post),
         Page::Dummy(dummy) => build_dummy(dummy),
         Page::Curriculum(curriculum) => build_curriculum(curriculum),
+        Page::ContributorSpotlight(cs) => build_contributor_spotlight(cs),
     };
     match built_page {
         Ok(built_page) => {
@@ -36,6 +40,10 @@ pub fn build_single_page(page: &Page) {
             let buffed = BufWriter::new(file);
 
             serde_json::to_writer(buffed, &built_page).unwrap();
+
+            if let Some(in_path) = page.full_path().parent() {
+                copy_additional_files(in_path, &out_path).unwrap();
+            }
         }
         Err(e) => {
             error!("Error: {e}");

Diff for: crates/rari-doc/src/cached_readers.rs

@@ -10,12 +10,12 @@ use rari_types::locale::Locale;
 use rari_utils::io::read_to_string;
 use tracing::error;
 
-use crate::docs::blog::{Author, AuthorFrontmatter, BlogPost, BlogPostBuildMeta};
-use crate::docs::curriculum::{CurriculumIndexEntry, CurriculumPage};
-use crate::docs::doc::Doc;
-use crate::docs::page::{Page, PageLike};
 use crate::error::DocError;
 use crate::html::sidebar::{MetaSidebar, Sidebar};
+use crate::pages::page::{Page, PageLike};
+use crate::pages::types::blog::{Author, AuthorFrontmatter, BlogPost, BlogPostBuildMeta};
+use crate::pages::types::curriculum::{CurriculumIndexEntry, CurriculumPage};
+use crate::pages::types::doc::Doc;
 use crate::reader::read_docs_parallel;
 use crate::sidebars::jsref;
 use crate::translations::init_translations_from_static_docs;

Diff for: crates/rari-doc/src/docs/types.rs

@@ -9,7 +9,7 @@ use rari_types::locale::LocaleError;
 use rari_types::ArgError;
 use thiserror::Error;
 
-use crate::docs::page::PageCategory;
+use crate::pages::page::PageCategory;
 
 #[derive(Debug, Error)]
 pub enum DocError {

Diff for: crates/rari-doc/src/error.rs

@@ -9,10 +9,10 @@ use rari_types::globals::deny_warnings;
 use rari_types::locale::Locale;
 
 use super::titles::api_page_title;
-use crate::docs::page::{
+use crate::error::DocError;
+use crate::pages::page::{
     url_path_to_page_with_other_locale_and_fallback, Page, PageLike, PageReader,
 };
-use crate::error::DocError;
 use crate::redirects::resolve_redirect;
 use crate::templ::templs::badges::{write_deprecated, write_experimental, write_non_standard};
 use crate::utils::COLLATOR;
@@ -214,7 +214,7 @@ pub fn get_sub_pages(
         let mut sub_pages = sub_folders
             .iter()
             .filter(|f| f.as_path() != full_path)
-            .map(Page::read)
+            .map(|p| Page::read(p, Some(doc.locale())))
             .collect::<Result<Vec<_>, DocError>>()?;
         sub_pages.sort_by(sorter.sorter());
         return Ok(sub_pages);

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

@@ -1,6 +1,6 @@
-use crate::docs::doc::render_md_to_html;
-use crate::docs::page::{Page, PageLike};
 use crate::error::DocError;
+use crate::pages::page::{Page, PageLike};
+use crate::pages::types::doc::render_md_to_html;
 use crate::templ::render::render_for_summary;
 
 /// There's a few places were we still tansplant content.

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

@@ -1,6 +1,6 @@
 use rari_types::fm_types::PageType;
 
-use crate::docs::page::{Page, PageLike};
+use crate::pages::page::{Page, PageLike};
 
 pub fn api_page_title(page: &Page) -> &str {
     if let Some(short_title) = page.short_title() {

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

@@ -2,11 +2,11 @@ use rari_l10n::l10n_json_data;
 use rari_types::fm_types::PageType;
 use rari_types::locale::Locale;
 
-use crate::docs::page::{Page, PageLike};
 use crate::error::DocError;
 use crate::helpers::subpages::{get_sub_pages, SubPagesSorter};
 use crate::helpers::titles::api_page_title;
 use crate::html::sidebar::{Details, MetaChildren, SidebarMetaEntry, SidebarMetaEntryContent};
+use crate::pages::page::{Page, PageLike};
 
 pub fn entry(slug: &str, locale: Locale) -> Result<Vec<SidebarMetaEntry>, DocError> {
     let properties_label = l10n_json_data("Common", "Properties", locale)?;

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

@@ -5,8 +5,8 @@ use rari_types::fm_types::FeatureStatus;
 use rari_types::locale::Locale;
 use tracing::warn;
 
-use crate::docs::page::{Page, PageLike};
 use crate::error::DocError;
+use crate::pages::page::{Page, PageLike};
 use crate::templ::api::RariApi;
 use crate::templ::templs::badges::{write_deprecated, write_experimental, write_non_standard};
 

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

@@ -9,9 +9,9 @@ use rari_types::fm_types::PageType;
 use rari_types::locale::Locale;
 use url::Url;
 
-use crate::docs::curriculum::relative_file_to_curriculum_page;
-use crate::docs::page::{Page, PageLike};
 use crate::error::DocError;
+use crate::pages::page::{Page, PageLike};
+use crate::pages::types::curriculum::relative_file_to_curriculum_page;
 use crate::redirects::resolve_redirect;
 use crate::resolve::strip_locale_from_url;
 

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

@@ -12,11 +12,11 @@ use super::links::{render_link_from_page, render_link_via_page, LinkModifier};
 use super::modifier::add_attribute;
 use super::rewriter::post_process_html;
 use crate::cached_readers::read_sidebar;
-use crate::docs::doc::Doc;
-use crate::docs::page::{Page, PageLike};
 use crate::error::DocError;
 use crate::helpers;
 use crate::helpers::subpages::{list_sub_pages_grouped_internal, list_sub_pages_internal};
+use crate::pages::page::{Page, PageLike};
+use crate::pages::types::doc::Doc;
 use crate::utils::t_or_vec;
 
 fn cache_side_bar(sidebar: &str) -> bool {

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

@@ -1,10 +1,10 @@
 pub mod baseline;
 pub mod build;
 pub mod cached_readers;
-pub mod docs;
 pub mod error;
 pub mod helpers;
 pub mod html;
+pub mod pages;
 pub mod percent;
 pub mod reader;
 pub mod redirects;

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

@@ -1,24 +1,21 @@
 use std::borrow::Cow;
+use std::fs;
+use std::path::Path;
 
 use rari_types::fm_types::PageType;
 use rari_types::globals::{base_url, content_branch, git_history, popularities};
 use rari_types::locale::Locale;
 use scraper::Html;
 
-use super::blog::BlogPost;
-use super::curriculum::{
-    build_landing_modules, build_overview_modules, build_sidebar, curriculum_group,
-    prev_next_modules, prev_next_overview, CurriculumPage, Template,
-};
-use super::doc::{render_md_to_html, Doc};
-use super::dummy::Dummy;
 use super::json::{
-    BuiltDocy, Compat, JsonBlogPost, JsonBlogPostDoc, JsonCurriculum, JsonDoADoc, JsonDoc, Prose,
-    Section, Source, SpecificationSection, TocEntry, Translation,
+    BuiltDocy, Compat, ContributorSpotlightHyData, HyData, JsonBlogPost, JsonBlogPostDoc,
+    JsonCurriculum, JsonDoADoc, JsonDoc, Prose, Section, Source, SpecificationSection, TocEntry,
+    Translation,
 };
 use super::page::PageLike;
 use super::parents::parents;
 use super::title::{page_title, transform_title};
+use super::types::contributors::ContributorSpotlight;
 use crate::baseline::get_baseline;
 use crate::error::DocError;
 use crate::html::bubble_up::bubble_up_curriculum_page;
@@ -28,6 +25,14 @@ use crate::html::sections::{split_sections, BuildSection, BuildSectionType, Spli
 use crate::html::sidebar::{
     build_sidebars, expand_details_and_mark_current_for_inline_sidebar, postprocess_sidebar,
 };
+use crate::pages::json::JsonContributorSpotlight;
+use crate::pages::types::blog::BlogPost;
+use crate::pages::types::curriculum::{
+    build_landing_modules, build_overview_modules, build_sidebar, curriculum_group,
+    prev_next_modules, prev_next_overview, CurriculumPage, Template,
+};
+use crate::pages::types::doc::{render_md_to_html, Doc};
+use crate::pages::types::dummy::Dummy;
 use crate::specs::extract_specifications;
 use crate::templ::render::{decode_ref, render, Rendered};
 use crate::translations::get_translations_for;
@@ -357,3 +362,38 @@ pub fn build_curriculum(curriculum: &CurriculumPage) -> Result<BuiltDocy, DocErr
         locale: curriculum.locale(),
     })))
 }
+
+pub fn build_contributor_spotlight(cs: &ContributorSpotlight) -> Result<BuiltDocy, DocError> {
+    let PageContent { body, .. } = build_content(cs)?;
+    let hy_data = ContributorSpotlightHyData {
+        sections: body,
+        contributor_name: cs.meta.contributor_name.clone(),
+        folder_name: cs.meta.folder_name.clone(),
+        is_featured: cs.meta.is_featured,
+        profile_img: cs.meta.img.clone(),
+        profile_img_alt: cs.meta.img_alt.clone(),
+        usernames: cs.meta.usernames.clone(),
+        quote: cs.meta.quote.clone(),
+    };
+    Ok(BuiltDocy::ContributorSpotlight(Box::new(
+        JsonContributorSpotlight {
+            url: cs.meta.url.clone(),
+            page_title: cs.meta.title.clone(),
+            hy_data: HyData::ContributorSpotlight(hy_data),
+        },
+    )))
+}
+
+pub fn copy_additional_files(from: &Path, to: &Path) -> Result<(), DocError> {
+    for from in fs::read_dir(from)?
+        .filter_map(Result::ok)
+        .map(|f| f.path())
+        .filter(|p| p.is_file())
+    {
+        if let Some(filename) = from.file_name() {
+            let to = to.to_path_buf().join(filename);
+            fs::copy(&from, to)?;
+        }
+    }
+    Ok(())
+}

Diff for: crates/rari-doc/src/docs/build.rs renamed to crates/rari-doc/src/pages/build.rs

@@ -3,12 +3,12 @@ use std::path::PathBuf;
 use chrono::NaiveDateTime;
 use rari_data::baseline::SupportStatusWithByKey;
 use rari_types::locale::{Locale, Native};
-use serde::Serialize;
+use serde::{Deserialize, Serialize};
 
-use super::blog::BlogMeta;
-use super::curriculum::{CurriculumIndexEntry, CurriculumSidebarEntry, Template, Topic};
-use super::dummy::BlogIndex;
-use super::types::PrevNextCurriculum;
+use super::types::contributors::Usernames;
+use super::types::curriculum::{CurriculumIndexEntry, CurriculumSidebarEntry, Template, Topic};
+use crate::pages::types::blog::BlogMeta;
+use crate::pages::types::dummy::BlogIndex;
 use crate::specs::Specification;
 use crate::utils::modified_dt;
 
@@ -121,6 +121,7 @@ pub struct JsonDoc {
 #[serde(untagged)]
 pub enum HyData {
     BlogIndex(BlogIndex),
+    ContributorSpotlight(ContributorSpotlightHyData),
 }
 
 #[derive(Debug, Clone, Serialize, Default)]
@@ -167,6 +168,7 @@ pub struct JsonCurriculumDoc {
     pub prev_next: Option<PrevNextCurriculum>,
     pub template: Template,
 }
+
 #[derive(Debug, Clone, Serialize, Default)]
 pub struct JsonCurriculum {
     pub doc: JsonCurriculumDoc,
@@ -210,10 +212,68 @@ pub struct JsonBlogPost {
     pub hy_data: Option<HyData>,
 }
 
+#[derive(Debug, Clone, Serialize)]
+pub struct ContributorSpotlightHyData {
+    pub sections: Vec<Section>,
+    #[serde(rename = "contributorName")]
+    pub contributor_name: String,
+    #[serde(rename = "folderName")]
+    pub folder_name: String,
+    #[serde(rename = "isFeatured")]
+    pub is_featured: bool,
+    #[serde(rename = "profileImg")]
+    pub profile_img: String,
+    #[serde(rename = "profileImgAlt")]
+    pub profile_img_alt: String,
+    pub usernames: Usernames,
+    pub quote: String,
+}
+
+#[derive(Debug, Clone, Serialize)]
+pub struct JsonContributorSpotlight {
+    pub url: String,
+    #[serde(rename = "pageTitle")]
+    pub page_title: String,
+    #[serde(rename = "hyData")]
+    pub hy_data: HyData,
+}
 #[derive(Debug, Clone, Serialize)]
 #[serde(untagged)]
 pub enum BuiltDocy {
     Doc(Box<JsonDoADoc>),
     Curriculum(Box<JsonCurriculum>),
     BlogPost(Box<JsonBlogPost>),
+    ContributorSpotlight(Box<JsonContributorSpotlight>),
+}
+
+#[derive(Deserialize, Serialize, Clone, Debug, Default)]
+#[serde(default)]
+pub struct PrevNextBlog {
+    pub previous: Option<SlugNTitle>,
+    pub next: Option<SlugNTitle>,
+}
+
+impl PrevNextBlog {
+    pub fn is_none(&self) -> bool {
+        self.previous.is_none() && self.next.is_none()
+    }
+}
+
+#[derive(Deserialize, Serialize, Clone, Debug, Default)]
+pub struct SlugNTitle {
+    pub title: String,
+    pub slug: String,
+}
+
+#[derive(Deserialize, Serialize, Clone, Debug, Default)]
+#[serde(default)]
+pub struct PrevNextCurriculum {
+    pub prev: Option<UrlNTitle>,
+    pub next: Option<UrlNTitle>,
+}
+
+#[derive(Deserialize, Serialize, Clone, Debug, Default)]
+pub struct UrlNTitle {
+    pub title: String,
+    pub url: String,
 }

Diff for: crates/rari-doc/src/docs/json.rs renamed to crates/rari-doc/src/pages/json.rs

@@ -1,8 +1,4 @@
-pub mod blog;
 pub mod build;
-pub mod curriculum;
-pub mod doc;
-pub mod dummy;
 pub mod json;
 pub mod page;
 pub mod parents;