Merge pull request #398 from gjtorikian/classify

gjtorikian · web-flow · commit b9e02e38170e · 2024-02-28T17:32:47.000-05:00
[BREAKING] `TextFilter` now requires instantiation
diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/Gemfile b/Gemfile
@@ -10,8 +10,6 @@ gem "awesome_print"
 gem "rubocop"
 gem "rubocop-standard"
 
-gem "github_changelog_generator", "~> 1.16"
-
 gem "sorbet-runtime"
 
 group :development, :test do
diff --git a/README.md b/README.md
@@ -171,7 +171,7 @@ ALLOWLIST = {
 
 pipeline = HTMLPipeline.new \
   text_filters: [
-    HTMLPipeline::MarkdownFilter,
+    HTMLPipeline::TextFilter::ImageFilter.new,
   ],
   convert_filter: HTMLPipeline::ConvertFilter::MarkdownFilter.new,
   sanitization_config: ALLOWLIST
@@ -199,7 +199,7 @@ the config:
 ```ruby
 pipeline = HTMLPipeline.new \
   text_filters: [
-    HTMLPipeline::MarkdownFilter,
+    HTMLPipeline::TextFilter::ImageFilter.new,
   ],
   convert_filter: HTMLPipeline::ConvertFilter::MarkdownFilter.new,
   sanitization_config: nil
diff --git a/lib/html_pipeline.rb b/lib/html_pipeline.rb
@@ -153,7 +153,7 @@ def call(text, context: {}, result: {})
 
     if @text_filters.any?
       payload = default_payload({
-        text_filters: @text_filters.map(&:name),
+        text_filters: @text_filters.map { |f| f.class.name },
         context: context,
         result: result,
       })
@@ -204,7 +204,7 @@ def call(text, context: {}, result: {})
   # Returns the result of the filter.
   def perform_filter(filter, doc, context: {}, result: {})
     payload = default_payload({
-      filter: filter.name,
+      filter: filter.class.name,
       context: context,
       result: result,
     })
diff --git a/lib/html_pipeline/text_filter.rb b/lib/html_pipeline/text_filter.rb
@@ -4,17 +4,17 @@ class HTMLPipeline
   class TextFilter < Filter
     attr_reader :text
 
-    def initialize(text, context: {}, result: {})
-      raise TypeError, "text must be a String" unless text.is_a?(String)
-
-      # Ensure that this is always a string
-      @text = text.respond_to?(:to_str) ? text.to_str : text.to_s
+    def initialize(context: {}, result: {})
       super(context: context, result: result)
     end
 
     class << self
-      def call(input, context: {}, result: {})
-        new(input, context: context, result: result).call
+      def call(text, context: {}, result: {})
+        raise TypeError, "text must be a String" unless text.is_a?(String)
+
+        # Ensure that this is always a string
+        text = text.respond_to?(:to_str) ? text.to_str : text.to_s
+        new(context: context, result: result).call(text)
       end
     end
   end
diff --git a/lib/html_pipeline/text_filter/image_filter.rb b/lib/html_pipeline/text_filter/image_filter.rb
@@ -9,8 +9,8 @@ class TextFilter
     #   <img src="http://example.com/test.jpg" alt=""/>.
 
     class ImageFilter < TextFilter
-      def call
-        @text.gsub(%r{(https|http)?://.+\.(jpg|jpeg|bmp|gif|png)(\?\S+)?}i) do |match|
+      def call(text)
+        text.gsub(%r{(https|http)?://.+\.(jpg|jpeg|bmp|gif|png)(\?\S+)?}i) do |match|
           %(<img src="#{match}" alt=""/>)
         end
       end
diff --git a/lib/html_pipeline/text_filter/plain_text_input_filter.rb b/lib/html_pipeline/text_filter/plain_text_input_filter.rb
@@ -5,8 +5,8 @@ class TextFilter
     # Simple filter for plain text input. HTML escapes the text input and wraps it
     # in a div.
     class PlainTextInputFilter < TextFilter
-      def call
-        "<div>#{CGI.escapeHTML(@text)}</div>"
+      def call(text)
+        "<div>#{CGI.escapeHTML(text)}</div>"
       end
     end
   end
diff --git a/lib/html_pipeline/version.rb b/lib/html_pipeline/version.rb
@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class HTMLPipeline
-  VERSION = "3.0.3"
+  VERSION = "3.1.0"
 end
diff --git a/script/generate_changelog b/script/generate_changelog
diff --git a/test/html_pipeline/convert_filter/markdown_filter_test.rb b/test/html_pipeline/convert_filter/markdown_filter_test.rb
@@ -16,8 +16,8 @@ def setup
         "See http://example.org/ for more info"
       @code =
         "```\n" \
-          "def hello()" \
-          "  'world'" \
+          "def hello()  " \
+          "'world'" \
           "end" \
           "```"
       @header = <<~DOC
diff --git a/test/html_pipeline_test.rb b/test/html_pipeline_test.rb
@@ -3,11 +3,13 @@
 require "test_helper"
 require "helpers/mocked_instrumentation_service"
 require "html_pipeline/node_filter/image_max_width_filter"
+require "html_pipeline/node_filter/mention_filter"
+require "html_pipeline/convert_filter/markdown_filter"
 
 class HTMLPipelineTest < Minitest::Test
   def setup
     @default_context = {}
-    @pipeline = HTMLPipeline.new(text_filters: [TestTextFilter], default_context: @default_context)
+    @pipeline = HTMLPipeline.new(text_filters: [TestReverseFilter.new], default_context: @default_context)
   end
 
   def test_filter_instrumentation
@@ -20,7 +22,7 @@ def test_filter_instrumentation
 
     assert(event, "event expected")
     assert_equal("call_filter.html_pipeline", event)
-    assert_equal(TestTextFilter.name, payload[:filter])
+    assert_equal(TestReverseFilter.name, payload[:filter])
     assert_equal(@pipeline.class.name, payload[:pipeline])
     assert_equal(body.reverse, payload[:result][:output])
   end
@@ -35,7 +37,8 @@ def test_pipeline_instrumentation
 
     assert(event, "event expected")
     assert_equal("call_text_filters.html_pipeline", event)
-    assert_equal(@pipeline.text_filters.map(&:name), payload[:text_filters])
+
+    assert_equal(@pipeline.text_filters.map { |x| x.class.name }, payload[:text_filters])
     assert_equal(@pipeline.class.name, payload[:pipeline])
     assert_equal(body.reverse, payload[:result][:output])
   end
@@ -73,7 +76,7 @@ def test_setup_instrumentation
 
   def test_incorrect_text_filters
     assert_raises(HTMLPipeline::InvalidFilterError) do
-      HTMLPipeline.new(text_filters: [HTMLPipeline::NodeFilter::MentionFilter], default_context: @default_context)
+      HTMLPipeline.new(text_filters: [HTMLPipeline::NodeFilter::MentionFilter.new], default_context: @default_context)
     end
   end
 
@@ -86,7 +89,7 @@ def test_incorrect_convert_filter
   def test_convert_filter_needed_for_text_and_html_filters
     assert_raises(HTMLPipeline::InvalidFilterError) do
       HTMLPipeline.new(
-        text_filters: [TestTextFilter],
+        text_filters: [TestReverseFilter.new],
         node_filters: [
           HTMLPipeline::NodeFilter::MentionFilter.new,
         ],
@@ -100,4 +103,17 @@ def test_incorrect_node_filters
       HTMLPipeline.new(node_filters: [HTMLPipeline::ConvertFilter::MarkdownFilter], default_context: @default_context)
     end
   end
+
+  def test_kitchen_sink
+    text = "Hey there, @billy. Love to see <marquee>yah</marquee>!"
+
+    pipeline = HTMLPipeline.new(
+      text_filters: [TestReverseFilter.new, YehBolderFilter.new],
+      convert_filter: HTMLPipeline::ConvertFilter::MarkdownFilter.new,
+      node_filters: [HTMLPipeline::NodeFilter::MentionFilter.new],
+    )
+    result = pipeline.call(text)[:output]
+
+    assert_equal("<p>!&gt;eeuqram/eeuqram&lt; ees ot evoL .yllib@ ,ereht <strong>yeH</strong></p>", result)
+  end
 end
diff --git a/test/test_helper.rb b/test/test_helper.rb
@@ -16,10 +16,15 @@ module TestHelpers
 
 Minitest::Test.include(TestHelpers)
 
-class TestTextFilter < HTMLPipeline::TextFilter
-  class << self
-    def call(input, context: {}, result: {})
-      input.reverse
-    end
+class TestReverseFilter < HTMLPipeline::TextFilter
+  def call(input, context: {}, result: {})
+    input.reverse
+  end
+end
+
+# bolds any instance of the word yeH
+class YehBolderFilter < HTMLPipeline::TextFilter
+  def call(input, context: {}, result: {})
+    input.gsub("yeH", "**yeH**")
   end
 end
