-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix: Honour encoding in IO::Memory#to_s
#11875
Merged
straight-shoota
merged 3 commits into
crystal-lang:master
from
straight-shoota:fix/io_memory-to_s-encoding
Mar 17, 2022
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -61,6 +61,37 @@ describe IO::Memory do | |
# Ensure that the buffer is resized, otherwise the spec doesn't work | ||
[email protected]_not eq old_capacity | ||
end | ||
|
||
{% if flag?(:without_iconv) %} | ||
pending "encoding" | ||
{% else %} | ||
describe "encoding" do | ||
it "returns String" do | ||
io = IO::Memory.new | ||
io.set_encoding "UTF-16LE" | ||
io << "abc" | ||
io.to_s.should eq "abc" | ||
io.to_slice.should eq Bytes[0x61, 0, 0x62, 0, 0x63, 0] | ||
end | ||
|
||
it "writes to IO" do | ||
io1 = IO::Memory.new | ||
io1.set_encoding "UTF-32LE" | ||
|
||
io2 = IO::Memory.new | ||
io2.set_encoding "UTF-16LE" | ||
|
||
io1.write_utf8 "abc😂".to_slice | ||
io1.to_s io2 | ||
byte_slice = io2.to_slice | ||
utf16_slice = Slice.new(byte_slice.to_unsafe.unsafe_as(Pointer(UInt16)), byte_slice.size // sizeof(UInt16)) | ||
|
||
String.from_utf16(utf16_slice).should eq "abc😂" | ||
byte_slice.should eq Bytes[0x61, 0, 0x62, 0, 0x63, 0, 0x3D, 0xD8, 0x02, 0xDE] | ||
utf16_slice.should eq Slice[0x0061, 0x0062, 0x0063, 0xD83D, 0xDE02] | ||
end | ||
end | ||
{% end %} | ||
end | ||
|
||
it "reads single line content" do | ||
|
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -392,7 +392,15 @@ class IO::Memory < IO | |
# io.to_s # => "123" | ||
# ``` | ||
def to_s : String | ||
String.new @buffer, @bytesize | ||
if encoding = @encoding | ||
{% if flag?(:without_iconv) %} | ||
raise NotImplementedError.new("String.encode") | ||
{% else %} | ||
String.new to_slice, encoding: encoding.name, invalid: encoding.invalid | ||
{% end %} | ||
else | ||
String.new @buffer, @bytesize | ||
end | ||
end | ||
|
||
# Returns the underlying bytes. | ||
|
@@ -415,7 +423,15 @@ class IO::Memory < IO | |
new_bytesize = bytesize * 2 | ||
resize_to_capacity(new_bytesize) if @capacity < new_bytesize | ||
end | ||
io.write(to_slice) | ||
if encoding = @encoding | ||
{% if flag?(:without_iconv) %} | ||
raise NotImplementedError.new("String.encode") | ||
{% else %} | ||
String.encode(to_slice, encoding.name, io.encoding, io, [email protected](&.invalid)) | ||
{% end %} | ||
else | ||
io.write(to_slice) | ||
end | ||
end | ||
|
||
private def check_writeable | ||
|
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wouldn't be better to move this check into the
String.encode
method instead?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, I wondered about that. But
String.encode
is explicit about being for encoding purposes. Calling that method with-Dwithout_iconv
should lead to a compile time error.IO::Memory#to_s
on the other hand is not explicitly about encoding. It's just something that it needs to do in some state. In this case there should definitely not be a compile time error. So raising the runtime error here makes more sense IMO.