Add Signature for PrettyPrint #573
Conversation
|
Removing the WIP because I find difficult implementing the tests, although I will try more. |
wildeng
changed the title
stdlib/prettyprint/0/prettyprint.rbs
Outdated
| @@ -0,0 +1,364 @@ | |||
| # frozen_string_literal: true | |||
There was a problem hiding this comment.
RBS doesn't understand frozen_string_literal directive. ✂️
stdlib/prettyprint/0/prettyprint.rbs
Outdated
| # output | ||
| # end | ||
| # | ||
| def self.format: (?untyped output, ?Integer maxwidth, ?String newline, ?untyped genspace) ?{ (Integer) -> Integer } -> untyped |
There was a problem hiding this comment.
I think we can make an interface with << method, and use the interface as the type of output here?
There was a problem hiding this comment.
If I correctly understood something like:
interface _Output
def <<: (?String obj, ?String sep, ?String newline, ?untyped genspace ) ?{ (Integer) -> Integer } -> void
end
An then the definition becomes
def self.format: (?untyped output, ?Integer maxwidth, ?String newline, ?untyped genspace) ?{ (Integer) -> Integer } -> Output
There was a problem hiding this comment.
I mean like the following:
class PrettyPrint
interface _Output
def <<: (String) -> void
end
def self.format: (?_Output output, ?Integer maxwidth, ?String newline, ?untyped genspace) ?{ (Integer) -> Integer } -> _Output # !?!?
endYes, it's my bad... I finally found that the type cannot be written in RBS... 😢
Leave the type of the first argument ?untyped. 🙏 (I'm sorry for the confusion.)
stdlib/prettyprint/0/prettyprint.rbs
Outdated
| # | ||
| # If `width` is not specified, obj.length is used. | ||
| # | ||
| def text: (untyped obj, ?Integer width) -> untyped |
There was a problem hiding this comment.
I'm wondering if we need untyped here as the type of obj. Is there any reason to make it other than String?
There was a problem hiding this comment.
This is a good point, although the documentation is a little bit obscure for me. It's implicit the use of String.
There was a problem hiding this comment.
Yeah, I also got confused a bit. 😓
As far as I know, obj is (implicitly) assumed to be a String.
|
|
||
| # Breaks the buffer into lines that are shorter than #maxwidth | ||
| # | ||
| def break_outmost_groups: () -> untyped |
There was a problem hiding this comment.
Seems like these -> untyped can be -> void?
|
@soutaro thanks a lot for the comments and the test templates. I'm really happy to try to give back what Ruby gave to me in all these years. |
wildeng
force-pushed
the
add-pretty-print
branch
2 times, most recently
from
4680fe7
to
3cc2124
Compare
wildeng
force-pushed
the
add-pretty-print
branch
from
0d1b887
to
6f12c6f
Compare
|
I've checked the original code and modified the PR accordingly and did the requested changes. I also wrote the tests for it. |
* Added prettyprint.rbs file with definitions and rdoc
annotations
* Added the tests
wildeng
force-pushed
the
add-pretty-print
branch
from
6f12c6f
to
54bba31
Compare
Done :) |
|
Merged! Thank you! 🎉 |
Added the prettyprint signature file.
Marked as WIP because I'm trying to write the related tests.