Module: Turbo::Broadcastable::ClassMethods

Defined in:
app/models/concerns/turbo/broadcastable.rb

Instance Method Summary collapse

Instance Method Details

#broadcast_target_default ⇒ Object

All default targets will use the return of this method. Overwrite if you want something else than model_name.plural.



89
90
91
 
# File 'app/models/concerns/turbo/broadcastable.rb', line 89

def broadcast_target_default
  model_name.plural
end

#broadcasts(stream = model_name.plural, inserts_by: :append, target: broadcast_target_default, **rendering) ⇒ Object

Same as #broadcasts_to, but the designated stream for updates and destroys is automatically set to the current model, for creates - to the model plural name, which can be overriden by passing stream.



82
83
84
85
86
 
# File 'app/models/concerns/turbo/broadcastable.rb', line 82

def broadcasts(stream = model_name.plural, inserts_by: :append, target: broadcast_target_default, **rendering)
  after_create_commit  -> { broadcast_action_later_to stream, action: inserts_by, target: target.try(:call, self) || target, **rendering }
  after_update_commit  -> { broadcast_replace_later **rendering }
  after_destroy_commit -> { broadcast_remove }
end

#broadcasts_to(stream, inserts_by: :append, target: broadcast_target_default, **rendering) ⇒ Object

Configures the model to broadcast creates, updates, and destroys to a stream name derived at runtime by the stream symbol invocation. By default, the creates are appended to a dom id target name derived from the model’s plural name. The insertion can also be made to be a prepend by overwriting inserts_by and the target dom id overwritten by passing target. Examples:

class Message < ApplicationRecord
  belongs_to :board
  broadcasts_to :board
end

class Message < ApplicationRecord
  belongs_to :board
  broadcasts_to ->(message) { [ message.board, :messages ] }, inserts_by: :prepend, target: "board_messages"
end

class Message < ApplicationRecord
  belongs_to :board
  broadcasts_to ->(message) { [ message.board, :messages ] }, partial: "messages/custom_message"
end



74
75
76
77
78
 
# File 'app/models/concerns/turbo/broadcastable.rb', line 74

def broadcasts_to(stream, inserts_by: :append, target: broadcast_target_default, **rendering)
  after_create_commit  -> { broadcast_action_later_to stream.try(:call, self) || send(stream), action: inserts_by, target: target.try(:call, self) || target, **rendering }
  after_update_commit  -> { broadcast_replace_later_to stream.try(:call, self) || send(stream), **rendering }
  after_destroy_commit -> { broadcast_remove_to stream.try(:call, self) || send(stream) }
end