summaryrefslogtreecommitdiff
path: root/spec/ruby/core/io/set_encoding_by_bom_spec.rb
blob: 92433d66405aaee86f60a745ac2ef71a1d3a5637 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
require_relative '../../spec_helper'

describe "IO#set_encoding_by_bom" do
  before :each do
    @name = tmp('io_set_encoding_by_bom.txt')
    touch(@name)
    @io = new_io(@name, 'rb')
  end

  after :each do
    @io.close unless @io.closed?
    rm_r @name
  end

  it "returns nil if not readable" do
    not_readable_io = new_io(@name, 'wb')

    not_readable_io.set_encoding_by_bom.should be_nil
    not_readable_io.external_encoding.should == Encoding::ASCII_8BIT
  ensure
    not_readable_io.close
  end

  it "returns the result encoding if found BOM UTF-8 sequence" do
    File.binwrite(@name, "\u{FEFF}")

    @io.set_encoding_by_bom.should == Encoding::UTF_8
    @io.external_encoding.should == Encoding::UTF_8
    @io.read.b.should == "".b
    @io.rewind
    @io.set_encoding(Encoding::ASCII_8BIT)

    File.binwrite(@name, "\u{FEFF}abc")

    @io.set_encoding_by_bom.should == Encoding::UTF_8
    @io.external_encoding.should == Encoding::UTF_8
    @io.read.b.should == "abc".b
  end

  it "returns the result encoding if found BOM UTF_16LE sequence" do
    File.binwrite(@name, "\xFF\xFE")

    @io.set_encoding_by_bom.should == Encoding::UTF_16LE
    @io.external_encoding.should == Encoding::UTF_16LE
    @io.read.b.should == "".b
    @io.rewind
    @io.set_encoding(Encoding::ASCII_8BIT)

    File.binwrite(@name, "\xFF\xFEabc")

    @io.set_encoding_by_bom.should == Encoding::UTF_16LE
    @io.external_encoding.should == Encoding::UTF_16LE
    @io.read.b.should == "abc".b
  end

  it "returns the result encoding if found BOM UTF_16BE sequence" do
    File.binwrite(@name, "\xFE\xFF")

    @io.set_encoding_by_bom.should == Encoding::UTF_16BE
    @io.external_encoding.should == Encoding::UTF_16BE
    @io.read.b.should == "".b
    @io.rewind
    @io.set_encoding(Encoding::ASCII_8BIT)

    File.binwrite(@name, "\xFE\xFFabc")

    @io.set_encoding_by_bom.should == Encoding::UTF_16BE
    @io.external_encoding.should == Encoding::UTF_16BE
    @io.read.b.should == "abc".b
  end

  it "returns the result encoding if found BOM UTF_32LE sequence" do
    File.binwrite(@name, "\xFF\xFE\x00\x00")

    @io.set_encoding_by_bom.should == Encoding::UTF_32LE
    @io.external_encoding.should == Encoding::UTF_32LE
    @io.read.b.should == "".b
    @io.rewind
    @io.set_encoding(Encoding::ASCII_8BIT)

    File.binwrite(@name, "\xFF\xFE\x00\x00abc")

    @io.set_encoding_by_bom.should == Encoding::UTF_32LE
    @io.external_encoding.should == Encoding::UTF_32LE
    @io.read.b.should == "abc".b
  end

  it "returns the result encoding if found BOM UTF_32BE sequence" do
    File.binwrite(@name, "\x00\x00\xFE\xFF")

    @io.set_encoding_by_bom.should == Encoding::UTF_32BE
    @io.external_encoding.should == Encoding::UTF_32BE
    @io.read.b.should == "".b
    @io.rewind
    @io.set_encoding(Encoding::ASCII_8BIT)

    File.binwrite(@name, "\x00\x00\xFE\xFFabc")

    @io.set_encoding_by_bom.should == Encoding::UTF_32BE
    @io.external_encoding.should == Encoding::UTF_32BE
    @io.read.b.should == "abc".b
  end

  it "returns nil if io is empty" do
    @io.set_encoding_by_bom.should be_nil
    @io.external_encoding.should == Encoding::ASCII_8BIT
  end

  it "returns nil if UTF-8 BOM sequence is incomplete" do
    File.write(@name, "\xEF")

    @io.set_encoding_by_bom.should == nil
    @io.external_encoding.should == Encoding::ASCII_8BIT
    @io.read.b.should == "\xEF".b
    @io.rewind

    File.write(@name, "\xEFa")

    @io.set_encoding_by_bom.should == nil
    @io.external_encoding.should == Encoding::ASCII_8BIT
    @io.read.b.should == "\xEFa".b
    @io.rewind

    File.write(@name, "\xEF\xBB")

    @io.set_encoding_by_bom.should == nil
    @io.external_encoding.should == Encoding::ASCII_8BIT
    @io.read.b.should == "\xEF\xBB".b
    @io.rewind

    File.write(@name, "\xEF\xBBa")

    @io.set_encoding_by_bom.should == nil
    @io.external_encoding.should == Encoding::ASCII_8BIT
    @io.read.b.should == "\xEF\xBBa".b
  end

  it "returns nil if UTF-16BE BOM sequence is incomplete" do
    File.write(@name, "\xFE")

    @io.set_encoding_by_bom.should == nil
    @io.external_encoding.should == Encoding::ASCII_8BIT
    @io.read.b.should == "\xFE".b
    @io.rewind

    File.write(@name, "\xFEa")

    @io.set_encoding_by_bom.should == nil
    @io.external_encoding.should == Encoding::ASCII_8BIT
    @io.read.b.should == "\xFEa".b
  end

  it "returns nil if UTF-16LE/UTF-32LE BOM sequence is incomplete" do
    File.write(@name, "\xFF")

    @io.set_encoding_by_bom.should == nil
    @io.external_encoding.should == Encoding::ASCII_8BIT
    @io.read.b.should == "\xFF".b
    @io.rewind

    File.write(@name, "\xFFa")

    @io.set_encoding_by_bom.should == nil
    @io.external_encoding.should == Encoding::ASCII_8BIT
    @io.read.b.should == "\xFFa".b
  end

  it "returns UTF-16LE if UTF-32LE BOM sequence is incomplete" do
    File.write(@name, "\xFF\xFE")

    @io.set_encoding_by_bom.should == Encoding::UTF_16LE
    @io.external_encoding.should == Encoding::UTF_16LE
    @io.read.b.should == "".b
    @io.rewind
    @io.set_encoding(Encoding::ASCII_8BIT)

    File.write(@name, "\xFF\xFE\x00")

    @io.set_encoding_by_bom.should == Encoding::UTF_16LE
    @io.external_encoding.should == Encoding::UTF_16LE
    @io.read.b.should == "\x00".b
    @io.rewind
    @io.set_encoding(Encoding::ASCII_8BIT)

    File.write(@name, "\xFF\xFE\x00a")

    @io.set_encoding_by_bom.should == Encoding::UTF_16LE
    @io.external_encoding.should == Encoding::UTF_16LE
    @io.read.b.should == "\x00a".b
  end

  it "returns nil if UTF-32BE BOM sequence is incomplete" do
    File.write(@name, "\x00")

    @io.set_encoding_by_bom.should == nil
    @io.external_encoding.should == Encoding::ASCII_8BIT
    @io.read.b.should == "\x00".b
    @io.rewind

    File.write(@name, "\x00a")

    @io.set_encoding_by_bom.should == nil
    @io.external_encoding.should == Encoding::ASCII_8BIT
    @io.read.b.should == "\x00a".b
    @io.rewind

    File.write(@name, "\x00\x00")

    @io.set_encoding_by_bom.should == nil
    @io.external_encoding.should == Encoding::ASCII_8BIT
    @io.read.b.should == "\x00\x00".b
    @io.rewind

    File.write(@name, "\x00\x00a")

    @io.set_encoding_by_bom.should == nil
    @io.external_encoding.should == Encoding::ASCII_8BIT
    @io.read.b.should == "\x00\x00a".b
    @io.rewind

    File.write(@name, "\x00\x00\xFE")

    @io.set_encoding_by_bom.should == nil
    @io.external_encoding.should == Encoding::ASCII_8BIT
    @io.read.b.should == "\x00\x00\xFE".b
    @io.rewind

    File.write(@name, "\x00\x00\xFEa")

    @io.set_encoding_by_bom.should == nil
    @io.external_encoding.should == Encoding::ASCII_8BIT
    @io.read.b.should == "\x00\x00\xFEa".b
  end

  it "returns nil if found BOM sequence not provided" do
    File.write(@name, "abc")

    @io.set_encoding_by_bom.should == nil
    @io.external_encoding.should == Encoding::ASCII_8BIT
    @io.read(3).should == "abc".b
  end

  it 'returns exception if io not in binary mode' do
    not_binary_io = new_io(@name, 'r')

    -> { not_binary_io.set_encoding_by_bom }.should raise_error(ArgumentError, 'ASCII incompatible encoding needs binmode')
  ensure
    not_binary_io.close
  end

  it 'returns exception if encoding already set' do
    @io.set_encoding("utf-8")

    -> { @io.set_encoding_by_bom }.should raise_error(ArgumentError, 'encoding is set to UTF-8 already')
  end

  it 'returns exception if encoding conversion is already set' do
    @io.set_encoding(Encoding::UTF_8, Encoding::UTF_16BE)

    -> { @io.set_encoding_by_bom }.should raise_error(ArgumentError, 'encoding conversion is set')
  end
end