Add RBS type signatures for improved type safety #68
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
Introduces comprehensive RBS type signatures for the entire public API and internal classes. This provides improved type checking, better IDE support, and documentation for gem users. All type signatures have been validated through runtime type checking using `rbs test` against the full RSpec test suite (291 examples, 0 failures). Changes: - Add RBS signatures for all core classes (Zxcvbn, Tester, Score, Match, etc.) - Add rake tasks for RBS validation and testing (rbs:validate, rbs:test, rbs:list, rbs:parse) - Configure rbs_collection.yaml for dependency type signatures - Update gemspec to exclude rbs_collection.yaml from gem package - Add sig/README.md with usage instructions - Fix type signatures based on runtime validation: - Use Numeric instead of Float for entropy calculations (handles both Integer and Float) - Accept nullable parameters where nil is valid (password, Match in year_entropy) - Support Symbol keys in DictionaryRanker for test compatibility - Allow untyped arrays in user_inputs for proper sanitization
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.
Context
This PR introduces RBS (Ruby Signature) type definitions for the entire public API and internal classes. RBS provides optional static type checking for Ruby, enabling better IDE support, earlier error detection, and improved documentation for gem users.
Changes
Zxcvbn,Tester,Score,Match,Feedback, etc.)rake rbs:validate- Validate type signature correctnessrake rbs:test- Run runtime type checking against test suiterake rbs:list- List all defined typesrake rbs:parse- Check RBS syntaxrbs_collection.yamlfor dependency type signaturessig/README.mdwith usage instructions and examplesAll type signatures have been validated through runtime type checking using
rbs testagainst the full RSpec test suite (291 examples, 0 failures).Considerations
Numericinstead ofFloatwhere methods return both integers and floatsuntypedarrays where the implementation performs sanitisationrbs:test) takes approximately 2 minutes and is not included in the default rake task