inertia_rails 1.8.0 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c9c8c3b0d07a467179b741d6ce1f9d79d6190f0c71ecbe3e960536929055caf
-  data.tar.gz: 2f0f3a5ac49480f5fae1b28c771fe7bc3ea6de2953c734e0015b617fcc70a8bc
+  metadata.gz: 7912624c7ea6f1c71a896b969b704d8ff329ee41a3d1bc7277c28900b35a6516
+  data.tar.gz: 30098f0f5dd3cf41987cd40f139a12259d5501375b85685ab0d427c0e69d230e
 SHA512:
-  metadata.gz: d696ea9c18535afb527dfead16bd271613d2bb561936ffd470e85caf78e20138109c6247d2e21724751a94acafc5548849533e50da3774d510528ed6f1221bc4
-  data.tar.gz: 6aa06ca052045c5f27c8f1a801889cf26ed77bb5e660875e6fe74cd3c7a30eab7c306385b9707842c8a52a8131c797405741a5f34e5397a64b58da2e98c5ae62
+  metadata.gz: a97f62fa00d4489ff8364e6b4f9914161a1394905e5830526ba0baa9ae6888ee933a4e7739e18aeb6969f470989fb4aba9031cb62f57b68ed89065ff433d4e54
+  data.tar.gz: e9d7b942b9e1b7f4cdb98e9941143b0e08501586266aac08390a510126233ffeca8328e75e9b0f63aea49d1d19820d02b97e65af0fb178bb822c8bf63ad9925c

data/.github/workflows/push.yml

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

data/Appraisals

@@ -1,3 +1,7 @@
+appraise "rails-6.1" do
+  gem "rails", "~> 6.1.0"
+end
+
 appraise "rails-6.0" do
   gem "rails", "~> 6.0.3", '>= 6.0.3.2'
 end

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.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
+
 ## [1.8.0] - 2020-12-08
 
 * Add `inertia` route helper feature

data/gemfiles/rails_6.1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 6.1.0"
+
+gemspec path: "../"

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,17 +20,31 @@ module InertiaRails
       end
     end
 
+    def redirect_to(options = {}, response_options = {})
+      capture_inertia_errors(response_options)
+      super(options, response_options)
+    end
+
+    def redirect_back(fallback_location:, allow_other_host: true, **options)
+      capture_inertia_errors(options)
+      super(
+        fallback_location: fallback_location,
+        allow_other_host: allow_other_host,
+        **options,
+      )
+    end
+
+    private
+
     def inertia_location(url)
       headers['X-Inertia-Location'] = url
       head :conflict
     end
 
-    def redirect_to(options = {}, response_options = {})
-      if (inertia_errors = response_options.fetch(:inertia, {}).fetch(:errors, nil))
+    def capture_inertia_errors(options)
+      if (inertia_errors = options.dig(:inertia, :errors))
         session[:inertia_errors] = inertia_errors
       end
-
-      super(options, response_options)
     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.8.0"
+  VERSION = "1.11.0"
 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.8.0
+  version: 1.11.0
 platform: ruby
 authors:
 - Brian Knoles
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-12-08 00:00:00.000000000 Z
+date: 2021-03-23 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
@@ -137,7 +151,14 @@ files:
 - gemfiles/rails_5.1.gemfile
 - gemfiles/rails_5.2.gemfile
 - 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
@@ -153,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