Merge pull request #418 from gjtorikian/allow-for-text-pipeline

Allow for "just text" pipelines

Author: gjtorikian

.rubocop.yml

@@ -15,3 +15,6 @@ AllCops:
     - "vendor/**/*"
     - "tmp/**/*"
     - "test/progit/**/*"
+
+ThreadSafety/ClassAndModuleAttributes:
+  Enabled: false

lib/html_pipeline.rb

@@ -122,7 +122,7 @@ def initialize(text_filters: [], convert_filter: nil, sanitization_config: Sanit
 
     @convert_filter = convert_filter
 
-    if @convert_filter.nil? && (!@text_filters.empty? && !@node_filters.empty?)
+    if @convert_filter.nil? && !@text_filters.empty? && !@node_filters.empty?
       raise InvalidFilterError, "Must provide `convert_filter` if `text_filters` and `node_filters` are also provided"
     elsif !@convert_filter.nil?
       validate_filter(@convert_filter, HTMLPipeline::ConvertFilter)
@@ -154,13 +154,13 @@ def call(text, context: {}, result: {})
     if @text_filters.any?
       payload = default_payload({
         text_filters: @text_filters.map { |f| f.class.name },
-        context: context,
-        result: result,
+        context:,
+        result:,
       })
       instrument("call_text_filters.html_pipeline", payload) do
         result[:output] =
           @text_filters.inject(text) do |doc, filter|
-            perform_filter(filter, doc, context: (filter.context || {}).merge(context), result: result)
+            perform_filter(filter, doc, context: (filter.context || {}).merge(context), result:)
           end
       end
     end
@@ -181,18 +181,18 @@ def call(text, context: {}, result: {})
       },
     }
 
-    if @node_filters.empty?
+    if @node_filters.empty? && !@sanitization_config.nil?
       instrument("sanitization.html_pipeline", payload) do
         result[:output] = Selma::Rewriter.new(sanitizer: @sanitization_config, options: rewriter_options).rewrite(html)
       end
-    else
+    elsif @node_filters.any?
       instrument("call_node_filters.html_pipeline", payload) do
         @node_filters.each { |filter| filter.context = (filter.context || {}).merge(context) }
         result[:output] = Selma::Rewriter.new(sanitizer: @sanitization_config, handlers: @node_filters, options: rewriter_options).rewrite(html)
         payload = default_payload({
           node_filters: @node_filters.map { |f| f.class.name },
-          context: context,
-          result: result,
+          context:,
+          result:,
         })
       end
     end
@@ -211,18 +211,18 @@ def call(text, context: {}, result: {})
   def perform_filter(filter, doc, context: {}, result: {})
     payload = default_payload({
       filter: filter.class.name,
-      context: context,
-      result: result,
+      context:,
+      result:,
     })
 
     instrument("call_filter.html_pipeline", payload) do
-      filter.call(doc, context: context, result: result)
+      filter.call(doc, context:, result:)
     end
   end
 
   # Like call but guarantee the value returned is a string of HTML markup.
   def to_html(input, context: {}, result: {})
-    result = call(input, context: context, result: result)
+    result = call(input, context:, result:)
     output = result[:output]
     if output.respond_to?(:to_html)
       output.to_html

lib/html_pipeline/version.rb

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

test/html_pipeline_test.rb

@@ -104,6 +104,18 @@ def test_incorrect_node_filters
     end
   end
 
+  def test_just_text_filters
+    text = "Hey there, @billy."
+
+    pipeline = HTMLPipeline.new(
+      text_filters: [TestReverseFilter.new],
+      convert_filter: nil,
+    )
+    result = pipeline.call(text)[:output]
+
+    assert_equal(".yllib@ ,ereht yeH", result)
+  end
+
   def test_kitchen_sink
     text = "Hey there, @billy. Love to see <marquee>yah</marquee>!"