react_on_rails 12.0.3.beta.0 → 12.2.0

data/docs/{additional-reading → rails}/convert-rails-5-api-only-app.md

@@ -16,4 +16,4 @@ Rails will start creating the app and will skip the files you have already creat
 3. If it is removeing some of your code then press "n" and add all additions manually
 ```
 
-3. Run `bundle install` and follow [the instructions for installing into an existing Rails app](../basics/installation-into-an-existing-rails-app.md).*
+3. Run `bundle install` and follow [the instructions for installing into an existing Rails app](https://www.shakacode.com/react-on-rails/docs/basics/installation-into-an-existing-rails-app)

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

@@ -43,7 +43,14 @@ module ReactOnRails
       end
 
       def add_yarn_dependencies
-        run "yarn add react-on-rails --exact"
+        major_minor_patch_only = /\A\d+\.\d+\.\d+\z/.freeze
+        if ReactOnRails::VERSION.match?(major_minor_patch_only)
+          run "yarn add react-on-rails@#{ReactOnRails::VERSION} --exact"
+        else
+          # otherwise add latest
+          puts "Adding the lastest react-on-rails NPM module. Double check this is correct in package.json"
+          run "yarn add react-on-rails --exact"
+        end
       end
 
       def append_to_spec_rails_helper

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/configuration.rb

@@ -53,6 +53,7 @@ module ReactOnRails
                   :server_render_method, :random_dom_id,
                   :same_bundle_for_client_and_server
 
+    # rubocop:disable Metrics/AbcSize
     def initialize(node_modules_location: nil, server_bundle_js_file: nil, prerender: nil,
                    replay_console: nil,
                    trace: nil, development_mode: nil,
@@ -98,6 +99,7 @@ module ReactOnRails
 
       self.server_render_method = server_render_method
     end
+    # rubocop:enable Metrics/AbcSize
 
     # on ReactOnRails
     def setup_config_values

data/lib/react_on_rails/git_utils.rb

@@ -10,10 +10,10 @@ module ReactOnRails
       status = `git status --porcelain`
       return false if $CHILD_STATUS.success? && status.empty?
 
-      error = if !$CHILD_STATUS.success?
-                "You do not have Git installed. Please install Git, and commit your changes before continuing"
-              else
+      error = if $CHILD_STATUS.success?
                 "You have uncommitted code. Please commit or stash your changes before continuing"
+              else
+                "You do not have Git installed. Please install Git, and commit your changes before continuing"
               end
       message_handler.add_error(error)
       true

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!
@@ -32,8 +33,8 @@ module ReactOnRails
     #   Exposing the react_component_name is necessary to both a plain ReactComponent as well as
     #     a generator:
     #   See README.md for how to "register" your react components.
-    #   See spec/dummy/client/app/startup/serverRegistration.jsx and
-    #     spec/dummy/client/app/startup/ClientRegistration.jsx for examples of this
+    #   See spec/dummy/client/app/packs/server-bundle.js and
+    #     spec/dummy/client/app/packs/client-bundle.js for examples of this.
     #
     # options:
     #   props: Ruby Hash or JSON string which contains the properties to pass to the react object. Do
@@ -57,14 +58,15 @@ module ReactOnRails
       server_rendered_html = internal_result[:result]["html"]
       console_script = internal_result[:result]["consoleReplayScript"]
 
-      if server_rendered_html.is_a?(String)
+      case server_rendered_html
+      when String
         build_react_component_result_for_server_rendered_string(
           server_rendered_html: server_rendered_html,
           component_specification_tag: internal_result[:tag],
           console_script: console_script,
           render_options: internal_result[:render_options]
         )
-      elsif server_rendered_html.is_a?(Hash)
+      when Hash
         msg = <<~MSG
           Use react_component_hash (not react_component) to return a Hash to your ruby view code. See
           https://github.com/shakacode/react_on_rails/blob/master/spec/dummy/client/app/startup/ReactHelmetServerApp.jsx
@@ -169,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
@@ -181,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)
@@ -191,6 +193,8 @@ module ReactOnRails
         var htmlResult = '';
         var consoleReplayScript = '';
         var hasErrors = false;
+        var renderingError = null;
+        var renderingErrorObject = {};
 
         try {
           htmlResult =
@@ -198,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();
@@ -208,7 +220,8 @@ module ReactOnRails
         return JSON.stringify({
             html: htmlResult,
             consoleReplayScript: consoleReplayScript,
-            hasErrors: hasErrors
+            hasErrors: hasErrors,
+            renderingError: renderingErrorObject
         });
 
       })()
@@ -243,7 +256,7 @@ module ReactOnRails
     # second parameter passed to both component and store Render-Functions.
     # This method can be called from views and from the controller, as `helpers.rails_context`
     #
-    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
     def rails_context(server_side: true)
       # ALERT: Keep in sync with node_package/src/types/index.ts for the properties of RailsContext
       @rails_context ||= begin
@@ -254,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
@@ -291,7 +309,7 @@ module ReactOnRails
 
       @rails_context.merge(serverSide: server_side)
     end
-    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity
 
     private
 
@@ -486,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|
@@ -521,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
 

data/lib/react_on_rails/locales/to_js.rb

@@ -5,10 +5,6 @@ require "erb"
 module ReactOnRails
   module Locales
     class ToJs < Base
-      def initialize
-        super
-      end
-
       private
 
       def file_format

data/lib/react_on_rails/locales/to_json.rb

@@ -5,10 +5,6 @@ require "erb"
 module ReactOnRails
   module Locales
     class ToJson < Base
-      def initialize
-        super
-      end
-
       private
 
       def file_format

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

@@ -47,6 +47,7 @@ module ReactOnRails
         # Note, js_code does not have to be based on React.
         # js_code MUST RETURN json stringify Object
         # Calling code will probably call 'html_safe' on return value before rendering to the view.
+        # rubocop:disable Metrics/CyclomaticComplexity
         def exec_server_render_js(js_code, render_options, js_evaluator = nil)
           js_evaluator ||= self
           if render_options.trace
@@ -67,16 +68,15 @@ module ReactOnRails
             console_script = result["consoleReplayScript"]
             console_script_lines = console_script.split("\n")
             console_script_lines = console_script_lines[2..-2]
-            re = /console\.(log|error)\.apply\(console, \["\[SERVER\] (?<msg>.*)"\]\);/
-            if console_script_lines
-              console_script_lines.each do |line|
-                match = re.match(line)
-                Rails.logger.info { "[react_on_rails] #{match[:msg]}" } if match
-              end
+            re = /console\.(?:log|error)\.apply\(console, \["\[SERVER\] (?<msg>.*)"\]\);/
+            console_script_lines&.each do |line|
+              match = re.match(line)
+              Rails.logger.info { "[react_on_rails] #{match[:msg]}" } if match
             end
           end
           result
         end
+        # rubocop:enable Metrics/CyclomaticComplexity
 
         def trace_js_code_used(msg, js_code, file_name = "tmp/server-generated.js", force: false)
           return unless ReactOnRails.configuration.trace || force
@@ -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 () {