turbo_live 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 973ebc91558a780fcdfc2e8dea4c6b1bc3d090678ee30535768e3b9d7ad1f9aa
-  data.tar.gz: 63e48c4f2b207557d9b111609a3dad42a10f70ea3719ea96a1477ed8f4e952fe
+  metadata.gz: f35b2977f8f91c94aa92547a23facedec57a0fe96c10b497a9ee4f0583ee3aa6
+  data.tar.gz: b2d82cbcc93d640fd1dee6a32753fe93d5ef7e509e2e6db569d74b24c84cb651
 SHA512:
-  metadata.gz: f1118112757bfde64bbdd6417827ad56ea031ba950f2006a8151436f55101ca14543b991317d3825ecd143844417b2fafe84c2d6cccf7d408c9c14d213e18c1f
-  data.tar.gz: 7c1269811dd43b3a80188f9cafefc571c198c0eb9bd5adf9683353b7a67ef4ef915832a29bdf3fc1db710eeeb10a8ebca4b1829d4b05dacb7e2d05468891c01d
+  metadata.gz: 3108716f45050495efcb80b7c5d7b8ea0ba0fe1712ffa72165299dc31ad9e0a7443e3e961323ed33dbcb35f4fb4f65c52d1a530f5b2e8e537028d7fec612f91a
+  data.tar.gz: 1118bcb7d3bcbd573265edaff2be2b3d5590614a7018d68e8ecb4e628404c6eec24f4ce00d1f6260ecf078e717d6ff8741e1dbc603389395b22eb4539971d541

data/README.md

@@ -6,6 +6,10 @@ TurboLive is a Ruby gem that enables the creation of async, progressively enhanc
 
 - [Installation](#installation)
 - [Setup](#setup)
+  - [Rails Routes](#rails-routes)
+  - [Stimulus Controller](#stimulus-controller)
+  - [ActionCable (Optional)](#actioncable-optional)
+  - [Serializer Configuration](#serializer-configuration)
 - [Usage](#usage)
   - [Creating a Component](#creating-a-component)
   - [Model State](#model-state)
@@ -46,7 +50,13 @@ For importmaps:
 bin/importmap pin @radioactive-labs/turbo-live
 ```
 
-For npm:
+For yarn:
+
+```console
+yarn add @radioactive-labs/turbo-live
+```
+
+Or YAR:
 
 ```console
 npm install @radioactive-labs/turbo-live
@@ -54,6 +64,21 @@ npm install @radioactive-labs/turbo-live
 
 ## Setup
 
+### Rails Routes
+
+In your rails routes, mount the engine:
+
+```diff
+Rails.application.routes.draw do
+  # Define your application routes per the DSL in https://guides.rubyonrails.org/routing.html
+
++  mount TurboLive::Engine => "/turbo_live"
+
+  # Defines the root path route ("/")
+  root "index#index"
+end
+```
+
 ### Stimulus Controller
 
 TurboLive uses a Stimulus controller to manage interactions. In your `app/javascript/controllers/index.js`:
@@ -61,9 +86,10 @@ TurboLive uses a Stimulus controller to manage interactions. In your `app/javasc
 ```diff
 import { application } from "controllers/application"
 import { eagerLoadControllersFrom } from "@hotwired/stimulus-loading"
-+import * as turboLive from "@radioactive-labs/turbo-live"
 
 eagerLoadControllersFrom("controllers", application)
+
++import * as turboLive from "@radioactive-labs/turbo-live"
 +turboLive.registerControllers(application)
 ```
 
@@ -88,6 +114,28 @@ import "controllers"
 +import "channels"
 ```
 
+### Serializer Configuration
+
+TurboLive requires a serializer for state management.
+
+The default serializer (`TurboLive::Serializer`) simply wraps YAML, which handles primitive objects and basic collections.
+If you need to serialize complex objects, you can provide your own serializer implementation or customize the in-built.
+
+You can configure the serializer in an initializer:
+
+```ruby
+# config/initializers/turbo_live.rb
+
+# Optional - defaults to TurboLive::Serializer
+TurboLive.serializer = YourCustomSerializer
+
+# (Optional) You can set a custom verifier key for security
+TurboLive.verifier_key = Rails.application.secret_key_base
+
+# pass extra permitted classes to the underlying YAML serializer
+TurboLive::Serializer.permitted_classes << BigDecimal
+```
+
 ## Usage
 
 A TurboLive component is a self-contained, interactive unit of a web application that can update in real-time without full page reloads. Components follow [The Elm Architecture](https://guide.elm-lang.org/architecture/) pattern.

data/examples/countdown_component.rb

@@ -14,9 +14,9 @@ class CountdownComponent < TurboLive::Component
 
   def update(input)
     case input
-    in [:countdown]
+    in :countdown
       self.countdown -= 1
-    in [:start]
+    in :start
       self.countdown = 1000
     end
   end

data/examples/counter_component.rb

@@ -15,11 +15,11 @@ class CounterComponent < TurboLive::Component
 
   def update(input)
     case input
-    in [:decrement]
+    in :decrement
       self.count -= 1
-    in [:increment]
+    in :increment
       self.count += 1
-    in [:reset]
+    in :reset
       self.count = 0
     end
   end

data/examples/flappy_bird_component.rb

@@ -75,14 +75,14 @@ class FlappyBirdComponent < TurboLive::Component
 
   def update(input)
     case input
-    in [:jump]
+    in :jump
       if game_over
         reset_game
       else
         self.nonce = NONCES[live_id] = NONCES[live_id] + 1
         self.bird_velocity = JUMP_STRENGTH
       end
-    in [:tick]
+    in :tick
       norender! if nonce < NONCES[live_id]
       update_game_state
     end

data/examples/showcase_component.rb

@@ -12,6 +12,7 @@ class ShowcaseComponent < TurboLive::Component
           li { button(**on(click: [:change_component, :countdown])) { "Countdown" } }
           li { button(**on(click: [:change_component, :tic_tac_toe])) { "TicTacToe" } }
           li { button(**on(click: [:change_component, :flappy_bird])) { "Flappy Bird" } }
+          li { button(**on(click: [:change_component, :form])) { "Form" } }
         end
       end
       div class: "right-column" do
@@ -24,7 +25,7 @@ class ShowcaseComponent < TurboLive::Component
 
   def update(input)
     case input
-    in [[:change_component, component]]
+    in [:change_component, component]
       self.component = component
     end
   end
@@ -41,6 +42,8 @@ class ShowcaseComponent < TurboLive::Component
       TicTacToeComponent
     when :flappy_bird
       FlappyBirdComponent
+    when :form
+      FormComponent
     end
   end
 end

data/examples/tic_tac_toe_component.rb

@@ -50,9 +50,9 @@ class TicTacToeComponent < TurboLive::Component
 
   def update(input)
     case input
-    in [[:make_move, index]]
+    in [:make_move, index]
       make_move(index)
-    in [:reset_game]
+    in :reset_game
       reset_game
     end
   end

data/lib/turbo_live/serializer.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module TurboLive
+  class Serializer
+    class << self
+      def dump(obj)
+        YAML.dump(obj)
+      end
+
+      def load(obj)
+        YAML.safe_load(obj, permitted_classes: permitted_classes)
+      end
+
+      def permitted_classes
+        @permitted_classes ||= []
+      end
+    end
+  end
+end

data/lib/turbo_live/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TurboLive
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/turbo_live.rb

@@ -3,9 +3,10 @@
 require_relative "turbo_live/version"
 require_relative "turbo_live/component"
 require_relative "turbo_live/renderer"
+require_relative "turbo_live/serializer"
 
 require_relative "turbo_live/engine" if defined?(Rails)
-require_relative "../app/channels/components_channel" if defined?(ActionCable)
+require_relative "../app/channels/turbo_live/components_channel" if defined?(ActionCable::Channel::Base)
 
 module TurboLive
   class Error < StandardError; end
@@ -17,13 +18,18 @@ module TurboLive
 
   class << self
     attr_writer :verifier_key
+    attr_writer :serializer
 
     def verifier
-      @verifier ||= ActiveSupport::MessageVerifier.new(verifier_key, digest: "SHA256", serializer: YAML)
+      @verifier ||= ActiveSupport::MessageVerifier.new(verifier_key, digest: "SHA256", serializer: serializer)
     end
 
     def verifier_key
       @verifier_key or raise ArgumentError, "Turbo requires a verifier_key"
     end
+
+    def serializer
+      @serializer ||= TurboLive::Serializer
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: turbo_live
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - TheDumbTechGuy
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-17 00:00:00.000000000 Z
+date: 2024-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: phlex-rails
@@ -52,7 +52,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- app/channels/components_channel.rb
+- app/channels/turbo_live/components_channel.rb
 - app/controllers/turbo_live/components_controller.rb
 - config/routes.rb
 - examples/countdown_component.rb
@@ -64,6 +64,7 @@ files:
 - lib/turbo_live/component.rb
 - lib/turbo_live/engine.rb
 - lib/turbo_live/renderer.rb
+- lib/turbo_live/serializer.rb
 - lib/turbo_live/version.rb
 - package-lock.json
 - package.json