html-pipeline 3.0.0 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 248d46dd59af87c501118e123ac1ffa5e16447942ca892a9b4985e0fa43c6548
-  data.tar.gz: 48a75cb97c189f4da648df25121e96efd4a9a278081c6ddd75c129c86f4fcbdd
+  metadata.gz: ad9e9991f181f9b708acdb8b5ba27537e759f3f87cd624c2587e248524747f0f
+  data.tar.gz: ffaa220bac349aedd97a240de688c6ef0abe44b947a8aedd9df804fc13057e71
 SHA512:
-  metadata.gz: f2fb4d1b8097e9c0af8eb9621701484a5701a12183fcabe13729f19f42f4648bfebf4d76830c90611d734ff5d9d93b5253f8a269b011cac0b5c38aa7e48bfffc
-  data.tar.gz: e0721ac24b36925bf40b63fbae758f7c649b36c501bcb0769219551500f586d2c3643922be3588aaf65e6393dd064bf382a64ade7f31cebba3d7a2a58b6c92bc
+  metadata.gz: 41179127f775429b7de505c334d76a22771a903a9bcfb4fe6c47c344aae6fa94b92d15a66fb41bb61657924a5360548858ee7c7daac08476c2b72be73f355230
+  data.tar.gz: 1f937f9f2eee0ea99d5d8c1069648f10c8702da88524057e70aa1ca691be1a49bf645f249bdb07b6d4ccc8c9620ec463ca85f2285274cfee29a3f052368128c9

data/CHANGELOG.md

@@ -1,3 +1,40 @@
+## [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
+* add truffleruby-head by @gogainda in https://github.com/gjtorikian/html-pipeline/pull/348
+* Add Rubocop by @gjtorikian in https://github.com/gjtorikian/html-pipeline/pull/349
+* Support multiple dependencies per filter by @gjtorikian in https://github.com/gjtorikian/html-pipeline/pull/351
+* Split filters up by @gjtorikian in https://github.com/gjtorikian/html-pipeline/pull/360
+* Migrate from Nokogiri to Selma by @gjtorikian in https://github.com/gjtorikian/html-pipeline/pull/368
+* You shall pass by @gjtorikian in https://github.com/gjtorikian/html-pipeline/pull/369
+* Update Selma signatures by @gjtorikian in https://github.com/gjtorikian/html-pipeline/pull/370
+* Close sanitization-related issues by @gjtorikian in https://github.com/gjtorikian/html-pipeline/pull/371
+* Drop SyntaxHighlightFilter by @gjtorikian in https://github.com/gjtorikian/html-pipeline/pull/372
+* V3 Release by @gjtorikian in https://github.com/gjtorikian/html-pipeline/pull/347
+* Use emoji from commonmarker by @gjtorikian in https://github.com/gjtorikian/html-pipeline/pull/373
+* req convert_filter if filter present by @gjtorikian in https://github.com/gjtorikian/html-pipeline/pull/375
+* Update selma requirement from ~> 0.0.1 to >= 0.0.1, < 0.2.0 by @dependabot in https://github.com/gjtorikian/html-pipeline/pull/377
+* Add the AssetProxyFilter by @digitalmoksha in https://github.com/gjtorikian/html-pipeline/pull/379
+* Update rouge requirement from ~> 3.1 to ~> 4.1 by @dependabot in https://github.com/gjtorikian/html-pipeline/pull/381
+* Update gemoji requirement from ~> 3.0 to ~> 4.1 by @dependabot in https://github.com/gjtorikian/html-pipeline/pull/382
+* Have Zeitwerk not automatically load filters by @gjtorikian in https://github.com/gjtorikian/html-pipeline/pull/383
+* Bump the github-actions group with 1 update by @dependabot in https://github.com/gjtorikian/html-pipeline/pull/384
+* :gem: 3.0.0 by @gjtorikian in https://github.com/gjtorikian/html-pipeline/pull/386
+
+## New Contributors
+* @gogainda made their first contribution in https://github.com/gjtorikian/html-pipeline/pull/348
+* @dependabot made their first contribution in https://github.com/gjtorikian/html-pipeline/pull/377
+* @digitalmoksha made their first contribution in https://github.com/gjtorikian/html-pipeline/pull/379
+
+**Full Changelog**: https://github.com/gjtorikian/html-pipeline/compare/v2.14.3...v3.0.0
 ## [v3.0.0.pre6] - 16-08-2023
 null
 # Changelog

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.

data/lib/html_pipeline/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class HTMLPipeline
-  VERSION = "3.0.0"
+  VERSION = "3.0.2"
 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,34 +151,47 @@ 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
 
-    result = result.merge(Hash[*@node_filters.collect(&:result).flatten])
+    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!)
 
     result
@@ -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.0
+  version: 3.0.2
 platform: ruby
 authors:
 - Garen J. Torikian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-12-24 00:00:00.000000000 Z
+date: 2024-01-08 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.4
 signing_key: 
 specification_version: 4
 summary: Helpers for processing content through a chain of filters