inertia_rails 1.9.0 → 1.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a3b7e29654788cf3c7ac7307d83fd258d47c7ee5daa36745998c944ae31b472
-  data.tar.gz: 4070f2fb9ae9d253a94c98d7f8705f713248788b63611bfa30f36edaaa15a73e
+  metadata.gz: 60a2f2a20da36323f792051d3a0c1327b3f085f78e8fed5906064e8892c516d9
+  data.tar.gz: c9a40fd17509def36b88862a671f98a4ed839f158ffd0959a66aba3023ee6084
 SHA512:
-  metadata.gz: 2aa986d0e69a1db45d94ca921771e7ff82ec61c53008dbf756b9eed3728837d314ee773e12acd27a98fcb1372d67f44653fa749ef24b2959759849b2be925ae9
-  data.tar.gz: ab880524135f77d437aeb4c8dfa1e3e23ddc69db5d99a5adea6139d17331db7981f691921ae10b84d41122d06fc1a01a456af902ed3fcde704fb9d4bf1b9f08a
+  metadata.gz: c136e534632a852b4d92ec7303cb5eba67fed88706cf28cc16e8bc541fda5320f9f09aa3e92f481951fe93390e30714813f0950bd67b75389b933634721d8dd5
+  data.tar.gz: b6f8568840f971249c90142afd6b20adf39b4d99a4864d952ddbedcbfdfb49884a6e35f9c419fd180d7abf50590bee70863f3766b94e6883a171b8995cef5f9e

data/CHANGELOG.md

@@ -4,6 +4,28 @@ 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.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`
+
+## [1.9.2] - 2021-02-23
+
+* Improve method for detecting whether a user used the RSpec helpers without adding `inertia: true` to the spec
+* Emit a warning when expecting an Inertia response in RSpec and never reaching a `render inertia:` call
+
+## [1.9.1] - 2021-02-10
+
+* Define `redirect_to` and `redirect_back` as public methods for compatibility with other code using them
+
 ## [1.9.0] - 2021-01-17
 
 * Added the same inertia awareness that redirect_to has to redirect_back

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/inertia_rails.gemspec

@@ -33,4 +33,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rails-controller-testing"
   spec.add_development_dependency "sqlite3"
   spec.add_development_dependency "appraisal"
+  spec.add_development_dependency "responders"
 end

data/lib/generators/inertia_rails/install/controller.rb

@@ -0,0 +1,7 @@
+class InertiaExampleController < ApplicationController
+  def index
+    render inertia: 'InertiaExample', props: {
+      name: 'World',
+    }
+  end
+end

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

@@ -0,0 +1,9 @@
+import React from 'react';
+
+const InertiaExample = ({name}) => (
+  <>
+    <h1>Hello {name}!</h1>
+  </>
+);
+
+export default InertiaExample;

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

@@ -0,0 +1,21 @@
+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)}
+      resolveComponent={name => require(`../Pages/${name}`).default}
+    />,
+    el
+  )
+});

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

@@ -0,0 +1,74 @@
+module InertiaRails
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('./install', __dir__)
+    class_option :front_end, type: :string, default: 'react'
+
+    FRONT_END_INSTALLERS = [
+      'react',
+      'vue',
+    ]
+
+    def install
+      exit! unless installable?
+
+      install_base!
+
+      send "install_#{options[:front_end]}!"
+
+      say "You're all set! Run rails s and checkout localhost:3000/inertia-example", :green
+    end
+
+    protected
+
+    def installable?
+      unless run("./bin/rails webpacker:verify_install")
+        say "Sorry, you need to have webpacker installed for inertia_rails default setup.", :red
+        return false
+      end
+
+      unless options[:front_end].in? FRONT_END_INSTALLERS
+        say "Sorry, there is no generator for #{options[:front_end]}!\n\n", :red
+        say "If you are a #{options[:front_end]} developer, please help us improve inertia_rails by contributing an installer.\n\n"
+        say "https://github.com/inertiajs/inertia-rails/\n\n"
+
+        return false
+      end
+
+      true
+    end
+
+    def install_base!
+      say "Adding inertia pack tag to application layout", :blue
+      insert_into_file Rails.root.join("app/views/layouts/application.html.erb").to_s, after: "<%= javascript_pack_tag 'application' %>\n" do
+        "\t\t<%= javascript_pack_tag 'inertia' %>\n"
+      end
+
+      say "Installing inertia client packages", :blue
+      run "yarn add @inertiajs/inertia @inertiajs/progress"
+
+      say "Copying example files", :blue
+      template "controller.rb", Rails.root.join("app/controllers/inertia_example_controller.rb").to_s
+
+      say "Adding a route for the example inertia controller...", :blue
+      route "get 'inertia-example', to: 'inertia_example#index'"
+    end
+
+    def install_react!
+      say "Creating a React page component...", :blue
+      run 'yarn add @inertiajs/inertia-react'
+      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 "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
+  end
+end

data/lib/inertia_rails/controller.rb

@@ -20,13 +20,6 @@ module InertiaRails
       end
     end
 
-    private
-
-    def inertia_location(url)
-      headers['X-Inertia-Location'] = url
-      head :conflict
-    end
-
     def redirect_to(options = {}, response_options = {})
       capture_inertia_errors(response_options)
       super(options, response_options)
@@ -41,6 +34,13 @@ module InertiaRails
       )
     end
 
+    private
+
+    def inertia_location(url)
+      headers['X-Inertia-Location'] = url
+      head :conflict
+    end
+
     def capture_inertia_errors(options)
       if (inertia_errors = options.dig(:inertia, :errors))
         session[:inertia_errors] = inertia_errors

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/rspec.rb

@@ -35,6 +35,9 @@ module InertiaRails
       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
 
@@ -49,7 +52,7 @@ module InertiaRails
       protected 
       
       def inertia_tests_setup?
-        @_inertia_render_wrapper.present?
+        ::RSpec.current_example.metadata.fetch(:inertia, false)
       end
     end
   end
@@ -57,6 +60,9 @@ 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)

data/lib/inertia_rails/version.rb

@@ -1,3 +1,3 @@
 module InertiaRails
-  VERSION = "1.9.0"
+  VERSION = "1.11.1"
 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

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: inertia_rails
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.11.1
 platform: ruby
 authors:
 - Brian Knoles
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-17 00:00:00.000000000 Z
+date: 2021-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -110,6 +110,20 @@ dependencies:
     - - ">="
       - !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'
 description: 
 email:
 - brain@bellawatt.com
@@ -139,6 +153,12 @@ files:
 - gemfiles/rails_6.0.gemfile
 - gemfiles/rails_6.1.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/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
@@ -154,6 +174,7 @@ files:
 - 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/inertiajs/inertia-rails
 licenses:
 - MIT