rump-images/test/gulp.js

Rump piece for handling images

import '../src'
import bufferEqual from 'buffer-equal'
import gulp from 'gulp'
import imageSize from 'image-size'
import timeout from 'timeout-then'
import rump from 'rump'
import {colors} from 'gulp-util'
import {exists, readFile, stat, writeFile} from 'mz/fs'
import {sep} from 'path'
import {spy} from 'sinon'

const {stripColor} = colors

describe('tasks', function() {
  this.timeout(0)

  afterEach(() => {
    rump.configure({
      paths: {
        source: {root: 'test/fixtures/src', images: ''},
        destination: {root: 'tmp', images: ''},
      },
      images: {retina: true},
    })
  })

  it('are added and defined', () => {
    const callback = spy()
    rump.on('gulp:main', callback)
    rump.on('gulp:images', callback)
    rump.addGulpTasks({prefix: 'spec'})
    callback.should.be.calledTwice()
    gulp.tasks['spec:info:images'].should.be.ok()
    gulp.tasks['spec:build:images'].should.be.ok()
    gulp.tasks['spec:watch:images'].should.be.ok()
  })

  it('display correct information in info task', () => {
    const logs = [],
          {log} = console
    console.log = newLog
    gulp.start('spec:info')
    console.log = log
    logs.slice(-7).should.eql([
      '',
      '--- Images v0.8.0',
      `Images from test${sep}fixtures${sep}src are copied to tmp`,
      'Affected files (* - non-retina copies also generated):',
      'image1.png',
      'image2@2x.jpg *',
      '',
    ])
    logs.length = 0
    console.log = newLog
    gulp.start('spec:info:prod')
    console.log = log
    logs.slice(-7).should.eql([
      '',
      '--- Images v0.8.0',
      `Images from test${sep}fixtures${sep}src are minified and copied to tmp`,
      'Affected files (* - non-retina copies also generated):',
      'image1.png',
      'image2@2x.jpg *',
      '',
    ])
    rump.reconfigure({images: {retina: false}})
    logs.length = 0
    console.log = newLog
    gulp.start('spec:info')
    console.log = log
    logs.slice(-7).should.eql([
      '',
      '--- Images v0.8.0',
      `Images from test${sep}fixtures${sep}src are minified and copied to tmp`,
      'Affected files:',
      'image1.png',
      'image2@2x.jpg',
      '',
    ])
    rump.reconfigure({paths: {source: {images: 'nonexistant'}}})
    logs.length = 0
    console.log = newLog
    gulp.start('spec:info')
    console.log = log
    logs.length.should.not.be.above(4)

    function newLog(...args) {
      logs.push(stripColor(args.join(' ')))
    }
  })

  it('for building', async() => {
    const originals = await Promise.all([
      readFile('test/fixtures/src/image1.png'),
      readFile('test/fixtures/src/image2@2x.jpg'),
    ])
    let contents, nonRetinaExists
    await new Promise(resolve => {
      gulp.task('postbuild', ['spec:build'], resolve)
      gulp.start('postbuild')
    })
    contents = await Promise.all([
      readFile('tmp/image1.png'),
      readFile('tmp/image2@2x.jpg'),
    ])
    contents.forEach((content, index) => {
      bufferEqual(originals[index], content).should.be.true()
    })
    nonRetinaExists = await exists('tmp/image2.jpg')
    nonRetinaExists.should.be.true()
  })

  describe('for watching', () => {
    let original

    before(async() => {
      original = await readFile('test/fixtures/src/image1.png')
      await new Promise(resolve => {
        gulp.task('postwatch', ['spec:watch'], resolve)
        gulp.start('postwatch')
      })
    })

    beforeEach(() => timeout(1000))

    afterEach(() => writeFile('test/fixtures/src/image1.png', original))

    it('handles updates', async() => {
      let content = await readFile('tmp/image1.png')
      bufferEqual(original, await readFile('tmp/image1.png')).should.be.true()
      content = await readFile('test/fixtures/new/image1.png')
      await timeout(1000)
      await writeFile('test/fixtures/src/image1.png', content)
      await timeout(1000)
      bufferEqual(original, await readFile('tmp/image1.png')).should.be.false()
    })

    it('handles retina images', () => {
      const {width, height} = imageSize('tmp/image2.jpg'),
            retinaSize = imageSize('tmp/image2@2x.jpg')
      retinaSize.width.should.equal(width * 2)
      retinaSize.height.should.equal(height * 2)
    })

    it('handles minification in production', async() => {
      let sourceStat = await stat('test/fixtures/src/image1.png'),
          destinationStat = await stat('tmp/image1.png')
      sourceStat.size.should.equal(destinationStat.size)
      rump.reconfigure({environment: 'production'})
      await timeout(1000)
      await writeFile('test/fixtures/src/image1.png', original)
      await timeout(1000);
      [sourceStat, destinationStat] = await Promise.all([
        stat('test/fixtures/src/image1.png'),
        stat('tmp/image1.png'),
      ])
      sourceStat.size.should.be.above(destinationStat.size)
    })
  })
})