Improve signature for Gem::Version.create #625
Merged
Conversation
This file contains 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
This change aims to improve the signature for the `Gem::Version.create` method.
The current signature always returns a nil-able value, but this is not useful because nil-check is necessary.
I think we can improve the method signature via overloading because this method returns `nil` only when `nil` is passed.
See below:
```ruby
# a.rb
p(Gem::Version.create("2.3.4") >= Gem::Version.create("2.3.0"))
```
```console
$ bundle exec steep check a.rb
...
a.rb:1:31: [error] Type `(::Gem::Version | nil)` does not have method `>=`
│ Diagnostic ID: Ruby::NoMethod
│
└ p(Gem::Version.create("2.3.4") >= Gem::Version.create("2.3.0"))
~~
```
Environments:
- RBS 1.1.0
- Steep 0.42.0
Source code of the `create` method:
https://github.com/rubygems/rubygems/blob/v3.2.13/lib/rubygems/version.rb#L188-L196
ybiquitous
commented
Mar 10, 2021
| @@ -170,7 +170,8 @@ module Gem | |||
| # ver2 = Version.create(ver1) # -> (ver1) | |||
| # ver3 = Version.create(nil) # -> nil | |||
| # | |||
| def self.create: (_ToS | Version | nil input) -> instance? | |||
| def self.create: (_ToS | Version input) -> instance | |||
| | (nil input) -> nil | |||
There was a problem hiding this comment.
[note] The test case is covered when nil is passed:
rbs/test/stdlib/rubygems/GemVersion_test.rb
Lines 23 to 24 in e629aa7
|
FYI. |
|
@pocke Thanks for the review and merge! 😄 |
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.
This change aims to improve the signature for the
Gem::Version.createmethod.The current signature always returns a nil-able value, but this is not useful because nil-check is necessary.
I think we can improve the method signature via overloading because this method returns
nilonly whennilis passed.See below:
Environments:
Source code of the
createmethod:https://github.com/rubygems/rubygems/blob/v3.2.13/lib/rubygems/version.rb#L188-L196