From f170fc781936566dc0b4dc1b56f6a855e0a15008 Mon Sep 17 00:00:00 2001
From: Douglas Eichelberger <d@eic.email>
Date: Mon, 8 Sep 2025 09:03:05 -0700
Subject: [PATCH] Unify Cask::Config data structure

---
 Library/Homebrew/cask/config.rb    | 41 ++++++++++++------------------
 Library/Homebrew/formulary.rb      |  3 ++-
 Library/Homebrew/system_command.rb |  2 +-
 3 files changed, 19 insertions(+), 27 deletions(-)

diff --git a/Library/Homebrew/cask/config.rb b/Library/Homebrew/cask/config.rb
index be95cb6b9a..fbf5a426d1 100644
--- a/Library/Homebrew/cask/config.rb
+++ b/Library/Homebrew/cask/config.rb
@@ -12,7 +12,7 @@ module Cask
   #
   # @api internal
   class Config
-    ConfigValue = T.type_alias { T.any(LazyObject, String, Pathname, T::Array[String]) }
+    ConfigHash = T.type_alias { T::Hash[Symbol, T.any(LazyObject, String, Pathname, T::Array[String])] }
     DEFAULT_DIRS = T.let(
       {
         appdir:               "/Applications",
@@ -79,24 +79,15 @@ module Cask
       )
     end
 
-    sig {
-      params(
-        config: T.any(
-          T::Hash[Symbol, T.any(LazyObject, String)],
-          T::Enumerable[[T.any(String, Symbol), ConfigValue]],
-        ),
-      ).returns(T::Hash[Symbol, ConfigValue])
-    }
+    sig { params(config: ConfigHash).returns(ConfigHash) }
     def self.canonicalize(config)
       config.to_h do |k, v|
-        key = k.to_sym
-
-        if DEFAULT_DIRS.key?(key)
+        if DEFAULT_DIRS.key?(k)
           raise TypeError, "Invalid path for default dir #{k}: #{v.inspect}" if v.is_a?(Array)
 
-          [key, Pathname(v.to_s).expand_path]
+          [k, Pathname(v.to_s).expand_path]
         else
-          [key, v]
+          [k, v]
         end
       end
     end
@@ -104,14 +95,14 @@ module Cask
     # Get the explicit configuration.
     #
     # @api internal
-    sig { returns(T::Hash[Symbol, ConfigValue]) }
+    sig { returns(ConfigHash) }
     attr_accessor :explicit
 
     sig {
       params(
-        default:             T.nilable(T::Hash[Symbol, ConfigValue]),
-        env:                 T.nilable(T::Hash[Symbol, ConfigValue]),
-        explicit:            T::Hash[Symbol, ConfigValue],
+        default:             T.nilable(ConfigHash),
+        env:                 T.nilable(ConfigHash),
+        explicit:            ConfigHash,
         ignore_invalid_keys: T::Boolean,
       ).void
     }
@@ -119,18 +110,18 @@ module Cask
       if default
         @default = T.let(
           self.class.canonicalize(self.class.defaults.merge(default)),
-          T.nilable(T::Hash[Symbol, ConfigValue]),
+          T.nilable(ConfigHash),
         )
       end
       if env
         @env = T.let(
           self.class.canonicalize(env),
-          T.nilable(T::Hash[Symbol, ConfigValue]),
+          T.nilable(ConfigHash),
         )
       end
       @explicit = T.let(
         self.class.canonicalize(explicit),
-        T::Hash[Symbol, ConfigValue],
+        ConfigHash,
       )
 
       if ignore_invalid_keys
@@ -143,18 +134,18 @@ module Cask
       @explicit.assert_valid_keys(*self.class.defaults.keys)
     end
 
-    sig { returns(T::Hash[Symbol, ConfigValue]) }
+    sig { returns(ConfigHash) }
     def default
       @default ||= self.class.canonicalize(self.class.defaults)
     end
 
-    sig { returns(T::Hash[Symbol, ConfigValue]) }
+    sig { returns(ConfigHash) }
     def env
       @env ||= self.class.canonicalize(
         Homebrew::EnvConfig.cask_opts
           .select { |arg| arg.include?("=") }
           .map { |arg| T.cast(arg.split("=", 2), [String, String]) }
-          .map do |(flag, value)|
+          .to_h do |(flag, value)|
             key = flag.sub(/^--/, "")
             # converts --language flag to :languages config key
             if key == "language"
@@ -162,7 +153,7 @@ module Cask
               value = value.split(",")
             end
 
-            [key, value]
+            [key.to_sym, value]
           end,
       )
     end
diff --git a/Library/Homebrew/formulary.rb b/Library/Homebrew/formulary.rb
index e9c1472ba2..250562b356 100644
--- a/Library/Homebrew/formulary.rb
+++ b/Library/Homebrew/formulary.rb
@@ -50,7 +50,8 @@ module Formulary
   end
   private_class_method :platform_cache_tag
 
-  # The untyped nested hash values are a mix of Formula instances and Formula classes.
+  # The untyped nested hash values are a mix of Formula instances and Formula classes,
+  # but using a union type will require a updating call sites with type guards.
   sig { returns(T::Hash[Symbol, T::Hash[String, T.untyped]]) }
   def self.platform_cache
     cache[platform_cache_tag] ||= {}
diff --git a/Library/Homebrew/system_command.rb b/Library/Homebrew/system_command.rb
index 1426ffe837..d465f0abde 100644
--- a/Library/Homebrew/system_command.rb
+++ b/Library/Homebrew/system_command.rb
@@ -235,7 +235,7 @@ class SystemCommand
   sig { returns(T.any(NilClass, String, Pathname)) }
   attr_reader :chdir
 
-  sig { returns(T::Hash[String, String]) }
+  sig { returns(T::Hash[String, T.any(NilClass, String, T::Boolean)]) }
   attr_reader :env
 
   sig { returns(T::Boolean) }