Skip to content

Feature - A simpler select function #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion examples/document.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ extern crate scraper;

use std::io::{self, Read, Write};

use scraper::{Selector, Html};
use scraper::{Html, Selector};

fn main() {
let mut input = String::new();
Expand Down
2 changes: 1 addition & 1 deletion examples/fragment.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ extern crate scraper;

use std::io::{self, Read, Write};

use scraper::{Selector, Html};
use scraper::{Html, Selector};

fn main() {
let mut input = String::new();
Expand Down
12 changes: 7 additions & 5 deletions src/element_ref/element.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
use selectors::{Element, OpaqueElement};
use selectors::attr::{AttrSelectorOperation, CaseSensitivity, NamespaceConstraint};
use html5ever::{LocalName, Namespace};
use selectors::attr::{AttrSelectorOperation, CaseSensitivity, NamespaceConstraint};
use selectors::matching;
use selectors::{Element, OpaqueElement};

use super::ElementRef;
use selector::{NonTSPseudoClass, PseudoElement, Simple};
Expand Down Expand Up @@ -59,7 +59,8 @@ impl<'a> Element for ElementRef<'a> {
) -> bool {
self.value().attrs.iter().any(|(key, value)| {
!matches!(*ns, NamespaceConstraint::Specific(url) if *url != key.ns)
&& *local_name == key.local && operation.eval_str(value)
&& *local_name == key.local
&& operation.eval_str(value)
})
}

Expand Down Expand Up @@ -100,7 +101,8 @@ impl<'a> Element for ElementRef<'a> {
}

fn is_empty(&self) -> bool {
!self.children()
!self
.children()
.any(|child| child.value().is_element() || child.value().is_text())
}

Expand All @@ -114,8 +116,8 @@ impl<'a> Element for ElementRef<'a> {
mod tests {
use html::Html;
use selector::Selector;
use selectors::Element;
use selectors::attr::CaseSensitivity;
use selectors::Element;

#[test]
fn test_has_id() {
Expand Down
49 changes: 45 additions & 4 deletions src/element_ref/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@

use std::ops::Deref;

use ego_tree::iter::{Edge, Traverse};
use ego_tree::NodeRef;
use ego_tree::iter::{Traverse, Edge};
use html5ever::serialize::{serialize, SerializeOpts, TraversalScope};

use {Node, Selector};
use node::Element;
use selectors::parser::SelectorParseErrorKind;
use {Node, Selector};

/// Wrapper around a reference to an element node.
///
Expand Down Expand Up @@ -48,6 +49,18 @@ impl<'a> ElementRef<'a> {
}
}

/// Returns an iterator over descendent elements matching a selector.
pub fn try_select<'s>(
&self,
selector: &'s str,
) -> Result<SelectOwned<'_>, cssparser::ParseError<'s, SelectorParseErrorKind<'s>>> {
let mut inner = self.traverse();
inner.next(); // Skip Edge::Open(self).
let selector = Selector::parse(selector)?;

Ok(SelectOwned { inner, selector })
}

fn serialize(&self, traversal_scope: TraversalScope) -> String {
let opts = SerializeOpts {
scripting_enabled: false, // It's not clear what this does.
Expand All @@ -71,13 +84,17 @@ impl<'a> ElementRef<'a> {

/// Returns an iterator over descendent text nodes.
pub fn text(&self) -> Text<'a> {
Text { inner: self.traverse() }
Text {
inner: self.traverse(),
}
}
}

impl<'a> Deref for ElementRef<'a> {
type Target = NodeRef<'a, Node>;
fn deref(&self) -> &NodeRef<'a, Node> { &self.node }
fn deref(&self) -> &NodeRef<'a, Node> {
&self.node
}
}

/// Iterator over descendent elements matching a selector.
Expand All @@ -104,6 +121,30 @@ impl<'a, 'b> Iterator for Select<'a, 'b> {
}
}

/// Iterator over descendent elements matching a selector.
#[derive(Debug, Clone)]
pub struct SelectOwned<'a> {
inner: Traverse<'a, Node>,
selector: Selector,
}

impl<'a> Iterator for SelectOwned<'a> {
type Item = ElementRef<'a>;

fn next(&mut self) -> Option<ElementRef<'a>> {
for edge in &mut self.inner {
if let Edge::Open(node) = edge {
if let Some(element) = ElementRef::wrap(node) {
if self.selector.matches(&element) {
return Some(element);
}
}
}
}
None
}
}

/// Iterator over descendent text nodes.
#[derive(Debug, Clone)]
pub struct Text<'a> {
Expand Down
13 changes: 6 additions & 7 deletions src/element_ref/serializable.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ use html5ever::serialize::{Serialize, Serializer, TraversalScope};

use {ElementRef, Node};


impl<'a> Serialize for ElementRef<'a> {
fn serialize<S: Serializer>(
&self,
Expand All @@ -22,20 +21,20 @@ impl<'a> Serialize for ElementRef<'a> {
match *node.value() {
Node::Doctype(ref doctype) => {
try!(serializer.write_doctype(doctype.name()));
},
}
Node::Comment(ref comment) => {
try!(serializer.write_comment(comment));
},
}
Node::Text(ref text) => {
try!(serializer.write_text(text));
},
}
Node::Element(ref elem) => {
let attrs = elem.attrs.iter().map(|(k, v)| (k, &v[..]));
try!(serializer.start_elem(elem.name.clone(), attrs));
},
}
_ => (),
}
},
}

Edge::Close(node) => {
if node == **self && traversal_scope == TraversalScope::ChildrenOnly(None) {
Expand All @@ -45,7 +44,7 @@ impl<'a> Serialize for ElementRef<'a> {
if let Some(elem) = node.value().as_element() {
try!(serializer.end_elem(elem.name.clone()));
}
},
}
}
}

Expand Down
55 changes: 50 additions & 5 deletions src/html/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,16 @@

use std::borrow::Cow;

use ego_tree::Tree;
use ego_tree::iter::Nodes;
use ego_tree::Tree;
use html5ever::driver;
use html5ever::tree_builder::QuirksMode;
use html5ever::QualName;
use tendril::TendrilSink;

use {Node, ElementRef};
use selector::Selector;
use selectors::parser::SelectorParseErrorKind;
use {ElementRef, Node};

/// An HTML tree.
///
Expand Down Expand Up @@ -91,6 +92,19 @@ impl Html {
}
}

/// Returns an iterator over elements matching a selector.
pub fn try_select<'a, 's>(
&'a self,
selector: &'s str,
) -> Result<SelectOwned<'a>, cssparser::ParseError<'s, SelectorParseErrorKind<'s>>> {
let selector = Selector::parse(selector)?;

Ok(SelectOwned {
inner: self.tree.nodes(),
selector,
})
}

/// Returns the root `<html>` element.
pub fn root_element(&self) -> ElementRef {
let root_node = self
Expand Down Expand Up @@ -125,6 +139,28 @@ impl<'a, 'b> Iterator for Select<'a, 'b> {
}
}

/// Iterator over elements matching a owned selector.
#[derive(Debug)]
pub struct SelectOwned<'a> {
inner: Nodes<'a, Node>,
selector: Selector,
}

impl<'a> Iterator for SelectOwned<'a> {
type Item = ElementRef<'a>;

fn next(&mut self) -> Option<ElementRef<'a>> {
for node in self.inner.by_ref() {
if let Some(element) = ElementRef::wrap(node) {
if element.parent().is_some() && self.selector.matches(&element) {
return Some(element);
}
}
}
None
}
}

mod tree_sink;

#[cfg(test)]
Expand All @@ -136,7 +172,10 @@ mod tests {
fn root_element_fragment() {
let html = Html::parse_fragment(r#"<a href="http://github.com">1</a>"#);
let root_ref = html.root_element();
let href = root_ref.select(&Selector::parse("a").unwrap()).next().unwrap();
let href = root_ref
.select(&Selector::parse("a").unwrap())
.next()
.unwrap();
assert_eq!(href.inner_html(), "1");
assert_eq!(href.value().attr("href").unwrap(), "http://github.com");
}
Expand All @@ -145,15 +184,21 @@ mod tests {
fn root_element_document_doctype() {
let html = Html::parse_document("<!DOCTYPE html>\n<title>abc</title>");
let root_ref = html.root_element();
let title = root_ref.select(&Selector::parse("title").unwrap()).next().unwrap();
let title = root_ref
.select(&Selector::parse("title").unwrap())
.next()
.unwrap();
assert_eq!(title.inner_html(), "abc");
}

#[test]
fn root_element_document_comment() {
let html = Html::parse_document("<!-- comment --><title>abc</title>");
let root_ref = html.root_element();
let title = root_ref.select(&Selector::parse("title").unwrap()).next().unwrap();
let title = root_ref
.select(&Selector::parse("title").unwrap())
.next()
.unwrap();
assert_eq!(title.inner_html(), "abc");
}
}
Loading