sawzall 0.1.0.pre

data/Cargo.toml

@@ -0,0 +1,7 @@
+# This Cargo.toml is here to let externals tools (IDEs, etc.) know that this is
+# a Rust project. Your extensions dependencies should be added to the Cargo.toml
+# in the ext/ directory.
+
+[workspace]
+members = ["./ext/sawzall"]
+resolver = "2"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 David Cornu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# Sawzall
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/sawzall`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/sawzall.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/ext/sawzall/Cargo.toml

@@ -0,0 +1,15 @@
+[package]
+name = "sawzall"
+version = "0.1.0"
+edition = "2021"
+authors = ["David Cornu <me@davidcornu.com>"]
+license = "MIT"
+publish = false
+
+[lib]
+crate-type = ["cdylib"]
+
+[dependencies]
+ego-tree = "0.10.0"
+magnus = { version = "0.7.1" }
+scraper = { version = "0.23.1", features = ["atomic"] }

data/ext/sawzall/extconf.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require "mkmf"
+require "rb_sys/mkmf"
+
+create_rust_makefile("sawzall/sawzall")

data/ext/sawzall/src/html_to_plain.rs

@@ -0,0 +1,196 @@
+use ego_tree::iter::Edge;
+use scraper::{ElementRef, Node};
+use std::{collections::HashSet, sync::LazyLock};
+
+/// Set of block-level elements extracted from [MDN][1]
+///
+/// [1]: https://developer.mozilla.org/en-US/docs/Web/HTML/Block-level_elements
+const BLOCK_LEVEL_ELEMENTS: [&'static str; 33] = [
+    "address",
+    "article",
+    "aside",
+    "blockquote",
+    "dd",
+    "details",
+    "dialog",
+    "div",
+    "dl",
+    "dt",
+    "fieldset",
+    "figcaption",
+    "figure",
+    "footer",
+    "form",
+    "h1",
+    "h2",
+    "h3",
+    "h4",
+    "h5",
+    "h6",
+    "header",
+    "hgroup",
+    "hr",
+    "li",
+    "main",
+    "nav",
+    "ol",
+    "p",
+    "pre",
+    "section",
+    "table",
+    "ul",
+];
+
+static BLOCK_LEVEL_ELEMENTS_SET: LazyLock<HashSet<&'static str>> =
+    LazyLock::new(|| BLOCK_LEVEL_ELEMENTS.iter().map(|s| *s).collect());
+
+fn is_block_element(name: &str) -> bool {
+    BLOCK_LEVEL_ELEMENTS_SET.contains(&name)
+}
+
+enum Item<'a> {
+    Text(&'a str),
+    Newlines(usize),
+}
+
+/// Converts HTML to plain text using a subset of the [`HTMLElement.innerText`][1]
+/// algorithm ([WHATWG spec][2], [Chromium source][3]).
+///
+/// While the output should be acceptable for documents containing text, no effort
+/// was made to support more complex elements (e.g. tables, images, videos, etc...)
+/// which have no reasonable use case for the kinds of inputs expected to be handled
+/// (e.g. RSS entry titles and summaries)
+///
+/// [1]: https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/innerText
+/// [2]: https://html.spec.whatwg.org/multipage/dom.html#the-innertext-idl-attribute
+/// [3]: https://source.chromium.org/chromium/chromium/src/+/main:third_party/blink/renderer/core/editing/element_inner_text.cc;l=262;drc=eca6a1b4c221dc66cf40d0d1ee8eff3f3028ce26?q=innerText&ss=chromium
+pub(crate) fn html_to_plain(element: ElementRef) -> String {
+    let mut item_iter = element
+        .traverse()
+        .filter_map(|edge| match edge {
+            Edge::Open(node) => match node.value() {
+                Node::Text(text) if !text.trim().is_empty() => Some(Item::Text(text)),
+                Node::Element(element) => match element.name() {
+                    "br" => Some(Item::Newlines(1)),
+                    "p" => Some(Item::Newlines(2)),
+                    name if is_block_element(name) => Some(Item::Newlines(1)),
+                    _ => None,
+                },
+                _ => None,
+            },
+            Edge::Close(node) => match node.value() {
+                Node::Element(element) => match element.name() {
+                    "p" => Some(Item::Newlines(2)),
+                    name if is_block_element(name) => Some(Item::Newlines(1)),
+                    _ => None,
+                },
+                _ => None,
+            },
+        })
+        .peekable();
+
+    let mut output = String::new();
+
+    while let Some(item) = item_iter.next() {
+        match item {
+            Item::Text(text) => {
+                output.push_str(text);
+            }
+            Item::Newlines(count) => {
+                let mut max = count;
+
+                // Combine all subsequent newlines into one, using the maximum value
+                while let Some(Item::Newlines(next_count)) = item_iter.peek() {
+                    max = max.max(*next_count);
+                    item_iter.next();
+                }
+
+                // Don't insert newlines if we're at the beginning or the end
+                if !(output.is_empty() || item_iter.peek().is_none()) {
+                    output.push_str(&"\n".repeat(max));
+                }
+            }
+        }
+    }
+
+    output
+}
+
+#[cfg(test)]
+mod tests {
+    fn html_to_plain(input: &str) -> String {
+        let doc = scraper::Html::parse_fragment(input);
+        super::html_to_plain(doc.root_element())
+    }
+
+    #[test]
+    fn test_html_to_plain() {
+        assert_eq!("", html_to_plain(""));
+
+        assert_eq!(
+            "this is just text",
+            html_to_plain("this is just text"),
+            "regular text is returned as-is"
+        );
+
+        assert_eq!(
+            "this is a single paragraph",
+            html_to_plain("<p>this is a single paragraph</p>"),
+            "single paragraphs do not get leading and trailing newlines"
+        );
+
+        assert_eq!(
+            "this is a single div",
+            html_to_plain("<div>this is a single div</div>"),
+            "single block elements do not get leading and trailing newlines"
+        );
+
+        assert_eq!(
+            "text like <html> is correctly unescaped",
+            html_to_plain("<h1>text like &lt;html&gt; is correctly unescaped</h1>"),
+            "html-escaped text is correctly unescaped"
+        );
+
+        assert_eq!(
+            "this bold text is special",
+            html_to_plain("<p>this <em>bold</em> text is <span>special</span></p>"),
+            "inline elements don't introduce newlines"
+        );
+
+        assert_eq!(
+            "some deeply nested text",
+            html_to_plain("<header><div><h1>some deeply nested text</h1></div></header>"),
+            "subsequent block elements do not introduce duplicate newlines"
+        );
+
+        assert_eq!(
+            "line one\nline two",
+            html_to_plain("line one<br>line two"),
+            "<br> introduces a single newline"
+        );
+
+        assert_eq!(
+            "paragraph one\n\nparagraph two",
+            html_to_plain("<p>paragraph one</p><p>paragraph two</p>"),
+            "paragraphs are separated by two newlines"
+        );
+
+        assert_eq!(
+            "paragraph one\n\nparagraph two\n\nparagraph three",
+            html_to_plain("<p>paragraph one</p><p>paragraph two</p><p>paragraph three</p>"),
+            "paragraphs not at the beginning or end are wrapped in two newlines"
+        );
+
+        assert_eq!(
+            "malformed input\n🙌",
+            html_to_plain("<h1>malformed input</br><ul>🙌"),
+            "malformed input is handled"
+        );
+
+        assert_eq!(
+            "Hello, world\n\nThis is an HTML fragment",
+            html_to_plain("<h1>Hello, world</h1>\n<p>This is an HTML fragment</p>"),
+            "empty lines are ignored"
+        );
+    }
+}

data/ext/sawzall/src/lib.rs

@@ -0,0 +1,149 @@
+mod html_to_plain;
+
+use ego_tree::NodeId;
+use magnus::{function, method, prelude::*, Error, RArray, Ruby};
+use scraper::{ElementRef, Html, Selector};
+use std::sync::{Arc, Mutex};
+
+#[magnus::init]
+fn init(ruby: &Ruby) -> Result<(), Error> {
+    let module = ruby.define_module("Sawzall")?;
+    module.define_singleton_method("parse_fragment", function!(parse_fragment, 1))?;
+    module.define_singleton_method("parse_document", function!(parse_document, 1))?;
+
+    let document_class = module.define_class("Document", ruby.class_object())?;
+    document_class.define_method("select", method!(Document::select, 1))?;
+    document_class.define_method("root_element", method!(Document::root_element, 0))?;
+
+    let element_class = module.define_class("Element", ruby.class_object())?;
+    element_class.define_method("name", method!(Element::name, 0))?;
+    element_class.define_method("html", method!(Element::html, 0))?;
+    element_class.define_method("inner_html", method!(Element::inner_html, 0))?;
+    element_class.define_method("attr", method!(Element::attr, 1))?;
+    element_class.define_method("select", method!(Element::select, 1))?;
+    element_class.define_method("child_elements", method!(Element::child_elements, 0))?;
+    element_class.define_method("text", method!(Element::text, 0))?;
+
+    Ok(())
+}
+
+fn parse_fragment(fragment: String) -> Document {
+    Document::new(Html::parse_fragment(&fragment))
+}
+
+fn parse_document(document: String) -> Document {
+    Document::new(Html::parse_document(&document))
+}
+
+#[derive(Clone)]
+#[magnus::wrap(class = "Sawzall::Document", free_immediately)]
+struct Document(Arc<Mutex<Html>>);
+
+impl Document {
+    fn new(html: Html) -> Self {
+        Self(Arc::new(Mutex::new(html)))
+    }
+
+    fn with_locked_html<U, F>(&self, f: F) -> U
+    where
+        F: FnOnce(&Html) -> U,
+    {
+        let html = self.0.lock().expect("failed to lock mutex");
+
+        f(&html)
+    }
+
+    fn select(&self, css_selector: String) -> Result<RArray, Error> {
+        self.with_locked_html(|html| select(css_selector, self.clone(), html.root_element()))
+    }
+
+    fn root_element(&self) -> Element {
+        self.with_locked_html(|html| Element {
+            id: html.root_element().id(),
+            document: self.clone(),
+        })
+    }
+}
+
+fn select(
+    css_selector: String,
+    document: Document,
+    element_ref: ElementRef,
+) -> Result<RArray, Error> {
+    let ruby = Ruby::get().expect("called from non-ruby thread");
+
+    let selector = Selector::parse(&css_selector).map_err(|e| {
+        Error::new(
+            ruby.exception_arg_error(),
+            format!("failed to parse selector {css_selector:?}\n{e}"),
+        )
+    })?;
+
+    Ok(element_ref
+        .select(&selector)
+        .map(|matching_element_ref| Element {
+            id: matching_element_ref.id(),
+            document: document.clone(),
+        })
+        .collect())
+}
+
+#[magnus::wrap(class = "Sawzall::Element", free_immediately)]
+struct Element {
+    id: NodeId,
+    document: Document,
+}
+
+impl Element {
+    fn with_element_ref<U, F>(&self, f: F) -> U
+    where
+        F: FnOnce(ElementRef) -> U,
+    {
+        let html = self.document.0.lock().expect("failed to lock mutex");
+        let element_ref = html
+            .tree
+            .get(self.id)
+            .and_then(ElementRef::wrap)
+            .expect("node with id {self.id} must be an element in the tree");
+
+        f(element_ref)
+    }
+
+    fn name(&self) -> String {
+        self.with_element_ref(|element_ref| element_ref.value().name().to_string())
+    }
+
+    fn html(&self) -> String {
+        self.with_element_ref(|element_ref| element_ref.html())
+    }
+
+    fn inner_html(&self) -> String {
+        self.with_element_ref(|element_ref| element_ref.inner_html())
+    }
+
+    fn attr(&self, attribute: String) -> Option<String> {
+        self.with_element_ref(|element_ref| element_ref.attr(&attribute).map(ToString::to_string))
+    }
+
+    fn select(&self, css_selector: String) -> Result<RArray, Error> {
+        self.with_element_ref(|element_ref| {
+            select(css_selector, self.document.clone(), element_ref)
+        })
+    }
+
+    fn child_elements(&self) -> RArray {
+        self.with_element_ref(|element_ref| {
+            element_ref
+                .child_elements()
+                .map(|child_element_ref| Element {
+                    id: child_element_ref.id(),
+                    document: self.document.clone(),
+                })
+                .collect()
+        })
+    }
+
+    fn text(&self) -> String {
+        self.with_element_ref(html_to_plain::html_to_plain)
+    }
+}

data/lib/sawzall/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Sawzall
+  VERSION = "0.1.0.pre"
+end

data/lib/sawzall.rb

@@ -0,0 +1,184 @@
+# frozen_string_literal: true
+
+require_relative "sawzall/version"
+require_relative "sawzall/sawzall"
+
+module Sawzall
+  # Parses the given string as an HTML fragment
+  #
+  # @!method self.parse_fragment(html)
+  # @param html [String]
+  # @return [Sawzall::Document]
+  #
+  # @example
+  #   Sawzall
+  #     .parse_fragment("<h1 id='title'>Page Title</h1>")
+  #     .select("h1")
+  #     .first
+  #     .attr("id") #=> "title"
+
+  # Parses the given string as a complete HTML document
+  #
+  # @!method self.parse_document(html)
+  # @param html [String]
+  # @return [Sawzall::Document]
+  #
+  # @example
+  #   html = <<~HTML
+  #     <!doctype html>
+  #     <html>
+  #       <head>
+  #         <title>Page Title</title>
+  #       </head>
+  #       <body>
+  #         <h1>Heading</h1>
+  #       </body>
+  #     </html>
+  #   HTML
+  #
+  #   Sawzall
+  #     .parse_document(html)
+  #     .select("head title")
+  #     .first
+  #     .text #=> "Page Title"
+
+  # @!parse
+  #   class Document
+  #     # Returns the elements that match the given [CSS selector][mdn]
+  #     #
+  #     # [mdn]: https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_selectors
+  #     #
+  #     # @example
+  #     #   doc = Sawzall.parse_fragment(<<~HTML)
+  #     #     <h1>Heading</h1>
+  #     #     <p>Paragraph 1</p>
+  #     #     <p>Paragraph 2</p>
+  #     #   HTML
+  #     #   matches = doc.select("p")
+  #     #   matches.map(&:text) #=> ["Paragraph 1", "Paragraph 2"]
+  #     #
+  #     # @!method select(css_selector)
+  #     # @param css_selector [String]
+  #     # @raise [ArgumentError] if the CSS selector is invalid
+  #     # @return [Array<Sawzall::Element>]
+  #
+  #     # Returns the document's root element
+  #     #
+  #     # @example
+  #     #   doc = Sawzall.parse_fragment("<h1>Heading</h1>")
+  #     #   doc.root_element.name #=> "html"
+  #     #   doc.root_element.child_elements.map(&:name) #=> ["h1"]
+  #     #
+  #     # @!method root_element
+  #     # @return [Sawzall::Element]
+  #   end
+
+  # @!parse
+  #   class Element
+  #     # Returns the element's name in lowercase
+  #     #
+  #     # @example
+  #     #   doc = Sawzall.parse_fragment("<p>Paragraph</p>")
+  #     #   doc.select("p").first.name #=> "p"
+  #     #
+  #     # @!method name
+  #     # @return [String]
+  #
+  #     # Returns the element's outer HTML
+  #     #
+  #     # @example
+  #     #   doc = Sawzall.parse_fragment(<<~HTML)
+  #     #     <section>
+  #     #       <h1>Heading</h1>
+  #     #     </section>
+  #     #   HTML
+  #     #   section = doc.select("section").first
+  #     #   section.html #=> "<section>\n<h1>Heading</h1>\n</section>"
+  #     #
+  #     # @!method html
+  #     # @return [String]
+  #
+  #     # Returns the element's inner HTML
+  #     #
+  #     # @example
+  #     #   doc = Sawzall.parse_fragment(<<~HTML)
+  #     #     <section>
+  #     #       <h1>Heading</h1>
+  #     #     </section>
+  #     #   HTML
+  #     #   section = doc.select("section").first
+  #     #   section.inner_html #=> "\n<h1>Heading</h1>\n"
+  #     #
+  #     # @!method inner_html
+  #     # @return [String]
+  #
+  #     # Returns the given attribute's value or `nil`
+  #     #
+  #     # @example
+  #     #   doc = Sawzall.parse_fragment("<h1 id='title'>Heading</h1>")
+  #     #   h1 = doc.select("h1").first
+  #     #   h1.attr("id") #=> "title"
+  #     #   h1.attr("class") #=> nil
+  #     #
+  #     # @!method attr(attribute)
+  #     # @param attribute [String]
+  #     # @return [String, Nil]
+  #
+  #     # Returns the child elements that match the given CSS selector
+  #     #
+  #     # https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_selectors
+  #     #
+  #     # @example
+  #     #   doc = Sawzall.parse_fragment(<<~HTML)
+  #     #     <div class="container">
+  #     #       <div>inner div 1</div>
+  #     #       <div>inner div 2</div>
+  #     #     </div>
+  #     #   HTML
+  #     #   container = doc.select(".container").first
+  #     #   matches = container.select("div")
+  #     #   matches.map(&:text) #=> ["inner div 1", "inner div 2"]
+  #     #
+  #     # @!method select(css_selector)
+  #     # @param css_selector [String]
+  #     # @raise [ArgumentError] if the CSS selector is invalid
+  #     # @return [Array<Sawzall::Element>]
+  #
+  #     # Returns the element's child elements
+  #     #
+  #     # @example
+  #     #   doc = Sawzall.parse_fragment(<<~HTML)
+  #     #     <div id="parent">
+  #     #       <div id="child1">
+  #     #         <div id="grandchild1"></div>
+  #     #       </div>
+  #     #       <div id="child2"></div>
+  #     #     </div>
+  #     #   HTML
+  #     #   parent = doc.select("#parent").first
+  #     #   parent
+  #     #     .child_elements
+  #     #     .map { it.attr("id") } #=> ["child1", "child2"]
+  #     #
+  #     # @!method child_elements
+  #     # @return [Array<Sawzall::Element>]
+  #
+  #     # Returns the element's text content using a very simplified version of the
+  #     # `innerText` algorithm.
+  #     #
+  #     # https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/innerText
+  #     #
+  #     # @example
+  #     #   doc = Sawzall.parse_fragment(<<~HTML)
+  #     #     <ul>
+  #     #       <li>First item</li>
+  #     #       <li>Second item</li>
+  #     #     </ul>
+  #     #   HTML
+  #     #   ul = doc.select("ul").first
+  #     #   ul.text #=> "First item\nSecond item"
+  #     #
+  #     # @!method text
+  #     # @return [String]
+  #   end
+end

data/sawzall.gemspec

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative "lib/sawzall/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "sawzall"
+  spec.version = Sawzall::VERSION
+  spec.authors = ["David Cornu"]
+  spec.email = ["me@davidcornu.com"]
+
+  spec.summary = "HTML parsing and querying with CSS selectors."
+  spec.description = <<~TXT
+    Sawzall wraps the Rust scraper library (https://github.com/rust-scraper/scraper)
+    to make it easy to parse HTML documents and query them with CSS selectors.
+  TXT
+  spec.homepage = "https://github.com/davidcornu/sawzall"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.1.0"
+  spec.required_rubygems_version = ">= 3.3.11"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  # Specify which files should be added to the gem when it is released.
+  gemspec = File.basename(__FILE__)
+  spec.files = [
+    gemspec,
+    "README.md",
+    "LICENSE.txt",
+    "Cargo.lock",
+    "Cargo.toml"
+  ]
+  spec.files += Dir.glob([
+    "ext/**/*.{rs,toml,lock,rb}",
+    "lib/**/*.rb",
+  ])
+
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.extensions = ["ext/sawzall/extconf.rb"]
+
+  spec.add_dependency "rb_sys", "~> 0.9.91"
+end