ratalada-contrib 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7dc83505ef9f19515c7d724d845243d929745c808b001eda6d701a5a05a5303a
+  data.tar.gz: ab848595fb7a33d79f798da713a0abe2413a7105ce422ed3c80aca2ffaed89c2
+SHA512:
+  metadata.gz: f337a60798f1ae83ceafaa3ec6e653399ac10790337cd0977a63e868193e383a89a7097333bc60c4de1b5e9ae8daf52bccedea645caf368121cabf401438e491
+  data.tar.gz: 71bb0c9027acc6a087c953704860688bc3b5b92be4ee7123d0ebedd58052687dca310bf5eb5f1da62331a95ff77be9de6ff03073f2b1d50722a669265a39bddd

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/lib/ratalada/contrib/inertia/core_ext.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# The gem's PropsResolver is plain Ruby except for three ActiveSupport core
+# extensions it calls on every resolve. We don't load ActiveSupport, so here
+# they are, AS-compatible.
+class Object
+  def try(method_name, ...) = respond_to?(method_name) ? public_send(method_name, ...) : nil
+
+  def blank? = respond_to?(:empty?) ? !!empty? : !self
+
+  def present? = !blank?
+end

data/lib/ratalada/contrib/inertia/csrf_middleware.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require "securerandom"
+require "rack/utils"
+
+module Ratalada
+  module Contrib
+    module Inertia
+      class CSRFMiddleware
+        COOKIE_NAME = "XSRF-TOKEN"
+        HEADER_KEY = "HTTP_X_XSRF_TOKEN"
+        ENV_TOKEN_KEY = "ratalada.inertia.csrf_token"
+        SAFE_METHODS = %w[GET HEAD OPTIONS].freeze
+
+        def initialize(app, same_site: :Lax)
+          @app = app
+          @same_site = same_site
+        end
+
+        def call(env)
+          existing = read_cookie(env)
+          token = existing || SecureRandom.urlsafe_base64(32)
+          env[ENV_TOKEN_KEY] = token
+
+          if token_mismatch?(env, existing)
+            forbidden(
+              "CSRF token mismatch (expected matching X-XSRF-TOKEN header to XSRF-TOKEN cookie)",
+            )
+          else
+            status, headers, body = @app.call(env)
+            unless existing == token
+              set_cookie!(headers, token)
+            end
+            [status, headers, body]
+          end
+        end
+
+        private
+
+          def safe_method?(env)
+            SAFE_METHODS.include?(env["REQUEST_METHOD"])
+          end
+
+          def token_mismatch?(env, existing)
+            if safe_method?(env)
+              false
+            else
+              header = env[HEADER_KEY].to_s
+              existing.nil? || header.empty? || !secure_compare(header, existing)
+            end
+          end
+
+          def read_cookie(env)
+            pairs = env["HTTP_COOKIE"].to_s.split(/;\s*/).map { |pair| pair.split("=", 2) }
+            match = pairs.find { |name, _value| name == COOKIE_NAME }
+            match && match[1]
+          end
+
+          def secure_compare(a, b)
+            a = a.to_s
+            b = b.to_s
+            if a.bytesize != b.bytesize
+              false
+            else
+              diff = 0
+              a.bytes.zip(b.bytes) { |ai, bi| diff |= ai ^ bi }
+              diff.zero?
+            end
+          end
+
+          def set_cookie!(headers, token)
+            cookie = ::Rack::Utils.set_cookie_header(
+              COOKIE_NAME,
+              value:     token,
+              path:      "/",
+              same_site: @same_site,
+            )
+
+            existing = headers["set-cookie"]
+            if existing
+              headers["set-cookie"] = Array(existing) + [cookie]
+            else
+              headers["set-cookie"] = cookie
+            end
+          end
+
+          def forbidden(message)
+            body = "#{message}\n"
+            [
+              403,
+              {
+                "content-type"   => "text/plain; charset=utf-8",
+                "content-length" => body.bytesize.to_s,
+              },
+              [body]
+            ]
+          end
+      end
+    end
+  end
+end

data/lib/ratalada/contrib/inertia/errors.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Ratalada
+  module Contrib
+    module Inertia
+      Error = Class.new(StandardError)
+      InvalidProtocol = Class.new(Error)
+    end
+  end
+end

data/lib/ratalada/contrib/inertia/helpers.rb

@@ -0,0 +1,213 @@
+# frozen_string_literal: true
+
+require "json"
+
+require_relative "response"
+
+module Ratalada
+  module Contrib
+    module Inertia
+      module Helpers
+        def inertia(component, props: {}, layout: nil)
+          if layout.nil?
+            layout = current_page_layout
+          end
+
+          version = current_inertia_version
+          shared = current_inertia_shared
+
+          if !@inertia_encrypt_history_override.nil?
+            encrypt = @inertia_encrypt_history_override == true
+          else
+            encrypt = Ratalada.config.inertia_encrypt_history == true
+          end
+
+          clear = @inertia_clear_history == true
+
+          if inertia_request?
+            content_type("application/json; charset=utf-8")
+            headers("x-inertia" => "true", "vary" => "X-Inertia")
+          end
+
+          errors_payload = inertia_errors_payload
+          sweep_inertia_session!
+
+          response_obj = Ratalada::Contrib::Inertia::Response.new(
+            component:       component,
+            props:           props,
+            request:         request,
+            context:         self,
+            version:         version,
+            url:             request.fullpath,
+            encrypt_history: encrypt,
+            clear_history:   clear,
+            shared:          shared,
+            errors:          errors_payload,
+          )
+          page_hash = response_obj.to_h
+          page_json = page_hash.to_json
+
+          if inertia_request?
+            page_json
+          else
+            @page = page_hash
+            @page_json = ::Rack::Utils.escape_html(page_json)
+            erb(layout, layout: false)
+          end
+        end
+
+        def render(*args, **kwargs, &block)
+          first = args.first
+          if args.length == 1 && first.is_a?(Hash) && first.key?(:inertia)
+            inertia(
+              first[:inertia],
+              props:  first[:props] || {},
+              layout: first[:layout],
+            )
+          elsif kwargs.key?(:inertia) && args.empty?
+            inertia(
+              kwargs[:inertia],
+              props:  kwargs[:props] || {},
+              layout: kwargs[:layout],
+            )
+          elsif first.is_a?(String) &&
+              args.length <= 2 &&
+              (args.length == 1 || args[1].is_a?(Hash))
+            layout = kwargs.delete(:layout)
+            props = {}
+            if args[1].is_a?(Hash)
+              props.merge!(args[1])
+            end
+            explicit_props = kwargs.delete(:props)
+            if explicit_props.is_a?(Hash)
+              props.merge!(explicit_props)
+            end
+            props.merge!(kwargs)
+            inertia(first, props: props, layout: layout)
+          else
+            super(*args, **kwargs, &block)
+          end
+        end
+
+        def render_modal(background:, background_props:, component:, props:, url:)
+          inertia(
+            background,
+            props: background_props.merge(
+              modal: {
+                component: component,
+                props:     props,
+                url:       url,
+              },
+            ),
+          )
+        end
+
+        def inertia_request?
+          request.env["HTTP_X_INERTIA"] == "true"
+        end
+
+        def page_request?
+          inertia_request?
+        end
+
+        def csrf_token
+          request.env["ratalada.inertia.csrf_token"]
+        end
+
+        # The prop factories are the gem's (Ratalada::Contrib::Inertia delegates to
+        # InertiaRails).
+        def always(value = nil, &block) = Ratalada::Contrib::Inertia.always(value, &block)
+        def defer(group: "default", &block) = Ratalada::Contrib::Inertia.defer(group: group, &block)
+        def optional(&block) = Ratalada::Contrib::Inertia.optional(&block)
+        def lazy(&block) = Ratalada::Contrib::Inertia.lazy(&block)
+        def merge(value = nil, &block) = Ratalada::Contrib::Inertia.merge(value, &block)
+        def deep_merge(&block) = Ratalada::Contrib::Inertia.deep_merge(&block)
+        def once(...) = Ratalada::Contrib::Inertia.once(...)
+        def cache(...) = Ratalada::Contrib::Inertia.cache(...)
+        def scroll(...) = Ratalada::Contrib::Inertia.scroll(...)
+
+        def current_inertia_shared
+          blocks = Ratalada.config.inertia_share_blocks || []
+          merged = {}
+          blocks.each do |b|
+            v = instance_exec(&b)
+            if v.is_a?(Hash)
+              merged = deep_merge_hashes(merged, v)
+            end
+          end
+
+          merged
+        end
+
+        def current_inertia_version
+          Ratalada::Contrib::Inertia.current_version
+        end
+
+        def inertia_errors(payload = nil)
+          if payload.nil?
+            (session[:_inertia_errors] || {}).dup
+          else
+            session[:_inertia_errors] = payload
+            payload
+          end
+        end
+
+        def page_errors(payload = nil)
+          inertia_errors(payload)
+        end
+
+        def inertia_clear_history!
+          @inertia_clear_history = true
+        end
+
+        def clear_history!
+          inertia_clear_history!
+        end
+
+        def inertia_encrypt_history!(flag = true)
+          @inertia_encrypt_history_override = flag
+        end
+
+        def encrypt_history!(flag = true)
+          inertia_encrypt_history!(flag)
+        end
+
+        def inertia_errors_payload
+          errors = session[:_inertia_errors]
+          if errors.nil?
+            nil
+          else
+            if errors.respond_to?(:empty?) && errors.empty?
+              nil
+            else
+              errors
+            end
+          end
+        end
+
+        def sweep_inertia_session!
+          if session.respond_to?(:[]=)
+            session[:_inertia_errors] = nil
+          end
+        end
+
+        private
+
+          def current_page_layout
+            config = Ratalada.config
+            if config.respond_to?(:page_layout)
+              config.page_layout
+            else
+              config.inertia_layout
+            end
+          end
+
+          def deep_merge_hashes(a, b)
+            a.merge(b) do |_k, av, bv|
+              (av.is_a?(Hash) && bv.is_a?(Hash)) ? deep_merge_hashes(av, bv) : bv
+            end
+          end
+      end
+    end
+  end
+end

data/lib/ratalada/contrib/inertia/middleware.rb

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+module Ratalada
+  module Contrib
+    module Inertia
+      # Rack middleware for the Inertia protocol. Mirrors
+      # InertiaRails::Middleware but built on plain Rack rather than
+      # ActionDispatch — the gem's version also manages its Rails flash and
+      # session keys, which this app does not use (errors live in
+      # session[:_inertia_errors] and are swept by the render helpers).
+      class Middleware
+        INERTIA_HEADER = "HTTP_X_INERTIA"
+        INERTIA_VERSION_HEADER = "HTTP_X_INERTIA_VERSION"
+        REDIRECT_STATUSES = [301, 302, 303].freeze
+        REWRITABLE_REDIRECT_STATUSES = [301, 302].freeze
+
+        def initialize(app, version: -> { Ratalada::Contrib::Inertia.current_version })
+          @app = app
+          @version = version
+        end
+
+        def call(env)
+          copy_xsrf_to_csrf!(env)
+          status, headers, body = @app.call(env)
+
+          if external_redirect?(env, status, headers)
+            status, headers, body = convert_to_location_response!(headers, body)
+          end
+
+          # Only 301/302 are rewritten to 303: a 303 already forces a GET on
+          # follow, and 307/308 preserve the request method by design.
+          if inertia_non_get_redirect?(env, status)
+            status = 303
+          end
+
+          # A response with X-Inertia-Location is already a full page visit —
+          # nothing to refresh.
+          if stale_inertia_get?(env) && !headers["X-Inertia-Location"]
+            force_refresh(env)
+          else
+            [status, headers, body]
+          end
+        end
+
+        private
+
+          # XHR follows redirects transparently, so a cross-origin target is only
+          # reachable through a window.location visit (409 + X-Inertia-Location).
+          # 307/308 are excluded: a full page visit is always a GET.
+          def external_redirect?(env, status, headers)
+            inertia_request?(env) &&
+              REDIRECT_STATUSES.include?(status) &&
+              external_origin?(env, headers["Location"])
+          end
+
+          def external_origin?(env, location)
+            uri = URI.parse(location.to_s)
+            if uri.host.nil? || uri.host.empty?
+              false
+            else
+              request = Rack::Request.new(env)
+              scheme = uri.scheme || request.scheme
+              port = uri.port || (scheme == "https" ? 443 : 80)
+
+              scheme != request.scheme ||
+                !uri.host.casecmp?(request.host) ||
+                port != request.port
+            end
+          rescue URI::InvalidURIError
+            false
+          end
+
+          # Mutates the headers in place to keep the rest of the response,
+          # notably Set-Cookie (which matters mid-OAuth).
+          def convert_to_location_response!(headers, body)
+            headers["X-Inertia-Location"] = headers.delete("Location")
+            headers.delete("Content-Type")
+            headers.delete("Content-Length")
+            if body.respond_to?(:close)
+              body.close
+            end
+
+            [409, headers, []]
+          end
+
+          def inertia_non_get_redirect?(env, status)
+            inertia_request?(env) &&
+              REWRITABLE_REDIRECT_STATUSES.include?(status) &&
+              %w[POST PUT PATCH DELETE].include?(env["REQUEST_METHOD"])
+          end
+
+          def stale_inertia_get?(env)
+            env["REQUEST_METHOD"] == "GET" && inertia_request?(env) && version_mismatch?(env)
+          end
+
+          def inertia_request?(env)
+            env[INERTIA_HEADER] == "true"
+          end
+
+          def version_mismatch?(env)
+            current = current_version
+            if current.nil? || current.empty?
+              false
+            else
+              env[INERTIA_VERSION_HEADER].to_s != current
+            end
+          end
+
+          def current_version
+            if @version.respond_to?(:call)
+              v = @version.call
+            else
+              v = @version
+            end
+            v.to_s
+          end
+
+          def force_refresh(env)
+            location = env["REQUEST_URI"] || build_url(env)
+            [409, { "x-inertia-location" => location, "vary" => "X-Inertia" }, []]
+          end
+
+          def copy_xsrf_to_csrf!(env)
+            if env["HTTP_X_XSRF_TOKEN"]
+              env["HTTP_X_CSRF_TOKEN"] = env["HTTP_X_XSRF_TOKEN"]
+            end
+          end
+
+          def build_url(env)
+            scheme = env["rack.url_scheme"] || "http"
+            host = env["HTTP_HOST"] || env["SERVER_NAME"]
+            path = env["PATH_INFO"]
+            qs = env["QUERY_STRING"]
+            full = +"#{scheme}://#{host}#{path}"
+            if qs && !qs.empty?
+              full << "?#{qs}"
+            end
+            full
+          end
+      end
+    end
+  end
+end

data/lib/ratalada/contrib/inertia/response.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Ratalada
+  module Contrib
+    module Inertia
+      # Builds the Inertia page object for a render. Shared data is deep-merged
+      # under the page props and errors are merged on top; prop resolution —
+      # partial reloads, deferred/optional/merge/once/scroll metadata — is the
+      # gem's PropsResolver, evaluating blocks in the request context via the
+      # gem's PropEvaluator.
+      class Response
+        attr_reader(
+          :component,
+          :props,
+          :request,
+          :context,
+          :version,
+          :url,
+          :encrypt_history,
+          :clear_history,
+          :shared,
+          :errors,
+        )
+
+        def initialize(
+          component:,
+          props:,
+          request:,
+          context:,
+          version:,
+          url: nil,
+          encrypt_history: false,
+          clear_history: false,
+          shared: {},
+          errors: nil
+        )
+          @component = component
+          @props = props || {}
+          @request = request
+          @context = context
+          @version = version.to_s
+          @url = url || request.fullpath
+          @encrypt_history = encrypt_history
+          @clear_history = clear_history
+          @shared = shared || {}
+          @errors = errors
+        end
+
+        def to_h
+          merged = deep_merge(shared, props)
+          if errors
+            merged = merged.merge(errors: errors)
+          end
+
+          resolved, metadata = ::InertiaRails::PropsResolver.new(
+            merged,
+            evaluator: ::InertiaRails::PropEvaluator.new(
+              context,
+              scroll_intent: request.env["HTTP_X_INERTIA_INFINITE_SCROLL_MERGE_INTENT"],
+            ),
+            visit:     {
+              component:   partial_request?,
+              only:        header_list("HTTP_X_INERTIA_PARTIAL_DATA"),
+              except:      header_list("HTTP_X_INERTIA_PARTIAL_EXCEPT"),
+              reset:       header_list("HTTP_X_INERTIA_RESET"),
+              except_once: header_list("HTTP_X_INERTIA_EXCEPT_ONCE_PROPS"),
+            },
+          ).resolve
+
+          page = {
+            component: component,
+            props:     resolved,
+            url:       url,
+            version:   version,
+          }
+          if encrypt_history
+            page[:encryptHistory] = true
+          end
+          if clear_history
+            page[:clearHistory] = true
+          end
+          page.merge!(metadata)
+          page
+        end
+
+        def to_json(*) = to_h.to_json
+
+        private
+
+          def partial_request?
+            request.env["HTTP_X_INERTIA_PARTIAL_COMPONENT"] == component
+          end
+
+          def header_list(key)
+            request.env[key].to_s.split(",").map(&:strip).reject(&:empty?)
+          end
+
+          def deep_merge(a, b)
+            a.merge(b) do |_k, av, bv|
+              if av.is_a?(Hash) && bv.is_a?(Hash)
+                deep_merge(av, bv)
+              else
+                bv
+              end
+            end
+          end
+      end
+    end
+  end
+end

data/lib/ratalada/contrib/inertia.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require "ratalada"
+
+# Prop system only... no rails-coupled stuff.
+require "inertia_rails/raw_json"
+require "inertia_rails/prop_onceable"
+require "inertia_rails/prop_mergeable"
+require "inertia_rails/prop_cacheable"
+require "inertia_rails/base_prop"
+require "inertia_rails/ignore_on_first_load_prop"
+require "inertia_rails/always_prop"
+require "inertia_rails/lazy_prop"
+require "inertia_rails/optional_prop"
+require "inertia_rails/cached_prop"
+require "inertia_rails/defer_prop"
+require "inertia_rails/merge_prop"
+require "inertia_rails/once_prop"
+require "inertia_rails/scroll_metadata"
+require "inertia_rails/scroll_prop"
+require "inertia_rails/prop_evaluator"
+require "inertia_rails/props_resolver"
+
+require_relative "inertia/errors"
+require_relative "inertia/core_ext"
+require_relative "inertia/response"
+require_relative "inertia/middleware"
+require_relative "inertia/csrf_middleware"
+require_relative "inertia/helpers"
+
+# LazyProp reports deprecation through code that's tied to rails.
+module InertiaRails
+  def self.deprecator = Kernel
+end
+
+module Ratalada
+  module Contrib
+    module Inertia
+      module_function
+
+      def always(value = nil, &block) = ::InertiaRails::AlwaysProp.new(&block || proc { value })
+      def defer(group: "default", &block) = ::InertiaRails::DeferProp.new(group: group, &block)
+      def optional(&block) = ::InertiaRails::OptionalProp.new(&block)
+      def lazy(value = nil, &block) = ::InertiaRails::LazyProp.new(value, &block)
+      def merge(value = nil, &block) = ::InertiaRails::MergeProp.new(&block || proc { value })
+      def deep_merge(match_on: nil, &block) = ::InertiaRails::MergeProp.new(deep_merge: true, match_on: match_on, &block)
+      def once(...) = ::InertiaRails::OnceProp.new(...)
+      def cache(...) = ::InertiaRails::CachedProp.new(...)
+      def scroll(metadata = nil, **options, &block) = ::InertiaRails::ScrollProp.new(metadata: metadata, **options, &block)
+
+      # Registers a shared-prop block, run in the request context on every
+      # inertia render and deep-merged under the page props.
+      def share(&block)
+        unless block
+          raise ArgumentError, "share requires a block"
+        end
+
+        Ratalada.config.inertia_share_blocks = Ratalada.config.inertia_share_blocks + [block]
+      end
+
+      def share_props(&block) = share(&block)
+
+      # The asset version sent with every page object. An app-defined
+      # page_version setting wins over inertia_version; either may be
+      # callable, and whatever comes out is stringified.
+      def current_version
+        config = Ratalada.config
+        if config.respond_to?(:page_version)
+          version = config.page_version
+        else
+          version = config.inertia_version
+        end
+
+        version.respond_to?(:call) ? version.call.to_s : version.to_s
+      end
+    end
+  end
+end
+
+unless defined?(::Inertia)
+  ::Inertia = Ratalada::Contrib::Inertia
+end
+
+# Contrib settings, registered on the core config exactly like the core's own.
+Ratalada.setting :inertia_version, default: "1"
+Ratalada.setting :inertia_layout, default: :layout
+Ratalada.setting :inertia_encrypt_history, default: false
+Ratalada.setting :inertia_csrf_protection, default: true
+Ratalada.setting :inertia_share_blocks, default: []

data/lib/ratalada/contrib/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Ratalada
+  module Contrib
+    VERSION = "2.0.0"
+  end
+end

data/lib/ratalada/contrib/vite.rb

@@ -0,0 +1,66 @@
+require "vite_ruby"
+
+module Ratalada
+  module Contrib
+    module Vite
+      # Rack middleware that fronts the app with vite's dev-server proxy while
+      # `bin/vite dev` is running, and is a pass-through otherwise (production,
+      # or a build served from the manifest). The decision is ViteRuby's
+      # `run_proxy?`, read once at boot like any other `Server.use` argument.
+      #
+      #   Server.use(Ratalada::Contrib::Vite::DevServerProxy).run { ... }
+      class DevServerProxy
+        def initialize(app, ssl_verify_none: true)
+          if ::ViteRuby.run_proxy?
+            @app = ::ViteRuby::DevServerProxy.new(app, ssl_verify_none: ssl_verify_none)
+          else
+            @app = app
+          end
+        end
+
+        def call(env) = @app.call(env)
+      end
+
+      module TagHelpers
+        def vite_client_tag
+          src = vite_manifest.vite_client_src
+
+          if src
+            %(<script type="module" src="#{src}"></script)
+          end
+        end
+
+        def vite_react_refresh_tag = vite_manifest.react_refresh_preamble
+
+        def vite_asset_path(name, **options) = vite_manifest.path_for(name, **options)
+
+        def vite_javascript_tag(*names, type: "module", crossorigin: "anonymous", **options)
+          entries = vite_manifest.resolve_entries(*names, **options)
+
+          scripts = entries.fetch(:scripts).map do |src|
+            %(<script type="#{type}" crossorigin="#{crossorigin}" src="#{src}"></script>)
+          end
+          preloads = entries.fetch(:imports).map do |href|
+            %(<link rel="modulepreload" as="script" crossorigin="#{crossorigin}" href="#{href}">)
+          end
+          styles = entries.fetch(:stylesheets).map { |href| %(<link rel="stylesheet" href="#{href}">) }
+
+          (scripts + preloads + styles).join("\n")
+        end
+
+        def vite_styleshee_tag(*name, **options)
+          name
+            .map { |name| vite_asset_path(name, type: :stylesheet, **options) }
+            .map { |href| %(<link rel="stylesheet" href="#{href}">) }
+            .join("\n")
+        end
+
+        private
+
+          def vite_manifest
+            ViteRuby.instance.manifest
+          end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: ratalada-contrib
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Nathan K
+bindir: bin
+cert_chain: []
+date: 1980-01-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ratalada
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: |
+  Optional add-on modules for ratalada that do not belong in the core gem.
+  Require only the ones you use; each pulls its own framework (the
+  file-based routing module expects Sinatra, supplied by your app).
+email:
+- nathankidd@hey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- lib/ratalada/contrib/inertia.rb
+- lib/ratalada/contrib/inertia/core_ext.rb
+- lib/ratalada/contrib/inertia/csrf_middleware.rb
+- lib/ratalada/contrib/inertia/errors.rb
+- lib/ratalada/contrib/inertia/helpers.rb
+- lib/ratalada/contrib/inertia/middleware.rb
+- lib/ratalada/contrib/inertia/response.rb
+- lib/ratalada/contrib/version.rb
+- lib/ratalada/contrib/vite.rb
+homepage: https://github.com/n-at-han-k/ratalada
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/n-at-han-k/ratalada
+  source_code_uri: https://github.com/n-at-han-k/ratalada
+  documentation_uri: https://github.com/n-at-han-k/ratalada
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.7.2
+specification_version: 4
+summary: Contrib add-ons for ratalada.
+test_files: []