File: test_scrubber.rb

package info (click to toggle)
ruby-loofah 2.25.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 488 kB
  • sloc: ruby: 4,176; makefile: 4
file content (395 lines) | stat: -rw-r--r-- 10,724 bytes parent folder | download
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
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
# frozen_string_literal: true

require "helper"

class UnitTestScrubber < Loofah::TestCase
  FRAGMENT = "<span>hello</span><span>goodbye</span>"
  FRAGMENT_NODE_COUNT = 4 # span, text, span, text
  FRAGMENT_NODE_STOP_TOP_DOWN = 2 # span, span
  DOCUMENT = "<html><head><link></link></head><body><span>hello</span><span>goodbye</span></body></html>"
  DOCUMENT_NODE_COUNT = 8 # html, head, link, body, span, text, span, text
  DOCUMENT_NODE_STOP_TOP_DOWN = 1 # html

  context "receiving a block" do
    before do
      @count = 0
    end

    context "returning CONTINUE" do
      before do
        @scrubber = Loofah::Scrubber.new do |_node|
          @count += 1
          Loofah::Scrubber::CONTINUE
        end
      end

      it "operates properly" do
        Loofah.scrub_html4_fragment(FRAGMENT, @scrubber)

        assert_equal FRAGMENT_NODE_COUNT, @count
      end

      it "operates properly" do
        Loofah.scrub_html4_document(DOCUMENT, @scrubber)

        assert_equal DOCUMENT_NODE_COUNT, @count
      end

      it "operates properly" do
        Loofah.scrub_html5_fragment(FRAGMENT, @scrubber)

        assert_equal FRAGMENT_NODE_COUNT, @count
      end if Loofah.html5_support?

      it "operates properly" do
        Loofah.scrub_html5_document(DOCUMENT, @scrubber)

        assert_equal DOCUMENT_NODE_COUNT, @count
      end if Loofah.html5_support?
    end

    context "returning STOP" do
      before do
        @scrubber = Loofah::Scrubber.new do |_node|
          @count += 1
          Loofah::Scrubber::STOP
        end
      end

      it "operates as top-down" do
        Loofah.scrub_html4_fragment(FRAGMENT, @scrubber)

        assert_equal FRAGMENT_NODE_STOP_TOP_DOWN, @count
      end

      it "operates as top-down" do
        Loofah.scrub_html4_document(DOCUMENT, @scrubber)

        assert_equal DOCUMENT_NODE_STOP_TOP_DOWN, @count
      end

      it "operates as top-down" do
        Loofah.scrub_html5_fragment(FRAGMENT, @scrubber)

        assert_equal FRAGMENT_NODE_STOP_TOP_DOWN, @count
      end if Loofah.html5_support?

      it "operates as top-down" do
        Loofah.scrub_html5_document(DOCUMENT, @scrubber)

        assert_equal DOCUMENT_NODE_STOP_TOP_DOWN, @count
      end if Loofah.html5_support?
    end

    context "returning neither CONTINUE nor STOP" do
      before do
        @scrubber = Loofah::Scrubber.new do |_node|
          @count += 1
        end
      end

      it "acts as if CONTINUE was returned" do
        Loofah.scrub_html4_fragment(FRAGMENT, @scrubber)

        assert_equal FRAGMENT_NODE_COUNT, @count
      end

      it "acts as if CONTINUE was returned" do
        Loofah.scrub_html4_document(DOCUMENT, @scrubber)

        assert_equal DOCUMENT_NODE_COUNT, @count
      end

      it "acts as if CONTINUE was returned" do
        Loofah.scrub_html5_fragment(FRAGMENT, @scrubber)

        assert_equal FRAGMENT_NODE_COUNT, @count
      end if Loofah.html5_support?

      it "acts as if CONTINUE was returned" do
        Loofah.scrub_html5_document(DOCUMENT, @scrubber)

        assert_equal DOCUMENT_NODE_COUNT, @count
      end if Loofah.html5_support?
    end

    context "not specifying direction" do
      before do
        @scrubber = Loofah::Scrubber.new do |_node|
          @count += 1
          Loofah::Scrubber::STOP
        end
      end

      it "operates as top-down" do
        Loofah.scrub_html4_fragment(FRAGMENT, @scrubber)

        assert_equal FRAGMENT_NODE_STOP_TOP_DOWN, @count
      end

      it "operates as top-down" do
        Loofah.scrub_html4_document(DOCUMENT, @scrubber)

        assert_equal DOCUMENT_NODE_STOP_TOP_DOWN, @count
      end

      it "operates as top-down" do
        Loofah.scrub_html5_fragment(FRAGMENT, @scrubber)

        assert_equal FRAGMENT_NODE_STOP_TOP_DOWN, @count
      end if Loofah.html5_support?

      it "operates as top-down" do
        Loofah.scrub_html5_document(DOCUMENT, @scrubber)

        assert_equal DOCUMENT_NODE_STOP_TOP_DOWN, @count
      end if Loofah.html5_support?
    end

    context "specifying top-down direction" do
      before do
        @scrubber = Loofah::Scrubber.new(direction: :top_down) do |_node|
          @count += 1
          Loofah::Scrubber::STOP
        end
      end

      it "operates as top-down" do
        Loofah.scrub_html4_fragment(FRAGMENT, @scrubber)

        assert_equal FRAGMENT_NODE_STOP_TOP_DOWN, @count
      end

      it "operates as top-down" do
        Loofah.scrub_html4_document(DOCUMENT, @scrubber)

        assert_equal DOCUMENT_NODE_STOP_TOP_DOWN, @count
      end

      it "operates as top-down" do
        Loofah.scrub_html5_fragment(FRAGMENT, @scrubber)

        assert_equal FRAGMENT_NODE_STOP_TOP_DOWN, @count
      end if Loofah.html5_support?

      it "operates as top-down" do
        Loofah.scrub_html5_document(DOCUMENT, @scrubber)

        assert_equal DOCUMENT_NODE_STOP_TOP_DOWN, @count
      end if Loofah.html5_support?
    end

    context "specifying bottom-up direction" do
      before do
        @scrubber = Loofah::Scrubber.new(direction: :bottom_up) do |_node|
          @count += 1
        end
      end

      it "operates as bottom-up" do
        Loofah.scrub_html4_fragment(FRAGMENT, @scrubber)

        assert_equal FRAGMENT_NODE_COUNT, @count
      end

      it "operates as bottom-up" do
        Loofah.scrub_html4_document(DOCUMENT, @scrubber)

        assert_equal DOCUMENT_NODE_COUNT, @count
      end

      it "operates as bottom-up" do
        Loofah.scrub_html5_fragment(FRAGMENT, @scrubber)

        assert_equal FRAGMENT_NODE_COUNT, @count
      end if Loofah.html5_support?

      it "operates as bottom-up" do
        Loofah.scrub_html5_document(DOCUMENT, @scrubber)

        assert_equal DOCUMENT_NODE_COUNT, @count
      end if Loofah.html5_support?
    end

    context "invalid direction" do
      it "raise an exception" do
        assert_raises(ArgumentError) do
          Loofah::Scrubber.new(direction: :quux) {}
        end
      end
    end

    context "given a block taking zero arguments" do
      before do
        @scrubber = Loofah::Scrubber.new do
          @count += 1
        end
      end

      it "works anyway, shrug" do
        Loofah.scrub_html4_fragment(FRAGMENT, @scrubber)

        assert_equal FRAGMENT_NODE_COUNT, @count
      end

      it "works anyway, shrug" do
        Loofah.scrub_html4_document(DOCUMENT, @scrubber)

        assert_equal DOCUMENT_NODE_COUNT, @count
      end

      it "works anyway, shrug" do
        Loofah.scrub_html5_fragment(FRAGMENT, @scrubber)

        assert_equal FRAGMENT_NODE_COUNT, @count
      end if Loofah.html5_support?

      it "works anyway, shrug" do
        Loofah.scrub_html5_document(DOCUMENT, @scrubber)

        assert_equal DOCUMENT_NODE_COUNT, @count
      end if Loofah.html5_support?
    end
  end

  context "defining a new Scrubber class" do
    before do
      @klass = Class.new(Loofah::Scrubber) do
        attr_accessor :count

        def initialize(direction = nil) # rubocop:disable Lint/MissingSuper
          @direction = direction
          @count = 0
        end

        def scrub(node)
          @count += 1
          Loofah::Scrubber::STOP
        end
      end
    end

    context "when not specifying direction" do
      before do
        @scrubber = @klass.new

        assert_nil @scrubber.direction
      end

      it "operates as top-down" do
        Loofah.scrub_html4_fragment(FRAGMENT, @scrubber)

        assert_equal FRAGMENT_NODE_STOP_TOP_DOWN, @scrubber.count
      end

      it "operates as top-down" do
        Loofah.scrub_html4_document(DOCUMENT, @scrubber)

        assert_equal DOCUMENT_NODE_STOP_TOP_DOWN, @scrubber.count
      end

      it "operates as top-down" do
        Loofah.scrub_html5_fragment(FRAGMENT, @scrubber)

        assert_equal FRAGMENT_NODE_STOP_TOP_DOWN, @scrubber.count
      end if Loofah.html5_support?

      it "operates as top-down" do
        Loofah.scrub_html5_document(DOCUMENT, @scrubber)

        assert_equal DOCUMENT_NODE_STOP_TOP_DOWN, @scrubber.count
      end if Loofah.html5_support?
    end

    context "when direction is specified as top_down" do
      before do
        @scrubber = @klass.new(:top_down)

        assert_equal :top_down, @scrubber.direction
      end

      it "operates as top-down" do
        Loofah.scrub_html4_fragment(FRAGMENT, @scrubber)

        assert_equal FRAGMENT_NODE_STOP_TOP_DOWN, @scrubber.count
      end

      it "operates as top-down" do
        Loofah.scrub_html4_document(DOCUMENT, @scrubber)

        assert_equal DOCUMENT_NODE_STOP_TOP_DOWN, @scrubber.count
      end

      it "operates as top-down" do
        Loofah.scrub_html5_fragment(FRAGMENT, @scrubber)

        assert_equal FRAGMENT_NODE_STOP_TOP_DOWN, @scrubber.count
      end if Loofah.html5_support?

      it "operates as top-down" do
        Loofah.scrub_html5_document(DOCUMENT, @scrubber)

        assert_equal DOCUMENT_NODE_STOP_TOP_DOWN, @scrubber.count
      end if Loofah.html5_support?
    end

    context "when direction is specified as bottom_up" do
      before do
        @scrubber = @klass.new(:bottom_up)

        assert_equal :bottom_up, @scrubber.direction
      end

      it "operates as bottom-up" do
        Loofah.scrub_html4_fragment(FRAGMENT, @scrubber)

        assert_equal FRAGMENT_NODE_COUNT, @scrubber.count
      end

      it "operates as bottom-up" do
        Loofah.scrub_html4_document(DOCUMENT, @scrubber)

        assert_equal DOCUMENT_NODE_COUNT, @scrubber.count
      end

      it "operates as bottom-up" do
        Loofah.scrub_html5_fragment(FRAGMENT, @scrubber)

        assert_equal FRAGMENT_NODE_COUNT, @scrubber.count
      end if Loofah.html5_support?

      it "operates as bottom-up" do
        Loofah.scrub_html5_document(DOCUMENT, @scrubber)

        assert_equal DOCUMENT_NODE_COUNT, @scrubber.count
      end if Loofah.html5_support?
    end
  end

  context "creating a new Scrubber class with no scrub method" do
    before do
      @klass = Class.new(Loofah::Scrubber) do
        def initialize; end # rubocop:disable Lint/MissingSuper
      end
      @scrubber = @klass.new
    end

    it "raises an exception" do
      assert_raises(Loofah::ScrubberNotFound) do
        Loofah.scrub_html4_fragment(FRAGMENT, @scrubber)
      end

      assert_raises(Loofah::ScrubberNotFound) do
        Loofah.scrub_html4_document(DOCUMENT, @scrubber)
      end

      assert_raises(Loofah::ScrubberNotFound) do
        Loofah.scrub_html5_fragment(FRAGMENT, @scrubber)
      end if Loofah.html5_support?

      assert_raises(Loofah::ScrubberNotFound) do
        Loofah.scrub_html5_document(DOCUMENT, @scrubber)
      end if Loofah.html5_support?
    end
  end
end