Extract vendored css from style.css into a separate file vendored.css (Fixes #992)

Author: cynecx

build.rs

@@ -15,6 +15,7 @@ fn main() {
     );
 
     // Don't rerun anytime a single change is made
+    println!("cargo:rerun-if-changed=templates/style/vendored.scss");
     println!("cargo:rerun-if-changed=templates/style/base.scss");
     println!("cargo:rerun-if-changed=templates/style/_rustdoc.scss");
     println!("cargo:rerun-if-changed=templates/style/_vars.scss");
@@ -57,30 +58,54 @@ fn get_git_hash() -> Option<String> {
     })
 }
 
-fn compile_sass() -> Result<(), Box<dyn Error>> {
+fn compile_sass_file(
+    name: &str,
+    target: &str,
+    include_paths: &[String],
+) -> Result<(), Box<dyn Error>> {
     use sass_rs::{Context, Options, OutputStyle};
 
     const STYLE_DIR: &str = concat!(env!("CARGO_MANIFEST_DIR"), "/templates/style");
 
-    let mut context = Context::new_file(format!("{}/base.scss", STYLE_DIR))?;
+    let include_paths = {
+        let mut paths = vec![STYLE_DIR.to_owned()];
+        paths.extend_from_slice(include_paths);
+        paths
+    };
+
+    // Compile base.scss
+    let mut context = Context::new_file(format!("{}/{}.scss", STYLE_DIR, name))?;
     context.set_options(Options {
         output_style: OutputStyle::Compressed,
-        include_paths: vec![
-            STYLE_DIR.to_owned(),
-            concat!(env!("CARGO_MANIFEST_DIR"), "/vendor/fontawesome/scss").to_owned(),
-            concat!(env!("CARGO_MANIFEST_DIR"), "/vendor/pure-css/css").to_owned(),
-        ],
+        include_paths,
         ..Default::default()
     });
 
     let css = context.compile()?;
-    let dest_path = Path::new(&env::var("OUT_DIR")?).join("style.css");
+    let dest_path = Path::new(&env::var("OUT_DIR")?).join(format!("{}.css", target));
     let mut file = File::create(&dest_path)?;
     file.write_all(css.as_bytes())?;
 
     Ok(())
 }
 
+fn compile_sass() -> Result<(), Box<dyn Error>> {
+    // Compile base.scss -> style.css
+    compile_sass_file("base", "style", &[])?;
+
+    // Compile vendored.scss -> vendored.css
+    compile_sass_file(
+        "vendored",
+        "vendored",
+        &[
+            concat!(env!("CARGO_MANIFEST_DIR"), "/vendor/fontawesome/scss").to_owned(),
+            concat!(env!("CARGO_MANIFEST_DIR"), "/vendor/pure-css/css").to_owned(),
+        ],
+    )?;
+
+    Ok(())
+}
+
 fn copy_js() {
     ["menu.js", "index.js"].iter().for_each(|path| {
         let source_path =

src/web/metrics.rs

@@ -132,6 +132,7 @@ mod tests {
             ("/robots.txt", "static resource"),
             ("/sitemap.xml", "static resource"),
             ("/-/static/style.css", "static resource"),
+            ("/-/static/vendored.css", "static resource"),
         ];
 
         wrapper(|env| {

src/web/statics.rs

@@ -10,6 +10,7 @@ use mime_guess::MimeGuess;
 use router::Router;
 use std::{ffi::OsStr, fs, path::Path};
 
+const VENDORED_CSS: &str = include_str!(concat!(env!("OUT_DIR"), "/vendored.css"));
 const STYLE_CSS: &str = include_str!(concat!(env!("OUT_DIR"), "/style.css"));
 const MENU_JS: &str = include_str!(concat!(env!("OUT_DIR"), "/menu.js"));
 const INDEX_JS: &str = include_str!(concat!(env!("OUT_DIR"), "/index.js"));
@@ -20,6 +21,7 @@ pub(crate) fn static_handler(req: &mut Request) -> IronResult<Response> {
     let file = cexpect!(req, router.find("file"));
 
     match file {
+        "vendored.css" => serve_resource(VENDORED_CSS, ContentType("text/css".parse().unwrap())),
         "style.css" => serve_resource(STYLE_CSS, ContentType("text/css".parse().unwrap())),
         "index.js" => serve_resource(
             INDEX_JS,
@@ -119,7 +121,7 @@ pub(super) fn ico_handler(req: &mut Request) -> IronResult<Response> {
 
 #[cfg(test)]
 mod tests {
-    use super::{INDEX_JS, MENU_JS, STATIC_SEARCH_PATHS, STYLE_CSS};
+    use super::{INDEX_JS, MENU_JS, STATIC_SEARCH_PATHS, STYLE_CSS, VENDORED_CSS};
     use crate::test::wrapper;
     use std::fs;
 
@@ -141,6 +143,24 @@ mod tests {
         });
     }
 
+    #[test]
+    fn vendored_css() {
+        wrapper(|env| {
+            let web = env.frontend();
+
+            let resp = web.get("/-/static/vendored.css").send()?;
+            assert!(resp.status().is_success());
+            assert_eq!(
+                resp.headers().get("Content-Type"),
+                Some(&"text/css".parse().unwrap()),
+            );
+            assert_eq!(resp.content_length().unwrap(), VENDORED_CSS.len() as u64);
+            assert_eq!(resp.text()?, VENDORED_CSS);
+
+            Ok(())
+        });
+    }
+
     #[test]
     fn index_js() {
         wrapper(|env| {

templates/base.html

@@ -10,6 +10,7 @@
         {%- block meta -%}{%- endblock meta -%}
 
         {# Docs.rs styles #}
+        <link rel="stylesheet" href="/-/static/vendored.css?{{ docsrs_version() | slugify }}" type="text/css" media="all" />
         <link rel="stylesheet" href="/normalize-{{ rustc_resource_suffix() }}.css" type="text/css" media="all" />
         <link rel="stylesheet" href="/rustdoc-{{ rustc_resource_suffix() }}.css" type="text/css" media="all" />
         <link rel="stylesheet" href="/light-{{ rustc_resource_suffix() }}.css" type="text/css" media="all" />

templates/style/base.scss

@@ -1,6 +1,5 @@
 // FIXME: Use modules
-@import "vars", "rustdoc", "utils", "navbar", "fontawesome", "regular", "solid", "brands", "pure-min",
-    "grids-responsive-min";
+@import "vars", "rustdoc", "utils", "navbar";
 
 html,
 input,

templates/style/vendored.scss

@@ -0,0 +1,3 @@
+@import "fontawesome", "regular", "solid", "brands", "pure-min",
+    "grids-responsive-min";
+