react_on_rails 11.2.2 → 12.0.0.pre.beta.3

data/docs/basics/deployment.md

@@ -1,6 +1,4 @@
 # Deployment
 
-- React on Rails puts the necessary precompile steps automatically in the rake precompile step. You can, however, disable this by setting certain values to nil in the [config/initializers/react_on_rails.rb](./configuration.md).
-  - `build_production_command`: Set to nil to turn off the precompilation of the js assets.
-  - `config.symlink_non_digested_assets_regex`: Default is nil, turning off the setup of non-js assets. This should be nil except when when using Sprockets rather than Webpacker. 
-- See the [Heroku Deployment](../additional-reading/heroku-deployment.md) doc for specifics regarding Heroku. The information for Heroku may apply to other deployments.
+- `rails/webpacker` puts the necessary precompile steps automatically in the rake precompile step. 
+- See the [Heroku Deployment](docs/basics/heroku-deployment.md) doc for specifics regarding Heroku. The information for Heroku may apply to other deployments.

data/docs/basics/heroku-deployment.md

@@ -0,0 +1,24 @@
+# Heroku Deployment
+## Heroku buildpacks
+
+React on Rails requires both a ruby environment (for Rails) and a Node environment (for Webpack), so you will need to have Heroku use multiple buildpacks.
+
+Assuming you have downloaded and installed the Heroku command-line utility and have initialized the app, you will need to tell Heroku to use both buildpacks via the command-line:
+
+```
+heroku buildpacks:set heroku/ruby
+heroku buildpacks:add --index 1 heroku/nodejs
+```
+
+For more information, see [Using Multiple Buildpacks for an App](https://devcenter.heroku.com/articles/using-multiple-buildpacks-for-an-app)
+
+## assets:precompile
+
+### rails/webpacker webpack configuration
+If you're using the standard rails/webpacker configuration of webpack, then rails/webpacker
+will automatically modify or create an assets:precompile task to build your assets.
+
+### custom webpack configuration
+If you're a custom webpack configuration, and you **do not have the default
+`config/webpack/production.js`** file, then the `config/initializers/react_on_rails.rb`
+configuration `config.build_production_command` will be used.

data/docs/basics/hmr-and-hot-reloading-with-the-webpack-dev-server.md

@@ -0,0 +1,49 @@
+# HMR and Hot Reloading with the webpack-dev-server
+
+The webpack-dev-server provides:
+
+1. Speedy compilation of client side assets
+2. Optional HMR which means that the page will reload automatically when after
+   compilation completes. Note, some developers do not like this, as you'll
+   abruptly lose any tweaks within the Chrome development tools.
+3. Optional hot-reloading. The older react-hot-loader has been deprecated in 
+   favor of [fast-refresh](https://reactnative.dev/docs/fast-refresh).
+   For use with webpack, see [react-refresh-webpack-plugin](https://github.com/pmmmwh/react-refresh-webpack-plugin).
+
+If you are ***not*** using server-side rendering (***not*** using `prerender: true`),
+then you can follow all the regular docs for using the `bin/webpack-dev-server` 
+during development.
+
+
+# Server Side Rendering with the Default rails/webpacker bin/webpack-dev-server
+
+If you are using server-side rendering, then you have a couple options. The
+recommended technique is to have a different webpack configuration for server
+rendering.  
+
+
+
+
+## If you use the same Webpack setup for your server and client bundles 
+If you do use the webpack-dev-server for prerendering, be sure to set the
+`config/initializers/react_on_rails.rb` setting of 
+
+```
+  config.same_bundle_for_client_and_server = true
+```
+
+`dev_server.hmr` maps to [devServer.hot](https://webpack.js.org/configuration/dev-server/#devserverhot).
+This must be false if you're using the webpack-dev-server for client and server bundles.
+ 
+`dev_server.inline` maps to [devServer.inline](https://webpack.js.org/configuration/dev-server/#devserverinline).
+This must also be false.
+
+If you don't configure these two to false, you'll see errors like:
+
+* "ReferenceError: window is not defined" (if hmr is true)
+* "TypeError: Cannot read property 'prototype' of undefined" (if inline is true)
+
+
+
+
+

data/docs/basics/i18n.md

@@ -1,23 +1,10 @@
-# How to add I18n
+# I18n
 
 Here's a summary of adding the I18n functionality.
 
-You can refer to [react-webpack-rails-tutorial](https://github.com/shakacode/react-webpack-rails-tutorial) and [PR #340](https://github.com/shakacode/react-webpack-rails-tutorial/pull/340), [commmited](https://github.com/shakacode/react-webpack-rails-tutorial/commit/ef369ed9d922aea5116ca7e50208169fd7831389) for a complete example.
+1. Add `config.i18n_dir` in `config/initializers/react_on_rails.rb`
 
-1. Add `react-intl` & `intl` to `client/package.json`, and remember to `bundle && yarn install`.
-
-  ```js
-  "dependencies": {
-    ...
-    "intl": "^1.2.5",
-    "react-intl": "^2.1.5",
-    ...
-  }
-  ```
-
-2. Add `config.i18n_dir` in `config/initializers/react_on_rails.rb`
-
-  `react-intl` requires locale files in json format. React on Rails will generate `translations.js` & `default.js` automatically after you configured your `config.i18n_dir` in `config/initializers/react_on_rails.rb`.
+  React on Rails will generate `translations.json` & `default.json` automatically (see #3) after you configured your `config.i18n_dir` in `config/initializers/react_on_rails.rb`.
 
   ```ruby
   # Replace the following line to the location where you keep translation.js & default.js.
@@ -31,16 +18,50 @@ You can refer to [react-webpack-rails-tutorial](https://github.com/shakacode/rea
   config.i18n_yml_dir = Rails.root.join("PATH_TO", "YOUR_YAML_I18N_FOLDER")
   ```
 
-  `translations.js`: All your locales in json format.
-  `default.js`: Default settings in json format.
+  `translations.json`: All your locales in json format.
+  `default.json`: Default settings in json format.
 
-3. Add `translations.js` and `default.js` to your `.gitignore` and `.eslintignore`.
+2. Add `translations.json` and `default.json` to your `.gitignore`.
+
+3. Javascript locale files must be generated before `yarn build`.
 
-4. Javascript locale files must be generated before `yarn build`.
+  Once you setup `config.i18n_dir` as in the previous step, you will need to make sure `rake react_on_rails:locale` runs before webpack. 
+  
+  For development, you should adjust your startup scripts (Procfiles) so that they run **`bundle exec rake react_on_rails:locale`** before running any webpack watch process (`yarn run build:development`). 
+  
+  You may need to configure your CI to  run **`bundle exec rake react_on_rails:locale`** before any webpack process if you are not using the React on Rails test helper. 
+  
+  Note, if you are try to lint before running tests, and you are depending on the test helper to build your locales, your linting will fail because the translations won't be built yet. 
+  
+  The fix is either to 
+  1) run the rake task to build the translations before running the lint command or 
+  2) to run the tests first.
 
-  Once you setup `config.i18n_dir` as in the previous step, react_on_rails will automatically do this for testing (if using the `ReactOnRails::TestHelper.configure_rspec_to_compile_assets` and for production deployments if using the [default precompile rake hook](../additional-reading/heroku-deployment.md). For development, you should adjust your startup scripts (Procfiles) so that they run **`bundle exec rake react_on_rails:locale`** before running any webpack watch process (`yarn run build:development`). You may need to configure your CI to  run **`bundle exec rake react_on_rails:locale`** before any webpack process if you are not using the React on Rails test helper. Note, if you are try to lint before running tests, and you are depending on the test helper to build your locales, your linting will fail because the translations won't be built yet. The fix is either to 1) run the rake task to build the translations before running the lint command or 2) to run the tests first.
+# Generate locales with react-intl support
 
-5. In React, you need to initialize `react-intl`, and set parameters for it.
+By default the locales generated in json format. If you need to generate files in the prior way
+with `react-intl` supported via js files:
+
+1. Specify i18n output format in `react_on_rails.rb`:
+  ```rb
+    config.i18n_output_format = 'js'
+  ```
+
+2. Add `react-intl` & `intl` to `client/package.json`, and remember to `bundle && yarn install`.
+   Versions should be newer than these:
+
+  ```js
+  "dependencies": {
+    ...
+    "intl": "^1.2.5",
+    "react-intl": "^2.1.5",
+    ...
+  }
+  ```
+
+3. Add `translations.js` and `default.js` to your `.gitignore` and `.eslintignore`.
+
+4. In React, you need to initialize `react-intl`, and set parameters for it.
 
   ```js
   ...
@@ -73,5 +94,6 @@ You can refer to [react-webpack-rails-tutorial](https://github.com/shakacode/rea
   ```
   
   # Notes
-  
+  * See why using JSON could be better compare to JS if amount of data is hure [ https://v8.dev/blog/cost-of-javascript-2019#json]( https://v8.dev/blog/cost-of-javascript-2019#json).
   * See [Support for Rails' i18n pluralization #1000](https://github.com/shakacode/react_on_rails/issues/1000) for a discussion of issues around pluralization.
+  * *Outdated:* You can refer to [react-webpack-rails-tutorial](https://github.com/shakacode/react-webpack-rails-tutorial) and [PR #340](https://github.com/shakacode/react-webpack-rails-tutorial/pull/340), [commmited](https://github.com/shakacode/react-webpack-rails-tutorial/commit/ef369ed9d922aea5116ca7e50208169fd7831389) for a complete example.

data/docs/basics/installation-into-an-existing-rails-app.md

@@ -7,11 +7,11 @@
 1. Add the following to your Gemfile and `bundle install`. We recommend fixing the version of React on Rails, as you will need to keep the exact version in sync with the version in your `client/package.json` file.
 
    ```ruby
-   gem "react_on_rails", "11.1.4" # Update to the current version
-   gem "webpacker", "~> 3" # Newer versions might be supported
+   gem "react_on_rails", "12.0.0" # Update to the current version
+   gem "webpacker", "~> 5"
    ```
 
-2. Run the following 2 commands to install Webpacker with React. Note, f you are using an older version of Rails than 5.1, you'll need to install webpacker with React per the instructions [here](https://github.com/rails/webpacker).
+2. Run the following 2 commands to install Webpacker with React. Note, if you are using an older version of Rails than 5.1, you'll need to install webpacker with React per the instructions [here](https://github.com/rails/webpacker).
 
 
    ```bash
@@ -45,7 +45,7 @@
 
 ## Installation
 
-See the [Installation Overview](../misc-pending/manual-installation-overview.md) for a concise set summary of what's in a React on Rails installation.
+See the [Installation Overview](docs/outdated/manual-installation-overview.md) for a concise set summary of what's in a React on Rails installation.
 
 
 ## NPM
@@ -57,8 +57,3 @@ $ yarn add react-on-rails --exact
 ```
 
 That will install the latest version and update your package.json. **NOTE:** the `--exact` flag will ensure that you do not have a "~" or "^" for your react-on-rails version in your package.json.
-
-## Webpacker Configuration
-
-React on Rails users should set configuration value `compile` to false, as React on Rails handles compilation for test and production environments.
-

data/docs/basics/minitest-configuration.md

@@ -0,0 +1,31 @@
+# Minitest Configuration
+
+The setup for minitest is the same as for rspec with the following difference.
+
+Rather than calling `ReactOnRails::TestHelper.configure_rspec_to_compile_assets(config)`, instead you will do something like this:
+
+```ruby
+class ActiveSupport::TestCase
+  setup do
+    ReactOnRails::TestHelper.ensure_assets_compiled
+  end
+end    
+```
+
+
+Or maybe something like this, from the [minitest docs](https://github.com/seattlerb/minitest/blob/master/lib/minitest/test.rb#L119):
+
+```ruby
+module MyMinitestPlugin
+  def before_setup
+    super
+    ReactOnRails::TestHelper.ensure_assets_compiled
+  end
+end
+
+class MiniTest::Test
+  include MyMinitestPlugin
+end
+```
+
+ 

data/docs/basics/react-server-rendering.md

@@ -10,7 +10,7 @@ During the Rails rendering of HTML per a browser request, the Rails server will
 
 The default JavaScript interpretter is [ExecJS](https://github.com/rails/execjs). If you want to maximize the perfomance of your server rendering, then you want to use React on Rails Pro which uses NodeJS to do the server rendering. See the [docs for React on Rails Pro](https://github.com/shakacode/react_on_rails/wiki).
 
-See [this note](./how-react-on-rails-works.md#client-side-rendering-vs-server-side-rendering)
+See [this note](docs/outdated/how-react-on-rails-works.md#client-side-rendering-vs-server-side-rendering)
 
 
 ## How do you do Server Rendering with React on Rails?

data/docs/basics/recommended-project-structure.md

@@ -1,7 +1,5 @@
 # Recommended Project structure
 
-While React On Rails does not *enforce* a specific project structure, we do *recommend* a standard organization. The more we follow standards as a community, the easier it will be for all of us to move between various Rails projects that include React On Rails.
-
 The React on Rails generator uses the standard `rails/webpacker` convention of this structure:
 
 ```yml
@@ -14,21 +12,9 @@ app/javascript:
   │   └── hello-world-bundle.js
 ```
 
-The problems with this structure and using rails/webpacker to configure Webpack for you:
-
-1. No support for different entry points for server rendering.
-2. Webpacker adds an extra layer of abstraction over Webpack, which you probably don't want.
-
-This default rails/webpacker configuration is used for the generator because:
-
-1. Minimizes the amount of generated code to get up and running with React on Rails.
-2. Good enough for very simple projects.
-3. Configuration of Webpack is not the goal of this library, React on Rails.
+However, you may wish to move all your client side files to a single directory called something like `/client`.
 
-
-Thus, the generator structure and using rails/webpacker for Webpack configuration **is not recommended** for any commercial projects, especially those that will use server rendering. Instead, the recommended structure is shown in this example app: [github.com/shakacode/react-webpack-rails-tutorial](https://github.com/shakacode/react-webpack-rails-tutorial) and described below.
-
-## Steps to convert from the generator defaults to use the recommended `/client` directory structure.
+## Steps to convert from the generator defaults to use a `/client` directory structure.
 
 1. Move the directory:
 
@@ -44,7 +30,7 @@ mv app/javascript client
 
 ## Moving node_modules from `/` to `/client` with a custom webpack setup.
 
-`rails/webpacker` probably doesn't support having your main node_modules directory under `/client`, so only follow these steps if you want to use your own webpack configuration (which is highly recommended!).
+`rails/webpacker` probably doesn't support having your main node_modules directory under `/client`, so only follow these steps if you want to use your own webpack configuration.
 
 1. Move the `/package.json` to `/client/package.json`
 2. Create a `/package.json` that delegates to `/client/package.json`. See the example in [spec/dummy/package.json](../../spec/dummy/package.json).
@@ -57,7 +43,7 @@ mv app/javascript client
 1. `/client/app/bundles`: Top level of different app domains. Use a name within this directory for you app domains. For example, if you had a domain called `widget-editing`, then you would have: `/client/app/bundles/widget-editing`
 1. `/client/app/lib`: Common code for bundles
 1. Within each bundle directory (or the lib directory), such as a domain named "comments"
-`/client/app/bundles/comments`, use following directory structure:
+`/client/app/bundles/comments`, use following directory structure, if you're using redux. However, with React hooks, this will probably be a bit different:
 
   * `/actions`: Redux actions.
   * `/components`: "dumb" components (no connections to Redux or Ajax). These get props and can render themselves and children.
@@ -79,7 +65,7 @@ This isn't really any technique, as you keep handling all your styling assets us
 1. Much simpler! There's no changes really from your current processes.
 
 ### Using Webpack to Manage Styling Assets
-This technique involves customization of the webpack config files to generate CSS, image, and font assets. See [webpack.client.rails.build.config.js](https://github.com/shakacode/react_on_rails/blob/master/spec%2Fdummy%2Fclient%2Fwebpack.client.rails.build.config.js) for an example how to set the webpack part.
+This technique involves customization of the webpack config files to generate CSS, image, and font assets. 
 
 #### Directory structure
 1. `/client/app/assets`: Assets for CSS for client app.
@@ -89,6 +75,3 @@ This technique involves customization of the webpack config files to generate CS
 1. You can use [CSS modules](https://github.com/css-modules/css-modules), which is super compelling once you seen the benefits.
 1. You can do hot reloading of your assets. Thus, you do not have to refresh your web page to see asset change, including changing styles.
 1. You can run your client code on a mocked out express server for super fast prototyping. In other words, your client application can somewhat more easily be move to a different application server.
-
-#### Updates 2017-03-04 Regarding CSS handled by Webpack
-* See article [Best practices for CSS and CSS Modules using Webpack](https://forum.shakacode.com/t/best-practices-for-css-and-css-modules-using-webpack/799).

data/docs/basics/{generator-functions-and-railscontext.md → render-functions-and-railscontext.md}

@@ -1,45 +1,80 @@
-# Generator Functions and Rails Context 
+# Render-Functions and the Rails Context 
 
-## Generator Functions
+## Render-Functions
 
-When you use a "generator function" to create react components (or renderedHtml on the server), or you used shared redux stores, you get two params passed to your function that creates a React component:
+When you use a render-function to create react components (or renderedHtml on the server), or you
+used shared redux stores, you get two params passed to your function that creates a React component:
 
 1. `props`: Props that you pass in the view helper of either `react_component` or `redux_store`
-2. `railsContext`: Rails contextual information, such as the current pathname. You can customize this in your config file. **Note**: The `railsContext` is not related to the concept of a ["context" for React components](https://facebook.github.io/react/docs/context.html#how-to-use-context).
+2. `railsContext`: Rails contextual information, such as the current pathname. You can customize
+   this in your config file. **Note**: The `railsContext` is not related to the concept of a
+   ["context" for React components](https://facebook.github.io/react/docs/context.html#how-to-use-context).
 
-This parameters (`props` and `railsContext`) will be the same regardless of either client or server side rendering, except for the key `serverSide` based on whether or not you are server rendering.
+These parameters (`props` and `railsContext`) will be the same regardless of either client or server
+side rendering, except for the key `serverSide` based on whether or not you are server rendering.
 
-While you could manually configure your Rails code to pass the "`railsContext` information" with the rest of your "props", the `railsContext` is a convenience because it's passed consistently to all invocations of generator functions.
+While you could manually configure your Rails code to pass the "`railsContext` information" with
+the rest of your "props", the `railsContext` is a convenience because it's passed consistently to
+all invocations of render functions.
 
-For example, suppose you create a "generator function" called MyAppComponent.
+For example, suppose you create a "render-function" called MyAppComponent.
 
 ```js
 import React from 'react';
 const MyAppComponent = (props, railsContext) => (
-  <div>
-    <p>props are: {JSON.stringify(props)}</p>
-    <p>railsContext is: {JSON.stringify(railsContext)}
-    </p>
-  </div>
+  // NOTE: need to wrap in a function so this is proper React function component that can use
+  // hooks
+ 
+  // the props get passed again, but we ignore since we use a closure
+  // or should we
+  () =>
+      <div>
+        <p>props are: {JSON.stringify(props)}</p>
+        <p>railsContext is: {JSON.stringify(railsContext)}
+        </p>
+      </div>
 );
 export default MyAppComponent;
 ```
 
+------------------------------
+
+_This would be alternate API where you have to call React.createElement and the React on Rails code doesn't do that._
+
+```js
+import React from 'react';
+const MyAppComponent = (props, railsContext) => (
+  // NOTE: need to wrap in a function so this is proper React function component that can use
+  // hooks
+  React.createElement(
+    () =>
+      <div>
+        <p>props are: {JSON.stringify(props)}</p>
+        <p>railsContext is: {JSON.stringify(railsContext)}
+        </p>
+      </div>,
+  props)
+);
+export default MyAppComponent;
+```
+
+------------------------------------
+
 *Note: you will get a React browser console warning if you try to serverRender this since the value of `serverSide` will be different for server rendering.*
 
-So if you register your generator function `MyAppComponent`, it will get called like:
+So if you register your render-function `MyAppComponent`, it will get called like:
 
 ```js
 reactComponent = MyAppComponent(props, railsContext);
 ```
 
-and, similarly, any redux store always initialized with 2 parameters:
+and, similarly, any redux store is always initialized with 2 parameters:
 
 ```js
 reduxStore = MyReduxStore(props, railsContext);
 ```
 
-Note: you never make these calls. React on Rails makes these calls when it does either client or server rendering. You will define functions that take these 2 params and return a React component or a Redux Store. Naturally, you do not have to use second parameter of the railsContext if you do not need it.
+Note: you never make these calls. React on Rails makes these calls when it does either client or server rendering. You will define functions that take these 2 params and return a React component or a Redux Store. Naturally, you do not have to use second parameter of the railsContext if you do not need it. If you don't take a second parameter, then you're probably defining a React function component and you will simply return a React Element, often just JSX.
 
 (Note: see below [section](#multiple-react-components-on-a-page-with-one-store) on how to setup redux stores that allow multiple components to talk to the same store.)
 
@@ -76,7 +111,7 @@ Plus, you can add your customizations to this. See "rendering extension" below.
 
 ## Rails Context
 
-The `railsContext` is a second param passed to your generator functions for React components. This is in addition to the props that are passed from the `react_component` Rails helper. For example:
+The `railsContext` is a second param passed to your render-functions for React components. This is in addition to the props that are passed from the `react_component` Rails helper. For example:
 
 ERB view file: 
 
@@ -91,7 +126,8 @@ This is what your HelloWorld.js file might contain. The railsContext is always a
 import React from 'react';
 
 export default (props, railsContext) => {
-  return (
+  // Note, wrap in a function so this is React function component
+  return () => (
     <div>
       Your locale is {railsContext.i18nLocale}.<br/>
       Hello, {props.name}!
@@ -100,15 +136,17 @@ export default (props, railsContext) => {
 };
 ``` 
 
-## Why is the railsContext is only passed to generator functions?
+## Why is the railsContext only passed to render-functions?
 
-There's no reason that the railsContext would ever get passed to your React component unless the value is explicitly put into the props used for rendering. If you create a react component, rather than a generator function, for use by React on Rails, then you get whatever props are passed in from the view helper, which **does not include the Rails Context**. It's trivial to wrap your component in a "generator function" to return a new component that takes both:
+There's no reason that the railsContext would ever get passed to your React component unless the value is explicitly put into the props used for rendering. If you create a react component, rather than a render-function, for use by React on Rails, then you get whatever props are passed in from the view helper, which **does not include the Rails Context**. It's trivial to wrap your component in a "render-function" to return a new component that takes both:
 
 ```js
 import React from 'react';
 import AppComponent from './AppComponent';
 const AppComponentWithRailsContext = (props, railsContext) => (
-  <AppComponent {...{...props, railsContext}}/>
+  // Create a React Function Component so you can
+  // use the React Hooks API in this React Function Component
+  () => <AppComponent {...{...props, railsContext}}/>
 )
 export default AppComponentWithRailsContext;
 ```
@@ -153,7 +191,7 @@ See [spec/dummy/config/initializers/react_on_rails.rb](https://github.com/shakac
 module RenderingExtension
 
   # Return a Hash that contains custom values from the view context that will get merged with
-  # the standard rails_context values and passed to all calls to generator functions used by the
+  # the standard rails_context values and passed to all calls to render-functions used by the
   # react_component and redux_store view helpers
   def self.custom_context(view_context)
     {