react_on_rails 11.3.1 → 12.0.0.pre.beta.0

data/.travis.yml

@@ -3,10 +3,10 @@ sudo: required
 language: ruby
 
 rvm:
-  # Rails 5 requires 2.2
   - 2.5.3
-  - 2.6.0
-  - 2.2.10
+  - 2.6.5
+  - 2.7.0
+
 services:
   - docker
 
@@ -18,7 +18,6 @@ cache:
 
 gemfile:
   - spec/dummy/Gemfile
-  - spec/dummy_no_webpacker/Gemfile.rails32
 
 env:
   global:
@@ -35,13 +34,16 @@ before_install:
   - "/sbin/start-stop-daemon --start --quiet --pidfile /tmp/custom_xvfb_99.pid --make-pidfile --background --exec /usr/bin/Xvfb -- :99 -ac -screen scn 1600x1200x16"
 
 install:
-  - travis_retry gem install bundler -v '<2' # Ruby 2.2 and Rails 3.2 & 4.2 depend on bundler 1.x.
-  - travis_retry nvm install 8.11.3
+  - travis_retry gem install bundler -v '>2'
+  - travis_retry nvm install 13.9.0
   - node -v
   - travis_retry npm i -g yarn
   - travis_retry bundle install
+  - travis_retry yarn global add yalc
+  - travis_retry yalc publish
+  - travis_retry cd spec/dummy && yalc add react-on-rails
   - travis_retry yarn
-  - travis_retry yarn run build
+  - travis_retry cd ../.. && yarn run build
   - bundle exec rake prepare_for_ci
 
 before_script:
@@ -50,19 +52,6 @@ before_script:
 script:
   - bundle exec rake
 
-matrix:
-  exclude:
-    - gemfile: spec/dummy_no_webpacker/Gemfile.rails32
-      rvm: 2.3.8
-    - gemfile: spec/dummy_no_webpacker/Gemfile.rails32
-      rvm: 2.4.5
-    - gemfile: spec/dummy_no_webpacker/Gemfile.rails32
-      rvm: 2.5.3
-    - gemfile: spec/dummy_no_webpacker/Gemfile.rails32
-      rvm: 2.6.0
-    - gemfile: spec/dummy/Gemfile
-      rvm: 2.2.10
-
 notifications:
   slack:
     secure: LfcUk4AJ4vAxWwRIyw4tFh8QNbYefMwfG/oLfsN3CdRMWMOtCOHR1GGsRhAOlfVVJ/FvHqVqWj5gK7z7CaO5Uvl7rD3/zJ8QzExKx/iH9yWj55iIPuKLzwFNnBwRpFW/cqyU2lFPPRxGD50BUn3c+qybkuSqtKZ6qtTowwqlxLa5iyM3N95aZp7MEIKCP7cPcnHfLbJyP8wBpotp/rtw62eXM2HIRJJwgjcp+n+My7VFR9DnBXNFf6R91aZHM4U4cHHDbu15HFtH8honVrzK1JQdyqMNHga+j04dFuaS7z9Q369/hsELMOBp/227+Pz7ZRfWZFK4UASguOvyeX7RmGTRpTuWLm1XJeUzfsPZVROecaSVQBve+U7F12yKqilt97QlvRXn2EGyBILqvxtFNNR4S9kgAf72/6EFgiM1TKq7i9zy6lVOnagU2+7amq7UeopX1uoFsUfNKMR7YbgV1WjF0IK95UP0b0/7ZOJlPYgi5zzkQi129qAFWSMmxGk+ZpsttHh/tjJtvAh0A3mHq/zb5w4ub/MbSyZqeDUNgGj72QArOWUFSAStQT1ybsVLeDoKPgOvVq7OV1D64rpcHjBXcqOCit8tDZ+TqkFhcYJo2cITSaqE4zJXn+4F5s7So5O8CyfKYQq+kFJCooYGmfgTUckJpGl7eIvKmL4TN9Q=

data/CHANGELOG.md

@@ -15,28 +15,54 @@ Please follow the recommendations outlined at [keepachangelog.com](http://keepac
 Changes since last non-beta release.
 
 *Please add entries here for your pull requests that are not yet released.*
-### [11.3.1] - 2020-10-01
-#### Fixed
-Update the init per backport of 12.0.3. [PR 1331](https://github.com/shakacode/react_on_rails/pull/1331)
-by [justin808](https://github.com/justin808).
-
-* Should fix issue 1330.
-* Component not loading in Chrome, DOMContentLoaded not called.
-* https://github.com/shakacode/react_on_rails/issues/1330
 
-So  long as the document is not loading, we can assume:
-The document has finished loading and the document has been parsed
-but sub-resources such as images, stylesheets and frames are still loading.
-If lazy asynch loading is used, such as with loadable-components, then the init
-function will install some handler that will properly know when to do hyrdation.
+## UPCOMING 12.0 RELEASE
+### [12.0.0]
+#### BREAKING CHANGE
+In order to solve the issues regarding React Hooks compatibility, the number of parameters
+for functions is used to determine if you have a generator function that will get invoked to
+return a React component, or you are registering a functional React component. Alternately, you can
+set JavaScript property `renderFunction` on the function for which you want to return to be
+invoked to return the React component. In that case, you won't need to pass any unused params.
+[PR 1268](https://github.com/shakacode/react_on_rails/pull/1268) by [justin808](https://github.com/justin808)
+
+See [docs/basics/upgrading-react-on-rails](./docs/basics/upgrading-react-on-rails#upgrading-to-v12)
+for details.         
+
+* Requires the use of rails/webpacker helpers
+* Removed **env_javascript_include_tag** and **env_stylesheet_link_tag** as these are replaced by view helpers
+  from rails/webpacker
+* Removal of support for old Rubies and Rails.
+* Removal of config.symlink_non_digested_assets_regex as it's no longer needed with rails/webpacker.
+  If any business needs this, we can move the code to a separate gem.
+* Added configuration option `same_bundle_for_client_and_server` with default `false` because
+
+  1. Production applications would typically have a server bundle that differs from the client bundle
+  2. This change only affects trying to use HMR with react_on_rails with rails/webpacker. 
+  
+  The previous behavior was to always go to the webpack-dev-server for the server bundle if the 
+  webpack-dev-server was running _and_ the server bundle was found in the `manifest.json`. 
+  
+  If you are using the **same bundle for client and server rendering**, then set this configuration option
+  to `true`. By [justin808](https://github.com/shakacode/react_on_rails/pull/1240).
+  
+* Added support to export locales in JSON format. New option added `i18n_output_format` which allows to
+  specify locales format either `JSON` or `JS`. **`JSON` format is now the default.**
+ 
+  Use this config setting to get the old behavior: config.i18n_output_format = 'js'
+  
+  [PR 1271](https://github.com/shakacode/react_on_rails/pull/1271) by [ashgaliyev](https://github.com/ashgaliyev).
 
+#### Improved
+- Added Typescript definitions to the Node package. By [justin808](https://github.com/justin808) and [judahmeek](https://github.com/judahmeek) in [PR 1287](https://github.com/shakacode/react_on_rails/pull/1287).
+- Removed unnecessary restriction to keep the server bundle in the same directory with the client bundles. Rails/webpacker 4 has an advanced cleanup that will remove any files in the directory of other webpack files. Removing this restriction allows the server bundle to be created in a sibling directory. By [justin808](https://github.com/shakacode/react_on_rails/pull/1240).
 
-### [11.3.0] - 2019-04-20
+### [11.3.0] - 2019-05-24
 #### Added
 - Added method for retrieving any option from `render_options` [PR 1213](https://github.com/shakacode/react_on_rails/pull/1213)
 by [ashgaliyev](https://github.com/ashgaliyev).
 
-- html_options can now has option for 'tag' to add dynamically html element. like this: `html_options: { tag: "span" }`.
+- html_options has an option for 'tag' to set the html tag name like this: `html_options: { tag: "span" }`.
 [PR 1208](https://github.com/shakacode/react_on_rails/pull/1208) by [tahsin352](https://github.com/tahsin352).
 
 ### [11.2.2] - 2018-12-24
@@ -55,9 +81,9 @@ by [ashgaliyev](https://github.com/ashgaliyev).
 #### Changed
 - Changed the default for:
   ```rb
-  config.raise_on_prerender_error = Rails.env.development? 
+  config.raise_on_prerender_error = Rails.env.development?
   ```
-  
+
   Thus, developers will need to fix server rendering errors before continuing.
   [PR 1145](https://github.com/shakacode/react_on_rails/pull/1145) by [justin808](https://github.com/justin808).
 
@@ -887,8 +913,7 @@ Best done with Object destructing:
 ##### Fixed
 - Fix several generator related issues.
 
-[Unreleased]: https://github.com/shakacode/react_on_rails/compare/11.3.1...master
-[11.3.1]: https://github.com/shakacode/react_on_rails/compare/11.3.0...11.3.1
+[Unreleased]: https://github.com/shakacode/react_on_rails/compare/11.3.0...master
 [11.3.0]: https://github.com/shakacode/react_on_rails/compare/11.2.2...11.3.0
 [11.2.2]: https://github.com/shakacode/react_on_rails/compare/11.2.1...11.2.2
 [11.2.1]: https://github.com/shakacode/react_on_rails/compare/11.1.8...11.2.1

data/CONTRIBUTING.md

@@ -1,46 +1,9 @@
 # Tips for Contributors
 
-* See [docs/contributor-info/Releasing](./docs/contributor-info/releasing.md) for instructions on releasing.
+* [docs/contributor-info/Releasing](./docs/contributor-info/releasing.md) for instructions on releasing.
+* [docs/contributor-info/pull-requests](./docs/contributor-info/pull-requests.md)
 * See other docs in [docs/contributor-info](./docs/contributor-info)
 
-## Summary
-
-For non-doc fixes:
-
-* Provide changelog entry in the [unreleased section of the CHANGELOG.md](https://github.com/shakacode/react_on_rails/blob/master/CHANGELOG.md#unreleased).
-* Ensure CI passes and that you added a test that passes with the fix and fails without the fix.
-* Squash all commits down to one with a nice commit message *ONLY* once final review is given. Make sure this single commit is rebased on top of master.
-* Please address all code review comments.
-* Ensure that docs are updated accordingly if a feature is added.
-
-## Commit Messages
-
-From [How to Write a Git Commit Message](http://chris.beams.io/posts/git-commit/)
-
-#### The seven rules of a great git commit message
-> Keep in mind: This has all been said before.
-
-1. Separate subject from body with a blank line
-1. Limit the subject line to 50 characters
-1. Capitalize the subject line
-1. Do not end the subject line with a period
-1. Use the imperative mood in the subject line
-1. Wrap the body at 72 characters
-1. Use the body to explain what and why vs. how
-
-
-## Doc Changes
-
-When making doc changes, we want the change to work on both the gitbook and the regular github site. The issue is that non-doc files will not go to the gitbook site, so doc references to non doc files must use the github URL.
-
-### Links to other docs:
-* When making references to doc files, use a relative URL path like:
-`[Installation Overview](docs/basics/installation-overview.md)`
-
-* When making references to source code files, use a full url path like:
-`[spec/dummy/config/initializers/react_on_rails.rb](https://github.com/shakacode/react_on_rails/tree/master/spec/dummy/config/initializers/react_on_rails.rb)`
-
-
 ## To run tests:
 * After updating code via git, to prepare all examples and run all tests:
 
@@ -91,52 +54,63 @@ gem "react_on_rails", path: "../path-to-react-on-rails"
 
 Note that you will need to bundle install after making this change, but also that **you will need to restart your Rails application if you make any changes to the gem**.
 
-## Testing the Node package for react-on-rails
+## Testing the Node package for react-on-rails via Yalc
 In addition to testing the Ruby parts out, you can also test the node package parts of the gem with an external application. First, be **sure** to build the NPM package:
 
 ```sh
 cd react_on_rails/
 yarn
-yarn run build
-yarn install-react-on-rails
+
+# Update the lib directory with babel compiled files
+yarn run build:watch
 ```
+   
+You need to do this once:
 
-Install the local package by using yarn link, like this:
-```sh
+```
+# Will send the updates to other folders
+yalc publish
+cd spec/dummy
+yalc add react-on-rails
+```
+
+The workflow is:
+1. Make changes to the node package.
+2. We need yalc to push and then run yarn:
+```
+cd <top dir>
+# Will send the updates to other folders
+yalc push
 cd spec/dummy
+
+# Will update from yalc
 yarn
 ```
 
-Note, yarn will run the `postinstall` script of `spec/dummy/client` which runs `yarn link` to set up a sym link to the parent package.
+When you run `yalc push`, you'll get an informative message
 
-#### Example: Testing NPM changes with the dummy app
-1. Add `console.log('Hello!')` [here](https://github.com/shakacode/react_on_rails/blob/master/node_package/src/clientStartup.js#L181) in `react_on_rails/node_package/src/clientStartup.js` to confirm we're getting an update to the node package.
-2. Refresh the browser if the server is already running or start the server using `foreman start` from `react_on_rails/spec/dummy` and navigate to `http://localhost:5000/`. You will now see the `Hello!` message printed in the browser's console.
+```
+✗ yalc push
+react-on-rails@12.0.0-12070fd1 published in store.
+Pushing react-on-rails@12.0.0 in /Users/justin/shakacode/react-on-rails/react_on_rails/spec/dummy
+Package react-on-rails@12.0.0-12070fd1 added ==> /Users/justin/shakacode/react-on-rails/react_on_rails/spec/dummy/node_modules/react-on-rails.
+Don't forget you may need to run yarn after adding packages with yalc to install/update dependencies/bin scripts.
+```
 
-_Note: running `npm i` automatically builds the npm package before installing. However, when using yarn you will need to run `yarn run build` in the root directory before the install script. This will be updated when [yarn issue #2649](https://github.com/yarnpkg/yarn/issues/2649) (above) is resolved._
+#### Example: Testing NPM changes with the dummy app
+1. Add `console.log('Hello!')` to [clientStartup.ts, function render](https://github.com/shakacode/react_on_rails/blob/master/node_package/src/clientStartup.ts in `/node_package/src/clientStartup.js` to confirm we're getting an update to the node package client side. Do the same for function `serverRenderReactComponent` in `/node_package/src/serverRenderReactComponent.ts`.
+2. Refresh the browser if the server is already running or start the server using `foreman start` from `react_on_rails/spec/dummy` and navigate to `http://localhost:5000/`. You will now see the `Hello!` message printed in the browser's console. If you did not see that message, then review the steps above for the workflow of making changes and pushing them via yalc.
 
 # Development Setup for Gem and Node Package Contributors
 
-## Checklist before Committing
-1. `rake`: runs all linters and specs (you need Docker setup, see below)
-2. Did you need any more tests for your change?
-3. Did you document your change? Update the README.md?
-
 ## Dev Initial Setup
 
 ### Prereqs
 After checking out the repo, making sure you have rvm and nvm setup (setup ruby and node), cd to `spec/dummy` and run `bin/setup` to install ruby dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 ### Local Node Package
-Because the example and dummy apps rely on the react-on-rails node package, they should link directly to your local version to pick up any changes you may have made to that package. To achieve this, switch to the dummy app's root directory and run this command below which runs something like [this script](spec/dummy/package.json#L14)
-
-```sh
-cd react_on_rails/spec/dummy
-yarn run install-react-on-rails
-```
-_Note: this runs npm under the hood as explained in **Test NPM for react-on-rails** section above_
 
-From now on, the example and dummy apps will use your local node_package folder as the react-on-rails node package. This will also be done automatically for you via the `rake examples:gen_all` rake task.
+Note, the example and dummy apps will use your local node_package folder as the react-on-rails node package. This will also be done automatically for you via the `rake examples:gen_all` rake task.
 
 *Side note: It's critical to use the alias section of the webpack config to avoid a double inclusion error. This has already been done for you in the example and dummy apps, but for reference:*
 
@@ -182,13 +156,6 @@ cd react_on_rails/spec/dummy
 rspec
 ```
 
-Eventually, we may have JS tests:
-
-```sh
-cd react_on_rails/spec/dummy/client
-yarn run test
-```
-
 ### Run most tests and linting
 
 ```sh
@@ -197,7 +164,7 @@ yarn run check
 ```
 
 ### Starting the Dummy App
-To run the dummy app, it's **CRITICAL** to not just run `rails s`. You have to run `foreman start`. If you don't do this, then `webpack` will not generate a new bundle, and you will be seriously confused when you change JavaScript and the app does not change. If you change the webpack configs, then you need to restart foreman. If you change the JS code for react-on-rails, you need to run `yarn run build`. Since the react-on-rails package should be sym linked, you don't have to `yarn react-on-rails` after every change.
+To run the dummy app, it's **CRITICAL** to not just run `rails s`. You have to run `foreman start` with one of the Procfiles. If you don't do this, then `webpack` will not generate a new bundle, and you will be seriously confused when you change JavaScript and the app does not change. If you change the webpack configs, then you need to restart foreman. If you change the JS code for react-on-rails, you need to run `yarn run build`. Since the react-on-rails package should be sym linked, you don't have to `yarn react-on-rails` after every change.
 
 ### RSpec Testing
 Run `rake` for testing the gem and `spec/dummy`. Otherwise, the `rspec` command only works for testing within the sample apps, like `spec/dummy`.
@@ -219,10 +186,26 @@ In your Rails app add this gem with a path to your fork.
 
 ```ruby
 gem 'react_on_rails', path: '../relative/path/to/react_on_rails'
-```
+```                                                             
+
+Then run `bundle`.
 
 The main installer can be run with ```rails generate react_on_rails:install```
 
+Then use yalc to add the npm module. 
+
+Be sure that your ran this first at the top level of React on Rails
+
+```
+yalc publish
+```
+
+Then add the node package to your test app:
+
+```
+yalc add react-on-rails
+```
+
 ### Testing the Generator
 The generators are covered by generator tests using Rails's generator testing helpers, but it never hurts to do a sanity check and explore the API. See [generator_testing_script.md](generator_testing_script.md) for a script on how to run the generator on a fresh project.
 
@@ -247,6 +230,12 @@ You can run specific linting for directories or files by using `docker-compose r
 
 `docker-compose run lint bash` sets you up to run from the container command line.
 
+### Updating Rubocop
+2 files require updating to update the Rubocop version:
+
+1. `react_on_rails.gemspec`
+2. `spec/dummy/Gemfile`
+
 ### Docker CI - Test and Linting
 Docker CI and Tests containers have a xvfd server automatically started for headless browser testing with selenium and Firefox.
 

data/Gemfile

@@ -15,14 +15,14 @@ gem "jbuilder"
 gem "jquery-rails"
 gem "mini_racer"
 gem "puma"
-
 gem "rails_12factor"
 gem "ruby-lint", require: false
 gem "sass-rails"
 gem "scss_lint", require: false
 gem "sdoc", group: :doc
 gem "spring"
-gem "sqlite3"
+gem "sprockets", "~>3.0"
+gem "sqlite3", "~> 1.3.6"
 gem "turbolinks"
 gem "uglifier"
 gem "web-console", group: :development
@@ -34,8 +34,7 @@ gem "launchy"
 gem "rspec-rails"
 gem "rspec-retry"
 gem "selenium-webdriver"
-gem "webdrivers", "~> 3.0"
-gem "webpacker"
+gem "webpacker", ">= 4.0.0"
 
 gem "equivalent-xml", github: "mbklein/equivalent-xml"
 gem "rainbow"

data/{COMM-LICENSE → REACT-ON-RAILS-PRO-LICENSE}

@@ -1,6 +1,7 @@
+React on Rails Pro License
 For React on Rails Pro, not the open source version. For open source, see https://github.com/shakacode/react_on_rails/blob/master/LICENSE.md.
 
-Copyright (c) 2018 Justin Gordon and ShakaCode, http://www.shakacode.com
+Copyright (c) 2018, 2019 Justin Gordon and ShakaCode, http://www.shakacode.com
 
 All rights reserved.
 
@@ -19,7 +20,7 @@ In order to use the Software under this Agreement, you must receive a “Source
 
 1.1 General Use. This Agreement grants you a non-exclusive, non-transferable, limited license to the use rights for the Software, without the right to grant sublicenses, subject to the terms and conditions in this Agreement. The Software is licensed, not sold.
 
-1.2 Unlimited Organization License. If you purchased an Organization License (included with the React on Rails Pro Software), you may install the Software on an unlimited number of Hosts. “Host” means any physical or virtual machine which is controlled by you. You may concurrently run the software on an unlimited number of Hosts, with each host running an unlimited number of Workers.
+1.2 Unlimited Organization License. You may install the Software on an unlimited number of Hosts. “Host” means any physical or virtual machine which is controlled by you. You may concurrently run the software on an unlimited number of Hosts, with each host running an unlimited number of Workers.
 
 1.3 Archive Copies. You are entitled to make a reasonable amount of copies of the Software for archival purposes. Each copy must reproduce all copyright and other proprietary rights notices on or in the Software Product.
 
@@ -33,15 +34,11 @@ In order to use the Software under this Agreement, you must receive a “Source
 
 3.2 UNDER NO CIRCUMSTANCES MAY YOU USE THE SOFTWARE AS PART OF A PRODUCT OR SERVICE THAT PROVIDES SIMILAR FUNCTIONALITY TO THE SOFTWARE ITSELF.
 
-The Open Source version of the Software (“LGPL Version”) is licensed
-under the terms of the GNU Lesser General Public License versions 3.0
-(“LGPL”) and not under this EULA.
-
 4. Ownership. Notwithstanding anything to the contrary contained herein, except for the limited license rights expressly provided herein, ShakaCode and its suppliers have and will retain all rights, title and interest (including, without limitation, all patent, copyright, trademark, trade secret and other intellectual property rights) in and to the Software and all copies, modifications and derivative works thereof (including any changes which incorporate any of your ideas, feedback or suggestions). You acknowledge that you are obtaining only a limited license right to the Software, and that irrespective of any use of the words “purchase”, “sale” or like terms hereunder no ownership rights are being conveyed to you under this Agreement or otherwise.
 
 5. Fees and Payment. The Software license fees will be due and payable in full as set forth in the applicable invoice or at the time of purchase. If the Software does not function properly within two weeks of purchase, please contact us within those two weeks for a refund. You shall be responsible for all taxes, withholdings, duties and levies arising from the order (excluding taxes based on the net income of ShakaCode).
 
-6. Support, Maintenance and Services. Subject to the terms and conditions of this Agreement, as set forth in your invoice, and as set forth on the React on Rails Pro support page (https://github.com/shakacode/react_on_rails/wiki/Commercial-Support), support and maintenance services may be included with the purchase of your license subscription.
+6. Support, Maintenance and Services. Subject to the terms and conditions of this Agreement, as set forth in your invoice, and as set forth in the attached Master Service Agreement included with the purchase of your license subscription.
 
 7. Term of Agreement.
 
@@ -52,6 +49,7 @@ under the terms of the GNU Lesser General Public License versions 3.0
 7.3 Expiration of License. Upon the expiration of any term under this Agreement, (a) all Software updates and services pursuant to the license shall cease, (b) you may only continue to run existing installations of the Software, (c) you may not install the Software on any additional Hosts, and (d) any new installation of the Software shall require the purchase of a new license subscription from ShakaCode.
 
 8. Disclaimer of Warranties. The Software is provided "as is," with all faults, defects and errors, and without warranty of any kind. ShakaCode does not warrant that the Software will be free of bugs, errors, viruses or other defects, and ShakaCode shall have no liability of any kind for the use of or inability to use the Software, the Software content or any associated service, and you acknowledge that it is not technically practicable for ShakaCode to do so.
+
 To the maximum extent permitted by applicable law, ShakaCode disclaims all warranties, express, implied, arising by law or otherwise, regarding the Software, the Software content and their respective performance or suitability for your intended use, including without limitation any implied warranty of merchantability, fitness for a particular purpose.
 
 9. Limitation of Liability.
@@ -72,12 +70,11 @@ In no event will ShakaCode's liability exceed the Software license price as indi
 
 12. Third Party Software.  Examples included in Software may provide links to third party libraries or code (collectively “Third Party Software”) to implement various functions. Third Party Software does not comprise part of the Software. In some cases, access to Third Party Software may be included along with the Software delivery as a convenience for demonstration purposes. Such source code and libraries may be included in the “…/examples” source tree delivered with the Software and do not comprise the Software. Licensee acknowledges (1) that some part of Third Party Software may require additional licensing of copyright and patents from the owners of such, and (2) that distribution of any of the Software referencing or including any portion of a Third Party Software may require appropriate licensing from such third parties.
 
-
 13. Miscellaneous
 
 13.1 Entire Agreement. This Agreement sets forth our entire agreement with respect to the Software and the subject matter hereof and supersedes all prior and contemporaneous understandings and agreements whether written or oral.
 
-13.2 Amendment. ShakaCode reserves the right, in its sole discretion, to amend this Agreement from time. Amendments to this Agreement can be located at: https://github.com/shakacode/react_on_rails/blob/master/COMM-LICENSE.
+13.2 Amendment. ShakaCode reserves the right, in its sole discretion, to amend this Agreement from time. Amendments to this Agreement can be located at: https://github.com/shakacode/react_on_rails/blob/master/REACT-ON-RAILS-PRO-LICENSE.
 
 13.3 Assignment. You may not assign this Agreement or any of its rights under this Agreement without the prior written consent of ShakaCode and any attempted assignment without such consent shall be void.
 

data/README.md

@@ -1,10 +1,36 @@
-# ReactOnRails
+![reactrails](https://user-images.githubusercontent.com/10421828/79436261-52159b80-7fd9-11ea-994e-2a98dd43e540.png)
+
+<p align="center">
+ <a href="https://shakacode.com/"><img src="https://user-images.githubusercontent.com/10421828/79436256-517d0500-7fd9-11ea-9300-dfbc7c293f26.png"></a>
+ <a href="https://forum.shakacode.com/"><img src="https://user-images.githubusercontent.com/10421828/79436266-53df5f00-7fd9-11ea-94b3-b985e1b05bdc.png"></a>
+ <a href="https://forum.shakacode.com/t/react-on-rails-pro-2020-shave-the-yak/1842"><img src="https://user-images.githubusercontent.com/10421828/79436265-53df5f00-7fd9-11ea-8220-fc474f6a856c.png"></a>
+ <a href="https://github.com/sponsors/shakacode"><img src="https://user-images.githubusercontent.com/10421828/79466109-cdd90d80-8004-11ea-88e5-25f9a9ddcf44.png"></a>
+</p>
+
+---
 
 [![License](https://img.shields.io/badge/license-mit-green.svg)](./LICENSE.md) [![Build Status](https://travis-ci.org/shakacode/react_on_rails.svg?branch=master)](https://travis-ci.org/shakacode/react_on_rails) [![Gem Version](https://badge.fury.io/rb/react_on_rails.svg)](https://badge.fury.io/rb/react_on_rails) [![npm version](https://badge.fury.io/js/react-on-rails.svg)](https://badge.fury.io/js/react-on-rails) [![Code Climate](https://codeclimate.com/github/shakacode/react_on_rails/badges/gpa.svg)](https://codeclimate.com/github/shakacode/react_on_rails) [![Coverage Status](https://coveralls.io/repos/shakacode/react_on_rails/badge.svg?branch=master&service=github)](https://coveralls.io/github/shakacode/react_on_rails?branch=master) [![](https://ruby-gem-downloads-badge.herokuapp.com/react_on_rails?type=total)](https://rubygems.org/gems/react_on_rails)
 
+*These are the docs for React on Rails 12, coming soon. To see the version 11 docs, [click here](https://github.com/shakacode/react_on_rails/tree/11.3.0).*
+
+#### News
+**April 2, 2020**:
+* Are you interested in support for React on Rails? If so check out [React on Rails Pro](https://www.shakacode.com/react-on-rails-pro).
+* HMR is working with [Loadable Components](https://loadable-components.com) for a both amazing hot-reloading developer experience and great runtime performance. Please [email me](mailto:justin@shakacode.com) if you'd like to use [Loadable Components Code Splitting](https://loadable-components.com/docs/code-splitting/) to speed up your app by reducing your bundle sizes and lazily loading the code that's needed.
+* `react_on_rails` fully supports `rails/webpacker`. The example test app in `spec/dummy` was recently converted over to use rails/webpacker v4. It's a good example of how to leverage rails/webpacker's webpack configuration. 
+
+---
+
+#### About
 React on Rails integrates Rails with (server rendering of) Facebook's [React](https://github.com/facebook/react) front-end framework.
 
-Interested in optimizing your webpack setup for React on Rails including code splitting with react-router v4, webpack v4, and react-loadable with server side rendering? [Contact Justin Gordon](mailto:justin@shakacode.com).
+This project is sponsored by the software consulting firm [ShakaCode](https://www.shakacode.com). We focus on React front-ends, often with Ruby on Rails or Gatsby. The best way to see what we do is to see the details of [our recent work](https://www.shakacode.com/recent-work).
+
+Interested in optimizing your webpack setup for React on Rails including code splitting with react-router v4, webpack v4, and react-loadable with server side rendering? We just did this for Popmenu, [lowering Heroku costs 20-25% while getting a 73% decrease in average response times](https://www.shakacode.com/recent-work/popmenu/).
+
+Feel free to contact Justin Gordon, [justin@shakacode.com](mailto:justin@shakacode.com), maintainer of React on Rails, for more information.
+
+[Click to join **React + Rails Slack**](https://reactrails.slack.com/join/shared_invite/enQtNjY3NTczMjczNzYxLTlmYjdiZmY3MTVlMzU2YWE0OWM0MzNiZDI0MzdkZGFiZTFkYTFkOGVjODBmOWEyYWQ3MzA2NGE1YWJjNmVlMGE).
 
 # Intro
 
@@ -28,56 +54,10 @@ Given that rails/webpacker gem already provides basic React integration, why wou
 See the [react-webpack-rails-tutorial](https://github.com/shakacode/react-webpack-rails-tutorial) for an example of a live implementation and code.
 
 ## ShakaCode Forum Premium Content
-_Requires creating a free account._ 
+_Requires creating a free account._
+ 
 * [How to use different versions of a file for client and server rendering](https://forum.shakacode.com/t/how-to-use-different-versions-of-a-file-for-client-and-server-rendering/1352)
 
-## React on Rails Pro and ShakaCode Pro Support
-
-React on Rails Pro provides Node server rendering and other performance enhancements for React on Rails. 
-
-[![2018-09-11_10-31-11](https://user-images.githubusercontent.com/1118459/45467845-5bcc7400-b6bd-11e8-91e1-e0cf806d4ea4.png)](https://blog.shakacode.com/hvmns-90-reduction-in-server-response-time-from-react-on-rails-pro-eb08226687db)
-
-* [HVMN Testimonial, by Paul Benigeri, October 12, 2018](./docs/testimonials/hvmn.md)
-* [HVMN’s 90% Reduction in Server Response Time from React on Rails Pro](https://blog.shakacode.com/hvmns-90-reduction-in-server-response-time-from-react-on-rails-pro-eb08226687db)
-* [Egghead React on Rails Pro Deployment Highlights](https://github.com/shakacode/react_on_rails/wiki/Egghead-React-on-Rails-Pro-Deployment-Highlights)
-
-For more information, see the [React on Rails Pro Docs](https://github.com/shakacode/react_on_rails/wiki).
-
-The [ShakaCode Pro Support Plan](http://www.shakacode.com/work/shakacode-pro-support.pdf) can help you with:
-
-* Optimizing your webpack setup to Webpack v4 for React on Rails including code splitting with react-router v4, webpack v4, and react-loadable.
-* Upgrading your app to use the current Webpack setup that skips the Sprockets asset pipeline.
-* Better performance client and server side.
-* Efficiently migrating from [Angular to React](https://www.shakacode.com/services/angular-to-react/).
-* Best practices based on over four years of React on Rails experience.
-* Using [Reason](https://reasonml.github.io/) with (or without) React on Rails.
-
-ShakaCode can also help you with your custom software development needs. We specialize in marketplace and e-commerce applications that utilize both Rails and React. Because we own [HawaiiChee.com](https://www.hawaiichee.com), we can leverage that code for your app! 
-
-The article [Why Hire ShakaCode?](https://blog.shakacode.com/can-shakacode-help-you-4a5b1e5a8a63#.jex6tg9w9) provides additional details about our projects.
-
-Please [email me (Justin Gordon), the creator of React on Rails](mailto:justin@shakacode.com), to see if I can help you or if you want an invite to our private Slack room for ShakaCode.
-
-## Testimonials for Hiring ShakaCode and our "Pro Support"
-
-[HVMN Testimonial, Written by Paul Benigeri, October 12, 2018](./docs/testimonials/hvmn.md)
-
-> The price we paid for the consultation + the React on Rails pro license has already been made back a couple of times from hosting fees alone. The entire process was super hands off, and our core team was able to focus on shipping new feature during that sprint.
-
-[ResortPass Testimonial, by Leora Juster, December 10, 2018](./docs/testimonials/resortpass.md)
-
-> Justin and his team were instrumental in assisting us in setting design foundations and standards for our transition to a react on rails application. Just three months of work with the team at Shaka code and we have a main page of our application server-side rendering at exponentially improved speeds.
-
-From Kyle Maune of Cooper Aerial, May 4, 2018
-
-![image](https://user-images.githubusercontent.com/1118459/40891236-9b0b406e-671d-11e8-80ee-c026dbd1d5a2.png)
-
-From Joel Hooks, Co-Founder, Chief Nerd at [egghead.io](https://egghead.io/), January 30, 2017:
-
-![2017-01-30_11-33-59](https://cloud.githubusercontent.com/assets/1118459/22443635/b3549fb4-e6e3-11e6-8ea2-6f589dc93ed3.png)
-
-For more testimonials, see [Live Projects](PROJECTS.md) and [Kudos](./KUDOS.md).
-
 ----
 
 # Docs
@@ -191,13 +171,14 @@ Below is the line where you turn server rendering on by setting `prerender` to t
     <%= react_component("HelloWorld", props: { name: "Stranger" }) %>
   ```
   
-- This is what your HelloWorld.js file might contain. The railsContext is always available for any parameters that you _always_ want available for your React components. It has _nothing_ to do with the concept of the [React Context](https://reactjs.org/docs/context.html). See [Generator Functions and the RailsContext](docs/basics/generator-functions-and-railscontext.md) for more details on this topic.
+- This is what your HelloWorld.js file might contain. The railsContext is always available for any parameters that you _always_ want available for your React components. It has _nothing_ to do with the concept of the [React Context](https://reactjs.org/docs/context.html). See [render functions and the RailsContext](docs/basics/render-functions-and-railscontext.md) for more details on this topic.
   
   ```js
   import React from 'react';
 
   export default (props, railsContext) => {
-    return (
+    // Note wrap in a function to make this a React function component
+    return () => (
       <div>
         Your locale is {railsContext.i18nLocale}.<br/>
         Hello, {props.name}!
@@ -210,7 +191,7 @@ See the [View Helpers API](./docs/api/view-helpers-api.md) for more details on `
 
 ## Fragment Caching
 
-Fragment caching is a [React on Rails Pro](https://github.com/shakacode/react_on_rails/wiki) feature. Fragment caching is a **HUGE** performance booster for your apps. Use the `cached_react_component` and `cached_react_component_hash`. The API is the same as `react_component` and `react_component_hash`, but for 2 differences:
+Fragment caching is a [React on Rails Pro](https://www.shakacode.com/react-on-rails-pro) feature. Fragment caching is a **HUGE** performance booster for your apps. Use the `cached_react_component` and `cached_react_component_hash`. The API is the same as `react_component` and `react_component_hash`, but for 2 differences:
 
 1. The `cache_key` takes the same parameters as any Rails `cache` view helper.
 1. The **props** are passed via a block so that evaluation of the props is not done unless the cache is broken. Suppose you put your props calculation into some method called `some_slow_method_that_returns_props`:
@@ -232,7 +213,7 @@ Note, even without server rendering (without step 3 above), fragment caching is
   
 ## Integration with Node.js for Server Rendering
 
-Default server rendering is done by ExecJS. If you want to use a Node.js server for better performing server rendering, [email justin@shakacode.com](mailto:justin@shakacode.com). ShakaCode has built a premium Node rendering server that is part of [React on Rails Pro](https://github.com/shakacode/react_on_rails/wiki).
+Default server rendering is done by ExecJS. If you want to use a Node.js server for better performing server rendering, [email justin@shakacode.com](mailto:justin@shakacode.com). ShakaCode has built a premium Node rendering server that is part of [React on Rails Pro](https://www.shakacode.com/react-on-rails-pro).
 
 ## Globally Exposing Your React Components
 
@@ -257,21 +238,39 @@ Another way is to use a separate webpack configuration file that can use a diffe
 
 For details on techniques to use different code for client and server rendering, see: [How to use different versions of a file for client and server rendering](https://forum.shakacode.com/t/how-to-use-different-versions-of-a-file-for-client-and-server-rendering/1352). (_Requires creating a free account._)
 
-## Specifying Your React Components: Direct or Generator Functions
+## Specifying Your React Components: Register directly or use render-functions
 
-You have two ways to specify your React components. You can either register the React component directly, or you can create a function that returns a React component. Creating a function has the following benefits:
+You have two ways to specify your React components. You can either register the React component (either function or class component) directly, or you can create a function that returns a React component, which we using the name of a "render-function". Creating a render-function allows:
 
-1. You have access to the `railsContext`. See documentation for the railsContext in terms of why you might need it. You **need** a generator function to access the `railsContext`.
+1. You have access to the `railsContext`. See documentation for the railsContext in terms of why you might need it. You **need** a render function to access the `railsContext`.
 2. You can use the passed-in props to initialize a redux store or set up react-router.
 3. You can return different components depending on what's in the props.
 
-ReactOnRails will automatically detect a registered generator function. Thus, there is no difference between registering a React Component versus a "generator function."
+Note, the return value of a **render function** should be either a React Function or Class Component, or an object representing server rendering results.
+
+Do not return a React Element (JSX).
+
+ReactOnRails will automatically detect a registered render function by the fact that the function takes
+more than 1 parameter. In other words, if you want the ability to provide a function that returns the
+React component, then you need to specify at least a second parameter. This is the `railsContext`.
+If you're not using this parameter, declare your function with the unused param:
+
+```js
+const MyComponentGenerator = (props, _railsContext) => {
+  if (props.print) {
+    // This is a React FunctionComponent because it is wrapped in a function.
+    return () => <H1>{JSON.stringify(props)}</H1>;
+  }
+}
+```
+
+Thus, there is no difference between registering a React function or class Component versus a "render function."
 
-## react_component_hash for Generator Functions
+## react_component_hash for render functions
 
-Another reason to use 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 }. Make sure you use this function with `react_component_hash`. 
+Another reason to use a render 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 }. Make sure you use this function with `react_component_hash`. 
 
-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 `renderedHtml`. Inside this Object, place a key called `componentHtml`, along with any other needed keys. An example scenario of this is when you are using side effects libraries like [React Helmet](https://github.com/nfl/react-helmet). Your Ruby code will get this Object as a Hash containing keys componentHtml and any other custom keys that you added:
+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. An example scenario of this is when you are using side effects libraries like [React Helmet](https://github.com/nfl/react-helmet). Your Ruby code will get this Object as a Hash containing keys componentHtml and any other custom keys that you added:
 
 ```js
 { renderedHtml: { componentHtml, customKey1, customKey2} }
@@ -286,7 +285,8 @@ For details on using react_component_hash with react-helmet, see the docs below
 
 ## I18n
 
-You can enable the i18n functionality with [react-intl](https://github.com/yahoo/react-intl). React on Rails provides an option for automatic conversions of Rails `*.yml` locale files into `*.js` files for `react-intl`. See the [How to add I18n](docs/basics/i18n.md) for a summary of adding I18n.
+React on Rails provides an option for automatic conversions of Rails `*.yml` locale files into `*.json` or `*.js*.
+See the [How to add I18n](docs/basics/i18n.md) for a summary of adding I18n.
 
 ## More Details
 
@@ -294,18 +294,16 @@ Browse the links in the [Summary Table of Contents](./SUMMARY.md)
 
 Here are some highly recommended next articles to read:
 
-1. [How React on Rails Works](./docs/basics/how-react-on-rails-works.md)
+1. [How React on Rails Works](docs/outdated/how-react-on-rails-works.md)
 1. [Recommended Project Structure](./docs/basics/recommended-project-structure.md)
 1. [Webpack Configuration](./docs/basics/webpack-configuration.md)
 1. [View Helpers API](./docs/api/view-helpers-api.md) 
-1. [Caching and Performance: React on Rails Pro](https://github.com/shakacode/react_on_rails/wiki).
+1. [Caching and Performance: React on Rails Pro](https://www.shakacode.com/react-on-rails-pro).
 1. [Deployment](docs/basics/deployment.md).
 
 # Support
 
-## ShakaCode Support
-
-Aloha, I'm Justin Gordon the creator and maintainer of React on Rails. I'm supporting my continued dedication to this project by project by offering a React on Rails **Pro Support Plan**. Please [email me](mailto:justin@shakacode.com) to see if I can help you.
+[Click to join **React + Rails Slack**](https://reactrails.slack.com/join/shared_invite/enQtNjY3NTczMjczNzYxLTlmYjdiZmY3MTVlMzU2YWE0OWM0MzNiZDI0MzdkZGFiZTFkYTFkOGVjODBmOWEyYWQ3MzA2NGE1YWJjNmVlMGE).
 
 ## Community Resources
 
@@ -324,23 +322,58 @@ Please [**click to subscribe**](https://app.mailerlite.com/webforms/landing/l1d9
 
 Bug reports and pull requests are welcome. See [Contributing](CONTRIBUTING.md) to get started, and the [list of help wanted issues](https://github.com/shakacode/react_on_rails/labels/contributions%3A%20up%20for%20grabs%21).
 
+## React on Rails Pro
+
+React on Rails Pro provides Node server rendering, fragment caching, code-splitting, and other performance enhancements for React on Rails. For a case study, see the article [HVMN’s 90% Reduction in Server Response Time from React on Rails Pro](https://blog.shakacode.com/hvmns-90-reduction-in-server-response-time-from-react-on-rails-pro-eb08226687db). The [Wiki](https://github.com/shakacode/react_on_rails/wiki) contains more details.
+
+[![2018-09-11_10-31-11](https://user-images.githubusercontent.com/1118459/45467845-5bcc7400-b6bd-11e8-91e1-e0cf806d4ea4.png)](https://blog.shakacode.com/hvmns-90-reduction-in-server-response-time-from-react-on-rails-pro-eb08226687db)
+
+## React on Rails Pro Support
+
+The [React on Rails Pro Support Plan](https://www.shakacode.com/react-on-rails-pro) can help!
+
+* Optimizing your webpack setup to Webpack v4 for React on Rails including code splitting with react-router v4, webpack v4, and react-loadable.
+* Upgrading your app to use the current Webpack setup that skips the Sprockets asset pipeline.
+* Better performance client and server side.
+* Best practices based on over four years of React on Rails experience.
+* Using [Reason](https://reasonml.github.io/) with (or without) React on Rails.
+
+ShakaCode can also help you with your custom software development needs. We specialize in marketplace and e-commerce applications that utilize both Rails and React. Because we own [HawaiiChee.com](https://www.hawaiichee.com), we can leverage that code for your app!
+
+Please email Justin Gordon [justin@shakacode.com](mailto:justin@shakacode.com), the maintainer of React on Rails, for more information.
+
+## Testimonials for ShakaCode
+[HVMN Testimonial, by Paul Benigeri, October 12, 2018](./docs/testimonials/hvmn.md)
+> The price we paid for the consultation + the React on Rails pro license has already been made back a couple of times from hosting fees alone. The entire process was super hands off, and our core team was able to focus on shipping new feature during that sprint.
+
+[ResortPass Testimonial, by Leora Juster, December 10, 2018](./docs/testimonials/resortpass.md)
+
+> Justin and his team were instrumental in assisting us in setting design foundations and standards for our transition to a react on rails application. Just three months of work with the team at Shaka code and we have a main page of our application server-side rendering at exponentially improved speeds.
+
+From Joel Hooks, Co-Founder, Chief Nerd at [egghead.io](https://egghead.io/), January 30, 2017:
+
+![2017-01-30_11-33-59](https://cloud.githubusercontent.com/assets/1118459/22443635/b3549fb4-e6e3-11e6-8ea2-6f589dc93ed3.png)
+
+For more testimonials, see [Live Projects](PROJECTS.md) and [Kudos](./KUDOS.md).
+
 # Supporters
 
 The following companies support this open source project, and ShakaCode uses their products! Justin writes React on Rails on [RubyMine](https://www.jetbrains.com/ruby/). We use [Scout](https://scoutapp.com/) to monitor the live performance of [HawaiiChee.com](https://www.hawaiichee.com), [BrowserStack](https://www.browserstack.com) to solve problems with oddball browsers, and [CodersRank](https://codersrank.io/) to find candidates for our team.
 
+[![2019-09-24_17-48-00](https://user-images.githubusercontent.com/1118459/65567887-96353780-def3-11e9-926d-4a55e2e186ff.png)](https://www.jetbrains.com/ruby/)
 [![Scout](https://user-images.githubusercontent.com/1118459/41828269-106b40f8-77d0-11e8-8d19-9c4b167ef9d8.png)](https://scoutapp.com/)
 [![BrowserStack](https://cloud.githubusercontent.com/assets/1118459/23203304/1261e468-f886-11e6-819e-93b1a3f17da4.png)](https://www.browserstack.com)
 [![CodersRank](https://user-images.githubusercontent.com/1118459/55040254-ad8a7b00-4fcb-11e9-8936-c6765eb30698.png)](https://codersrank.io/?utm_source=github&utm_medium=banner&utm_campaign=shakacode)
 
 ## Clubhouse
-I've just moved ShakaCode's development to [ClubHouse](https://clubhouse.io/) from Trello. We're going to be doing this with all our projects. If you want to **try ClubHouse and get 2 months free beyond the 14-day trial period**, click [here to use ShakaCode's referral code](http://r.clbh.se/mvfd30S). We're participating in their awesome triple-sided referral program, which you can read about [here](https://clubhouse.io/blog/clubhouse-referral-program-5f614bb437c3). By using our [referral code](http://r.clbh.se/mvfd30S) you'll be supporting ShakaCode and, thus, React on Rails!
+I've just moved ShakaCode's development to [ClubHouse](https://clubhouse.io/) from Trello. We're going to be doing this with all our projects. If you want to **try ClubHouse and get 2 months free beyond the 14-day trial period**, click [here to use ShakaCode's referral code](http://r.clbh.se/mvfoNeH). We're participating in their awesome triple-sided referral program, which you can read about [here](https://clubhouse.io/blog/clubhouse-referral-program-5f614bb437c3). By using our [referral code](http://r.clbh.se/mvfoNeH) you'll be supporting ShakaCode and, thus, React on Rails!
 
 *If you'd like to support React on Rails and have your company listed here, [get in touch](mailto:justin@shakacode.com).*
 
 Aloha and best wishes from Justin and the ShakaCode team!
 
 # Work with Us
-ShakaCode is **[currently looking to hire](http://www.shakacode.com/about/#work-with-us)** like-minded, remote-first, developers that wish to work on our projects, including [Hawaii Chee](https://www.hawaiichee.com). Your main coding interview will be pairing with us on our open source! We're getting into [Reason](https://reasonml.github.io/)!
+ShakaCode is **[currently looking to hire](http://www.shakacode.com/about/#work-with-us)** like-minded, remote-first, developers that wish to work on our projects, including [Hawaii Chee](https://www.hawaiichee.com). Your main coding interview will be pairing with us on our open source! We're also using [ReasonML](https://reasonml.github.io/) extensively!
 
 # License