Update the codebase based on Shakapacker

Author: ahangarha

Appraisals

@@ -16,7 +16,7 @@ end
 
 appraise 'shakapacker' do
   gem 'rails', '~> 7.0.x'
-  gem 'shakapacker', '6.6.0'
+  gem 'shakapacker', '7.0.2'
 end
 
 appraise 'base' do

lib/generators/react/component_generator.rb

@@ -6,7 +6,7 @@ class ComponentGenerator < ::Rails::Generators::NamedBase
       source_root File.expand_path "../templates", __dir__
       desc <<-DESC.strip_heredoc
       Description:
-          Scaffold a React component into `components/` of your Webpacker source or asset pipeline.
+          Scaffold a React component into `components/` of your Shakapacker source or asset pipeline.
           The generated component will include a basic render function and a PropTypes
           hash to help with development.
 
@@ -125,8 +125,8 @@ class ComponentGenerator < ::Rails::Generators::NamedBase
 
       def create_component_file
         template_extension = detect_template_extension
-        # Prefer webpacker to sprockets:
-        if webpacker?
+        # Prefer Shakapacker to Sprockets:
+        if shakapacker?
           new_file_name = file_name.camelize
           extension = if options[:coffee]
                         "coffee"
@@ -152,33 +152,36 @@ def create_component_file
       private
 
       def webpack_configuration
-        Webpacker.respond_to?(:config) ? Webpacker.config : Webpacker::Configuration
+        Shakapacker.respond_to?(:config) ? Shakapacker.config : Shakapacker::Configuration
       end
 
       def component_name
         file_name.camelize
       end
 
       def file_header
-        if webpacker?
+        if shakapacker?
           return %(import * as React from "react"\n) if options[:ts]
 
-          %(import React from "react"\nimport PropTypes from "prop-types"\n)
+          <<~JS
+            import React from "react"
+            import PropTypes from "prop-types"
+          JS
         else
           ""
         end
       end
 
       def file_footer
-        if webpacker?
+        if shakapacker?
           %(export default #{component_name})
         else
           ""
         end
       end
 
-      def webpacker?
-        defined?(Webpacker)
+      def shakapacker?
+        defined?(Shakapacker)
       end
 
       def parse_attributes!

lib/generators/react/install_generator.rb

@@ -20,32 +20,32 @@ class InstallGenerator < ::Rails::Generators::Base
 
       # Make an empty `components/` directory in the right place:
       def create_directory
-        components_dir = if webpacker?
-                           Pathname.new(javascript_dir).parent.to_s
-                         else
-                           javascript_dir
-                         end
-        empty_directory File.join(components_dir, "components")
-        return if options[:skip_git]
-
-        create_file File.join(components_dir, "components/.keep")
+        components_dir = if shakapacker?
+          Pathname.new(javascript_dir).parent.to_s
+        else
+          javascript_dir
+        end
+        empty_directory File.join(components_dir, 'components')
+        unless options[:skip_git]
+          create_file File.join(components_dir, 'components/.keep')
+        end
       end
 
       # Add requires, setup UJS
       def setup_react
-        if webpacker?
-          setup_react_webpacker
+        if shakapacker?
+          setup_react_shakapacker
         else
           setup_react_sprockets
         end
       end
 
       def create_server_rendering
         if options[:skip_server_rendering]
-          nil
-        elsif webpacker?
-          ssr_manifest_path = File.join(javascript_dir, "server_rendering.js")
-          template("server_rendering_pack.js", ssr_manifest_path)
+          return
+        elsif shakapacker?
+          ssr_manifest_path = File.join(javascript_dir, 'server_rendering.js')
+          template('server_rendering_pack.js', ssr_manifest_path)
         else
           ssr_manifest_path = File.join(javascript_dir, "server_rendering.js")
           template("server_rendering.js", ssr_manifest_path)
@@ -56,13 +56,13 @@ def create_server_rendering
 
       private
 
-      def webpacker?
-        !!defined?(Webpacker)
+      def shakapacker?
+        !!defined?(Shakapacker)
       end
 
       def javascript_dir
-        if webpacker?
-          webpack_source_path
+        if shakapacker?
+          shakapacker_source_path
             .relative_path_from(::Rails.root)
             .to_s
         else
@@ -96,33 +96,26 @@ def setup_react_sprockets
         create_file components_file, components_js
       end
 
-      WEBPACKER_SETUP_UJS = <<~JS
+      SHAKAPACKER_SETUP_UJS = <<~JS
         // Support component names relative to this directory:
         var componentRequireContext = require.context("components", true);
         var ReactRailsUJS = require("react_ujs");
         ReactRailsUJS.useContext(componentRequireContext);
       JS
 
-      def setup_react_webpacker
+      def setup_react_shakapacker
         `yarn add react_ujs`
         if manifest.exist?
-          append_file(manifest, WEBPACKER_SETUP_UJS)
+          append_file(manifest, SHAKAPACKER_SETUP_UJS)
         else
-          create_file(manifest, WEBPACKER_SETUP_UJS)
+          create_file(manifest, SHAKAPACKER_SETUP_UJS)
         end
       end
 
-      def webpack_source_path
-        if Webpacker.respond_to?(:config)
-          Webpacker.config.source_entry_path # Webpacker >3
-        else
-          Webpacker::Configuration.source_path.join(Webpacker::Configuration.entry_path) # Webpacker <3
-        end
-      end
+      private
 
-      def reloaded_webpacker_config
-        Webpacker.instance.instance_variable_set(:@config, nil)
-        Webpacker.config
+      def shakapacker_source_path
+        Shakapacker.config.source_entry_path
       end
     end
   end

lib/react/server_rendering/bundle_renderer.rb

@@ -8,7 +8,7 @@
 module React
   module ServerRendering
     # Extends ExecJSRenderer for the Rails environment
-    # - fetches JS code from the Rails app (webpacker or sprockets)
+    # - fetches JS code from the Rails app (Shakapacker or Sprockets)
     # - stringifies props
     # - implements console replay
     class BundleRenderer < ExecJSRenderer

lib/react/server_rendering/separate_server_bundle_container.rb

@@ -4,14 +4,14 @@
 
 module React
   module ServerRendering
-    # Get a compiled file from Webpacker's output path
+    # Get a compiled file from Shakapacker's output path
     class SeparateServerBundleContainer
       def self.compatible?
-        !!defined?(Webpacker)
+        !!defined?(Shakapacker)
       end
 
       def find_asset(filename)
-        asset_path = Webpacker.config.public_output_path.join(filename).to_s
+        asset_path = Shakapacker.config.public_output_path.join(filename).to_s
         File.read(asset_path)
       end
     end