quilt_rails 1.2.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37e297fafc5b69be129c5a4770dacf4f59f4268d7e6c20ec0ad5f04bcf04f553
-  data.tar.gz: 479e1d89872d29171328ed4fde97a734acbb6d87482dc3d585a4f5564cbe99dc
+  metadata.gz: 5214ca27d069782ed72ddcd0f8efe1570ac2d8ebbf71df664f01d88977b09d80
+  data.tar.gz: c80609914deb36fb2fe95b683b5bdca6bab97f2100609daf95e9938a31a35e4d
 SHA512:
-  metadata.gz: e4241d2c553d44a385970ada0101e88461685b1dfc58bf057d02e97476df0662b7be908d453d8f920b9d268b5a8d3d42b2a2b568d9252ef9e6ae086cff112d43
-  data.tar.gz: bb2df14689c7255c6df563df49f3985b312109fc3f89521cf85252130540c29f945e9a860f99d432adc4ffa819a95c3d019d306d690761323cbf35fe8daa5244
+  metadata.gz: 98813d5e73ad5a700318b8185f08db41863665adb071bef21e9abfea66cbda8810f42ee4c3d7065dbc6fbd32111de9b875964a215258d3fdb6fd71ddd0bfaaab
+  data.tar.gz: 0601b77ac976964817c259c5b4fc9d92356493ebe7f9bf617a5be03b8da9493e8cc04375bba08d6bedff54aec5db5b0fc7c5df0ca22ee9ff6eab6bb09f047e4b

data/README.md

@@ -6,13 +6,20 @@ This document focuses on Rails integration. For details of `@shopify/react-serve
 
 ## Quick Start
 
-Create a Rails project using `dev init` then:
+### Add Ruby dependencies
+
+`bundle add sewing_kit quilt_rails`
+
+First, create a Rails project using `dev init`. Next, run `rails generate quilt:install`. This will install the Node dependencies, provide a basic React app (in TypeScript) and mounts the Quilt engine inside of your `config/routes.rb` file.
+
+## Manual Installation
+
+You can also perform the steps within the rake task manually by following the guide below.
 
 ### Install Dependencies
 
 ```sh
-# Add Ruby/Node dependencies
-bundle add sewing_kit quilt_rails
+# Add Node dependencies
 yarn add @shopify/sewing-kit @shopify/react-server
 
 # Optional - add Polaris and quilt libraries
@@ -26,7 +33,33 @@ dev up
 
 sewing_kit looks for JavaScript in `app/ui/index.js`. The code in `index.js` (and any imported JS/CSS) will be built into a `main` bundle.
 
-### Setup your react controller and routes
+### Rails Setup
+
+There are 2 ways to consume this package.
+
+### Option 1: Mount the Engine
+
+Add the engine to `routes.rb`.
+
+```ruby
+# config/routes.rb
+Rails.application.routes.draw do
+  # ...
+  mount Quilt::Engine, at: '/'
+end
+```
+
+Where `at` is the path where your App will respond with the React App. If you only want a sub-section of routes to respond with the React App, you can pass in the path to that sub-section here. For example:
+
+```ruby
+# config/routes.rb
+Rails.application.routes.draw do
+  # ...
+  mount Quilt::Engine, at: '/path/to/react'
+end
+```
+
+### Option 2: Add your react controller and routes
 
 Create a `ReactController` to handle react requests.
 
@@ -80,3 +113,13 @@ function App() {
 
 export default App;
 ```
+
+## Rails Generators'
+
+### `quilt:install`
+
+Installs the Node dependencies, provide a basic React app (in TypeScript) and mounts the Quilt engine inside of your `config/routes.rb` file.
+
+### `sewing-kit:install`
+
+Adds a basic `sewing-kit.config.ts` file.

data/Rakefile

@@ -10,6 +10,8 @@ end
 
 Bundler::GemHelper.install_tasks
 
+require File.expand_path('../test/dummy/config/application', __FILE__)
+
 require 'rake/testtask'
 
 Rake::TestTask.new do |t|

data/app/controllers/quilt/ui_controller.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Quilt
+  class UiController < ApplicationController
+    include Quilt::ReactRenderable
+
+    def index
+      render_react
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+Quilt::Engine.routes.draw do
+  get '/*path', to: 'react#index'
+  root 'react#index'
+end

data/lib/generators/quilt/USAGE

@@ -0,0 +1,5 @@
+Description:
+    This generator mounts the Quilt engine and adds a React app.
+
+Example:
+    rails generate quilt:install

data/lib/generators/quilt/install_generator.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Quilt
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+
+    desc "This generator mounts the Quilt engine and adds a React app."
+
+    def install_js_dependencies
+      say "Installing @shopify/react-server and @shopify/sewing-kit dependencies"
+      system("yarn add @shopify/sewing-kit @shopify/react-server") unless Rails.env.test?
+    end
+
+    def create_app_file
+      app_path = "app/ui/index.tsx"
+
+      unless File.exist?(app_path)
+        copy_file "App.tsx", app_path
+
+        log("React App at #{app_path}", 'wrote')
+      end
+    end
+
+    def create_route_file
+      routes_path = "config/routes.rb"
+
+      if File.exist?(routes_path)
+        route "mount Quilt::Engine, at: '/'"
+      else
+        copy_file "routes.rb", routes_path
+      end
+
+      say "Added Quilt engine mount"
+    end
+  end
+end

data/lib/generators/quilt/templates/App.tsx

@@ -0,0 +1,7 @@
+import React from 'react';
+
+function App() {
+  return <div>Hello Quilt</div>;
+}
+
+export default App;

data/lib/generators/quilt/templates/routes.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+Rails.application.routes.draw do
+  mount Quilt::Engine, at: '/'
+end

data/lib/generators/sewing_kit/USAGE

@@ -0,0 +1,5 @@
+Description:
+    This generator creates a sewing-kit config file.
+
+Example:
+    rails generate sewing-kit:install

data/lib/generators/sewing_kit/install_generator.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module SewingKit
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+
+    desc "This generator creates a sewing-kit config file."
+
+    def create_config
+      config_path = "config/sewing-kit.config.ts"
+
+      if File.exist?(config_path)
+        say "Sewing kit config already exists"
+      else
+        copy_file "sewing-kit.config.ts", config_path
+
+        say "Sewing kit config"
+      end
+    end
+  end
+end

data/lib/generators/sewing_kit/templates/sewing-kit.config.ts

@@ -0,0 +1,7 @@
+/* eslint-env node */
+
+module.exports = function sewingKitConfig() {
+  return {
+    name: 'your-app-name',
+  };
+};

data/lib/quilt_rails/engine.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Quilt
+  class Engine < ::Rails::Engine
+    isolate_namespace Quilt
+  end
+end

data/lib/quilt_rails/react_renderable.rb

@@ -1,4 +1,6 @@
-require 'rails-reverse-proxy';
+# frozen_string_literal: true
+
+require 'rails-reverse-proxy'
 
 module Quilt
   module ReactRenderable

data/lib/quilt_rails/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Quilt
-  VERSION = "1.2.0"
+  VERSION = "1.3.1"
 end

data/lib/quilt_rails.rb

@@ -2,7 +2,7 @@
 module Quilt
 end
 
+require "quilt_rails/engine"
 require "quilt_rails/version"
 require "quilt_rails/configuration"
-require "quilt_rails/railtie"
 require "quilt_rails/react_renderable"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quilt_rails
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Mathew Allen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-16 00:00:00.000000000 Z
+date: 2019-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -38,6 +38,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.74'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.74'
+- !ruby/object:Gem::Dependency
+  name: rubocop-git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.3
 description: A turn-key solution for integrating server-rendered react into your Rails
   app using Quilt libraries.
 email:
@@ -48,9 +76,18 @@ extra_rdoc_files: []
 files:
 - README.md
 - Rakefile
+- app/controllers/quilt/ui_controller.rb
+- config/routes.rb
+- lib/generators/quilt/USAGE
+- lib/generators/quilt/install_generator.rb
+- lib/generators/quilt/templates/App.tsx
+- lib/generators/quilt/templates/routes.rb
+- lib/generators/sewing_kit/USAGE
+- lib/generators/sewing_kit/install_generator.rb
+- lib/generators/sewing_kit/templates/sewing-kit.config.ts
 - lib/quilt_rails.rb
 - lib/quilt_rails/configuration.rb
-- lib/quilt_rails/railtie.rb
+- lib/quilt_rails/engine.rb
 - lib/quilt_rails/react_renderable.rb
 - lib/quilt_rails/version.rb
 homepage: https://github.com/Shopify/quilt/tree/master/gems/quilt_rails

data/lib/quilt_rails/railtie.rb

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-module Quilt
-  class Railtie < Rails::Railtie
-  end
-end