Add RBS signature and testing #25
Merged
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
I propose managing the signatures in a ruby/base64 repository instead of ruby/gem_rbs_collection.
Background
base64 is a bundled gem.
Until now, its signatures were managed in the RBS repository, but bundled gems are now expected to be maintained either in gem_rbs_collection or in the gem itself.
Signatures
Original: https://github.com/ruby/rbs/blob/868689362fe295e06b812a78c503981ab04730d6/stdlib/base64/0/base64.rbs
Current: https://github.com/ruby/gem_rbs_collection/blob/1b207abb31c92061e2ce58383503bb36294f7666/gems/base64/0.1/base64.rbs
Once this change is released, rbs will automatically give preference to the gem's signature.
Testings
No modifications have been made to existing Ruby tests.
I have rewritten a new test for signatures.
It is sufficient to test signatures only with the latest version of Ruby.
Comments
Ruby comments and rbs comments are synchronized using the
rake rbs:annotatecommand.Updates to rbs comments are now automatically checked by CI.
Benefit
We can provide users with signatures that follow the Ruby code perfectly.