inertia_rails 1.11.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60a2f2a20da36323f792051d3a0c1327b3f085f78e8fed5906064e8892c516d9
-  data.tar.gz: c9a40fd17509def36b88862a671f98a4ed839f158ffd0959a66aba3023ee6084
+  metadata.gz: ac66be3f6a11b3caa5d6fec8057f75e4be257e154b3ce77f3f2c7b8ddb38d4bc
+  data.tar.gz: cd9891492a338447f41f10016656c369d8870dd71eacd55ce8d4c6be92f08464
 SHA512:
-  metadata.gz: c136e534632a852b4d92ec7303cb5eba67fed88706cf28cc16e8bc541fda5320f9f09aa3e92f481951fe93390e30714813f0950bd67b75389b933634721d8dd5
-  data.tar.gz: b6f8568840f971249c90142afd6b20adf39b4d99a4864d952ddbedcbfdfb49884a6e35f9c419fd180d7abf50590bee70863f3766b94e6883a171b8995cef5f9e
+  metadata.gz: '09beccfde8d305ae45d9afa84d9ace59337e7ae6521984f3047c10723c2ff70dcf01fe66667e51b4ab3bdd52c6d09a915d9edaace24d5aab83db571aa60fca10'
+  data.tar.gz: 7f25e813e9bec9bd513f2608bd5892728a504b76b2cab5fb43d2067af78411a12fe02baab6f0dded2591fb095536d6dda5ee7f65d6c4691c1affdce767458c80

data/.github/workflows/push.yml

@@ -8,7 +8,10 @@ jobs:
       fail-fast: false
       matrix:
         ruby: [2.6, 2.7]
-        rails: ['5.0', '5.1', '5.2', '6.0', '6.1']
+        rails: ['5.1', '5.2', '6.0', '6.1', '7.0']
+        exclude:
+          - rails: '7.0'
+            ruby: 2.6
 
     runs-on: ubuntu-latest
     name: Test against Ruby ${{ matrix.ruby }} / Rails ${{ matrix.rails }}

data/Appraisals

@@ -1,3 +1,7 @@
+appraise "rails-7.0" do
+  gem "rails", "~> 7.0"
+end
+
 appraise "rails-6.1" do
   gem "rails", "~> 6.1.0"
 end
@@ -13,7 +17,3 @@ end
 appraise "rails-5.1" do
   gem "rails", "~> 5.1.7"
 end
-
-appraise "rails-5.0" do
-  gem "rails", "~> 5.0.7", '>= 5.0.7.2'
-end

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).
 
+## [2.0.0] - 2022-06-20
+
+* Fix an issue with Rails 7.0. Thanks @0xDing and @aviemet!
+* Drop support for Rails 5.0 (and mentally, though not literally drop support for Rails < 6)
+
+## [1.12.1] - 2022-05-09
+
+* Allow inertia to take over after initial pageload when using ssr. Thanks @99monkey!
+
+## [1.12.0] - 2022-05-04
+
+* SSR!
+
 ## [1.11.1] - 2021-06-27
 
 * Fixed thread safety in the middleware. Thanks @caifara!

data/README.md

@@ -3,7 +3,136 @@
 
 # Inertia.js Rails Adapter
 
-Visit [inertiajs.com](https://inertiajs.com/) for installation instructions, documentation, and to learn more.
+## Installation
+
+### Backend
+
+Just add the inertia rails gem to your Gemfile
+```ruby
+gem 'inertia_rails'
+```
+
+### Frontend
+
+Rails 7 specific frontend docs coming soon. For now, check out the official Inertia docs at https://inertiajs.com/
+
+## Usage
+
+### Responses
+
+Render Inertia responses is simple, just use the inertia renderer in your controller methods. The renderer accepts two arguments, the first is the name of the component you want to render from within your pages directory (without extension). The second argument is an options hash where you can provide `props` to your components. This options hash also allows you to pass `view_data` to your layout, but this is much less common.
+
+```ruby
+def index
+  render inertia: 'Event/Index', props: {
+    events: Event.all,
+  }
+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.
+
+```ruby
+class EventsController < ApplicationController
+  # share syncronously
+  inertia_share app_name: env['app.name']
+  
+  # share lazily, evaluated at render time
+  inertia_share do
+    if logged_in?
+      {
+        user: logged_in_user,
+      }
+    end
+  end
+  
+  # share lazily alternate syntax
+  inertia_share user_count: lambda { User.count }
+  
+end
+```
+
+### 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
+
+```ruby
+inertia 'about' => 'AboutComponent'
+```
+
+## Configuration
+
+Inertia Rails has a few different configuration options that can be set anywhere, but the most common location is from within an initializer.
+
+The default config is shown below
+```ruby
+InertiaRails.configure do |config|
+  
+  # set the current version for automatic asset refreshing. A string value should be used if any.
+  config.version = nil
+  
+  # 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'
+  
+end
+```
+
+## Testing
+
+If you're using Rspec, Inertia Rails comes with some nice test helpers to make things simple. 
+
+To use these helpers, just add the following require statement to your `spec/rails_helper.rb`
+
+```ruby
+require 'inertia_rails/rspec'
+```
+
+And in any test you want to use the inertia helpers, add the inertia flag to the describe block
+
+```ruby
+RSpec.describe EventController, type: :request do
+  describe '#index', inertia: true do
+    # ...
+  end
+end
+```
+
+### Assertions
+
+```ruby
+RSpec.describe EventController, type: :request do
+  describe '#index', inertia: true do
+    
+    # check the component
+    expect_inertia.to render_component 'Event/Index'
+    
+    # access the component name
+    expect(inertia.component).to eq 'TestComponent'
+    
+    # props (including shared props)
+    expect_inertia.to have_exact_props({name: 'Brandon', sport: 'hockey'})
+    expect_inertia.to include_props({sport: 'hockey'})
+    
+    # access props
+    expect(inertia.props[:name]).to eq 'Brandon'
+    
+    # view data
+    expect_inertia.to have_exact_view_data({name: 'Brian', sport: 'basketball'})
+    expect_inertia.to include_view_data({sport: 'basketball'})
+    
+    # access view data 
+    expect(inertia.view_data[:name]).to eq 'Brian'
+    
+  end
+end
+
+```
 
 *Maintained and sponsored by the team at [bellaWatt](https://bellawatt.com/)*
 

data/gemfiles/{rails_5.0.gemfile → rails_7.0.gemfile}

@@ -2,6 +2,6 @@
 
 source "https://rubygems.org"
 
-gem "rails", "~> 5.0.7", ">= 5.0.7.2"
+gem "rails", "~> 7.0"
 
 gemspec path: "../"

data/lib/generators/inertia_rails/install/svelte/InertiaExample.svelte

@@ -0,0 +1,11 @@
+<script>
+  export let name;
+</script>
+
+<style>
+  h1 { font-family: sans-serif; text-align: center; }
+</style>
+
+<h1>
+  Hello {name}!
+</h1>

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

@@ -0,0 +1,19 @@
+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({
+    id: 'app',
+    resolve: name => import(`../Pages/${name}.svelte`),
+    setup({ el, App, props }) {
+      new App({ target: el, props })
+    },
+  })
+})

data/lib/generators/inertia_rails/install_generator.rb

@@ -6,6 +6,7 @@ module InertiaRails
     FRONT_END_INSTALLERS = [
       'react',
       'vue',
+      'svelte',
     ]
 
     def install
@@ -70,5 +71,14 @@ module InertiaRails
       template "vue/inertia.js", Rails.root.join("app/javascript/packs/inertia.js").to_s
       say "done!", :green
     end
+
+    def install_svelte!
+      say "Creating a Svelte page component...", :blue
+      run 'yarn add @inertiajs/inertia-svelte'
+      template "svelte/InertiaExample.svelte", Rails.root.join("app/javascript/Pages/InertiaExample.svelte").to_s
+      say "Copying inertia.js into webpacker's packs folder...", :blue
+      template "svelte/inertia.js", Rails.root.join("app/javascript/packs/inertia.js").to_s
+      say "done!", :green
+    end
   end
 end

data/lib/inertia_rails/controller.rb

@@ -1,4 +1,5 @@
 require_relative "inertia_rails"
+require_relative "helper"
 
 module InertiaRails
   module Controller
@@ -9,6 +10,7 @@ module InertiaRails
         # :inertia_errors are deleted from the session by the middleware
         InertiaRails.share(errors: session[:inertia_errors]) if session[:inertia_errors].present?
       end
+      helper ::InertiaRails::Helper
     end
 
     module ClassMethods

data/lib/inertia_rails/engine.rb

@@ -8,7 +8,7 @@ module InertiaRails
     end
 
     initializer "inertia_rails.action_controller" do
-      ActiveSupport.on_load(:action_controller) do
+      ActiveSupport.on_load(:action_controller_base) do
         include ::InertiaRails::Controller
       end
     end

data/lib/inertia_rails/helper.rb

@@ -0,0 +1,7 @@
+require_relative 'inertia_rails'
+
+module InertiaRails::Helper
+  def inertia_headers
+    ::InertiaRails.html_headers.join.html_safe
+  end
+end

data/lib/inertia_rails/inertia_rails.rb

@@ -5,6 +5,7 @@ require 'inertia_rails/lazy'
 module InertiaRails
   thread_mattr_accessor :threadsafe_shared_plain_data
   thread_mattr_accessor :threadsafe_shared_blocks
+  thread_mattr_accessor :threadsafe_html_headers
 
   def self.configure
     yield(Configuration)
@@ -23,6 +24,18 @@ module InertiaRails
     Configuration.layout
   end
 
+  def self.ssr_enabled?
+    Configuration.ssr_enabled
+  end
+
+  def self.ssr_url
+    Configuration.ssr_url
+  end
+
+  def self.html_headers
+    self.threadsafe_html_headers || []
+  end
+
   # "Setters"
   def self.share(**args)
     self.shared_plain_data = self.shared_plain_data.merge(args)
@@ -32,9 +45,14 @@ module InertiaRails
     self.shared_blocks = self.shared_blocks + [block]
   end
 
+  def self.html_headers=(headers)
+    self.threadsafe_html_headers = headers
+  end
+
   def self.reset!
     self.shared_plain_data = {}
     self.shared_blocks = []
+    self.html_headers = []
   end
 
   def self.lazy(value = nil, &block)
@@ -46,6 +64,8 @@ module InertiaRails
   module Configuration
     mattr_accessor(:layout) { 'application' }
     mattr_accessor(:version) { nil }
+    mattr_accessor(:ssr_enabled) { false }
+    mattr_accessor(:ssr_url) { 'http://localhost:13714' }
 
     def self.evaluated_version
       self.version.respond_to?(:call) ? self.version.call : self.version

data/lib/inertia_rails/renderer.rb

@@ -1,3 +1,5 @@
+require 'net/http'
+require 'json'
 require_relative "inertia_rails"
 
 module InertiaRails
@@ -20,12 +22,21 @@ module InertiaRails
         @response.set_header('X-Inertia', 'true')
         @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})
       end
     end
 
     private
 
+    def render_ssr
+      uri = URI("#{::InertiaRails.ssr_url}/render")
+      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})
+    end
+
     def props
       _props = ::InertiaRails.shared_data(@controller).merge(@props).select do |key, prop|
         if rendering_partial_component?

data/lib/inertia_rails/version.rb

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

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: inertia_rails
 version: !ruby/object:Gem::Version
-  version: 1.11.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Brian Knoles
 - Brandon Shar
 - Eugene Granovsky
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-06-27 00:00:00.000000000 Z
+date: 2022-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -124,7 +124,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - brain@bellawatt.com
 - brandon@bellawatt.com
@@ -147,21 +147,24 @@ files:
 - app/views/inertia.html.erb
 - bin/console
 - bin/setup
-- gemfiles/rails_5.0.gemfile
 - gemfiles/rails_5.1.gemfile
 - gemfiles/rails_5.2.gemfile
 - gemfiles/rails_6.0.gemfile
 - gemfiles/rails_6.1.gemfile
+- gemfiles/rails_7.0.gemfile
 - inertia_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/helper.rb
 - lib/inertia_rails/inertia_rails.rb
 - lib/inertia_rails/lazy.rb
 - lib/inertia_rails/middleware.rb
@@ -182,7 +185,7 @@ 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
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -197,8 +200,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: Inertia adapter for Rails
 test_files: []