turbo_live 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f8bb20b23ebd77936e9d016fc914bad406118d259fc7e21b814ab21bd162dd48
-  data.tar.gz: b34976b5f6b8ba0e48a51f26d7fee4f13c2870631c5fdab88860e16db49d9bb0
+  metadata.gz: f35b2977f8f91c94aa92547a23facedec57a0fe96c10b497a9ee4f0583ee3aa6
+  data.tar.gz: b2d82cbcc93d640fd1dee6a32753fe93d5ef7e509e2e6db569d74b24c84cb651
 SHA512:
-  metadata.gz: f23e8d630a733dad9c92b6ad79458213aa97b0f7f1c527a1e30b4b65914e62675ffeda07e3a272cdd8e8d924500c8fe36ae16c712922788b50b4939bcedad464
-  data.tar.gz: 266d2bcc3e8b82977ee5474dee219b88ce3e0d82b6de7258f231ec302807e87b8479422b4c124a8b3c05d1792d4293e01d81460b66809b1dfa7d4ea969b7923b
+  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)
@@ -110,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/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.1"
+  VERSION = "0.3.0"
 end

data/lib/turbo_live.rb

@@ -3,6 +3,7 @@
 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/turbo_live/components_channel" if defined?(ActionCable::Channel::Base)
@@ -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.1
+  version: 0.3.0
 platform: ruby
 authors:
 - TheDumbTechGuy
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-23 00:00:00.000000000 Z
+date: 2024-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: phlex-rails
@@ -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