turbo_boost-commands 0.2.2 → 0.3.1

data/lib/turbo_boost/commands/errors.rb

@@ -1,16 +1,11 @@
 # frozen_string_literal: true
 
 module TurboBoost::Commands
-  class InvalidTokenError < StandardError; end
-
-  class InvalidClassError < StandardError; end
-
-  class InvalidMethodError < StandardError; end
-
-  class InvalidElementError < StandardError; end
+  class StateError < StandardError
+  end
 
   class CommandError < StandardError
-    def initialize(*messages, command:, http_status:, cause: nil)
+    def initialize(*messages, command:, http_status: :internal_server_error, cause: nil)
       @cause = cause
       @command = command
       @http_status_code = TurboBoost::Commands.http_status_code(http_status)
@@ -30,6 +25,18 @@ module TurboBoost::Commands
     end
   end
 
+  class InvalidTokenError < CommandError
+  end
+
+  class InvalidClassError < CommandError
+  end
+
+  class InvalidMethodError < CommandError
+  end
+
+  class InvalidElementError < CommandError
+  end
+
   class AbortError < CommandError
     def initialize(*messages, **kwargs)
       messages.prepend "TurboBoost Command intentionally aborted via `throw` in a `[before,after,around]_command` lifecycle callback!"

data/lib/turbo_boost/commands/{middleware.rb → middlewares/entry_middleware.rb}

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class TurboBoost::Commands::Middleware
+class TurboBoost::Commands::EntryMiddleware
   PATH = "/turbo-boost-command-invocation"
 
   def initialize(app)
@@ -35,6 +35,11 @@ class TurboBoost::Commands::Middleware
     false
   end
 
+  def convert_to_get_request?(driver)
+    return true if driver == "frame" || driver == "window"
+    false
+  end
+
   # Modifies the given POST request so Rails sees it as GET.
   #
   # The posted JSON body content holds the TurboBoost Command meta data.
@@ -42,19 +47,21 @@ class TurboBoost::Commands::Middleware
   #
   # @example POST payload for: /turbo-boost-command-invocation
   #   {
-  #     "id"                => "turbo-command-f824ded1-a86e-4a36-9442-ea2165a64569",                 # unique command invocation id
-  #     "name"              => "IncrementCountCommand",                                              # the command being invoked
-  #     "elementId"         => nil,                                                                  # the triggering element's dom id
-  #     "elementAttributes" => {"tag"=>"BUTTON", "checked"=>false, "disabled"=>false, "value"=>nil}, # the triggering element's attributes
-  #     "startedAt"         => 1708213193567,                                                        # the time the command was invoked
-  #     "changedState"      => {},                                                                   # the delta of optimistic state changes made on the client
-  #     "clientState"       => {                                                                     # the state as it was on the client
-  #       "command_token" => "IlU0dVVhNElFdkVCZVUi--a878d33d85ed9b9611c155ed1d7bb8785fb..."}         # the command token used for forgery protection
+  #     "csrfToken"         => "..."                                                 # Rails' CSRF token
+  #     "id"                => "turbo-command-f824ded1-a86e-4a36-9442-ea2165a64569", # Unique ID for the command invocation
+  #     "name"              => "ExampleCommand#perform",                             # Name of command being invoked
+  #     "elementId"         => nil,                                                  # Triggering element's DOM id
+  #     "elementAttributes" => {...},                                                # Triggering element's attributes
+  #     "startedAt"         => 1708213193567,                                        # Time the command was invoked
+  #     "elementCache"      => {...},                                                # Cache of ALL tracked element attributes (optimistic changes)
+  #     "state"             => {                                                     # State ... TODO: HOPSOFT
+  #       "page"            => {...},                                                # - transient page state (element attributes, etc.)
+  #       "signed"          => "",                                                   # - signed state used for the last server render (untampered)
+  #       "unsigned"        => {...}                                                 # - state with optimistic changes from the client
   #     },
-  #     "signedState"       => "eyJfcmFpbHMiOnsiZGF0YSI6ImdpZDovL2R1VuaXZlcnNhbElEOjpFeH...",        # the state as it was on the server at the time of the last command invocation
-  #     "driver"            => "frame",                                                              # the driver used to invoke the command
-  #     "frameId"           => "basic_command-turbo-frame",                                          # the turbo-frame id (if applicable)
-  #     "src"               => "/basic_command.turbo_stream"                                         # the URL to present to Rails (turbo-frame src, window location, etc.)
+  #     "driver"            => "frame",                                              # Driver used to invoke the command
+  #     "frameId"           => "...",                                                # TurboFrame id (if applicable)
+  #     "src"               => "..."                                                 # URL to present to Rails (turbo-frame src, window location, etc.)
   #   }
   #
   # @param request [Rack::Request] the request to modify
@@ -64,20 +71,22 @@ class TurboBoost::Commands::Middleware
 
     request.env.tap do |env|
       # Store the command params in the environment
-      env["turbo_boost_command"] = params
-
-      # Change the method from POST to GET
-      env["REQUEST_METHOD"] = "GET"
+      env["turbo_boost_command_params"] = params
 
       # Update the URI, PATH_INFO, and QUERY_STRING
       env["REQUEST_URI"] = uri.to_s if env.key?("REQUEST_URI")
       env["PATH_INFO"] = uri.path
       env["QUERY_STRING"] = uri.query.to_s
 
-      # Clear the body and related headers so the appears and behaves like a GET
-      env["rack.input"] = StringIO.new
-      env["CONTENT_LENGTH"] = "0"
-      env.delete("CONTENT_TYPE")
+      # Change the method from POST to GET
+      if convert_to_get_request?(params["driver"])
+        env["REQUEST_METHOD"] = "GET"
+
+        # Clear the body and related headers so the appears and behaves like a GET
+        env["rack.input"] = StringIO.new
+        env["CONTENT_LENGTH"] = "0"
+        env.delete("CONTENT_TYPE")
+      end
     end
   rescue => error
     puts "#{self.class.name} failed to modify the request! #{error.message}"

data/lib/turbo_boost/commands/middlewares/exit_middleware.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+class TurboBoost::Commands::ExitMiddleware
+  BODY_PATTERN = /<\/\s*body/io
+  TURBO_FRAME_PATTERN = /<\/\s*turbo-frame/io
+  TURBO_STREAM_PATTERN = /<\/\s*turbo-stream/io
+  TAIL_PATTERN = /\z/io
+
+  def initialize(app)
+    @app = app
+  end
+
+  def call(env)
+    @params = env["turbo_boost_command_params"]
+    response = @app.call(env)
+    return modify!(env, response) if modify?(env)
+    response
+  end
+
+  private
+
+  def modify?(env)
+    env["turbo_boost_command_responder"].is_a? TurboBoost::Commands::Responder
+  end
+
+  def modify!(env, response)
+    responder = env["turbo_boost_command_responder"]
+    status, headers, body = response
+    new_body = body_to_a(body).join
+
+    case response_type(new_body)
+    when :body
+      match = new_body.match(BODY_PATTERN).to_s
+      new_body.sub! BODY_PATTERN, [responder.body, match].join
+    when :frame
+      match = new_body.match(TURBO_FRAME_PATTERN).to_s
+      new_body.sub! TURBO_FRAME_PATTERN, [responder.body, match].join
+    else
+      new_body << responder.body
+    end
+
+    [status, headers.merge(responder.headers), [new_body]]
+  rescue => error
+    Rails.logger.error "TurboBoost::Commands::Runner failed to append to the response! #{error.message}"
+    [status, headers, body]
+  end
+
+  def body_to_a(body)
+    return [] if body.nil?
+    return body if body.is_a?(Array)
+    return [body] if body.is_a?(String)
+    return body.to_ary if body.respond_to?(:to_ary)
+    return body.each.to_a if body.respond_to?(:each)
+    [body.to_s]
+  end
+
+  def response_type(body)
+    return :body if body.match?(BODY_PATTERN)
+    return :frame if body.match?(TURBO_FRAME_PATTERN)
+    return :stream if body.match?(TURBO_STREAM_PATTERN)
+    :unknown
+  end
+end

data/lib/turbo_boost/commands/patches/action_view_helpers_tag_helper_tag_builder_patch.rb

@@ -4,7 +4,15 @@ require_relative "../attribute_hydration"
 
 module TurboBoost::Commands::Patches::ActionViewHelpersTagHelperTagBuilderPatch
   def tag_options(options, ...)
-    dehydrated_options = TurboBoost::Commands::AttributeHydration.dehydrate(options)
-    super(dehydrated_options, ...)
+    options = turbo_boost&.state&.tag_options(options) || options
+    options = TurboBoost::Commands::AttributeHydration.dehydrate(options)
+    super(options, ...)
+  end
+
+  private
+
+  def turbo_boost
+    return nil unless @view_context.respond_to?(:turbo_boost)
+    @view_context.turbo_boost
   end
 end

data/lib/turbo_boost/commands/responder.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+class TurboBoost::Commands::Responder
+  attr_accessor :headers
+
+  def initialize
+    @headers = HashWithIndifferentAccess.new
+    @body = Set.new
+  end
+
+  def body
+    @body.join.html_safe
+  end
+
+  def add_header(key, value)
+    headers[key.to_s.downcase] = value.to_s
+  end
+
+  def add_content(content)
+    @body << sanitizer.sanitize(content) + "\n"
+  end
+
+  private
+
+  def sanitizer
+    TurboBoost::Commands::Sanitizer.instance
+  end
+end