react_on_rails 12.0.0.pre.beta.1 → 12.0.1

data/docs/basics/upgrading-react-on-rails.md

@@ -5,28 +5,50 @@ If you would like help in migrating between React on Rails versions or help with
 
 We specialize in helping companies to quickly and efficiently move from versions before 9 to current. The older versions use the Rails asset pipeline to package client assets. The current and recommended way is to use Webpack 4 for asset preparation. You may also need help migrating from the `rails/webpacker`'s Webpack configuration to a better setup ready for Server Side Rendering.
 
-## Upgrading to v13
-* Make sure that you are on a relatively more recent version of rails and webpacker.
-* Updated API for ReactOnRails.register.
+## Upgrading to v12
+### Recent versions
+Make sure that you are on a relatively more recent version of rails and webpacker.
+v12 is tested on Rails 6. It should work on Rails v5. If you're on any older version,
+and v12 doesn't work, please file an issue. 
+
+### Removed Configuration config.symlink_non_digested_assets_regex
+Remove `config.symlink_non_digested_assets_regex` from your `config/initializers/react_on_rails.rb`.
+If you still need that feature, please file an issue.
+
+### i18n default format changed to JSON
+* If you're using the internalization helper, then set `config.i18n_output_format = 'js'`. You can
+  later update to the default JSON format as you will need to update your usage of that file. A JSON
+  format is more efficient.
+
+### Updated API for `ReactOnRails.register()`
 
 In order to solve the issues regarding React Hooks compatibility, the number of parameters
-for functions is used to determine if you have a render function that will get invoked to
+for functions is used to determine if you have a Render-Function that will get invoked to
 return a React component, or you are registering a React component defined by a function.
-
-Registered Objects are of the following types:
+Please see [Render-Functions and the Rails Context](./render-functions-and-railscontext.md) for
+more information on what a Render-Function is.
 
 ##### Correct
-Either of these will work:
-1. Take **2 params** and return **a React function or class component**. A function component is a function
-   that takes zero or one params and returns a React Element, like JSX.
-    ```js
-    export default (props, _railsContext) => () => <Component {...props} />;
-    ```
 
-2. Take only zero or one params and you return a React Element, often JSX.
+Registered Objects are of the following types. Either of these will work:
+1. Takes only zero or one params and you return a React Element, often JSX.
     ```js
     export default (props) => <Component {...props} />;
+    ```       
+2. Takes **2 params** and returns **a React function or class component**. A function
+   component is a function that takes zero or one params and returns a React Element, like JSX.
+    ```js
+    export default (props, _railsContext) => () => <Component {...props} />;
     ```
+   Note, you cannot return a React Element (JSX).
+3. Takes **3 params** and uses the 3rd param, `domNodeId`, to call `ReactDOM.hydrate`
+  
+Previously, with case number 2, you could return a React Element.
+
+The fix is simple. Here is an example of the change you'll do:
+
+![2020-07-07_09-43-51 (1)](https://user-images.githubusercontent.com/1118459/86927351-eff79e80-c0ce-11ea-9172-d6855c45e2bb.png)
+ 
 ##### Broken, as this function takes two params and it returns a React Element from a JSX Literal
 ```js
 export default (props, _railsContext) => <Component {...props} />;

data/docs/basics/webpack-configuration.md

@@ -17,11 +17,11 @@ A key decision in your use React on Rails is whether you go with the rails/webpa
 
 ## Option 1: Recommended: Traditional React on Rails using the /client directory
 
-Until version 9, all React on Rails apps used the `/client` directory for configuring React on Rails in terms of the configuration of Webpack and location of your JavaScript and Webpack files, including the node_modules directory. Version 9 changed the default to `/` for the `node_modules` location using this value in `config/initializers/react_on_rails.rb`: `config.node_modules_location`. The  
+Until version 9, all React on Rails apps used the `/client` directory for configuring React on Rails in terms of the configuration of Webpack and location of your JavaScript and Webpack files, including the node_modules directory. Version 9 changed the default to `/` for the `node_modules` location using this value in `config/initializers/react_on_rails.rb`: `config.node_modules_location`. 
 
-The [ShakaCode Team](http://www.shakacode.com) _recommends_ this approach for projects beyond the simplest cases as it provides the greatest transparency in your webpack and overall client-side setup. The *big advantage* to this is that almost everything within the `/client` directory will apply if you wish to convert your client-side code to a pure Single Page Application that runs without Rails. This allows you to google for how to do something with Webpack configuration and what applies to a non-Rails app will apply just as well to a React on Rails app.
+The [ShakaCode Team](http://www.shakacode.com) _recommends_ this approach for projects beyond the simplest cases as it provides the greatest transparency in your webpack and overall client-side setup. The *big advantage* to this is that almost everything within the `/client` directory will apply if you wish to convert your client-side code to a pure Single Page Application that runs without Rails. This allows you to Google for how to do something with Webpack configuration and what applies to a non-Rails app will apply just as well to a React on Rails app.
 
-The two best examples of this pattern are the [react-webpack-rails-tutorial](https://github.com/shakacode/react-webpack-rails-tutorial) and the integration test example in [spec/dummy](https://github.com/shakacode/react_on_rails/tree/master/spec/dummy).
+An examples of this pattern is the [react-webpack-rails-tutorial](https://github.com/shakacode/react-webpack-rails-tutorial).
 
 In this case, you don't need to understand the nuances of customization of your Webpack config via the [Webpacker mechanism](./docs/additional-reading/webpack-tips.md).
 
@@ -45,10 +45,6 @@ Typical rails/webpacker apps have a standard directory structure as documented [
 
 The *advantage* of using rails/webpacker to configure Webpack is that there is very little code needed to get started and you don't need to understand really anything about Webpack customization. The *big disadvantage* to this is that you will need to learn the ins and outs of the [rails/webpacker way to customize Webpack](https://github.com/rails/webpacker/blob/master/docs/webpack.md) which differs from the plain [Webpack way](https://webpack.js.org/).
 
-Overall, consider carefully if you prefer the `rails/webpacker` directory structure and Webpack configuration, over the placement of all client side files within the `/client` directory along with conventional Webpack configuration. Once again, the `/client` directory setup is recommended.
-
 You can find more details on this topic in [Recommended Project Structure](./recommended-project-structure.md). 
  
 See [Issue 982: Tutorial Generating Correct Project Structure?](https://github.com/shakacode/react_on_rails/issues/982) to discuss this issue.
-
-For more details on project setup, see [Recommended Project Structure](./docs/basics/recommended-project-structure.md).

data/docs/misc/doctrine.md

@@ -19,7 +19,7 @@ The React on Rails setup provides several key components related to front-end de
 6. Happiness for us is actively participating in open source, so we want to be where the action is, which is with the npm libraries on github.com.
 7. You can get set up on React on Rails **FAST** using our application generator.
 8. By placing all client-side development inside of the `/client` directory, pure JavaScript developers can productively do development separate from Rails. Instead of Rails APIs, stub APIs on an express server can provide a simple backend, allowing for rapid iteration of UI prototypes.
-9. Just because we're not relying on the Rails asset pipeline for ES6 conversion does not mean that we're deploying Rails apps in any different way. We still use the asset pipeline to include our Webpack compiled JavaScript. This only requires a few small modifications, as explained in our doc [Heroku Deployment](docs/outdated/heroku-deployment.md).
+9. Just because we're not relying on the Rails asset pipeline for ES6 conversion does not mean that we're deploying Rails apps in any different way. We still use the asset pipeline to include our Webpack compiled JavaScript. This only requires a few small modifications, as explained in our doc [Heroku Deployment](docs/basics/heroku-deployment.md).
 
 ## Convention over Configuration
 * React on Rails has taken the hard work out of figuring out the JavaScript tooling that works best with Rails. Not only could you spend lots of time researching different tooling, but then you'd have to figure out how to splice it all together. This is where a lot of "JavaScript fatigue" comes from. The following keep the code clean and consistent:

data/docs/outdated/code-splitting.md

@@ -21,11 +21,11 @@ Let's say you're requesting a page that needs to fetch a code chunk from the ser
 > (server) <div data-reactroot="
 <!--This comment is here because the comment beginning on line 13 messes up Sublime's markdown parsing-->
 
-Different markup is generated on the client than on the server. Why does this happen? When you register a component or render function with `ReactOnRails.register`, react on rails will render the component as soon as the page loads. However, react-router renders a comment while waiting for the code chunk to be fetched from the server. This means that react will tear all of the server rendered code out of the DOM, and then rerender it a moment later once the code chunk arrives from the server, defeating most of the purpose of server rendering.
+Different markup is generated on the client than on the server. Why does this happen? When you register a component or Render-Function with `ReactOnRails.register`, react on rails will render the component as soon as the page loads. However, react-router renders a comment while waiting for the code chunk to be fetched from the server. This means that react will tear all of the server rendered code out of the DOM, and then rerender it a moment later once the code chunk arrives from the server, defeating most of the purpose of server rendering.
 
 ### The solution
 
-To prevent this, you have to wait until the code chunk is fetched before doing the initial render on the client side. To accomplish this, react on rails allows you to register a renderer. This works just like registering a render function, except that the function you pass takes three arguments: `renderer(props, railsContext, domNodeId)`, and is responsible for calling `ReactDOM.render` or `ReactDOM.hydrate` to render the component to the DOM. React on rails will automatically detect when a render function takes three arguments, and will **not** call `ReactDOM.render` or `ReactDOM.hydrate`, instead allowing you to control the initial render yourself. Note, you have to be careful to call `ReactDOM.hydrate` rather than `ReactDOM.render` if you are are server rendering.
+To prevent this, you have to wait until the code chunk is fetched before doing the initial render on the client side. To accomplish this, react on rails allows you to register a renderer. This works just like registering a Render-Function, except that the function you pass takes three arguments: `renderer(props, railsContext, domNodeId)`, and is responsible for calling `ReactDOM.render` or `ReactDOM.hydrate` to render the component to the DOM. React on rails will automatically detect when a Render-Function takes three arguments, and will **not** call `ReactDOM.render` or `ReactDOM.hydrate`, instead allowing you to control the initial render yourself. Note, you have to be careful to call `ReactDOM.hydrate` rather than `ReactDOM.render` if you are are server rendering.
 
 Here's an example of how you might use this in practice:
 
@@ -134,7 +134,7 @@ If you're going to try to do code splitting with server rendered routes, you'll
 
 The reason is we do server rendering with ExecJS, which is not capable of doing anything asynchronous. It would be impossible to asyncronously fetch a code chunk while server rendering. See [this issue](https://github.com/shakacode/react_on_rails/issues/477) for a discussion.
 
-Also, do not attempt to register a renderer on the server. Instead, register either a render function or a component. If you register a renderer in the server bundle, you'll get an error when react on rails tries to server render the component.
+Also, do not attempt to register a renderer function on the server. Instead, register either a Render-Function or a component. If you register a renderer in the server bundle, you'll get an error when react on rails tries to server render the component.
 
 ## How does Webpack know where to find my code chunks?
 

data/docs/outdated/how-react-on-rails-works.md

@@ -28,13 +28,17 @@ You can see all this on the source for [reactrails.com](https://www.reactrails.c
 
 ## Building the Bundles
 
-Each time you change your client code, you will need to re-generate the bundles (the webpack-created JavaScript files included in application.js). The included example Foreman `Procfile.dev` files will take care of this for you by starting a webpack process with the watch flag. This will watch your JavaScript code files for changes. 
+Each time you change your client code, you will need to re-generate the bundles (the webpack-created JavaScript files included in application.js). The included example Foreman `Procfile.dev` files will take care of this for you by starting a webpack process with the watch flag. This will watch your JavaScript code files for changes. Alternately, the `rails/webpacker` library also can ensure that your bundles are built. 
 
-Simply run `foreman start -f Procfile.dev`. [Example](spec/dummy/Procfile.dev).
+For example, you might create a [Procfile.dev](spec/dummy/Procfile.dev).
 
-On production deployments that use asset precompilation, such as Heroku deployments, React on Rails, by default, will automatically run webpack to build your JavaScript bundles. You configure the command used as `config.build_production_command` in your [config/initializers/react_on_rails.rb](docs/basics/configuration.md).
+On production deployments that use asset precompilation, such as Heroku deployments, `rails/webpacker`, by default, will automatically run webpack to build your JavaScript bundles, running the command `bin/webpack` in your app.
 
-You can see the source code for what gets added to your precompilation [here](https://github.com/shakacode/react_on_rails/tree/master/lib/tasks/assets.rake). For more information on this topic, see [the doc on Heroku deployment](docs/outdated/heroku-deployment.md#more-details-on-precompilation-using-webpack-to-create-javascript-assets).
+However, if you want to run a custom command to run webpack to build your bundles, then you will:
+1. Ensure you do not have a `config/webpack/production.js` file
+1. Define `config.build_production_command` in your [config/initializers/react_on_rails.rb](docs/basics/configuration.md)
+
+Then React on Rails modifies the `assets:precompile` task to run your `build_production_command`.
 
 If you have used the provided generator, these bundles will automatically be added to your `.gitignore` to prevent extraneous noise from re-generated code in your pull requests. You will want to do this manually if you do not use the provided generator.
 

data/docs/outdated/manual-installation-overview.md

@@ -25,6 +25,6 @@ The default path: `public/webpack` can be loaded with webpackConfigLoader as sho
 1. Configure the `config/initializers/react_on_rails.rb`. You can adjust some necessary settings and defaults. See file [spec/dummy/config/initializers/react_on_rails.rb](spec/dummy/config/initializers/react_on_rails.rb) for a detailed example of configuration, including comments on the different values to configure.
 1. Configure your Procfiles per the example apps. These are at the root of your Rails installation.
 1. Configure your top level JavaScript files for inclusion in your layout. You'll want a version that you use for static assets, and you want a file for any files in your setup that are not part of your webpack build. The reason for this is for use with hot-reloading. If you are not using hot reloading, then you only need to configure your `application.js` file to include your Webpack generated files. 
-1. If you are deploying to Heroku, see [heroku-deployment.md](/docs/outdated/heroku-deployment.md)
+1. If you are deploying to Heroku, see [heroku-deployment.md](/docs/basics/heroku-deployment.md)
 
 If I missed anything, please submit a PR or file an issue.

data/docs/outdated/rails-assets.md

@@ -36,13 +36,6 @@ _If you are interested in learning how to use assets in your React components, r
 _Note, this solution was removed in v14. If you're intersted in this symlink solution, please create
 a github issue._
 
-React on Rails creates symlinks of non-digested versions (original webpack digested file names) 
-to the Rails deployed digested versions when doing a Rails assets compile. The solution is 
-implemented using `assets:precompile` after-hook in 
-file [lib/tasks/assets.rake](lib/tasks/assets.rake)
-The assets for symlinking are defined by `config.symlink_non_digested_assets_regex` in 
-`config/initializers/react_on_rails.rb`.
-
 ## Example from /spec/dummy
 
 ```

data/docs/tutorial.md

@@ -119,31 +119,13 @@ foreman start -f Procfile.dev-hmr
 
 Visit [http://localhost:3000/hello_world](http://localhost:3000/hello_world) and see your **React On Rails** app running!
 
-*Note, foreman may default to PORT 5000 unless you set the value of PORT in your environment or in the Procfile.*
-
 # HMR vs. React Hot Reloading
 
-First, check that the `hmr` option is `true` in your `config/webpacker.yml` file.
-
-The basic setup will have HMR working with the default webpacker setup. The basic HMR will cause
-a full page refresh each time you save a file. You also lose any state on your page during the refresh. Don't try to use HMR
-
-### Custom IP & PORT setup (Cloud9 example)
-
-In case you are running some custom setup with different IP or PORT you should also edit Procfile.dev. For example to be able to run on free Cloud9 IDE we are putting IP 0.0.0.0 and PORT 8080. The default generated file `Procfile.dev` uses `-p 3000`.
-
-``` Procfile.dev
-web: rails s -p 8080 -b 0.0.0.0
-```
+First, check that the `hmr` and the `inline` options are `true` in your `config/webpacker.yml` file.
 
-Then visit https://your-shared-addr.c9users.io:8080/hello_world 
-
-## RubyMine
-
-It's super important to exclude certain directories from RubyMine or else it will slow to a crawl as it tries to parse all the npm files.
-
-* Generated files, per the settings in your `config/webpacker.yml`, which default to `public/packs` and `public/packs-test`
-* `node_modules`
+The basic setup will have HMR working with the default webpacker setup. The basic
+[HMR](https://webpack.js.org/concepts/hot-module-replacement/), without a special
+React setup, will cause a full page refresh each time you save a file. 
 
 ## Deploying to Heroku
 
@@ -166,17 +148,16 @@ Set heroku to use multiple buildpacks:
 
 ### Swap out sqlite for postgres by doing the following:
 
-1. Delete the line with `sqlite` and replace it with:
+Run these two commands:
 
-```ruby
-   gem 'pg'
 ```
-
-2. Run `bundle`
+bundle remove sqlite3
+bundle add pg
+```
 
 ![07](https://cloud.githubusercontent.com/assets/20628911/17465015/1f2f4042-5cf4-11e6-8287-2fb077550809.png)
 
-3. Replace your `database.yml` file with this (assuming your app name is "ror").
+### Replace your `database.yml` file with this (assuming your app name is "ror").
 
 ```yml
 default: &default
@@ -204,7 +185,6 @@ production:
 Then you need to setup postgres so you can run locally:
 
 ```
-bundle
 rake db:setup
 rake db:migrate
 ```
@@ -228,7 +208,7 @@ Create `/Procfile`. This is what Heroku uses to start your app.
 web: bundle exec puma -C config/puma.rb
 ```
 
-Note, newer versions of Rails create this file automatically. However, the [docs on Heroku](https://devcenter.heroku.com/articles/deploying-rails-applications-with-the-puma-web-server#config) have something a bit different, so please make it conform to those docs. As of 2018-10-13, the docs looked like this:
+Note, newer versions of Rails create this file automatically. However, the [docs on Heroku](https://devcenter.heroku.com/articles/deploying-rails-applications-with-the-puma-web-server#config) have something a bit different, so please make it conform to those docs. As of 2020-06-04, the docs looked like this:
 
 `config/puma.rb`
 ```rb
@@ -249,6 +229,15 @@ on_worker_boot do
 end
 ```
 
+Next, update your `package.json` to specify the version of yarn and node. Add this section:
+
+```json
+  "engines": {
+    "node": "13.9.0",
+    "yarn": "1.22.4"
+  },
+```
+
 Then after all changes are done don't forget to commit them with git and finally you can push your app to Heroku!
 
 ```
@@ -339,6 +328,27 @@ So you get some basics from HMR with no code changes. If you want to go further,
 
 React on Rails will automatically handle disabling server rendering if there is only one bundle file created by the Webpack development server by rails/webpacker.
 
+
+### Custom IP & PORT setup (Cloud9 example)
+
+In case you are running some custom setup with different IP or PORT you should also edit Procfile.dev. For example to be able to run on free Cloud9 IDE we are putting IP 0.0.0.0 and PORT 8080. The default generated file `Procfile.dev` uses `-p 3000`.
+
+``` Procfile.dev
+web: rails s -p 8080 -b 0.0.0.0
+```
+
+Then visit https://your-shared-addr.c9users.io:8080/hello_world 
+
+## RubyMine
+
+It's super important to exclude certain directories from RubyMine or else it will slow to a crawl as it tries to parse all the npm files.
+
+* Generated files, per the settings in your `config/webpacker.yml`, which default to `public/packs` and `public/packs-test`
+* `node_modules`
+
+
+
+
 ## Conclusion
 
 * Browse the docs either on the [gitbook](https://shakacode.gitbooks.io/react-on-rails/content/) or in the [docs directory on github](https://github.com/shakacode/react_on_rails/tree/master/docs)

data/lib/generators/react_on_rails/templates/base/base/Procfile.dev-hmr

@@ -1,18 +1,26 @@
+# Procfile for development using HMR
+
 web: rails s -p 3000
 
 # Note, hot and live reloading don't work with the default generator setup on
 # top of the rails/webpacker Webpack config with server rendering.
 # If you have server rendering enabled (prerender is true), you either need to
-# a. Skip using the webpack-dev-server. bin/webpack --watch is typically
+# a. Ensure that you have dev_server.hmr and dev_server.inline BOTH set to false,
+#    and you have this option in your config/initializers/react_on_rails.rb:
+#      config.same_bundle_for_client_and_server = true
+#    If you have either config/webpacker.yml option set to true, 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)
+# b. Skip using the webpack-dev-server. bin/webpack --watch is typically
      fast enough.
-# b. See the React on Rails README for a link to documentation for how to setup
-#    SSR with HMR and React hot loading
-# Otherwise, you will have an error. If you want HMR and Server Rendering, see
-# the example in the https://github.com/shakacode/react-webpack-rails-tutorial
-web: rails s -p 3000
+# c. See the React on Rails README for a link to documentation for how to setup
+#    SSR with HMR and React hot loading using the webpack-dev-server only for the
+#    client bundles and a static file for the server bundle.
 
-# Run the hot reload server for client development
+# Run the webpack-dev-server for client and maybe server files
 webpack-dev-server: bin/webpack-dev-server
 
-# Keep the JS fresh for server rendering. Remove if not server rendering
-rails-server-assets: SERVER_BUNDLE_ONLY=yes bin/webpack --watch
+# Keep the JS fresh for server rendering. Remove if not server rendering.
+# Especially if you have not configured generation of a server bundle without a hash.
+# as that will conflict with the manifest created by the bin/webpack-dev-server
+# rails-server-assets: SERVER_BUNDLE_ONLY=yes bin/webpack --watch

data/lib/generators/react_on_rails/templates/base/base/config/initializers/react_on_rails.rb

@@ -6,7 +6,8 @@
 ReactOnRails.configure do |config|
   # This configures the script to run to build the production assets by webpack. Set this to nil
   # if you don't want react_on_rails building this file for you.
-  config.build_production_command = "RAILS_ENV=production NODE_ENV=production bin/webpack"
+  # If nil, then the standard rails/webpacker assets:precompile will run
+  # config.build_production_command = nil
 
   ################################################################################
   ################################################################################
@@ -22,6 +23,8 @@ ReactOnRails.configure do |config|
   # with rspec then this controls what yarn command is run
   # to automatically refresh your webpack assets on every test run.
   #
+  # Alternately, you can remove the `ReactOnRails::TestHelper.configure_rspec_to_compile_assets`
+  # and set the config/webpacker.yml option for test to true.
   config.build_test_command = "RAILS_ENV=test bin/webpack"
 
   ################################################################################

data/lib/react_on_rails/configuration.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# rubocop:disable Metrics/ClassLength
+
 module ReactOnRails
   def self.configure
     yield(configuration)
@@ -107,10 +109,46 @@ module ReactOnRails
       check_i18n_yml_directory_exists
       check_server_render_method_is_only_execjs
       error_if_using_webpacker_and_generated_assets_dir_not_match_public_output_path
+      check_deprecated_settings
     end
 
     private
 
+    def check_deprecated_settings
+      if build_production_command.present? &&
+         ReactOnRails::WebpackerUtils.webpacker_webpack_production_config_exists?
+        msg = <<~MSG
+          Setting ReactOnRails configuration for `build_production_command` is
+          not necessary if you have config/webpack/production.js. When that file
+          exists, React on Rails DOES NOT modify the standard assets:precompile.
+          If you want React on Rails to modify to the standard assets:precompile
+          to use your config/initializers/react_on_rails.rb config.build_production_command
+          then delete the config/webpack/production.js.
+        MSG
+        Rails.logger.warn(msg)
+      end
+      #
+      # msg = <<~MSG
+      #   ReactOnRails configuration for `build_production_command` is removed.
+      #   Move this command into `bin/webpack` converting the script to a shell script.
+      # MSG
+      # raise ReactOnRails::Error, msg
+      # Commenting out until v13 when
+      # https://github.com/rails/webpacker/issues/2640 gets resolved
+      # if node_modules_location.present?
+      #   Rails.logger.warn("ReactOnRails configuration for `node_modules_location` is deprecated. "\
+      #    "Instead, prepend a `cd client` (or whichever location) before your test command.")
+      # end
+      #
+      # return unless build_production_command.present?
+      #
+      # msg = <<~MSG
+      #   ReactOnRails configuration for `build_production_command` is removed.
+      #   Move this command into `bin/webpack` converting the script to a shell script.
+      # MSG
+      # raise ReactOnRails::Error, msg
+    end
+
     def error_if_using_webpacker_and_generated_assets_dir_not_match_public_output_path
       return unless ReactOnRails::WebpackerUtils.using_webpacker?
 
@@ -122,12 +160,12 @@ module ReactOnRails
         Rails.logger.warn("You specified generated_assets_dir in `config/initializers/react_on_rails.rb` "\
         "with Webpacker. Remove this line from your configuration file.")
       else
-        msg = <<-MSG.strip_heredoc
-        Error configuring /config/initializers/react_on_rails.rb: You are using webpacker
-        and your specified value for generated_assets_dir = #{generated_assets_dir}
-        that does not match the value for public_output_path specified in
-        webpacker.yml = #{webpacker_public_output_path}. You should remove the configuration
-        value for "generated_assets_dir" from your config/initializers/react_on_rails.rb file.
+        msg = <<~MSG
+          Error configuring /config/initializers/react_on_rails.rb: You are using webpacker
+          and your specified value for generated_assets_dir = #{generated_assets_dir}
+          that does not match the value for public_output_path specified in
+          webpacker.yml = #{webpacker_public_output_path}. You should remove the configuration
+          value for "generated_assets_dir" from your config/initializers/react_on_rails.rb file.
         MSG
         raise ReactOnRails::Error, msg
       end
@@ -214,3 +252,4 @@ module ReactOnRails
     end
   end
 end
+# rubocop:enable Metrics/ClassLength

data/lib/react_on_rails/helper.rb

@@ -17,13 +17,13 @@ module ReactOnRails
 
     COMPONENT_HTML_KEY = "componentHtml"
 
-    # react_component_name: can be a React function or class component or a "render function".
-    # "render functions" differ from a React function in that they take two parameters, the
+    # react_component_name: can be a React function or class component or a "Render-Function".
+    # "Render-Functions" differ from a React function in that they take two parameters, the
     #   props and the railsContext, like this:
     #
     #   let MyReactComponentApp = (props, railsContext) => <MyReactComponent {...props}/>;
     #
-    #   Alternately, you can define the render function with an additional property
+    #   Alternately, you can define the Render-Function with an additional property
     #   `.renderFunction = true`:
     #
     #   let MyReactComponentApp = (props) => <MyReactComponent {...props}/>;
@@ -79,7 +79,7 @@ module ReactOnRails
           Value:
           #{server_rendered_html}
 
-          If you're trying to use a render function to return a Hash to your ruby view code, then use
+          If you're trying to use a Render-Function to return a Hash to your ruby view code, then use
           react_component_hash instead of react_component and see
           https://github.com/shakacode/react_on_rails/blob/master/spec/dummy/client/app/startup/ReactHelmetServerApp.jsx
           for an example of the JavaScript code.
@@ -93,7 +93,7 @@ module ReactOnRails
     # It is exactly like react_component except for the following:
     # 1. prerender: true is automatically added, as this method doesn't make sense for client only
     #    rendering.
-    # 2. Your JavaScript render 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 the view code:
@@ -124,10 +124,10 @@ module ReactOnRails
         )
       else
         msg = <<~MSG
-          render function used by react_component_hash for #{component_name} is expected to return
+          Render-Function used by react_component_hash for #{component_name} is expected to return
           an Object. See https://github.com/shakacode/react_on_rails/blob/master/spec/dummy/client/app/startup/ReactHelmetServerApp.jsx
           for an example of the JavaScript code.
-          Note, your render function must either take 2 params or have the property
+          Note, your Render-Function must either take 2 params or have the property
           `.renderFunction = true` added to it to distinguish it from a React Function Component.
         MSG
         raise ReactOnRails::Error, msg
@@ -240,7 +240,7 @@ module ReactOnRails
     end
 
     # This is the definitive list of the default values used for the rails_context, which is the
-    # second parameter passed to both component and store render functions.
+    # second parameter passed to both component and store Render-Functions.
     # This method can be called from views and from the controller, as `helpers.rails_context`
     #
     # rubocop:disable Metrics/AbcSize