react_on_rails 11.0.10 → 11.1.0.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c451d146d7a22f7a7ef543534018d2b8f02b6c9f1a9544e32a4be1bc5adefa09
-  data.tar.gz: d4348d9c3c67e9a508bc9a53bab51a83077beb609c6b34a524519d788cfd5202
+  metadata.gz: f5687d77e654b890214e39ea3536ed17983845335c442d2eb2cd4a8b09728205
+  data.tar.gz: 33976af7da00de964d3385772a57e9e0aa45f068ebe4d1e3a6590b963e524e8b
 SHA512:
-  metadata.gz: 555fcb6cec66efa9f6d2ecaa834097f4706a20622abf3152d9261e027b5b07c46c511448ef2382b122471a30fce39b828f3d3e9b1e18607b096dcec59385107f
-  data.tar.gz: 3ecaf4ab4726e7e77781a735c35163a1bcb230f6d3700a105f490fa6d45217641d5f3b2124f1109610a3b63920f3d2fc96b243322f549cab61f0d5dd796880fa
+  metadata.gz: dcc783be172cce095c75115e11d3bedfcf1f8e801cc577ab001087704985c644b68dae9403ae911ba0371317d32147b773e058395e27250bbac201186895b25d
+  data.tar.gz: '0068fd2eb0ed4965a5a3e89f8915f11444ff591c83a62f72250a51f75d0b6a18c74589bf57f0add986f27941110c39c527ffd35a8f5f80353490ca0ca9fa0afd'

data/docs/api/view-helpers-api.md

@@ -3,6 +3,8 @@
 
 Once the bundled files have been generated in your `app/assets/webpack` folder and you have registered your components, you will want to render these components on your Rails views using the included helper method, `react_component`.
 
+------------
+
 ### react_component
 
 ```ruby
@@ -24,11 +26,13 @@ react_component(component_name,
   - **id:** Id for the div, will be used to attach the React component. This will get assigned automatically if you do not provide an id. Must be unique.
   - **html_options:** Any other HTML options get placed on the added div for the component. For example, you can set a class (or inline style) on the outer div so that it behaves like a span, with the styling of `display:inline-block`.
   - **trace:** set to true to print additional debugging information in the browser. Defaults to true for development, off otherwise. Only on the **client side** will you will see the `railsContext` and your props.
+  - **random_dom_id:** True to automatically generate random dom ids when using multiple instances of the same React component on one Rails view.
 - **options if prerender (server rendering) is true:**
   - **replay_console:** Default is true. False will disable echoing server-rendering logs to the browser. While this can make troubleshooting server rendering difficult, so long as you have the configuration of `logging_on_server` set to true, you'll still see the errors on the server.
   - **logging_on_server:** Default is true. True will log JS console messages and errors to the server.
   - **raise_on_prerender_error:** Default is false. True will throw an error on the server side rendering. Your controller will have to handle the error.
 
+-------------
 
 ### react_component_hash
 
@@ -68,6 +72,8 @@ export default (props, _railsContext) => {
 
 ```
 
+------------
+
 ### cached_react_component and cached_react_component_hash
 Fragment caching is a [React on Rails Pro](https://github.com/shakacode/react_on_rails/wiki) feature. The API is the same as the above, but for 2 differences:
 
@@ -79,10 +85,13 @@ Fragment caching is a [React on Rails Pro](https://github.com/shakacode/react_on
   some_slow_method_that_returns_props
 end %>
 ```
+------------
+
 ### rails_context
 
 You can call `rails_context(server_side: true | false)` from your controller or view to see what values are are in the Rails Context. Pass true or false depending on whether you want to see the server side or the client side rails_context.
 
+------------
 
 ### Renderer Functions (function that will call ReactDOM.render or ReactDOM.hydrate)
 
@@ -92,6 +101,8 @@ Why would you want to call `ReactDOM.hydrate` yourself? One possible use case is
 
 Renderer functions are not meant to be used on the server since there's no DOM on the server. Instead, use a generator function. Attempting to server render with a renderer function will throw an error.
 
+------------
+
 ### React Router
 
 [React Router](https://github.com/reactjs/react-router) is supported, including server-side rendering! See:
@@ -100,6 +111,8 @@ Renderer functions are not meant to be used on the server since there's no DOM o
 2. Examples in [spec/dummy/app/views/react_router](../../spec/dummy/app/views/react_router) and follow to the JavaScript code in the [spec/dummy/client/app/startup/ServerRouterApp.jsx](../../spec/dummy/client/app/startup/ServerRouterApp.jsx).
 3. [Code Splitting docs](../misc-pending/code-splitting.md) for information about how to set up code splitting for server rendered routes.
 
+------------
+
 ## server_render_js
 
 `server_render_js(js_expression, options = {})`
@@ -109,6 +122,8 @@ Renderer functions are not meant to be used on the server since there's no DOM o
 
 This is a helper method that takes any JavaScript expression and returns the output from evaluating it. If you have more than one line that needs to be executed, wrap it in an IIFE. JS exceptions will be caught and console messages handled properly.
 
+------------
+
 # More details
 
 See the [lib/react_on_rails/helper.rb](../../lib/react_on_rails/helper.rb) source.

data/docs/basics/configuration.md

@@ -12,6 +12,15 @@ ReactOnRails.configure do |config|
   # setInterval, clearTimout when server rendering.
   config.trace = Rails.env.development?
 
+  # Configure if default DOM IDs have a random value or are fixed.
+  # false ==> Sets the dom id to "#{react_component_name}-react-component"
+  # true ==> Adds "-#{SecureRandom.uuid}" to that ID
+  # If you might use multiple instances of the same React component on a Rails page, then
+  # it is convenient to set this to true or else you have to either manually set the ids to 
+  # avoid collisions. Most newer apps will have only one instance of a component on a page,
+  # so this should be false in most cases.
+  # This value can be overrident for a given call to react_component
+  config.random_dom_id = false # default is true
 
   # defaults to "" (top level)
   #

data/lib/react_on_rails/configuration.rb

@@ -9,6 +9,7 @@ module ReactOnRails
   DEFAULT_GENERATED_ASSETS_DIR = File.join(%w[public webpack], Rails.env).freeze
   DEFAULT_SERVER_RENDER_TIMEOUT = 20
   DEFAULT_POOL_SIZE = 1
+  DEFAULT_RANDOM_DOM_ID = TRUE # for backwards compatability
 
   def self.configuration
     @configuration ||= Configuration.new(
@@ -32,7 +33,8 @@ module ReactOnRails
       server_render_method: nil,
       symlink_non_digested_assets_regex: nil,
       build_test_command: "",
-      build_production_command: ""
+      build_production_command: "",
+      random_dom_id: DEFAULT_RANDOM_DOM_ID
     )
   end
 
@@ -45,7 +47,7 @@ module ReactOnRails
                   :webpack_generated_files, :rendering_extension, :build_test_command,
                   :build_production_command,
                   :i18n_dir, :i18n_yml_dir,
-                  :server_render_method, :symlink_non_digested_assets_regex
+                  :server_render_method, :symlink_non_digested_assets_regex, :random_dom_id
 
     def initialize(node_modules_location: nil, server_bundle_js_file: nil, prerender: nil,
                    replay_console: nil,
@@ -56,7 +58,7 @@ module ReactOnRails
                    generated_assets_dir: nil, webpack_generated_files: nil,
                    rendering_extension: nil, build_test_command: nil,
                    build_production_command: nil,
-                   i18n_dir: nil, i18n_yml_dir: nil,
+                   i18n_dir: nil, i18n_yml_dir: nil, random_dom_id: nil,
                    server_render_method: nil, symlink_non_digested_assets_regex: nil)
       self.node_modules_location = node_modules_location.present? ? node_modules_location : Rails.root
       self.server_bundle_js_file = server_bundle_js_file
@@ -67,6 +69,7 @@ module ReactOnRails
       self.i18n_dir = i18n_dir
       self.i18n_yml_dir = i18n_yml_dir
 
+      self.random_dom_id = random_dom_id
       self.prerender = prerender
       self.replay_console = replay_console
       self.logging_on_server = logging_on_server

data/lib/react_on_rails/helper.rb

@@ -98,6 +98,7 @@ module ReactOnRails
     #   raise_on_prerender_error: <true/false> Default to false. True will raise exception on server
     #      if the JS code throws
     # Any other options are passed to the content tag, including the id.
+    # random_dom_id can be set to override the global default.
     def react_component(component_name, options = {})
       internal_result = internal_react_component(component_name, options)
       server_rendered_html = internal_result[:result]["html"]

data/lib/react_on_rails/react_component/render_options.rb

@@ -22,8 +22,26 @@ module ReactOnRails
         options.fetch(:props) { NO_PROPS }
       end
 
+      def random_dom_id
+        retrieve_key(:random_dom_id)
+      end
+
       def dom_id
-        @dom_id ||= options.fetch(:id) { generate_unique_dom_id }
+        @dom_id ||= options.fetch(:id) do
+          if random_dom_id
+            generate_unique_dom_id
+          else
+            base_dom_id
+          end
+        end
+      end
+
+      def has_random_dom_id?
+        return false if options[:id]
+
+        return false unless random_dom_id
+
+        true
       end
 
       def html_options
@@ -58,8 +76,12 @@ module ReactOnRails
 
       attr_reader :options
 
+      def base_dom_id
+       "#{react_component_name}-react-component"
+      end
+
       def generate_unique_dom_id
-        "#{react_component_name}-react-component-#{SecureRandom.uuid}"
+        "#{base_dom_id}-#{SecureRandom.uuid}"
       end
 
       def retrieve_key(key)

data/lib/react_on_rails/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ReactOnRails
-  VERSION = "11.0.10".freeze
+  VERSION = "11.1.0.beta.1".freeze
 end

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-on-rails",
-  "version": "11.0.10",
+  "version": "11.1.0-beta.1",
   "description": "react-on-rails JavaScript for react_on_rails Ruby gem",
   "main": "node_package/lib/ReactOnRails.js",
   "directories": {
@@ -54,7 +54,7 @@
     "test": "babel-tape-runner -r node_package/tests/helpers/test_helper.js node_package/tests/*.js | tap-spec",
     "clean": "rm -rf node_package/lib",
     "prepare": "yarn run build",
-    "prepublish": "check-node-version --npm \">=4\" || npm run prepare",
+    "prepublish": "npm run prepare",
     "babel": "babel --out-dir node_package/lib node_package/src",
     "build": "yarn run clean && yarn run babel",
     "build-watch": "babel --watch --out-dir node_package/lib node_package/src",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: react_on_rails
 version: !ruby/object:Gem::Version
-  version: 11.0.10
+  version: 11.1.0.beta.1
 platform: ruby
 authors:
 - Justin Gordon
@@ -503,9 +503,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.7