inertia_rails-contrib 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5dca7d6390241ca5da0909ccd2cdb516228c3e35c2db48f97950de6e7299c25
-  data.tar.gz: 502c67ce0772ef78e96860a21516ca7cfe185ef30b9db1059a79d328257ac4b2
+  metadata.gz: eff1b41b96c46c48c582218d5a3337a26f7e6ee5bb94a1bf32ddca65d86ff8d9
+  data.tar.gz: 1d6ffdd2a0aeb3de9f90e364a260f53a80f14b98a4d0a8c685c5181b9132eb39
 SHA512:
-  metadata.gz: 96a9dd14f7d57b52832c685221d92efd1354e5a8e8bfdc6edd46746434aba4ba67094635a5104625eabff34bd78cd01abffeaee043365418fc0a86a81d9b0e88
-  data.tar.gz: 1e2ea3af72ae494d24e6d95ecb9df09adf92e87d0ebbe2dffeee3293b4e7fcaa157fea0edd2c67b10944e553d71c6fa2642ee2197652441e43a9c671d9c8c2cd
+  metadata.gz: 757b700b44d096aef10748596026b81f3b7fb337ce894ec8e877f5d1d0994a925e56c8541062593177dd32e2c3d8bbd2970a77b48d9fb4c456ecd242f81a806a
+  data.tar.gz: 2edff2c7ebfcd93b35bb130d3166a3aba3be16fea99bb5c4113049e54033e4004c05c6887c7850abe3d54ea5b34c7737747917a4795441cc5477caeed217c0d5

data/CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning].
 
 ## [Unreleased]
 
+## [0.5.0] - 2025-06-11
+
+Added:
+
+- [InertiaUI Modal](https://github.com/inertiaui/modal) support ([@skryukov])
+
 ## [0.4.0] - 2024-12-23
 
 Changed:
@@ -78,7 +84,9 @@ Added:
 [@Shaglock]: https://github.com/Shaglock
 [@skryukov]: https://github.com/skryukov
 
-[Unreleased]: https://github.com/skryukov/inertia_rails-contrib/compare/v0.3.0...HEAD
+[Unreleased]: https://github.com/skryukov/inertia_rails-contrib/compare/v0.5.0...HEAD
+[0.5.0]: https://github.com/skryukov/inertia_rails-contrib/compare/v0.4.0...v0.5.0
+[0.4.0]: https://github.com/skryukov/inertia_rails-contrib/compare/v0.3.0...v0.4.0
 [0.3.0]: https://github.com/skryukov/inertia_rails-contrib/compare/v0.2.2...v0.3.0
 [0.2.2]: https://github.com/skryukov/inertia_rails-contrib/compare/v0.2.1...v0.2.2
 [0.2.1]: https://github.com/skryukov/inertia_rails-contrib/compare/v0.2.0...v0.2.1

data/README.md

@@ -27,6 +27,37 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
     $ gem install inertia_rails-contrib
 
+## InertiaUI Modal Support
+
+`InertiaRailsContrib` provides support for [InertiaUI Modal](https://github.com/inertiaui/modal) in the Rails application.
+
+With InertiaUI Modal, you can easily open any route in a Modal or Slideover without having to change anything about your existing routes or controllers.
+
+By default, InertiaUI Modal doesn't require anything from the Inertia Server Adapters, since it just opens modals without changing the URL.
+However, InertiaUI Modal also supports updating the URL when opening a modal (see the docs on why you might want that: https://inertiaui.com/inertia-modal/docs/base-route-url).
+
+### Setup
+
+1. Follow the NPM installation instructions from the [InertiaUI Modal documentation](https://inertiaui.com/inertia-modal/docs/installation#npm-installation).
+
+2. Enable InertiaUI Modal, turn on the `enable_inertia_ui_modal` option in the `inertia_rails_contrib.rb` initializer:
+
+```ruby
+InertiaRailsContrib.configure do |config|
+  config.enable_inertia_ui_modal = true
+end
+```
+
+This will add a new render method `inertia_modal` that can be used in the controller actions:
+
+```ruby
+class PostsController < ApplicationController
+  def new
+    render inertia_modal: 'Post/New', props: { post: Post.new }, base_url: posts_path
+  end
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/inertia_rails_contrib/configuration.rb

@@ -0,0 +1,10 @@
+# lib/inertia_rails_contrib/engine.rb
+module InertiaRailsContrib
+  class Configuration
+    attr_accessor :enable_inertia_ui_modal
+
+    def initialize
+      @enable_inertia_ui_modal = false
+    end
+  end
+end

data/lib/inertia_rails_contrib/engine.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module InertiaRailsContrib
+  class Engine < ::Rails::Engine
+    initializer "inertia_rails_contrib.inertia_ui_modal" do
+      require_relative "inertia_ui_modal" if InertiaRailsContrib.configuration.enable_inertia_ui_modal
+    end
+  end
+end

data/lib/inertia_rails_contrib/inertia_ui_modal/inertia_rails_patch.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "inertia_rails/renderer"
+
+module InertiaRailsContrib
+  module InertiaUIModal
+    module RendererPatch
+      def page
+        super.tap do |modal|
+          if @request.env[:_inertiaui_modal]
+            modal[:props][:_inertiaui_modal] = @request.env[:_inertiaui_modal]
+            modal[:url] = modal[:props][:_inertiaui_modal][:url]
+          end
+        end
+      end
+    end
+  end
+end
+
+InertiaRails::Renderer.prepend(InertiaRailsContrib::InertiaUIModal::RendererPatch)

data/lib/inertia_rails_contrib/inertia_ui_modal/redirect.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module InertiaRailsContrib
+  module InertiaUIModal
+    module Redirect
+      def redirect_back_or_to(fallback_location, allow_other_host: _allow_other_host, **options)
+        inertia_modal_referer = request.headers[HEADER_BASE_URL]
+        if inertia_modal_referer && (allow_other_host || _url_host_allowed?(inertia_modal_referer))
+          redirect_to inertia_modal_referer, allow_other_host: allow_other_host, **options
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/inertia_rails_contrib/inertia_ui_modal/renderer.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module InertiaRailsContrib
+  module InertiaUIModal
+    class Renderer
+      KNOWN_KEYWORDS = %i[props view_data deep_merge encrypt_history clear_history].freeze
+
+      def initialize(component, controller, request, response, render_method, base_url: nil, **options)
+        @request = request
+        @response = response
+        @base_url = base_url
+        @inertia_renderer = InertiaRails::Renderer.new(component, controller, request, response, render_method, **options.slice(*KNOWN_KEYWORDS))
+      end
+
+      def render
+        if @request.headers[HEADER_USE_ROUTER] == "0" || base_url.blank?
+          return @inertia_renderer.render
+        end
+
+        page = @inertia_renderer.page
+        page[:baseUrl] = base_url
+        page[:meta] = {
+          deferredProps: page.delete(:deferredProps),
+          mergeProps: page.delete(:mergeProps)
+        }
+
+        @request.env[:_inertiaui_modal] = page
+
+        render_base_url
+      end
+
+      def base_url
+        @request.headers[HEADER_BASE_URL] || @base_url
+      end
+
+      def render_base_url
+        original_env = Rack::MockRequest.env_for(
+          base_url,
+          method: @request.method,
+          params: @request.params
+        )
+        @request.each_header do |k, v|
+          original_env[k] ||= v
+        end
+
+        original_request = ActionDispatch::Request.new(original_env)
+
+        path = ActionDispatch::Journey::Router::Utils.normalize_path(original_request.path_info)
+        Rails.application.routes.recognize_path_with_request(original_request, path, {})
+        controller = original_request.controller_class.new
+        controller.request = @request
+        controller.response = @response
+        controller.process(original_request.path_parameters[:action])
+      end
+    end
+  end
+end

data/lib/inertia_rails_contrib/inertia_ui_modal.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative "inertia_ui_modal/renderer"
+require_relative "inertia_ui_modal/redirect"
+require_relative "inertia_ui_modal/inertia_rails_patch"
+
+module InertiaRailsContrib
+  module InertiaUIModal
+    HEADER_BASE_URL = "X-InertiaUI-Modal-Base-Url"
+    HEADER_USE_ROUTER = "X-InertiaUI-Modal-Use-Router"
+  end
+end
+
+ActionController::Renderers.add :inertia_modal do |component, options|
+  InertiaRailsContrib::InertiaUIModal::Renderer.new(
+    component,
+    self,
+    request,
+    response,
+    method(:render),
+    **options
+  ).render
+end
+
+ActiveSupport.on_load(:action_controller_base) do
+  prepend ::InertiaRailsContrib::InertiaUIModal::Redirect
+end

data/lib/inertia_rails_contrib/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module InertiaRailsContrib
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/lib/inertia_rails_contrib.rb

@@ -1,8 +1,21 @@
 # frozen_string_literal: true
 
-require "inertia_rails" if defined?(Rails)
+if defined?(Rails)
+  require "inertia_rails"
+  require_relative "inertia_rails_contrib/engine"
+end
 
 require_relative "inertia_rails_contrib/version"
+require_relative "inertia_rails_contrib/configuration"
 
 module InertiaRailsContrib
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+  end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: inertia_rails-contrib
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Svyatoslav Kryukov
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-23 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: inertia_rails
@@ -36,6 +35,12 @@ files:
 - README.md
 - lib/inertia_rails-contrib.rb
 - lib/inertia_rails_contrib.rb
+- lib/inertia_rails_contrib/configuration.rb
+- lib/inertia_rails_contrib/engine.rb
+- lib/inertia_rails_contrib/inertia_ui_modal.rb
+- lib/inertia_rails_contrib/inertia_ui_modal/inertia_rails_patch.rb
+- lib/inertia_rails_contrib/inertia_ui_modal/redirect.rb
+- lib/inertia_rails_contrib/inertia_ui_modal/renderer.rb
 - lib/inertia_rails_contrib/version.rb
 homepage: https://github.com/skryukov/inertia_rails-contrib
 licenses:
@@ -47,7 +52,6 @@ metadata:
   homepage_uri: https://github.com/skryukov/inertia_rails-contrib
   source_code_uri: https://github.com/skryukov/inertia_rails-contrib
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -62,8 +66,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.23
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
 summary: A collection of extensions and developer tools for Rails Inertia adapter
 test_files: []