Update type for CSV.foreach #1738
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
m11o
commented
Jan 28, 2024
| @@ -1722,7 +1722,10 @@ class CSV < Object | |||
| # would read `UTF-32BE` data from the file but transcode it to `UTF-8` | |||
| # before parsing. | |||
| # | |||
| def self.foreach: [U] (String | IO | StringIO path, ?::Hash[Symbol, U] options) { (::Array[String?] arg0) -> void } -> void | |||
| def self.foreach: (String | IO path, ?String mode, headers: true, **untyped options) { (::CSV::Row arg0) -> void } -> void | |||
There was a problem hiding this comment.
Accurately, the headers keyword argument can't be only received true, but also truthy value, for example, String and Symbol, etc.
However, As headers argument is often provided true, I defined true only in this methods.
Please let me know if not good. Thanks.
Because csv gem promoted bundled gem from default gem.
m11o
commented
Jan 28, 2024
| @@ -18,6 +18,7 @@ GEM | |||
| ast (2.4.2) | |||
| base64 (0.2.0) | |||
| bigdecimal (3.1.6) | |||
| csv (3.2.8) | |||
There was a problem hiding this comment.
Add csv gem to Gemfile because it is changed from default gem to bundled gem in ruby 3.4.
ref: #1734
soutaro
approved these changes
Jan 29, 2024
|
Technically, the type definition will result in an incorrect result: bool = true
CSV.foreach(..., headers: bool) do |row|
# `bool` is `bool` type, not `true`, and `row` is `String`.
endI think it's not too weird to assume we pass a |
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 Pull Request updates the type signatures of
CSV.foreachin RBS.When CSV.foreach is called with the headers keyword argument, the block parameter or the elements of the returned Enumerator are of type
CSV::Row. If the headers argument is not provided, the elements of the Enumerator will be arrays with elements of type String.This change accurately reflects the behavior of CSV.foreach depending on the presence of the headers keyword argument.
This Pull Request does not include changes for other methods that accept the headers keyword argument and have behavior variations based on this argument. After this Pull Request is merged, I plan to address these methods in a separate Pull Request.
Thanks.
CSV.foreach: https://github.com/ruby/csv/blob/0cba3e766d34373043b4ca0bbae93c8de12014f0/lib/csv.rb#L1332