react_on_rails 12.0.0 → 12.0.4

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

@@ -15,7 +15,10 @@ require "capybara/rspec"
 require "capybara/rails"
 Capybara.javascript_driver = :selenium_chrome
 Capybara.register_driver :selenium_chrome do |app|
-  Capybara::Selenium::Driver.new(app, browser: :chrome)
+  options = Selenium::WebDriver::Chrome::Options.new
+  options.add_argument("--headless")
+  options.add_argument("--disable-gpu")
+  Capybara::Selenium::Driver.new(app, browser: :chrome, options: options)
 end
 
 # Requires supporting ruby files with custom matchers and macros, etc, in

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 =~ %r{/spec/}
     end
   end
 end

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

@@ -17,13 +17,13 @@ module ReactOnRails
 
     COMPONENT_HTML_KEY = "componentHtml"
 
-    # react_component_name: can be a React function or class component or a "render function".
-    # "render functions" differ from a React function in that they take two parameters, the
+    # react_component_name: can be a React function or class component or a "Render-Function".
+    # "Render-Functions" differ from a React function in that they take two parameters, the
     #   props and the railsContext, like this:
     #
     #   let MyReactComponentApp = (props, railsContext) => <MyReactComponent {...props}/>;
     #
-    #   Alternately, you can define the render function with an additional property
+    #   Alternately, you can define the Render-Function with an additional property
     #   `.renderFunction = true`:
     #
     #   let MyReactComponentApp = (props) => <MyReactComponent {...props}/>;
@@ -32,8 +32,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 +57,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
@@ -79,7 +80,7 @@ module ReactOnRails
           Value:
           #{server_rendered_html}
 
-          If you're trying to use a render function to return a Hash to your ruby view code, then use
+          If you're trying to use a Render-Function to return a Hash to your ruby view code, then use
           react_component_hash instead of react_component and see
           https://github.com/shakacode/react_on_rails/blob/master/spec/dummy/client/app/startup/ReactHelmetServerApp.jsx
           for an example of the JavaScript code.
@@ -93,7 +94,7 @@ module ReactOnRails
     # It is exactly like react_component except for the following:
     # 1. prerender: true is automatically added, as this method doesn't make sense for client only
     #    rendering.
-    # 2. Your JavaScript render function for server rendering must return an Object rather than a React component.
+    # 2. Your JavaScript Render-Function for server rendering must return an Object rather than a React component.
     # 3. Your view code must expect an object and not a string.
     #
     # Here is an example of the view code:
@@ -124,10 +125,10 @@ module ReactOnRails
         )
       else
         msg = <<~MSG
-          render function used by react_component_hash for #{component_name} is expected to return
+          Render-Function used by react_component_hash for #{component_name} is expected to return
           an Object. See https://github.com/shakacode/react_on_rails/blob/master/spec/dummy/client/app/startup/ReactHelmetServerApp.jsx
           for an example of the JavaScript code.
-          Note, your render function must either take 2 params or have the property
+          Note, your Render-Function must either take 2 params or have the property
           `.renderFunction = true` added to it to distinguish it from a React Function Component.
         MSG
         raise ReactOnRails::Error, msg
@@ -240,10 +241,10 @@ module ReactOnRails
     end
 
     # This is the definitive list of the default values used for the rails_context, which is the
-    # second parameter passed to both component and store render functions.
+    # 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
@@ -291,7 +292,7 @@ module ReactOnRails
 
       @rails_context.merge(serverSide: server_side)
     end
-    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity
 
     private
 

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/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

data/lib/react_on_rails/test_helper.rb

@@ -52,6 +52,7 @@ module ReactOnRails
     #                        don't provide one.
     # webpack_generated_files List of files to check for up-to-date-status, defaulting to
     #                        webpack_generated_files in your configuration
+    # rubocop:disable Metrics/CyclomaticComplexity
     def self.ensure_assets_compiled(webpack_assets_status_checker: nil,
                                     webpack_assets_compiler: nil,
                                     source_path: nil,
@@ -96,4 +97,5 @@ module ReactOnRails
       ).call
     end
   end
+  # rubocop:enable Metrics/CyclomaticComplexity
 end

data/lib/react_on_rails/test_helper/webpack_assets_compiler.rb

@@ -8,7 +8,7 @@ module ReactOnRails
       def compile_assets
         if ReactOnRails.configuration.build_test_command.blank?
           msg = <<~MSG
-            You are using the React on Rails test helper. 
+            You are using the React on Rails test helper.
             Either you used:
               ReactOnRails::TestHelper.configure_rspec_to_compile_assets or
               ReactOnRails::TestHelper.ensure_assets_compiled

data/lib/react_on_rails/utils.rb

@@ -34,7 +34,7 @@ module ReactOnRails
     end
 
     def self.object_to_boolean(value)
-      [true, "true", "yes", 1, "1", "t"].include?(value.class == String ? value.downcase : value)
+      [true, "true", "yes", 1, "1", "t"].include?(value.instance_of?(String) ? value.downcase : value)
     end
 
     def self.server_rendering_is_enabled?
@@ -71,7 +71,11 @@ module ReactOnRails
       # 1. Using same bundle for both server and client, so server bundle will be hashed in manifest
       # 2. Using a different bundle (different Webpack config), so file is not hashed, and
       #    bundle_js_path will throw so the default path is used without a hash.
-      # 3. Not using webpacker, and this method returns the bundle_js_file_path
+      # 3. The third option of having the server bundle hashed and a different configuration than
+      #    the client bundle is not supported for 2 reasons:
+      #    a. The webpack manifest plugin would have a race condition where the same manifest.json
+      #       is edited by both the webpack-dev-server
+      #    b. There is no good reason to hash the server bundle name.
       return @server_bundle_path if @server_bundle_path && !Rails.env.development?
 
       bundle_name = ReactOnRails.configuration.server_bundle_js_file
@@ -114,9 +118,11 @@ module ReactOnRails
       end
     end
 
+    # rubocop:disable Naming/VariableNumber
     def self.rails_version_less_than_4_1_1
       rails_version_less_than("4.1.1")
     end
+    # rubocop:enable Naming/VariableNumber
 
     module Required
       def required(arg_name)

data/lib/react_on_rails/version.rb

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

data/lib/react_on_rails/webpacker_utils.rb

@@ -28,10 +28,10 @@ module ReactOnRails
       # Next line will throw if the file or manifest does not exist
       hashed_bundle_name = Webpacker.manifest.lookup!(bundle_name)
 
-      # support for hashing the server-bundle and having that built
-      # by a webpack watch process and not served by the webpack-dev-server, then we
-      # need an extra config value "same_bundle_for_client_and_server" where a value of false
-      # would mean that the bundle is created by a separate webpack watch process.
+      # Support for hashing the server-bundle and having that built
+      # the webpack-dev-server is provided by the config value
+      # "same_bundle_for_client_and_server" where a value of true
+      # would mean that the bundle is created by the webpack-dev-server
       is_server_bundle = bundle_name == ReactOnRails.configuration.server_bundle_js_file
 
       if Webpacker.dev_server.running? && (!is_server_bundle ||

data/lib/tasks/assets.rake

@@ -13,26 +13,37 @@ unless ReactOnRails::WebpackerUtils.webpacker_webpack_production_config_exists?
   # the build command.
   ENV["WEBPACKER_PRECOMPILE"] = "false"
 
+  precompile_tasks = lambda {
+    Rake::Task["react_on_rails:assets:webpack"].invoke
+    puts "Invoking task webpacker:clean from React on Rails"
+
+    # VERSIONS is per the rails/webpacker clean method definition.
+    # We set it very big so that it is not used, and then clean just
+    # removes files older than 1 hour.
+    versions = 100_000
+    Rake::Task["webpacker:clean"].invoke(versions)
+  }
+
   if Rake::Task.task_defined?("assets:precompile")
     Rake::Task["assets:precompile"].enhance do
-      Rake::Task["react_on_rails:assets:webpack"].invoke
-      puts "Invoking task webpacker:clean from React on Rails"
-      Rake::Task["webpacker:clean"].invoke
+      precompile_tasks.call
     end
   else
-    Rake::Task.define_task("assets:precompile" => ["react_on_rails:assets:webpack",
-                                                   "webpacker:clean"])
+    Rake::Task.define_task("assets:precompile") do
+      precompile_tasks.call
+    end
   end
 end
 
 # Sprockets independent tasks
+# rubocop:disable Metrics/BlockLength
 namespace :react_on_rails do
   namespace :assets do
     desc <<-DESC.strip_heredoc
-      Compile assets with webpack	
-      Uses command defined with ReactOnRails.configuration.build_production_command	
-      sh "#{ReactOnRails::Utils.prepend_cd_node_modules_directory('<ReactOnRails.configuration.build_production_command>')}"	
-      Note: This command is not automatically added to assets:precompile if the rails/webpacker	
+      Compile assets with webpack
+      Uses command defined with ReactOnRails.configuration.build_production_command
+      sh "#{ReactOnRails::Utils.prepend_cd_node_modules_directory('<ReactOnRails.configuration.build_production_command>')}"
+      Note: This command is not automatically added to assets:precompile if the rails/webpacker
       configuration file config/webpack/production.js exists.
     DESC
     task webpack: :locale do
@@ -55,3 +66,4 @@ namespace :react_on_rails do
     end
   end
 end
+# rubocop:enable Metrics/BlockLength

data/package.json

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

data/rakelib/docker.rake

@@ -6,11 +6,6 @@ namespace :docker do
     sh "docker-compose run lint rake lint:rubocop"
   end
 
-  desc "Run ruby-lint linter from docker"
-  task :ruby do
-    sh "docker-compose run lint rake lint:ruby"
-  end
-
   desc "Run scss-lint linter from docker"
   task :scss do
     sh "docker-compose run lint rake lint:scss"

data/rakelib/examples.rake

@@ -6,7 +6,7 @@
 # Also see example_type.rb
 
 require "yaml"
-require 'rails/version'
+require "rails/version"
 
 require_relative "example_type"
 require_relative "task_helpers"

data/rakelib/lint.rake

@@ -2,18 +2,12 @@
 
 require_relative "task_helpers"
 
-namespace :lint do # rubocop:disable Metrics/BlockLength
+namespace :lint do
   include ReactOnRails::TaskHelpers
 
   desc "Run Rubocop as shell"
   task :rubocop do
-    sh_in_dir(gem_root, "bundle exec rubocop .")
-  end
-
-  desc "Run ruby-lint as shell"
-  task :ruby do
-    puts "See /ruby-lint.yml for what directories are included."
-    sh_in_dir(gem_root, "bundle exec ruby-lint .")
+    sh_in_dir(gem_root, "bundle exec rubocop --version", "bundle exec rubocop .")
   end
 
   desc "Run scss-lint as shell"
@@ -23,10 +17,10 @@ namespace :lint do # rubocop:disable Metrics/BlockLength
 
   desc "Run eslint as shell"
   task :eslint do
-    sh_in_dir(gem_root, "yarn run eslint")
+    sh_in_dir(gem_root, "yarn run eslint --version", "yarn run eslint .")
   end
 
-  desc "Run all eslint & rubocop linters. Skip ruby-lint and scss"
+  desc "Run all eslint & rubocop linters. Skip scss"
   task lint: %i[eslint rubocop] do
     puts "Completed all linting"
   end

data/rakelib/release.rake

@@ -4,6 +4,13 @@ require_relative "task_helpers"
 require_relative File.join(gem_root, "lib", "react_on_rails", "version_syntax_converter")
 require_relative File.join(gem_root, "lib", "react_on_rails", "git_utils")
 require_relative File.join(gem_root, "lib", "react_on_rails", "utils")
+
+class RaisingMessageHandler
+  def add_error(error)
+    raise error
+  end
+end
+
 desc("Releases both the gem and node package using the given version.
 
 IMPORTANT: the gem version must be in valid rubygem format (no dashes).
@@ -19,19 +26,11 @@ which are installed via `bundle install` and `yarn`
 2nd argument: Perform a dry run by passing 'true' as a second argument.
 
 Example: `rake release[2.1.0,false]`")
-
-# rubocop:disable Metrics/BlockLength
 task :release, %i[gem_version dry_run tools_install] do |_t, args|
   include ReactOnRails::TaskHelpers
 
-  class MessageHandler
-    def add_error(error)
-      raise error
-    end
-  end
-
   # Check if there are uncommited changes
-  ReactOnRails::GitUtils.uncommitted_changes?(MessageHandler.new)
+  ReactOnRails::GitUtils.uncommitted_changes?(RaisingMessageHandler.new)
   args_hash = args.to_hash
 
   is_dry_run = ReactOnRails::Utils.object_to_boolean(args_hash[:dry_run])
@@ -67,8 +66,5 @@ task :release, %i[gem_version dry_run tools_install] do |_t, args|
   sh_in_dir(gem_root, release_it_command)
 
   # Release the new gem version
-  unless is_dry_run
-    sh_in_dir(gem_root, "gem release")
-  end
+  sh_in_dir(gem_root, "gem release") unless is_dry_run
 end
-# rubocop:enable Metrics/BlockLength

data/rakelib/run_rspec.rake

@@ -86,16 +86,15 @@ task run_rspec: ["run_rspec:run_rspec"]
 private
 
 def calc_path(dir)
-  path = if dir.is_a?(String)
-           if dir.start_with?(File::SEPARATOR)
-             Pathname.new(dir)
-           else
-             Pathname.new(File.join(gem_root, dir))
-           end
-         else
-           dir
-         end
-  path
+  if dir.is_a?(String)
+    if dir.start_with?(File::SEPARATOR)
+      Pathname.new(dir)
+    else
+      Pathname.new(File.join(gem_root, dir))
+    end
+  else
+    dir
+  end
 end
 
 # Runs rspec in the given directory.