react_on_rails 6.4.2 → 6.5.0.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cc9ce8dfafb075ba679a34c960037df7c61746ff
-  data.tar.gz: 35d775a65518d91e1b46733758cdf9883c52b6ac
+  metadata.gz: 66dd313d68c7587349dba811710050bd0b68c065
+  data.tar.gz: 8593a20efabecdc8b53ab2ab868a7a5a22e2c5e5
 SHA512:
-  metadata.gz: 8e6c98e563102e792da954e116ef75e7774c13698c970be417869d667364e0bfa604b4e815eb9e22f9e87540e897da7988bd3823ec98836c98846e763195081e
-  data.tar.gz: d675c0ad865f9edd283ba64344e2912cceac4ec50720c6f00c676a8e1d458ad5363cefa86f1f7adcac9847613215fae47701bb7e090b786cbf4bfa31710b7c97
+  metadata.gz: f70c7504fc02efd692bef39cd628bb7bff67ad69c56d18d6e2b1da6e5abdfff5d41ab678754626f11ebb3be2bc18a7e6d6d7ad39ed0c7aec3a87788134722392
+  data.tar.gz: 1f986e7e885762669dbdb3ef802d246989daafb3b0bbdcaef59cae15846e7a08aa17d73f7a673dc71f769fe04f9881ca9ada7700d27095a9b2a03006dce4acaa

data/CHANGELOG.md

@@ -6,17 +6,10 @@ Contributors: please follow the recommendations outlined at [keepachangelog.com]
 ## [Unreleased]
 *Please add entries here for your pull requests.*
 
-## [6.4.2] - 2017-1-17
-### Fixed
-- Added OS detection for install generator, system call for Windows and unit-tests for it. [#666](https://github.com/shakacode/react_on_rails/pull/666) by [GeorgeGorbanev](https://github.com/GeorgeGorbanev).
-
-## [6.4.1] - 2017-1-17
-No changes.
-
 ## [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.
+- 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).
@@ -435,9 +428,7 @@ Best done with Object destructing:
 ##### Fixed
 - Fix several generator related issues.
 
-[Unreleased]: https://github.com/shakacode/react_on_rails/compare/6.4.2...master
-[6.4.2]: https://github.com/shakacode/react_on_rails/compare/6.4.1...6.4.2
-[6.4.1]: https://github.com/shakacode/react_on_rails/compare/6.4.0...6.4.1
+[Unreleased]: https://github.com/shakacode/react_on_rails/compare/6.4.0...master
 [6.4.0]: https://github.com/shakacode/react_on_rails/compare/6.3.5...6.4.0
 [6.3.5]: https://github.com/shakacode/react_on_rails/compare/6.3.4...6.3.5
 [6.3.4]: https://github.com/shakacode/react_on_rails/compare/6.3.3...6.3.4

data/README.md

@@ -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/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/generators/react_on_rails/install_generator.rb

@@ -64,7 +64,7 @@ module ReactOnRails
       end
 
       def missing_npm?
-        return false unless ReactOnRails::Utils.running_on_windows? ? `where npm`.blank? : `which npm`.blank?
+        return false unless `which npm`.blank?
         error = "npm is required. Please install it before continuing. "
         error << "https://www.npmjs.com/"
         GeneratorMessages.add_error(error)
@@ -72,7 +72,7 @@ module ReactOnRails
       end
 
       def missing_node?
-        return false unless ReactOnRails::Utils.running_on_windows? ? `where node`.blank? : `which node`.blank?
+        return false unless `which node`.blank?
         error = "** nodejs is required. Please install it before continuing. "
         error << "https://nodejs.org/en/"
         GeneratorMessages.add_error(error)

data/lib/react_on_rails/utils.rb

@@ -20,10 +20,6 @@ module ReactOnRails
                 ReactOnRails.configuration.server_bundle_js_file)
     end
 
-    def self.running_on_windows?
-      (/cygwin|mswin|mingw|bccwin|wince|emx/ =~ RUBY_PLATFORM) != nil
-    end
-
     module Required
       def required(arg_name)
         raise ArgumentError, "#{arg_name} is required"

data/lib/react_on_rails/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module ReactOnRails
-  VERSION = "6.4.2".freeze
+  VERSION = "6.5.0.beta.1".freeze
 end

data/package.json

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: react_on_rails
 version: !ruby/object:Gem::Version
-  version: 6.4.2
+  version: 6.5.0.beta.1
 platform: ruby
 authors:
 - Justin Gordon
@@ -445,9 +445,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.8