feat: Option to control whether remote stylesheets should be loaded

Stranger6667 · Stranger6667 · commit 6bfb510aeccc · 2020-06-25T12:37:54.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,11 +5,12 @@
 ### Added
 
 - `CSSInliner` and customization options. [#9](https://github.com/Stranger6667/css-inline/issues/9)
-- Option to remove "style" tags. [#11](https://github.com/Stranger6667/css-inline/issues/11)
+- Option to remove "style" tags (`remove_style_tags`). Disabled by default. [#11](https://github.com/Stranger6667/css-inline/issues/11)
 - `CSSInliner::compact()` constructor for producing smaller HTML output.
 - `CSSInliner.inline_to` that writes the output to a generic writer. [#24](https://github.com/Stranger6667/css-inline/issues/24)
 - Implement `Error` for `InlineError`.
 - Loading external stylesheets. [#8](https://github.com/Stranger6667/css-inline/issues/8)
+- Option to control whether remote stylesheets should be loaded (`load_remote_stylesheets`). Enabled by default.
 
 ### Changed
 
diff --git a/README.md b/README.md
@@ -12,19 +12,10 @@ For example, this HTML:
 <html>
     <head>
         <title>Test</title>
-        <style>
-            h1, h2 { color:blue; }
-            strong { text-decoration:none }
-            p { font-size:2px }
-            p.footer { font-size: 1px}
-        </style>
+        <style>h1 { color:blue; }</style>
     </head>
     <body>
         <h1>Big Text</h1>
-        <p>
-            <strong>Solid</strong>
-        </p>
-        <p class="footer">Foot notes</p>
     </body>
 </html>
 ```
@@ -33,15 +24,9 @@ Will be turned into this:
 
 ```html
 <html>
-    <head>
-        <title>Test</title>
-    </head>
+    <head><title>Test</title></head>
     <body>
         <h1 style="color:blue;">Big Text</h1>
-        <p style="font-size:2px;">
-            <strong style="text-decoration:none;">Solid</strong>
-        </p>
-        <p style="font-size:1px;">Foot notes</p>
     </body>
 </html>
 ```
@@ -52,33 +37,56 @@ To use it in your project add the following line to your `dependencies` section
 css-inline = "0.1"
 ```
 
-## Example:
+## Usage
 
 ```rust
 use css_inline;
 
 const HTML: &str = r#"<html>
 <head>
     <title>Test</title>
-    <style>
-        h1, h2 { color:blue; }
-        strong { text-decoration:none }
-        p { font-size:2px }
-        p.footer { font-size: 1px}
-    </style>
+    <style>h1 { color:blue; }</style>
 </head>
 <body>
     <h1>Big Text</h1>
-    <p>
-        <strong>Solid</strong>
-    </p>
-    <p class="footer">Foot notes</p>
 </body>
 </html>"#;
 
 fn main() -> Result<(), css_inline::InlineError> {
-   let inlined = css_inline::inline(HTML)?;
-   // Do something with inlined HTML, e.g. send an email
-   Ok(())
+    let inlined = css_inline::inline(HTML)?;
+    // Do something with inlined HTML, e.g. send an email
+    Ok(())
 }
 ```
+
+### Features
+
+`css-inline` does minimum work by default:
+
+- No CSS transformation;
+- No "style" or "link" tags removal;
+
+It also loads external stylesheets via network or filesystem, but this behavior is configurable.
+
+### Configuration
+
+`css-inline` can be configured by using `InlineOptions` and `CSSInliner`:
+
+```rust
+use css_inline;
+
+fn main() -> Result<(), css_inline::InlineError> {
+    let options = css_inline::InlineOptions {
+        load_remote_stylesheets: false,
+        ..Default::default()
+    };
+    let inliner = css_inline::CSSInliner(options);
+    let inlined = inliner.inline(HTML);
+    // Do something with inlined HTML, e.g. send an email
+    Ok(())
+}
+```
+
+- `remove_style_tags`. Remove "style" tags after inlining.
+- `base_url`. Base URL to resolve relative URLs
+- `load_remote_stylesheets`. Whether remote stylesheets should be loaded or not
diff --git a/python/CHANGELOG.md b/python/CHANGELOG.md
@@ -5,6 +5,7 @@
 ### Added
 
 - Loading external stylesheets. [#8](https://github.com/Stranger6667/css-inline/issues/8)
+- Option to control whether remote stylesheets should be loaded (`load_remote_stylesheets`). Enabled by default.
 
 ### Changed
 
diff --git a/python/src/lib.rs b/python/src/lib.rs
@@ -17,18 +17,23 @@ fn to_pyerr(error: rust_inline::InlineError) -> PyErr {
 
 /// Customizable CSS inliner.
 #[pyclass]
-#[text_signature = "(remove_style_tags=False, base_url=None)"]
+#[text_signature = "(remove_style_tags=False, base_url=None, load_remote_stylesheets=True)"]
 struct CSSInliner {
     inner: rust_inline::CSSInliner,
 }
 
 #[pymethods]
 impl CSSInliner {
     #[new]
-    fn new(remove_style_tags: Option<bool>, base_url: Option<String>) -> Self {
+    fn new(
+        remove_style_tags: Option<bool>,
+        base_url: Option<String>,
+        load_remote_stylesheets: Option<bool>,
+    ) -> Self {
         let options = rust_inline::InlineOptions {
             remove_style_tags: remove_style_tags.unwrap_or(false),
             base_url,
+            load_remote_stylesheets: load_remote_stylesheets.unwrap_or(true),
         };
         CSSInliner {
             inner: rust_inline::CSSInliner::new(options),
@@ -52,37 +57,41 @@ impl CSSInliner {
     }
 }
 
-/// inline(html, remove_style_tags=False, base_url=None)
+/// inline(html, remove_style_tags=False, base_url=None, load_remote_stylesheets=True)
 ///
 /// Inline CSS in the given HTML document
 #[pyfunction]
-#[text_signature = "(html, remove_style_tags=False, base_url=None)"]
+#[text_signature = "(html, remove_style_tags=False, base_url=None, load_remote_stylesheets=True)"]
 fn inline(
     html: &str,
     remove_style_tags: Option<bool>,
     base_url: Option<String>,
+    load_remote_stylesheets: Option<bool>,
 ) -> PyResult<String> {
     let options = rust_inline::InlineOptions {
         remove_style_tags: remove_style_tags.unwrap_or(false),
         base_url,
+        load_remote_stylesheets: load_remote_stylesheets.unwrap_or(true),
     };
     let inliner = rust_inline::CSSInliner::new(options);
     Ok(inliner.inline(html).map_err(to_pyerr)?)
 }
 
-/// inline_many(htmls, remove_style_tags=False, base_url=None)
+/// inline_many(htmls, remove_style_tags=False, base_url=None, load_remote_stylesheets=True)
 ///
 /// Inline CSS in multiple HTML documents
 #[pyfunction]
-#[text_signature = "(htmls, remove_style_tags=False, base_url=None)"]
+#[text_signature = "(htmls, remove_style_tags=False, base_url=None, load_remote_stylesheets=True)"]
 fn inline_many(
     htmls: &PyList,
     remove_style_tags: Option<bool>,
     base_url: Option<String>,
+    load_remote_stylesheets: Option<bool>,
 ) -> PyResult<Vec<String>> {
     let options = rust_inline::InlineOptions {
         remove_style_tags: remove_style_tags.unwrap_or(false),
         base_url,
+        load_remote_stylesheets: load_remote_stylesheets.unwrap_or(true),
     };
     let inliner = rust_inline::CSSInliner::new(options);
     inline_many_impl(&inliner, htmls)
diff --git a/src/lib.rs b/src/lib.rs
@@ -162,6 +162,8 @@ pub struct InlineOptions {
     pub remove_style_tags: bool,
     /// Used for loading external stylesheets via relative URLs
     pub base_url: Option<String>,
+    /// Whether remote stylesheets should be loaded or not
+    pub load_remote_stylesheets: bool,
 }
 
 impl InlineOptions {
@@ -171,6 +173,7 @@ impl InlineOptions {
         InlineOptions {
             remove_style_tags: true,
             base_url: None,
+            load_remote_stylesheets: true,
         }
     }
 }
@@ -181,6 +184,7 @@ impl Default for InlineOptions {
         InlineOptions {
             remove_style_tags: false,
             base_url: None,
+            load_remote_stylesheets: true,
         }
     }
 }
@@ -234,14 +238,16 @@ impl CSSInliner {
                 style_tag.as_node().detach()
             }
         }
-        for link_tag in document
-            .select("link[rel~=stylesheet]")
-            .map_err(|_| error::InlineError::ParseError("Unknown error".to_string()))?
-        {
-            if let Some(href) = &link_tag.attributes.borrow().get("href") {
-                let url = self.get_full_url(href);
-                let css = self.load_external(url.as_str())?;
-                process_css(&document, css.as_str())?;
+        if self.options.load_remote_stylesheets {
+            for link_tag in document
+                .select("link[rel~=stylesheet]")
+                .map_err(|_| error::InlineError::ParseError("Unknown error".to_string()))?
+            {
+                if let Some(href) = &link_tag.attributes.borrow().get("href") {
+                    let url = self.get_full_url(href);
+                    let css = self.load_external(url.as_str())?;
+                    process_css(&document, css.as_str())?;
+                }
             }
         }
         document.serialize(target)?;
diff --git a/tests/test_inlining.rs b/tests/test_inlining.rs
@@ -1,4 +1,4 @@
-use css_inline::{inline, CSSInliner};
+use css_inline::{inline, CSSInliner, InlineOptions};
 
 macro_rules! html {
     ($style: expr, $body: expr) => {
@@ -135,6 +135,37 @@ h2 { color: red; }
     ))
 }
 
+#[test]
+fn remote_file_stylesheet_disable() {
+    let html = r#"
+<html>
+<head>
+<link href="tests/external.css" rel="stylesheet" type="text/css">
+<link rel="alternate" type="application/rss+xml" title="RSS" href="/rss.xml">
+<style type="text/css">
+h2 { color: red; }
+</style>
+</head>
+<body>
+<h1>Big Text</h1>
+<h2>Smaller Text</h2>
+</body>
+</html>"#;
+    let options = InlineOptions {
+        remove_style_tags: false,
+        base_url: None,
+        load_remote_stylesheets: false,
+    };
+    let result = inline(&html).unwrap();
+    assert!(result.ends_with(
+        r#"<body>
+<h1 style="color: blue;">Big Text</h1>
+<h2 style="color: red;">Smaller Text</h2>
+
+</body></html>"#
+    ))
+}
+
 #[test]
 fn remote_network_stylesheet() {
     let html = r#"
@@ -160,3 +191,14 @@ h2 { color: red; }
 </body></html>"#
     ))
 }
+
+#[test]
+fn customize_inliner() {
+    let options = InlineOptions {
+        load_remote_stylesheets: false,
+        ..Default::default()
+    };
+    assert_eq!(options.load_remote_stylesheets, false);
+    assert_eq!(options.remove_style_tags, false);
+    assert_eq!(options.base_url, None);
+}

Original file line number	Diff line number	Diff line change
`@@ -162,6 +162,8 @@ pub struct InlineOptions {`
`162`	`162`	`pub remove_style_tags: bool,`
`163`	`163`	`/// Used for loading external stylesheets via relative URLs`
`164`	`164`	`pub base_url: Option<String>,`
	`165`	`+ /// Whether remote stylesheets should be loaded or not`
	`166`	`+ pub load_remote_stylesheets: bool,`
`165`	`167`	`}`
`166`	`168`
`167`	`169`	`impl InlineOptions {`
`@@ -171,6 +173,7 @@ impl InlineOptions {`
`171`	`173`	`InlineOptions {`
`172`	`174`	`remove_style_tags: true,`
`173`	`175`	`base_url: None,`
	`176`	`+ load_remote_stylesheets: true,`
`174`	`177`	`}`
`175`	`178`	`}`
`176`	`179`	`}`
`@@ -181,6 +184,7 @@ impl Default for InlineOptions {`
`181`	`184`	`InlineOptions {`
`182`	`185`	`remove_style_tags: false,`
`183`	`186`	`base_url: None,`
	`187`	`+ load_remote_stylesheets: true,`
`184`	`188`	`}`
`185`	`189`	`}`
`186`	`190`	`}`
`@@ -234,14 +238,16 @@ impl CSSInliner {`
`234`	`238`	`style_tag.as_node().detach()`
`235`	`239`	`}`
`236`	`240`	`}`
`237`		`- for link_tag in document`
`238`		`- .select("link[rel~=stylesheet]")`
`239`		`- .map_err(\|_\| error::InlineError::ParseError("Unknown error".to_string()))?`
`240`		`- {`
`241`		`- if let Some(href) = &link_tag.attributes.borrow().get("href") {`
`242`		`- let url = self.get_full_url(href);`
`243`		`- let css = self.load_external(url.as_str())?;`
`244`		`- process_css(&document, css.as_str())?;`
	`241`	`+ if self.options.load_remote_stylesheets {`
	`242`	`+ for link_tag in document`
	`243`	`+ .select("link[rel~=stylesheet]")`
	`244`	`+ .map_err(\|_\| error::InlineError::ParseError("Unknown error".to_string()))?`
	`245`	`+ {`
	`246`	`+ if let Some(href) = &link_tag.attributes.borrow().get("href") {`
	`247`	`+ let url = self.get_full_url(href);`
	`248`	`+ let css = self.load_external(url.as_str())?;`
	`249`	`+ process_css(&document, css.as_str())?;`
	`250`	`+ }`
`245`	`251`	`}`
`246`	`252`	`}`
`247`	`253`	`document.serialize(target)?;`