react_on_rails 6.4.0 → 6.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6a4f8bdac2245e1f3a17da6fd63341e9ce892b36
-  data.tar.gz: 18f926d01a9634607fa41e217c0981b751ed6dbd
+  metadata.gz: 94e59e11d5830cb4add6aa9d4c4dfff86075eda1
+  data.tar.gz: 0aed8a351e8ad6701c91e6b802a9b63d3aa04e3f
 SHA512:
-  metadata.gz: 3c38887fd29781c9342661fc2f3a88cd50fa494610d1aed43342e0b0522d84762ebc1a0aa3b176a75fbec61a149ab6ee7f9c700ba4f109d2ee0d66091f8fa494
-  data.tar.gz: d5cdcc84850799bea50d3d346a45dbbdb6627cb409138e6c0ec4ebbca2f8720018fa35cfac24fccbf5053b8822635d2d4e0a2580f266e68d61bf17b14f5df75e
+  metadata.gz: a50c9626b05fbbb4c10b10941dbff6e3168979fb4d9ef6843552557f041260e95d11ae9e3fd0d7a8983ad37bde8c779b408fc87e506a633d28ab24a7a25fd0e1
+  data.tar.gz: b8226192b451b6701d4f788fcfbf01a6eb9516302112d9156ef046f9a7563f7ae291c84140e921bb4b10fd8f9d0a0e5295caa836164b38b5e85aee17df6ffc3e

data/CHANGELOG.md

@@ -8,6 +8,9 @@ Contributors: please follow the recommendations outlined at [keepachangelog.com]
 
 ## [6.4.0] - 2017-1-12
 
+### Possible Breaking Change
+- Since foreman is no longer a dependency of the React on Rails gem, please run `gem install foreman`. If you are using rvm, you may wish to run `rvm @global do gem install foreman` to install foreman for all your gemsets. 
+
 ### Fixed
 - Removed foreman as a dependency. [#678](https://github.com/shakacode/react_on_rails/pull/678) by [x2es](https://github.com/x2es).
 

data/CONTRIBUTING.md

@@ -176,6 +176,13 @@ npm test
 
 ```sh
 cd spec/dummy
+rspec
+```
+
+Eventually, we may have JS tests:
+
+```sh
+cd spec/dummy/client
 npm run test
 ```
 

data/README.md

@@ -119,9 +119,9 @@ We're definitely not doing that. With react_on_rails, webpack is mainly generati
   bundle && npm install
   ```
 
-6. Start your Rails server:
+6. Ensure that you have `foreman` installed: `gem install foreman`.
 
-  with foreman installed (`gem install foreman`)
+7. Start your Rails server:
 
   ```bash
   foreman start -f Procfile.dev
@@ -217,7 +217,7 @@ On production deployments that use asset precompilation, such as Heroku deployme
 If you have used the provided generator, these bundles will automatically be added to your `.gitignore` to prevent extraneous noise from re-generated code in your pull requests. You will want to do this manually if you do not use the provided generator.
 
 ### Rails Context
-When you use a "generator function" to create react components or you used shared redux stores, you get 2 params passed to your function:
+When you use a "generator function" to create react components (or renderedHtml on the server) or you used shared redux stores, you get 2 params passed to your function:
 
 1. Props that you pass in the view helper of either `react_component` or `redux_store`
 2. Rails contextual information, such as the current pathname. You can customize this in your config file.
@@ -318,6 +318,8 @@ If you do want different code to run, you'd setup a separate webpack compilation
 #### Generator Functions
 Why would you create a function that returns a React component? For example, you may want the ability to use the passed-in props to initialize a redux store or setup react-router. Or you may want to return different components depending on what's in the props. ReactOnRails will automatically detect a registered generator function.
 
+Another reason to user a generator function is that sometimes in server rendering, specifically with React Router, you need to return the result of calling ReactDOMServer.renderToString(element). You can do this by returning an object with the following shape: { renderedHtml, redirectLocation, error }.
+
 #### Renderer Functions
 A renderer function is a generator function that accepts three arguments: `(props, railsContext, domNodeId) => { ... }`. Instead of returning a React component, a renderer is responsible for calling `ReactDOM.render` to manually render a React component into the dom. Why would you want to call `ReactDOM.render` yourself? One possible use case is [code splitting](docs/additional-reading/code-splitting.md).
 
@@ -340,7 +342,7 @@ react_component(component_name,
                 html_options: {})
 ```
 
-+ **component_name:** Can be a React component, created using a ES6 class, or `React.createClass`, a generator function that returns a React component, or a renderer function that manually renders a React component to the dom (client side only).
++ **component_name:** Can be a React component, created using a ES6 class, or `React.createClass`, a generator function that returns a React component (or only on the server side, an object with shape { redirectLocation, error, renderedHtml }), or a renderer function that manually renders a React component to the dom (client side only).
 + **options:**
   + **props:** Ruby Hash which contains the properties to pass to the react object, or a JSON string. If you pass a string, we'll escape it for you.
   + **prerender:** enable server-side rendering of component. Set to false when debugging!

data/docs/additional-reading/heroku-deployment.md

@@ -5,6 +5,9 @@ The generator has created the necessary files and gems for deployment to Heroku.
 + `12factor` gem: required by Heroku if using a version before Rails 5 (see their [README](https://github.com/heroku/rails_12factor#rails-5) for more information if upgrading from a lower version)
 + `'puma'` gem: recommended Heroku webserver
 + `config/puma.rb`: Puma webserver config file
++ `/package.json`: Top level package.json which must contain `"scripts": { "postinstall": "cd client && npm install" }`
+
+If you want to see an updated example deployed to Heroku, please visit the [github.com/shakacode/react-webpack-rails-tutorial](https://github.com/shakacode/react-webpack-rails-tutorial).
 
 ## More details on precompilation using webpack to create JavaScript assets
 This is how the rake task gets modified. You should be able to call `clear_prerequisites` and setup your own custom precompile if needed.

data/docs/additional-reading/react-router.md

@@ -46,3 +46,68 @@ For a fleshed out integration of react_on_rails with react-router, check out [Re
 * [react-webpack-rails-tutorial/client/app/bundles/comments/startup/ClientRouterApp.jsx](https://github.com/shakacode/react-webpack-rails-tutorial/blob/master/client/app/bundles/comments/startup/ClientRouterApp.jsx)
 
 * [react-webpack-rails-tutorial/client/app/bundles/comments/startup/ServerRouterApp.jsx](https://github.com/shakacode/react-webpack-rails-tutorial/blob/master/client/app/bundles/comments/startup/ServerRouterApp.jsx)
+
+
+# Server Rendering Using React Router V4
+
+Your generator function may not return an object with the property `renderedHtml`. Thus, you call 
+renderToString() and return an object with this property.
+
+This example **only applies to server rendering** and should be only used in the server side bundle.
+
+From the [original example in the ReactRouter docs](https://react-router.now.sh/ServerRouter)
+ 
+```javascript
+   import React from 'react'
+   import { renderToString } from 'react-dom/server'
+   import { ServerRouter, createServerRenderContext } from 'react-router'
+   
+   const ReactRouterComponent = (props, railsContext) => {
+   
+     // first create a context for <ServerRouter>, it's where we keep the
+     // results of rendering for the second pass if necessary
+     const context = createServerRenderContext()
+     const { location } = railsContext;
+
+     // render the first time
+     let markup = renderToString(
+       <ServerRouter
+         location={location}
+         context={context}
+       >
+         <App/>
+       </ServerRouter>
+     )
+   
+     // get the result
+     const result = context.getResult()
+   
+     // the result will tell you if it redirected, if so, we ignore
+     // the markup and send a proper redirect.
+     if (result.redirect) {
+       return { 
+         redirectLocation: result.redirect.pathname 
+       };
+     } else {
+   
+       // the result will tell you if there were any misses, if so
+       // we can send a 404 and then do a second render pass with
+       // the context to clue the <Miss> components into rendering
+       // this time (on the client they know from componentDidMount)
+       if (result.missed) {
+         // React on Rails does not support the 404 status code for the browser.  
+         // res.writeHead(404)
+         
+         markup = renderToString(
+           <ServerRouter
+             location={location}
+             context={context}
+           >
+             <App/>
+           </ServerRouter>
+         )
+       }
+       return { renderedHtml: markup };
+     }
+  }
+```

data/docs/api/javascript-api.md

@@ -4,7 +4,9 @@ The best source of docs is the main [ReactOnRails.js](../../node_package/src/Rea
 ```js
   /**
    * Main entry point to using the react-on-rails npm package. This is how Rails will be able to
-   * find you components for rendering.
+   * find you components for rendering. Components get called with props, or you may use a
+   * "generator function" to return a React component or an object with the following shape:
+   * { renderedHtml, redirectLocation, error }. 
    * @param components (key is component name, value is component)
    */
   register(components)

data/lib/react_on_rails/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module ReactOnRails
-  VERSION = "6.4.0".freeze
+  VERSION = "6.4.1".freeze
 end

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-on-rails",
-  "version": "6.4.0",
+  "version": "6.4.1",
   "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.4.0
+  version: 6.4.1
 platform: ruby
 authors:
 - Justin Gordon
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-13 00:00:00.000000000 Z
+date: 2017-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool