react_on_rails 13.4.0 → 14.0.1

data/lib/generators/react_on_rails/templates/dev_tests/spec/system/hello_world_spec.rb

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

data/lib/react_on_rails/configuration.rb

@@ -137,35 +137,23 @@ module ReactOnRails
     end
 
     def adjust_precompile_task
-      skip_react_on_rails_precompile = %w[no false n f].include?(ENV["REACT_ON_RAILS_PRECOMPILE"])
+      skip_react_on_rails_precompile = %w[no false n f].include?(ENV.fetch("REACT_ON_RAILS_PRECOMPILE", nil))
 
       return if skip_react_on_rails_precompile || build_production_command.blank?
 
-      if Webpacker.config.webpacker_precompile?
-        msg = <<~MSG
-
-          React on Rails and Shakapacker error in configuration!
-          In order to use config/react_on_rails.rb config.build_production_command,
-          you must edit config/webpacker.yml to include this value in the default configuration:
-          'webpacker_precompile: false'
-
-          Alternatively, remove the config/react_on_rails.rb config.build_production_command and the
-          default bin/webpacker script will be used for assets:precompile.
-
-        MSG
-        raise ReactOnRails::Error, msg
-      end
+      raise(ReactOnRails::Error, compile_command_conflict_message) if shakapacker_precompile?
 
       precompile_tasks = lambda {
         Rake::Task["react_on_rails:generate_packs"].invoke
         Rake::Task["react_on_rails:assets:webpack"].invoke
-        puts "Invoking task webpacker:clean from React on Rails"
 
         # VERSIONS is per the shakacode/shakapacker 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)
+
+        puts "Invoking task #{shakapacker_clean_task} from React on Rails"
+        Rake::Task[shakapacker_clean_task].invoke(versions)
       }
 
       if Rake::Task.task_defined?("assets:precompile")
@@ -187,7 +175,7 @@ module ReactOnRails
       webpacker_public_output_path = ReactOnRails::WebpackerUtils.webpacker_public_output_path
 
       if File.expand_path(generated_assets_dir) == webpacker_public_output_path.to_s
-        Rails.logger.warn("You specified generated_assets_dir in `config/initializers/react_on_rails.rb` "\
+        Rails.logger.warn("You specified generated_assets_dir in `config/initializers/react_on_rails.rb` " \
                           "with Webpacker. Remove this line from your configuration file.")
       else
         msg = <<~MSG
@@ -225,20 +213,20 @@ module ReactOnRails
 
       if ReactOnRails::WebpackerUtils.using_webpacker?
         webpacker_public_output_path = ReactOnRails::WebpackerUtils.webpacker_public_output_path
-        Rails.logger.warn "Error configuring config/initializers/react_on_rails. Define neither the "\
-                          "generated_assets_dirs no the generated_assets_dir when using Webpacker. This is defined by "\
-                          "public_output_path specified in webpacker.yml = #{webpacker_public_output_path}."
+        Rails.logger.warn "Error configuring config/initializers/react_on_rails. Define neither the " \
+                          "generated_assets_dirs no the generated_assets_dir when using Webpacker. This is defined " \
+                          "by public_output_path specified in webpacker.yml = #{webpacker_public_output_path}."
         return
       end
 
-      Rails.logger.warn "[DEPRECATION] ReactOnRails: Use config.generated_assets_dir rather than "\
+      Rails.logger.warn "[DEPRECATION] ReactOnRails: Use config.generated_assets_dir rather than " \
                         "generated_assets_dirs"
       if generated_assets_dir.blank?
         self.generated_assets_dir = generated_assets_dirs
       else
-        Rails.logger.warn "[DEPRECATION] ReactOnRails. You have both generated_assets_dirs and "\
-                          "generated_assets_dir defined. Define ONLY generated_assets_dir if NOT using Webpacker"\
-                          " and define neither if using Webpacker"
+        Rails.logger.warn "[DEPRECATION] ReactOnRails. You have both generated_assets_dirs and " \
+                          "generated_assets_dir defined. Define ONLY generated_assets_dir if NOT using Webpacker " \
+                          "and define neither if using Webpacker"
       end
     end
 
@@ -266,6 +254,32 @@ module ReactOnRails
 
       raise ReactOnRails::Error, msg
     end
+
+    def shakapacker_precompile?
+      return Webpacker.config.webpacker_precompile? if ReactOnRails::WebpackerUtils.using_shakapacker_6?
+
+      Webpacker.config.shakapacker_precompile?
+    end
+
+    def shakapacker_clean_task
+      ReactOnRails::WebpackerUtils.using_shakapacker_6? ? "webpacker:clean" : "shakapacker:clean"
+    end
+
+    def compile_command_conflict_message
+      packer = ReactOnRails::WebpackerUtils.using_shakapacker_6? ? "webpacker" : "shakapacker"
+
+      <<~MSG
+
+        React on Rails and Shakapacker error in configuration!
+        In order to use config/react_on_rails.rb config.build_production_command,
+        you must edit config/#{packer}.yml to include this value in the default configuration:
+        '#{packer}_precompile: false'
+
+        Alternatively, remove the config/react_on_rails.rb config.build_production_command and the
+        default bin/#{packer} script will be used for assets:precompile.
+
+      MSG
+    end
   end
 end
 # rubocop:enable Metrics/ClassLength

data/lib/react_on_rails/git_utils.rb

@@ -4,13 +4,13 @@ require "English"
 
 module ReactOnRails
   module GitUtils
-    def self.uncommitted_changes?(message_handler)
+    def self.uncommitted_changes?(message_handler, git_installed: true)
       return false if ENV["COVERAGE"] == "true"
 
       status = `git status --porcelain`
-      return false if $CHILD_STATUS.success? && status.empty?
+      return false if git_installed && status&.empty?
 
-      error = if $CHILD_STATUS.success?
+      error = if git_installed
                 "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"

data/lib/react_on_rails/helper.rb

@@ -155,7 +155,7 @@ module ReactOnRails
       if defer
         @registered_stores_defer_render ||= []
         @registered_stores_defer_render << redux_store_data
-        "YOU SHOULD NOT SEE THIS ON YOUR VIEW -- Uses as a code block, like <% redux_store %> "\
+        "YOU SHOULD NOT SEE THIS ON YOUR VIEW -- Uses as a code block, like <% redux_store %> " \
           "and not <%= redux store %>"
       else
         @registered_stores ||= []
@@ -245,7 +245,7 @@ module ReactOnRails
       return "{}" if hash_or_string.nil?
 
       unless hash_or_string.is_a?(String) || hash_or_string.is_a?(Hash)
-        raise ReactOnRails::Error, "#{__method__} only accepts String or Hash as argument "\
+        raise ReactOnRails::Error, "#{__method__} only accepts String or Hash as argument " \
                                    "(#{hash_or_string.class} given)."
       end
 
@@ -441,11 +441,10 @@ module ReactOnRails
                                                 "data-trace" => (render_options.trace ? true : nil),
                                                 "data-dom-id" => render_options.dom_id)
 
+      load_pack_for_generated_component(react_component_name, render_options)
       # Create the HTML rendering part
       result = server_rendered_react_component(render_options)
 
-      load_pack_for_generated_component(react_component_name, render_options)
-
       {
         render_options: render_options,
         tag: component_specification_tag,

data/lib/react_on_rails/json_output.rb

@@ -4,25 +4,8 @@ require "active_support/core_ext/string/output_safety"
 
 module ReactOnRails
   class JsonOutput
-    ESCAPE_REPLACEMENT = {
-      "&" => '\u0026',
-      ">" => '\u003e',
-      "<" => '\u003c',
-      "\u2028" => '\u2028',
-      "\u2029" => '\u2029'
-    }.freeze
-    ESCAPE_REGEXP = /[\u2028\u2029&><]/u.freeze
-
     def self.escape(json)
-      return escape_without_erb_util(json) if Utils.rails_version_less_than_4_1_1
-
       ERB::Util.json_escape(json)
     end
-
-    def self.escape_without_erb_util(json)
-      # https://github.com/rails/rails/blob/60257141462137331387d0e34931555cf0720886/activesupport/lib/active_support/core_ext/string/output_safety.rb#L113
-
-      json.to_s.gsub(ESCAPE_REGEXP, ESCAPE_REPLACEMENT)
-    end
   end
 end

data/lib/react_on_rails/locales/base.rb

@@ -100,14 +100,14 @@ module ReactOnRails
 
       def convert
         file_names.each do |name|
-          template = send("template_#{name}")
+          template = send(:"template_#{name}")
           path = file(name)
           generate_file(template, path)
         end
       end
 
       def generate_file(template, path)
-        result = ERB.new(template).result()
+        result = ERB.new(template).result
         File.write(path, result)
       end
 
@@ -138,7 +138,7 @@ module ReactOnRails
       def flatten(translations)
         translations.each_with_object({}) do |(k, v), h|
           if v.is_a? Hash
-            flatten(v).map { |hk, hv| h["#{k}.#{hk}".to_sym] = hv }
+            flatten(v).map { |hk, hv| h[:"#{k}.#{hk}"] = hv }
           elsif v.is_a?(String)
             h[k] = v.gsub("%{", "{")
           elsif !v.is_a?(Array)
@@ -157,7 +157,7 @@ module ReactOnRails
         <<-JS.strip_heredoc
           import { defineMessages } from 'react-intl';
 
-          const defaultLocale = \'#{default_locale}\';
+          const defaultLocale = '#{default_locale}';
 
           const defaultMessages = defineMessages(#{@defaults});
 

data/lib/react_on_rails/locales/to_js.rb

@@ -21,7 +21,7 @@ module ReactOnRails
         <<-JS.strip_heredoc
           import { defineMessages } from 'react-intl';
 
-          const defaultLocale = \'#{default_locale}\';
+          const defaultLocale = '#{default_locale}';
 
           const defaultMessages = defineMessages(#{@defaults});
 

data/lib/react_on_rails/packs_generator.rb

@@ -5,7 +5,7 @@ require "fileutils"
 module ReactOnRails
   # rubocop:disable Metrics/ClassLength
   class PacksGenerator
-    CONTAINS_CLIENT_OR_SERVER_REGEX = /\.(server|client)($|\.)/.freeze
+    CONTAINS_CLIENT_OR_SERVER_REGEX = /\.(server|client)($|\.)/
     MINIMUM_SHAKAPACKER_VERSION = [6, 5, 1].freeze
 
     def self.instance
@@ -15,6 +15,7 @@ module ReactOnRails
     def generate_packs_if_stale
       return unless ReactOnRails.configuration.auto_load_bundle
 
+      add_generated_pack_to_server_bundle
       are_generated_files_present_and_up_to_date = Dir.exist?(generated_packs_directory_path) &&
                                                    File.exist?(generated_server_bundle_file_path) &&
                                                    !stale_or_missing_packs?
@@ -99,8 +100,8 @@ module ReactOnRails
     def generated_server_bundle_file_path
       return server_bundle_entrypoint if ReactOnRails.configuration.make_generated_server_bundle_the_entrypoint
 
-      generated_server_bundle_file_path = server_bundle_entrypoint.sub(".js", "-generated.js")
-      generated_server_bundle_file_name = component_name(generated_server_bundle_file_path)
+      generated_interim_server_bundle_path = server_bundle_entrypoint.sub(".js", "-generated.js")
+      generated_server_bundle_file_name = component_name(generated_interim_server_bundle_path)
       source_entrypoint_parent = Pathname(ReactOnRails::WebpackerUtils.webpacker_source_entry_path).parent
       generated_nonentrypoints_path = "#{source_entrypoint_parent}/generated"
 
@@ -155,9 +156,7 @@ module ReactOnRails
     end
 
     def common_component_to_path
-      common_components_paths = Dir.glob("#{components_search_path}/*").reject do |f|
-        CONTAINS_CLIENT_OR_SERVER_REGEX.match?(f)
-      end
+      common_components_paths = Dir.glob("#{components_search_path}/*").grep_v(CONTAINS_CLIENT_OR_SERVER_REGEX)
       component_name_to_path(common_components_paths)
     end
 

data/lib/react_on_rails/react_component/render_options.rb

@@ -35,7 +35,7 @@ module ReactOnRails
                                                                           props.clone)
           end
 
-          raise ReactOnRails::Error, "ReactOnRails: your rendering_props_extension module is missing the "\
+          raise ReactOnRails::Error, "ReactOnRails: your rendering_props_extension module is missing the " \
                                      "required adjust_props_for_client_side_hydration method & can not be used"
         end
         props

data/lib/react_on_rails/server_rendering_pool/ruby_embedded_java_script.rb

@@ -7,7 +7,6 @@ module ReactOnRails
   module ServerRenderingPool
     # rubocop:disable Metrics/ClassLength
     class RubyEmbeddedJavaScript
-      # rubocop:enable Metrics/ClassLength
       class << self
         def reset_pool
           options = {
@@ -125,8 +124,8 @@ module ReactOnRails
             File.read(server_js_file)
           end
         rescue StandardError => e
-          msg = "You specified server rendering JS file: #{server_js_file}, but it cannot be "\
-                "read. You may set the server_bundle_js_file in your configuration to be \"\" to "\
+          msg = "You specified server rendering JS file: #{server_js_file}, but it cannot be " \
+                "read. You may set the server_bundle_js_file in your configuration to be \"\" to " \
                 "avoid this warning.\nError is: #{e}"
           raise ReactOnRails::Error, msg
         end
@@ -145,15 +144,15 @@ module ReactOnRails
           begin
             if ReactOnRails.configuration.trace
               Rails.logger.info do
-                "[react_on_rails] Created JavaScript context with file "\
+                "[react_on_rails] Created JavaScript context with file " \
                   "#{ReactOnRails::Utils.server_bundle_js_file_path}"
               end
             end
             ExecJS.compile(base_js_code)
           rescue StandardError => e
-            msg = "ERROR when compiling base_js_code! "\
-                  "See file #{file_name} to "\
-                  "correlate line numbers of error. Error is\n\n#{e.message}"\
+            msg = "ERROR when compiling base_js_code! " \
+                  "See file #{file_name} to " \
+                  "correlate line numbers of error. Error is\n\n#{e.message}" \
                   "\n\n#{e.backtrace.join("\n")}"
             Rails.logger.error(msg)
             trace_js_code_used("Error when compiling JavaScript code for the context.", base_js_code,
@@ -192,8 +191,8 @@ module ReactOnRails
 
         def undefined_for_exec_js_logging(function_name)
           if ReactOnRails.configuration.trace
-            "console.error('[React on Rails Rendering] #{function_name} is not defined for server rendering.');\n"\
-              "  console.error(getStackTrace().join('\\n'));"
+            "console.error('[React on Rails Rendering] #{function_name} is not defined for server rendering.');\n  " \
+              "console.error(getStackTrace().join('\\n'));"
           else
             ""
           end
@@ -235,6 +234,7 @@ module ReactOnRails
           raise ReactOnRails::Error, msg
         end
       end
+      # rubocop:enable Metrics/ClassLength
     end
   end
 end

data/lib/react_on_rails/test_helper/webpack_assets_status_checker.rb

@@ -62,10 +62,10 @@ module ReactOnRails
           else
             file_list = make_file_list(make_globs(generated_assets_full_path)).to_ary
             puts "V" * 80
-            puts "Please define config.webpack_generated_files (array) so the test helper knows "\
-                 "which files are required. If you are using webpacker, you typically need to only "\
+            puts "Please define config.webpack_generated_files (array) so the test helper knows " \
+                 "which files are required. If you are using webpacker, you typically need to only " \
                  "include 'manifest.json'."
-            puts "Detected the possible following files to check for webpack compilation in "\
+            puts "Detected the possible following files to check for webpack compilation in " \
                  "#{generated_assets_full_path}"
             puts file_list.join("\n")
             puts "^" * 80

data/lib/react_on_rails/test_helper.rb

@@ -80,8 +80,8 @@ module ReactOnRails
 
         unless @printed_once
           puts
-          puts "====> React On Rails: Checking files in "\
-               "#{webpack_assets_status_checker.generated_assets_full_path} for "\
+          puts "====> React On Rails: Checking files in " \
+               "#{webpack_assets_status_checker.generated_assets_full_path} for " \
                "outdated/missing bundles based on source_path #{source_path}"
           puts
           @printed_once = true

data/lib/react_on_rails/utils.rb

@@ -118,12 +118,6 @@ 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)
         raise ReactOnRails::Error, "#{arg_name} is required"
@@ -195,13 +189,13 @@ module ReactOnRails
       to_remove = str.length - max_length
       lstrip = (to_remove / 2.0).ceil
       rstrip = to_remove - lstrip
-      str[0..(midpoint - lstrip - 1)] + TRUNCATION_FILLER + str[(midpoint + rstrip)..-1]
+      str[0..(midpoint - lstrip - 1)] + TRUNCATION_FILLER + str[(midpoint + rstrip)..]
     end
 
     def self.find_most_recent_mtime(files)
       files.reduce(1.year.ago) do |newest_time, file|
         mt = File.mtime(file)
-        mt > newest_time ? mt : newest_time
+        [mt, newest_time].max
       end
     end
 

data/lib/react_on_rails/version.rb

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

data/lib/react_on_rails/version_checker.rb

@@ -6,7 +6,7 @@ module ReactOnRails
   class VersionChecker
     attr_reader :node_package_version
 
-    MAJOR_MINOR_PATCH_VERSION_REGEX = /(\d+)\.(\d+)\.(\d+)/.freeze
+    MAJOR_MINOR_PATCH_VERSION_REGEX = /(\d+)\.(\d+)\.(\d+)/
 
     def self.build
       new(NodePackageVersion.build)
@@ -52,7 +52,7 @@ module ReactOnRails
     end
 
     def raise_node_semver_version_warning
-      msg = "**ERROR** ReactOnRails: Your node package version for react-on-rails contains a "\
+      msg = "**ERROR** ReactOnRails: Your node package version for react-on-rails contains a " \
             "^ or ~\n#{common_error_msg}"
       raise ReactOnRails::Error, msg
     end

data/lib/react_on_rails/webpacker_utils.rb

@@ -141,5 +141,11 @@ module ReactOnRails
     def self.semver_to_string(ary)
       "#{ary[0]}.#{ary[1]}.#{ary[2]}"
     end
+
+    def self.using_shakapacker_6?
+      shakapacker_major_version = shakapacker_version_as_array[0]
+
+      shakapacker_major_version == 6
+    end
   end
 end

data/lib/tasks/assets.rake

@@ -18,7 +18,7 @@ namespace :react_on_rails do
         elsif build_production_command.methods.include?(:call)
           build_production_command.call
         else
-          msg = "ReactonRails.configuration.build_production_command is improperly configured. "\
+          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)

data/react_on_rails.gemspec

@@ -16,14 +16,15 @@ Gem::Specification.new do |s|
   s.homepage      = "https://github.com/shakacode/react_on_rails"
   s.license       = "MIT"
 
-  s.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features|gen-examples|tmp|node_modules|node_package|coverage)/})
+  s.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(docs|test|spec|features|gen-examples|tmp|node_modules|node_package|coverage|rakelib|script)/}) ||
+      f.match(%r{^(jest\.config\.js|book\.json|package\.json|package-scripts\.yml|yarn\.lock|\..*)})
   end
   s.bindir        = "exe"
   s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.required_ruby_version = ">= 2.7.0"
+  s.required_ruby_version = ">= 3.0.0"
 
   s.add_dependency "addressable"
   s.add_dependency "connection_pool"
@@ -31,7 +32,6 @@ Gem::Specification.new do |s|
   s.add_dependency "rails", ">= 5.2"
   s.add_dependency "rainbow", "~> 3.0"
 
-  s.add_development_dependency "bundler", "~> 2"
   s.add_development_dependency "gem-release"
   s.post_install_message = '
 --------------------------------------------------------------------------------