Introduce RenderHelper to reuse StreamHelpers in model broadcasts (#43)

* Introduce `TurboPower::RenderHelper` to reuse `StreamHelpers` in model broadcasts

* Update dummy app

Author: marcoroth

.github/workflows/tests.yml

@@ -4,6 +4,9 @@ on:
   push:
   pull_request:
 
+env:
+  RAILS_ENV: test
+
 jobs:
   build:
     runs-on: ubuntu-latest
@@ -26,5 +29,9 @@ jobs:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
 
+      - name: Setup database
+        run: bundle exec rake db:create db:migrate
+        working-directory: test/dummy
+
       - name: Run tests
         run: bundle exec rake test

Gemfile

@@ -8,7 +8,8 @@ gem "rake", "~> 13.0"
 gem "rubocop", "~> 1.21"
 
 group :test do
-  gem "sprockets-rails"
-  gem "sqlite3"
+  gem "rails"
   gem "simplecov"
+  gem "sprockets-rails"
+  gem "sqlite3", "~> 1.3"
 end

lib/turbo_power.rb

@@ -6,6 +6,7 @@
 require_relative "turbo_power/engine"
 require_relative "turbo_power/attribute_transformations"
 require_relative "turbo_power/stream_helper"
+require_relative "turbo_power/render_helper"
 require_relative "turbo_power/broadcasts"
 require_relative "turbo_power/broadcastable"
 

lib/turbo_power/broadcasts.rb

@@ -17,7 +17,7 @@ module Broadcasts
     def custom_broadcast_action_to(*streamables, action:, **attributes)
       broadcast_stream_to(
         *streamables,
-        content: turbo_stream_action_tag(action, **attributes)
+        content: RenderHelper.public_send(action, **attributes)
       )
     end
 

lib/turbo_power/render_helper.rb

@@ -0,0 +1,28 @@
+module TurboPower
+  class RenderHelper
+    extend ActionView::Helpers::TagHelper
+    extend TurboPower::StreamHelper
+
+    def self.turbo_stream_action_tag(action, target: nil, targets: nil, template: nil, **attributes)
+      template = action.to_sym.in?(%i[ remove refresh ]) ? "" : tag.template(template.to_s.html_safe)
+
+      if target = convert_to_turbo_stream_dom_id(target)
+        tag.turbo_stream(template, **attributes, action: action, target: target)
+      elsif targets = convert_to_turbo_stream_dom_id(targets, include_selector: true)
+        tag.turbo_stream(template, **attributes, action: action, targets: targets)
+      else
+        tag.turbo_stream(template, **attributes, action: action)
+      end
+    end
+
+    private
+
+    def self.convert_to_turbo_stream_dom_id(target, include_selector: false)
+      if Array(target).any? { |value| value.respond_to?(:to_key) }
+        "#{"#" if include_selector}#{ActionView::RecordIdentifier.dom_id(*target)}"
+      else
+        target
+      end
+    end
+  end
+end

test/dummy/.gitignore

@@ -0,0 +1,5 @@
+*.log
+*.sqlite3
+*.sqlite3-shm
+*.sqlite3-wal
+tmp/*

test/dummy/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative "config/application"
+
+Rails.application.load_tasks

test/dummy/app/channels/application_cable/channel.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

test/dummy/app/channels/application_cable/connection.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

test/dummy/app/models/message.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class Message < ActiveRecord::Base
+end