inertia_rails 1.9.2 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84d7a55c30678d9984236bdca8442ff34268cb09ff8795560d0506678acf9ab8
-  data.tar.gz: 48308b96e0e2cf06c70027649acc8e992f280743fd5cae05c70a49c4d8ec343e
+  metadata.gz: c76eba9ada41f6b781b030f81b43bb87169034594127e106ec4dbee472926e8e
+  data.tar.gz: e9ed9115c9d6a678bdefdeeeafbeb1790c9a28f37521d71c699d5ca40989cd86
 SHA512:
-  metadata.gz: b8ab3b00e2ee6a44649924fd60aefad32bd5bd33621a12c45ddb692f49d7220a4f1a3837334d983ce614a30c9144249c23f280918b8fbc9b75aef2f97cfad04d
-  data.tar.gz: de4d10ec3200f4d45a50c2a1cb2abcc479182f4cee135b9401f43679ad1e296031c644982b9d2fa5e5a5875f1fe909b8dfcda941e933927028b0f7cbdbbb8d97
+  metadata.gz: 5d0285ccf5284c9fb4d267d25dfc899d58be5f57b2166fc42251246398483aaf639c8dbec94181a1a5978c020ea2fb796872248dd3de7c14db165b8ab20755cb
+  data.tar.gz: c06d57bec2e2c4fa55b15428055684999af1d65ee226f42263cb945d17ce4f06029bc8365b2a9f52b59db924b251f34944dd96998a7933b64fe18c6e80ae3117

data/CHANGELOG.md

@@ -4,6 +4,10 @@ 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.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

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/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/react.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_generator.rb

@@ -0,0 +1,62 @@
+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',
+    ]
+
+    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
+    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.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
+      say "done!", :green
+    end
+  end
+end

data/lib/inertia_rails/version.rb

@@ -1,3 +1,3 @@
 module InertiaRails
-  VERSION = "1.9.2"
+  VERSION = "1.10.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.9.2
+  version: 1.10.0
 platform: ruby
 authors:
 - Brian Knoles
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-23 00:00:00.000000000 Z
+date: 2021-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -153,6 +153,10 @@ 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/inertia.jsx
+- lib/generators/inertia_rails/install/react.jsx
+- lib/generators/inertia_rails/install_generator.rb
 - lib/inertia_rails.rb
 - lib/inertia_rails/controller.rb
 - lib/inertia_rails/engine.rb
@@ -168,6 +172,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