roda-inertia-lite 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e8c72b8c3e0ceb53697e8dd7ddca0d00629c45f818e3ee9f5abd6db37ebc69be
+  data.tar.gz: 767440533bd5fe394270edbd47133eec4e0724c8ca94904914ec9619621eae28
+SHA512:
+  metadata.gz: 8639f9d4288fa12f78e3d6824311ba60a12ceea90748064521e2e767a245801c0f63e3ee32c3c1924e1dd9c3de9f661c5f9033c276fcf9e90948ef6f3fb642ba
+  data.tar.gz: 8da2fac1587eb3e886a7aef4058be8716680313e26cf8ac4134f2a826782db5c8100060cc3a9b00d4c02d475a98c32b65604327b83c15b4470090ffed40f077f

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+## [Unreleased]
+
+## [0.1.0]
+
+- Fork of https://github.com/holamendi/inertia-roda
+- Removed "render" and "h" plugins dependency
+- Added the string layout optins

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Pablo Orellana
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,192 @@
+# Inertia.js Roda (Lite)
+
+A standalone [Roda](https://roda.jeremyevans.net/) adapter for seamlessly integrating [Inertia.js](https://inertiajs.com/) without views or other plugins dependency. 
+
+*forked from [https://github.com/holamendi/inertia-roda](https://github.com/holamendi/inertia-roda)*
+
+
+## Installation
+
+Add this line to your application's `Gemfile`:
+
+```ruby
+gem "roda-inertia-lite"
+```
+
+Then run:
+
+```bash
+bundle install
+```
+
+## Usage
+
+### 1. Register the plugin
+
+```ruby
+require "roda"
+
+class App < Roda
+  plugin :inertia, version: -> { "v1" }
+end
+```
+
+The `version` option is **required**. It can be a string or a callable (e.g., a lambda reading from an environment variable):
+
+```ruby
+# Static version
+plugin :inertia, version: "abc123"
+
+# Dynamic version (re-read on every request)
+plugin :inertia, version: { ENV.fetch("ASSET_VERSION", "v1") }
+```
+
+### 2. Render Inertia responses
+
+Use `inertia` in your routes to return page data as JSON (for Inertia requests) or as a full HTML document (for initial page loads):
+
+```ruby
+class App < Roda
+  plugin :inertia, version: -> { "v1" }
+
+  route do |r|
+    r.get "users" do
+      inertia "Users/Index", props: { users: User.all }
+    end
+  end
+end
+```
+
+**For Inertia requests** (headers include `X-Inertia: true`):
+- Sets response header `X-Inertia: true`
+- Sets response header `Vary: X-Inertia`
+- Returns a JSON page object:
+
+```json
+{
+  "component": "Users/Index",
+  "props": { "users": [{ "id": 1, "name": "Alice" }] },
+  "url": "/users",
+  "version": "v1"
+}
+```
+
+**For non-Inertia requests** (initial page load):
+- Returns a full HTML document with the JSON page data embedded in a `<div id="app" data-page='...'>` tag
+- The HTML structure is built from the configured layout (see [Custom Layout](#custom-layout))
+
+### 3. Handle redirects
+
+Use `inertia_redirect` for both Inertia and non-Inertia requests:
+
+```ruby
+class App < Roda
+  plugin :inertia, version: -> { "v1" }
+
+  route do |r|
+    r.post "users" do
+      user = User.create(r.params["user"])
+      inertia_redirect "/users/#{user.id}"
+    end
+  end
+end
+```
+
+**For Inertia requests:**
+- Internal paths (same host): redirects with **302** (GET) or **303** (non-GET)
+- External URLs (different host): returns **409 Conflict** with an `X-Inertia-Location` header, telling the client to perform a full page visit
+
+**For non-Inertia requests:**
+- Always performs a standard redirect (default **302**, or specify a custom status)
+
+**Custom status:**
+
+```ruby
+inertia_redirect "/dashboard", status: 301
+```
+
+### 4. Check if a request is an Inertia request
+
+Use `inertia_request?` to conditionally handle Inertia vs. non-Inertia requests:
+
+```ruby
+route do |r|
+  r.get "dashboard" do
+    if inertia_request?
+      inertia "Dashboard", props: { stats: calculate_stats }
+    else
+      # Handle non-Inertia request differently
+    end
+  end
+end
+```
+
+## Configuration
+
+### Custom Layout
+
+You can customize the HTML document structure string using the `layout` option:
+
+```ruby
+plugin :inertia,
+  version: -> { "v1" },
+  layout: {
+    head: "<title>My App</title>",
+    body: "<footer>&copy; 2024 My App</footer>"
+  }
+```
+
+This produces:
+
+```html
+<html><head><meta charset='utf-8' /><meta name='viewport' content='width=device-width, initial-scale=1, shrink-to-fit=no'><title>My App</title></head><body><div id='app' data-page='{...}'></div><footer>&copy; 2024 My App</footer></body></html>
+```
+
+## How It Works
+
+### Version Conflicts (409 Responses)
+
+When the client's asset version doesn't match the server's version (detected via the `X-Inertia-Version` header), the plugin returns a **409 Conflict** response with an `X-Inertia-Location` header. This tells the Inertia client to perform a full page reload to fetch fresh assets.
+
+```
+Client Request:
+  X-Inertia: true
+  X-Inertia-Version: v0
+
+Server Response:
+  Status: 409 Conflict
+  X-Inertia-Location: https://example.com/page
+```
+
+### Request Flow
+
+```
+                    +------------------+
+                    |   Inertia Request?|
+                    +--------+---------+
+                             |
+              +--------------+--------------+
+              |                             |
+              v                             v
+      +-------+-------+           +--------+--------+
+      | X-Inertia: true|           |  Initial Load   |
+      +-------+-------+           +--------+--------+
+              |                             |
+              v                             v
+    +---------+---------+         +---------+---------+
+    | Version matches?  |         |  Return full HTML  |
+    +---------+---------+         |  document with    |
+              |                   |  embedded JSON    |
+    +---------+---------+         +-------------------+
+    | Yes       | No    |
+    v           v
++---+---+   +---+---+   +------------------+
+| Return|   | 409   |   |  Redirect:       |
+| JSON  |   |Conflict|   |  302/303         |
++---+---+   +---+---+   +------------------+
+                           External? -> 409
+```
+
+## License
+
+MIT

data/lib/roda/plugins/inertia.rb

@@ -0,0 +1,120 @@
+require "oj"
+require "uri"
+
+class Roda
+  module RodaPlugins
+    module Inertia
+      HTML_HEAD            = "<html><head><meta charset='utf-8' /><meta name='viewport' content='width=device-width, initial-scale=1, shrink-to-fit=no'>".freeze
+      HTML_BODY_START      = "</head><body><div id='app' data-page='".freeze
+      HTML_APP_TAG_END     = "'></div>".freeze
+      HTML_BODY_END        = "</body></html>".freeze
+
+      HTTP_X_INERTIA = "HTTP_X_INERTIA".freeze
+      X_INERTIA_LOCATION = "X-Inertia-Location".freeze
+      X_INERTIA = "X-Inertia".freeze
+      VARY = "vary".freeze
+      STRING_TRUE = "true".freeze
+      EMPTY_STRING = "".freeze
+      HTTP_X_INERTIA_VERSION = "HTTP_X_INERTIA_VERSION".freeze
+      HTTP = "http://".freeze
+      HTTPS = "https://".freeze
+      JSON_MIME_TYPE = "application/json".freeze
+      QUESTION_MARK = "?".freeze
+
+      def self.configure(app, opts = {})
+        app.opts[:inertia_version] = opts[:version]
+        head = opts.dig(:layout, :head) || EMPTY_STRING
+        body = opts.dig(:layout, :body) || EMPTY_STRING
+
+        app.opts[:inertia_html_head] ||= '' << HTML_HEAD << head << HTML_BODY_START
+        app.opts[:inertia_html_body] ||= '' << HTML_APP_TAG_END << body << HTML_BODY_END
+      end
+
+      module InstanceMethods
+        def inertia(component, props: {})
+          if request.get? && inertia_request? && version_stale?
+            response.status = 409
+            response[X_INERTIA_LOCATION] = request.url
+            return EMPTY_STRING
+          end
+
+          page_data = {
+            component: component,
+            props: props,
+            url: inertia_request_url,
+            version: inertia_version
+          }
+
+          if inertia_request?
+            response[X_INERTIA] = STRING_TRUE
+            response[VARY] = X_INERTIA
+
+            page_data
+          else
+            '' \
+              << opts[:inertia_html_head] \
+              << Oj.dump(page_data, mode: :compat) \
+              << opts[:inertia_html_body] \
+          end
+        end
+
+        def inertia_redirect(path, status: nil)
+          if inertia_request?
+            status ||= request.get? ? 302 : 303
+
+            if external_url?(path)
+              response.status = 409
+              response[X_INERTIA_LOCATION] = path
+              EMPTY_STRING
+            else
+              request.redirect(path, status)
+            end
+          else
+            request.redirect(path, status || 302)
+          end
+        end
+
+        def inertia_request?
+          request.get_header(HTTP_X_INERTIA) == STRING_TRUE
+        end
+
+        private
+
+        def version_stale?
+          client_version = request.get_header(HTTP_X_INERTIA_VERSION)
+          server_version = inertia_version
+
+          server_version && client_version && client_version != server_version.to_s
+        end
+
+        def external_url?(path)
+          return false unless path.start_with?(HTTP, HTTPS)
+
+          uri = URI.parse(path)
+          [uri.scheme, uri.host, uri.port] != [request.scheme, request.host, request.port]
+        rescue URI::InvalidURIError
+          false
+        end
+
+        def inertia_request_url
+          query = request.query_string
+          return request.path if query.nil? || query.empty?
+
+          '' << request.path << QUESTION_MARK << query
+        end
+
+        def inertia_version
+          version = opts[:inertia_version]
+
+          if version.respond_to?(:call)
+            version.call
+          else
+            version
+          end
+        end
+      end
+    end
+
+    register_plugin(:inertia, Inertia)
+  end
+end

data/lib/roda-inertia-lite.rb

@@ -0,0 +1 @@
+require_relative "roda/plugins/inertia"

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: roda-inertia-lite
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Henrique F. Teixeira
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: roda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Inertia.js adapter for Roda, without views or other plugins dependency
+email:
+- hriqueft@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/roda-inertia-lite.rb
+- lib/roda/plugins/inertia.rb
+homepage: https://github.com/henrique-ft/roda-inertia-lite
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/henrique-ft/roda-inertia-lite
+  source_code_uri: https://github.com/henrique-ft/roda-inertia-lite
+  changelog_uri: https://github.com/henrique-ft/roda-inertia-lite/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.17
+specification_version: 4
+summary: Standalone Inertia.js adapter for Roda
+test_files: []