react-rails 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e2392fd8c147fca4d725dd8e96d49e3515bb0c439c58e7f13c1c283b69d1ea4
-  data.tar.gz: 8867c4ada55330af8fd290379b5d6f93611c714558791ab5cc27d80796b71300
+  metadata.gz: 1f3c2b4f28629f4fa197ec51a3951aa90ca430a4688f0f45d8eceac3a91c7309
+  data.tar.gz: 43f8580d6678c51cc0f6a7037dda28f63e256073ed7c5d16867c87d31d15af35
 SHA512:
-  metadata.gz: 8ffac366e8a10b59f386722b280d1407b25607231ff5a42bbf71a374420cf3ff4a2a6a2ae6b0eb49e768b3c161f5407fc7aafb20f317766ffc67eacf0a5b4577
-  data.tar.gz: ac63153752bb2b5da0d8f1303d24ac8359ab3751f7ab65e576dc5bcfedd63ac07f1336faeb2ffaff81431f833e06468821f282859513012cea484e4a0571ef1e
+  metadata.gz: b2a3fdff4d9d1438d9935b1d63b9fa1e891d6a79cce5dfd10731c364681b4d1cfc0c017960184c15d91c1228b5efb18fbe5e600f509ad0385f9d3c667894ac15
+  data.tar.gz: 84500c2291940cfeb41617f340ce59ee7e9de4f2a337b5b313dc42581fa5157b7ecaac759d00d5240b80cb48154e57eb590bce5183e951b01691deb3d9bd9898

data/CHANGELOG.md

@@ -5,10 +5,17 @@ If you need help upgrading `react-rails`, `webpacker` to `shakapacker`, or JS pa
 [#1209 2.7 Release Discussion](https://github.com/reactjs/react-rails/issues/1209)
 
 ## Unreleased
-Changes since last non-beta release.
+Changes since the last non-beta release.
 
 _Please add entries here for your pull requests that are not yet released._
 
+## [3.1.0] - 2023-08-15
+
+#### Added
+- Added option to replace `null`s in props with `undefined` via `config.react.null_to_undefined_props` in `config/application.rb` #1293
+
+## [3.0.0] - 2023-08-14
+
 ### Breaking Changes
 - Requires separate compilations for server & client bundles if using Shakapacker (see [Webpack config](https://github.com/reactjs/react-rails/tree/master/test/dummy/config/webpack)) #1274
 - Replaces WebpackManifestContainer, which searched for assets in the webpack manifest, with SeparateServerBundleContainer, which expects a single server bundle file & does not use the webpack manifest at all. #1274
@@ -555,6 +562,8 @@ _Please add entries here for your pull requests that are not yet released._
 - Server rendering with `prerender: true`
 - Transform `.jsx` in the asset pipeline
 
-[Unreleased]: https://github.com/reactjs/react-rails/compare/v2.7.1...master
-[2.7.1]: https://github.com/shakacode/shakapacker/compare/v2.7.0...v2.7.1
-[2.7.0]: https://github.com/shakacode/shakapacker/compare/v2.6.2...v2.7.0
+[Unreleased]: https://github.com/reactjs/react-rails/compare/v3.1.0...master
+[3.1.0]: https://github.com/reactjs/react-rails/compare/v3.0.0...v3.1.0
+[3.0.0]: https://github.com/reactjs/react-rails/compare/v2.7.1...v3.0.0
+[2.7.1]: https://github.com/reactjs/react-rails/compare/v2.7.0...v2.7.1
+[2.7.0]: https://github.com/reactjs/react-rails/compare/v2.6.2...v2.7.0

data/README.md

@@ -32,7 +32,7 @@ Here's a testimonial of how ShakaCode can help, from [Florian Gößler](https://
 
 Read the [full review here](https://clutch.co/profile/shakacode#reviews?sort_by=date_DESC#review-2118154). Here's [another review of a Shakapacker migration that led to more work](https://clutch.co/profile/shakacode#reviews?sort_by=date_DESC#review-2096078).
 
-## Resouces
+## Resources
 * [Click to join **React + Rails Slack**](https://reactrails.slack.com/join/shared_invite/enQtNjY3NTczMjczNzYxLTlmYjdiZmY3MTVlMzU2YWE0OWM0MzNiZDI0MzdkZGFiZTFkYTFkOGVjODBmOWEyYWQ3MzA2NGE1YWJjNmVlMGE). Then join the channel `#react-rails`.
 * If you are upgrading, you might consider migrating to the [react_on_rails](https://github.com/shakacode/react_on_rails) gem.
 * Source code example utilizing React-Rails: https://github.com/BookOfGreg/react-rails-example-app
@@ -68,6 +68,8 @@ Read the [full review here](https://clutch.co/profile/shakacode#reviews?sort_by=
 - [Upgrading](#upgrading)
   - [2.7 to 3.0](#27-to-30)
   - [2.3 to 2.4](#23-to-24)
+- [Other features](#other-features)
+  - [Replace `null` with `undefined` in props](#replace-null-with-undefined-in-props)
 - [Common Errors](#common-errors)
   - [Getting warning for `Can't resolve 'react-dom/client'` in React < 18](#getting-warning-for-cant-resolve-react-domclient-in-react--18)
   - [Undefined Set](#undefined-set)
@@ -75,6 +77,7 @@ Read the [full review here](https://clutch.co/profile/shakacode#reviews?sort_by=
   - [HMR](#hmr)
 - [Related Projects](#related-projects)
 - [Contributing](#contributing)
+- [Supporters](#supporters)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
@@ -528,7 +531,6 @@ use it like so:
 ReactUJS.getConstructor = ReactUJS.constructorFromRequireContext(require.context('components', true));
 ```
 
-
 ## Server-Side Rendering
 
 You can render React components inside your Rails server with `prerender: true`:
@@ -801,6 +803,26 @@ For the vast majority of cases this will get you most of the migration:
 - add `import PropTypes from 'prop-types'` (Webpacker only)
 - re-run `bundle exec rails webpacker:install:react` to update npm packages (Webpacker only)
 
+## Other features
+
+### Replace `null` with `undefined` in props
+
+React-Rails converts `nil` to `null` while parsing props from Ruby to JavaScript. Optionally, you can configure React-Rails to parse `nil` values to `undefined` as per the following:
+
+```ruby
+# config/application.rb
+module TheAppName
+  class Application < Rails::Application
+    # ...
+    # Set to true to convert null values in props into undefined
+    config.react.null_to_undefined_props = true
+    # ...
+  end
+end
+```
+
+More information in: [discussion#1272](https://github.com/reactjs/react-rails/discussions/1272).
+
 ## Common Errors
 ### Getting warning for `Can't resolve 'react-dom/client'` in React < 18
 
@@ -857,7 +879,7 @@ By contributing to React-Rails, you agree to abide by the [code of conduct](http
 
 You can always help by submitting patches or triaging issues. Even offering reproduction steps to issues is incredibly helpful!
 
-# Supporters
+## Supporters
 
 The following companies support the development of this and other open-source projects maintained by ShakaCode by providing licenses to the ShakaCode team. ShakaCode stands by the usefulness of these products!
 

data/lib/react/rails/component_mount.rb

@@ -56,7 +56,10 @@ module React
         unless prerender_options == :static
           html_options[:data].tap do |data|
             data[:react_class] = name
-            data[:react_props] = (props.is_a?(String) ? props : props.to_json)
+            data[:react_props] = props_to_json(
+              props,
+              null_to_undefined: Dummy::Application.config.react.null_to_undefined_props
+            )
             data[:hydrate] = "t" if prerender_options
 
             num_components = @cache_ids.count { |c| c.start_with? name }
@@ -67,6 +70,17 @@ module React
         html_options
       end
 
+      def props_to_json(props, options = { null_to_undefined: false })
+        return props if props.is_a?(String)
+        return props.to_json unless options[:null_to_undefined]
+
+        # This regex matches key:value with null values while ensuing no string with similar
+        # pattern gets matched. It doesn't include null values in arrays.
+        props.to_json
+             .gsub(/([^\\]":)null([,}\]])/, '\1undefined\2') # match simple null values
+             .gsub(/([^\\]":(\[[^\\"]+,|\[))null([,\]])/, '\1undefined\3') # Match nulls in array
+      end
+
       def rendered_tag(html_options, &block)
         html_tag = html_options[:tag] || :div
 

data/lib/react/rails/railtie.rb

@@ -12,6 +12,7 @@ module React
       config.react.jsx_transformer_class = nil # defaults to BabelTransformer
       config.react.camelize_props = false # pass in an underscored hash but get a camelized hash
       config.react.sprockets_strategy = nil # how to attach JSX to the asset pipeline (or `false` for none)
+      config.react.null_to_undefined_props = false # Set to true to convert null values in props into undefined
 
       # Server rendering:
       config.react.server_renderer_pool_size  = 1   # increase if you're on JRuby

data/lib/react/rails/version.rb

@@ -4,6 +4,6 @@ module React
   module Rails
     # If you change this, make sure to update VERSIONS.md
     # and republish the UJS by updating package.json and `bundle exec rake ujs:publish`
-    VERSION = "3.0.0"
+    VERSION = "3.1.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: react-rails
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Paul O’Shannessy
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-14 00:00:00.000000000 Z
+date: 2023-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appraisal