react_on_rails 12.0.4 → 12.3.0

data/docs/{additional-reading → rails}/turbolinks.md

@@ -1,4 +1,15 @@
-# Turbolinks
+# Turbolinks and Turbo
+
+## Updated to support Turbo
+* See [PR 1374](https://github.com/shakacode/react_on_rails/pull/1374).
+* Ability to use with Turbo (@hotwired/turbo), as Turbolinks gets obsolete.
+
+To configure turbo the following option can be set:
+  `ReactOnRails.setOptions({ turbo: true })`
+
+Turbo is not auto-detected like older Turbolinks.
+
+*Below docs maybe outdated*
 
 * See [Turbolinks on Github](https://github.com/rails/turbolinks)
 * React on Rails currently supports 2.5.x of Turbolinks and 5.0.0 of Turbolinks 5.
@@ -73,6 +84,7 @@ To turn on tracing of Turbolinks events, put this in your registration file, whe
 ```js
    ReactOnRails.setOptions({
      traceTurbolinks: true,
+     turbo: true,
    });
 ```
 

data/docs/testimonials/testimonials.md

@@ -1,17 +1,17 @@
 # Testimonials
-# [HVMN Testimonial, Written by Paul Benigeri, October 12, 2018](./hvmn.md)
+# [HVMN Testimonial, Written by Paul Benigeri, October 12, 2018](https://www.shakacode.com/react-on-rails/docs/testimonials/hvmn)
 
 > The price we paid for the consultation + the React on Rails pro license has already been made back a couple of times from hosting fees alone. The entire process was super hands off, and our core team was able to focus on shipping new feature during that sprint.
 
-Full writeup [here](./hvmn.md).
+Full writeup [here](https://www.shakacode.com/react-on-rails/docs/testimonials/hvmn).
 
 ---
 
-# [Leora from ResortPass](./resortpass.md), December 10, 2018
+# [Leora from ResortPass](https://www.shakacode.com/react-on-rails/docs/testimonials/resortpass), December 10, 2018
 
-Justin and his team were instrumental in assisting us in setting design foundations and standards for our transition to a react on rails application. Just three months of work with the team at Shaka code and we have a main page of our application server-side rendering at exponentially improved speeds. 
+Justin and his team were instrumental in assisting us in setting design foundations and standards for our transition to a react on rails application. Just three months of work with the team at Shaka code and we have a main page of our application server-side rendering at exponentially improved speeds.
 
-Full writeup [here](./testimonials/resortpass.md).
+Full writeup [here](https://www.shakacode.com/react-on-rails/docs/testimonials/resortpass).
 
 ---
 
@@ -25,4 +25,4 @@ From Kyle Maune of Cooper Aerial, May 4, 2018
 
 ![image](https://user-images.githubusercontent.com/1118459/40891236-9b0b406e-671d-11e8-80ee-c026dbd1d5a2.png)
 
-For more testimonials, see [Live Projects](PROJECTS.md) and [Kudos](KUDOS.md).
+For more testimonials, see [Live Projects](https://github.com/shakacode/react_on_rails/tree/master/PROJECTS.md) and [Kudos](https://github.com/shakacode/react_on_rails/tree/master/KUDOS.md).

data/lib/generators/react_on_rails/base_generator.rb

@@ -132,7 +132,7 @@ module ReactOnRails
       # From https://github.com/rails/rails/blob/4c940b2dbfb457f67c6250b720f63501d74a45fd/railties/lib/rails/generators/rails/app/app_generator.rb
       def app_name
         @app_name ||= (defined_app_const_base? ? defined_app_name : File.basename(destination_root))
-                      .tr('\\', "").tr(". ", "_")
+                      .tr("\\", "").tr(". ", "_")
       end
 
       def defined_app_name

data/lib/generators/react_on_rails/dev_tests_generator.rb

@@ -25,7 +25,7 @@ module ReactOnRails
       end
 
       def copy_tests
-        %w[spec/features/hello_world_spec.rb].each { |file| copy_file(file) }
+        %w[spec/system/hello_world_spec.rb].each { |file| copy_file(file) }
       end
 
       def add_test_related_gems_to_gemfile

data/lib/generators/react_on_rails/templates/dev_tests/spec/rails_helper.rb

@@ -13,7 +13,6 @@ require_relative "spec_helper"
 require "rspec/rails"
 require "capybara/rspec"
 require "capybara/rails"
-Capybara.javascript_driver = :selenium_chrome
 Capybara.register_driver :selenium_chrome do |app|
   options = Selenium::WebDriver::Chrome::Options.new
   options.add_argument("--headless")
@@ -41,6 +40,10 @@ end
 # ActiveRecord::Migration.maintain_test_schema!
 
 RSpec.configure do |config|
+  config.before(:each, type: :system, js: true) do
+    driven_by :selenium_chrome
+  end
+
   # Ensure that if we are running js tests, we are using latest webpack assets
   # This will use the defaults of :js and :server_rendering meta tags
   ReactOnRails::TestHelper.configure_rspec_to_compile_assets(config)

data/lib/generators/react_on_rails/templates/dev_tests/spec/simplecov_helper.rb

@@ -17,7 +17,7 @@ if ENV["COVERAGE"] == "true"
 
     # Don't report anything that has "spec" in the path
     add_filter do |src|
-      src.filename =~ %r{/spec/}
+      src.filename.include?("/spec/")
     end
   end
 end

data/lib/generators/react_on_rails/templates/dev_tests/spec/{features → system}/hello_world_spec.rb

@@ -2,8 +2,8 @@
 
 require_relative "../rails_helper"
 
-feature "Hello World", js: true do
-  scenario "the hello world example works" do
+describe "Hello World", js: true do
+  it "the hello world example works" do
     visit "/hello_world"
     expect(heading).to have_text("Hello World")
     expect(message).to have_text("Stranger")

data/lib/react_on_rails/helper.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 # rubocop:disable Metrics/ModuleLength
+# rubocop:disable Metrics/MethodLength
 # NOTE:
 # For any heredoc JS:
 # 1. The white spacing in this file matters!
@@ -170,7 +171,7 @@ module ReactOnRails
     def redux_store_hydration_data
       return if @registered_stores_defer_render.blank?
 
-      @registered_stores_defer_render.reduce("".dup) do |accum, redux_store_data|
+      @registered_stores_defer_render.reduce(+"") do |accum, redux_store_data|
         accum << render_redux_store_data(redux_store_data)
       end.html_safe
     end
@@ -182,7 +183,7 @@ module ReactOnRails
     # Helper method to take 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 are caught and console messages are handled properly.
-    # Options include:{ prerender:, trace:, raise_on_prerender_error: }
+    # Options include:{ prerender:, trace:, raise_on_prerender_error:, throw_js_errors: }
     def server_render_js(js_expression, options = {})
       render_options = ReactOnRails::ReactComponent::RenderOptions
                        .new(react_component_name: "generic-js", options: options)
@@ -192,6 +193,8 @@ module ReactOnRails
         var htmlResult = '';
         var consoleReplayScript = '';
         var hasErrors = false;
+        var renderingError = null;
+        var renderingErrorObject = {};
 
         try {
           htmlResult =
@@ -199,9 +202,17 @@ module ReactOnRails
               return #{js_expression};
             })();
         } catch(e) {
+          renderingError = e;
+          if (#{render_options.throw_js_errors}) {
+            throw e;
+          }
           htmlResult = ReactOnRails.handleError({e: e, name: null,
             jsCode: '#{escape_javascript(js_expression)}', serverSide: true});
           hasErrors = true;
+          renderingErrorObject = {
+            message: renderingError.message,
+            stack: renderingError.stack,
+          }
         }
 
         consoleReplayScript = ReactOnRails.buildConsoleReplay();
@@ -209,7 +220,8 @@ module ReactOnRails
         return JSON.stringify({
             html: htmlResult,
             consoleReplayScript: consoleReplayScript,
-            hasErrors: hasErrors
+            hasErrors: hasErrors,
+            renderingError: renderingErrorObject
         });
 
       })()
@@ -255,8 +267,13 @@ module ReactOnRails
           i18nLocale: I18n.locale,
           i18nDefaultLocale: I18n.default_locale,
           rorVersion: ReactOnRails::VERSION,
+          # TODO: v13 just use the version if existing
           rorPro: ReactOnRails::Utils.react_on_rails_pro?
         }
+        if ReactOnRails::Utils.react_on_rails_pro?
+          result[:rorProVersion] = ReactOnRails::Utils.react_on_rails_pro_version
+        end
+
         if defined?(request) && request.present?
           # Check for encoding of the request's original_url and try to force-encoding the
           # URLs as UTF-8. This situation can occur in browsers that do not encode the
@@ -487,13 +504,13 @@ module ReactOnRails
     end
 
     def initialize_redux_stores
-      result = <<-JS.dup
+      result = +<<-JS
       ReactOnRails.clearHydratedStores();
       JS
 
       return result unless @registered_stores.present? || @registered_stores_defer_render.present?
 
-      declarations = "var reduxProps, store, storeGenerator;\n".dup
+      declarations = +"var reduxProps, store, storeGenerator;\n"
       all_stores = (@registered_stores || []) + (@registered_stores_defer_render || [])
 
       result << all_stores.each_with_object(declarations) do |redux_store_data, memo|
@@ -522,3 +539,4 @@ module ReactOnRails
   end
 end
 # rubocop:enable Metrics/ModuleLength
+# rubocop:enable Metrics/MethodLength

data/lib/react_on_rails/locales/base.rb

@@ -32,12 +32,12 @@ module ReactOnRails
       end
 
       def exist_files
-        @exist_files ||= files.select(&File.method(:exist?))
+        @exist_files ||= files.select { |file| File.exist?(file) }
       end
 
       def files_are_outdated
-        latest_yml = locale_files.map(&File.method(:mtime)).max
-        earliest = exist_files.map(&File.method(:mtime)).min
+        latest_yml = locale_files.map { |file| File.mtime(file) }.max
+        earliest = exist_files.map { |file| File.mtime(file) }.min
         latest_yml > earliest
       end
 
@@ -54,15 +54,18 @@ module ReactOnRails
       end
 
       def locale_files
+        # rubocop:disable Layout/IndentationWidth, Style/RedundantBegin
         @locale_files ||= begin
-          if i18n_yml_dir.present?
-            Dir["#{i18n_yml_dir}/**/*.yml"]
-          else
-            ReactOnRails::Utils.truthy_presence(
-              Rails.application && Rails.application.config.i18n.load_path
-            ).presence
-          end
+                            if i18n_yml_dir.present?
+                              Dir["#{i18n_yml_dir}/**/*.yml"]
+                            else
+                             ReactOnRails::Utils.truthy_presence(
+                               Rails.application && Rails.application.config.i18n.load_path
+                             ).presence
+                            end
         end
+
+        # rubocop:enable Layout/IndentationWidth, Style/RedundantBegin
       end
 
       def i18n_dir

data/lib/react_on_rails/prerender_error.rb

@@ -46,7 +46,7 @@ module ReactOnRails
     private
 
     def calc_message(component_name, console_messages, err, js_code, props)
-      message = "ERROR in SERVER PRERENDERING\n".dup
+      message = +"ERROR in SERVER PRERENDERING\n"
       if err
         message << <<~MSG
           Encountered error: \"#{err}\"

data/lib/react_on_rails/react_component/render_options.rb

@@ -11,6 +11,7 @@ module ReactOnRails
 
       NO_PROPS = {}.freeze
 
+      # TODO: remove the required for named params
       def initialize(react_component_name: required("react_component_name"), options: required("options"))
         @react_component_name = react_component_name.camelize
         @options = options
@@ -18,12 +19,16 @@ module ReactOnRails
 
       attr_reader :react_component_name
 
+      def throw_js_errors
+        options.fetch(:throw_js_errors, false)
+      end
+
       def props
         options.fetch(:props) { NO_PROPS }
       end
 
       def random_dom_id
-        retrieve_key(:random_dom_id)
+        retrieve_configuration_value_for(:random_dom_id)
       end
 
       def dom_id
@@ -49,23 +54,23 @@ module ReactOnRails
       end
 
       def prerender
-        retrieve_key(:prerender)
+        retrieve_configuration_value_for(:prerender)
       end
 
       def trace
-        retrieve_key(:trace)
+        retrieve_configuration_value_for(:trace)
       end
 
       def replay_console
-        retrieve_key(:replay_console)
+        retrieve_configuration_value_for(:replay_console)
       end
 
       def raise_on_prerender_error
-        retrieve_key(:raise_on_prerender_error)
+        retrieve_configuration_value_for(:raise_on_prerender_error)
       end
 
       def logging_on_server
-        retrieve_key(:logging_on_server)
+        retrieve_configuration_value_for(:logging_on_server)
       end
 
       def to_s
@@ -76,6 +81,10 @@ module ReactOnRails
         options[key]
       end
 
+      def set_option(key, value)
+        options[key] = value
+      end
+
       private
 
       attr_reader :options
@@ -88,7 +97,7 @@ module ReactOnRails
         "#{base_dom_id}-#{SecureRandom.uuid}"
       end
 
-      def retrieve_key(key)
+      def retrieve_configuration_value_for(key)
         options.fetch(key) do
           ReactOnRails.configuration.public_send(key)
         end

data/lib/react_on_rails/server_rendering_pool/ruby_embedded_java_script.rb

@@ -187,8 +187,10 @@ module ReactOnRails
         end
 
         # Reimplement console methods for replaying on the client
+        # Save a handle to the original console if needed.
         def console_polyfill
           <<~JS
+            var debugConsole = console;
             var console = { history: [] };
             ['error', 'log', 'info', 'warn'].forEach(function (level) {
               console[level] = function () {

data/lib/react_on_rails/utils.rb

@@ -158,15 +158,29 @@ module ReactOnRails
     end
 
     def self.gem_available?(name)
-      Gem::Specification.find_all_by_name(name).present?
+      Gem.loaded_specs[name].present?
     rescue Gem::LoadError
       false
     rescue StandardError
       Gem.available?(name).present?
     end
 
+    # Todo -- remove this for v13, as we don't need both boolean and number
     def self.react_on_rails_pro?
-      @react_on_rails_pro ||= gem_available?("react_on_rails_pro")
+      return @react_on_rails_pro if defined?(@react_on_rails_pro)
+
+      @react_on_rails_pro = gem_available?("react_on_rails_pro")
+    end
+
+    # Return an empty string if React on Rails Pro is not installed
+    def self.react_on_rails_pro_version
+      return @react_on_rails_pro_version if defined?(@react_on_rails_pro_version)
+
+      @react_on_rails_pro_version = if react_on_rails_pro?
+                                      Gem.loaded_specs["react_on_rails_pro"].version.to_s
+                                    else
+                                      ""
+                                    end
     end
 
     def self.smart_trim(str, max_length = 1000)

data/lib/react_on_rails/version.rb

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

data/lib/react_on_rails/webpacker_utils.rb

@@ -2,8 +2,12 @@
 
 module ReactOnRails
   module WebpackerUtils
+    # TODO: V13 code should be cleaned up so that the webpacker gem is required.
+    # This check should only be done at startup.
     def self.using_webpacker?
-      ReactOnRails::Utils.gem_available?("webpacker")
+      return @using_webpacker if defined?(@using_webpacker)
+
+      @using_webpacker = ReactOnRails::Utils.gem_available?("webpacker")
     end
 
     def self.webpacker_webpack_production_config_exists?

data/lib/tasks/assets.rake

@@ -6,7 +6,6 @@
 require "active_support"
 
 ENV["RAILS_ENV"] ||= ENV["RACK_ENV"] || "development"
-ENV["NODE_ENV"]  ||= "development"
 
 unless ReactOnRails::WebpackerUtils.webpacker_webpack_production_config_exists?
   # Ensure that rails/webpacker does not call bin/webpack if we're providing
@@ -47,10 +46,20 @@ namespace :react_on_rails do
       configuration file config/webpack/production.js exists.
     DESC
     task webpack: :locale do
-      if ReactOnRails.configuration.build_production_command.present?
-        sh ReactOnRails::Utils.prepend_cd_node_modules_directory(
-          ReactOnRails.configuration.build_production_command
-        ).to_s
+      build_production_command = ReactOnRails.configuration.build_production_command
+      if build_production_command.present?
+        if build_production_command.is_a?(String)
+          sh ReactOnRails::Utils.prepend_cd_node_modules_directory(
+            build_production_command
+          ).to_s
+        elsif build_production_command.methods.include?(:call)
+          build_production_command.call
+        else
+          msg = "ReactonRails.configuration.build_production_command is improperly configured. "\
+                "Value = #{build_production_command} with class #{build_production_command.class}"
+          puts Rainbow(msg).red
+          exit!(1)
+        end
       else
         msg = <<~MSG
           React on Rails is aborting webpack compilation from task react_on_rails:assets:webpack

data/package.json

@@ -1,56 +1,51 @@
 {
   "name": "react-on-rails",
-  "version": "12.0.4",
+  "version": "12.3.0",
   "description": "react-on-rails JavaScript for react_on_rails Ruby gem",
   "main": "node_package/lib/ReactOnRails.js",
   "directories": {
     "doc": "docs"
   },
   "devDependencies": {
-    "@babel/cli": "^7.0.0",
-    "@babel/core": "^7.0.0",
-    "@babel/plugin-transform-runtime": "^7.0.0",
-    "@babel/plugin-transform-typescript": "^7.8.7",
-    "@babel/preset-env": "^7.0.0",
-    "@babel/preset-react": "^7.0.0",
-    "@babel/types": "^7.0.0",
-    "@types/jest": "^25.1.4",
-    "@types/node": "^13.9.0",
+    "@babel/cli": "^7.12.10",
+    "@babel/core": "^7.12.10",
+    "@babel/plugin-transform-runtime": "^7.12.10",
+    "@babel/plugin-transform-typescript": "^7.12.1",
+    "@babel/preset-env": "^7.12.10",
+    "@babel/preset-react": "^7.12.10",
+    "@babel/types": "^7.12.10",
+    "@types/jest": "^26.0.18",
+    "@types/node": "^14.14.11",
     "@types/react": "^16.9.23",
     "@types/react-dom": "^16.9.5",
     "@types/turbolinks": "^5.2.0",
-    "@typescript-eslint/eslint-plugin": "^2.23.0",
-    "@typescript-eslint/parser": "^2.23.0",
-    "babel-loader": "^8.0.2",
+    "@typescript-eslint/eslint-plugin": "^4.10.0",
+    "@typescript-eslint/parser": "^4.10.0",
     "babelify": "^10.0.0",
     "blue-tape": "^1.0.0",
     "create-react-class": "^15.6.0",
-    "eslint": "^6.8.0",
-    "eslint-config-prettier": "^6.10.1",
+    "eslint": "^7.15.0",
+    "eslint-config-prettier": "^7.0.0",
     "eslint-config-shakacode": "^16.0.1",
-    "eslint-plugin-import": "^2.6.1",
-    "eslint-plugin-jsx-a11y": "^6.1.2",
-    "eslint-plugin-prettier": "^3.0.0",
-    "eslint-plugin-react": "^7.1.0",
-    "jest": "^25.1.0",
-    "jsdom": "^11.1.0",
+    "eslint-plugin-import": "^2.22.1",
+    "eslint-plugin-jsx-a11y": "^6.4.1",
+    "eslint-plugin-prettier": "^3.3.0",
+    "eslint-plugin-react": "^7.21.5",
+    "jest": "^26.6.3",
+    "jsdom": "^16.4.0",
     "nps": "^5.9.3",
-    "prettier": "^2.0.1",
+    "prettier": "^2.2.1",
     "prettier-eslint-cli": "^5.0.0",
     "prop-types": "^15.5.10",
     "react": "^16.5.2",
     "react-dom": "^16.5.2",
     "react-transform-hmr": "^1.0.4",
     "redux": "^4.0.1",
-    "release-it": "^8.2.0",
-    "ts-jest": "^25.2.1",
-    "tslint-config-prettier": "^1.18.0",
-    "typescript": "^3.8.3",
-    "webpack": "^3.4.1",
-    "webpack-manifest-plugin": "^1.2.1"
+    "ts-jest": "^26.4.4",
+    "typescript": "^4.1.2"
   },
   "dependencies": {
-    "@babel/runtime-corejs3": "^7.9.6",
+    "@babel/runtime-corejs3": "^7.12.5",
     "concurrently": "^5.1.0"
   },
   "peerDependencies": {