react_on_rails 11.3.0 → 12.0.0.pre.beta.4

data/Rakefile

@@ -3,8 +3,6 @@
 # Rake will automatically load any *.rake files inside of the "rakelib" folder
 # See rakelib/
 
-require_relative "./spec/react_on_rails/support/rails32_helper"
-
 tasks = %w[run_rspec lint]
 prepare_for_ci = %w[node_package dummy_apps]
 
@@ -14,11 +12,6 @@ if ENV["USE_COVERALLS"] == "TRUE"
   tasks << "coveralls:push"
 end
 
-if using_rails32?
-  tasks = %w[run_rspec:gem_rails32 run_rspec:dummy_no_webpacker]
-  prepare_for_ci = %w[node_package dummy_apps:dummy_no_webpacker]
-end
-
 desc "Run all tests and linting"
 task default: tasks
 

data/SUMMARY.md

@@ -5,11 +5,11 @@
 ## **Basics**
   + [React on Rails Basic Installation Tutorial](./docs/tutorial.md)
   + [Webpack Configuration](./docs/basics/webpack-configuration.md)
-  + [How React on Rails Works](./docs/basics/how-react-on-rails-works.md)
+  + [How React on Rails Works](docs/outdated/how-react-on-rails-works.md)
   + [Client vs. Server Rendering](./docs/basics/client-vs-server-rendering.md)
   + [React Server Rendering](./docs/basics/react-server-rendering.md)
   + [Recommended Project Structure](./docs/basics/recommended-project-structure.md)
-  + [Generator Functions and the RailsContext](docs/basics/generator-functions-and-railscontext.md)
+  + [Render-Functions and the RailsContext](docs/basics/render-functions-and-railscontext.md)
   + [Caching and Performance: React on Rails Pro](https://github.com/shakacode/react_on_rails/wiki).
   + [Deployment](docs/basics/deployment.md).
   + [React on Rails Internationalization (I18n, localization)](docs/basics/i18n.md)
@@ -26,35 +26,31 @@
   + [Migration from react-rails](./docs/basics/migrating-from-react-rails.md)
   + [Generator Details](docs/basics/generator-details.md)
   + [Updating Dependencies](./docs/additional-reading/updating-dependencies.md)
-  + [Manual Installation Overview](docs/misc-pending/manual-installation-overview.md)
+  + [Manual Installation Overview](docs/outdated/manual-installation-overview.md)
   + [Upgrading from rails/webpacker v3 to v4](docs/additional-reading/upgrade-webpacker-v3-to-v4.md)
   
 ## **Rails**
   + [Rails Engine Integration](./docs/additional-reading/rails-engine-integration.md)
   + [Rails View Rendering from Inline JavaScript](./docs/additional-reading/rails_view_rendering_from_inline_javascript.md)
   + [Turbolinks](./docs/additional-reading/turbolinks.md)
-  + [Rails Assets](docs/misc-pending/rails-assets.md)
   + [Converting a Rails 5 API only app to a Rails app](./docs/additional-reading/convert-rails-5-api-only-app.md)
 
 ## **Javascript**
   + [Node Dependencies, NPM, and Yarn](./docs/additional-reading/node-dependencies-and-npm.md)
-  + [Babel](./docs/additional-reading/babel.md)
   + [React Router](./docs/additional-reading/react-router.md)
   + [React & Redux](./docs/additional-reading/react-and-redux.md)
   + [Webpack Tips](./docs/additional-reading/webpack.md)
   + [Server Rendering Tips](./docs/additional-reading/server-rendering-tips.md)
-  + [Code Splitting](docs/misc-pending/code-splitting.md)
+  + [Code Splitting](docs/outdated/code-splitting.md)
   + [AngularJS Integration and Migration to React on Rails](./docs/additional-reading/angular-js-integration-migration.md)
 
 ## **Deployment**
-  + [Heroku Deployment](./docs/additional-reading/heroku-deployment.md)
+  + [Heroku Deployment](docs/basics/heroku-deployment.md)
   + [Elastic Beanstalk Deployment](./docs/additional-reading/elastic-beanstalk.md)
 
-## Older, Non-Webpack Docs
-  + [Setting up Hot Reloading during Rails Development, API docs](./docs/api/ruby-api-hot-reload-view-helpers.md)
+## Outdated Non-Webpack Docs
   + [Developing with the Webpack Dev Server](./docs/additional-reading/webpack-dev-server.md)
-  + [Webpack, the Asset Pipeline, and Using Assets w/ React](./docs/additional-reading/rails-assets-relative-paths.md)
-  + [Hot Reloading of Assets For Rails Development for Asset Pipeline](docs/additional-reading/hot-reloading-rails-development-asset-pipeline.md)
+  + [Webpack, the Asset Pipeline, and Using Assets w/ React](./docs/outdated/rails-assets-relative-paths.md)
 
 ## **[CONTRIBUTING](CONTRIBUTING.md)**
   + [Generator Testing](./docs/contributor-info/generator-testing.md)

data/book.json

@@ -7,12 +7,12 @@
       "url": "https://github.com/shakacode/react_on_rails/"
     },
     "sharing": {
-      "facebook":   true,
-      "twitter":    true,
-      "google":     true,
-      "weibo":      true,
+      "facebook": true,
+      "twitter": true,
+      "google": true,
+      "weibo": true,
       "instapaper": true,
-      "vk":         true
+      "vk": true
     }
   }
 }

data/docs/additional-reading/asset-pipeline.md

@@ -1,20 +1,12 @@
-# Asset Pipeline
+# Asset Pipeline with React on Rails
 
-The plumbing of webpack produced assets through the asset pipeline is deprecated as of v9.0.
+In general, you should not be mixing the asset pipeline with rails/webpacker and React on Rails.
 
-The information in this document is here for those that have not yet upgraded.
+If you're using React, then all of your CSS and images should be under either `/client` or
+`/app/javascript` or wherever you want your client side application.
 
+If you are incrementally migrating a large application, your main concern will be how to minimize
+duplication of styles and images between your old application and the new one.
 
-
-
-This option still works for your `/config/initializers/react_on_rails.rb` if you are still using the
-asset pipeline.
-```
-  ################################################################################
-  # MISCELLANEOUS OPTIONS
-  ################################################################################
-  # If you want to use webpack for CSS and images, and still use the asset pipeline,
-  # see https://github.com/shakacode/react_on_rails/blob/master/docs/additional-reading/rails-assets.md
-  # And you will use a setting like this.
-  config.symlink_non_digested_assets_regex = /\.(png|jpg|jpeg|gif|tiff|woff|ttf|eot|svg|map)/
-```
+Please email [justin@shakacode.com](mailto:justin@shakacode.com) if you would be interested in help
+to migrate a larger application.

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

@@ -1,12 +1,13 @@
 # Using React Helmet to build `<head>` content
 
 ## Installation and general usage
-See https://github.com/nfl/react-helmet for details. Run `yarn add react-helmet` in your `client` directory to add this package to your application.
+See [nfl/react-helmet](https://github.com/nfl/react-helmet) for details on how to use this package.
+Run `yarn add react-helmet` to add this package to your application.
 
 ## Example
 Here is what you need to do in order to configure your Rails application to work with **ReactHelmet**.
 
- Create generator function for server rendering like this:
+ Create a render-function for server rendering like this:
 
 ```javascript
 export default (props, _railsContext) => {
@@ -20,17 +21,35 @@ export default (props, _railsContext) => {
   return { renderedHtml };
 };
 ```
-You can add more **helmet** properties to result, e.g. **meta**, **base** and so on. See https://github.com/nfl/react-helmet#server-usage.
+You can add more **helmet** properties to the result, e.g. **meta**, **base** and so on. See https://github.com/nfl/react-helmet#server-usage.
 
-Use regular component or generator function for client-side:
+Use a regular React functional or class component or a render-function for your client-side bundle:
 
 ```javascript
-export default (props, _railsContext) => (
+// React functional component
+export default (props) => (
   <App {...props} />
 );
 ```
 
-Put **ReactHelmet** component somewhere in your `<App>`:
+Or a render-function. Note you can't return just the JSX (React element), but you need to return
+either a React functional or class component.
+```javascript
+// React functional component
+export default (props, railsContext) => (
+  () => <App {{railsContext, ...props}} />
+);
+```
+
+Note, this doesn't work, because this function just returns a React element rather than a React component
+```javascript
+// React functional component
+export default (props, railsContext) => (
+  <App {{railsContext, ...props}} />
+);
+```
+
+Put the **ReactHelmet** component somewhere in your `<App>`:
 ```javascript
 import { Helmet } from 'react-helmet';
 
@@ -55,15 +74,18 @@ ReactOnRails.register({
 });
 ```
 ```javascript
+// Note the import from the server file.
 import ReactHelmetApp from '../ReactHelmetServerApp';
 
 ReactOnRails.register({
   ReactHelmetApp
 });
 ```
-Now when the `react_component_hash` helper is called with **"ReactHelmetApp"** as a first argument it will return a hash instead of HTML string:
+Now when the `react_component_hash` helper is called with **"ReactHelmetApp"** as a first argument it
+will return a hash instead of HTML string. Note, there is no need to specify "prerender" as it would not
+make sense to use react_component_hash without server rendering:
 ```ruby
-<% react_helmet_app = react_component_hash("ReactHelmetApp", prerender: true, props: { hello: "world" }, trace: true) %>
+<% react_helmet_app = react_component_hash("ReactHelmetApp", props: { hello: "world" }, trace: true) %>
 
 <% content_for :title do %>
   <%= react_helmet_app['title'] %>
@@ -76,5 +98,3 @@ So now we're able to insert received title tag to our application layout:
 ```ruby
  <%= yield(:title) if content_for?(:title) %>
 ```
-
-Note: Use of `react_component` for this functionality is deprecated. Please use `react_component_hash` instead.

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

@@ -1,39 +1,28 @@
+_This article needs updating for the latest version of React Router_
+
 # Using React Router
 
-React on Rails supports the use of React Router. Client-side code doesn't need any special configuration for the React on Rails gem. Implement React Router how you normally would. Note, you might want to avoid using Turbolinks as both Turbolinks and React-Router will be trying to handle the back and forward buttons. If you get this figured out, please do share with the community! Otherwise, you might have to tweak the basic settings for Turbolinks, and this may or may not be worth the effort.
 
-When attempting to use server-rendering, it is necessary to take steps that prevent rendering when there is a router error or redirect. In these cases, the client code should return an object containing the `error` and a `redirectLocation` instead of the React component. The `react_component` helper method in your Rails view will automatically detect that there was an error/redirect and handle it accordingly.
+React on Rails supports the use of React Router. Client-side code doesn't need any special configuration for the React on Rails gem. Implement React Router how you normally would. Note, you might want to avoid using Turbolinks as both Turbolinks and React-Router will be trying to handle the back and forward buttons. If you get this figured out, please do share with the community! Otherwise, you might have to tweak the basic settings for Turbolinks, and this may or may not be worth the effort.
 
 If you are working with the HelloWorldApp created by the react_on_rails generator, then the code below corresponds to the module in `client/app/bundles/HelloWorld/startup/HelloWorldApp.jsx`.
 
 ```js
+
+import { BrowserRouter, Switch } from 'react-router-dom'
+import routes from './routes.jsx'
+
 const RouterApp = (props, railsContext) => {
-  let error;
-  let redirectLocation;
-  let routeProps;
-  const { location } = railsContext;
-  
   // create your hydrated store
   const store = createStore(props);
-
-  // See https://github.com/reactjs/react-router/blob/master/docs/guides/ServerRendering.md
-  match({ routes, location }, (_error, _redirectLocation, _routeProps) => {
-    error = _error;
-    redirectLocation = _redirectLocation;
-    routeProps = _routeProps;
-  });
-
-  // This tell react_on_rails to skip server rendering any HTML. Note, client rendering
-  // will handle the redirect. What's key is that we don't try to render.
-  // Critical to return the Object properties to match this { error, redirectLocation }
-  if (error || redirectLocation) {
-    return { error, redirectLocation };
-  }
-
-  // Important that you don't do this if you are redirecting or have an error.
+  
   return (
     <Provider store={store}>
-      <RouterContext {...routeProps} />
+      <BrowserRouter>
+        <Switch>
+          {routes}
+        </Switch>
+      </BrowserRouter>
     </Provider>
   );
 };
@@ -50,64 +39,52 @@ For a fleshed out integration of react_on_rails with react-router, check out [Re
 
 # Server Rendering Using React Router V4
 
-Your generator function may not return an object with the property `renderedHtml`. Thus, you call 
+Your render 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)
+From the [original example in the ReactRouter docs](https://github.com/ReactTraining/react-router/blob/v4.3.1/packages/react-router-dom/docs/guides/server-rendering.md)
  
 ```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 };
-     }
+   import { StaticRouter } from 'react-router'
+   import { Provider } from 'react-redux'
+   import ReactOnRails from 'react-on-rails'
+
+   // App.jsx from src/client/App.jsx
+   import App from '../App'
+
+   const ReactServerRenderer = (props, railsContext) => {
+      const context = {}
+
+      // commentStore from src/server/store/commentStore
+      const store = ReactOnRails.getStore('../store/commentStore')
+
+      // Route Store generated from react-on-rails
+      
+      const { location } = railsContext
+
+      const html = ReactDOMServer.renderToString(
+        <Provider store={store}>
+          <StaticRouter
+            location={location}
+            context={context}
+            props={props}
+          >
+            <App />
+          </StaticRouter>
+        </ Provider>
+        )
+
+        if (context.url) {
+          // Somewhere a `<Redirect>` was rendered
+          redirect(301, context.url)
+        } else {
+          // we're good, send the response
+          return { renderedHtml: html };
+        }
+    }
   }
 ```

data/docs/additional-reading/server-rendering-tips.md

@@ -1,14 +1,19 @@
 # Server Rendering Tips
 
-Be sure to use mini_racer. See [issues/428](https://github.com/shakacode/react_on_rails/issues/428)
+For the best performance with Server Rendering, consider using [React on Rails Pro]
+
+Be sure to use mini_racer. See [issues/428](https://github.com/shakacode/react_on_rails/issues/428).
+
+
 
 ## General Tips
-- Your code can't reference `document`. Server side JS execution does not have access to `document`, so jQuery and some
-  other libs won't work in this environment. You can debug this by putting in `console.log`
-  statements in your code.
-- You can conditionally avoid running code that references document by passing in a boolean prop to your top level react
-  component. Since the passed in props Hash from the view helper applies to client and server side code, the best way to
-  do this is to use a generator function.
+- Your code can't reference `document`. Server side JS execution does not have access to `document`,
+  so jQuery and some other libs won't work in this environment. You can debug this by putting in
+  `console.log` statements in your code.
+- You can conditionally avoid running code that references document by either checking if `window`
+  is defined or using the "railsContext" 
+  your top level react component. Since the passed in props Hash from the view helper applies to
+  client and server side code, the best way to do this is to use a render function.
 - If you're serious about server rendering, it's worth the effort to have different entry points for client and server rendering. It's worth the extra complexity. The point is that you have separate files for top level client or server side, and you pass some extra option indicating that rendering is happening server side.
 - You can enable Node.js server rendering via [React on Rails Pro](https://github.com/shakacode/react_on_rails/wiki).
 

data/docs/api/javascript-api.md

@@ -25,10 +25,10 @@ The best source of docs is the main [ReactOnRails.js](https://github.com/shakaco
   /**
    * Main entry point to using the react-on-rails npm package. This is how Rails will be able to
    * 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:
+   * "render function" to return a React component or an object with the following shape:
    * { renderedHtml, redirectLocation, error }.
-   * For server rendering, if you wish to return multiple HTML strings from a generator function,
-   * you may return an Object from your generator function with a single top level property of
+   * For server rendering, if you wish to return multiple HTML strings from a render function,
+   * you may return an Object from your render function with a single top level property of
    * renderedHtml. Inside this Object, place a key called componentHtml, along with any other
    * needed keys. This is useful when you using side effects libraries like react helmet.
    * Your Ruby code with get this Object as a Hash containing keys componentHtml and any other

data/docs/api/redux-store-api.md

@@ -1,8 +1,10 @@
 # Redux Store
 
-First things first. You don't need to use the `redux_store` api to use redux. This api was setup to support multiple calls to `react_component` on one page that all talk to the same redux store.
+_This redux API is no longer recommended as it prevents dynamic code splitting for performance. Instead, you should use the standard react_component view helper passing in a "render function."_
 
-If you are only rendering one react component on a page, as is typical to do a "Single Page App" in React, then you should _probably_ pass the props to your React component in a "generator function."
+You don't need to use the `redux_store` api to use redux. This api was setup to support multiple calls to `react_component` on one page that all talk to the same redux store.
+
+If you are only rendering one react component on a page, as is typical to do a "Single Page App" in React, then you should _probably_ pass the props to your React component in a "render function."
 
 Consider using the `redux_store` helper for the two following use cases:
 

data/docs/api/view-helpers-api.md

@@ -22,7 +22,7 @@ Uncommonly used options:
   id: nil,
 ```
 
-- **component_name:** Can be a React component, created using an ES6 class or 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).
+- **component_name:** Can be a React component, created using an ES6 class or a render 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).
   All options except `props, id, html_options` will inherit from your `react_on_rails.rb` initializer, as described [here](../basics/configuration.md).
 - **general 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.
@@ -45,7 +45,7 @@ adding meta-tags to a page. It is exactly like react_component except for the fo
 
 1. `prerender: true` is automatically added to options, as this method doesn't make sense for 
    client only rendering.
-2. Your JavaScript generator function for server rendering must return an Object rather than a React Component.
+2. Your JavaScript render function for server rendering must return an Object rather than a React Component.
 3. Your view code must expect an object and not a string.
 
 Here is an example of ERB view code:
@@ -73,7 +73,6 @@ export default (props, _railsContext) => {
   };
   return { renderedHtml };
 };
-
 ```
 
 ------------
@@ -99,11 +98,11 @@ You can call `rails_context` or `rails_context(server_side: true|false)` from yo
 
 ### Renderer Functions (function that will call ReactDOM.render or ReactDOM.hydrate)
 
-A "renderer function" is a generator function that accepts three arguments (rather than 2): `(props, railsContext, domNodeId) => { ... }`. Instead of returning a React component, a renderer is responsible for installing a callback that will call `ReactDOM.render` (in React 16+, `ReactDOM.hydrate`) to render a React component into the DOM. The "renderer function" is called at the same time the document ready event would instantate the React components into the DOM.
+A "renderer function" is a render function that accepts three arguments (rather than 2): `(props, railsContext, domNodeId) => { ... }`. Instead of returning a React component, a renderer is responsible for installing a callback that will call `ReactDOM.render` (in React 16+, `ReactDOM.hydrate`) to render a React component into the DOM. The "renderer function" is called at the same time the document ready event would instantate the React components into the DOM.
 
-Why would you want to call `ReactDOM.hydrate` yourself? One possible use case is [code splitting](../misc-pending/code-splitting.md). In a nutshell, you don't want to load the React component on the DOM node yet. So you want to install some handler that will call `ReactDOM.hydrate` at a later time. In the case of code splitting with server rendering, the server rendered code has any async code loaded and used to server render. Thus, the client code must also fully load any asynch code before server rendering. Otherwise, the client code would first render partially, not matching the server rendering, and then a second later, the full code would render, resulting in an unpleasant flashing on the screen.
+Why would you want to call `ReactDOM.hydrate` yourself? One possible use case is [code splitting](docs/outdated/code-splitting.md). In a nutshell, you don't want to load the React component on the DOM node yet. So you want to install some handler that will call `ReactDOM.hydrate` at a later time. In the case of code splitting with server rendering, the server rendered code has any async code loaded and used to server render. Thus, the client code must also fully load any asynch code before server rendering. Otherwise, the client code would first render partially, not matching the server rendering, and then a second later, the full code would render, resulting in an unpleasant flashing on the screen.
 
-Renderer functions are not meant to be used on the server since there's no DOM on the server. Instead, use a generator function. Attempting to server render with a renderer function will throw an error.
+Renderer functions are not meant to be used on the server since there's no DOM on the server. Instead, use a render function. Attempting to server render with a renderer function will throw an error.
 
 ------------
 
@@ -113,7 +112,7 @@ Renderer functions are not meant to be used on the server since there's no DOM o
 
 1. [React on Rails docs for react-router](../additional-reading/react-router.md)
 2. Examples in [spec/dummy/app/views/react_router](../../spec/dummy/app/views/react_router) and follow to the JavaScript code in the [spec/dummy/client/app/startup/ServerRouterApp.jsx](../../spec/dummy/client/app/startup/ServerRouterApp.jsx).
-3. [Code Splitting docs](../misc-pending/code-splitting.md) for information about how to set up code splitting for server rendered routes.
+3. [Code Splitting docs](docs/outdated/code-splitting.md) for information about how to set up code splitting for server rendered routes.
 
 ------------