cable_streams 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 57ca136e081b470c8cafb90704ed1076d05ccadcfb667bd08121ee82e4bee991
+  data.tar.gz: f71a6dc50129583580751c7a08c9edb152a60ad43c1e584f97ce49b8fb893313
+SHA512:
+  metadata.gz: 88b893edb4714b78eead519089cac8bc8a7053fa55902d61f91ccf7c2e2689bdb9e1756d198d2641c8ad1e66b1f6f5a2a1e2fde0ee5ffd7468f542192fbceb4c
+  data.tar.gz: e148b44f0fc42c803563bac8a807c0af3e4263dcc271774e8f8f52bf7b02c6cc5f221ee8b7c2713d8f4f281997e7bafb5eef0e322ead2d92cc6161ed4a950179

data/README.md

@@ -0,0 +1,30 @@
+## CableStreams Rails
+
+This is a Rails helper gem for the [`cable-streams`](https://github.com/marcoroth/cable-streams) NPM package. CableStreams extends Turbo Streams with Custom Turbo Stream Actions and all CableReady operations.
+
+### Installation
+
+```bash
+bundle add cable_streams
+```
+
+### Using the Tag Helpers
+
+The `cable_streams` gem ships view helpers for all CableReady operations. All options are identical to [the regular CableReady operations](https://cableready.stimulusreflex.com/v/v5/reference/operations).
+
+Here's an example of the `console_log` operation:
+
+```html+erb
+<%= turbo_stream.console_log(message: "hello world") %>
+```
+
+Which renders to:
+```html
+<turbo-stream action="consoleLog" target="body">
+  <template>
+    [
+      { "message": "hello world", "operation": "consoleLog" }
+    ]
+  </template>
+</turbo-stream>
+```

data/app/helpers/cable_streams/streams/action_helper.rb

@@ -0,0 +1,23 @@
+require "cable_ready"
+require "turbo-rails"
+
+module CableStreams
+  module Streams
+    module ActionHelper
+      include CableReady::Broadcaster
+
+      IGNORE_LIST = [:after, :append, :before, :prepend, :remove, :replace, :update]
+
+      (CableReady.config.operation_names - IGNORE_LIST).each do |name|
+        define_method(name) do |args|
+          operation = cable_car.send(name, args).dispatch.to_json
+          target = (args.to_h.pluck(:selector) || 'body') rescue "body"
+
+          turbo_stream_action_tag name.to_s.camelize(:lower), target: target, template: operation
+        end
+      end
+    end
+  end
+end
+
+Turbo::Streams::TagBuilder.prepend(CableStreams::Streams::ActionHelper)

data/lib/cable_streams/engine.rb

@@ -0,0 +1,6 @@
+require "rails/engine"
+
+module CableStreams
+  class Engine < Rails::Engine
+  end
+end

data/lib/cable_streams/version.rb

@@ -0,0 +1,3 @@
+module CableStreams
+  VERSION = "0.1.0"
+end

data/lib/cable_streams.rb

@@ -0,0 +1,4 @@
+require "cable_streams/engine"
+
+module CableStreams
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: cable_streams
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Marco Roth
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-04-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: cable_ready
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0.pre9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0.pre9
+- !ruby/object:Gem::Dependency
+  name: turbo-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email: marco.roth@hey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- app/helpers/cable_streams/streams/action_helper.rb
+- lib/cable_streams.rb
+- lib/cable_streams/engine.rb
+- lib/cable_streams/version.rb
+homepage: https://github.com/marcoroth/cable-streams-rails
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: Extend Turbo Streams with Custom Turbo Stream Actions or CableReady operations
+test_files: []