Skip to content

Commit

Permalink
speedreader: Update README and cargo fmt
Browse files Browse the repository at this point in the history
* Run `cargo fmt` in the speedreader root
* Add a section to the README about fetching the test data, since it is
  not retrieved automatically.
  • Loading branch information
Kevin Kuehler committed Mar 30, 2021
1 parent 18eaedb commit 63ec571
Show file tree
Hide file tree
Showing 6 changed files with 22 additions and 10 deletions.
10 changes: 10 additions & 0 deletions components/speedreader/rust/lib/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,13 @@ rule-based rewriting (using [lol_html](https://github.com/cloudflare/lol-html)
to support output streaming), or heuristics approach loosely based on [Mozilla's
Readability](https://github.com/mozilla/readability) and Rust implementation
improved from https://github.com/kumabook/readability.

## Running the tests

You need to clone the speedreader test data to the
`components/speedreader/rust/lib` directory.

```
$ [email protected]:brave-experiments/speedreader-test-data.git data
$ cargo test
```
3 changes: 2 additions & 1 deletion components/speedreader/rust/lib/examples/fetch-transform.rs
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@ fn main() {
let url = Url::parse(article_url).unwrap();

let client = reqwest::blocking::Client::new();
let data = client.get(article_url)
let data = client
.get(article_url)
.header(reqwest::header::COOKIE, "")
.send()
.unwrap()
Expand Down
3 changes: 1 addition & 2 deletions components/speedreader/rust/lib/examples/lolhtml.rs
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,7 @@ async fn stream_content(article_url: &str) -> Result<(), Box<dyn Error>> {
.await?;

let mut mapped_file = fs::File::create(format!("{}/mapped.html", &dir))?;
let mut mapped_test_file =
fs::File::create(format!("{}/mapped.html", "data/lolhtml/test"))?;
let mut mapped_test_file = fs::File::create(format!("{}/mapped.html", "data/lolhtml/test"))?;

let sr = SpeedReader::default();
let config = sr.get_rewriter_type(article_url);
Expand Down
4 changes: 2 additions & 2 deletions components/speedreader/rust/lib/src/speedreader.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
use core::any::Any;
use lol_html::Selector;
use serde::{Deserialize, Serialize};
use core::any::Any;
use thiserror::Error;
use url::Url;

Expand Down Expand Up @@ -114,7 +114,7 @@ impl Default for RewriteRules {
delazify: true,
fix_embeds: false,
content_script: None,
preprocess: vec![]
preprocess: vec![],
}
}
}
Expand Down
2 changes: 1 addition & 1 deletion components/speedreader/rust/lib/src/whitelist.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
use flate2::read::GzDecoder;
use serde::{Deserialize, Serialize};
use std::collections::HashMap;
use std::io::prelude::*;
use flate2::read::GzDecoder;

use crate::speedreader::{SpeedReaderConfig, SpeedReaderError};

Expand Down
10 changes: 6 additions & 4 deletions components/speedreader/rust/lib/tests/whitelist.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,7 @@ fn serialization_works() {
let mut whitelist = speedreader::whitelist::Whitelist::default();
whitelist.add_configuration(speedreader::SpeedReaderConfig {
domain: "example.com".to_owned(),
url_rules: vec![
"||example.com/news/*".to_owned(),
],
url_rules: vec!["||example.com/news/*".to_owned()],
declarative_rewrite: None,
});
let serialized = whitelist.serialize();
Expand All @@ -36,7 +34,11 @@ fn deserialize_stable_format() {
fn deserialize_uncompressed() {
let serialized = fs::read("./tests/SpeedReaderConfig.json").unwrap();
let maybe_whitelist = speedreader::whitelist::Whitelist::deserialize(&serialized);
assert!(maybe_whitelist.is_ok(), "Deserialization errored: {:?}", maybe_whitelist.err());
assert!(
maybe_whitelist.is_ok(),
"Deserialization errored: {:?}",
maybe_whitelist.err()
);
let whitelist = maybe_whitelist.unwrap();
assert!(whitelist.get_configuration("cnn.com").is_some());
}

0 comments on commit 63ec571

Please sign in to comment.