react_on_rails 13.1.0 → 13.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67d4584eb27dc3faa475b108565c57f201da8be1b50959f280c1e9904d22e891
-  data.tar.gz: c1d0c37d9cf8be39c87b7976466c10d72837f7b777b39b5b1d3771fb1602c097
+  metadata.gz: e61be8a6315e32bd3127d5ed676e1235c9e44cb43ff011dde722947c4f18b518
+  data.tar.gz: 61be21f2eda6b8a58688af7a69f88b70c2b0dbfe23a9addf68f2894829e96787
 SHA512:
-  metadata.gz: 8ddc27d5e684c33d23234221989fa04ba4c46a44ade8593a392e2444feb4b569a74334c3b704ff4124bc6ae89a8ca9210736ea37afb6e11e574c3aadafb2e0f4
-  data.tar.gz: bbcdae693b9cad8f964ec85b89a61ad656b2192ee5b26476d039d3328d31eb47fd6c91e361b31d4ab68a2647477dcfb2d631b98a771e6d956ea44523aa55309d
+  metadata.gz: '069f91f435f7609c582a197e100e0140c9d4045b472fa163a06819847d860a339d0fba56ab408d32aa7307cb2b1205dfd5387b6e503810897a4898d6acf56dee'
+  data.tar.gz: ed764a94f2cf6b4ff1a50d605c73cab97371e0a0bc68bb344bc1978988c54b213b44cbc2bce6f6045158d662e7e8201e829f801df2a07392394dfcfcade3e3d4

data/.circleci/config.yml

@@ -205,6 +205,9 @@ jobs:
       - run: *install-yalc-add-react-on-rails
       - run: *install-dummy-app-node-modules
       - run: *install-dummy-app-ruby-gems
+      - run:
+          name: generate file system-based packs
+          command: cd spec/dummy && bundle exec rake react_on_rails:generate_packs
       - run:
           name: Build test bundles for dummy app
           command: cd spec/dummy && yarn run build:test
@@ -269,12 +272,12 @@ jobs:
           name: Prep for CI
           # TODO -- need to leverage Circle CI containers
           command: |
-            bundle exec rake prepare_for_ci
+            bundle exec rails prepare_for_ci
       - run:
           name: Main CI
           # TODO -- need to leverage Circle CI containers
           command: |
-            bundle exec rake run_rspec:all_dummy
+            bundle exec rails run_rspec:all_dummy
       # The following step will run only if the main job is finished successfully.
       # Build hook is triggered by curl command described here https://docs.netlify.com/configure-builds/build-hooks/
       # NETLIFY_HOOK is an environment variable on CircleCI to keep sensitive data outside the repo

data/.github/workflows/lint-js-and-ruby.yml

@@ -8,7 +8,7 @@ jobs:
       matrix:
         ruby: [2.7]
         node: [14]
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     steps:
     - uses: actions/checkout@v2
     - name: Setup Ruby
@@ -32,12 +32,12 @@ jobs:
       uses: actions/cache@v2
       with:
         path: node_modules
-        key: v4-package-node-modules-cache-${{ hashFiles('yarn.lock') }}
+        key: v5-package-node-modules-cache-${{ hashFiles('yarn.lock') }}
     - name: Save root ruby gems to cache
       uses: actions/cache@v2
       with:
         path: vendor/bundle
-        key: v4-package-app-gem-cache-${{ hashFiles('react_on_rails.gemspec') }}
+        key: v5-package-app-gem-cache-${{ hashFiles('react_on_rails.gemspec') }}
     - name: Install Node modules with Yarn for renderer package
       run: |
         yarn install --no-progress --no-emoji

data/.github/workflows/main.yml

@@ -8,13 +8,17 @@ jobs:
       matrix:
         ruby: [2.7]
         node: [14]
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     steps:
     - uses: actions/checkout@v2
     - name: Setup Ruby
       uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby }}
+    # libyaml-dev is needed for psych v5
+    # this gem depends on sdoc which depends on rdoc which depends on psych
+    - name: Fix dependency for libyaml-dev
+      run: sudo apt install libyaml-dev
     - name: Setup Node
       uses: actions/setup-node@v2-beta
       with:
@@ -32,7 +36,7 @@ jobs:
       uses: actions/cache@v2
       with:
         path: node_modules
-        key: v4-package-node-modules-cache-${{ hashFiles('yarn.lock') }}
+        key: v5-package-node-modules-cache-${{ hashFiles('yarn.lock') }}
     - name: Install Node modules with Yarn for renderer package
       run: |
         yarn install --no-progress --no-emoji
@@ -44,7 +48,7 @@ jobs:
       uses: actions/cache@v2
       with:
         path: spec/dummy/node_modules
-        key: v4-dummy-app-node-modules-cache-${{ hashFiles('spec/dummy/yarn.lock') }}
+        key: v5-dummy-app-node-modules-cache-${{ hashFiles('spec/dummy/yarn.lock') }}
     - name: yalc add react-on-rails
       run: cd spec/dummy && yalc add react-on-rails
     - name: Install Node modules with Yarn for dummy app
@@ -53,9 +57,11 @@ jobs:
       uses: actions/cache@v2
       with:
         path: spec/dummy/vendor/bundle
-        key: v4-dummy-app-gem-cache-${{ hashFiles('spec/dummy/Gemfile.lock') }}
+        key: v5-dummy-app-gem-cache-${{ hashFiles('spec/dummy/Gemfile.lock') }}
     - name: Install Ruby Gems for dummy app
       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: generate file system-based packs
+      run: cd spec/dummy && RAILS_ENV=test bundle exec rake react_on_rails:generate_packs
     - name: Build test bundles for dummy app
       run: cd spec/dummy && yarn run build:test
     - id: get-sha
@@ -64,7 +70,7 @@ jobs:
       uses: actions/cache@v2
       with:
         path: spec/dummy/public/webpack
-        key: v4-dummy-app-webpack-bundle-${{ steps.get-sha.outputs.sha }}
+        key: v5-dummy-app-webpack-bundle-${{ steps.get-sha.outputs.sha }}
 
   main:
     needs: build-dummy-app-webpack-test-bundles
@@ -73,7 +79,7 @@ jobs:
         ruby: [2.7]
         node: [14]
         rake_task: ['run_rspec:all_dummy', 'run_rspec:all_but_examples', 'run_rspec:examples']
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     steps:
     - uses: actions/checkout@v2
     - name: Setup Ruby
@@ -97,29 +103,29 @@ jobs:
       uses: actions/cache@v2
       with:
         path: node_modules
-        key: v4-package-node-modules-cache-${{ hashFiles('yarn.lock') }}
+        key: v5-package-node-modules-cache-${{ hashFiles('yarn.lock') }}
     - name: Save root ruby gems to cache
       uses: actions/cache@v2
       with:
         path: vendor/bundle
-        key: v4-package-app-gem-cache-${{ hashFiles('react_on_rails.gemspec') }}
+        key: v5-package-app-gem-cache-${{ hashFiles('react_on_rails.gemspec') }}
     - name: Save dummy app ruby gems to cache
       uses: actions/cache@v2
       with:
         path: spec/dummy/vendor/bundle
-        key: v4-dummy-app-gem-cache-${{ hashFiles('spec/dummy/Gemfile.lock') }}
+        key: v5-dummy-app-gem-cache-${{ hashFiles('spec/dummy/Gemfile.lock') }}
     - name: Save spec/dummy/node_modules to cache
       uses: actions/cache@v2
       with:
         path: spec/dummy/node_modules
-        key: v4-dummy-app-node-modules-cache-${{ hashFiles('spec/dummy/yarn.lock') }}
+        key: v5-dummy-app-node-modules-cache-${{ hashFiles('spec/dummy/yarn.lock') }}
     - id: get-sha
       run: echo "::set-output name=sha::$(git rev-parse HEAD)"
     - name: Save test webpack bundles to cache (for build number checksum used by rspec job)
       uses: actions/cache@v2
       with:
         path: spec/dummy/public/webpack
-        key: v4-dummy-app-webpack-bundle-${{ steps.get-sha.outputs.sha }}
+        key: v5-dummy-app-webpack-bundle-${{ steps.get-sha.outputs.sha }}
 
     - name: Install Node modules with Yarn for renderer package
       run: |
@@ -153,9 +159,9 @@ jobs:
     - name: Increase the amount of inotify watchers
       run: echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p
     - name: Prep for CI
-      run: bundle exec rake prepare_for_ci
+      run: bundle exec rails prepare_for_ci
     - name: Main CI
-      run: bundle exec rake ${{ matrix.rake_task }}
+      run: bundle exec rails ${{ matrix.rake_task }}
     - name: Store test results
       uses: actions/upload-artifact@v2
       with:

data/.github/workflows/package-js-tests.yml

@@ -7,7 +7,7 @@ jobs:
     strategy:
       matrix:
         node: [12, 14]
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     steps:
     - uses: actions/checkout@v2
     - name: Setup Node
@@ -25,7 +25,7 @@ jobs:
       uses: actions/cache@v2
       with:
         path: node_modules
-        key: v4-package-node-modules-cache-${{ hashFiles('yarn.lock') }}
+        key: v5-package-node-modules-cache-${{ hashFiles('yarn.lock') }}
     - name: Install Node modules with Yarn for renderer package
       run: |
         yarn install --no-progress --no-emoji

data/.github/workflows/rspec-package-specs.yml

@@ -8,7 +8,7 @@ jobs:
       matrix:
         ruby: [2.7]
         node: [14]
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     steps:
     - uses: actions/checkout@v2
     - name: Setup Ruby
@@ -28,7 +28,7 @@ jobs:
       uses: actions/cache@v2
       with:
         path: vendor/bundle
-        key: v4-package-app-gem-cache-${{ hashFiles('react_on_rails.gemspec') }}
+        key: v5-package-app-gem-cache-${{ hashFiles('react_on_rails.gemspec') }}
     - name: Install Ruby Gems for package
       run: bundle check --path=vendor/bundle || bundle install --path=vendor/bundle --jobs=4 --retry=3
     - name: Run rspec tests

data/.rubocop.yml

@@ -94,6 +94,8 @@ RSpec/AnyInstance:
   Exclude:
     - 'spec/react_on_rails/git_utils_spec.rb'
     - 'spec/react_on_rails/locales_to_js_spec.rb'
+    - 'spec/react_on_rails/binstubs/dev_spec.rb'
+    - 'spec/react_on_rails/binstubs/dev_static_spec.rb'
 
 RSpec/DescribeClass:
   Enabled: false
@@ -111,6 +113,8 @@ RSpec/BeforeAfterAll:
   Exclude:
     - 'spec/react_on_rails/generators/dev_tests_generator_spec.rb'
     - 'spec/react_on_rails/generators/install_generator_spec.rb'
+    - 'spec/react_on_rails/binstubs/dev_spec.rb'
+    - 'spec/react_on_rails/binstubs/dev_static_spec.rb'
 
 RSpec/MessageChain:
   Enabled: false

data/CHANGELOG.md

@@ -17,6 +17,24 @@ Changes since last non-beta release.
 
 *Please add entries here for your pull requests that are not yet released.*
 
+### [13.3.0] - 2022-01-29
+### Fixed
+- Fixed pack not found warning while using `react_component` and `react_component_hash` helpers, even when corresponding chunks are present. [PR 1511](https://github.com/shakacode/react_on_rails/pull/1511) by [pulkitkkr](https://github.com/pulkitkkr)
+- Fixed FS-based packs generation functionality to trigger pack generation  on the creation of a new react component inside `components_subdirectory`. [PR 1506](https://github.com/shakacode/react_on_rails/pull/1506) by [pulkitkkr](https://github.com/pulkitkkr)
+- Upgrade several JS dependencies to fix security issues. [PR 1514](https://github.com/shakacode/react_on_rails/pull/1514) by [ahangarha](https://github.com/ahangarha)
+
+### Added
+- Added `./bin/dev` and `./bin/dev-static` executables to ease and standardize running the dev server. [PR 1491](https://github.com/shakacode/react_on_rails/pull/1491) by [ahangarha](https://github.com/ahangarha)
+
+### [13.2.0] - 2022-12-23
+                                           
+### Fixed
+- Fix reactOnRailsPageUnloaded when there is no component on the page. Important for apps using both hotwire and react_on_rails. [PR 1498](https://github.com/shakacode/react_on_rails/pull/1498) by [NhanHo](https://github.com/NhanHo).
+- Fixing wrong type. The throwIfMissing param of getStore should be optional as it defaults to true. [PR 1480](https://github.com/shakacode/react_on_rails/pull/1480) by [wouldntsavezion](https://github.com/wouldntsavezion).
+
+### Added
+- Exposed `reactHydrateOrRender` utility via [PR 1481](https://github.com/shakacode/react_on_rails/pull/1481) by [vaukalak](https://github.com/vaukalak).
+
 ### [13.1.0] - 2022-08-20
 
 #### Improved
@@ -1042,7 +1060,9 @@ Best done with Object destructing:
 ##### Fixed
 - Fix several generator related issues.
 
-[Unreleased]: https://github.com/shakacode/react_on_rails/compare/13.0.2...master
+[Unreleased]: https://github.com/shakacode/react_on_rails/compare/13.3.0...master
+[13.3.0]: https://github.com/shakacode/react_on_rails/compare/13.2.0...13.3.0
+[13.2.0]: https://github.com/shakacode/react_on_rails/compare/13.1.0...13.2.0
 [13.1.0]: https://github.com/shakacode/react_on_rails/compare/13.0.2...13.1.0
 [13.0.2]: https://github.com/shakacode/react_on_rails/compare/13.0.1...13.0.2
 [13.0.1]: https://github.com/shakacode/react_on_rails/compare/13.0.0...13.0.1

data/Gemfile.development_dependencies

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-gem "shakapacker", ">= 6.4.0"
+gem "shakapacker", "6.5.1"
 gem "bootsnap", require: false
 gem "rails", "~> 7.0"
 gem "sqlite3"
 gem "sass-rails", "~> 6.0"
 gem "uglifier"
 gem "jquery-rails"
-gem "puma"
+gem "puma", "~> 5.0"
 
 # Turbolinks makes following links in your web application faster. Read more: https://github.com/rails/turbolinks
 gem "turbolinks" if ENV["DISABLE_TURBOLINKS"].nil? || ENV["DISABLE_TURBOLINKS"].strip.empty?

data/README.md

@@ -48,6 +48,8 @@ To provide a high performance framework for integrating Ruby on Rails with React
 
 Given that `rails/webpacker` gem already provides basic React integration, why would you use "React on Rails"?
 
+1. Automatic configuration of what bundles are added to the page based on what React components are on the page. This results in faster browser loading time via smaller bundle sizes.
+1. Keep up with the latest changes of different versions of React. React 18 is supported.
 1. Easy passing of props directly from your Rails view to your React components rather than having your Rails view load and then make a separate request to your API.
 Tight integration with [shakapacker](https://github.com/shakacode/shakapacker) (or it's predecessor [rails/webpacker](https://github.com/rails/webpacker)).
 1. Server-Side Rendering (SSR), often used for SEO crawler indexing and UX performance.
@@ -96,6 +98,11 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 # Supporters
 
+The following companies support our open source projects, and ShakaCode uses their products!
+
+<br />
+<br />
+
 <a href="https://www.jetbrains.com">
   <img src="https://user-images.githubusercontent.com/4244251/184881139-42e4076b-024b-4b30-8c60-c3cd0e758c0a.png" alt="JetBrains" height="120px">
 </a>
@@ -120,8 +127,3 @@ The gem is available as open source under the terms of the [MIT License](https:/
 <a href="https://www.honeybadger.io">
   <img src="https://user-images.githubusercontent.com/4244251/184881133-79ee9c3c-8165-4852-958e-31687b9536f4.png" alt="Honeybadger" height="55px">
 </a>
-
-<br />
-<br />
-
-The following companies support our open source projects, and ShakaCode uses their products!

data/docs/api/javascript-api.md

@@ -58,6 +58,15 @@ The best source of docs is the main [ReactOnRails.js](https://github.com/shakaco
    */
   getStore(name, throwIfMissing = true )
 
+  /**
+   * Renders or hydrates the react element passed. In case react version is >=18 will use the new api.
+   * @param domNode
+   * @param reactElement
+   * @param hydrate if true will perform hydration, if false will render
+   * @returns {Root|ReactComponent|ReactElement|null}
+   */
+  reactHydrateOrRender(domNode, reactElement, hydrate)
+
   /**
    * Set options for ReactOnRails, typically before you call ReactOnRails.register
    * Available Options:

data/docs/getting-started.md

@@ -9,15 +9,25 @@ Note, the best way to understand how to use ReactOnRails is to study a few simpl
 
 ## Basic Installation
 
-*See also [the instructions for installing into an existing Rails app](https://www.shakacode.com/react-on-rails/docs/guides/installation-into-an-existing-rails-app/).*
+These steps assume that you've got a rails application with webpacker (e.g. one
+generated using `rails new my_app --javascript=webpack`). If your
+application is not yet set up to use webpacker, please see 
+[the instructions for installing into an existing Rails app](https://www.shakacode.com/react-on-rails/docs/guides/installation-into-an-existing-rails-app/).*
 
-1. Add the `react_on_rails` gem to Gemfile:
+1. Add the `shakapacker` and `react_on_rails` gem to Gemfile:
 
    ```bash
+   bundle add shakapacker --strict
    bundle add react_on_rails --strict
    ```
 
-2. Commit this to git (or else you cannot run the generator unless you pass the option `--ignore-warnings`).
+2. Run installation command for webpacker:
+
+   ```bash
+   rails webpacker:install
+   ```
+
+3. Commit this to git (or else you cannot run the generator unless you pass the option `--ignore-warnings`).
 
 3. Run the generator:
 
@@ -27,9 +37,8 @@ Note, the best way to understand how to use ReactOnRails is to study a few simpl
 
 4. Start the app:
 
-   ```bash
-   rails s
-   ```
+   - Run `./bin/dev` for HMR
+   - Run `./bin/dev-static` for statically created bundles (no HMR)
 
 5. Visit http://localhost:3000/hello_world.
 

data/docs/guides/configuration.md

@@ -47,6 +47,11 @@ for all client files, including your sources and node_modules.
 # NOTE: you typically will leave the commented out configurations set to their defaults.
 # Thus, you only need to pay careful attention to the non-commented settings in this file.
 ReactOnRails.configure do |config|
+  # You can optionally add values to your rails_context. This object is passed
+  # every time a component renders.
+  # See below for an example definition of RenderingExtension
+  config.rendering_extension = RenderingExtension
+  
   # `trace`: General debugging flag.
   # The default is true for development, off otherwise.
   # With true, you get detailed logs of rendering and stack traces if you call setTimout,
@@ -74,6 +79,10 @@ ReactOnRails.configure do |config|
   # In this example, the module BuildProductionCommand would have a class method `call`.
   config.build_production_command = "RAILS_ENV=production bin/webpacker"
 
+  # NOTE:
+  # When specifying `build_production_command`, you need to disable `rails/webpacker` 
+  # configuration by setting `webpacker_precompile: false` in your `config/webpacker.yml` file.
+
   # See bottom for an example of the BuildProductionCommand module.
   # config.build_production_command = BuildProductionCommand
   # If you wish to utilize ReactOnRailsPro production bundle caching logic, then use
@@ -95,6 +104,11 @@ ReactOnRails.configure do |config|
   # If you are hashing this file (supposing you are using the same file for client rendering), then
   # you should include a name that matches your bundle name in your webpack config.
   config.server_bundle_js_file = "server-bundle.js"
+  
+  # `prerender` means server-side rendering
+  # default is false. This is an option for view helpers `render_component` and `render_component_hash`.
+  # Set to true to change the default value to true. 
+  config.prerender = false
 
   # THE BELOW OPTIONS FOR SERVER-SIDE RENDERING RARELY NEED CHANGING
   #
@@ -154,14 +168,19 @@ ReactOnRails.configure do |config|
   ################################################################################
   ################################################################################
   # FILE SYSTEM BASED COMPONENT REGISTRY
+  # `render_component` and `render_component_hash` view helper methods can
+  # auto-load the bundle for the generated component, to avoid having to specify the
+  # bundle manually for each view with the component.
   ################################################################################
   # components_subdirectory is the name of the subdirectory matched to detect and register components automatically
   # The default is nil. You can enable the feature by updating it in the next line.
-  config.components_subdirectory = "ror_components"
-  
-  # For automated component registry, `render_component` view helper method tries to load bundle for component from
-  # generated directory. default is false, you can pass option at the time of individual usage or update the default
-  # in the following line
+  config.components_subdirectory = nil
+  # Change to a value like this example to enable this feature 
+  # config.components_subdirectory = "ror_components"
+
+  # Default configuration to auto loading bundles for components.
+  # default is false. The default can be overrident as an option in calls to view helpers
+  # `render_component` and `render_component_hash`. You may set to true to change the default to auto loading.
   config.auto_load_bundle = false
 
   ################################################################################
@@ -184,20 +203,6 @@ ReactOnRails.configure do |config|
   # The default format is json
   config.i18n_output_format = 'json'
 
-  ################################################################################
-  ################################################################################
-  # CLIENT RENDERING OPTIONS
-  # Below options can be overridden by passing options to the react_on_rails
-  # `render_component` view helper method.
-  ################################################################################
-  # default is false
-  config.prerender = false
-
-  # You can optionally add values to your rails_context. This object is passed
-  # every time a component renders.
-  # See below for an example definition of RenderingExtension
-  config.rendering_extension = RenderingExtension
-
   ################################################################################
   ################################################################################
   # TEST CONFIGURATION OPTIONS
@@ -226,7 +231,7 @@ ReactOnRails.configure do |config|
   #
   # Define the files we need to check for webpack compilation when running tests.
   # The default is `%w( manifest.json )` as will be sufficient for most webpacker builds.
-  # However, if you are generated a server bundle that is NOT hashed (present in manifest.json),
+  # However, if you are generating a server bundle that is NOT hashed (present in manifest.json),
   # then include the file in this list like this:
   config.webpack_generated_files = %w( server-bundle.js manifest.json )
   # Note, be sure NOT to include your server-bundle.js if it is hashed, or else React on Rails will

data/docs/guides/file-system-based-automated-bundle-generation.md

@@ -5,7 +5,8 @@ To use the automated bundle generation feature introduced in React on Rails v13.
 ## Configuration
 
 ### Enable nested_entries for Shakapacker
-To use the automated bundle generation feature, set nested_entries: true in the webpacker.yml file like this. The generated files will go in a nested directory.
+To use the automated bundle generation feature, set `nested_entries: true` in the `webpacker.yml` file like this.
+The generated files will go in a nested directory.
 
 ```yml
 default:
@@ -36,7 +37,7 @@ config.auto_load_bundle = true
 ```
 
 ### Update `.gitignore` file
-React on Rails automatically generates pack files for components to be registered in the `packs/generated` directory. To avoid committing generated files into the version control system, please update `.gitignore` to have 
+React on Rails automatically generates pack files for components to be registered in the `packs/generated` directory. To avoid committing generated files into the version control system, please update `.gitignore` to have
 
 ```gitignore
 # Generated React on Rails packs
@@ -55,11 +56,11 @@ If the `webpacker.yml` file is configured as instructed [here](https://github.co
 ```yml
 default: &default
   source_path: app/javascript
-  source_entry_path: packs 
+  source_entry_path: packs
   public_root_path: public
   public_output_path: packs
   nested_entries: true
-# And more 
+# And more
 ```
 
 the directory structure will look like this
@@ -100,7 +101,7 @@ Your layout would contain:
 ```
 
 
-Suppose, you want to use bundle splitting to minimize unnecessary javascript loaded on each page, You would put each of your components in the `packs` directory. 
+Suppose, you want to use bundle splitting to minimize unnecessary javascript loaded on each page, you would put each of your components in the `packs` directory.
 ```
 app/javascript:
   └── packs:               # sets up webpack entries
@@ -138,8 +139,8 @@ Your layout would now contain:
 
 ```
 app/javascript:
-  └── packs                      
-  └── src:                   
+  └── packs
+  └── src:
   │   └── Foo
   │   │ └── ...
   │   │ └── ror_components          # configured as `components_subdirectory`
@@ -148,25 +149,25 @@ app/javascript:
   │   │ └── ...
   │   │ └── ror_components          # configured as `components_subdirectory`
   │   │   │ └── BarComponentOne.jsx
-  │   │   │ └── BarComponentTwo.jsx       
+  │   │   │ └── BarComponentTwo.jsx
 ```
 
 4. You no longer need to register these React components nor directly add their bundles. For example you can have a Rails view using three components:
 
 ```erb
-    <%= react_component("FooComponentOne", {}, auto_load_bundle: true) %>    
-    <%= react_component("BarComponentOne", {}, auto_load_bundle: true) %>    
-    <%= react_component("BarComponentTwo", {}, auto_load_bundle: true) %>    
+    <%= react_component("FooComponentOne", {}, auto_load_bundle: true) %>
+    <%= react_component("BarComponentOne", {}, auto_load_bundle: true) %>
+    <%= react_component("BarComponentTwo", {}, auto_load_bundle: true) %>
 ```
 
 If `FooComponentOne` uses multiple HTML strings for server rendering, the [`react_component_hash`](https://www.shakacode.com/react-on-rails/docs/api/view-helpers-api/#react_component_hash) view helper can be used on the Rails view, as illustrated below.
 
 ```erb
-<% foo_component_one_data = react_component_hash("FooComponentOne", 
+<% foo_component_one_data = react_component_hash("FooComponentOne",
                                              prerender: true,
                                              auto_load_bundle: true
                                              props: {}
-                                          ) %>   
+                                          ) %>
 <% content_for :title do %>
    <%= foo_component_one_data['title'] %>
 <% end %>
@@ -179,6 +180,8 @@ The default value of the `auto_load_bundle` parameter can be specified by settin
 
 If server rendering is enabled, the component will be registered for usage both in server and client rendering. In order to have separate definitions for client and server rendering, name the component files as `ComponentName.server.jsx` and `ComponentName.client.jsx`. The `ComponentName.server.jsx` file will be used for server rendering and the `ComponentName.client.jsx` file for client rendering. If you don't want the component rendered on the server, you should only have the `ComponentName.client.jsx` file.
 
+Once generated, all server entrypoints will be imported into a file named `[ReactOnRails.configuration.server_bundle_js_file]-generated.js`, which in turn will be imported into a source file named the same as `ReactOnRails.configuration.server_bundle_js_file`. If your server bundling logic is such that your server bundle source entrypoint is not named the same as your `ReactOnRails.configuration.server_bundle_js_file` & changing it would be difficult, please let us know.
+
 *Note: If specifying separate definitions for client and server rendering, please make sure to delete the generalized `ComponentName.jsx` file.*
 
 ### Using Automated Bundle Generation Feature with already defined packs

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

@@ -7,48 +7,46 @@
 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 `package.json` file.
 
    ```ruby
-   gem "react_on_rails", "12.0.0" # Update to the current version
-   gem "webpacker", "~> 5"
+   gem "react_on_rails", "13.1.0" # Use the latest and the exact version
+   gem "shakapacker", "6.5.4"
    ```
 
-1. Add the webpacker and react_on_rails gems
-_Use the latest version for react_on_rails._
+   Or use `bundle add`:
 
-```
-bundle add webpacker                 
-bundle add react_on_rails --version=12.0.4 --strict
-```
+   ```bash
+   bundle add react_on_rails --version=13.1.0 --strict
+   bundle add shakapacker --strict
+   ```
 
 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
-   bundle exec rails webpacker:install
-   bundle exec rails webpacker:install:react
+   rails webpacker:install
    ```
 
 3. Commit this to git (or else you cannot run the generator unless you pass the option `--ignore-warnings`).
 
-4. See help for the generator:
+4. Run the generator with a simple "Hello World" example (more options below):
 
    ```bash
-   $ rails generate react_on_rails:install --help
+   rails generate react_on_rails:install
    ```
 
-5. Run the generator with a simple "Hello World" example (more options below):
+   For more information about this generator use `--help` option:
 
    ```bash
-   $ rails generate react_on_rails:install
+   rails generate react_on_rails:install --help
    ```
+5. Ensure that you have `overmind` or `foreman` installed
 
-6. Ensure that you have `foreman` installed: `gem install foreman`.
-
-7. Start your Rails server:
+6. Start your Rails server:
 
    ```bash
-   $ foreman start -f Procfile.dev
+   ./bin/dev
    ```
+   Note: `foreman` defaults to PORT 5000 unless you set the value of PORT in your environment. For example, you can `export PORT=3000` to use the Rails default port of 3000. For the hello_world example this is already set.
 
-8. Visit [localhost:3000/hello_world](http://localhost:3000/hello_world). Note: `foreman` defaults to PORT 5000 unless you set the value of PORT in your environment. For example, you can `export PORT=3000` to use the Rails default port of 3000. For the hello_world example this is already set.
+7. Visit [localhost:3000/hello_world](http://localhost:3000/hello_world).
 
 ## Installation
 
@@ -60,7 +58,7 @@ See the [Installation Overview](https://www.shakacode.com/react-on-rails/docs/ad
 All JavaScript in React On Rails is loaded from npm: [react-on-rails](https://www.npmjs.com/package/react-on-rails). To manually install this (you did not use the generator), assuming you have a standard configuration, run this command (assuming you are in the directory where you have your `node_modules`):
 
 ```bash
-$ yarn add react-on-rails --exact
+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.