quilt_rails 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 79df4e26acc8f810e8a721f77915f4a4d4ccd303b99fa7f0707664ce7fee54d3
+  data.tar.gz: 3864feba212ae32c9e22935e43ecf3f48a3d7565f25dca7a9c08993e9e01d295
+SHA512:
+  metadata.gz: e47642a175372f74193cac2016edb7198069d18ad2f81714892507b114966627a75765f53af510a16d81ba7ef16b9bd1973a6471b10591688b84682ea89629f0
+  data.tar.gz: 7c772564b14727ccd3e92cdcaaf6e35f54e1f28061d7d0e1918bf4c2ea5d05fe976356882e92d19409e6c1d2296b6304a3b6941b2180701b3bc39c65a63b4c0a

data/README.md

@@ -0,0 +1,82 @@
+# quilt_rails
+
+A turn-key solution for integrating server-rendered react into your Rails app using Quilt libraries.
+
+This document focuses on Rails integration. For details of `@shopify/react-server`'s configuration and usage, see the [react-server documentation](/packages/react-server/README.md).
+
+## Quick Start
+
+Create a Rails project using `dev init` then:
+
+### Install Dependencies
+
+```sh
+# Add Ruby/Node dependencies
+bundle add sewing_kit quilt_rails
+yarn add @shopify/sewing-kit @shopify/react-server
+
+# Optional - add Polaris and quilt libraries
+yarn add @shopify/polaris @shopify/react-self-serializers react react-dom
+
+yarn
+dev up
+```
+
+### Add JavaScript
+
+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
+
+Create a `ReactController` to handle react requests.
+
+```ruby
+class ReactController < ApplicationController
+  include Quilt::ReactRenderable
+
+  def index
+    render_react
+  end
+end
+```
+
+Have your routes wired up to default to your react controller.
+
+```ruby
+  get '/*path', to: 'react#index'
+  root 'react#index'
+```
+
+## Minimal Project Layout
+
+```
+├── Gemfile (must contain "gem 'sewing_kit" and "gem 'quilt_rails'")
+├── package.json (must specify '@shopify/sewing-kit' and `@shopify/react-server` as 'dependencies')
+│
+└── app
+   └── ui
+   │   └─- index.js
+   └── controllers
+       └─- react_controller (see above)
+```
+
+## Example minimal React/Polaris/Quilt entrypoint
+
+```tsx
+// app/ui/index.tsx
+
+import * as React from 'react';
+import {AppProvider, Page, Card} from '@shopify/polaris';
+
+function App() {
+  return (
+    <AppProvider>
+      <Page title="Hello">
+        <Card sectioned>Hi there</Card>
+      </Page>
+    </AppProvider>
+  );
+}
+
+export default App;
+```

data/Rakefile

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+end
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.name = 'test:unit'
+  t.pattern = 'test/quilt_rails/**/*_test.rb'
+end

data/lib/quilt_rails.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+module Quilt
+end
+
+require "quilt_rails/version"
+require "quilt_rails/configuration"
+require "quilt_rails/railtie"
+require "quilt_rails/react_renderable"

data/lib/quilt_rails/configuration.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+module Quilt
+  class Configuration
+    attr_accessor :react_server_host, :react_server_protocol
+
+    def initialize
+      @react_server_host = ENV['SERVICE_URL'] || 'localhost:8081'
+      @react_server_protocol = ENV['SERVICE_PROTOCOL'] || 'http'
+    end
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

data/lib/quilt_rails/railtie.rb

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

data/lib/quilt_rails/react_renderable.rb

@@ -0,0 +1,12 @@
+require 'rails-reverse-proxy';
+
+module Quilt
+  module ReactRenderable
+    include ReverseProxy::Controller
+
+    def render_react
+      host = "#{Quilt.configuration.react_server_protocol}://#{Quilt.configuration.react_server_host}"
+      reverse_proxy(host)
+    end
+  end
+end

data/lib/quilt_rails/version.rb

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

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: quilt_rails
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Mathew Allen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-08-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: rails-reverse-proxy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+description: A turn-key solution for integrating server-rendered react into your Rails
+  app using Quilt libraries.
+email:
+- mathew.allen@shopify.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/quilt_rails.rb
+- lib/quilt_rails/configuration.rb
+- lib/quilt_rails/railtie.rb
+- lib/quilt_rails/react_renderable.rb
+- lib/quilt_rails/version.rb
+homepage: https://github.com/Shopify/quilt/tree/master/gems/quilt_rails
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A turn-key solution for integrating server-rendered react into your Rails
+  app using Quilt libraries.
+test_files: []