react_on_rails 13.1.0 → 13.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67d4584eb27dc3faa475b108565c57f201da8be1b50959f280c1e9904d22e891
-  data.tar.gz: c1d0c37d9cf8be39c87b7976466c10d72837f7b777b39b5b1d3771fb1602c097
+  metadata.gz: 763474ed712a00d925c374048aca65cef79aa72ababa1ab3b06d00c8eb8ede2a
+  data.tar.gz: 47cb351a79b2aca23615ae60b5b9d8e2f4300b7d1e92abf04b67ed7d7ac54a18
 SHA512:
-  metadata.gz: 8ddc27d5e684c33d23234221989fa04ba4c46a44ade8593a392e2444feb4b569a74334c3b704ff4124bc6ae89a8ca9210736ea37afb6e11e574c3aadafb2e0f4
-  data.tar.gz: bbcdae693b9cad8f964ec85b89a61ad656b2192ee5b26476d039d3328d31eb47fd6c91e361b31d4ab68a2647477dcfb2d631b98a771e6d956ea44523aa55309d
+  metadata.gz: ddff41744b61108f731644f8e4d7e7f9e059ee25a656baf60ac4b9e58ad7da8e90bc047a8d2e0d91d2caf3947080a8afa305a4c9ce75a1e29635da61c3b78e4c
+  data.tar.gz: 8030fdb57740f229e97e6545d360c61f6fbdcad4d8a2b227d11b21693ff0ee10774d92c3b8076610724f9ba9f8eb8d5cf10271c3e9f0726022a1a57968afe363

data/.github/workflows/main.yml

@@ -8,13 +8,17 @@ jobs:
       matrix:
         ruby: [2.7]
         node: [14]
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.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:
@@ -73,7 +77,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-20.04
     steps:
     - uses: actions/checkout@v2
     - name: Setup Ruby

data/CHANGELOG.md

@@ -17,6 +17,15 @@ Changes since last non-beta release.
 
 *Please add entries here for your pull requests that are not yet released.*
 
+### [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 +1051,8 @@ 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.2.0...master
+[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

@@ -7,7 +7,7 @@ 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.

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,7 +9,10 @@ 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:
 

data/docs/guides/configuration.md

@@ -158,7 +158,7 @@ ReactOnRails.configure do |config|
   # 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
@@ -226,7 +226,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 %>

data/docs/guides/rails-webpacker-react-integration-options.md

@@ -3,9 +3,9 @@
 You only _need_ props hydration if you need SSR. However, there's no good reason to
 have your app make a second round trip to the Rails server to get initialization props.
 
-**Server-Side Rendering (SSR)** results in Rails rendering HTML for your React components. The main reasons to use SSR are better SEO and pages display more quickly. 
+**Server-Side Rendering (SSR)** results in Rails rendering HTML for your React components. The main reasons to use SSR are better SEO and pages display more quickly.
 
-These gems provide advanced integration of React with [rails/webpacker](https://github.com/rails/webpacker): 
+These gems provide advanced integration of React with [rails/webpacker](https://github.com/rails/webpacker):
 
 | Gem | Props Hydration | Server-Side-Rendering (SSR) | SSR with HMR | SSR with React-Router | SSR with Code Splitting | Node SSR |
 | --- | --------------- | --- | --------------------- | ----------------------| ------------------------|----|
@@ -19,7 +19,7 @@ Note, Node SSR for React on Rails requires [React on Rails Pro](https://www.shak
 
 As mentioned, you don't _need_ to use a gem to integrate Rails with React.
 
-If you're not concerned with view helpers to pass props or server rendering, can do it yourself:
+If you're not concerned with view helpers to pass props or server rendering, you can do it yourself:
 
 ```erb
 <%# views/layouts/application.html.erb %>
@@ -71,7 +71,7 @@ development:
     inline: true
 ```
 
-This basic configuration alone will have HMR working with the default webpacker setup. However, an code saves will trigger a full page refresh each time you save a file.
+This basic configuration alone will have HMR working with the default webpacker setup. However, a code save will trigger a full page refresh each time you save a file.
 
 Webpack's HMR allows the replacement of modules for React in-place without reloading the browser. To do this, you have two options:
 
@@ -95,9 +95,9 @@ You can see an example commit of adding this [here](https://github.com/shakacode
    ```js
    const ReactRefreshWebpackPlugin = require('@pmmmwh/react-refresh-webpack-plugin');
    const environment = require('./environment')
-   
+
    const isWebpackDevServer = process.env.WEBPACK_DEV_SERVER;
-   
+
    //plugins
    if (isWebpackDevServer) {
        environment.plugins.append(
@@ -164,11 +164,11 @@ const environment = require('./environment')
 + if (!module.hot) {
 +   environment.loaders.get('sass').use.find(item => item.loader === 'sass-loader').options.sourceMapContents = false
 + }
-+ 
++
 module.exports = environment.toWebpackConfig()
 ```
 
-5. Adjust your `config/webpack/environment.js` for a 
+5. Adjust your `config/webpack/environment.js` for a
 
 ```diff
 // config/webpack/environment.js

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

@@ -17,7 +17,7 @@ See [this note](https://www.shakacode.com/react-on-rails/docs/guides/client-vs-s
 
 ## How do you do Server Rendering with React on Rails?
 1. The `react_component` view helper method provides the `prerender:` option to switch on or off server rendering.
-1. Configure your Webpack setup to create a different server bundle per your needs. While you may reuse the same bundle as for client rendering, this is not common in larger apps for many reasons, such as as code splitting, handling CSS and images, different code paths for React Router on the server vs. client, etc.
+1. Configure your Webpack setup to create a different server bundle per your needs. While you may reuse the same bundle as for client rendering, this is not common in larger apps for many reasons, such as code splitting, handling CSS and images, different code paths for React Router on the server vs. client, etc.
 1. You need to configure `config.server_bundle_js_file = "server-bundle.js"` in your `config/initializers/react_on_rails.rb`
 1. You should ***not*** put a hash on the server-bundle so that you can easily use the webpack-dev-server for client bundles and have the server bundle generated by a watch process.
 

data/docs/guides/tutorial.md

@@ -50,7 +50,7 @@ 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
 # This is for Rails 7
-rails new --skip-turbolinks --skip-javascript test-react-on-rails
+rails new test-react-on-rails --skip-turbolinks --skip-javascript
 
 cd test-react-on-rails
 ```

data/lib/react_on_rails/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ReactOnRails
-  VERSION = "13.1.0"
+  VERSION = "13.2.0"
 end

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-on-rails",
-  "version": "13.1.0",
+  "version": "13.2.0",
   "description": "react-on-rails JavaScript for react_on_rails Ruby gem",
   "main": "node_package/lib/ReactOnRails.js",
   "directories": {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: react_on_rails
 version: !ruby/object:Gem::Version
-  version: 13.1.0
+  version: 13.2.0
 platform: ruby
 authors:
 - Justin Gordon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-21 00:00:00.000000000 Z
+date: 2023-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable