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
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
|
var clean = require('gulp-clean');
var fs = require('fs');
var gulp = require('gulp');
var log = require('fancy-log');
var gzip = require('../');
var nid = require('nid');
var rename = require('gulp-rename');
var should = require('should');
var Stream = require('stream');
var tap = require('gulp-tap');
var zlib = require('zlib');
// monkeys are fixing cwd for gulp-mocha
// node lives in one process/scope/directory
process.chdir('./test');
describe('gulp-gzip', function() {
describe('config', function() {
it('should have default config', function(done) {
var instance = gzip();
instance.config.should.eql({
append: true,
gzipOptions: {},
skipGrowingFiles: false,
threshold: false
});
done();
});
it('should merge options with defaults', function(done) {
var instance = gzip({ append: false });
instance.config.should.eql({
append: false,
gzipOptions: {},
skipGrowingFiles: false,
threshold: false
});
done();
});
});
describe('file extension', function() {
it('should append .gz to the file extension, by default', function(done) {
gulp.src('files/small.txt')
.pipe(gzip())
.pipe(tap(function(file) {
file.path.should.endWith('.gz');
done();
}));
});
it('should not append .gz to the file extension receiving { append: false }', function(done) {
gulp.src('files/small.txt')
.pipe(gzip({ append: false }))
.pipe(tap(function(file) {
file.path.should.not.endWith('.gz');
done();
}));
});
it('should accept an arbitrary extension with the `extension` option', function(done) {
gulp.src('files/small.txt')
.pipe(gzip({ extension: 'zip' }))
.pipe(tap(function(file) {
file.path.should.endWith('.zip');
done();
}));
});
it('should accept an arbitrary pre-extension with the `preExtension` option', function(done) {
gulp.src('files/small.txt')
.pipe(gzip({ preExtension: 'gz' }))
.pipe(tap(function(file) {
file.path.should.endWith('.gz.txt');
done();
}));
});
});
describe('file type', function() {
it('should return file contents as a Buffer', function(done) {
gulp.src('files/small.txt')
.pipe(gzip())
.pipe(tap(function(file) {
file.contents.should.be.instanceof(Buffer);
done();
}));
});
it('should return file contents as a Stream', function(done) {
gulp.src('files/small.txt', { buffer: false })
.pipe(gzip())
.pipe(tap(function(file) {
file.contents.should.be.instanceof(Stream);
done();
}));
});
});
describe('file properties', function() {
it('should not lose any properties from the Vinyl file', function(done) {
gulp.src('files/small.txt')
.pipe(tap(function(file) {
file.test = 'test';
}))
.pipe(gzip())
.pipe(tap(function(file) {
file.should.have.property('test', 'test');
done();
}));
});
it('should set `contentEncoding`', function(done) {
gulp.src('files/small.txt')
.pipe(gzip())
.pipe(tap(function(file) {
file.should.have.property('contentEncoding');
file.contentEncoding.should.containEql('gzip');
done();
}));
});
});
describe('gzip options', function() {
it('should set gzipOptions object', function(done) {
var instance = gzip({ gzipOptions: { level: 9, memLevel: 1} });
instance.config.should.have.property('gzipOptions');
instance.config.gzipOptions.should.have.property('level', 9);
instance.config.gzipOptions.should.have.property('memLevel', 1);
done();
});
it('should handle compression level in buffer mode', function(done) {
var id_lowest_compression = nid();
var id_highest_compression = nid();
var out_lowest_compression = gulp.dest('tmp');
var out_highest_compression = gulp.dest('tmp');
var size_lowest_compression = 0;
var size_highest_compression = 0;
out_lowest_compression.on('end', function() {
fs.stat('./tmp/' + id_lowest_compression + '.txt.gz', function (err, stats) {
size_lowest_compression = stats.size;
if (size_highest_compression > 0) {
size_highest_compression.should.be.lessThan(size_lowest_compression);
done();
}
});
});
out_highest_compression.on('end', function() {
fs.stat('./tmp/' + id_highest_compression + '.txt.gz', function (err, stats) {
size_highest_compression = stats.size;
if (size_lowest_compression > 0) {
size_highest_compression.should.be.lessThan(size_lowest_compression);
done();
}
});
});
gulp.src('files/big.txt')
.pipe(rename({ basename: id_lowest_compression }))
.pipe(gzip({ gzipOptions: { level: 1 } }))
.pipe(out_lowest_compression);
gulp.src('files/big.txt')
.pipe(rename({ basename: id_highest_compression }))
.pipe(gzip({ gzipOptions: { level: 9 } }))
.pipe(out_highest_compression);
});
it('should handle compression level in stream mode', function(done) {
var id_lowest_compression = nid();
var id_highest_compression = nid();
var out_lowest_compression = gulp.dest('tmp');
var out_highest_compression = gulp.dest('tmp');
var size_lowest_compression = 0;
var size_highest_compression = 0;
out_lowest_compression.on('end', function() {
fs.stat('./tmp/' + id_lowest_compression + '.txt.gz', function (err, stats) {
size_lowest_compression = stats.size;
if (size_highest_compression > 0) {
size_highest_compression.should.be.lessThan(size_lowest_compression);
done();
}
});
});
out_highest_compression.on('end', function() {
fs.stat('./tmp/' + id_highest_compression + '.txt.gz', function (err, stats) {
size_highest_compression = stats.size;
if (size_lowest_compression > 0) {
size_highest_compression.should.be.lessThan(size_lowest_compression);
done();
}
});
});
gulp.src('files/big.txt', { buffer: false })
.pipe(rename({ basename: id_lowest_compression }))
.pipe(gzip({ gzipOptions: { level: 1 } }))
.pipe(out_lowest_compression);
gulp.src('files/big.txt', { buffer: false })
.pipe(rename({ basename: id_highest_compression }))
.pipe(gzip({ gzipOptions: { level: 9 } }))
.pipe(out_highest_compression);
});
});
describe('threshold option', function() {
it('should set threshold to false while receiving false', function(done) {
var instance = gzip({ threshold: false });
instance.config.threshold.should.be.false;
done();
});
it('should set threshold to 150 while receiving true', function(done) {
var instance = gzip({ threshold: true });
instance.config.threshold.should.eql(150);
done();
});
it('should set threshold to Number while receiving Number', function(done) {
var instance = gzip({ threshold: 1024 });
instance.config.should.have.property('threshold', 1024);
done();
});
it('should set threshold to 150 while receiving Number < 150', function(done) {
var instance = gzip({ threshold: 100 });
instance.config.should.have.property('threshold', 150);
done();
});
it('should set threshold to Number while receiving String (bytes result)', function(done) {
var instance = gzip({ threshold: '1kb' });
instance.config.should.have.property('threshold', 1024);
done();
});
it('should set threshold to 150 while receiving String (bytes result < 150)', function(done) {
var instance = gzip({ threshold: '1kb' });
instance.config.should.have.property('threshold', 1024);
done();
});
it('should handle threshold of 1kb by passing through small.txt (<1kb)', function(done) {
var id = nid();
var out = gulp.dest('tmp');
out.on('end', function() {
fs.readFile('./tmp/' + id + '.txt', { encoding: 'utf-8' }, function(err, file) {
fs.readFile('./files/small.txt', { encoding: 'utf-8' }, function(err, original) {
file.should.equal(original);
done();
});
});
});
gulp.src('files/small.txt')
.pipe(rename({ basename: id }))
.pipe(gzip({ threshold: '1kb' }))
.pipe(out);
});
it('should handle threshold of 1kb by compressing big.txt (>1kb)', function(done) {
var id = nid();
var out = gulp.dest('tmp');
out.on('end', function() {
fs.readFile('./tmp/' + id + '.txt.gz', function(err, file) {
zlib.unzip(file, function(err, buffer) {
file = buffer.toString('utf-8');
fs.readFile('./files/big.txt', { encoding: 'utf-8' }, function(err, original) {
file.should.equal(original);
done();
});
});
});
});
gulp.src('files/big.txt')
.pipe(rename({ basename: id }))
.pipe(gzip({ threshold: '1kb' }))
.pipe(out);
});
it('should handle threshold of 1kb by passing through small.txt (<1kb)', function(done) {
var id = nid();
var out = gulp.dest('tmp');
out.on('end', function() {
fs.readFile('./tmp/' + id + '.txt', { encoding: 'utf-8' }, function(err, file) {
fs.readFile('./files/small.txt', { encoding: 'utf-8' }, function(err, original) {
file.should.equal(original);
done();
});
});
});
gulp.src('files/small.txt', { buffer: false })
.pipe(rename({ basename: id }))
.pipe(gzip({ threshold: '1kb' }))
.pipe(out);
});
it('should handle threshold of 1kb by compressing big.txt (>1kb)', function(done) {
var id = nid();
var out = gulp.dest('tmp');
out.on('end', function() {
fs.readFile('./tmp/' + id + '.txt.gz', function(err, file) {
zlib.unzip(file, function(err, buffer) {
file = buffer.toString('utf-8');
fs.readFile('./files/big.txt', { encoding: 'utf-8' }, function(err, original) {
file.should.equal(original);
done();
});
});
});
});
gulp.src('files/big.txt', { buffer: false })
.pipe(rename({ basename: id }))
.pipe(gzip({ threshold: '1kb' }))
.pipe(out);
});
});
describe('delete mode', function() {
it('should not delete existing gzipped files when { deleteMode : false }', function(done) {
var id = nid();
var out = gulp.dest('tmp');
out.on('end', function() {
fs.readFile('./tmp/' + id + '.txt.gz', function(err, file) {
should.not.exist(err);
should.exist(file);
file.should.not.be.empty;
var out = gulp.dest('tmp');
out.on('end', function() {
fs.readFile('./tmp/' + id + '.txt.gz', function(err, file) {
should.not.exist(err);
should.exist(file);
file.should.not.be.empty;
done();
});
});
gulp.src('files/small.txt')
.pipe(rename({ basename: id }))
.pipe(gzip({ threshold: 1024 }))
.pipe(out);
});
});
gulp.src('files/big.txt')
.pipe(rename({ basename: id }))
.pipe(gzip({ threshold: 1024 }))
.pipe(out);
});
it('should delete existing gzipped files if the files changed from big.txt (over threshold) to small.txt (under threshold) when { deleteMode : true }', function(done) {
var id = nid();
var out = gulp.dest('tmp');
out.on('end', function() {
fs.readFile('./tmp/' + id + '.txt.gz', function(err, file) {
should.not.exist(err);
should.exist(file);
file.should.not.be.empty;
var out = gulp.dest('tmp');
out.on('end', function() {
fs.exists('./tmp/' + id + '.txt.gz', function(exists) {
exists.should.be.false;
done();
});
});
gulp.src('files/small.txt')
.pipe(rename({ basename: id }))
.pipe(gzip({ threshold: 1024, deleteMode: 'tmp' }))
.pipe(out);
});
});
gulp.src('files/big.txt')
.pipe(rename({ basename: id }))
.pipe(gzip({ threshold: 1024, deleteMode: 'tmp' }))
.pipe(out);
});
});
describe ('uncompress the compressed file', function() {
it('should match original in buffer mode', function(done) {
var id = nid();
var out = gulp.dest('tmp');
out.on('end', function() {
fs.readFile('./tmp/' + id + '.txt.gz', function(err, file) {
zlib.unzip(file, function(err, buffer) {
file = buffer.toString('utf-8', 0, buffer.length);
fs.readFile('./files/small.txt', { encoding: 'utf-8' }, function(err, original) {
file.should.equal(original);
done();
});
});
});
});
gulp.src('files/small.txt')
.pipe(rename({ basename: id }))
.pipe(gzip())
.pipe(out);
});
it('should match original in stream mode', function(done) {
var id = nid();
var out = gulp.dest('tmp');
out.on('end', function() {
fs.readFile('./tmp/' + id + '.txt.gz', function(err, file) {
zlib.unzip(file, function(err, buffer) {
file = buffer.toString('utf-8', 0, buffer.length);
fs.readFile('./files/small.txt', { encoding: 'utf-8' }, function(err, original) {
file.should.equal(original);
done();
});
});
});
});
gulp.src('files/small.txt', { buffer: false })
.pipe(rename({ basename: id }))
.pipe(gzip())
.pipe(out);
});
});
describe('skip files that get larger after compression', function() {
it('handles buffers', function(done) {
var originalBuffer;
gulp.src('files/too_small.txt')
.pipe(tap(function(file) {
originalBuffer = file.contents;
}))
.pipe(gzip({ skipGrowingFiles: true }))
.pipe(tap(function(file) {
file.contents.should.equal(originalBuffer);
done();
}));
});
it('handles streams', function(done) {
var originalStream;
gulp.src('files/too_small.txt', { buffer: false })
.pipe(tap(function(file) {
originalStream = file.contents;
}))
.pipe(gzip({ skipGrowingFiles: true }))
.pipe(tap(function(file) {
file.contents.should.equal(originalStream);
done();
}));
});
});
});
|
