reactive_component 0.7.2 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ef3f09713ddda3cdec03ffd6dac861df951589a1b077504a7ea1323e6ac8d73
-  data.tar.gz: a08ef29771672722c29145c51f15a9b159d0b9487d801dec2a045d0a5ebf0127
+  metadata.gz: a6b20beff63665f50b6910b02f241982c53bf7112145d2db4158b08738d2b3c4
+  data.tar.gz: 43c738cda0f1d36bb20a42f41a16ba9c55585858487d363cb37cebd4aa26de0d
 SHA512:
-  metadata.gz: e7142557dca9daff0f7f5b9a6034144228d47578c417e1a9e959694f8ec0e62371fe4757bffc16738ef7ed8879f40cffa53b347887a5a1a9cb153ce63f7756fc
-  data.tar.gz: 92e76f033d5883773851f94f551499c78072a33624fe016ce579834be04e1cfcad000c0e8ba6009500fa2477c05fa3ca401cc755c061c2d86b736a430d224d46
+  metadata.gz: 5b1011b2b0c3d08ad80ecc86586d7c0061c77bc762c0bbafbbf031c2420d711e69c1c63b34ea67ef0f3bfd0824f7f48ce2737e59b26e61a3ad1def298a6b9ed3
+  data.tar.gz: dd3c3c6ad4e6d900bfd37ad95450c20344fda96060e0cb1d8f8695918b9e7a6678c89a2d8f1ff673a129cd850c6f07e8c556249bd4410eeaef549c29c9be49d2

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [0.8.0] - 2026-09-10
+
+### Added
+- `ReactiveComponent::Entity`: subscribe a component to an object built from
+  several models. The entity declares its `root` record and `rebuilds_on`
+  each source model, optionally narrowed to `fields:`. See the Derived
+  Entities guide.
+- `broadcast_reactive(action)` and `broadcast_reactive_destroy` are public on
+  wired models, alongside `broadcast_reactive_update`.
+
+### Fixed
+- Multibyte characters in a template (★, é, emoji) rendered as mojibake after
+  a live re-render. The client now decodes the base64 template as UTF-8.
+
 ## [0.7.2] - 2026-09-07
 
 ### Security

data/app/javascript/reactive_component/lib/reactive_renderer_utils.js

@@ -8,7 +8,7 @@ export function compileTemplate(source) {
   if (templateCache.has(source)) return templateCache.get(source)
 
   try {
-    const body = isBase64(source) ? atob(source) : source
+    const body = isBase64(source) ? decodeBase64(source) : source
     const fn = new Function("data", body)
     templateCache.set(source, fn)
     return fn
@@ -18,6 +18,12 @@ export function compileTemplate(source) {
   }
 }
 
+// atob yields one char per byte, so multibyte UTF-8 (★, é, emoji) in a
+// template literal came out as mojibake once the client re-rendered.
+function decodeBase64(base64) {
+  return new TextDecoder().decode(Uint8Array.from(atob(base64), c => c.charCodeAt(0)))
+}
+
 export function clearTemplateCache() {
   templateCache.clear()
 }

data/lib/reactive_component/broadcastable.rb

@@ -16,6 +16,9 @@ module ReactiveComponent
 
         self.reactive_component_classes = reactive_component_classes | [component_class]
 
+        # A derived entity (ReactiveComponent::Entity) is not an ActiveRecord
+        # model: it has no commit callbacks and broadcasts itself.
+        return unless respond_to?(:after_create_commit)
         return if _commit_callbacks.map(&:filter).include?(:_broadcast_reactive_create)
 
         after_create_commit  :_broadcast_reactive_create
@@ -24,18 +27,17 @@ module ReactiveComponent
       end
     end
 
-    def broadcast_reactive_update
-      _broadcast_reactive(:update)
+    def broadcast_reactive(action)
+      reactive_component_classes.each { |klass| ReactiveComponent.broadcast_for(klass, self, action: action) }
     end
 
-    private
+    def broadcast_reactive_update  = broadcast_reactive(:update)
+    def broadcast_reactive_destroy = broadcast_reactive(:destroy)
 
-    def _broadcast_reactive_create  = _broadcast_reactive(:create)
-    def _broadcast_reactive_update  = _broadcast_reactive(:update)
-    def _broadcast_reactive_destroy = _broadcast_reactive(:destroy)
+    private
 
-    def _broadcast_reactive(action)
-      reactive_component_classes.each { |klass| ReactiveComponent.broadcast_for(klass, self, action: action) }
-    end
+    def _broadcast_reactive_create  = broadcast_reactive(:create)
+    def _broadcast_reactive_update  = broadcast_reactive(:update)
+    def _broadcast_reactive_destroy = broadcast_reactive(:destroy)
   end
 end

data/lib/reactive_component/entity.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require 'active_model'
+
+module ReactiveComponent
+  # A derived entity: a plain object built on top of several ActiveRecord
+  # models that a component can `subscribes_to` like a model. The entity owns
+  # the whole declaration — which record it is keyed on, and which changes to
+  # which models rebuild it:
+  #
+  #   class OrderSummary
+  #     include ReactiveComponent::Entity
+  #
+  #     root :order
+  #     rebuilds_on Order,    fields: %i[status total_cents]
+  #     rebuilds_on Payment,  via: :order_id, fields: %i[amount]
+  #     rebuilds_on Shipment, via: :order_id, fields: %i[delivered_at]
+  #
+  #     def total = order.payments.sum(:amount)
+  #   end
+  #
+  #   class OrderSummaryComponent < ApplicationComponent
+  #     include ReactiveComponent
+  #     subscribes_to :summary, class_name: "OrderSummary"
+  #   end
+  module Entity
+    extend ActiveSupport::Concern
+    include ActiveModel::Model
+    include Broadcastable
+
+    included do
+      class_attribute :root_name, instance_writer: false
+    end
+
+    def persisted? = true
+
+    # Default stream when the component declares no `broadcasts stream:`.
+    # A bare id would collide with every other entity sharing it.
+    def to_param = "#{self.class.model_name.param_key}/#{id}"
+
+    class_methods do
+      # The record the entity is keyed on. Defines `initialize(<name>:)`, the
+      # reader, `id`, and the `find` / `find_by(id:)` the channel and actions
+      # controller need.
+      def root(name, class_name: name.to_s.classify)
+        self.root_name = name.to_sym
+        attr_reader name
+
+        define_method(:initialize) { |**kwargs| instance_variable_set(:"@#{name}", kwargs.fetch(name)) }
+        delegate :id, to: name
+
+        define_singleton_method(:find)    { |id| new(name => class_name.constantize.find(id)) }
+        define_singleton_method(:find_by) { |id:| (record = class_name.constantize.find_by(id: id)) && new(name => record) }
+      end
+
+      # Rebroadcast the entity after `model` commits. `via:` is the foreign key
+      # on `model` pointing at the root; omit it when `model` is the root.
+      # `fields:` narrows updates to the listed columns; create and destroy
+      # always count.
+      def rebuilds_on(model, via: nil, fields: nil)
+        entity = self
+        fields = fields&.map(&:to_s)
+
+        model.after_commit { entity.rebuild_from(self, via: via, fields: fields) }
+      end
+
+      def rebuild_from(record, via:, fields:)
+        action = commit_action(record)
+        return if action == :update && fields && !record.saved_changes.keys.intersect?(fields)
+        return find_by(id: record.public_send(via))&.broadcast_reactive(:update) if via
+
+        new(root_name => record).broadcast_reactive(action)
+      end
+
+      private
+
+      def commit_action(record)
+        return :destroy if record.destroyed?
+        return :create if record.previously_new_record?
+
+        :update
+      end
+    end
+  end
+end

data/lib/reactive_component/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ReactiveComponent
-  VERSION = '0.7.2'
+  VERSION = '0.8.0'
 end

data/lib/reactive_component.rb

@@ -8,6 +8,7 @@ require_relative 'reactive_component/compiler'
 require_relative 'reactive_component/data_evaluator'
 require_relative 'reactive_component/wrapper'
 require_relative 'reactive_component/broadcastable'
+require_relative 'reactive_component/entity'
 require_relative 'reactive_component/engine' if defined?(Rails::Engine)
 
 module ReactiveComponent

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reactive_component
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.8.0
 platform: ruby
 authors:
 - Przemyslaw Lusar
@@ -113,6 +113,7 @@ files:
 - lib/reactive_component/compiler.rb
 - lib/reactive_component/data_evaluator.rb
 - lib/reactive_component/engine.rb
+- lib/reactive_component/entity.rb
 - lib/reactive_component/erubi.rb
 - lib/reactive_component/transpiler.rb
 - lib/reactive_component/version.rb