inertia_rails 1.10.0 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c76eba9ada41f6b781b030f81b43bb87169034594127e106ec4dbee472926e8e
-  data.tar.gz: e9ed9115c9d6a678bdefdeeeafbeb1790c9a28f37521d71c699d5ca40989cd86
+  metadata.gz: 468c8c88d85da84a010be47c474e9d8d1ed4735d5d83cd8058038401e322334c
+  data.tar.gz: ce4ccdf41063f88495e8829dbefc4eb92936850d9f4da8a4f51e907eff9f90f4
 SHA512:
-  metadata.gz: 5d0285ccf5284c9fb4d267d25dfc899d58be5f57b2166fc42251246398483aaf639c8dbec94181a1a5978c020ea2fb796872248dd3de7c14db165b8ab20755cb
-  data.tar.gz: c06d57bec2e2c4fa55b15428055684999af1d65ee226f42263cb945d17ce4f06029bc8365b2a9f52b59db924b251f34944dd96998a7933b64fe18c6e80ae3117
+  metadata.gz: 6a097f6f871a2b7b294e5e497d051c8d677230f8a600e4a602a73b742e76bce34686b7b76d3287bb2d5af897a3254a6d368b03a672c0830779b7753f9284a0f0
+  data.tar.gz: caa62abc7dab0b7abe669b3735a4381e7ee1af3b705983b386059c4a0938a9df6a26f274f85169dbdf55a76bb4a06383e6930e22464035ef29fb6492af36bd2d

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).
 
+## [1.12.0] - 2022-05-04
+
+* SSR!
+
+## [1.11.1] - 2021-06-27
+
+* Fixed thread safety in the middleware. Thanks @caifara!
+
+## [1.11.0] - 2021-03-23
+
+* Fixed the install generator. `installable?` was always returning false, preventing it from actually running.
+* Added an install generator for Vue.
+
 ## [1.10.0] - 2021-03-22
 
 * Added install generator to quickly add Inertia to existing rails apps via `rails inertia_rails:install:react`

data/README.md

@@ -1,14 +1,10 @@
-# Inertia.js Rails Adapter
-
-Visit [inertiajs.com](https://inertiajs.com/) to learn more.
+![image](https://user-images.githubusercontent.com/6599653/114456558-032e2200-9bab-11eb-88bc-a19897f417ba.png)
 
-# Note to pre Rubygems release users
 
-The initial version of the gem was named `inertia`; however, that name was not available on Rubygems. 
+# Inertia.js Rails Adapter
 
-The 1.0.0 version release on Rubygems is `inertia_rails`.
+Visit [inertiajs.com](https://inertiajs.com/) for installation instructions, documentation, and to learn more.
 
-The changes required are:
+*Maintained and sponsored by the team at [bellaWatt](https://bellawatt.com/)*
 
-1. Use `gem 'inertia_rails'` in your Gemfile (or `gem install inertia_rails`)
-2. Change any `Inertia.configure` calls to `InertiaRails.configure`
+[![bellaWatt Logo](https://user-images.githubusercontent.com/6599653/114456832-5607d980-9bab-11eb-99c8-ab39867c384e.png)](https://bellawatt.com/)

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/vue/InertiaExample.vue

@@ -0,0 +1,11 @@
+<template>
+  <h1 :style="{ 'text-align': 'center' }">Hello {{name}}!</h1>
+</template>
+
+<script>
+export default {
+  props: {
+    name: { type: String, required: true },
+  },
+}
+</script>

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

@@ -0,0 +1,24 @@
+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')
+
+  Vue.use(plugin)
+
+  new Vue({
+    render: h => h(app, {
+      props: {
+        initialPage: JSON.parse(el.dataset.page),
+        resolveComponent: name => require(`../Pages/${name}`).default,
+      },
+    }),
+  }).$mount(el)
+})

data/lib/generators/inertia_rails/install_generator.rb

@@ -5,6 +5,8 @@ module InertiaRails
 
     FRONT_END_INSTALLERS = [
       'react',
+      'vue',
+      'svelte',
     ]
 
     def install
@@ -32,6 +34,8 @@ module InertiaRails
 
         return false
       end
+
+      true
     end
 
     def install_base!
@@ -53,10 +57,28 @@ module InertiaRails
     def install_react!
       say "Creating a React page component...", :blue
       run 'yarn add @inertiajs/inertia-react'
-      template "react.jsx", Rails.root.join("app/javascript/Pages/InertiaExample.js").to_s
+      template "react/InertiaExample.jsx", Rails.root.join("app/javascript/Pages/InertiaExample.js").to_s
       say "Copying inertia.jsx into webpacker's packs folder...", :blue
-      template "inertia.jsx", Rails.root.join("app/javascript/packs/inertia.jsx").to_s
+      template "react/inertia.jsx", Rails.root.join("app/javascript/packs/inertia.jsx").to_s
+      say "done!", :green
+    end
+
+    def install_vue!
+      say "Creating a Vue page component...", :blue
+      run 'yarn add @inertiajs/inertia-vue'
+      template "vue/InertiaExample.vue", Rails.root.join("app/javascript/Pages/InertiaExample.vue").to_s
+      say "Copying inertia.js into webpacker's packs folder...", :blue
+      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
+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/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/middleware.rb

@@ -5,79 +5,91 @@ module InertiaRails
     end
 
     def call(env)
-      @env = env
+      InertiaRailsRequest.new(@app, env)
+                         .response
+    end
 
-      status, headers, body = @app.call(env)
-      request = ActionDispatch::Request.new(env)
+    class InertiaRailsRequest
+      def initialize(app, env)
+        @app = app
+        @env = env
+      end
 
-      ::InertiaRails.reset!
+      def response
+        status, headers, body = @app.call(@env)
+        request = ActionDispatch::Request.new(@env)
 
-      # Inertia errors are added to the session via redirect_to 
-      request.session.delete(:inertia_errors) unless keep_inertia_errors?(status)
+        ::InertiaRails.reset!
 
-      status = 303 if inertia_non_post_redirect?(status)
+        # Inertia errors are added to the session via redirect_to 
+        request.session.delete(:inertia_errors) unless keep_inertia_errors?(status)
 
-      return stale_inertia_get? ? force_refresh(request) : [status, headers, body]
-    end
+        status = 303 if inertia_non_post_redirect?(status)
 
-    private
+        stale_inertia_get? ? force_refresh(request) : [status, headers, body]
+      end
 
-    def keep_inertia_errors?(status)
-      redirect_status?(status) || stale_inertia_request?
-    end
+      private
 
-    def stale_inertia_request?
-      inertia_request? && version_stale?
-    end
+      def keep_inertia_errors?(status)
+        redirect_status?(status) || stale_inertia_request?
+      end
 
-    def redirect_status?(status)
-      [301, 302].include? status
-    end
+      def stale_inertia_request?
+        inertia_request? && version_stale?
+      end
 
-    def non_get_redirectable_method?
-      ['PUT', 'PATCH', 'DELETE'].include? request_method
-    end
+      def redirect_status?(status)
+        [301, 302].include? status
+      end
 
-    def inertia_non_post_redirect?(status)
-      inertia_request? && redirect_status?(status) && non_get_redirectable_method?
-    end
+      def non_get_redirectable_method?
+        ['PUT', 'PATCH', 'DELETE'].include? request_method
+      end
 
-    def stale_inertia_get?
-      get? && stale_inertia_request?
-    end
+      def inertia_non_post_redirect?(status)
+        inertia_request? && redirect_status?(status) && non_get_redirectable_method?
+      end
 
-    def get?
-      request_method == 'GET'
-    end
+      def stale_inertia_get?
+        get? && stale_inertia_request?
+      end
 
-    def request_method
-      @env['REQUEST_METHOD']
-    end
+      def get?
+        request_method == 'GET'
+      end
 
-    def inertia_version
-      @env['HTTP_X_INERTIA_VERSION']
-    end
+      def request_method
+        @env['REQUEST_METHOD']
+      end
 
-    def inertia_request?
-      @env['HTTP_X_INERTIA'].present?
-    end
+      def inertia_version
+        @env['HTTP_X_INERTIA_VERSION']
+      end
 
-    def version_stale?
-      sent_version != saved_version
-    end
+      def inertia_request?
+        @env['HTTP_X_INERTIA'].present?
+      end
 
-    def sent_version
-      return nil if inertia_version.nil?
-      InertiaRails.version.is_a?(Numeric) ? inertia_version.to_f : inertia_version
-    end
+      def version_stale?
+        sent_version != saved_version
+      end
 
-    def saved_version
-      InertiaRails.version.is_a?(Numeric) ? InertiaRails.version.to_f : InertiaRails.version
-    end
+      def sent_version
+        return nil if inertia_version.nil?
+
+        InertiaRails.version.is_a?(Numeric) ? inertia_version.to_f : inertia_version
+      end
 
-    def force_refresh(request)
-      request.flash.keep
-      Rack::Response.new('', 409, {'X-Inertia-Location' => request.original_url}).finish
+      def saved_version
+        InertiaRails.version.is_a?(Numeric) ? InertiaRails.version.to_f : InertiaRails.version
+      end
+
+      def force_refresh(request)
+        request.flash.keep
+        Rack::Response.new('', 409, {'X-Inertia-Location' => request.original_url}).finish
+      end
     end
   end
 end
+

data/lib/inertia_rails/renderer.rb

@@ -1,3 +1,5 @@
+require 'net/http'
+require 'json'
 require_relative "inertia_rails"
 
 module InertiaRails
@@ -15,6 +17,8 @@ module InertiaRails
     end
 
     def render
+      return render_ssr if ::InertiaRails.ssr_enabled?
+
       if @request.headers['X-Inertia']
         @response.set_header('Vary', 'Accept')
         @response.set_header('X-Inertia', 'true')
@@ -26,6 +30,14 @@ module InertiaRails
 
     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.10.0"
+  VERSION = "1.12.0"
 end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: inertia_rails
 version: !ruby/object:Gem::Version
-  version: 1.10.0
+  version: 1.12.0
 platform: ruby
 authors:
 - Brian Knoles
 - Brandon Shar
 - Eugene Granovsky
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-22 00:00:00.000000000 Z
+date: 2022-05-04 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
@@ -154,12 +154,17 @@ files:
 - gemfiles/rails_6.1.gemfile
 - inertia_rails.gemspec
 - lib/generators/inertia_rails/install/controller.rb
-- lib/generators/inertia_rails/install/inertia.jsx
-- lib/generators/inertia_rails/install/react.jsx
+- 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
@@ -180,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
@@ -195,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: []