shakapacker 9.3.0.beta.2 → 9.3.0.beta.5

data/lib/shakapacker/build_config_loader.rb

@@ -0,0 +1,147 @@
+require "yaml"
+
+module Shakapacker
+  class BuildConfigLoader
+    attr_reader :config_file_path
+
+    def initialize(config_file_path = nil)
+      @config_file_path = config_file_path || File.join(Dir.pwd, "config", "shakapacker-builds.yml")
+    end
+
+    def exists?
+      File.exist?(@config_file_path)
+    end
+
+    def load_build(build_name)
+      unless exists?
+        raise ArgumentError, "Config file not found: #{@config_file_path}\n" \
+                            "Run 'bin/shakapacker --init' to generate a sample config file."
+      end
+
+      config = load_config
+      fetch_build_or_raise(config, build_name)
+    end
+
+    def resolve_build_config(build_name, default_bundler: "webpack")
+      config = load_config
+      build = fetch_build_or_raise(config, build_name)
+
+      # Resolve bundler with precedence: build.bundler > config.default_bundler > default_bundler
+      bundler = build["bundler"] || config["default_bundler"] || default_bundler
+
+      # Get environment variables
+      environment = build["environment"] || {}
+
+      # Get config file path if specified
+      config_file = build["config"]
+      if config_file
+        # Expand ${BUNDLER} variable
+        config_file = config_file.gsub("${BUNDLER}", bundler)
+      end
+
+      # Get bundler_env for --env flags
+      bundler_env = build["bundler_env"] || {}
+
+      # Get outputs
+      outputs = build["outputs"] || []
+
+      # Validate outputs
+      if outputs.empty?
+        raise ArgumentError, "Build '#{build_name}' has empty outputs array. " \
+                            "Please specify at least one output type (client, server, or all)."
+      end
+
+      {
+        name: build_name,
+        description: build["description"],
+        bundler: bundler,
+        dev_server: build["dev_server"],
+        environment: environment,
+        bundler_env: bundler_env,
+        outputs: outputs,
+        config_file: config_file
+      }
+    end
+
+    def uses_dev_server?(build_config)
+      # Check explicit dev_server flag first (preferred)
+      # Only return early if the value is explicitly set (not nil)
+      return build_config[:dev_server] unless build_config[:dev_server].nil?
+
+      # Fallback: check environment variables for backward compatibility
+      env = build_config[:environment]
+      return false unless env
+
+      # Handle both string "true" and boolean true from YAML
+      %w[WEBPACK_SERVE HMR].any? do |key|
+        value = env[key]
+        value.to_s.strip.casecmp("true").zero?
+      end
+    end
+
+    def list_builds
+      config = load_config
+      builds = config["builds"]
+
+      puts "\nAvailable builds in #{@config_file_path}:\n\n"
+
+      builds.each do |name, build|
+        bundler = build["bundler"] || config["default_bundler"] || "webpack (default)"
+        outputs = build["outputs"] ? build["outputs"].join(", ") : "missing (invalid)"
+
+        puts "  #{name}"
+        puts "    Description: #{build["description"]}" if build["description"]
+        puts "    Bundler: #{bundler}"
+        puts "    Outputs: #{outputs}"
+        puts ""
+      end
+    end
+
+    private
+
+      def fetch_build_or_raise(config, build_name)
+        build = config["builds"][build_name]
+        unless build
+          available = config["builds"].keys.join(", ")
+          raise ArgumentError, "Build '#{build_name}' not found in config file.\n" \
+                              "Available builds: #{available}\n" \
+                              "Use 'bin/shakapacker --list-builds' to see all available builds."
+        end
+        build
+      end
+
+      # Load YAML config file safely with Ruby version compatibility
+      # Ruby 3.1+ supports safe_load_file with aliases, older versions need safe_load
+      def load_config
+        begin
+          config = if YAML.respond_to?(:safe_load_file)
+            # Ruby 3.1+: Use safe_load_file with aliases enabled
+            YAML.safe_load_file(@config_file_path, aliases: true)
+          else
+            # Ruby 2.7-3.0: Use safe_load with aliases enabled
+            YAML.safe_load(
+              File.read(@config_file_path),
+              permitted_classes: [],
+              permitted_symbols: [],
+              aliases: true
+            )
+          end
+        rescue ArgumentError
+          # Fallback for older Psych versions without aliases support
+          config = YAML.safe_load(
+            File.read(@config_file_path),
+            permitted_classes: [],
+            permitted_symbols: []
+          )
+        end
+
+        unless config["builds"]&.is_a?(Hash)
+          raise ArgumentError, "Config file must contain a 'builds' object"
+        end
+
+        config
+      rescue Psych::SyntaxError => e
+        raise ArgumentError, "Invalid YAML in config file: #{e.message}"
+      end
+  end
+end

data/lib/shakapacker/configuration.rb

@@ -8,12 +8,13 @@ class Shakapacker::Configuration
     attr_accessor :installing
   end
 
-  attr_reader :root_path, :config_path, :env
+  attr_reader :root_path, :config_path, :env, :bundler_override
 
-  def initialize(root_path:, config_path:, env:)
+  def initialize(root_path:, config_path:, env:, bundler_override: nil)
     @root_path = root_path
     @env = env
     @config_path = config_path
+    @bundler_override = bundler_override
   end
 
   def dev_server
@@ -97,6 +98,9 @@ class Shakapacker::Configuration
   end
 
   def assets_bundler
+    # CLI --bundler flag takes highest precedence
+    return @bundler_override if @bundler_override
+
     # Show deprecation warning if using old 'bundler' key
     if data.has_key?(:bundler) && !data.has_key?(:assets_bundler)
       $stderr.puts "⚠️  DEPRECATION WARNING: The 'bundler' configuration option is deprecated. Please use 'assets_bundler' instead to avoid confusion with Ruby's Bundler gem manager."
@@ -231,6 +235,10 @@ class Shakapacker::Configuration
     fetch(:integrity)
   end
 
+  def early_hints
+    fetch(:early_hints)
+  end
+
   private
     def validate_output_paths!
       # Skip validation if already validated to avoid redundant checks

data/lib/shakapacker/dev_server_runner.rb

@@ -18,9 +18,71 @@ module Shakapacker
         exit(0)
       end
 
+      # Check for --build flag
+      build_index = argv.index("--build")
+      if build_index
+        build_name = argv[build_index + 1]
+
+        unless build_name
+          $stderr.puts "[Shakapacker] Error: --build requires a build name"
+          $stderr.puts "Usage: bin/shakapacker-dev-server --build <name>"
+          exit(1)
+        end
+
+        loader = BuildConfigLoader.new
+
+        unless loader.exists?
+          $stderr.puts "[Shakapacker] Config file not found: #{loader.config_file_path}"
+          $stderr.puts "Run 'bin/shakapacker --init' to create one"
+          exit(1)
+        end
+
+        begin
+          build_config = loader.resolve_build_config(build_name)
+
+          # Check if this build is meant for dev server
+          unless loader.uses_dev_server?(build_config)
+            $stderr.puts "[Shakapacker] Error: Build '#{build_name}' is not configured for dev server (dev_server: false)"
+            $stderr.puts "[Shakapacker] Use this command instead:"
+            $stderr.puts "  bin/shakapacker --build #{build_name}"
+            exit(1)
+          end
+
+          # Remove --build and build name from argv
+          remaining_argv = argv.dup
+          remaining_argv.delete_at(build_index + 1)
+          remaining_argv.delete_at(build_index)
+
+          run_with_build_config(remaining_argv, build_config)
+          return
+        rescue ArgumentError => e
+          $stderr.puts "[Shakapacker] #{e.message}"
+          exit(1)
+        end
+      end
+
       new(argv).run
     end
 
+    def self.run_with_build_config(argv, build_config)
+      # Apply build config environment variables
+      build_config[:environment].each do |key, value|
+        ENV[key] = value.to_s
+      end
+
+      # Set SHAKAPACKER_ASSETS_BUNDLER so JS/TS config files use the correct bundler
+      # This ensures the bundler override (from --bundler or build config) is respected
+      ENV["SHAKAPACKER_ASSETS_BUNDLER"] = build_config[:bundler]
+
+      puts "[Shakapacker] Running dev server for build: #{build_config[:name]}"
+      puts "[Shakapacker] Description: #{build_config[:description]}" if build_config[:description]
+      puts "[Shakapacker] Bundler: #{build_config[:bundler]}"
+      puts "[Shakapacker] Config file: #{build_config[:config_file]}" if build_config[:config_file]
+
+      # Pass bundler override so Configuration.assets_bundler reflects the build
+      new(argv, build_config, build_config[:bundler]).run
+    end
+
     def self.print_help
       puts <<~HELP
         ================================================================================
@@ -33,6 +95,17 @@ module Shakapacker
           -h, --help              Show this help message
           -v, --version           Show Shakapacker version
           --debug-shakapacker     Enable Node.js debugging (--inspect-brk)
+          --build <name>          Run a specific build configuration
+
+        Build configurations (config/shakapacker-builds.yml):
+          bin/shakapacker-dev-server --build dev-hmr    # Run the 'dev-hmr' build
+
+          To manage builds:
+          bin/shakapacker --init                        # Create config file
+          bin/shakapacker --list-builds                 # List available builds
+
+          Note: You can also use bin/shakapacker --build with a build that has
+          WEBPACK_SERVE=true, and it will automatically use the dev server.
 
         Examples:
           bin/shakapacker-dev-server                    # Start dev server