Use new instead of from_hash for formula and cask structs
#21377
+73
−14
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request improves type safety by overriding T::Struct::from_hash in FormulaStruct and CaskStruct to use T::Struct::new, which performs runtime type checking. The PR also fixes several type definitions to ensure they accurately reflect the actual data structures used in the API.
Key changes:
- Override
from_hashmethods to perform type checking vianewinstead of using Sorbet's default behavior - Correct type definitions for bottle checksums, dependency hashes, and cask dependencies
- Add fallback for missing head URLs to satisfy type checker
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| Library/Homebrew/api/formula_struct.rb | Adds from_hash override with type checking; defines DependencyHash type alias; corrects types for bottle_checksums, stable_dependency_hash, and head_dependency_hash |
| Library/Homebrew/api/formula.rb | Adds empty string fallback for missing head URL to satisfy type checker |
| Library/Homebrew/api/cask_struct.rb | Adds from_hash override with type checking; defines DependsOnArgs type alias to allow both single values and arrays; updates depends_on_args type |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
MikeMcQuaid
approved these changes
Jan 9, 2026
Member
MikeMcQuaid
left a comment
There was a problem hiding this comment.
Good idea, thanks for this!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Sorbet's default
T::Struct::from_hashdoesn't actually check to ensure that types match. Instead, let's override this method to useT::Struct::newwhich does perform type checking to catch additional issues.I had to fix a few minor types, but otherwise all formulae and casks load successfully from the API, which I tested with
Formula.allandCask::Cask.allinbrew irb.To try to avoid more issues when loading old installed cask JSON data, I've added an exception to the cask handling: if a cask is loaded from JSON that came from the installed caskfile, it will stick with the old method that doesn't enforce types to avoid fatal errors there