react_on_rails 12.5.0 → 13.0.0.beta.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28e3d2a5f4910c2d0e1aec7d57f2b3d5073cc3317d65dc92d209608d6b305dcd
-  data.tar.gz: f3280cfe4e5e57aeb60da72928a45ff01df41890ee7ab8a018cb6b4fefef61c8
+  metadata.gz: cdfa729f75cfd337b3436fe6e310d7e6a7789455fcba1baa729a2288d98c646f
+  data.tar.gz: 54495ad6beed806991e973866a4ccd62fd7b41d3141cbaec2e71a07e13999563
 SHA512:
-  metadata.gz: 9ee357656b8bf3fd8367d6036269f8d844c2e6dc72a6133698930dcfae138bfc7312d44d383dcd8d8db20d67da2b110e177374d18322738619ff4de7d43080e4
-  data.tar.gz: 6a291c92e4d2c86d9b1b6c3bac60a2a4980c7b0c876227d53ad741c802f23a1a63c2bcb451b19a89f0c7e8eb583617d42cafc0810d5f3289866e23def0f8fb8c
+  metadata.gz: d0610cfa82d1d1b60f09f1586fb966dcfa12daf8549762f09e74a1fc00df6e0c8374138950e5195db0bed8501f7d8f3a1f62d90a9a779e6b652a0ada08d19d4e
+  data.tar.gz: 9e87301d7790829e6fe2391a68cf8de6e5724777e11b955b112783c7cfec13820d5a0c28691c5f2851ec49c92ab20e886b8c2a7b4c3fe2cfcec727d662cc4490

data/.circleci/config.yml

@@ -55,7 +55,7 @@ aliases:
     command: |
       gem install bundler
       echo "Bundler version: "; bundle --version
-      cd spec/dummy && bundle check --path=vendor/bundle || bundle install --path=vendor/bundle --jobs=4 --retry=3
+      cd spec/dummy && bundle lock --add-platform 'x86_64-linux' && bundle check --path=vendor/bundle || bundle install --path=vendor/bundle --jobs=4 --retry=3
 
   # Install ruby gems unless existing set of gems is satisfying bundler.
   - &install-package-ruby-gems
@@ -63,6 +63,7 @@ aliases:
     command: |
       gem install bundler
       echo "Bundler version: "; bundle --version
+      bundle lock --add-platform 'x86_64-linux'
       bundle check --path=vendor/bundle || bundle install --path=vendor/bundle --jobs=4 --retry=3
 
   # Restore node_modules dir from cache using yarn.lock checksum as a key.
@@ -316,6 +317,7 @@ workflows:
       - build-dummy-app-webpack-test-bundles:
           requires:
             - install-dummy-app-node-packages
+            - install-dummy-app-ruby-gems
       - package-js-tests:
           requires:
             - install-package-node-packages

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,23 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+A bug is a crash or incorrect behavior. If you have a debugging or troubleshooting question, please open [a discussion](https://github.com/shakacode/react_on_rails/discussions).
+
+## Environment
+
+1. Ruby version:
+2. Rails version:
+3. Webpacker version:
+4. React on Rails version:
+
+## Expected behavior
+
+## Actual behavior
+
+## Small, reproducible repo

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.github/workflows/main.yml

@@ -55,7 +55,7 @@ jobs:
         path: spec/dummy/vendor/bundle
         key: v4-dummy-app-gem-cache-${{ hashFiles('spec/dummy/Gemfile.lock') }}
     - name: Install Ruby Gems for dummy app
-      run: cd spec/dummy && bundle check --path=vendor/bundle || bundle install --path=vendor/bundle --jobs=4 --retry=3
+      run: cd spec/dummy && bundle lock --add-platform 'x86_64-linux' && bundle check --path=vendor/bundle || bundle install --path=vendor/bundle --jobs=4 --retry=3
     - name: Build test bundles for dummy app
       run: cd spec/dummy && yarn run build:test
     - id: get-sha
@@ -131,9 +131,9 @@ jobs:
     - name: yalc add react-on-rails
       run: cd spec/dummy && yalc add react-on-rails
     - name: Install Ruby Gems for package
-      run: bundle check --path=vendor/bundle || bundle install --path=vendor/bundle --jobs=4 --retry=3
+      run:  bundle lock --add-platform 'x86_64-linux' && bundle check --path=vendor/bundle || bundle install --path=vendor/bundle --jobs=4 --retry=3
     - name: Install Ruby Gems for dummy app
-      run: cd spec/dummy && bundle check --path=vendor/bundle || bundle install --path=vendor/bundle --jobs=4 --retry=3
+      run: cd spec/dummy && bundle lock --add-platform 'x86_64-linux' && bundle check --path=vendor/bundle || bundle install --path=vendor/bundle --jobs=4 --retry=3
     - name: Ensure minimum required Chrome version
       run: |
         echo -e "Already installed $(google-chrome --version)\n"

data/.gitignore

@@ -11,9 +11,6 @@
 /vendor/
 
 /spec/examples.txt
-/spec/dummy/client/node_modules
-/spec/dummy/public/webpack/
-/spec/dummy/coverage/
 /spec/react_on_rails/dummy-for-generators/
 
 # RVM

data/.prettierignore

@@ -8,3 +8,5 @@ gen-examples/examples/*
 node_package/lib/*
 spec/react_on_rails/dummy-for-generators/app/javascript/bundles/HelloWorld/*
 bundle/
+spec/dummy/lib/bs/**
+*.bs.js

data/CHANGELOG.md

@@ -17,10 +17,25 @@ Changes since last non-beta release.
 
 *Please add entries here for your pull requests that are not yet released.*
 
+### [12.6.0] - 2022-01-22
+
+### Added
+- A `rendering_props_extension` configuration which takes a module with an `adjust_props_for_client_side_hydration` method, which is used to process props differently for server/client if `prerender` is set to `true`. [PR 1413](https://github.com/shakacode/react_on_rails/pull/1413) by [gscarv13](https://github.com/gscarv13) & [judahmeek](https://github.com/judahmeek).
+
+### [12.5.2] - 2021-12-29
+### Fixed
+- Usage of config.build_production_command for custom command for production builds fixed. [PR 1415](https://github.com/shakacode/react_on_rails/pull/1415) by [judahmeek](https://github.com/judahmeek).
+
+### [12.5.1] - 2021-12-27
+
+### Fixed
+- A fatal server rendering error if running an ReactOnRails >=12.4.0 with ReactOnRails Pro <2.4.0. [PR 1412](https://github.com/shakacode/react_on_rails/pull/1412) by [judahmeek](https://github.com/judahmeek).
+
 ### [12.5.0] - 2021-12-26
 
 #### Added
-- Added webpack configuration files as part of the generator and updated webpacker to version 6 [PR 1404](https://github.com/shakacode/react_on_rails/pull/1404) by [gscarv13](https://github.com/gscarv13).
+- Support for React 18, including the changed SSR API. [PR 1409](https://github.com/shakacode/react_on_rails/pull/1409) by [kylemellander](https://github.com/kylemellander).
+- Added webpack configuration files as part of the generator and updated webpacker to version 6. [PR 1404](https://github.com/shakacode/react_on_rails/pull/1404) by [gscarv13](https://github.com/gscarv13).
 - Supports Rails 7.
 
 #### Changed
@@ -92,7 +107,7 @@ invoked to return the React component. In that case, you won't need to pass any
 [PR 1268](https://github.com/shakacode/react_on_rails/pull/1268) by [justin808](https://github.com/justin808)
 
 See [docs/guides/upgrading-react-on-rails](https://www.shakacode.com/react-on-rails/docs/guides/upgrading-react-on-rails#upgrading-to-v12)
-for details.         
+for details.
 
 #### Other Updates
 * `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 for server-side rendering.
@@ -984,7 +999,11 @@ Best done with Object destructing:
 ##### Fixed
 - Fix several generator related issues.
 
-[Unreleased]: https://github.com/shakacode/react_on_rails/compare/12.4.0...master
+[Unreleased]: https://github.com/shakacode/react_on_rails/compare/12.6.0...master
+[12.6.0]: https://github.com/shakacode/react_on_rails/compare/12.5.2...12.6.0
+[12.5.2]: https://github.com/shakacode/react_on_rails/compare/12.5.1...12.5.2
+[12.5.1]: https://github.com/shakacode/react_on_rails/compare/12.5.0...12.5.1
+[12.5.0]: https://github.com/shakacode/react_on_rails/compare/12.4.0...12.5.0
 [12.4.0]: https://github.com/shakacode/react_on_rails/compare/12.3.0...12.4.0
 [12.3.0]: https://github.com/shakacode/react_on_rails/compare/12.2.0...12.3.0
 [12.2.0]: https://github.com/shakacode/react_on_rails/compare/12.1.0...12.2.0

data/Gemfile.development_dependencies

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-gem "webpacker", "6.0.0.rc.6"
+gem "shakapacker", ">= 6.1.1"
 gem "bootsnap", require: false
-gem "rails"
+gem "rails", "~> 7.0"
 gem "sqlite3"
-gem "sass-rails"
+gem "sass-rails", "~> 6.0"
 gem "uglifier"
 gem "jquery-rails"
 gem "puma"
@@ -17,11 +17,11 @@ gem "jbuilder"
 # bundle exec rake doc:rails generates the API under doc/api.
 gem "sdoc", group: :doc
 
-gem "sprockets"
+gem "sprockets", "~> 4.0"
 
 gem "amazing_print"
 
-gem "mini_racer"
+gem "mini_racer", ">= 0.6.2"
 
 group :development, :test do
   gem "listen"
@@ -34,7 +34,7 @@ group :development, :test do
   gem "rubocop-performance", require: false
   gem "rubocop-rspec", require: false
   gem "scss_lint", require: false
-  gem "spring"
+  gem "spring", "~> 4.0"
 end
 
 group :test do

data/README.md

@@ -12,14 +12,12 @@
 [![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)
 
 # News
+* ShakaCode now maintains the official successor to `rails/webpacker`, [`shakapacker`](https://github.com/shakacode/shakapacker).
 * Project is updated to support Rails 7!
-* **React and Webpack with Ruby on Rails**: The current version of https://github.com/rails/webpacker will soon ship. While it won't be the default for Rails 7, it is not "deprecated." The core webpack configuration has become slimmer, allowing easier extension. If you want to get started today, use the master branch of  [shakacode/react_on_rails_tutorial_with_ssr_and_hmr_fast_refresh](https://github.com/shakacode/react_on_rails_tutorial_with_ssr_and_hmr_fast_refresh) with `gem "webpacker", "6.0.0.rc.6"` Any updates to get to v6 from this point forward should be simple.
-
-If you have time, please comment on Justin's final proposals for Webpacker v6: [webpacker/pulls/justin808](https://github.com/rails/webpacker/pulls/justin808).
 
 -----
 
-*These are the docs for React on Rails 12. To see the version 11 docs, [click here](https://github.com/shakacode/react_on_rails/tree/11.3.0).*
+*These are the docs for React on Rails 13. To see the older docs: [v12](https://github.com/shakacode/react_on_rails/tree/12.6.0) and [v11](https://github.com/shakacode/react_on_rails/tree/11.3.0).*
 
 #### About
 React on Rails integrates Rails with (server rendering of) Facebook's [React](https://github.com/facebook/react) front-end framework.
@@ -29,13 +27,13 @@ This project is maintained by the software consulting firm [ShakaCode](https://w
 Are you interested in optimizing your webpack setup for React on Rails including code
 splitting with [react-router](https://github.com/ReactTraining/react-router#readme) and
  [loadable-components](https://loadable-components.com/) with server-side rendering for SEO and hot-reloading for developers?
-We 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/). Check out [React on Rails Pro](https://www.shakacode.com/react-on-rails-pro/).
+We 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/). Several years later, Popmenu is serving millions of SSR requests per day React on Rails.
 
-For more information, feel free to contact Justin Gordon, [justin@shakacode.com](mailto:justin@shakacode.com), maintainer of React on Rails.
+Check out [React on Rails Pro](https://www.shakacode.com/react-on-rails-pro/). For more information, feel free to contact Justin Gordon, [justin@shakacode.com](mailto:justin@shakacode.com), maintainer of React on Rails.
 
 # Documentation
 
-See the documentation at [shakacode.com/react-on-rails/docs](https://www.shakacode.com/react-on-rails/docs/).
+See the documentation at **[shakacode.com/react-on-rails/docs](https://www.shakacode.com/react-on-rails/docs/)**.
 
 ## Project Objective
 
@@ -55,11 +53,9 @@ Given that `rails/webpacker` gem already provides basic React integration, why w
 
 See [Rails/Webpacker React Integration Options](https://www.shakacode.com/react-on-rails/docs/guides/rails-webpacker-react-integration-options) for comparisons to other gems.
 
-See the [react-webpack-rails-tutorial](https://github.com/shakacode/react-webpack-rails-tutorial) for an example of a live implementation and code.
-
 ## Online demo
-
-A deployed version of the project `spec/dummy` which demonstrates several uses of `react_on_rails` is available on heroku [through this link](https://ror-spec-dummy.herokuapp.com/)
+* See the [react-webpack-rails-tutorial](https://github.com/shakacode/react-webpack-rails-tutorial) for an example of a live implementation and code.
+* A deployed version of the project `spec/dummy` which demonstrates several uses of `react_on_rails` is available on heroku [through this link](https://ror-spec-dummy.herokuapp.com/)
 
 ## ShakaCode Forum Premium Content
 _Requires creating a free account._
@@ -67,20 +63,19 @@ _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)
 * [How to conditionally render server side based on the device type](https://forum.shakacode.com/t/how-to-conditionally-render-server-side-based-on-the-device-type/1473)
 
-
 ## Prerequisites
 
-Ruby on Rails >=5 and rails/webpacker 4.2+.
+Ruby on Rails >=5, rails/webpacker >= 4.2, Ruby >= 2.7
 
 # Support
 
 * [Click to join **React + Rails Slack**](https://reactrails.slack.com/join/shared_invite/enQtNjY3NTczMjczNzYxLTlmYjdiZmY3MTVlMzU2YWE0OWM0MzNiZDI0MzdkZGFiZTFkYTFkOGVjODBmOWEyYWQ3MzA2NGE1YWJjNmVlMGE).
 - [**Subscribe**](https://app.mailerlite.com/webforms/landing/l1d9x5) for announcements of new releases of React on Rails and of our latest [blog articles](https://blog.shakacode.com) and tutorials.
-- **[forum.shakacode.com](https://forum.shakacode.com)**: Post your questions
+- [Discussions](https://github.com/shakacode/react_on_rails/discussions): Post your questions regarding React on Rails
+- **[forum.shakacode.com](https://forum.shakacode.com)**: Other discussions
 - **[@railsonmaui on Twitter](https://twitter.com/railsonmaui)**
 - *See [NEWS.md](https://github.com/shakacode/react_on_rails/tree/master/NEWS.md) for more notes over time.*
 - See [Projects](https://github.com/shakacode/react_on_rails/tree/master/PROJECTS.md) using and [KUDOS](https://github.com/shakacode/react_on_rails/tree/master/KUDOS.md) for React on Rails. Please submit yours! Please edit either page or [email us](mailto:contact@shakacode.com) and we'll add your info. We also **love stars** as it helps us attract new users and contributors.
-- *See [NEWS.md](https://github.com/shakacode/react_on_rails/tree/master/NEWS.md) for more notes over time.*
 
 ## Contributing
 

data/docs/deployment/heroku-deployment.md

@@ -22,7 +22,7 @@ Alternatively, you can specify `config.build_production_command` to have
 react_on_rails invoke a command for you during assets:precompile.
 
 ```
-config.build_production_command = "RAILS_ENV=production bin/webpack"
+config.build_production_command = "RAILS_ENV=production NODE_ENV=production bin/webpacker"
 ```
 
 ### Consider Removing Webpacker's clean task

data/docs/guides/configuration.md

@@ -68,11 +68,11 @@ ReactOnRails.configure do |config|
 
   # 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. If so,
-  # set this value to nil.  Alternatively, you can specify `config.build_production_command` 
+  # set this value to nil.  Alternatively, you can specify `config.build_production_command`
   # to have react_on_rails invoke a command for you during assets:precompile.
   # The command is either a script or a module containing a class method `call`
   # In this example, the module BuildProductionCommand would have a class method `call`.
-  config.build_production_command = "RAILS_ENV=production bin/webpack"
+  config.build_production_command = "RAILS_ENV=production bin/webpacker"
 
   # See bottom for an example of the BuildProductionCommand module.
   # config.build_production_command = BuildProductionCommand
@@ -129,6 +129,11 @@ ReactOnRails.configure do |config|
   # any server rendering issues immediately during development.
   config.raise_on_prerender_error = Rails.env.development?
 
+  # This configuration allows logic to be applied to client rendered props, such as stripping props that are only used during server rendering.
+  # Add a module with an adjust_props_for_client_side_hydration method that expects the component's name & props hash
+  # See below for an example definition of RenderingPropsExtension
+  config.rendering_props_extension = RenderingPropsExtension
+
   ################################################################################
   # Server Renderer Configuration for ExecJS
   ################################################################################
@@ -176,9 +181,8 @@ ReactOnRails.configure do |config|
 
   # You can optionally add values to your rails_context. This object is passed
   # every time a component renders.
-  # See example below for an example definition of RenderingExtension
-  #
-  # config.rendering_extension = RenderingExtension
+  # See below for an example definition of RenderingExtension
+  config.rendering_extension = RenderingExtension
 
   ################################################################################
   ################################################################################
@@ -199,7 +203,7 @@ ReactOnRails.configure do |config|
   # with rspec then this controls what yarn command is run
   # to automatically refresh your webpack assets on every test run.
   #
-  config.build_test_command = "RAILS_ENV=test bin/webpack"
+  config.build_test_command = "RAILS_ENV=test bin/webpacker"
 
   # CONFIGURE YOUR SOURCE FILES
   # The test helper needs to know where your JavaScript files exist. The value is configured
@@ -216,14 +220,25 @@ ReactOnRails.configure do |config|
 end
 ```
 
+Example of a ReactOnRailsConfig module for `client_props_extension`:
+
+```ruby
+module RenderingPropsExtension
+  # The modify_props method will be called by ReactOnRails::ReactComponent::RenderOptions if config.client_props_extension is defined
+  def self.adjust_props_for_client_side_hydration(component_name, props)
+    component_name == 'HelloWorld' ? props.except(:server_side_only) : props
+  end
+end
+```
+
 Example of a ReactOnRailsConfig module for `production_build_command`:
 
 ```ruby
 module BuildProductionCommand
   include FileUtils
-  # Method with the name of call will be called during assets:precompile
+  # The call method will be called during assets:precompile
   def self.call
-    sh "bin/webpack"
+    sh "bin/webpacker"
   end
 end
 ```

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

@@ -11,10 +11,10 @@ The webpack-dev-server provides:
    For use with webpack, see **Client Side rendering and HMR using react-refresh-webpack-plugin** section bellow or visit [react-refresh-webpack-plugin](https://github.com/pmmmwh/react-refresh-webpack-plugin) for additional details.
 
 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` 
+then you can follow all the regular docs for using the `bin/webpacker-dev-server` 
 during development.
 
-# Server Side Rendering with the Default rails/webpacker bin/webpack-dev-server
+# Server Side Rendering with the Default rails/webpacker bin/webpacker-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
@@ -41,7 +41,7 @@ If you don't configure these two to false, you'll see errors like:
 
 # Client Side rendering with HMR using react-refresh-webpack-plugin
 ## Basic installation
-To enable HMR functionality you have to use `./bin/webpack-dev-server`
+To enable HMR functionality you have to use `./bin/webpacker-dev-server`
 1. In `config/webpacker.yml` set **hmr** and **inline** `dev_server` properties to true. 
     ```
     dev_server:
@@ -59,7 +59,7 @@ To enable HMR functionality you have to use `./bin/webpack-dev-server`
 
 3. HMR is for use with the webpack-dev-server, so we only add this for the webpack-dev-server.
    ```
-   const { devServer } = require('@rails/webpacker')
+   const { devServer } = require('shakapacker')
 
    const isWebpackDevServer = process.env.WEBPACK_DEV_SERVER
 

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

@@ -32,7 +32,7 @@ Each time you change your client code, you will need to re-generate the bundles
 
 For example, you might create a [Procfile.dev](https://github.com/shakacode/react_on_rails/tree/master/spec/dummy/Procfile.dev).
 
-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.
+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/webpacker` in your app.
 
 However, if you want to run a custom command to run webpack to build your bundles, then you will:
 1. Define `config.build_production_command` in your [config/initializers/react_on_rails.rb](https://www.shakacode.com/react-on-rails/docs/guides/configuration/)

data/docs/guides/rspec-configuration.md

@@ -12,7 +12,7 @@ compiled by webpack before running tests and during production deployment:
 2. **Use the react_on_rails settings and helpers**. Use the settings in `config/initializers/react_on_rails.rb`. Refer to [docs/configuration](https://www.shakacode.com/react-on-rails/docs/guides/configuration/).
 
 ```yml
-  config.build_test_command = "NODE_ENV=test RAILS_ENV=test bin/webpack"
+  config.build_test_command = "NODE_ENV=test RAILS_ENV=test bin/webpacker"
 ```
 
 Which should you use? If you're already using the `rails/webpacker` way to configure webpack, then

data/docs/guides/tutorial.md

@@ -4,7 +4,7 @@
 
 -----
 
-*Updated for Ruby 2.7.1, Rails 6.0.3.1, React on Rails v12.5.0, and Webpacker v6*
+*Updated for Ruby 2.7.1, Rails 6.0.3.1, React on Rails v12.5.0, and Shakapacker v6*
 
 This tutorial guides you through setting up a new or existing Rails app with **React on Rails**, demonstrating Rails + React + Redux + Server Rendering.
 
@@ -21,18 +21,16 @@ By the time you read this, the latest may have changed. Be sure to check the ver
 * https://rubygems.org/gems/react_on_rails
 * https://www.npmjs.com/package/react-on-rails
 
-_Note: some of the screen images below show the "npm" command. react_on_rails 6.6.0 and greater uses `yarn`._
-
 ## Setting up your environment
 
-Trying out **React on Rails** is super easy, so long as you have the basic prerequisites. This includes the basics for Rails 6.x and node version 13+. I recommend `rvm` and `nvm` to install Ruby and Node, and [brew](https://brew.sh/) to install [yarn](https://yarnpkg.com/en/docs/install#mac-tab). Rails can be installed as an ordinary gem.
+Trying out **React on Rails** is super easy, so long as you have the basic prerequisites. This includes the basics for Rails 6.x and node version 14+. I recommend `rvm` or `rbevn` and `nvm` to install Ruby and Node. Rails can be installed as an ordinary gem.
 
 ```
 nvm install node                # download and install latest stable Node
 nvm alias default node          # make it default version
 nvm list                        # check
 
-brew install yarn               # you can use other installer if desired
+brew install yarn               # you can use other installer if desired, such as yvm
 rvm install 2.7                 # download and install latest stable Ruby (update to exact version)
 rvm use 2.7 --default           # use it and make it default
 rvm list                        # check
@@ -46,40 +44,37 @@ Then we need to create a fresh Rails application as following.
 
 First be sure to run `rails -v` and check you are using Rails 5.1.3 or above. If you are using an older version of Rails, you'll need to install webpacker with react per the instructions [here](https://github.com/rails/webpacker).
 
-```
+```bash
 cd <directory where you want to create your new Rails app>
 
 # Any name you like for the rails app
 # Skip javascript so will add that next and get the current version
-rails new --skip-sprockets --skip-turbolinks --javascript=webpack test-react-on-rails
+rails new --skip-turbolinks --skip-javascript test-react-on-rails
 
 cd test-react-on-rails
 ```
 
-## Add the webpacker and react_on_rails gems
+## Add the shakapacker and react_on_rails gems
 To avoid issues regarding inconsistent gem and npm versions, you should specify the exact versions
 of both the gem and npm package. In other words, don't use the `^` or `~` in the version specifications.
-_Use the latest version for react_on_rails._
+_Use the latest version for `react_on_rails` and `shakapacker`._
 
 ```
-gem 'react_on_rails', '12.5.0'         # prefer exact gem version to match npm version
+gem 'react_on_rails', '13.0.0'         # prefer exact gem version to match npm version
+gem 'shakapacker', '6.1.1'             # prefer exact gem version to match npm version
+
 ```
 
 Note: The latest released React On Rails version is considered stable. Please use the latest
 version to ensure you get all the security patches and the best support.
 
-```bash
-bundle add webpacker --git=https://github.com/rails/webpacker.git
-bundle add react_on_rails --version=12.5.0 --strict
-```
-
-## Run the webpacker generator
+## Run the webpacker (shakapacker) generator
 
 ```terminal
 bundle exec rails webpacker:install
 ```
 
-Let's commit everything before installing React on Rails.
+**Let's commit everything before installing React on Rails.**
 
 ```
 # Here are git commands to make a new git repo and commit everything.
@@ -98,10 +93,11 @@ If you want the redux install: `rails generate react_on_rails:install --redux`
 The generator will add `mini_racer`'s latest version. If you're using linux & encounter issues installing `libv8`, here's [a common solution](https://github.com/rubyjs/mini_racer/issues/218).
 
 ```
-rails generate react_on_rails:install
+bundle exec rails generate react_on_rails:install
 ```
 
-Enter `a` to replace all configuration files required by the project.
+Enter `a` to replace all configuration files required by the project. You can check the diffs
+before you commit to see what changed.
 
 Then run the server with one of the following options:
 

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

@@ -5,6 +5,21 @@ If you would like help in migrating between React on Rails versions or help with
 
 We specialize in helping companies to quickly and efficiently upgrade. 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
+
+### Breaking Change
+Previously, the gem `webpacker` was a Gem dependency.
+
+v13 has changed slightly to switch to `shakapacker`.
+
+For details, see see the [Shakapacker guide to upgrading](https://github.com/shakacode/shakapacker/blob/master/docs/v6_upgrade.md)
+
+In summary:
+
+1. Change the gem reference from 'webpacker' to 'shakapacker'
+2. Change the npm reference from '@rails/webpacker' to 'shakapacker'
+3. Other updates, depending on what version of rails/webpacker that you had.
+
 ## Upgrading to v12
 ### Recent versions
 Make sure that you are on a relatively more recent version of rails and webpacker. Yes, the [rails/webpacker](https://github.com/rails/webpacker) gem is required!

data/docs/guides/webpack-configuration.md

@@ -33,7 +33,7 @@ Until version 9, all React on Rails apps used the `/client` directory for config
 You can access values in the `config/webpacker.yml`
 
 ```js
-const { config, devServer } = require('@rails/webpacker');
+const { config, devServer } = require('shakapacker');
 ```
 
 You will want consider using some of the same values set in these files:

data/docs/javascript/converting-from-custom-webpack-config-to-rails-webpacker-config.md

@@ -4,7 +4,7 @@
   and avoid any duplicates. We don't want different versions of the same packages.
   We want the versions from rails/webpacker unless we specifically want to override them.
 2. Search the rails/webpacker repo for anything you're not sure about in terms of package names.
-3. run `bin/webpack` and make sure there are zero errors
+3. run `bin/webpacker` and make sure there are zero errors
 4. update webpack plugins and loaders to current or close to current
-5. Make sure that your bin/webpack and bin/webpacker match the latest on
+5. Make sure that your bin/webpacker and bin/webpacker match the latest on
 https://github.com/rails/webpacker/tree/master/lib/install/bin

data/lib/generators/react_on_rails/base_generator.rb

@@ -54,6 +54,7 @@ module ReactOnRails
                         config/webpack/development.js
                         config/webpack/production.js
                         config/webpack/serverWebpackConfig.js
+                        config/webpack/webpack.config.js
                         config/webpack/webpackConfig.js]
         config = {
           message: "// The source code including full typescript support is available at:"
@@ -136,28 +137,28 @@ module ReactOnRails
 
           What to do next:
 
-            - See the documentation on https://github.com/rails/webpacker/blob/master/docs/webpack.md
+            - See the documentation on https://github.com/shakacode/shakapacker#webpack-configuration
               for how to customize the default webpack configuration.
 
             - Include your webpack assets to your application layout.
 
                 <%= javascript_pack_tag 'hello-world-bundle' %>
 
-            - Run `rails s` to start the Rails server and use Webpacker's default lazy compilation.
+            - Run `rails s` to start the Rails server.
 
-            - Visit http://localhost:3000/hello_world and see your React On Rails app running!
-
-            - Run bin/webpack-dev-server to start the Webpack dev server for compilation of Webpack
+            - Run bin/webpacker-dev-server to start the Webpack dev server for compilation of Webpack
               assets as soon as you save. This default setup with the dev server does not work
               for server rendering
 
-            - Alternately, you may turn off compile in config/webpacker.yml and run the foreman
-              command to start the rails server and run webpack in watch mode.
+            - Visit http://localhost:3000/hello_world and see your React On Rails app running!
+
+            - Alternately, run the foreman command to start the rails server and run webpack#{' '}
+              in watch mode.
 
                 foreman start -f Procfile.dev-static
 
             - To turn on HMR, edit config/webpacker.yml and set HMR to true. Restart the rails server
-              and bin/webpack-dev-server. Or use Procfile.dev.
+              and bin/webpacker-dev-server. Or use Procfile.dev.
 
             - To server render, change this line app/views/hello_world/index.html.erb to
               `prerender: true` to see server rendering (right click on page and select "view source").

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

@@ -1,5 +1,5 @@
 # Procfile for development using HMR
 # You can run these commands in separate shells
 rails: bundle exec rails s -p 3000
-wp-client: HMR=true bin/webpack-dev-server
-wp-server: HMR=true SERVER_BUNDLE_ONLY=yes bin/webpack --watch
+wp-client: HMR=true bin/webpacker-dev-server
+wp-server: HMR=true SERVER_BUNDLE_ONLY=yes bin/webpacker --watch

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

@@ -5,5 +5,5 @@ web: rails s -p 3000
 # When making frequent changes to client side assets, you will prefer building webpack assets
 # upon saving rather than when you refresh your browser page.
 # Note, if using React on Rails localization you will need to run
-# `bundle exec rake react_on_rails:locale` before you run bin/webpack
-webpack: sh -c 'rm -rf public/packs/* || true && bin/webpack -w'
+# `bundle exec rake react_on_rails:locale` before you run bin/webpacker
+webpack: sh -c 'rm -rf public/packs/* || true && bin/webpacker -w'