Compatibility issue with ruby 2.5 - Encoding::UndefinedConversionError: ... from ASCII-8BIT to UTF-8

[abrom]

I'm seeing undefined conversion errors when trying to write out the result files when the source file contains extended ascii characters. The write_file method in lib/simplecov-rcov.rb:

https://github.com/fguillen/simplecov-rcov/blob/master/lib/simplecov-rcov.rb#L49

returns a string with ASCII-8BIT encoding, and as a result when trying to write the file out it fails with something like:

Encoding::UndefinedConversionError:
  "\xE2" from ASCII-8BIT to UTF-8

In my case I have character \x2019 in the source file (an accented apostrophe) although this could of likely be any extended ascii character.

If I change the encoding of the result to match the template encoding:

rcov_result.encoding(template.encoding)

everything 'works', but this seems really heavy handed

The issue would appear to come from a change in behaviour for the ERB result function where in ruby < 2.5 it would return the template encoding but in 2.5 it's returning the injected line encoding

Another option would be to address this upstream within the simplecov project such that the file source would already be in the expected encoding?

Thoughts?

[clucas]

How about just changing

File.open( output_filename, "w" )

to

File.open( output_filename, "wb" )

[k0kubun]

Oh, I overlooked the description of this issue and just submitted #21.

everything 'works', but this seems really heavy handed

I can understand what you mean. Here is my thought after deeper consideration:

The root cause of this issue is this line: https://github.com/colszowka/simplecov/blob/v0.16.1/lib/simplecov/source_file.rb#L94
As the source is read as binary, the rendering result which includes the binary should be binary as well. Saving it as non-binary by forcing it to the encoding of "views/detail.html.erb", UTF-8, looks a bad idea because (I assume) it doesn't work for an encoding incompatible with UTF-8.

So, here is my suggestion for this issue: #22