react_on_rails 13.3.0 → 13.4.0

data/lib/react_on_rails/helper.rb

@@ -313,27 +313,25 @@ module ReactOnRails
       @rails_context.merge(serverSide: server_side)
     end
 
-    # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity
-
-    private
+    def load_pack_for_generated_component(react_component_name, render_options)
+      return unless render_options.auto_load_bundle
 
-    def load_pack_for_component(component_name)
-      is_component_pack_present = File.exist?(generated_components_pack_path(component_name))
-      is_development = ENV["RAILS_ENV"] == "development"
-
-      if is_development && !is_component_pack_present
-        ReactOnRails::PacksGenerator.instance.generate_packs_if_stale
-        raise_missing_pack_error(component_name)
+      ReactOnRails::WebpackerUtils.raise_nested_entries_disabled unless ReactOnRails::WebpackerUtils.nested_entries?
+      if Rails.env.development?
+        is_component_pack_present = File.exist?(generated_components_pack_path(react_component_name))
+        raise_missing_autoloaded_bundle(react_component_name) unless is_component_pack_present
       end
+      append_javascript_pack_tag("generated/#{react_component_name}",
+                                 defer: ReactOnRails.configuration.defer_generated_component_packs)
+      append_stylesheet_pack_tag("generated/#{react_component_name}")
+    end
 
-      ReactOnRails::WebpackerUtils.raise_nested_entries_disabled unless ReactOnRails::WebpackerUtils.nested_entries?
+    # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity
 
-      ApplicationController.helpers.append_javascript_pack_tag "generated/#{component_name}"
-      ApplicationController.helpers.append_stylesheet_pack_tag "generated/#{component_name}"
-    end
+    private
 
-    def generated_components_pack_path(component_name)
-      "#{ReactOnRails::WebpackerUtils.webpacker_source_entry_path}/generated/#{component_name}.js"
+    def generated_components_pack_path(react_component_name)
+      "#{ReactOnRails::WebpackerUtils.webpacker_source_entry_path}/generated/#{react_component_name}.js"
     end
 
     def build_react_component_result_for_server_rendered_string(
@@ -446,7 +444,7 @@ module ReactOnRails
       # Create the HTML rendering part
       result = server_rendered_react_component(render_options)
 
-      load_pack_for_component react_component_name if render_options.auto_load_bundle
+      load_pack_for_generated_component(react_component_name, render_options)
 
       {
         render_options: render_options,
@@ -551,16 +549,6 @@ module ReactOnRails
       result
     end
 
-    def raise_missing_pack_error(component_name)
-      msg = <<~MSG
-        **ERROR** ReactOnRails: Generated missing pack for Component: #{component_name}. Please restart the webpack dev server or webpack in watch mode, to ensure webpack generates the chunks corresponding to #{component_name} component. If the problem persists
-        1. Verify `components_subdirectory` is configured in `config/initializers/react_on_rails`.
-        2. Component: #{component_name} is placed inside the configured `components_subdirectory`.
-      MSG
-
-      raise ReactOnRails::Error, msg
-    end
-
     def replay_console_option(val)
       val.nil? ? ReactOnRails.configuration.replay_console : val
     end
@@ -577,6 +565,17 @@ module ReactOnRails
       instrument_method :react_component, type: "ReactOnRails", name: "react_component"
       instrument_method :react_component_hash, type: "ReactOnRails", name: "react_component_hash"
     end
+
+    def raise_missing_autoloaded_bundle(react_component_name)
+      msg = <<~MSG
+        **ERROR** ReactOnRails: Component "#{react_component_name}" is configured as "auto_load_bundle: true"
+        but the generated component entrypoint, which should have been at #{generated_components_pack_path(react_component_name)},
+        is missing. You might want to check that this component is in a directory named "#{ReactOnRails.configuration.components_subdirectory}"
+        & that "bundle exec rake react_on_rails:generate_packs" has been run.
+      MSG
+
+      raise ReactOnRails::Error, msg
+    end
   end
 end
 # rubocop:enable Metrics/ModuleLength

data/lib/react_on_rails/packs_generator.rb

@@ -13,6 +13,8 @@ module ReactOnRails
     end
 
     def generate_packs_if_stale
+      return unless ReactOnRails.configuration.auto_load_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?
@@ -78,6 +80,8 @@ module ReactOnRails
     end
 
     def add_generated_pack_to_server_bundle
+      return if ReactOnRails.configuration.make_generated_server_bundle_the_entrypoint
+
       relative_path_to_generated_server_bundle = relative_path(server_bundle_entrypoint,
                                                                generated_server_bundle_file_path)
       content = <<~FILE_CONTENT
@@ -93,11 +97,15 @@ module ReactOnRails
     end
 
     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)
-      source_entry_path = ReactOnRails::WebpackerUtils.webpacker_source_entry_path
+      source_entrypoint_parent = Pathname(ReactOnRails::WebpackerUtils.webpacker_source_entry_path).parent
+      generated_nonentrypoints_path = "#{source_entrypoint_parent}/generated"
 
-      "#{source_entry_path}/#{generated_server_bundle_file_name}.js"
+      FileUtils.mkdir_p(generated_nonentrypoints_path)
+      "#{generated_nonentrypoints_path}/#{generated_server_bundle_file_name}.js"
     end
 
     def clean_generated_packs_directory
@@ -214,12 +222,11 @@ module ReactOnRails
 
     def stale_or_missing_packs?
       component_files = common_component_to_path.values + client_component_to_path.values
-      most_recent_mtime = Utils.find_most_recent_mtime(component_files)
+      most_recent_mtime = Utils.find_most_recent_mtime(component_files).to_i
 
       component_files.each_with_object([]).any? do |file|
         path = generated_pack_path(file)
-
-        !File.exist?(path) || File.mtime(path) < most_recent_mtime
+        !File.exist?(path) || File.mtime(path).to_i < most_recent_mtime
       end
     end
   end

data/lib/react_on_rails/server_rendering_pool/ruby_embedded_java_script.rb

@@ -113,9 +113,7 @@ module ReactOnRails
 
         def eval_js(js_code, _render_options)
           @js_context_pool.with do |js_context|
-            result = js_context.eval(js_code)
-            js_context.eval("console.history = []")
-            result
+            js_context.eval(js_code)
           end
         end
 

data/lib/react_on_rails/test_helper/ensure_assets_compiled.rb

@@ -37,7 +37,7 @@ module ReactOnRails
         # All done if no stale files!
         return if stale_gen_files.empty?
 
-        ReactOnRails::PacksGenerator.instance.generate_packs_if_stale
+        ReactOnRails::PacksGenerator.instance.generate_packs_if_stale if ReactOnRails.configuration.auto_load_bundle
 
         # Inform the developer that we're ensuring gen assets are ready.
         puts_start_compile_check_message(stale_gen_files)

data/lib/react_on_rails/test_helper.rb

@@ -35,8 +35,17 @@ module ReactOnRails
     def self.configure_rspec_to_compile_assets(config, *metatags)
       metatags = %i[js server_rendering controller] if metatags.empty?
 
+      # Supported since RSpec 3.5.0
+      supports_first_matching_example = config.respond_to?(:when_first_matching_example_defined)
+
       metatags.each do |metatag|
-        config.before(:example, metatag) { ReactOnRails::TestHelper.ensure_assets_compiled }
+        if supports_first_matching_example
+          config.when_first_matching_example_defined(metatag) do
+            ReactOnRails::TestHelper.ensure_assets_compiled
+          end
+        else
+          config.before(:example, metatag) { ReactOnRails::TestHelper.ensure_assets_compiled }
+        end
       end
     end
 

data/lib/react_on_rails/utils.rb

@@ -219,9 +219,5 @@ module ReactOnRails
 
       puts "Prepended\n#{text_to_prepend}to #{file}."
     end
-
-    def self.semver_to_string(ary)
-      "#{ary[0]}.#{ary[1]}.#{ary[2]}"
-    end
   end
 end

data/lib/react_on_rails/version.rb

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

data/lib/react_on_rails/webpacker_utils.rb

@@ -27,9 +27,10 @@ module ReactOnRails
       @shakapacker_version_as_array = [match[1].to_i, match[2].to_i, match[3].to_i]
     end
 
-    def self.shackapacker_version_requirement_met?(ary)
-      ary[0] >= shakapacker_version_as_array[0] && ary[1] >= shakapacker_version_as_array[1] &&
-        ary[2] >= shakapacker_version_as_array[2]
+    def self.shackapacker_version_requirement_met?(required_version)
+      req_ver = semver_to_string(required_version)
+
+      Gem::Version.new(shakapacker_version) >= Gem::Version.new(req_ver)
     end
 
     # This returns either a URL for the webpack-dev-server, non-server bundle or
@@ -136,5 +137,9 @@ module ReactOnRails
 
       raise ReactOnRails::Error, msg
     end
+
+    def self.semver_to_string(ary)
+      "#{ary[0]}.#{ary[1]}.#{ary[2]}"
+    end
   end
 end

data/package.json

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

data/rakelib/dummy_apps.rake

@@ -16,7 +16,12 @@ namespace :dummy_apps do
     bundle_install_in(dummy_app_dir)
   end
 
-  task dummy_apps: %i[dummy_app node_package] do
+  task :generate_packs do
+    dummy_app_dir = File.join(gem_root, "spec/dummy")
+    sh_in_dir(dummy_app_dir, "bundle exec rake react_on_rails:generate_packs")
+  end
+
+  task dummy_apps: %i[dummy_app node_package generate_packs] do
     puts "Prepared all Dummy Apps"
   end
 end

data/rakelib/run_rspec.rake

@@ -20,15 +20,11 @@ namespace :run_rspec do
 
   desc "Runs dummy rspec with turbolinks"
   task dummy: ["dummy_apps:dummy_app"] do
-    clean_gen_assets(spec_dummy_dir)
-    bundle_install_in(dummy_app_dir)
     run_tests_in(spec_dummy_dir)
   end
 
   desc "Runs dummy rspec without turbolinks"
   task dummy_no_turbolinks: ["dummy_apps:dummy_app"] do
-    clean_gen_assets(spec_dummy_dir)
-    bundle_install_in(dummy_app_dir)
     run_tests_in(spec_dummy_dir,
                  env_vars: "DISABLE_TURBOLINKS=TRUE",
                  command_name: "dummy_no_turbolinks")
@@ -47,15 +43,10 @@ namespace :run_rspec do
     ExampleType.all.each { |example_type| Rake::Task[example_type.rspec_task_name].invoke }
   end
 
-  desc "(HACK) Run RSpec on spec/empty_spec in order to have SimpleCov generate a coverage report from cache"
-  task :empty do
-    sh %(#{ENV['USE_COVERALLS'] ? 'COVERAGE=true' : ''} rspec spec/empty_spec.rb)
-  end
-
   Coveralls::RakeTask.new if ENV["USE_COVERALLS"] == "TRUE"
 
   desc "run all tests no examples"
-  task all_but_examples: %i[gem dummy_no_turbolinks dummy empty js_tests] do
+  task all_but_examples: %i[gem dummy_no_turbolinks dummy js_tests] do
     puts "Completed all RSpec tests"
   end
 
@@ -110,8 +101,3 @@ def run_tests_in(dir, options = {})
   env_vars << "COVERAGE=true" if ENV["USE_COVERALLS"]
   sh_in_dir(path.realpath, "#{env_vars} bundle exec rspec #{rspec_args}")
 end
-
-def clean_gen_assets(dir)
-  path = calc_path(dir)
-  sh_in_dir(path.realpath, "yarn run build:clean")
-end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: react_on_rails
 version: !ruby/object:Gem::Version
-  version: 13.3.0
+  version: 13.4.0
 platform: ruby
 authors:
 - Justin Gordon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-29 00:00:00.000000000 Z
+date: 2023-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -124,6 +124,7 @@ files:
 - ".github/FUNDING.yml"
 - ".github/ISSUE_TEMPLATE/bug_report.md"
 - ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
 - ".github/workflows/lint-js-and-ruby.yml"
 - ".github/workflows/main.yml"
 - ".github/workflows/package-js-tests.yml"
@@ -156,6 +157,7 @@ files:
 - docs/additional-details/manual-installation-overview.md
 - docs/additional-details/migrating-from-react-rails.md
 - docs/additional-details/recommended-project-structure.md
+- docs/additional-details/tips-for-usage-with-sp6.md
 - docs/additional-details/updating-dependencies.md
 - docs/additional-details/upgrade-webpacker-v3-to-v4.md
 - docs/api/javascript-api.md
@@ -202,6 +204,7 @@ files:
 - docs/javascript/react-helmet.md
 - docs/javascript/react-router.md
 - docs/javascript/server-rendering-tips.md
+- docs/javascript/troubleshooting-when-using-shakapacker.md
 - docs/javascript/troubleshooting-when-using-webpacker.md
 - docs/javascript/webpack-v1-notes.md
 - docs/javascript/webpack.md
@@ -224,6 +227,7 @@ files:
 - docs/testimonials/testimonials.md
 - jest.config.js
 - lib/generators/USAGE
+- lib/generators/react_on_rails/adapt_for_older_shakapacker_generator.rb
 - lib/generators/react_on_rails/base_generator.rb
 - lib/generators/react_on_rails/bin/dev
 - lib/generators/react_on_rails/bin/dev-static
@@ -246,6 +250,7 @@ files:
 - lib/generators/react_on_rails/templates/base/base/app/views/layouts/hello_world.html.erb
 - lib/generators/react_on_rails/templates/base/base/babel.config.js.tt
 - lib/generators/react_on_rails/templates/base/base/config/initializers/react_on_rails.rb
+- lib/generators/react_on_rails/templates/base/base/config/shakapacker.yml
 - lib/generators/react_on_rails/templates/base/base/config/webpack/clientWebpackConfig.js.tt
 - lib/generators/react_on_rails/templates/base/base/config/webpack/commonWebpackConfig.js.tt
 - lib/generators/react_on_rails/templates/base/base/config/webpack/development.js.tt
@@ -254,7 +259,6 @@ files:
 - lib/generators/react_on_rails/templates/base/base/config/webpack/test.js.tt
 - lib/generators/react_on_rails/templates/base/base/config/webpack/webpack.config.js.tt
 - lib/generators/react_on_rails/templates/base/base/config/webpack/webpackConfig.js.tt
-- lib/generators/react_on_rails/templates/base/base/config/webpacker.yml
 - lib/generators/react_on_rails/templates/dev_tests/.eslintrc
 - lib/generators/react_on_rails/templates/dev_tests/.rspec
 - lib/generators/react_on_rails/templates/dev_tests/spec/rails_helper.rb