Module: ExpoTurbo::Rails::Streams::Helper

Defined in:
lib/expo_turbo/rails/streams/helper.rb

Constant Summary collapse

RESERVED_STREAM_SOURCE_ATTRIBUTES = 
%w[channel signed-stream-name data-channel data-signed-stream-name].freeze
RESERVED_STREAM_SOURCE_DATA_ATTRIBUTES = 
%w[channel signed-stream-name].freeze
RESERVED_PROTECTED_STREAM_SOURCE_ATTRIBUTES = 
(RESERVED_STREAM_SOURCE_ATTRIBUTES + %w[data-grant grant]).freeze
RESERVED_PROTECTED_STREAM_SOURCE_DATA_ATTRIBUTES = 
(RESERVED_STREAM_SOURCE_DATA_ATTRIBUTES + %w[grant]).freeze

Instance Method Summary collapse

Instance Method Details

#expo_turbo_protected_stream_from(*streamables, grant:, **attributes) ⇒ Object 



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/expo_turbo/rails/streams/helper.rb', line 42

def expo_turbo_protected_stream_from(*streamables, grant:, **attributes)
  unless valid_grant?(grant)
    raise ArgumentError, "Expo Turbo protected stream grants must be nonblank UTF-8 Strings"
  end

  data_attributes = attributes.select { |key, _| normalized_attribute_name(key) == "data" }
  if data_attributes.size > 1 || data_attributes.values.any? { |value| !value.is_a?(Hash) }
    raise ArgumentError, "Expo Turbo protected stream source data must be one Hash"
  end

  reserved_data_attribute = data_attributes.values.any? do |data|
    data.keys.any? do |key|
      RESERVED_PROTECTED_STREAM_SOURCE_DATA_ATTRIBUTES.include?(normalized_attribute_name(key))
    end
  end
  reserved_source_attribute = attributes.keys.any? do |key|
    RESERVED_PROTECTED_STREAM_SOURCE_ATTRIBUTES.include?(normalized_attribute_name(key))
  end
  if reserved_source_attribute || reserved_data_attribute
    raise ArgumentError, "Expo Turbo protected stream sources reserve channel, signed stream name, and grant attributes"
  end

  ExpoTurbo::Rails::Cable.configuration
  data = data_attributes.values.first || {}
  source_attributes = attributes.reject { |key, _| normalized_attribute_name(key) == "data" }
  token = ExpoTurbo::Rails::Cable.protected_stream_token_for(*streamables)

  tag.turbo_cable_stream_source(
    **source_attributes,
    channel: ExpoTurbo::Rails::Cable::ProtectedStreamsChannel.name,
    "signed-stream-name": token,
    data: data.merge(grant:)
  )
end

#expo_turbo_stream ⇒ Object 



12
13
14
15
16
17
18
 
# File 'lib/expo_turbo/rails/streams/helper.rb', line 12

def expo_turbo_stream
  TagBuilder.new(
    self,
    partial_resolver: ->(partial) { controller.send(:expo_turbo_partial_file, partial) },
    fragment_validator: ->(document) { controller.send(:expo_turbo_validate_stream_fragment!, document) }
  )
end

#expo_turbo_stream_from(*streamables, **attributes) ⇒ Object 



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/expo_turbo/rails/streams/helper.rb', line 20

def expo_turbo_stream_from(*streamables, **attributes)
  reserved_data_attribute = attributes
    .select { |key, _| key.to_s == "data" }
    .values
    .grep(Hash)
    .any? do |data|
      data.keys.any? do |key|
        RESERVED_STREAM_SOURCE_DATA_ATTRIBUTES.include?(key.to_s.tr("_", "-"))
      end
    end
  if attributes.keys.any? { |key| RESERVED_STREAM_SOURCE_ATTRIBUTES.include?(key.to_s) } || reserved_data_attribute
    raise ArgumentError, "Expo Turbo stream sources reserve channel and signed stream name attributes"
  end

  ::Turbo::StreamsHelper.instance_method(:turbo_stream_from).bind_call(
    self,
    *ExpoTurbo::Rails::Streams.streamables_for(*streamables),
    **attributes,
    channel: "Turbo::StreamsChannel"
  )
end