selma 0.0.5-x86_64-linux → 0.0.7-x86_64-linux

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c44d404c6cd666d24abe3779484bc40f378aafb068cb9abaa96423e37728c2bc
-  data.tar.gz: df3bab7e8bd1f9289a74d16789f5959bc41ec59e6145e140a429227ce08738d6
+  metadata.gz: bbd21b1ab2dfc59fc7c16475c993a497cdd025ca136270d92114bbab596602fe
+  data.tar.gz: 5a5b5884d5ed3b714ca80c8acfbfaf8b3b044054e834ae9fffaacce9946ac7a2
 SHA512:
-  metadata.gz: 5131067d67769795f6a156828b6c8e16a963c030cc1f3aae108bd966feda71e6bbd8fbb4c39fbcd04c91c6542bf5c0b227060b9440b2b8b279ed714b5f282fb1
-  data.tar.gz: 5b2cbd109c3fced2bf922dedee36e1f291206be662ca47bb55bc2dc18c7288f09a3ce481a4eead218cd7369c8217e21ead6c712466d3382aaab898f4362f99c3
+  metadata.gz: 8ddc5f4256ffaa7bf8756c872a46caa139925bf4e9fee6c2cd447fe96e85276ddb7af24ae2038ed4eb9c30a21052cf09dd298ff44bad6f8d36c6f6a88690164e
+  data.tar.gz: e3eb10cc9b5db8eb9a1a11e2a8bb3eb92338d627d351068945ffd1bfce9d08960946288ae6513df8f9b7ee74271583b38ba67d4761ecce7dda664c1ae2eeef1b

data/README.md

@@ -24,23 +24,29 @@ Or install it yourself as:
 
 ## Usage
 
-Selma can perform two different actions:
+Selma can perform two different actions, either independently or together:
 
 - Sanitize HTML, through a [Sanitize](https://github.com/rgrove/sanitize)-like allowlist syntax; and
-- Select HTML using CSS rules, and manipulate elements and text
+- Select HTML using CSS rules, and manipulate elements and text nodes along the way.
 
-The basic API for Selma looks like this:
+It does this through two kwargsL `sanitizer` and `handlers`. The basic API for Selma looks like this:
 
 ```ruby
-rewriter = Selma::Rewriter.new(sanitizer: sanitizer_config, handlers: [MatchAttribute.new, TextRewrite.new])
-rewriter(html)
+sanitizer_config = {
+   elements: ["b", "em", "i", "strong", "u"],
+}
+sanitizer = Selma::Sanitizer.new(sanitizer_config)
+rewriter = Selma::Rewriter.new(sanitizer: sanitizer, handlers: [MatchElementRewrite.new, MatchTextRewrite.new])
+# removes any element that is not  ["b", "em", "i", "strong", "u"];
+# then calls `MatchElementRewrite` and `MatchTextRewrite` on matching HTML elements
+rewriter.rewrite(html)
 ```
 
-Let's take a look at each part individually.
+Here's a look at each individual part.
 
 ### Sanitization config
 
-Selma sanitizes by default. That is, even if the `sanitizer` kwarg is not passed in, sanitization occurs. If you want to disable HTML sanitization (for some reason), pass `nil`:
+Selma sanitizes by default. That is, even if the `sanitizer` kwarg is not passed in, sanitization occurs. If you truly want to disable HTML sanitization (for some reason), pass `nil`:
 
 ```ruby
 Selma::Rewriter.new(sanitizer: nil) # dangerous and ill-advised
@@ -87,22 +93,22 @@ whitespace_elements: ["blockquote", "h1", "h2", "h3", "h4", "h5", "h6", ]
 
 ### Defining handlers
 
-The real power in Selma comes in its use of handlers. A handler is simply an object with various methods:
+The real power in Selma comes in its use of handlers. A handler is simply an object with various methods defined:
 
 - `selector`, a method which MUST return instance of `Selma::Selector` which defines the CSS classes to match
 - `handle_element`, a method that's call on each matched element
-- `handle_text_chunk`, a method that's called on each matched text node; this MUST return a string
+- `handle_text_chunk`, a method that's called on each matched text node
 
 Here's an example which rewrites the `href` attribute on `a` and the `src` attribute on `img` to be `https` rather than `http`.
 
 ```ruby
 class MatchAttribute
-  SELECTOR = Selma::Selector(match_element: "a, img")
+  SELECTOR = Selma::Selector(match_element: %(a[href^="http:"], img[src^="http:"]"))
 
   def handle_element(element)
-    if element.tag_name == "a" && element["href"] =~ /^http:/
+    if element.tag_name == "a"
       element["href"] = rename_http(element["href"])
-    elsif element.tag_name == "img" && element["src"] =~ /^http:/
+    elsif element.tag_name == "img"
       element["src"] = rename_http(element["src"])
     end
   end
@@ -118,10 +124,10 @@ rewriter = Selma::Rewriter.new(handlers: [MatchAttribute.new])
 The `Selma::Selector` object has three possible kwargs:
 
 - `match_element`: any element which matches this CSS rule will be passed on to `handle_element`
-- `match_text_within`: any element which matches this CSS rule will be passed on to `handle_text_chunk`
+- `match_text_within`: any text_chunk which matches this CSS rule will be passed on to `handle_text_chunk`
 - `ignore_text_within`: this is an array of element names whose text contents will be ignored
 
-You've seen an example of `match_element`; here's one for `match_text` which changes strings in various elements which are _not_ `pre` or `code`:
+Here's an example for `handle_text_chunk` which changes strings in various elements which are _not_ `pre` or `code`:
 
 ```ruby
 
@@ -144,20 +150,63 @@ rewriter = Selma::Rewriter.new(handlers: [MatchText.new])
 
 The `element` argument in `handle_element` has the following methods:
 
-- `tag_name`: The element's name
-- `[]`: get an attribute
-- `[]=`: set an attribute
-- `remove_attribute`: remove an attribute
-- `attributes`: list all the attributes
-- `ancestors`: list all the ancestors
-- `append(content, as: content_type)`: appends `content` to the element's inner content, i.e. inserts content right before the element's end tag. `content_type` is either `:text` or `:html` and determines how the content will be applied.
+- `tag_name`: Gets the element's name
+- `tag_name=`: Sets the element's name
+- `self_closing?`: A bool which identifies whether or not the element is self-closing
+- `[]`: Get an attribute
+- `[]=`: Set an attribute
+- `remove_attribute`: Remove an attribute
+- `has_attribute?`: A bool which identifies whether or not the element has an attribute
+- `attributes`: List all the attributes
+- `ancestors`: List all of an element's ancestors as an array of strings
 - `before(content, as: content_type)`: Inserts `content` before the element. `content_type` is either `:text` or `:html` and determines how the content will be applied.
 - `after(content, as: content_type)`: Inserts `content` after the element. `content_type` is either `:text` or `:html` and determines how the content will be applied.
-- `set_inner_content`: replaces inner content of the element with `content`. `content_type` is either `:text` or `:html` and determines how the content will be applied.
+- `prepend(content, as: content_type)`: prepends `content` to the element's inner content, i.e. inserts content right after the element's start tag. `content_type` is either `:text` or `:html` and determines how the content will be applied.
+- `append(content, as: content_type)`: appends `content` to the element's inner content, i.e. inserts content right before the element's end tag. `content_type` is either `:text` or `:html` and determines how the content will be applied.
+- `set_inner_content`: Replaces inner content of the element with `content`. `content_type` is either `:text` or `:html` and determines how the content will be applied.
+
+#### `text_chunk` methods
+
+- `to_s` / `.content`: Gets the text node's content
+- `text_type`: identifies the type of text in the text node
+- `before(content, as: content_type)`: Inserts `content` before the text. `content_type` is either `:text` or `:html` and determines how the content will be applied.
+- `after(content, as: content_type)`: Inserts `content` after the text. `content_type` is either `:text` or `:html` and determines how the content will be applied.
+- `replace(content, as: content_type)`: Replaces the text node with `content`. `content_type` is either `:text` or `:html` and determines how the content will be applied.
 
 ## Benchmarks
 
-TBD
+<details>
+<pre>
+ruby test/benchmark.rb
+ruby test/benchmark.rb
+Warming up --------------------------------------
+sanitize-document-huge
+                         1.000  i/100ms
+ selma-document-huge     1.000  i/100ms
+Calculating -------------------------------------
+sanitize-document-huge
+                          0.257  (± 0.0%) i/s -      2.000  in   7.783398s
+ selma-document-huge      4.602  (± 0.0%) i/s -     23.000  in   5.002870s
+Warming up --------------------------------------
+sanitize-document-medium
+                         2.000  i/100ms
+selma-document-medium
+                        22.000  i/100ms
+Calculating -------------------------------------
+sanitize-document-medium
+                         28.676  (± 3.5%) i/s -    144.000  in   5.024669s
+selma-document-medium
+                        121.500  (±22.2%) i/s -    594.000  in   5.135410s
+Warming up --------------------------------------
+sanitize-document-small
+                        10.000  i/100ms
+selma-document-small    20.000  i/100ms
+Calculating -------------------------------------
+sanitize-document-small
+                        107.280  (± 0.9%) i/s -    540.000  in   5.033850s
+selma-document-small    118.867  (±31.1%) i/s -    540.000  in   5.080726s
+</pre>
+</details>
 
 ## Contributing
 

data/ext/selma/extconf.rb

@@ -3,4 +3,4 @@ require "rb_sys/mkmf"
 
 require_relative "_util"
 
-create_rust_makefile("selma")
+create_rust_makefile("selma/selma")

data/lib/selma/sanitizer/config/basic.rb

@@ -4,8 +4,39 @@ module Selma
   class Sanitizer
     module Config
       BASIC = freeze_config(
-        elements: ["a", "abbr", "blockquote", "b", "br", "cite", "code", "dd", "dfn", "dl", "dt", "em", "i", "kbd",
-                   "li", "mark", "ol", "p", "pre", "q", "s", "samp", "small", "strike", "strong", "sub", "sup", "time", "u", "ul", "var",],
+        elements: [
+          "a",
+          "abbr",
+          "blockquote",
+          "b",
+          "br",
+          "cite",
+          "code",
+          "dd",
+          "dfn",
+          "dl",
+          "dt",
+          "em",
+          "i",
+          "kbd",
+          "li",
+          "mark",
+          "ol",
+          "p",
+          "pre",
+          "q",
+          "s",
+          "samp",
+          "small",
+          "strike",
+          "strong",
+          "sub",
+          "sup",
+          "time",
+          "u",
+          "ul",
+          "var",
+        ],
 
         attributes: {
           "a" => ["href"],

data/lib/selma/sanitizer/config/default.rb

@@ -33,13 +33,49 @@ module Selma
 
         # An Array of element names whose contents will be removed. The contents
         # of all other filtered elements will be left behind.
-        remove_contents: ["iframe", "math", "noembed", "noframes", "noscript", "plaintext", "script", "style", "svg",
-                          "xmp",],
+        remove_contents: [
+          "iframe",
+          "math",
+          "noembed",
+          "noframes",
+          "noscript",
+          "plaintext",
+          "script",
+          "style",
+          "svg",
+          "xmp",
+        ],
 
         # Elements which, when removed, should have their contents surrounded by
         # whitespace.
-        whitespace_elements: ["address", "article", "aside", "blockquote", "br", "dd", "div", "dl", "dt", "footer",
-                              "h1", "h2", "h3", "h4", "h5", "h6", "header", "hgroup", "hr", "li", "nav", "ol", "p", "pre", "section", "ul",],
+        whitespace_elements: [
+          "address",
+          "article",
+          "aside",
+          "blockquote",
+          "br",
+          "dd",
+          "div",
+          "dl",
+          "dt",
+          "footer",
+          "h1",
+          "h2",
+          "h3",
+          "h4",
+          "h5",
+          "h6",
+          "header",
+          "hgroup",
+          "hr",
+          "li",
+          "nav",
+          "ol",
+          "p",
+          "pre",
+          "section",
+          "ul",
+        ],
       )
     end
   end

data/lib/selma/sanitizer/config/relaxed.rb

@@ -4,12 +4,60 @@ module Selma
   class Sanitizer
     module Config
       RELAXED = freeze_config(
-        elements: BASIC[:elements] + ["address", "article", "aside", "bdi", "bdo", "body", "caption", "col",
-                                      "colgroup", "data", "del", "div", "figcaption", "figure", "footer", "h1", "h2", "h3", "h4", "h5", "h6", "head", "header", "hgroup", "hr", "html", "img", "ins", "main", "nav", "rp", "rt", "ruby", "section", "span", "style", "summary", "sup", "table", "tbody", "td", "tfoot", "th", "thead", "title", "tr", "wbr",],
+        elements: BASIC[:elements] + [
+          "address",
+          "article",
+          "aside",
+          "bdi",
+          "bdo",
+          "body",
+          "caption",
+          "col",
+          "colgroup",
+          "data",
+          "del",
+          "div",
+          "figcaption",
+          "figure",
+          "footer",
+          "h1",
+          "h2",
+          "h3",
+          "h4",
+          "h5",
+          "h6",
+          "head",
+          "header",
+          "hgroup",
+          "hr",
+          "html",
+          "img",
+          "ins",
+          "main",
+          "nav",
+          "rp",
+          "rt",
+          "ruby",
+          "section",
+          "span",
+          "style",
+          "summary",
+          "sup",
+          "table",
+          "tbody",
+          "td",
+          "tfoot",
+          "th",
+          "thead",
+          "title",
+          "tr",
+          "wbr",
+        ],
 
         allow_doctype: true,
 
-        attributes: merge(BASIC[:attributes],
+        attributes: merge(
+          BASIC[:attributes],
           :all => ["class", "dir", "hidden", "id", "lang", "style", "tabindex", "title", "translate"],
           "a" => ["href", "hreflang", "name", "rel"],
           "col" => ["span", "width"],
@@ -21,16 +69,29 @@ module Selma
           "li" => ["value"],
           "ol" => ["reversed", "start", "type"],
           "style" => ["media", "scoped", "type"],
-          "table" => ["align", "bgcolor", "border", "cellpadding", "cellspacing", "frame", "rules", "sortable",
-                      "summary", "width",],
+          "table" => [
+            "align",
+            "bgcolor",
+            "border",
+            "cellpadding",
+            "cellspacing",
+            "frame",
+            "rules",
+            "sortable",
+            "summary",
+            "width",
+          ],
           "td" => ["abbr", "align", "axis", "colspan", "headers", "rowspan", "valign", "width"],
           "th" => ["abbr", "align", "axis", "colspan", "headers", "rowspan", "scope", "sorted", "valign", "width"],
-          "ul" => ["type"]),
+          "ul" => ["type"],
+        ),
 
-        protocols: merge(BASIC[:protocols],
+        protocols: merge(
+          BASIC[:protocols],
           "del" => { "cite" => ["http", "https", :relative] },
           "img" => { "src"  => ["http", "https", :relative] },
-          "ins" => { "cite" => ["http", "https", :relative] }),
+          "ins" => { "cite" => ["http", "https", :relative] },
+        ),
       )
     end
   end

data/lib/selma/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Selma
-  VERSION = "0.0.5"
+  VERSION = "0.0.7"
 end

data/selma.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
 
   spec.require_paths = ["lib"]
-  spec.extensions = ["ext/selma/Cargo.toml"]
+  spec.extensions = ["ext/selma/extconf.rb"]
 
   spec.metadata = {
     "allowed_push_host" => "https://rubygems.org",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: selma
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.7
 platform: x86_64-linux
 authors:
 - Garen J. Torikian
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-12-27 00:00:00.000000000 Z
+date: 2023-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rb_sys
@@ -66,7 +66,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
-description:
+description: 
 email:
 - gjtorikian@gmail.com
 executables: []
@@ -91,6 +91,7 @@ files:
 - ext/selma/src/wrapped_struct.rs
 - lib/selma.rb
 - lib/selma/3.1/selma.so
+- lib/selma/3.2/selma.so
 - lib/selma/extension.rb
 - lib/selma/html.rb
 - lib/selma/rewriter.rb
@@ -103,7 +104,7 @@ files:
 - lib/selma/selector.rb
 - lib/selma/version.rb
 - selma.gemspec
-homepage:
+homepage: 
 licenses:
 - MIT
 metadata:
@@ -111,7 +112,7 @@ metadata:
   funding_uri: https://github.com/sponsors/gjtorikian/
   source_code_uri: https://github.com/gjtorikian/selma
   rubygems_mfa_required: 'true'
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -122,15 +123,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '3.1'
   - - "<"
     - !ruby/object:Gem::Version
-      version: 3.2.dev
+      version: 3.3.dev
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: 3.3.22
 requirements: []
-rubygems_version: 3.3.22
-signing_key:
+rubygems_version: 3.4.3
+signing_key: 
 specification_version: 4
 summary: Selma selects and matches HTML nodes using CSS rules. Backed by Rust's lol_html
   parser.