Provide Roda plugin to mix in Streamlined helpers

Author: jaredcwhite

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## [Unreleased]
 
+## [0.4.0] — 2024-04-04
+
+- Provide Roda plugin to mix in Streamlined helpers.
+
 ## [0.3.1] - 2023-11-10
 
 - Ensure false or nil values for attributes avoid rendering attributes at all

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    streamlined (0.3.1)
+    streamlined (0.4.0)
       serbea (>= 2.1)
       zeitwerk (~> 2.5)
 

README.md

@@ -1,6 +1,6 @@
 # Streamlined
 
-Component rendering for Ruby using streamlined procs & heredocs. Rails and Bridgetown both supported.
+HTML fragment and component rendering for Ruby using streamlined procs & heredocs with safety checks via RuboCop. Bridgetown, Roda, and Rails all supported.
 
 ## Installation
 
@@ -10,7 +10,7 @@ Add Streamlined to your application's Gemfile by running:
 bundle add streamlined
 ```
 
-(If you're using Bridgetown, it's bundled in for Bridgetown 1.4…coming soon)
+(If you're using Bridgetown, it's bundled in for Bridgetown 2.0…coming soon)
 
 ## Usage
 

lib/roda/plugins/streamlined.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+class Roda
+  module RodaPlugins
+    module Streamlined
+      module CheckForStreamlined
+        def self.===(other)
+          other.is_a?(Proc) && other.respond_to?(:touched) && other.touched
+        end
+      end
+
+      module InstanceMethods
+        include ::Streamlined::Helpers
+      end
+
+      def self.load_dependencies(app, _opts = OPTS)
+        app.plugin :custom_block_results
+      end
+
+      def self.configure(app, _opts = OPTS)
+        app.handle_block_result CheckForStreamlined, &:to_s
+      end
+    end
+
+    register_plugin :streamlined, Streamlined
+  end
+end

lib/streamlined.rb

@@ -4,13 +4,17 @@
 require "serbea/pipeline"
 require "zeitwerk"
 loader = Zeitwerk::Loader.for_gem
+loader.ignore("#{__dir__}/roda")
 loader.setup
 
 module Streamlined
   class Error < StandardError; end
 end
 
 if defined?(Bridgetown)
-  Bridgetown.initializer :streamlined do # |config|
+  Bridgetown.initializer :streamlined do |config|
+    config.roda do |app|
+      app.plugin :streamlined
+    end
   end
 end

lib/streamlined/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Streamlined
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

streamlined.gemspec

@@ -8,10 +8,10 @@ Gem::Specification.new do |spec|
   spec.author = "Bridgetown Team"
   spec.email = "[email protected]"
 
-  spec.summary = "Component rendering for Ruby using streamlined procs & heredocs."
+  spec.summary = "HTML fragment & component rendering for Ruby using streamlined procs & heredocs."
   spec.homepage = "https://github.com/bridgetownrb/streamlined"
   spec.license = "MIT"
-  spec.required_ruby_version = ">= 3.0"
+  spec.required_ruby_version = ">= 3.1"
   spec.metadata["rubygems_mfa_required"] = "true"
 
   # Specify which files should be added to the gem when it is released.

test/test_streamlined.rb

@@ -48,11 +48,12 @@ def template(&block)
     false_value = false
     nil_value = nil
     other_value = 123
+    tags_in_attribute = "<h3>Whoa</h3>"
 
     render html -> { <<~HTML
       <section>
         <h1 #{html_attributes(false_value:, nil_value:, other_value:)}>#{text -> { heading }}</h1>
-        <h2>#{text -> { @name }}</h2>
+        <h2 class="#{text -> { tags_in_attribute }}">#{text -> { @name }}</h2>
         #{html -> { capture(self, &block) }}
         <footer>#{text -> { @number }.pipe { multiplied_by(10) }}</footer>
       </section>
@@ -108,6 +109,7 @@ def test_component_output
     # test a couple of things on the raw HTML output
     assert_includes rendered_markup, "I should be &lt;&quot;escaped&quot;&gt;"
     assert_includes rendered_markup, %(<h1 other-value="123">)
+    assert_includes rendered_markup, "<h2 class=\"&lt;h3&gt;Whoa&lt;/h3&gt;\">"
 
     document_root(rendered_markup)