react_on_rails 13.2.0 → 13.3.0

data/lib/generators/react_on_rails/bin/dev

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+def installed?(process)
+  IO.popen "#{process} -v"
+rescue Errno::ENOENT
+  false
+end
+
+def run(process)
+  args = [*ARGV]
+  args.shift
+  puts "Using #{process}"
+  exec "#{process} start -f Procfile.dev", args.join(" ")
+rescue Errno::ENOENT
+  warn <<~MSG
+    ERROR:
+    Please ensure `Procfile.dev` exist in your project!
+  MSG
+  exit!
+end
+
+if installed? "overmind"
+  run "overmind"
+elsif installed? "foreman"
+  run "foreman"
+else
+  warn <<~MSG
+    NOTICE:
+    For this script to run, you need either 'overmind' or 'foreman' installed on your machine. Please try this script after installing one of them.
+  MSG
+  exit!
+end

data/lib/generators/react_on_rails/bin/dev-static

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+def installed?(process)
+  IO.popen "#{process} -v"
+rescue Errno::ENOENT
+  false
+end
+
+def run(process)
+  args = [*ARGV]
+  args.shift
+  puts "Using #{process}"
+  exec "#{process} start -f Procfile.dev-static", args.join(" ")
+rescue Errno::ENOENT
+  warn <<~MSG
+    ERROR:
+    Please ensure `Procfile.dev-static` exist in your project!
+  MSG
+  exit!
+end
+
+if installed? "overmind"
+  run "overmind"
+elsif installed? "foreman"
+  run "foreman"
+else
+  warn <<~MSG
+    NOTICE:
+    For this script to run, you need either 'overmind' or 'foreman' installed on your machine. Please try this script after installing one of them.
+  MSG
+  exit!
+end

data/lib/generators/react_on_rails/install_generator.rb

@@ -28,6 +28,7 @@ module ReactOnRails
       def run_generators
         if installation_prerequisites_met? || options.ignore_warnings?
           invoke_generators
+          add_bin_scripts
         else
           error = "react_on_rails generator prerequisites not met!"
           GeneratorMessages.add_error(error)
@@ -75,6 +76,10 @@ module ReactOnRails
         GeneratorMessages.add_error(error)
         true
       end
+
+      def add_bin_scripts
+        directory "#{__dir__}/bin", "bin"
+      end
     end
   end
 end

data/lib/generators/react_on_rails/templates/base/base/config/initializers/react_on_rails.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# See https://github.com/shakacode/react_on_rails/blob/master/docs/basics/configuration.md
+# See https://github.com/shakacode/react_on_rails/blob/master/docs/guides/configuration.md
 # for many more options.
 
 ReactOnRails.configure do |config|

data/lib/react_on_rails/configuration.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# rubocop:disable Metrics/ClassLength
+
 module ReactOnRails
   def self.configure
     yield(configuration)
@@ -109,6 +111,7 @@ module ReactOnRails
 
     # on ReactOnRails
     def setup_config_values
+      check_autobundling_requirements_if_configured
       ensure_webpack_generated_files_exists
       configure_generated_assets_dirs_deprecation
       configure_skip_display_none_deprecation
@@ -121,14 +124,37 @@ module ReactOnRails
 
     private
 
+    def check_autobundling_requirements_if_configured
+      raise_missing_components_subdirectory if auto_load_bundle && !components_subdirectory.present?
+      return unless components_subdirectory.present?
+
+      ReactOnRails::WebpackerUtils.raise_shakapacker_not_installed unless ReactOnRails::WebpackerUtils.using_webpacker?
+      ReactOnRails::WebpackerUtils.raise_shakapacker_version_incompatible_for_autobundling unless
+        ReactOnRails::WebpackerUtils.shackapacker_version_requirement_met?(
+          ReactOnRails::PacksGenerator::MINIMUM_SHAKAPACKER_VERSION
+        )
+      ReactOnRails::WebpackerUtils.raise_nested_entries_disabled unless ReactOnRails::WebpackerUtils.nested_entries?
+    end
+
     def adjust_precompile_task
       skip_react_on_rails_precompile = %w[no false n f].include?(ENV["REACT_ON_RAILS_PRECOMPILE"])
 
       return if skip_react_on_rails_precompile || build_production_command.blank?
 
-      # Ensure that shakacode/shakapacker does not call bin/webpacker if we're providing
-      # the build command.
-      ENV["WEBPACKER_PRECOMPILE"] = "false"
+      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
 
       precompile_tasks = lambda {
         Rake::Task["react_on_rails:generate_packs"].invoke
@@ -230,5 +256,16 @@ module ReactOnRails
 
       Rails.logger.warn "[DEPRECATION] ReactOnRails: remove skip_display_none from configuration."
     end
+
+    def raise_missing_components_subdirectory
+      msg = <<~MSG
+        **ERROR** ReactOnRails: auto_load_bundle is set to true, yet components_subdirectory is unconfigured.\
+        Please set components_subdirectory to the desired directory.  For more information, please see \
+        https://www.shakacode.com/react-on-rails/docs/guides/file-system-based-automated-bundle-generation.md
+      MSG
+
+      raise ReactOnRails::Error, msg
+    end
   end
 end
+# rubocop:enable Metrics/ClassLength

data/lib/react_on_rails/helper.rb

@@ -91,26 +91,6 @@ module ReactOnRails
       end
     end
 
-    def load_pack_for_component(component_name)
-      component_pack_file = generated_components_pack(component_name)
-      is_component_pack_present = File.exist?("#{component_pack_file}.jsx")
-      is_development = ENV["RAILS_ENV"] == "development"
-
-      if is_development && !is_component_pack_present
-        ReactOnRails::PacksGenerator.generate
-        raise_generated_missing_pack_warning(component_name)
-      end
-
-      ReactOnRails::PacksGenerator.raise_nested_enteries_disabled unless ReactOnRails::WebpackerUtils.nested_entries?
-
-      append_javascript_pack_tag "generated/#{component_name}"
-      append_stylesheet_pack_tag "generated/#{component_name}"
-    end
-
-    def generated_components_pack(component_name)
-      "#{ReactOnRails::WebpackerUtils.webpacker_source_entry_path}/generated/#{component_name}"
-    end
-
     # react_component_hash is used to return multiple HTML strings for server rendering, such as for
     # adding meta-tags to a page.
     # It is exactly like react_component except for the following:
@@ -337,6 +317,25 @@ module ReactOnRails
 
     private
 
+    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)
+      end
+
+      ReactOnRails::WebpackerUtils.raise_nested_entries_disabled unless ReactOnRails::WebpackerUtils.nested_entries?
+
+      ApplicationController.helpers.append_javascript_pack_tag "generated/#{component_name}"
+      ApplicationController.helpers.append_stylesheet_pack_tag "generated/#{component_name}"
+    end
+
+    def generated_components_pack_path(component_name)
+      "#{ReactOnRails::WebpackerUtils.webpacker_source_entry_path}/generated/#{component_name}.js"
+    end
+
     def build_react_component_result_for_server_rendered_string(
       server_rendered_html: required("server_rendered_html"),
       component_specification_tag: required("component_specification_tag"),
@@ -552,10 +551,9 @@ module ReactOnRails
       result
     end
 
-    def raise_generated_missing_pack_warning(component_name)
+    def raise_missing_pack_error(component_name)
       msg = <<~MSG
-        **ERROR** ReactOnRails: Generated missing pack for Component: #{component_name}. Please refresh the webpage \
-        once webpack has finished generating the bundles. If the problem persists
+        **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

data/lib/react_on_rails/packs_generator.rb

@@ -6,45 +6,23 @@ module ReactOnRails
   # rubocop:disable Metrics/ClassLength
   class PacksGenerator
     CONTAINS_CLIENT_OR_SERVER_REGEX = /\.(server|client)($|\.)/.freeze
-    MINIMUM_SHAKAPACKER_MAJOR_VERSION = 6
-    MINIMUM_SHAKAPACKER_MINOR_VERSION = 5
-    MINIMUM_SHAKAPACKER_PATCH_VERSION = 1
+    MINIMUM_SHAKAPACKER_VERSION = [6, 5, 1].freeze
 
-    def self.generate
-      packs_generator = PacksGenerator.new
-      packs_generator.verify_setup_and_generate_packs
+    def self.instance
+      @instance ||= PacksGenerator.new
     end
 
-    def self.raise_nested_enteries_disabled
-      packs_generator = PacksGenerator.new
-      packs_generator.raise_nested_enteries_disabled
-    end
-
-    def verify_setup_and_generate_packs
-      return unless components_subdirectory.present?
-
-      raise_webpacker_not_installed unless ReactOnRails::WebpackerUtils.using_webpacker?
-      raise_shakapacker_version_incompatible unless shackapacker_version_requirement_met?
-      raise_nested_enteries_disabled unless ReactOnRails::WebpackerUtils.nested_entries?
+    def generate_packs_if_stale
+      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?
 
-      is_generated_directory_present = Dir.exist?(generated_packs_directory_path)
-
-      return if is_generated_directory_present && webpack_assets_status_checker.stale_generated_component_packs.empty?
+      return if are_generated_files_present_and_up_to_date
 
       clean_generated_packs_directory
       generate_packs
     end
 
-    def raise_nested_enteries_disabled
-      msg = <<~MSG
-        **ERROR** ReactOnRails: `nested_entries` is configured to be disabled in shakapacker. Please update \
-        webpacker.yml to enable nested enteries. for more information read
-        https://www.shakacode.com/react-on-rails/docs/guides/file-system-based-automated-bundle-generation.md#enable-nested_entries-for-shakapacker
-      MSG
-
-      raise ReactOnRails::Error, msg
-    end
-
     private
 
     def generate_packs
@@ -100,22 +78,26 @@ module ReactOnRails
     end
 
     def add_generated_pack_to_server_bundle
-      relative_path_to_generated_server_bundle = relative_path(defined_server_bundle_file_path,
+      relative_path_to_generated_server_bundle = relative_path(server_bundle_entrypoint,
                                                                generated_server_bundle_file_path)
       content = <<~FILE_CONTENT
-        import "./#{relative_path_to_generated_server_bundle}"\n
+        // import statement added by react_on_rails:generate_packs rake task
+        import "./#{relative_path_to_generated_server_bundle}"
       FILE_CONTENT
 
-      prepend_to_file_if_not_present(defined_server_bundle_file_path, content)
+      ReactOnRails::Utils.prepend_to_file_if_text_not_present(
+        file: server_bundle_entrypoint,
+        text_to_prepend: content,
+        regex: %r{import ['"]\./#{relative_path_to_generated_server_bundle}['"]}
+      )
     end
 
     def generated_server_bundle_file_path
-      file_ext = File.extname(defined_server_bundle_file_path)
-      generated_server_bundle_file_path = defined_server_bundle_file_path.sub(file_ext, "-generated#{file_ext}")
+      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_entry_path}/#{generated_server_bundle_file_name}#{file_ext}"
+      "#{source_entry_path}/#{generated_server_bundle_file_name}.js"
     end
 
     def clean_generated_packs_directory
@@ -123,8 +105,9 @@ module ReactOnRails
       FileUtils.mkdir_p(generated_packs_directory_path)
     end
 
-    def defined_server_bundle_file_path
-      ReactOnRails::Utils.server_bundle_js_file_path
+    def server_bundle_entrypoint
+      Rails.root.join(ReactOnRails::WebpackerUtils.webpacker_source_entry_path,
+                      ReactOnRails.configuration.server_bundle_js_file)
     end
 
     def generated_packs_directory_path
@@ -150,7 +133,7 @@ module ReactOnRails
     end
 
     def generated_pack_path(file_path)
-      "#{generated_packs_directory_path}/#{component_name(file_path)}.jsx"
+      "#{generated_packs_directory_path}/#{component_name(file_path)}.js"
     end
 
     def component_name(file_path)
@@ -197,23 +180,7 @@ module ReactOnRails
     def components_search_path
       source_path = ReactOnRails::WebpackerUtils.webpacker_source_path
 
-      "#{source_path}/**/#{components_subdirectory}"
-    end
-
-    def components_subdirectory
-      ReactOnRails.configuration.components_subdirectory
-    end
-
-    def webpack_assets_status_checker
-      source_path = ReactOnRails::Utils.source_path
-      generated_assets_full_path = ReactOnRails::Utils.generated_assets_full_path
-      webpack_generated_files = ReactOnRails.configuration.webpack_generated_files
-
-      @webpack_assets_status_checker ||= ReactOnRails::TestHelper::WebpackAssetsStatusChecker.new(
-        source_path: source_path,
-        generated_assets_full_path: generated_assets_full_path,
-        webpack_generated_files: webpack_generated_files
-      )
+      "#{source_path}/**/#{ReactOnRails.configuration.components_subdirectory}"
     end
 
     def raise_client_component_overrides_common(component_name)
@@ -245,53 +212,15 @@ module ReactOnRails
       raise ReactOnRails::Error, msg
     end
 
-    def raise_shakapacker_version_incompatible
-      msg = <<~MSG
-        **ERROR** ReactOnRails: Please upgrade Shakapacker to version #{minimum_required_shakapacker_version} or \
-        above to use the automated bundle generation feature. The currently installed version is \
-        #{ReactOnRails::WebpackerUtils.shakapacker_version}.
-      MSG
-
-      raise ReactOnRails::Error, msg
-    end
-
-    def raise_webpacker_not_installed
-      msg = <<~MSG
-        **ERROR** ReactOnRails: Missing Shakapacker gem. Please upgrade to use Shakapacker \
-        #{minimum_required_shakapacker_version} or above to use the \
-        automated bundle generation feature.
-      MSG
-
-      raise ReactOnRails::Error, msg
-    end
+    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)
 
-    def shakapacker_major_minor_version
-      shakapacker_version = ReactOnRails::WebpackerUtils.shakapacker_version
-      match = shakapacker_version.match(ReactOnRails::VersionChecker::MAJOR_MINOR_PATCH_VERSION_REGEX)
+      component_files.each_with_object([]).any? do |file|
+        path = generated_pack_path(file)
 
-      [match[1].to_i, match[2].to_i, match[3].to_i]
-    end
-
-    def shackapacker_version_requirement_met?
-      major = shakapacker_major_minor_version[0]
-      minor = shakapacker_major_minor_version[1]
-      patch = shakapacker_major_minor_version[2]
-
-      major >= MINIMUM_SHAKAPACKER_MAJOR_VERSION && minor >= MINIMUM_SHAKAPACKER_MINOR_VERSION &&
-        patch >= MINIMUM_SHAKAPACKER_PATCH_VERSION
-    end
-
-    def minimum_required_shakapacker_version
-      "#{MINIMUM_SHAKAPACKER_MAJOR_VERSION}.#{MINIMUM_SHAKAPACKER_MINOR_VERSION}.#{MINIMUM_SHAKAPACKER_PATCH_VERSION}"
-    end
-
-    def prepend_to_file_if_not_present(file, text_to_prepend)
-      file_content = File.read(file)
-
-      return if file_content.include?(text_to_prepend)
-
-      content_with_prepended_text = text_to_prepend + file_content
-      File.write(file, content_with_prepended_text)
+        !File.exist?(path) || File.mtime(path) < most_recent_mtime
+      end
     end
   end
   # rubocop:enable Metrics/ClassLength

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.generate
+        ReactOnRails::PacksGenerator.instance.generate_packs_if_stale
 
         # 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/webpack_assets_status_checker.rb

@@ -29,17 +29,13 @@ module ReactOnRails
         stale_generated_files(client_files)
       end
 
-      def stale_generated_component_packs
-        stale_generated_files(component_pack_files)
-      end
-
       def stale_generated_files(files)
         manifest_needed = ReactOnRails::WebpackerUtils.using_webpacker? &&
                           !ReactOnRails::WebpackerUtils.manifest_exists?
 
         return ["manifest.json"] if manifest_needed
 
-        most_recent_mtime = find_most_recent_mtime(files)
+        most_recent_mtime = Utils.find_most_recent_mtime(files)
         all_compiled_assets.each_with_object([]) do |webpack_generated_file, stale_gen_list|
           if !File.exist?(webpack_generated_file) ||
              File.mtime(webpack_generated_file) < most_recent_mtime
@@ -51,13 +47,6 @@ module ReactOnRails
 
       private
 
-      def find_most_recent_mtime(files)
-        files.reduce(1.year.ago) do |newest_time, file|
-          mt = File.mtime(file)
-          mt > newest_time ? mt : newest_time
-        end
-      end
-
       def all_compiled_assets
         @all_compiled_assets ||= begin
           webpack_generated_files = @webpack_generated_files.map do |bundle_name|
@@ -89,14 +78,6 @@ module ReactOnRails
         @client_files ||= make_file_list(make_globs(source_path)).to_ary
       end
 
-      def component_pack_files
-        make_file_list(make_globs(components_search_path)).to_ary
-      end
-
-      def components_search_path
-        "#{source_path}/**/#{ReactOnRails.configuration.components_subdirectory}"
-      end
-
       def make_globs(dirs)
         Array(dirs).map { |dir| File.join(dir, "**", "*") }
       end

data/lib/react_on_rails/utils.rb

@@ -197,5 +197,31 @@ module ReactOnRails
       rstrip = to_remove - lstrip
       str[0..(midpoint - lstrip - 1)] + TRUNCATION_FILLER + str[(midpoint + rstrip)..-1]
     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
+      end
+    end
+
+    def self.prepend_to_file_if_text_not_present(file:, text_to_prepend:, regex:)
+      if File.exist?(file)
+        file_content = File.read(file)
+
+        return if file_content.match(regex)
+
+        content_with_prepended_text = text_to_prepend + file_content
+        File.write(file, content_with_prepended_text, mode: "w")
+      else
+        File.write(file, text_to_prepend, mode: "w+")
+      end
+
+      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.2.0"
+  VERSION = "13.3.0"
 end

data/lib/react_on_rails/webpacker_utils.rb

@@ -2,8 +2,6 @@
 
 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?
       return @using_webpacker if defined?(@using_webpacker)
 
@@ -20,7 +18,18 @@ module ReactOnRails
     def self.shakapacker_version
       return nil unless ReactOnRails::Utils.gem_available?("shakapacker")
 
-      Gem.loaded_specs["shakapacker"].version.to_s
+      @shakapacker_version ||= Gem.loaded_specs["shakapacker"].version.to_s
+    end
+
+    def self.shakapacker_version_as_array
+      match = shakapacker_version.match(ReactOnRails::VersionChecker::MAJOR_MINOR_PATCH_VERSION_REGEX)
+
+      @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]
     end
 
     # This returns either a URL for the webpack-dev-server, non-server bundle or
@@ -85,5 +94,47 @@ module ReactOnRails
       puts wrap_message(msg)
       exit!
     end
+
+    def self.webpack_assets_status_checker
+      source_path = ReactOnRails::Utils.source_path
+      generated_assets_full_path = ReactOnRails::Utils.generated_assets_full_path
+      webpack_generated_files = ReactOnRails.configuration.webpack_generated_files
+
+      @webpack_assets_status_checker ||= ReactOnRails::TestHelper::WebpackAssetsStatusChecker.new(
+        source_path: source_path,
+        generated_assets_full_path: generated_assets_full_path,
+        webpack_generated_files: webpack_generated_files
+      )
+    end
+
+    def self.raise_nested_entries_disabled
+      msg = <<~MSG
+        **ERROR** ReactOnRails: `nested_entries` is configured to be disabled in shakapacker. Please update \
+        webpacker.yml to enable nested entries. for more information read
+        https://www.shakacode.com/react-on-rails/docs/guides/file-system-based-automated-bundle-generation.md#enable-nested_entries-for-shakapacker
+      MSG
+
+      raise ReactOnRails::Error, msg
+    end
+
+    def self.raise_shakapacker_version_incompatible_for_autobundling
+      msg = <<~MSG
+        **ERROR** ReactOnRails: Please upgrade Shakapacker to version #{ReactOnRails::WebpackerUtils.semver_to_string(ReactOnRails::PacksGenerator::MINIMUM_SHAKAPACKER_VERSION)} or \
+        above to use the automated bundle generation feature. The currently installed version is \
+        #{ReactOnRails::WebpackerUtils.semver_to_string(ReactOnRails::WebpackerUtils.shakapacker_version_as_array)}.
+      MSG
+
+      raise ReactOnRails::Error, msg
+    end
+
+    def self.raise_shakapacker_not_installed
+      msg = <<~MSG
+        **ERROR** ReactOnRails: Missing Shakapacker gem. Please upgrade to use Shakapacker \
+        #{ReactOnRails::WebpackerUtils.semver_to_string(minimum_required_shakapacker_version)} or above to use the \
+        automated bundle generation feature.
+      MSG
+
+      raise ReactOnRails::Error, msg
+    end
   end
 end

data/lib/tasks/generate_packs.rake

@@ -6,6 +6,6 @@ namespace :react_on_rails do
   DESC
 
   task generate_packs: :environment do
-    ReactOnRails::PacksGenerator.generate
+    ReactOnRails::PacksGenerator.instance.generate_packs_if_stale
   end
 end