html-pipeline 3.0.1 → 3.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca6ca26f7072957b016a32ac4f88923b1f7a34da25b91646612783bae9fd0cef
-  data.tar.gz: 44c0de334401dbdb58cbfc68f398311beb61b135f6fc3931c63818f063c0fc7d
+  metadata.gz: 22c3391b770c24cbed1ea42f396fabfa399935416c8d01a8ce8727094c456fe4
+  data.tar.gz: 6936f1943d251689b0bef19f43348ac46e2027d658ec7544dc4799ab98600602
 SHA512:
-  metadata.gz: e582606d24060d6e54387df1014182c8b7952d3f84fbe7d68fd135ac0e3c93826241810cf9fa5eb36c8c9f864f4fffa9935d36f1813b9604bf7307a360d52132
-  data.tar.gz: c7c1e2bfd59d9607f877c1134ffe05a4da93f070763240c88fac61316fb861f61e80ea93df3400bc9fe353dc6411de24194ef2e3e4e3f2131ca6a0fb0a96d87d
+  metadata.gz: dce1a303621b079f2e482007ad77761d745ca0bdec98bf405cedeb5d4f1b6a097b7c28bf96e919ae2b2b5129cc1bf0f528dd6d4e617eafb2767f760a24079a6e
+  data.tar.gz: 821a0b306d7cc440069ae38ca857f7ed157d1ec5c3decbbbcfc3a4fd05b5c17e975e493e9017ac1eaed5a216de0b00dfc3bed405e64e40b2d1e03a04b44b14cb

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+## [v3.0.2] - 08-01-2024
+## What's Changed
+* README.md: Fix example code by @grekko in https://github.com/gjtorikian/html-pipeline/pull/390
+* Allow pipeline to run without node filters by @gjtorikian in https://github.com/gjtorikian/html-pipeline/pull/392
+
+## New Contributors
+* @grekko made their first contribution in https://github.com/gjtorikian/html-pipeline/pull/390
+
+**Full Changelog**: https://github.com/gjtorikian/html-pipeline/compare/v3.0.1...v3.0.2
+## [v3.0.1] - 28-12-2023
+## What's Changed
+* Handle odd numbers of NodeFilters to be configured by @stevehill1981 in https://github.com/gjtorikian/html-pipeline/pull/389
+
+## New Contributors
+* @stevehill1981 made their first contribution in https://github.com/gjtorikian/html-pipeline/pull/389
+
+**Full Changelog**: https://github.com/gjtorikian/html-pipeline/compare/v3.0.0...v3.0.1
 ## [v3.0.0] - 24-12-2023
 ## What's Changed
 * Switch to GitHub Actions by @gjtorikian in https://github.com/gjtorikian/html-pipeline/pull/346

data/README.md

@@ -91,8 +91,8 @@ pipeline.call(user_supplied_text) # recommended: can call pipeline over and over
 Filters can be custom ones you create (like `HelloJohnnyFilter`), and `HTMLPipeline` additionally provides several helpful ones (detailed below). If you only need a single filter, you can call one individually, too:
 
 ```ruby
-filter = HTMLPipeline::ConvertFilter::MarkdownFilter.new(text)
-filter.call
+filter = HTMLPipeline::ConvertFilter::MarkdownFilter.new
+filter.call(text)
 ```
 
 Filters combine into a sequential pipeline, and each filter hands its
@@ -104,9 +104,9 @@ used to pass around arguments and metadata between filters in a pipeline. For
 example, if you want to disable footnotes in the `MarkdownFilter`, you can pass an option in the context hash:
 
 ```ruby
-context =  { markdown: extensions: { footnotes: false } }
-filter = HTMLPipeline::ConvertFilter::MarkdownFilter.new("Hi **world**!", context: context)
-filter.call
+context =  { markdown: { extensions: { footnotes: false } } }
+filter = HTMLPipeline::ConvertFilter::MarkdownFilter.new(context: context)
+filter.call("Hi **world**!")
 ```
 
 Please refer to the documentation for each filter to understand what configuration options are available.
@@ -375,7 +375,7 @@ you to add additional elements. You can either modify the constant's value, or
 re-define your own config and pass that in, such as:
 
 ```ruby
-config = HTMLPipeline::SanitizerFilter::DEFAULT_CONFIG.dup
+config = HTMLPipeline::SanitizationFilter::DEFAULT_CONFIG.dup
 config[:elements] << "iframe" # sure, whatever you want
 ```
 

data/lib/html_pipeline/sanitization_filter.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "selma"
+
 class HTMLPipeline
   # A special filter with sanization routines and allowlists. This module defines
   # what HTML is allowed in user provided content and fixes up issues with

data/lib/html_pipeline/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class HTMLPipeline
-  VERSION = "3.0.1"
+  VERSION = "3.0.3"
 end

data/lib/html_pipeline.rb

@@ -114,10 +114,10 @@ class HTMLPipeline
   def initialize(text_filters: [], convert_filter: nil, sanitization_config: SanitizationFilter::DEFAULT_CONFIG, node_filters: [], default_context: {}, result_class: Hash)
     raise ArgumentError, "default_context cannot be nil" if default_context.nil?
 
-    @text_filters = text_filters.flatten.freeze
+    @text_filters = text_filters.flatten.freeze || []
     validate_filters(@text_filters, HTMLPipeline::TextFilter)
 
-    @node_filters = node_filters.flatten.freeze
+    @node_filters = node_filters.flatten.freeze || []
     validate_filters(@node_filters, HTMLPipeline::NodeFilter)
 
     @convert_filter = convert_filter
@@ -151,33 +151,46 @@ class HTMLPipeline
     context = context.freeze
     result ||= {}
 
-    payload = default_payload({
-      text_filters: @text_filters.map(&:name),
-      context: context,
-      result: result,
-    })
-    instrument("call_text_filters.html_pipeline", payload) do
-      result[:output] =
-        @text_filters.inject(text) do |doc, filter|
-          perform_filter(filter, doc, context: context, result: result)
-        end
+    if @text_filters.any?
+      payload = default_payload({
+        text_filters: @text_filters.map(&:name),
+        context: context,
+        result: result,
+      })
+      instrument("call_text_filters.html_pipeline", payload) do
+        result[:output] =
+          @text_filters.inject(text) do |doc, filter|
+            perform_filter(filter, doc, context: context, result: result)
+          end
+      end
     end
 
-    text = result[:output]
+    text = result[:output] || text
 
-    html = @convert_filter.call(text) unless @convert_filter.nil?
+    html = if @convert_filter.nil?
+      text
+    else
+      instrument("call_convert_filter.html_pipeline", payload) do
+        html = @convert_filter.call(text)
+      end
+    end
 
     unless @node_filters.empty?
-      payload = default_payload({
-        node_filters: @node_filters.map { |f| f.class.name },
-        context: context,
-        result: result,
-      })
       instrument("call_node_filters.html_pipeline", payload) do
         result[:output] = Selma::Rewriter.new(sanitizer: @sanitization_config, handlers: @node_filters).rewrite(html)
+        html = result[:output]
+        payload = default_payload({
+          node_filters: @node_filters.map { |f| f.class.name },
+          context: context,
+          result: result,
+        })
       end
     end
 
+    instrument("html_pipeline.sanitization", payload) do
+      result[:output] = Selma::Rewriter.new(sanitizer: @sanitization_config, handlers: @node_filters).rewrite(html)
+    end
+
     result = result.merge(@node_filters.collect(&:result).reduce({}, :merge))
     @node_filters.each(&:reset!)
 
@@ -195,6 +208,7 @@ class HTMLPipeline
       context: context,
       result: result,
     })
+
     instrument("call_filter.html_pipeline", payload) do
       filter.call(doc, context: context, result: result)
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: html-pipeline
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.0.3
 platform: ruby
 authors:
 - Garen J. Torikian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-12-28 00:00:00.000000000 Z
+date: 2024-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selma
@@ -111,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 3.3.22
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.5
 signing_key: 
 specification_version: 4
 summary: Helpers for processing content through a chain of filters