Make sure every filter can work with context

gjtorikian · gjtorikian · commit e35f5b917d93 · 2024-04-30T11:49:35.000-07:00
diff --git a/lib/html_pipeline.rb b/lib/html_pipeline.rb
@@ -160,7 +160,7 @@ def call(text, context: {}, 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)
+            perform_filter(filter, doc, context: (filter.context || {}).merge(context), result: result)
           end
       end
     end
@@ -171,7 +171,7 @@ def call(text, context: {}, result: {})
       text
     else
       instrument("call_convert_filter.html_pipeline", payload) do
-        html = @convert_filter.call(text, context: context)
+        html = @convert_filter.call(text, context: (@convert_filter.context || {}).merge(context))
       end
     end
 
diff --git a/lib/html_pipeline/convert_filter/markdown_filter.rb b/lib/html_pipeline/convert_filter/markdown_filter.rb
@@ -3,7 +3,7 @@
 HTMLPipeline.require_dependency("commonmarker", "MarkdownFilter")
 
 class HTMLPipeline
-  class ConvertFilter
+  class ConvertFilter < Filter
     # HTML Filter that converts Markdown text into HTML.
     #
     # Context options:
diff --git a/lib/html_pipeline/filter.rb b/lib/html_pipeline/filter.rb
@@ -16,6 +16,8 @@ class HTMLPipeline
   # Each filter may define additional options and output values. See the class
   # docs for more info.
   class Filter
+    attr_accessor :context
+
     class InvalidDocumentException < StandardError; end
 
     def initialize(context: {}, result: {})
diff --git a/lib/html_pipeline/node_filter.rb b/lib/html_pipeline/node_filter.rb
@@ -4,8 +4,6 @@
 
 class HTMLPipeline
   class NodeFilter < Filter
-    attr_accessor :context
-
     def initialize(context: {}, result: {})
       super(context: context, result: {})
       send(:after_initialize) if respond_to?(:after_initialize)
diff --git a/test/html_pipeline/node_filter/table_of_contents_filter_test.rb b/test/html_pipeline/node_filter/table_of_contents_filter_test.rb
@@ -28,7 +28,7 @@ def test_anchors_and_list_are_added_properly
       def test_custom_anchor_html_added_properly
         orig = %(# Ice cube)
         expected = %(<h1><a href="#ice-cube" aria-hidden="true" id="ice-cube" class="anchor">#</a>Ice cube</h1>)
-        pipeline = HTMLPipeline.new(convert_filter: HTMLPipeline::ConvertFilter::MarkdownFilter, node_filters: [
+        pipeline = HTMLPipeline.new(convert_filter: HTMLPipeline::ConvertFilter::MarkdownFilter.new, node_filters: [
           TocFilter.new(context: { anchor_html: "#" }),
         ])
         result = pipeline.call(orig)
diff --git a/test/html_pipeline_test.rb b/test/html_pipeline_test.rb
@@ -134,7 +134,7 @@ def test_context_is_carried_over_in_call
     assert_equal("<p><strong>yeH</strong>! I <em>think</em> <a href=\"/gjtorikian\">@gjtorikian</a> is <del>great</del>!</p>", result)
 
     context = {
-      no_bolding: false,
+      bolded: false,
       markdown: { extension: { strikethrough: false } },
       base_url: "http://your-domain.com",
     }
@@ -146,4 +146,52 @@ def test_context_is_carried_over_in_call
     # - mentions are linked
     assert_equal("<p>yeH! I <em>think</em> <a href=\"http://your-domain.com/gjtorikian\">@gjtorikian</a> is ~great~!</p>", result_with_context)
   end
+
+  def test_text_filter_instance_context_is_carried_over_in_call
+    text = "yeH! I _think_ <marquee>@gjtorikian is ~great~</marquee>!"
+
+    pipeline = HTMLPipeline.new(
+      text_filters: [YehBolderFilter.new(context: { bolded: false })],
+      convert_filter: HTMLPipeline::ConvertFilter::MarkdownFilter.new,
+      node_filters: [HTMLPipeline::NodeFilter::MentionFilter.new],
+    )
+
+    result = pipeline.call(text)[:output]
+
+    # note:
+    # - yeH is not bolded due to previous context
+    assert_equal("<p>yeH! I <em>think</em> <a href=\"/gjtorikian\">@gjtorikian</a> is <del>great</del>!</p>", result)
+  end
+
+  def test_convert_filter_instance_context_is_carried_over_in_call
+    text = "yeH! I _think_ <marquee>@gjtorikian is ~great~</marquee>!"
+
+    pipeline = HTMLPipeline.new(
+      text_filters: [YehBolderFilter.new],
+      convert_filter: HTMLPipeline::ConvertFilter::MarkdownFilter.new(context: { extension: { strikethrough: false } }),
+      node_filters: [HTMLPipeline::NodeFilter::MentionFilter.new],
+    )
+
+    result = pipeline.call(text)[:output]
+
+    # note:
+    # - strikethroughs are not rendered due to previous context
+    assert_equal("<p><strong>yeH</strong>! I <em>think</em> <a href=\"/gjtorikian\">@gjtorikian</a> is <del>great</del>!</p>", result)
+  end
+
+  def test_node_filter_instance_context_is_carried_over_in_call
+    text = "yeH! I _think_ <marquee>@gjtorikian is ~great~</marquee>!"
+
+    pipeline = HTMLPipeline.new(
+      text_filters: [YehBolderFilter.new],
+      convert_filter: HTMLPipeline::ConvertFilter::MarkdownFilter.new,
+      node_filters: [HTMLPipeline::NodeFilter::MentionFilter.new(context: { base_url: "http://your-domain.com" })],
+    )
+
+    result = pipeline.call(text)[:output]
+
+    # note:
+    # - mentions are linked
+    assert_equal("<p><strong>yeH</strong>! I <em>think</em> <a href=\"http://your-domain.com/gjtorikian\">@gjtorikian</a> is <del>great</del>!</p>", result)
+  end
 end
diff --git a/test/test_helper.rb b/test/test_helper.rb
@@ -25,6 +25,6 @@ def call(input, context: {}, result: {})
 # bolds any instance of the word yeH
 class YehBolderFilter < HTMLPipeline::TextFilter
   def call(input, context: {}, result: {})
-    input.gsub("yeH", "**yeH**") unless context[:no_bolding] == false
+    input.gsub("yeH", "**yeH**") unless context[:bolded] == false
   end
 end

Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`HTMLPipeline.require_dependency("commonmarker", "MarkdownFilter")`
`4`	`4`
`5`	`5`	`class HTMLPipeline`
`6`		`- class ConvertFilter`
	`6`	`+ class ConvertFilter < Filter`
`7`	`7`	`# HTML Filter that converts Markdown text into HTML.`
`8`	`8`	`#`
`9`	`9`	`# Context options:`