inertia_rails 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5626c22ecacdfaa9d46b04fe63027a941af3ee6f9e32716943072a547f12bb8f
-  data.tar.gz: 3ad0c5ef9d0f2943a70d76218b1d97dce7cef8079ee0ef0bcc7e337ffeef607c
+  metadata.gz: 27e7436cecef40102f1e1ca1971c75b182195e3291f55f94981ef8c87359d9d4
+  data.tar.gz: 50c9634e36e040732e9bf42e7770a3d759e4930513b4fb54d2761e905689bc24
 SHA512:
-  metadata.gz: 1e67ddf363fef24d94688cc0f9f51f46c62aec3265acab8a3e656923cc227b05e812c56d95e2fb5996c2acca909d99ed2af1863f17420ea6ec387695af14cf8c
-  data.tar.gz: b412652b57ae50161487667e34f1d35cf396bcfde11f2ac3fe8f574d0670374722c5ff1b31e3a83b5c11dc40687afd9945f45734f0e9549f512480bbf22fb801
+  metadata.gz: 2653faf355cc672ebe5faec59fffdfe928cddd8b045ba114d5e8fafe01e3c5eb74ed47ac63336e62e1080c5e616a1ce3ac68fa8475644a1caf9f70e0206ce327
+  data.tar.gz: f7ae1c4be29f75140a42a08cd31c8ca946b1b5bb39a681c8bd2b0c8db71c716bcf3368bc0f37b573ffe84906686d57b191ead1e1143de3d19bf4441bab06c09f

data/CHANGELOG.md

@@ -4,6 +4,19 @@ 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!

data/README.md

@@ -79,7 +79,7 @@ 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
@@ -101,6 +101,76 @@ 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.
@@ -119,7 +189,9 @@ inertia 'about' => 'AboutComponent'
 
 ### SSR
 
-Enable SSR via the config settings for `ssr_enabled` and `ssr_url`
+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
 
@@ -137,6 +209,8 @@ InertiaRails.configure do |config|
   # 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.

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

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
@@ -40,6 +42,10 @@ module InertiaRails
     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)
@@ -71,6 +77,7 @@ module InertiaRails
     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:)
+    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 || controller.inertia_view_assigns
+      @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
@@ -41,8 +42,8 @@ module InertiaRails
       @controller.send(:inertia_layout)
     end
 
-    def props
-      _props = ::InertiaRails.shared_data(@controller).merge(@props).select do |key, prop|
+    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
@@ -50,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,
       }
@@ -75,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 = "3.0.0"
+  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: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Brian Knoles
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-22 00:00:00.000000000 Z
+date: 2023-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -198,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:
@@ -214,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