html-pipeline 3.1.1 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fabe2eaefdce46521fffa5ddbbe5fc1d77a763a48ad4beab286ff77cabd2bbd4
-  data.tar.gz: faf1d2aea3de3f6ee47e309cf7bd6fe631aa027c164525fd2eee7b8b038e845b
+  metadata.gz: e8252d2015129b2ee071b6c094a773afecd796a75d0ab3d24aaa18b997be8f1f
+  data.tar.gz: 3ace3231f84d7f5a82b4921d2ee600a4ae069440adb15e4ee527eda290b00637
 SHA512:
-  metadata.gz: b7e3b4445465f84909c991cfbbbcadc268c95e2ff0936748eb4257f046201a4a3abe65f9117cfba9679246adc2292e7a379d5eb9fad50dfb40fc3534ea330c21
-  data.tar.gz: 97d015f909923900889e2fea5ee077f56ddd8166089c98f1860280c52be5ba01a363c87f404a15d6fbb6519b04aa1f2d6d9281dfc07c9ab36ceb43c851672ef9
+  metadata.gz: be71b5590d6599b2a2c8d6dfdb98b27e61701a07bbc1a0aa14982459bfd65d8aec69228318834c939a6357dff03c982e739d2a39a83853e12016049e2ddd13e2
+  data.tar.gz: b90b25b60016557c21eef5ee431c21890f5580589fabfafbe36e530ff3dc63cd3e3a83cf835c757cf8b7398e58c2f290096cf7ef8173177a27457b15871fe5e9

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## [v3.1.1] - 09-04-2024
+## What's Changed
+* Correct missing method implementation by @gjtorikian in https://github.com/gjtorikian/html-pipeline/pull/401
+
+
+**Full Changelog**: https://github.com/gjtorikian/html-pipeline/compare/v3.1.0...v3.1.1
 ## [v3.1.0] - 28-02-2024
 ## What's Changed
 * UPGRADING:  not removed by @dentarg in https://github.com/gjtorikian/html-pipeline/pull/397

data/README.md

@@ -1,8 +1,5 @@
 # HTML-Pipeline
 
-> **Note**
-> This README refers to the behavior in the new 3.0.0.pre gem.
-
 HTML processing filters and utilities. This module is a small
 framework for defining CSS-based content filters and applying them to user
 provided content.
@@ -60,9 +57,15 @@ results tothe next filter. A pipeline has several kinds of filters available to
 
 You can assemble each sequence into a single pipeline, or choose to call each filter individually.
 
-As an example, suppose we want to transform Commonmark source text into Markdown HTML. With the content, we also want to:
+As an example, suppose we want to transform Commonmark source text into Markdown HTML:
 
-- change every instance of `$NAME` to "`Johnny"
+```
+Hey there, @gjtorikian
+```
+
+With the content, we also want to:
+
+- change every instance of `Hey` to `Hello`
 - strip undesired HTML
 - linkify @mention
 
@@ -73,7 +76,7 @@ require 'html_pipeline'
 
 class HelloJohnnyFilter < HTMLPipelineFilter
   def call
-    text.gsub("$NAME", "Johnny")
+    text.gsub("Hey", "Hello")
   end
 end
 
@@ -104,11 +107,21 @@ 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 } } }
+context = { markdown: { extensions: { footnotes: false } } }
 filter = HTMLPipeline::ConvertFilter::MarkdownFilter.new(context: context)
 filter.call("Hi **world**!")
 ```
 
+Alternatively, you can construct a pipeline, and pass in a context during the call:
+
+```ruby
+pipeline = HTMLPipeline.new(
+  convert_filter: HTMLPipeline::ConvertFilter::MarkdownFilter.new,
+  node_filters: [HTMLPipeline::NodeFilter::MentionFilter.new]
+)
+pipeline.call(user_supplied_text, context: { markdown: { extensions: { footnotes: false } } })
+```
+
 Please refer to the documentation for each filter to understand what configuration options are available.
 
 ### More Examples

data/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:
@@ -16,8 +16,8 @@ class HTMLPipeline
       end
 
       # Convert Commonmark to HTML using the best available implementation.
-      def call(text)
-        options = @context.fetch(:markdown, {})
+      def call(text, context: @context)
+        options = context.fetch(:markdown, {})
         plugins = options.fetch(:plugins, {})
         Commonmarker.to_html(text, options: options, plugins: plugins).rstrip!
       end

data/lib/html_pipeline/filter.rb

@@ -27,7 +27,7 @@ class HTMLPipeline
     # Public: Returns a simple Hash used to pass extra information into filters
     # and also to allow filters to make extracted information available to the
     # caller.
-    attr_reader :context
+    attr_accessor :context
 
     # Public: Returns a Hash used to allow filters to pass back information
     # to callers of the various Pipelines.  This can be used for

data/lib/html_pipeline/node_filter.rb

@@ -4,6 +4,8 @@ require "selma"
 
 class HTMLPipeline
   class NodeFilter < Filter
+    attr_accessor :context
+
     def initialize(context: {}, result: {})
       super(context: context, result: {})
       send(:after_initialize) if respond_to?(:after_initialize)

data/lib/html_pipeline/version.rb

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

data/lib/html_pipeline.rb

@@ -160,7 +160,7 @@ class HTMLPipeline
       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,12 +171,13 @@ class HTMLPipeline
       text
     else
       instrument("call_convert_filter.html_pipeline", payload) do
-        html = @convert_filter.call(text)
+        html = @convert_filter.call(text, context: (@convert_filter.context || {}).merge(context))
       end
     end
 
     unless @node_filters.empty?
       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).rewrite(html)
         html = result[:output]
         payload = default_payload({
@@ -187,7 +188,7 @@ class HTMLPipeline
       end
     end
 
-    instrument("html_pipeline.sanitization", payload) do
+    instrument("sanitization.html_pipeline", payload) do
       result[:output] = Selma::Rewriter.new(sanitizer: @sanitization_config, handlers: @node_filters).rewrite(html)
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: html-pipeline
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.2.0
 platform: ruby
 authors:
 - Garen J. Torikian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-04-09 00:00:00.000000000 Z
+date: 2024-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selma