inertia_rails 2.0.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e99464a3b4534b1ccb484be532f15a11cf6883a13ea3e25643e6546a6934cc9
-  data.tar.gz: da8e75d1927615db2b2421cffeec4b34ce4a01649756294be11520a910baeb54
+  metadata.gz: 27e7436cecef40102f1e1ca1971c75b182195e3291f55f94981ef8c87359d9d4
+  data.tar.gz: 50c9634e36e040732e9bf42e7770a3d759e4930513b4fb54d2761e905689bc24
 SHA512:
-  metadata.gz: da00b4ce0a9652fdc6b68988fcae4d6ad70caafd39574e6dd369e4e71f24c9a283323910aaeaef55fe17c50521d933bac3198e999806fd6629719795228ce5a6
-  data.tar.gz: '08b1a351fb8314ae370323dd9f374f59c507a4f8d9e9504e1bab8904d633bcfa4b9dc4f92c4ee2facd1d469deded86923067f315ca7b4cce184162d783151e21'
+  metadata.gz: 2653faf355cc672ebe5faec59fffdfe928cddd8b045ba114d5e8fafe01e3c5eb74ed47ac63336e62e1080c5e616a1ce3ac68fa8475644a1caf9f70e0206ce327
+  data.tar.gz: f7ae1c4be29f75140a42a08cd31c8ca946b1b5bb39a681c8bd2b0c8db71c716bcf3368bc0f37b573ffe84906686d57b191ead1e1143de3d19bf4441bab06c09f

data/CHANGELOG.md

@@ -4,6 +4,24 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [3.1.0] - 2023-08-21
+
+### Features
+
+* CSRF protection works without additional configuration now.
+* Optional deep merging of shared props.
+
+### Fixes
+
+* Document Inertia headers. @buhrmi
+* Documentation typo fix. @lujanfernaud
+* Changelog URI fix. @PedroAugustoRamalhoDuarte
+
+## [3.0.0] - 2022-09-22
+
+* Allow rails layout to set inertia layout. Thanks @ElMassimo!
+* Add the ability to set inertia props and components via rails conventions (see readme)
+
 ## [2.0.1] - 2022-07-12
 
 * Fix for a middleware issue where global state could be polluted if an exception occurs in a request. Thanks @ElMassimo!

data/README.md

@@ -14,7 +14,7 @@ gem 'inertia_rails'
 
 ### Frontend
 
-Rails 7 specific frontend docs coming soon. For now, check out the official Inertia docs at https://inertiajs.com/
+Rails 7 specific frontend docs coming soon. For now, check out the official Inertia docs at https://inertiajs.com/ or see an example using React/Vite [here](https://github.com/BrandonShar/inertia-rails-template)
 
 ## Usage
 
@@ -30,9 +30,56 @@ def index
 end
 ```
 
+#### Rails Component and Instance Props 
+
+Starting in version 3.0, Inertia Rails allows you to provide your component name and props via common rails conventions. 
+
+```ruby
+class EventsController < ApplicationController
+  use_inertia_instance_props
+
+  def index
+    @events = Event.all
+  end
+
+end
+```
+
+is the same as 
+
+
+```ruby
+class EventsController < ApplicationController
+  def index
+    render inertia: 'events/index', props: {
+      events: Event.all
+    }
+  end
+end
+```
+
+#### Instance Props and Default Render Notes 
+
+In order to use instance props, you must call `use_inertia_instance_props` on the controller (or a base controller it inherits from). If any props are provided manually, instance props
+are automatically disabled for that response. Instance props are only included if they are defined after the before filter is set from `use_inertia_instance_props`.
+
+Automatic component name is also opt in, you must set the `default_render` config value to `true`. Otherwise, you can simply `render inertia: true` for the same behavior explicitly. 
+
+### Layout 
+
+Inertia layouts use the rails layout convention and can be set or changed in the same way. The original `layout` config option is still functional, but will likely be deprecated in the future in favor
+of using rails layouts.
+
+```ruby
+class EventsController < ApplicationController
+  layout 'inertia_application'
+end
+```
+
+
 ### Shared Data
 
-If you have data that you want to be provided as a prop to every component (a common use-case is informationa about the authenticated user) you can use the `shared_data` controller method.
+If you have data that you want to be provided as a prop to every component (a common use-case is information about the authenticated user) you can use the `shared_data` controller method.
 
 ```ruby
 class EventsController < ApplicationController
@@ -54,6 +101,84 @@ class EventsController < ApplicationController
 end
 ```
 
+#### Deep Merging Shared Data
+
+By default, Inertia will shallow merge data defined in an action with the shared data. You might want a deep merge. Imagine using shared data to represent defaults you'll override sometimes.
+
+```ruby
+class ApplicationController
+  inertia_share do
+    { basketball_data: { points: 50, rebounds: 100 } }
+  end
+end
+```
+
+Let's say we want a particular action to change only part of that data structure. The renderer accepts a `deep_merge` option:
+
+```ruby
+class CrazyScorersController < ApplicationController
+  def index
+    render inertia: 'CrazyScorersComponent',
+    props: { basketball_data: { points: 100 } },
+    deep_merge: true
+  end
+end
+
+# The renderer will send this to the frontend:
+{
+  basketball_data: {
+    points: 100,
+    rebounds: 100,
+  }
+}
+```
+
+Deep merging can be set as the project wide default via the InertiaRails configuration:
+
+```ruby
+# config/initializers/some_initializer.rb
+InertiaRails.configure do |config|
+  config.deep_merge_shared_data = true
+end
+
+```
+
+If deep merging is enabled by default, it's possible to opt out within the action:
+
+```ruby
+class CrazyScorersController < ApplicationController
+  inertia_share do
+    {
+      basketball_data: {
+        points: 50,
+        rebounds: 10,
+      }
+    }
+  end
+
+  def index
+    render inertia: 'CrazyScorersComponent',
+    props: { basketball_data: { points: 100 } },
+    deep_merge: false
+  end
+end
+
+# Even if deep merging is set by default, since the renderer has `deep_merge: false`, it will send a shallow merge to the frontend:
+{
+  basketball_data: {
+    points: 100,
+  }
+}
+```
+
+### Lazy Props
+
+On the front end, Inertia supports the concept of "partial reloads" where only the props requested are returned by the server. Sometimes, you may want to use this flow to avoid processing a particularly slow prop on the intial load. In this case, you can use Lazy props. Lazy props aren't evaluated unless they're specifically requested by name in a partial reload.
+
+```ruby
+  inertia_share some_data: InertiaRails.lazy(lambda { some_very_slow_method })
+```
+
 ### Routing
 
 If you don't need a controller to handle a static component, you can route directly to a component with the inertia route helper
@@ -62,6 +187,12 @@ If you don't need a controller to handle a static component, you can route direc
 inertia 'about' => 'AboutComponent'
 ```
 
+### SSR
+
+Enable SSR via the config settings for `ssr_enabled` and `ssr_url`.
+
+When using SSR, don't forget to add `<%= inertia_headers %>` to the `<head>` of your `application.html.erb`.
+
 ## Configuration
 
 Inertia Rails has a few different configuration options that can be set anywhere, but the most common location is from within an initializer.
@@ -72,13 +203,14 @@ InertiaRails.configure do |config|
   
   # set the current version for automatic asset refreshing. A string value should be used if any.
   config.version = nil
+  # enable default inertia rendering (warning! this will override rails default rendering behavior)
+  config.default_render = true
   
-  # set the layout you want inertia components to be rendered within. This layout must include any required inertia javascript.
-  config.layout = 'application'
-
   # ssr specific options
   config.ssr_enabled = false
   config.ssr_url = 'http://localhost:13714'
+
+  config.deep_merge_shared_data = false
   
 end
 ```

data/inertia_rails.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
-  spec.metadata["changelog_uri"] = "#{spec.homepage}/CHANGELOG.md"
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/master/CHANGELOG.md"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -34,4 +34,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "sqlite3"
   spec.add_development_dependency "appraisal"
   spec.add_development_dependency "responders"
+  spec.add_development_dependency "debug"
 end

data/lib/generators/inertia_rails/install/react/inertia.jsx

@@ -1,16 +1,12 @@
 import { App } from '@inertiajs/inertia-react';
 import React from 'react';
 import { render } from 'react-dom';
-import axios from 'axios';
 import { InertiaProgress } from '@inertiajs/progress';
 
 document.addEventListener('DOMContentLoaded', () => {
   InertiaProgress.init();
   const el = document.getElementById('app')
 
-  const csrfToken = document.querySelector('meta[name=csrf-token]').content;
-  axios.defaults.headers.common['X-CSRF-Token'] = csrfToken;
-
   render(
     <App
       initialPage={JSON.parse(el.dataset.page)}
@@ -18,4 +14,4 @@ document.addEventListener('DOMContentLoaded', () => {
     />,
     el
   )
-});
+});

data/lib/generators/inertia_rails/install/svelte/inertia.js

@@ -1,12 +1,7 @@
-import axios from 'axios'
-
 import { createInertiaApp } from '@inertiajs/inertia-svelte'
 import { InertiaProgress } from '@inertiajs/progress'
 
 document.addEventListener('DOMContentLoaded', () => {
-  const csrfToken = document.querySelector('meta[name=csrf-token]').content
-  axios.defaults.headers.common['X-CSRF-Token'] = csrfToken
-
   InertiaProgress.init()
 
   createInertiaApp({
@@ -16,4 +11,4 @@ document.addEventListener('DOMContentLoaded', () => {
       new App({ target: el, props })
     },
   })
-})
+})

data/lib/generators/inertia_rails/install/vue/inertia.js

@@ -1,13 +1,9 @@
-import axios from 'axios'
 import Vue from 'vue'
 
 import { app, plugin } from '@inertiajs/inertia-vue'
 import { InertiaProgress } from '@inertiajs/progress'
 
 document.addEventListener('DOMContentLoaded', () => {
-  const csrfToken = document.querySelector('meta[name=csrf-token]').content
-  axios.defaults.headers.common['X-CSRF-Token'] = csrfToken
-
   InertiaProgress.init();
   const el = document.getElementById('app')
 

data/lib/inertia_rails/controller.rb

@@ -11,6 +11,10 @@ module InertiaRails
         InertiaRails.share(errors: session[:inertia_errors]) if session[:inertia_errors].present?
       end
       helper ::InertiaRails::Helper
+
+      after_action do
+        cookies['XSRF-TOKEN'] = form_authenticity_token unless request.inertia? || !protect_against_forgery?
+      end
     end
 
     module ClassMethods
@@ -20,6 +24,21 @@ module InertiaRails
           InertiaRails.share_block(block) if block
         end
       end
+
+      def use_inertia_instance_props
+        before_action do
+          @_inertia_instance_props = true
+          @_inertia_skip_props = view_assigns.keys + ['_inertia_skip_props']
+        end
+      end
+    end
+
+    def default_render
+      if InertiaRails.default_render?
+        render(inertia: true)
+      else
+        super
+      end
     end
 
     def redirect_to(options = {}, response_options = {})
@@ -36,8 +55,21 @@ module InertiaRails
       )
     end
 
+    def inertia_view_assigns
+      return {} unless @_inertia_instance_props
+      view_assigns.except(*@_inertia_skip_props)
+    end
+
     private
 
+    def inertia_layout
+      layout = ::InertiaRails.layout
+
+      # When the global configuration is not set, let Rails decide which layout
+      # should be used based on the controller configuration.
+      layout.nil? ? true : layout
+    end
+
     def inertia_location(url)
       headers['X-Inertia-Location'] = url
       head :conflict

data/lib/inertia_rails/inertia_rails.rb

@@ -13,7 +13,9 @@ module InertiaRails
 
   # "Getters"
   def self.shared_data(controller)
-    shared_plain_data.merge!(evaluated_blocks(controller, shared_blocks))
+    shared_plain_data.
+      merge!(evaluated_blocks(controller, shared_blocks)).
+      with_indifferent_access
   end
 
   def self.version
@@ -32,10 +34,18 @@ module InertiaRails
     Configuration.ssr_url
   end
 
+  def self.default_render?
+    Configuration.default_render
+  end 
+
   def self.html_headers
     self.threadsafe_html_headers || []
   end
 
+  def self.deep_merge_shared_data?
+    Configuration.deep_merge_shared_data
+  end
+
   # "Setters"
   def self.share(**args)
     self.shared_plain_data = self.shared_plain_data.merge(args)
@@ -62,10 +72,12 @@ module InertiaRails
   private
 
   module Configuration
-    mattr_accessor(:layout) { 'application' }
+    mattr_accessor(:layout) { nil }
     mattr_accessor(:version) { nil }
     mattr_accessor(:ssr_enabled) { false }
     mattr_accessor(:ssr_url) { 'http://localhost:13714' }
+    mattr_accessor(:default_render) { false }
+    mattr_accessor(:deep_merge_shared_data) { false }
 
     def self.evaluated_version
       self.version.respond_to?(:call) ? self.version.call : self.version

data/lib/inertia_rails/middleware.rb

@@ -18,6 +18,7 @@ module InertiaRails
       end
 
       def response
+        copy_xsrf_to_csrf!
         status, headers, body = @app.call(@env)
         request = ActionDispatch::Request.new(@env)
 
@@ -89,6 +90,10 @@ module InertiaRails
         request.flash.keep
         Rack::Response.new('', 409, {'X-Inertia-Location' => request.original_url}).finish
       end
+
+      def copy_xsrf_to_csrf!
+        @env['HTTP_X_CSRF_TOKEN'] = @env['HTTP_X_XSRF_TOKEN'] if @env['HTTP_X_XSRF_TOKEN'] && inertia_request?
+      end
     end
   end
 end

data/lib/inertia_rails/renderer.rb

@@ -6,14 +6,15 @@ module InertiaRails
   class Renderer
     attr_reader :component, :view_data
 
-    def initialize(component, controller, request, response, render_method, props:, view_data:)
-      @component = component
+    def initialize(component, controller, request, response, render_method, props: nil, view_data: nil, deep_merge: nil)
+      @component = component.is_a?(TrueClass) ? "#{controller.controller_path}/#{controller.action_name}" : component
       @controller = controller
       @request = request
       @response = response
       @render_method = render_method
-      @props = props || {}
+      @props = props ? props.with_indifferent_access : controller.inertia_view_assigns.with_indifferent_access
       @view_data = view_data || {}
+      @deep_merge = !deep_merge.nil? ? deep_merge : InertiaRails.deep_merge_shared_data?
     end
 
     def render
@@ -23,7 +24,7 @@ module InertiaRails
         @render_method.call json: page, status: @response.status, content_type: Mime[:json]
       else
         return render_ssr if ::InertiaRails.ssr_enabled? rescue nil
-        @render_method.call template: 'inertia', layout: ::InertiaRails.layout, locals: (view_data).merge({page: page})
+        @render_method.call template: 'inertia', layout: layout, locals: (view_data).merge({page: page})
       end
     end
 
@@ -34,11 +35,15 @@ module InertiaRails
       res = JSON.parse(Net::HTTP.post(uri, page.to_json, 'Content-Type' => 'application/json').body)
       
       ::InertiaRails.html_headers = res['head']
-      @render_method.call html: res['body'].html_safe, layout: ::InertiaRails.layout, locals: (view_data).merge({page: page})
+      @render_method.call html: res['body'].html_safe, layout: layout, locals: (view_data).merge({page: page})
     end
 
-    def props
-      _props = ::InertiaRails.shared_data(@controller).merge(@props).select do |key, prop|
+    def layout
+      @controller.send(:inertia_layout)
+    end
+
+    def computed_props
+      _props = ::InertiaRails.shared_data(@controller).send(prop_merge_method, @props).select do |key, prop|
         if rendering_partial_component?
           key.in? partial_keys
         else
@@ -46,13 +51,13 @@ module InertiaRails
         end
       end
 
-      deep_transform_values(_props, lambda {|prop| prop.respond_to?(:call) ? @controller.instance_exec(&prop) : prop })
+      deep_transform_values(_props, lambda {|prop| prop.respond_to?(:call) ? @controller.instance_exec(&prop) : prop }).with_indifferent_access
     end
 
     def page
       {
         component: component,
-        props: props,
+        props: computed_props,
         url: @request.original_fullpath,
         version: ::InertiaRails.version,
       }
@@ -71,5 +76,9 @@ module InertiaRails
     def rendering_partial_component?
       @request.inertia_partial? && @request.headers['X-Inertia-Partial-Component'] == component
     end
+
+    def prop_merge_method
+      @deep_merge ? :deep_merge : :merge
+    end
   end
 end

data/lib/inertia_rails/rspec.rb

@@ -74,7 +74,7 @@ end
 
 RSpec::Matchers.define :have_exact_props do |expected_props|
   match do |inertia|
-    expect(inertia.props).to eq expected_props
+    expect(inertia.props).to eq expected_props.with_indifferent_access
   end
 
   failure_message do |inertia|
@@ -84,7 +84,7 @@ end
 
 RSpec::Matchers.define :include_props do |expected_props|
   match do |inertia|
-      expect(inertia.props).to include expected_props
+    expect(inertia.props).to include expected_props.with_indifferent_access
   end
 
   failure_message do |inertia|

data/lib/inertia_rails/version.rb

@@ -1,3 +1,3 @@
 module InertiaRails
-  VERSION = "2.0.1"
+  VERSION = "3.1.0"
 end

data/lib/inertia_rails.rb

@@ -15,6 +15,7 @@ ActionController::Renderers.add :inertia do |component, options|
     method(:render),
     props: options[:props],
     view_data: options[:view_data],
+    deep_merge: options[:deep_merge],
   ).render
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: inertia_rails
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 3.1.0
 platform: ruby
 authors:
 - Brian Knoles
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-12 00:00:00.000000000 Z
+date: 2023-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -124,6 +124,20 @@ dependencies:
     - - ">="
       - !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
@@ -184,7 +198,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/inertiajs/inertia-rails
   source_code_uri: https://github.com/inertiajs/inertia-rails
-  changelog_uri: https://github.com/inertiajs/inertia-rails/CHANGELOG.md
+  changelog_uri: https://github.com/inertiajs/inertia-rails/blob/master/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -200,7 +214,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Inertia adapter for Rails