inertiax_rails 2.0.0

data/lib/inertia_rails/rspec.rb

@@ -0,0 +1,125 @@
+require "rspec/core"
+require "rspec/matchers"
+
+module InertiaRails
+  module RSpec
+    class InertiaRenderWrapper
+      attr_reader :view_data, :props, :component
+    
+      def initialize
+        @view_data = nil
+        @props = nil
+        @component = nil
+      end
+    
+      def call(params)
+        set_values(params)
+        @render_method&.call(params)
+      end
+    
+      def wrap_render(render_method)
+        @render_method = render_method
+        self
+      end
+    
+      protected
+    
+      def set_values(params)
+        @view_data = params[:locals].except(:page)
+        @props = params[:locals][:page][:props]
+        @component = params[:locals][:page][:component]
+      end
+    end
+
+    module Helpers
+      def inertia
+        raise 'Inertia test helpers aren\'t set up! Make sure you add inertia: true to describe blocks using inertia tests.' unless inertia_tests_setup?
+
+        if @_inertia_render_wrapper.nil? && !::RSpec.configuration.inertia[:skip_missing_renderer_warnings]
+          warn 'WARNING: the test never created an Inertia renderer. Maybe the code wasn\'t able to reach a `render inertia:` call? If this was intended, or you don\'t want to see this message, set ::RSpec.configuration.inertia[:skip_missing_renderer_warnings] = true'
+        end
+        @_inertia_render_wrapper
+      end
+
+      def expect_inertia
+        expect(inertia)
+      end
+
+      def inertia_wrap_render(render)
+        @_inertia_render_wrapper = InertiaRenderWrapper.new.wrap_render(render)
+      end
+
+      protected 
+      
+      def inertia_tests_setup?
+        ::RSpec.current_example.metadata.fetch(:inertia, false)
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include ::InertiaRails::RSpec::Helpers
+  config.add_setting :inertia, default: {
+    skip_missing_renderer_warnings: false
+  }
+
+  config.before(:each, inertia: true) do
+    new_renderer = InertiaRails::Renderer.method(:new)
+    allow(InertiaRails::Renderer).to receive(:new) do |component, controller, request, response, render, named_args|
+      new_renderer.call(component, controller, request, response, inertia_wrap_render(render), **named_args)
+    end
+  end
+end
+
+RSpec::Matchers.define :have_exact_props do |expected_props|
+  match do |inertia|
+  # Computed props have symbolized keys. 
+    expect(inertia.props).to eq expected_props.deep_symbolize_keys
+  end
+
+  failure_message do |inertia|
+    "expected inertia props to receive #{expected_props}, instead received #{inertia.props || 'nothing'}"
+  end
+end
+
+RSpec::Matchers.define :include_props do |expected_props|
+  match do |inertia|
+  # Computed props have symbolized keys. 
+    expect(inertia.props).to include expected_props.deep_symbolize_keys
+  end
+
+  failure_message do |inertia|
+    "expected inertia props to include #{expected_props}, instead received #{inertia.props || 'nothing'}"
+  end
+end
+
+RSpec::Matchers.define :render_component do |expected_component|
+  match do |inertia|
+    expect(inertia.component).to eq expected_component
+  end
+
+  failure_message do |inertia|
+    "expected rendered inertia component to be #{expected_component}, instead received #{inertia.component || 'nothing'}"
+  end
+end
+
+RSpec::Matchers.define :have_exact_view_data do |expected_view_data|
+  match do |inertia|
+    expect(inertia.view_data).to eq expected_view_data    
+  end
+
+  failure_message do |inertia|
+    "expected inertia view data to receive #{expected_view_data}, instead received #{inertia.view_data || 'nothing'}"
+  end
+end
+
+RSpec::Matchers.define :include_view_data do |expected_view_data|
+  match do |inertia|
+    expect(inertia.view_data).to include expected_view_data
+  end
+
+  failure_message do |inertia|
+    "expected inertia view data to include #{expected_view_data}, instead received #{inertia.view_data || 'nothing'}"
+  end
+end

data/lib/inertia_rails/version.rb

@@ -0,0 +1,3 @@
+module InertiaRails
+  VERSION = "2.0.0"
+end

data/lib/inertia_rails.rb

@@ -0,0 +1,24 @@
+require 'inertia_rails/renderer'
+require 'inertia_rails/engine'
+
+require 'patches/debug_exceptions'
+require 'patches/better_errors'
+require 'patches/request'
+require 'patches/mapper'
+
+ActionController::Renderers.add :inertia do |component, options|
+  InertiaRails::Renderer.new(
+    component,
+    self,
+    request,
+    response,
+    method(:render),
+    props: options[:props],
+    view_data: options[:view_data],
+    deep_merge: options[:deep_merge],
+  ).render
+end
+
+module InertiaRails
+  class Error < StandardError; end
+end

data/lib/patches/better_errors.rb

@@ -0,0 +1,17 @@
+# Patch BetterErrors::Middleware to render HTML for Inertia requests
+#
+# Original source:
+# https://github.com/BetterErrors/better_errors/blob/v2.5.1/lib/better_errors/middleware.rb
+#
+
+if defined?(BetterErrors)
+  BetterErrors::Middleware.class_eval do
+    prepend(InertiaBetterErrors = Module.new do
+      def text?(env)
+        return false if env["HTTP_X_INERTIA"]
+
+        super
+      end
+    end)
+  end
+end

data/lib/patches/debug_exceptions/patch-5-0.rb

@@ -0,0 +1,23 @@
+# Patch ActionDispatch::DebugExceptions to render HTML for Inertia requests
+#
+# Original source:
+# https://github.com/rails/rails/blob/5-0-stable/actionpack/lib/action_dispatch/middleware/debug_exceptions.rb
+#
+
+ActionDispatch::DebugExceptions.class_eval do
+  prepend(InertiaDebugExceptions = Module.new do
+    def render_for_default_application(request, wrapper)
+      template = create_template(request, wrapper)
+      file = "rescues/#{wrapper.rescue_template}"
+
+      if request.xhr? && !request.headers['X-Inertia'] # <<<< this line is changed only
+        body = template.render(template: file, layout: false, formats: [:text])
+        format = "text/plain"
+      else
+        body = template.render(template: file, layout: 'rescues/layout')
+        format = "text/html"
+      end
+      render(wrapper.status_code, body, format)
+    end
+  end)
+end

data/lib/patches/debug_exceptions/patch-5-1.rb

@@ -0,0 +1,26 @@
+# Patch ActionDispatch::DebugExceptions to render HTML for Inertia requests
+#
+# Original source (unchanged since Rails 5.1):
+# https://github.com/rails/rails/blob/5-1-stable/actionpack/lib/action_dispatch/middleware/debug_exceptions.rb
+# https://github.com/rails/rails/blob/5-2-stable/actionpack/lib/action_dispatch/middleware/debug_exceptions.rb
+# https://github.com/rails/rails/blob/6-0-stable/actionpack/lib/action_dispatch/middleware/debug_exceptions.rb
+#
+
+ActionDispatch::DebugExceptions.class_eval do
+  prepend(InertiaDebugExceptions = Module.new do
+    def render_for_browser_request(request, wrapper)
+      template = create_template(request, wrapper)
+      file = "rescues/#{wrapper.rescue_template}"
+
+      if request.xhr? && !request.headers['X-Inertia'] # <<<< this line is changed only
+        body = template.render(template: file, layout: false, formats: [:text])
+        format = "text/plain"
+      else
+        body = template.render(template: file, layout: "rescues/layout")
+        format = "text/html"
+      end
+
+      render(wrapper.status_code, body, format)
+    end
+  end)
+end

data/lib/patches/debug_exceptions.rb

@@ -0,0 +1,17 @@
+# Patch ActionDispatch::DebugExceptions to render HTML for Inertia requests
+#
+# Rails has introduced text rendering for XHR requests with Rails 4.1 and
+# changed the implementation in 4.2, 5.0 and 5.1 (unchanged since then).
+#
+# The original source needs to be patched, so that Inertia requests are
+# NOT responded with plain text, but with HTML.
+
+if defined?(ActionDispatch::DebugExceptions)
+  if ActionPack.version.to_s >= '5.1'
+    require 'patches/debug_exceptions/patch-5-1'
+  elsif ActionPack.version.to_s >= '5.0'
+    require 'patches/debug_exceptions/patch-5-0'
+  else
+    # This gem supports Rails 5 or later
+  end
+end

data/lib/patches/mapper.rb

@@ -0,0 +1,8 @@
+ActionDispatch::Routing::Mapper.class_eval do
+  def inertia(args, &block)
+    route = args.keys.first
+    component = args.values.first
+
+    get(route => 'inertia_rails/static#static', defaults: {component: component})
+  end
+end

data/lib/patches/request.rb

@@ -0,0 +1,9 @@
+ActionDispatch::Request.class_eval do
+  def inertia?
+    key? 'HTTP_X_INERTIA'
+  end
+
+  def inertia_partial?
+    key? 'HTTP_X_INERTIA_PARTIAL_DATA'
+  end
+end

data/lib/tasks/inertia_rails.rake

@@ -0,0 +1,16 @@
+namespace :inertia_rails do
+  namespace :install do
+    desc "Installs inertia_rails packages and configurations for a React based app"
+    task :react => :environment do
+      system 'rails g inertia_rails:install --front_end react'
+    end
+    desc "Installs inertia_rails packages and configurations for a Vue based app"
+    task vue: :environment do
+      system 'rails g inertia_rails:install --front_end vue'
+    end
+    desc "Installs inertia_rails packages and configurations for a Svelte based app"
+    task svelte: :environment do
+      system 'rails g inertia_rails:install --front_end svelte'
+    end
+  end
+end

metadata

@@ -0,0 +1,203 @@
+--- !ruby/object:Gem::Specification
+name: inertiax_rails
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Brian Knoles
+- Brandon Shar
+- Eugene Granovsky
+- Stefan Buhrmester
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-07-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rails-controller-testing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: responders
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: debug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- brain@bellawatt.com
+- brandon@bellawatt.com
+- eugene@bellawatt.com
+- stefan@buhrmi.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/push.yml"
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/controllers/inertia_rails/static_controller.rb
+- app/views/inertia.html.erb
+- app/views/inertia_ssr.html.erb
+- bin/console
+- bin/setup
+- inertiax_rails.gemspec
+- lib/generators/inertia_rails/install/controller.rb
+- lib/generators/inertia_rails/install/react/InertiaExample.jsx
+- lib/generators/inertia_rails/install/react/inertia.jsx
+- lib/generators/inertia_rails/install/svelte/InertiaExample.svelte
+- lib/generators/inertia_rails/install/svelte/inertia.js
+- lib/generators/inertia_rails/install/vue/InertiaExample.vue
+- lib/generators/inertia_rails/install/vue/inertia.js
+- lib/generators/inertia_rails/install_generator.rb
+- lib/inertia_rails.rb
+- lib/inertia_rails/controller.rb
+- lib/inertia_rails/engine.rb
+- lib/inertia_rails/inertia_rails.rb
+- lib/inertia_rails/lazy.rb
+- lib/inertia_rails/middleware.rb
+- lib/inertia_rails/renderer.rb
+- lib/inertia_rails/rspec.rb
+- lib/inertia_rails/version.rb
+- lib/patches/better_errors.rb
+- lib/patches/debug_exceptions.rb
+- lib/patches/debug_exceptions/patch-5-0.rb
+- lib/patches/debug_exceptions/patch-5-1.rb
+- lib/patches/mapper.rb
+- lib/patches/request.rb
+- lib/tasks/inertia_rails.rake
+homepage: https://github.com/buhrmi/inertia-rails
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/buhrmi/inertia-rails
+  source_code_uri: https://github.com/buhrmi/inertia-rails
+  changelog_uri: https://github.com/buhrmi/inertia-rails/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: Inertia adapter for Rails
+test_files: []