live_cable 0.3.0 → 0.4.0

data/lib/live_cable/rendering/view_buffer.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module LiveCable
+  module Rendering
+    # Appends to whichever buffer the view is writing to when the append happens,
+    # so a template block a view helper yields lands where plain ERB would put it.
+    class ViewBuffer
+      delegate :safe_append=, :append=, :safe_expr_append=, to: :output_buffer
+
+      def initialize(view_context)
+        @view_context = view_context
+      end
+
+      private
+
+      def output_buffer
+        @view_context.output_buffer
+      end
+    end
+  end
+end

data/lib/live_cable/testing/render_state.rb

@@ -6,14 +6,16 @@ module LiveCable
     # mirroring what the JavaScript client does: the first refresh carries
     # all parts, subsequent refreshes carry only the changed parts (nil
     # means unchanged), and child components arrive as separate results
-    # referenced by <LiveCable child-live-id="..."> placeholders.
+    # referenced by <LiveCable child-live-id="..."> placeholders. Results for
+    # children at every depth arrive in the root's c, so the whole tree
+    # shares one set of child states.
     class RenderState
       CHILD_PLACEHOLDER = %r{<LiveCable child-live-id="(?<live_id>[^"]+)"></LiveCable>}
 
-      def initialize
+      def initialize(children = Hash.new { |hash, key| hash[key] = RenderState.new(hash) })
         @parts_by_template = {}
         @last_template = nil
-        @children = Hash.new { |hash, key| hash[key] = RenderState.new }
+        @children = children
       end
 
       # @param refresh [Hash] A _refresh payload ({ h:, p:, c: })

data/lib/live_cable/testing/test_channel.rb

@@ -12,17 +12,23 @@ module LiveCable
       # @return [Array<Hash>] Payloads sent by components through this channel
       attr_reader :transmissions
 
+      # @return [Array<Hash>] Every _refresh payload sent, including any
+      #   since cleared from transmissions
+      attr_reader :refreshes
+
       # @return [LiveCable::Testing::TestCableConnection]
       attr_reader :connection
 
       def initialize(identifiers = {})
         @streams = {}
         @transmissions = []
+        @refreshes = []
         @connection = TestCableConnection.new(identifiers)
       end
 
       def broadcast(data)
         @transmissions << data
+        @refreshes << data[:_refresh] if data.key?(:_refresh)
       end
 
       def stream_from(name, coder: nil, &block)

data/lib/live_cable/testing/test_component.rb

@@ -77,7 +77,7 @@ module LiveCable
       end
 
       # Forget previously captured broadcasts. Useful after mounting, to
-      # assert on the effects of a single action.
+      # assert on the effects of a single action. Doesn't affect rendered.
       def clear_broadcasts
         channel.transmissions.clear
       end
@@ -98,8 +98,8 @@ module LiveCable
       def rendered_html
         state = RenderState.new
 
-        broadcasts(:_refresh).each do |broadcast|
-          state.apply(broadcast[:_refresh])
+        channel.refreshes.each do |refresh|
+          state.apply(refresh)
         end
 
         state.html

data/lib/live_cable/testing.rb

@@ -54,11 +54,15 @@ module LiveCable
 
       test_component = TestComponent.new(instance, connection, TestChannel.new(identifiers))
 
-      connection.add_component(instance)
-      instance.defaults = defaults
-      instance.apply_defaults
-      instance.connect(test_component.channel)
-      instance.broadcast_render
+      begin
+        connection.add_component(instance)
+        instance.defaults = defaults
+        instance.apply_defaults
+        instance.connect(test_component.channel)
+        instance.broadcast_render(subscribed: true)
+      rescue StandardError => error
+        connection.handle_error(instance, error, channel: test_component.channel)
+      end
 
       test_component
     end

data/lib/live_cable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LiveCable
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/lib/live_cable.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'logger'
 require 'zeitwerk'
 require 'herb'
 
@@ -19,18 +20,46 @@ require_relative '../app/helpers/live_cable_helper'
 require_relative 'live'
 
 module LiveCable
+  @warn_mutex = Mutex.new
+  @warned_messages = Set.new
+
+  # Log a warning through the Rails logger at most once per process for a
+  # given message. Used for performance and configuration hints (e.g. a
+  # component rendered without a .live.erb template) that would otherwise
+  # repeat on every render and flood the log.
+  def self.warn_once(message)
+    @warn_mutex.synchronize do
+      return unless @warned_messages.add?(message)
+    end
+
+    logger.warn(message)
+  end
+
+  # @return [Logger]
+  def self.logger
+    if defined?(Rails) && Rails.respond_to?(:logger) && Rails.logger
+      Rails.logger
+    else
+      @fallback_logger ||= Logger.new($stderr)
+    end
+  end
+
   def self.instance_from_string(string, id)
     klass = Live
     klass_string = string.camelize
 
     begin
       klass_string.split('::').each do |part|
-        unless klass.const_defined?(part)
+        # inherit: false so component names that collide with a top-level
+        # constant (e.g. "string" -> ::String) don't resolve through Object's
+        # ancestry and slip past this guard, only to blow up later with a
+        # confusing NameError instead of this friendly message.
+        unless klass.const_defined?(part, false)
           raise LiveCable::Error,
             "Component Live::#{klass_string} not found, make sure it is located in the Live:: module"
         end
 
-        klass = klass.const_get(part)
+        klass = klass.const_get(part, false)
       end
     rescue NameError
       raise LiveCable::Error, "Invalid component name \"#{string}\" - Live::#{klass_string} not found"
@@ -38,7 +67,7 @@ module LiveCable
 
     klass = "Live::#{klass_string}".safe_constantize
 
-    unless klass < LiveCable::Component
+    unless klass && klass < LiveCable::Component
       raise LiveCable::Error, 'Components must extend LiveCable::Component'
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: live_cable
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Craig Blanchette
@@ -136,6 +136,7 @@ files:
 - lib/live_cable/action_cable_connection.rb
 - lib/live_cable/component.rb
 - lib/live_cable/component/broadcasting.rb
+- lib/live_cable/component/dispatching.rb
 - lib/live_cable/component/events.rb
 - lib/live_cable/component/identification.rb
 - lib/live_cable/component/lifecycle.rb
@@ -151,18 +152,24 @@ files:
 - lib/live_cable/connection/messaging.rb
 - lib/live_cable/connection/state_management.rb
 - lib/live_cable/container.rb
+- lib/live_cable/defaults_signer.rb
 - lib/live_cable/delegation/array.rb
 - lib/live_cable/delegation/hash.rb
 - lib/live_cable/delegation/methods.rb
 - lib/live_cable/delegation/model.rb
 - lib/live_cable/delegator.rb
+- lib/live_cable/dispatch.rb
 - lib/live_cable/engine.rb
 - lib/live_cable/error.rb
+- lib/live_cable/forbidden.rb
+- lib/live_cable/identity_digest.rb
 - lib/live_cable/model_observer.rb
 - lib/live_cable/observer.rb
 - lib/live_cable/observer_tracking.rb
+- lib/live_cable/predicate_builder.rb
 - lib/live_cable/render_context.rb
 - lib/live_cable/rendering/compiler.rb
+- lib/live_cable/rendering/controller_renderer.rb
 - lib/live_cable/rendering/dependency_visitor.rb
 - lib/live_cable/rendering/handler.rb
 - lib/live_cable/rendering/method_analyzer.rb
@@ -172,6 +179,7 @@ files:
 - lib/live_cable/rendering/partial_renderer.rb
 - lib/live_cable/rendering/render_result.rb
 - lib/live_cable/rendering/renderer.rb
+- lib/live_cable/rendering/view_buffer.rb
 - lib/live_cable/testing.rb
 - lib/live_cable/testing/render_state.rb
 - lib/live_cable/testing/test_cable_connection.rb