Add gravity support to embed feature (#1038)

test/fixtures/index.js

@@ -85,6 +85,7 @@ module.exports = {
   inputPngBooleanNoAlpha: getPath('bandbool.png'),
   inputPngTestJoinChannel: getPath('testJoinChannel.png'),
   inputPngTruncated: getPath('truncated.png'), // gm convert 2569067123_aca715a2ee_o.jpg -resize 320x240 saw.png ; head -c 10000 saw.png > truncated.png
+  inputPngEmbed: getPath('embedgravitybird.png'), // Released to sharp under a CC BY 4.0
 
   inputWebP: getPath('4.webp'), // http://www.gstatic.com/webp/gallery/4.webp
   inputWebPWithTransparency: getPath('5_webp_a.webp'), // http://www.gstatic.com/webp/gallery3/5_webp_a.webp

test/unit/embed.js

@@ -6,6 +6,19 @@ const sharp = require('../../');
 const fixtures = require('../fixtures');
 
 describe('Embed', function () {
+  it('Allows specifying the gravity as a string', function (done) {
+    sharp(fixtures.inputJpg)
+      .resize(320, 240)
+      .embed('center')
+      .png()
+      .toBuffer(function (err, data, info) {
+        if (err) throw err;
+        assert.strictEqual(320, info.width);
+        assert.strictEqual(240, info.height);
+        fixtures.assertSimilar(fixtures.expected('embed-3-into-3.png'), data, done);
+      });
+  });
+
   it('JPEG within PNG, no alpha channel', function (done) {
     sharp(fixtures.inputJpg)
       .embed()
@@ -132,4 +145,313 @@ describe('Embed', function () {
         fixtures.assertSimilar(fixtures.expected('embed-enlarge.png'), data, done);
       });
   });
+
+  it('Embed invalid param values should fail', function () {
+    assert.throws(function () {
+      sharp().embed(-1);
+    });
+    assert.throws(function () {
+      sharp().embed(8.1);
+    });
+    assert.throws(function () {
+      sharp().embed(9);
+    });
+    assert.throws(function () {
+      sharp().embed(1000000);
+    });
+    assert.throws(function () {
+      sharp().embed(false);
+    });
+    assert.throws(function () {
+      sharp().embed('vallejo');
+    });
+  });
+
+  it('Embed gravity horizontal northwest', function (done) {
+    sharp(fixtures.inputPngEmbed)
+    .resize(200, 100)
+    .background({r: 0, g: 0, b: 0, alpha: 0})
+    .embed(sharp.gravity.northwest)
+    .toBuffer(function (err, data, info) {
+      if (err) throw err;
+      assert.strictEqual(true, data.length > 0);
+      assert.strictEqual('png', info.format);
+      assert.strictEqual(200, info.width);
+      assert.strictEqual(100, info.height);
+      assert.strictEqual(4, info.channels);
+      fixtures.assertSimilar(fixtures.expected('./embedgravitybird/a1-nw.png'), data, done);
+    });
+  });
+
+  it('Embed gravity horizontal north', function (done) {
+    sharp(fixtures.inputPngEmbed)
+    .resize(200, 100)
+    .background({r: 0, g: 0, b: 0, alpha: 0})
+    .embed(sharp.gravity.north)
+    .toBuffer(function (err, data, info) {
+      if (err) throw err;
+      assert.strictEqual(true, data.length > 0);
+      assert.strictEqual('png', info.format);
+      assert.strictEqual(200, info.width);
+      assert.strictEqual(100, info.height);
+      assert.strictEqual(4, info.channels);
+      fixtures.assertSimilar(fixtures.expected('./embedgravitybird/a2-n.png'), data, done);
+    });
+  });
+
+  it('Embed gravity horizontal northeast', function (done) {
+    sharp(fixtures.inputPngEmbed)
+    .resize(200, 100)
+    .background({r: 0, g: 0, b: 0, alpha: 0})
+    .embed(sharp.gravity.northeast)
+    .toBuffer(function (err, data, info) {
+      if (err) throw err;
+      assert.strictEqual(true, data.length > 0);
+      assert.strictEqual('png', info.format);
+      assert.strictEqual(200, info.width);
+      assert.strictEqual(100, info.height);
+      assert.strictEqual(4, info.channels);
+      fixtures.assertSimilar(fixtures.expected('./embedgravitybird/a3-ne.png'), data, done);
+    });
+  });
+
+  it('Embed gravity horizontal east', function (done) {
+    sharp(fixtures.inputPngEmbed)
+    .resize(200, 100)
+    .background({r: 0, g: 0, b: 0, alpha: 0})
+    .embed(sharp.gravity.east)
+    .toBuffer(function (err, data, info) {
+      if (err) throw err;
+      assert.strictEqual(true, data.length > 0);
+      assert.strictEqual('png', info.format);
+      assert.strictEqual(200, info.width);
+      assert.strictEqual(100, info.height);
+      assert.strictEqual(4, info.channels);
+      fixtures.assertSimilar(fixtures.expected('./embedgravitybird/a4-e.png'), data, done);
+    });
+  });
+
+  it('Embed gravity horizontal southeast', function (done) {
+    sharp(fixtures.inputPngEmbed)
+    .resize(200, 100)
+    .background({r: 0, g: 0, b: 0, alpha: 0})
+    .embed(sharp.gravity.southeast)
+    .toBuffer(function (err, data, info) {
+      if (err) throw err;
+      assert.strictEqual(true, data.length > 0);
+      assert.strictEqual('png', info.format);
+      assert.strictEqual(200, info.width);
+      assert.strictEqual(100, info.height);
+      assert.strictEqual(4, info.channels);
+      fixtures.assertSimilar(fixtures.expected('./embedgravitybird/a5-se.png'), data, done);
+    });
+  });
+
+  it('Embed gravity horizontal south', function (done) {
+    sharp(fixtures.inputPngEmbed)
+    .resize(200, 100)
+    .background({r: 0, g: 0, b: 0, alpha: 0})
+    .embed(sharp.gravity.south)
+    .toBuffer(function (err, data, info) {
+      if (err) throw err;
+      assert.strictEqual(true, data.length > 0);
+      assert.strictEqual('png', info.format);
+      assert.strictEqual(200, info.width);
+      assert.strictEqual(100, info.height);
+      assert.strictEqual(4, info.channels);
+      fixtures.assertSimilar(fixtures.expected('./embedgravitybird/a6-s.png'), data, done);
+    });
+  });
+
+  it('Embed gravity horizontal southwest', function (done) {
+    sharp(fixtures.inputPngEmbed)
+    .resize(200, 100)
+    .background({r: 0, g: 0, b: 0, alpha: 0})
+    .embed(sharp.gravity.southwest)
+    .toBuffer(function (err, data, info) {
+      if (err) throw err;
+      assert.strictEqual(true, data.length > 0);
+      assert.strictEqual('png', info.format);
+      assert.strictEqual(200, info.width);
+      assert.strictEqual(100, info.height);
+      assert.strictEqual(4, info.channels);
+      fixtures.assertSimilar(fixtures.expected('./embedgravitybird/a7-sw.png'), data, done);
+    });
+  });
+
+  it('Embed gravity horizontal west', function (done) {
+    sharp(fixtures.inputPngEmbed)
+    .resize(200, 100)
+    .background({r: 0, g: 0, b: 0, alpha: 0})
+    .embed(sharp.gravity.west)
+    .toBuffer(function (err, data, info) {
+      if (err) throw err;
+      assert.strictEqual(true, data.length > 0);
+      assert.strictEqual('png', info.format);
+      assert.strictEqual(200, info.width);
+      assert.strictEqual(100, info.height);
+      assert.strictEqual(4, info.channels);
+      fixtures.assertSimilar(fixtures.expected('./embedgravitybird/a8-w.png'), data, done);
+    });
+  });
+
+  it('Embed gravity horizontal center', function (done) {
+    sharp(fixtures.inputPngEmbed)
+    .resize(200, 100)
+    .background({r: 0, g: 0, b: 0, alpha: 0})
+    .embed(sharp.gravity.center)
+    .toBuffer(function (err, data, info) {
+      if (err) throw err;
+      assert.strictEqual(true, data.length > 0);
+      assert.strictEqual('png', info.format);
+      assert.strictEqual(200, info.width);
+      assert.strictEqual(100, info.height);
+      assert.strictEqual(4, info.channels);
+      fixtures.assertSimilar(fixtures.expected('./embedgravitybird/a9-c.png'), data, done);
+    });
+  });
+
+  it('Embed gravity vertical northwest', function (done) {
+    sharp(fixtures.inputPngEmbed)
+    .resize(200, 200)
+    .background({r: 0, g: 0, b: 0, alpha: 0})
+    .embed(sharp.gravity.northwest)
+    .toBuffer(function (err, data, info) {
+      if (err) throw err;
+      assert.strictEqual(true, data.length > 0);
+      assert.strictEqual('png', info.format);
+      assert.strictEqual(200, info.width);
+      assert.strictEqual(200, info.height);
+      assert.strictEqual(4, info.channels);
+      fixtures.assertSimilar(fixtures.expected('./embedgravitybird/1-nw.png'), data, done);
+    });
+  });
+
+  it('Embed gravity vertical north', function (done) {
+    sharp(fixtures.inputPngEmbed)
+    .resize(200, 200)
+    .background({r: 0, g: 0, b: 0, alpha: 0})
+    .embed(sharp.gravity.north)
+    .toBuffer(function (err, data, info) {
+      if (err) throw err;
+      assert.strictEqual(true, data.length > 0);
+      assert.strictEqual('png', info.format);
+      assert.strictEqual(200, info.width);
+      assert.strictEqual(200, info.height);
+      assert.strictEqual(4, info.channels);
+      fixtures.assertSimilar(fixtures.expected('./embedgravitybird/2-n.png'), data, done);
+    });
+  });
+
+  it('Embed gravity vertical northeast', function (done) {
+    sharp(fixtures.inputPngEmbed)
+    .resize(200, 200)
+    .background({r: 0, g: 0, b: 0, alpha: 0})
+    .embed(sharp.gravity.northeast)
+    .toBuffer(function (err, data, info) {
+      if (err) throw err;
+      assert.strictEqual(true, data.length > 0);
+      assert.strictEqual('png', info.format);
+      assert.strictEqual(200, info.width);
+      assert.strictEqual(200, info.height);
+      assert.strictEqual(4, info.channels);
+      fixtures.assertSimilar(fixtures.expected('./embedgravitybird/3-ne.png'), data, done);
+    });
+  });
+
+  it('Embed gravity vertical east', function (done) {
+    sharp(fixtures.inputPngEmbed)
+    .resize(200, 200)
+    .background({r: 0, g: 0, b: 0, alpha: 0})
+    .embed(sharp.gravity.east)
+    .toBuffer(function (err, data, info) {
+      if (err) throw err;
+      assert.strictEqual(true, data.length > 0);
+      assert.strictEqual('png', info.format);
+      assert.strictEqual(200, info.width);
+      assert.strictEqual(200, info.height);
+      assert.strictEqual(4, info.channels);
+      fixtures.assertSimilar(fixtures.expected('./embedgravitybird/4-e.png'), data, done);
+    });
+  });
+
+  it('Embed gravity vertical southeast', function (done) {
+    sharp(fixtures.inputPngEmbed)
+    .resize(200, 200)
+    .background({r: 0, g: 0, b: 0, alpha: 0})
+    .embed(sharp.gravity.southeast)
+    .toBuffer(function (err, data, info) {
+      if (err) throw err;
+      assert.strictEqual(true, data.length > 0);
+      assert.strictEqual('png', info.format);
+      assert.strictEqual(200, info.width);
+      assert.strictEqual(200, info.height);
+      assert.strictEqual(4, info.channels);
+      fixtures.assertSimilar(fixtures.expected('./embedgravitybird/5-se.png'), data, done);
+    });
+  });
+
+  it('Embed gravity vertical south', function (done) {
+    sharp(fixtures.inputPngEmbed)
+    .resize(200, 200)
+    .background({r: 0, g: 0, b: 0, alpha: 0})
+    .embed(sharp.gravity.south)
+    .toBuffer(function (err, data, info) {
+      if (err) throw err;
+      assert.strictEqual(true, data.length > 0);
+      assert.strictEqual('png', info.format);
+      assert.strictEqual(200, info.width);
+      assert.strictEqual(200, info.height);
+      assert.strictEqual(4, info.channels);
+      fixtures.assertSimilar(fixtures.expected('./embedgravitybird/6-s.png'), data, done);
+    });
+  });
+
+  it('Embed gravity vertical southwest', function (done) {
+    sharp(fixtures.inputPngEmbed)
+    .resize(200, 200)
+    .background({r: 0, g: 0, b: 0, alpha: 0})
+    .embed(sharp.gravity.southwest)
+    .toBuffer(function (err, data, info) {
+      if (err) throw err;
+      assert.strictEqual(true, data.length > 0);
+      assert.strictEqual('png', info.format);
+      assert.strictEqual(200, info.width);
+      assert.strictEqual(200, info.height);
+      assert.strictEqual(4, info.channels);
+      fixtures.assertSimilar(fixtures.expected('./embedgravitybird/7-sw.png'), data, done);
+    });
+  });
+
+  it('Embed gravity vertical west', function (done) {
+    sharp(fixtures.inputPngEmbed)
+    .resize(200, 200)
+    .background({r: 0, g: 0, b: 0, alpha: 0})
+    .embed(sharp.gravity.west)
+    .toBuffer(function (err, data, info) {
+      if (err) throw err;
+      assert.strictEqual(true, data.length > 0);
+      assert.strictEqual('png', info.format);
+      assert.strictEqual(200, info.width);
+      assert.strictEqual(200, info.height);
+      assert.strictEqual(4, info.channels);
+      fixtures.assertSimilar(fixtures.expected('./embedgravitybird/8-w.png'), data, done);
+    });
+  });
+
+  it('Embed gravity vertical center', function (done) {
+    sharp(fixtures.inputPngEmbed)
+    .resize(200, 200)
+    .background({r: 0, g: 0, b: 0, alpha: 0})
+    .embed(sharp.gravity.center)
+    .toBuffer(function (err, data, info) {
+      if (err) throw err;
+      assert.strictEqual(true, data.length > 0);
+      assert.strictEqual('png', info.format);
+      assert.strictEqual(200, info.width);
+      assert.strictEqual(200, info.height);
+      assert.strictEqual(4, info.channels);
+      fixtures.assertSimilar(fixtures.expected('./embedgravitybird/9-c.png'), data, done);
+    });
+  });
 });