react_on_rails 13.0.2 → 13.1.0

data/lib/react_on_rails/packs_generator.rb

@@ -0,0 +1,298 @@
+# frozen_string_literal: true
+
+require "fileutils"
+
+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
+
+    def self.generate
+      packs_generator = PacksGenerator.new
+      packs_generator.verify_setup_and_generate_packs
+    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?
+
+      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?
+
+      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
+      common_component_to_path.each_value { |component_path| create_pack(component_path) }
+      client_component_to_path.each_value { |component_path| create_pack(component_path) }
+
+      create_server_pack if ReactOnRails.configuration.server_bundle_js_file.present?
+    end
+
+    def create_pack(file_path)
+      output_path = generated_pack_path(file_path)
+      content = pack_file_contents(file_path)
+
+      File.write(output_path, content)
+
+      puts(Rainbow("Generated Packs: #{output_path}").yellow)
+    end
+
+    def pack_file_contents(file_path)
+      registered_component_name = component_name(file_path)
+      <<~FILE_CONTENT
+        import ReactOnRails from 'react-on-rails';
+        import #{registered_component_name} from '#{relative_component_path_from_generated_pack(file_path)}';
+
+        ReactOnRails.register({#{registered_component_name}});
+      FILE_CONTENT
+    end
+
+    def create_server_pack
+      File.write(generated_server_bundle_file_path, generated_server_pack_file_content)
+
+      add_generated_pack_to_server_bundle
+      puts(Rainbow("Generated Server Bundle: #{generated_server_bundle_file_path}").orange)
+    end
+
+    def generated_server_pack_file_content
+      common_components_for_server_bundle = common_component_to_path.delete_if { |k| server_component_to_path.key?(k) }
+      component_for_server_registration_to_path = common_components_for_server_bundle.merge(server_component_to_path)
+
+      server_component_imports = component_for_server_registration_to_path.map do |name, component_path|
+        "import #{name} from '#{relative_path(generated_server_bundle_file_path, component_path)}';"
+      end
+
+      components_to_register = component_for_server_registration_to_path.keys
+
+      <<~FILE_CONTENT
+        import ReactOnRails from 'react-on-rails';
+
+        #{server_component_imports.join("\n")}
+
+        ReactOnRails.register({#{components_to_register.join(",\n")}});
+      FILE_CONTENT
+    end
+
+    def add_generated_pack_to_server_bundle
+      relative_path_to_generated_server_bundle = relative_path(defined_server_bundle_file_path,
+                                                               generated_server_bundle_file_path)
+      content = <<~FILE_CONTENT
+        import "./#{relative_path_to_generated_server_bundle}"\n
+      FILE_CONTENT
+
+      prepend_to_file_if_not_present(defined_server_bundle_file_path, content)
+    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_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}"
+    end
+
+    def clean_generated_packs_directory
+      FileUtils.rm_rf(generated_packs_directory_path)
+      FileUtils.mkdir_p(generated_packs_directory_path)
+    end
+
+    def defined_server_bundle_file_path
+      ReactOnRails::Utils.server_bundle_js_file_path
+    end
+
+    def generated_packs_directory_path
+      source_entry_path = ReactOnRails::WebpackerUtils.webpacker_source_entry_path
+
+      "#{source_entry_path}/generated"
+    end
+
+    def relative_component_path_from_generated_pack(ror_component_path)
+      component_file_pathname = Pathname.new(ror_component_path)
+      component_generated_pack_path = generated_pack_path(ror_component_path)
+      generated_pack_pathname = Pathname.new(component_generated_pack_path)
+
+      relative_path(generated_pack_pathname, component_file_pathname)
+    end
+
+    def relative_path(from, to)
+      from_path = Pathname.new(from)
+      to_path = Pathname.new(to)
+
+      relative_path = to_path.relative_path_from(from_path)
+      relative_path.sub("../", "")
+    end
+
+    def generated_pack_path(file_path)
+      "#{generated_packs_directory_path}/#{component_name(file_path)}.jsx"
+    end
+
+    def component_name(file_path)
+      basename = File.basename(file_path, File.extname(file_path))
+
+      basename.sub(CONTAINS_CLIENT_OR_SERVER_REGEX, "")
+    end
+
+    def component_name_to_path(paths)
+      paths.to_h { |path| [component_name(path), path] }
+    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
+      component_name_to_path(common_components_paths)
+    end
+
+    def client_component_to_path
+      client_render_components_paths = Dir.glob("#{components_search_path}/*.client.*")
+      client_specific_components = component_name_to_path(client_render_components_paths)
+
+      duplicate_components = common_component_to_path.slice(*client_specific_components.keys)
+      duplicate_components.each_key { |component| raise_client_component_overrides_common(component) }
+
+      client_specific_components
+    end
+
+    def server_component_to_path
+      server_render_components_paths = Dir.glob("#{components_search_path}/*.server.*")
+      server_specific_components = component_name_to_path(server_render_components_paths)
+
+      duplicate_components = common_component_to_path.slice(*server_specific_components.keys)
+      duplicate_components.each_key { |component| raise_server_component_overrides_common(component) }
+
+      server_specific_components.each_key do |k|
+        raise_missing_client_component(k) unless client_component_to_path.key?(k)
+      end
+
+      server_specific_components
+    end
+
+    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
+      )
+    end
+
+    def raise_client_component_overrides_common(component_name)
+      msg = <<~MSG
+        **ERROR** ReactOnRails: client specific definition for Component '#{component_name}' overrides the \
+        common definition. Please delete the common definition and have separate server and client files. 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
+
+    def raise_server_component_overrides_common(component_name)
+      msg = <<~MSG
+        **ERROR** ReactOnRails: server specific definition for Component '#{component_name}' overrides the \
+        common definition. Please delete the common definition and have separate server and client files. 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
+
+    def raise_missing_client_component(component_name)
+      msg = <<~MSG
+        **ERROR** ReactOnRails: Component '#{component_name}' is missing a client specific file. 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
+
+    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 shakapacker_major_minor_version
+      shakapacker_version = ReactOnRails::WebpackerUtils.shakapacker_version
+      match = shakapacker_version.match(ReactOnRails::VersionChecker::MAJOR_MINOR_PATCH_VERSION_REGEX)
+
+      [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)
+    end
+  end
+  # rubocop:enable Metrics/ClassLength
+end

data/lib/react_on_rails/react_component/render_options.rb

@@ -71,6 +71,10 @@ module ReactOnRails
         retrieve_configuration_value_for(:prerender)
       end
 
+      def auto_load_bundle
+        retrieve_configuration_value_for(:auto_load_bundle)
+      end
+
       def trace
         retrieve_configuration_value_for(:trace)
       end

data/lib/react_on_rails/server_rendering_pool/ruby_embedded_java_script.rb

@@ -165,12 +165,6 @@ module ReactOnRails
         end
 
         def execjs_timer_polyfills
-          if ReactOnRails::Utils.react_on_rails_pro? &&
-             ReactOnRailsPro.configuration.respond_to?(:include_execjs_polyfills) &&
-             ReactOnRailsPro.configuration.include_execjs_polyfills == false
-            return ""
-          end
-
           <<~JS
             function getStackTrace () {
               var stack;

data/lib/react_on_rails/test_helper/ensure_assets_compiled.rb

@@ -37,6 +37,8 @@ module ReactOnRails
         # All done if no stale files!
         return if stale_gen_files.empty?
 
+        ReactOnRails::PacksGenerator.generate
+
         # 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

@@ -26,12 +26,20 @@ module ReactOnRails
       end
 
       def stale_generated_webpack_files
+        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
+        most_recent_mtime = 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
@@ -43,8 +51,8 @@ module ReactOnRails
 
       private
 
-      def find_most_recent_mtime
-        client_files.reduce(1.year.ago) do |newest_time, file|
+      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
@@ -81,6 +89,14 @@ 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/version.rb

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

data/lib/react_on_rails/webpacker_utils.rb

@@ -17,6 +17,12 @@ module ReactOnRails
       Webpacker.dev_server.running?
     end
 
+    def self.shakapacker_version
+      return nil unless ReactOnRails::Utils.gem_available?("shakapacker")
+
+      Gem.loaded_specs["shakapacker"].version.to_s
+    end
+
     # This returns either a URL for the webpack-dev-server, non-server bundle or
     # the hashed server bundle if using the same bundle for the client.
     # Otherwise returns a file path.
@@ -45,6 +51,14 @@ module ReactOnRails
       Webpacker.config.source_path
     end
 
+    def self.webpacker_source_entry_path
+      Webpacker.config.source_entry_path
+    end
+
+    def self.nested_entries?
+      Webpacker.config.nested_entries?
+    end
+
     def self.webpacker_public_output_path
       # Webpacker has the full absolute path of webpacker output files in a Pathname
       Webpacker.config.public_output_path.to_s

data/lib/react_on_rails.rb

@@ -19,6 +19,7 @@ require "react_on_rails/test_helper"
 require "react_on_rails/git_utils"
 require "react_on_rails/utils"
 require "react_on_rails/webpacker_utils"
+require "react_on_rails/packs_generator"
 require "react_on_rails/test_helper/webpack_assets_compiler"
 require "react_on_rails/test_helper/webpack_assets_status_checker"
 require "react_on_rails/test_helper/ensure_assets_compiled"

data/lib/tasks/generate_packs.rake

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+namespace :react_on_rails do
+  desc <<~DESC
+    If there is a file inside any directory matching config.components_subdirectory, this command generates corresponding packs.
+  DESC
+
+  task generate_packs: :environment do
+    ReactOnRails::PacksGenerator.generate
+  end
+end

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-on-rails",
-  "version": "13.0.2",
+  "version": "13.1.0",
   "description": "react-on-rails JavaScript for react_on_rails Ruby gem",
   "main": "node_package/lib/ReactOnRails.js",
   "directories": {
@@ -15,10 +15,10 @@
     "@babel/preset-react": "^7.12.10",
     "@babel/types": "^7.12.10",
     "@types/jest": "^26.0.18",
-    "@types/node": "^14.14.11",
     "@types/react": "^16.9.23",
     "@types/react-dom": "^16.9.5",
     "@types/turbolinks": "^5.2.0",
+    "@types/webpack-env": "^1.17.0",
     "@typescript-eslint/eslint-plugin": "^4.10.0",
     "@typescript-eslint/parser": "^4.10.0",
     "babelify": "^10.0.0",

data/yarn.lock

@@ -1594,11 +1594,6 @@
   resolved "https://registry.yarnpkg.com/@types/node/-/node-14.14.35.tgz#42c953a4e2b18ab931f72477e7012172f4ffa313"
   integrity sha512-Lt+wj8NVPx0zUmUwumiVXapmaLUcAk3yPuHCFVXras9k5VT9TdhJqKqGVUQCD60OTMCl0qxJ57OiTL0Mic3Iag==
 
-"@types/node@^14.14.11":
-  version "14.14.11"
-  resolved "https://registry.yarnpkg.com/@types/node/-/node-14.14.11.tgz#fc25a4248a5e8d0837019b1d170146d07334abe0"
-  integrity sha512-BJ97wAUuU3NUiUCp44xzUFquQEvnk1wu7q4CMEUYKJWjdkr0YWYDsm4RFtAvxYsNjLsKcrFt6RvK8r+mnzMbEQ==
-
 "@types/normalize-package-data@^2.4.0":
   version "2.4.0"
   resolved "https://registry.yarnpkg.com/@types/normalize-package-data/-/normalize-package-data-2.4.0.tgz#e486d0d97396d79beedd0a6e33f4534ff6b4973e"
@@ -1639,6 +1634,11 @@
   resolved "https://registry.yarnpkg.com/@types/turbolinks/-/turbolinks-5.2.0.tgz#cdfd3691143ea2f452113c2a06bd12d9a88b25d6"
   integrity sha512-xEgHb25lj23EaUlsU3Y4KlFH7elhlYINGSnqyn/8zmcMnenY4Idyjk/x9kw1kOoOToY3de9fD8NSwRzNc6f5nw==
 
+"@types/webpack-env@^1.17.0":
+  version "1.17.0"
+  resolved "https://registry.yarnpkg.com/@types/webpack-env/-/webpack-env-1.17.0.tgz#f99ce359f1bfd87da90cc4a57cab0a18f34a48d0"
+  integrity sha512-eHSaNYEyxRA5IAG0Ym/yCyf86niZUIF/TpWKofQI/CVfh5HsMEUyfE2kwFxha4ow0s5g0LfISQxpDKjbRDrizw==
+
 "@types/yargs-parser@*":
   version "20.2.0"
   resolved "https://registry.yarnpkg.com/@types/yargs-parser/-/yargs-parser-20.2.0.tgz#dd3e6699ba3237f0348cd085e4698780204842f9"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: react_on_rails
 version: !ruby/object:Gem::Version
-  version: 13.0.2
+  version: 13.1.0
 platform: ruby
 authors:
 - Justin Gordon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-10 00:00:00.000000000 Z
+date: 2022-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -168,10 +168,11 @@ files:
 - docs/contributor-info/releasing.md
 - docs/deployment/elastic-beanstalk.md
 - docs/deployment/heroku-deployment.md
+- docs/getting-started.md
 - docs/guides/client-vs-server-rendering.md
 - docs/guides/configuration.md
 - docs/guides/deployment.md
-- docs/guides/getting-started.md
+- docs/guides/file-system-based-automated-bundle-generation.md
 - docs/guides/hmr-and-hot-reloading-with-the-webpack-dev-server.md
 - docs/guides/how-react-on-rails-works.md
 - docs/guides/how-to-conditionally-server-render-based-on-device-type.md
@@ -277,6 +278,7 @@ files:
 - lib/react_on_rails/locales/base.rb
 - lib/react_on_rails/locales/to_js.rb
 - lib/react_on_rails/locales/to_json.rb
+- lib/react_on_rails/packs_generator.rb
 - lib/react_on_rails/prerender_error.rb
 - lib/react_on_rails/react_component/render_options.rb
 - lib/react_on_rails/server_rendering_js_code.rb
@@ -292,6 +294,7 @@ files:
 - lib/react_on_rails/version_syntax_converter.rb
 - lib/react_on_rails/webpacker_utils.rb
 - lib/tasks/assets.rake
+- lib/tasks/generate_packs.rake
 - lib/tasks/locale.rake
 - package-scripts.yml
 - package.json