react_on_rails 6.0.0.rc.1 → 6.0.0.rc.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 68bfa72cdabcd0e2d861afb7da5ca7af104b5140
-  data.tar.gz: baac4a7186be9bc820dfe64b660b241c08bba3fa
+  metadata.gz: 4fa57ce474be6cdecc395a2a0241a4a543ef1a68
+  data.tar.gz: dc3f4b0fc45854395163b3cec9b128c8983584d4
 SHA512:
-  metadata.gz: 1cd07693555179d1e8ddc79fc7c495eeaee20ce5081f8897c5d79af468c1a98f219ae9ff76b9ecb4a4875c189b21ba32f05de6ee8c84ddc1bb1b89c31f909dda
-  data.tar.gz: 5753b635513ceb439fc2f19f9a453a27533ee07c1435811f0aa982727136fb1f07316e73b0108aa9d89617c3506797d34fd5622e2f9359e1a73c1b376ca3c01a
+  metadata.gz: 436ca89cf6a4531b363dabd0dbbeee60208e5889f6cbe6c349c93070759ac032ae5ec4cc3ab62918fea4afe7f724c8a1b1d4a6721e559578410c583e644333a9
+  data.tar.gz: 714db3dc3ed5d8777be27bc7d33fe12c477eaa2920f6887d463a4cc18681d7206b1a2e77f7470de1439771cc658741b5fcf6e60f0e1f6f0007f973457a8e64c3

data/CHANGELOG.md

@@ -4,20 +4,30 @@ All notable changes to this project will be documented in this file. Items under
 Contributors: please follow the recommendations outlined at [keepachangelog.com](http://keepachangelog.com/). Please use the existing headings and styling as a guide, and add a link for the version diff at the bottom of the file. Also, please update the `Unreleased` link to compare to the latest release version.
 ## [Unreleased]
 
-## [6.0.0-rc1]
+## [6.0.0-rc.1]
 ##### Breaking Changes
 - Added automatic compilation of assets at precompile is now done by ReactOnRails. Thus, you don't need to provide your own assets.rake file that does the precompilation. 
   [#398](https://github.com/shakacode/react_on_rails/pull/398) by [robwise](https://github.com/robwise), [jbhatab](https://github.com/jbhatab), and [justin808](https://github.com/justin808).
-- **Migration to v6: you can either:**
+- **Migration to v6**
   
-  1. Specify a `config/react_on_rails` setting for `npm_build_production_command` to be nil to turn this feature off.
-  2. Specify the script command you want to run to build your production assets, and remove your assets.rake file.
+  - To configure the asset compliation you can either
+    1. Specify a `config/react_on_rails` setting for `npm_build_production_command` to be nil to turn this feature off.
+    2. Specify the script command you want to run to build your production assets, and remove your assets.rake file.
+
+  - If you are using the ReactOnRails test helper, then you will need to add the 'config.npm_build_test_command' to your config to tell react_on_rails what command to run when you run rspec.
+   
+- See [shakacode/react-webpack-rails-tutorial #287](https://github.com/shakacode/react-webpack-rails-tutorial/pull/287/files) for an upgrade example. The PR has a few comments on the upgrade.
 
 Here is the addition to the generated config file:
 ```ruby
   # This configures the script to run to build the production assets by webpack. Set this to nil
   # if you don't want react_on_rails building this file for you.
   config.npm_build_production_command = "npm run build:production"
+
+  # If you are using the ReactOnRails::TestHelper.configure_rspec_to_compile_assets(config)
+  # with rspec then this controls what npm command is run
+  # to automatically refresh your webpack assets on every test run.
+  config.npm_build_test_command = "npm run build:test"
 ```
 
 ##### Fixed

data/README.md

@@ -18,7 +18,7 @@
 
 **Project Objective**: To provide an opinionated and optimal framework for integrating **Ruby on Rails** with modern JavaScript tooling and libraries, including [**Webpack**](http://webpack.github.io/), [**Babel**](https://babeljs.io/), [**React**](https://facebook.github.io/react/), [**Redux**](https://github.com/reactjs/redux), [**React-Router**](https://github.com/reactjs/react-router). This differs significantly from typical Rails. When considering what goes into **react_on_rails**, we ask ourselves, is the functionality related to the intersection of using Rails and with modern JavaScript? If so, then the functionality belongs right here. In other cases, we're releasing separate npm packages or Ruby gems. If you are interested in implementing React using traditional Rails architecture, see [react-rails](https://github.com/reactjs/react-rails).
 
-React on Rails integrates Facebook's [React](https://github.com/facebook/react) front-end framework with Rails. React v0.14.x and greate is supported, with server rendering. [Redux](https://github.com/reactjs/redux) and [React-Router](https://github.com/reactjs/react-redux) are supported as well, also with server rendering, using either **execJS** or a [Node.js server](https://github.com/shakacode/react_on_rails/blob/master/docs%2Fadditional-reading%2Fnode-server-rendering.md). See the Rails on Maui [blog post](http://www.railsonmaui.com/blog/2014/10/03/integrating-webpack-and-the-es6-transpiler-into-an-existing-rails-project/) that started it all!
+React on Rails integrates Facebook's [React](https://github.com/facebook/react) front-end framework with Rails. React v0.14.x and greater is supported, with server rendering. [Redux](https://github.com/reactjs/redux) and [React-Router](https://github.com/reactjs/react-redux) are supported as well, also with server rendering, using either **execJS** or a [Node.js server](https://github.com/shakacode/react_on_rails/blob/master/docs%2Fadditional-reading%2Fnode-server-rendering.md). See the Rails on Maui [blog post](http://www.railsonmaui.com/blog/2014/10/03/integrating-webpack-and-the-es6-transpiler-into-an-existing-rails-project/) that started it all!
 
 ## Including your React Component in your Rails Views
 Please see [Getting Started](#getting-started) for how to set up your Rails project for React on Rails to understand how `react_on_rails` can see your ReactComponents.
@@ -72,6 +72,7 @@ Please see [Getting Started](#getting-started) for how to set up your Rails proj
     - [ReactOnRails JavaScript API](#reactonrails-javascript-api)
     - [React-Router](#react-router)
     - [Deployment](#deployment)
++ [Integration with Node](#integration-with-node)
 + [Additional Reading](#additional-reading)
 + [Contributing](#contributing)
 + [License](#license)
@@ -101,37 +102,39 @@ Universal React with Rails: Part I](https://medium.com/@alexfedoseev/isomorphic-
 We're definitely not doing that. With react_on_rails, webpack is mainly generating a nice JavaScript file for inclusion into `application.js`. We're going to KISS. And that's all relative given how much there is to get right in an enterprise class web application.
 
 ## Getting Started
-1. Add the following to your Gemfile and bundle install:
+1. Add the following to your Gemfile and bundle install.
 
   ```ruby
   gem "react_on_rails", "~> 5"
   ```
 
-2. See help for the generator:
+2. Commit this to git (you cannot run the generator unless you do this).
+
+3. See help for the generator:
 
   ```bash
   rails generate react_on_rails:install --help
   ```
 
-2. Run the generator with a simple "Hello World" example (more options below):
+4. Run the generator with a simple "Hello World" example (more options below):
 
   ```bash
   rails generate react_on_rails:install
   ```
 
-3. NPM install. Make sure you are on a recent version of node. Please use at least Node v5.
+5. NPM install. Make sure you are on a recent version of node. Please use at least Node v5.
 
   ```bash
   npm install
   ```
 
-4. Start your Rails server:
+6. Start your Rails server:
 
   ```bash
   foreman start -f Procfile.dev
   ```
 
-5. Visit [localhost:3000/hello_world](http://localhost:3000/hello_world)
+7. Visit [localhost:3000/hello_world](http://localhost:3000/hello_world)
 
 ### Installation Summary
 
@@ -414,6 +417,117 @@ See [ReactOnRails JavaScriptAPI](docs/api/javascript-api.md).
 * See the [Heroku Deployment](docs/additional-reading/heroku-deployment.md) doc for specifics regarding Heroku.
 * If you're using the node server for server rendering, you may want to do your own AWS install. We'll have more docs on this in the future.
 
+## Integration with Node
+NodeJS can be used as the backend for server-side rendering instead of ExecJS. To do this you need to add a few files and then configure react_on_rails to use NodeJS. Here are the relevant files to add.
+
+```javascript
+// client/node/package.json
+{
+    "name": "react_on_rails_node",
+    "version": "0.0.0",
+    "private": true,
+    "scripts": {
+        "start": "node ./server.js -s webpack-bundle.js"
+    },
+    "dependencies": {
+    }
+}
+```
+
+```javascript
+// client/node/server.js
+var net = require('net');
+var fs = require('fs');
+
+var bundlePath = '../../app/assets/webpack/';
+var bundleFileName = 'webpack-bundle.js';
+
+var currentArg;
+
+function Handler() {
+  this.queue = [];
+  this.initialized = false;
+}
+
+Handler.prototype.handle = function (connection) {
+  var callback = function () {
+    connection.setEncoding('utf8');
+    connection.on('data', (data)=> {
+      console.log('Processing request: ' + data);
+      var result = eval(data);
+      connection.write(result);
+    });
+  };
+
+  if (this.initialized) {
+    callback();
+  } else {
+    this.queue.push(callback);
+  }
+};
+
+Handler.prototype.initialize = function () {
+  console.log('Processing ' + this.queue.length + ' pending requests');
+  var callback;
+  while (callback = this.queue.pop()) {
+    callback();
+  }
+
+  this.initialized = true;
+};
+
+var handler = new Handler();
+
+process.argv.forEach((val) => {
+  if (val[0] == '-') {
+    currentArg = val.slice(1);
+    return;
+  }
+
+  if (currentArg == 's') {
+    bundleFileName = val;
+  }
+});
+
+try {
+  fs.mkdirSync(bundlePath);
+} catch (e) {
+  if (e.code != 'EEXIST') throw e;
+}
+
+fs.watchFile(bundlePath + bundleFileName, (curr) => {
+  if (curr && curr.blocks && curr.blocks > 0) {
+    if (handler.initialized) {
+      console.log('Reloading server bundle must be implemented by restarting the node process!');
+      return;
+    }
+
+    require(bundlePath + bundleFileName);
+    console.log('Loaded server bundle: ' + bundlePath + bundleFileName);
+    handler.initialize();
+  }
+});
+
+var unixServer = net.createServer(function (connection) {
+  handler.handle(connection);
+});
+
+unixServer.listen('node.sock');
+
+process.on('SIGINT', () => {
+  unixServer.close();
+  process.exit();
+});
+
+```
+
+The last thing you'll need to do is change the server_render_method to "NodeJS".
+
+```ruby
+# app/config/initializers/react_on_rails.rb
+config.server_render_method = "NodeJS"
+```
+
 ## Additional Reading
 + [JavaScript API](docs/api/javascript-api.md)
 + [Ruby API](docs/api/ruby-api.md)

data/lib/generators/react_on_rails/base_generator.rb

@@ -85,14 +85,6 @@ module ReactOnRails
         append_to_file("Gemfile", "\ngem 'therubyracer', platforms: :ruby\n")
       end
 
-      def install_node_files
-        base_path = "base/base/"
-        %w(client/node/package.json
-           client/node/server.js).each do |file|
-          copy_file(base_path + file, file)
-        end
-      end
-
       ASSETS_RB_APPEND = <<-DATA.strip_heredoc
 # Add client/assets/ folders to asset pipeline's search path.
 # If you do not want to move existing images and fonts from your Rails app

data/lib/react_on_rails/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module ReactOnRails
-  VERSION = "6.0.0.rc.1".freeze
+  VERSION = "6.0.0.rc.2".freeze
 end

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-on-rails",
-  "version": "6.0.0-rc.1",
+  "version": "6.0.0-rc.2",
   "description": "react-on-rails JavaScript for react_on_rails Ruby gem",
   "main": "node_package/lib/ReactOnRails.js",
   "directories": {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: react_on_rails
 version: !ruby/object:Gem::Version
-  version: 6.0.0.rc.1
+  version: 6.0.0.rc.2
 platform: ruby
 authors:
 - Justin Gordon
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-11 00:00:00.000000000 Z
+date: 2016-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
@@ -379,13 +379,9 @@ files:
 - lib/generators/react_on_rails/templates/base/base/client/.babelrc
 - lib/generators/react_on_rails/templates/base/base/client/REACT_ON_RAILS_CLIENT_README.md
 - lib/generators/react_on_rails/templates/base/base/client/app/bundles/HelloWorld/components/HelloWorldWidget.jsx.tt
-- lib/generators/react_on_rails/templates/base/base/client/node/package.json
-- lib/generators/react_on_rails/templates/base/base/client/node/server.js
 - lib/generators/react_on_rails/templates/base/base/client/package.json.tt
 - lib/generators/react_on_rails/templates/base/base/client/webpack.config.js
 - lib/generators/react_on_rails/templates/base/base/config/initializers/react_on_rails.rb.tt
-- lib/generators/react_on_rails/templates/base/base/lib/tasks/assets.rake.tt
-- lib/generators/react_on_rails/templates/base/base/lib/tasks/load_test.rake
 - lib/generators/react_on_rails/templates/base/base/package.json.tt
 - lib/generators/react_on_rails/templates/dev_tests/.rspec
 - lib/generators/react_on_rails/templates/dev_tests/spec/features/hello_world_spec.rb

data/lib/generators/react_on_rails/templates/base/base/client/node/package.json

@@ -1,10 +0,0 @@
-{
-    "name": "react_on_rails_node",
-    "version": "0.0.0",
-    "private": true,
-    "scripts": {
-        "start": "node ./server.js -s webpack-bundle.js"
-    },
-    "dependencies": {
-    }
-}

data/lib/generators/react_on_rails/templates/base/base/client/node/server.js

@@ -1,82 +0,0 @@
-var net = require('net');
-var fs = require('fs');
-
-var bundlePath = '../../app/assets/webpack/';
-var bundleFileName = 'webpack-bundle.js';
-
-var currentArg;
-
-function Handler() {
-  this.queue = [];
-  this.initialized = false;
-}
-
-Handler.prototype.handle = function (connection) {
-  var callback = function () {
-    connection.setEncoding('utf8');
-    connection.on('data', (data)=> {
-      console.log('Processing request: ' + data);
-      var result = eval(data);
-      connection.write(result);
-    });
-  };
-
-  if (this.initialized) {
-    callback();
-  } else {
-    this.queue.push(callback);
-  }
-};
-
-Handler.prototype.initialize = function () {
-  console.log('Processing ' + this.queue.length + ' pending requests');
-  var callback;
-  while (callback = this.queue.pop()) {
-    callback();
-  }
-
-  this.initialized = true;
-};
-
-var handler = new Handler();
-
-process.argv.forEach((val) => {
-  if (val[0] == '-') {
-    currentArg = val.slice(1);
-    return;
-  }
-
-  if (currentArg == 's') {
-    bundleFileName = val;
-  }
-});
-
-try {
-  fs.mkdirSync(bundlePath);
-} catch (e) {
-  if (e.code != 'EEXIST') throw e;
-}
-
-fs.watchFile(bundlePath + bundleFileName, (curr) => {
-  if (curr && curr.blocks && curr.blocks > 0) {
-    if (handler.initialized) {
-      console.log('Reloading server bundle must be implemented by restarting the node process!');
-      return;
-    }
-
-    require(bundlePath + bundleFileName);
-    console.log('Loaded server bundle: ' + bundlePath + bundleFileName);
-    handler.initialize();
-  }
-});
-
-var unixServer = net.createServer(function (connection) {
-  handler.handle(connection);
-});
-
-unixServer.listen('node.sock');
-
-process.on('SIGINT', () => {
-  unixServer.close();
-  process.exit();
-});

data/lib/generators/react_on_rails/templates/base/base/lib/tasks/assets.rake.tt

@@ -1,23 +0,0 @@
-# lib/tasks/assets.rake
-# The webpack task must run before assets:environment task.
-# Otherwise Sprockets cannot find the files that webpack produces.
-# This is the secret sauce for how a Heroku deployment knows to create the webpack generated JavaScript files.
-Rake::Task["assets:precompile"]
-  .clear_prerequisites
-  .enhance(["assets:compile_environment"])
-
-namespace :assets do
-  # In this task, set prerequisites for the assets:precompile task
-  task compile_environment: :webpack do
-    Rake::Task["assets:environment"].invoke
-  end
-
-  desc "Compile assets with webpack"
-  task :webpack do
-    sh "cd client && npm run build:production"
-  end
-
-  task :clobber do
-    rm_r Dir.glob(Rails.root.join("app/assets/webpack/*"))
-  end
-end

data/lib/generators/react_on_rails/templates/base/base/lib/tasks/load_test.rake

@@ -1,8 +0,0 @@
-namespace :load_test do
-  desc "Load test with apache benchmark"
-  task :run, [:url, :count] do |_, args|
-    url = args[:url] || "http://localhost:3000/hello_world"
-    count = args[:count] || 500
-    system("ab -c 10 -n #{count} #{url}")
-  end
-end