turbo_reflex 0.0.25 → 0.0.27

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c28abca449b5630362e4a5926b270c4c8075a1ef989434c0899355d96390b388
-  data.tar.gz: 6a767145f9a32ab240feac42051f0d2be4c4d395202641b4e8caaf3cabe9c242
+  metadata.gz: e1ef38965d0ef18dbbc67316bed5aaffcb50da54e603528b0b72088378e4daff
+  data.tar.gz: d1938187e80bdb62e1f2ab46bb14f17fd130eafeb24592df905052d4c26897ab
 SHA512:
-  metadata.gz: 36568b96f6cfd94e119adec06a2624c12a042447cdbbd5973de82ed8b629135a30ef033f23384da49084fa76a76a3ccc5422e3e0ec5267269cba693f7fcbce1d
-  data.tar.gz: 58efc30fb5c49b605b76a5d8998cd6f6d69b4288bad4d3a3b5b1085e26236f0162e282be402e34837e1e33ec78f405cb2cb5034279ee8bf9cb6fdd70a157c02c
+  metadata.gz: 86a168a615001267eed78ffc6b1fc7ff6032d2ef7b4e4d730e2a0ed9f0b13976a5972def9eb831340618560c62021175386aa438d133a5824e10d1063a85896b
+  data.tar.gz: e6438f83d9584b47d04f0a152dbd1ff9c886828847b66995d6d72d5c5448f162650584b3f9cde9d3710e88d8e2651a240b2e3d2b894fdf0377c8afb9d420dacc

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    turbo_reflex (0.0.25)
+    turbo_reflex (0.0.27)
       rails (>= 6.1)
       turbo-rails (>= 1.1)
       turbo_ready (>= 0.1)
@@ -190,7 +190,7 @@ GEM
       zeitwerk (~> 2.5)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.6.0)
+    regexp_parser (2.6.1)
     rexml (3.2.5)
     rouge (4.0.0)
     rubocop (1.39.0)
@@ -205,7 +205,7 @@ GEM
       unicode-display_width (>= 1.4.0, < 3.0)
     rubocop-ast (1.23.0)
       parser (>= 3.1.1.0)
-    rubocop-performance (1.15.0)
+    rubocop-performance (1.15.1)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     ruby-progressbar (1.11.0)
@@ -222,11 +222,10 @@ GEM
       actionpack (>= 5.2)
       activesupport (>= 5.2)
       sprockets (>= 3.0.0)
-    sqlite3 (1.5.3-aarch64-linux)
-    sqlite3 (1.5.3-arm64-darwin)
-    standard (1.18.0)
+    sqlite3 (1.5.4-arm64-darwin)
+    standard (1.18.1)
       rubocop (= 1.39.0)
-      rubocop-performance (= 1.15.0)
+      rubocop-performance (= 1.15.1)
     standardrb (1.0.1)
       standard
     tailwindcss-rails (2.0.21-aarch64-linux)

data/README.md

@@ -8,7 +8,7 @@
   </h1>
   <p align="center">
     <a href="http://blog.codinghorror.com/the-best-code-is-no-code-at-all/">
-      <img alt="Lines of Code" src="https://img.shields.io/badge/loc-1228-47d299.svg" />
+      <img alt="Lines of Code" src="https://img.shields.io/badge/loc-1249-47d299.svg" />
     </a>
     <a href="https://codeclimate.com/github/hopsoft/turbo_reflex/maintainability">
       <img src="https://api.codeclimate.com/v1/badges/fe1162a742fe83a4fdfd/maintainability" />

data/lib/turbo_reflex/base.rb

@@ -67,7 +67,7 @@ class TurboReflex::Base
   attr_reader :controller, :turbo_streams
   alias_method :streams, :turbo_streams
 
-  delegate :dom_id, :render, to: :"controller.view_context"
+  delegate :dom_id, to: :"controller.view_context"
   delegate(
     :controller_action_prevented?,
     :render_response,
@@ -86,6 +86,22 @@ class TurboReflex::Base
     "##{dom_id(...)}"
   end
 
+  # Same method signature as ActionView::Rendering#render (i.e. controller.view_context.render)
+  def render(options = {}, locals = {}, &block)
+    return controller.view_context.render(options, locals, &block) unless options.is_a?(Hash)
+
+    options = options.symbolize_keys
+
+    ivars = options[:assigns]&.each_with_object({}) do |(key, value), memo|
+      memo[key] = controller.instance_variable_get("@#{key}")
+      controller.instance_variable_set "@#{key}", value
+    end
+
+    controller.view_context.render(options.except(:assigns), locals, &block)
+  ensure
+    ivars&.each { |key, value| controller.instance_variable_set "@#{key}", value }
+  end
+
   def morph(selector, html)
     turbo_streams << turbo_stream.invoke("morph", args: [html], selector: selector)
   end

data/lib/turbo_reflex/engine.rb

@@ -5,13 +5,26 @@ require_relative "version"
 require_relative "base"
 require_relative "controller_pack"
 
-class TurboReflex::Engine < ::Rails::Engine
-  config.turbo_reflex = ActiveSupport::OrderedOptions.new
-  initializer "turbo_reflex.configuration" do
-    Mime::Type.register "text/vnd.turbo-reflex.html", :turbo_reflex
+module TurboReflex
+  def self.config
+    Rails.application.config.turbo_reflex
+  end
+
+  class Engine < ::Rails::Engine
+    config.turbo_reflex = ActiveSupport::OrderedOptions.new
+    config.turbo_reflex[:max_cookie_size] = ActionDispatch::Cookies::MAX_COOKIE_SIZE / 3
+    config.turbo_reflex[:validate_client_token] = true
+
+    # must opt-in to state overrides
+    config.turbo_reflex[:apply_client_state_overrides] = false
+    config.turbo_reflex[:apply_server_state_overrides] = false
+
+    initializer "turbo_reflex.configuration" do
+      Mime::Type.register "text/vnd.turbo-reflex.html", :turbo_reflex
 
-    config.to_prepare do |app|
-      ::ActionController::Base.send :include, TurboReflex::Controller
+      ActiveSupport.on_load(:action_controller_base) do
+        include TurboReflex::Controller
+      end
     end
   end
 end

data/lib/turbo_reflex/runner.rb

@@ -195,6 +195,7 @@ class TurboReflex::Runner
   end
 
   def valid_client_token?
+    return true unless Rails.configuration.turbo_reflex.validate_client_token
     return false unless client_token.present?
     return false unless message_verifier.valid_message?(client_token)
     unmasked_client_token = message_verifier.verify(client_token)

data/lib/turbo_reflex/state_manager.rb

@@ -18,12 +18,6 @@ class TurboReflex::StateManager
   include ActiveModel::Dirty
 
   class << self
-    attr_writer :cookie_max_bytesize
-
-    def cookie_max_bytesize
-      @cookie_max_bytesize ||= 2.kilobytes
-    end
-
     def state_override_blocks
       @state_overrides ||= {}
     end
@@ -69,25 +63,29 @@ class TurboReflex::StateManager
     header_state_hash = {}
 
     # Apply server state overrides (i.e. state stored in databases like Redis, Postgres, etc...)
-    begin
-      state_override_block = self.class.state_override_block(runner.controller)
-      if state_override_block
-        server_state_hash = runner.controller.instance_eval(&state_override_block).with_indifferent_access
-        server_state_hash.each { |key, val| self[key] = val }
+    if TurboReflex.config.apply_server_state_overrides
+      begin
+        state_override_block = self.class.state_override_block(runner.controller)
+        if state_override_block
+          server_state_hash = runner.controller.instance_eval(&state_override_block).with_indifferent_access
+          server_state_hash.each { |key, val| self[key] = val }
+        end
+      rescue => error
+        Rails.logger.error "Failed to apply `state_override_block` configured in #{runner.controller.class.name} to TurboReflex::State! #{error.message}"
       end
-    rescue => error
-      Rails.logger.error "Failed to apply `state_override_block` configured in #{runner.controller.class.name} to TurboReflex::State! #{error.message}"
     end
 
-    # Merge client state into server state (i.e. optimistic state)
+    # Apply client state overrides (i.e. optimistic state)
     # NOTE: Client state HTTP headers are only sent if/when state has changed on the client (only the changes are sent).
     #       This prevents race conditions (state mismatch) caused when frame and XHR requests emit immediately
     #       before the <meta id="turbo-reflex"> has been updated with the latest state from the server.
-    begin
-      header_state_hash = TurboReflex::State.deserialize_base64(header).with_indifferent_access
-      header_state_hash.each { |key, val| self[key] = val }
-    rescue => error
-      Rails.logger.error "Failed to apply client state from HTTP headers to TurboReflex::State! #{error.message}"
+    if TurboReflex.config.apply_client_state_overrides
+      begin
+        header_state_hash = TurboReflex::State.deserialize_base64(header).with_indifferent_access
+        header_state_hash.each { |key, val| self[key] = val }
+      rescue => error
+        Rails.logger.error "Failed to apply client state from HTTP headers to TurboReflex::State! #{error.message}"
+      end
     end
 
     @cookie_data = cookie_state_hash
@@ -130,7 +128,7 @@ class TurboReflex::StateManager
   def ordinal_payload
     provisional_state.clear
     state.shrink!
-    state.prune! max_bytesize: TurboReflex::StateManager.cookie_max_bytesize
+    state.prune! max_bytesize: TurboReflex.config.max_cookie_size
     state.ordinal_payload
   end
 

data/lib/turbo_reflex/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TurboReflex
-  VERSION = "0.0.25"
+  VERSION = "0.0.27"
 end

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "turbo_reflex",
-  "version": "0.0.23",
+  "version": "0.0.26",
   "description": "Reflexes for Turbo Frames that help you build robust reactive applications",
   "main": "app/javascript/index.js",
   "repository": "https://github.com/hopsoft/turbo_reflex",