test/color/hcl-test.js

var vows = require("vows"),
    _ = require("../../"),
    load = require("../load"),
    assert = require("../assert");

var suite = vows.describe("d3.hcl");

suite.addBatch({
  "hcl": {
    topic: load("color/hcl").expression("d3.hcl"),
    "converts string channel values to numbers": function(hcl) {
      assert.hclEqual(hcl("50", "-4", "32"), 50, -4, 32);
    },
    "converts null channel values to zero": function(hcl) {
      assert.hclEqual(hcl(null, null, null), 0, 0, 0);
    },
    "exposes h, c and l properties": function(hcl) {
      var color = hcl(50, -4, 32);
      assert.equal(color.h, 50);
      assert.equal(color.c, -4);
      assert.equal(color.l, 32);
    },
    "changing h, c or l affects the string format": function(hcl) {
      var color = hcl(50, -4, 32);
      assert.equal(color + "", "#444d50");
      color.h++;
      assert.equal(color + "", "#444d50");
      color.c++;
      assert.equal(color + "", "#464c4f");
      color.l++;
      assert.equal(color + "", "#494f51");
    },
    "parses hexadecimal shorthand format (e.g., \"#abc\")": function(hcl) {
      assert.hclEqual(hcl("#abc"), -102.28223831811077, 10.774886733325554, 75.10497524893663);
    },
    "parses hexadecimal format (e.g., \"#abcdef\")": function(hcl) {
      assert.hclEqual(hcl("#abcdef"), -100.15785184209284, 20.768234621934273, 81.04386565274363);
    },
    "parses HSL format (e.g., \"hsl(210, 64%, 13%)\")": function(hcl) {
      assert.hclEqual(hcl("hsl(210, 64.7058%, 13.33333%)"), -89.58282792342067, 16.833655998102003, 12.65624852526134);
    },
    "parses color names (e.g., \"moccasin\")": function(hcl) {
      assert.hclEqual(hcl("moccasin"), 84.71288921124494, 26.472460854104156, 91.72317744746022);
    },
    "parses and converts RGB format (e.g., \"rgb(102, 102, 0)\")": function(hcl) {
      assert.hclEqual(hcl("rgb(102, 102, 0)"), 102.85124420310271, 49.44871600399321, 41.73251953866431);
    },
    "can convert from RGB": function(hcl) {
      assert.hclEqual(hcl(_.rgb(12, 34, 56)), -89.58282792342067, 16.833655998102003, 12.65624852526134);
    },
    "can convert from HSL": function(hcl) {
      assert.hclEqual(hcl(hcl(20, .8, .3)), 20, 0.8, 0.3);
    },
    "can convert to RGB": function(hcl) {
      assert.rgbEqual(hcl("steelblue").rgb(), 70, 130, 180);
    },
    "can derive a brighter color": function(hcl) {
      assert.hclEqual(hcl("steelblue").brighter(), -97.21873224090723, 32.44906314974561, 70.46551718768575);
      assert.hclEqual(hcl("steelblue").brighter(.5), -97.21873224090723, 32.44906314974561, 61.46551718768575);
    },
    "can derive a darker color": function(hcl) {
      assert.hclEqual(hcl("lightsteelblue").darker(), -94.8160116310511, 15.26488988314746, 60.45157936968134);
      assert.hclEqual(hcl("lightsteelblue").darker(.5), -94.8160116310511, 15.26488988314746, 69.45157936968134);
    },
    "string coercion returns RGB format": function(hcl) {
      assert.strictEqual(hcl("hsl(60, 100%, 20%)") + "", "#666600");
      assert.strictEqual(hcl(hcl(60, -4, 32)) + "", "#454c51");
    },
    "roundtrip to HSL is idempotent": function(hcl) {
      assert.deepEqual(_.hsl(hcl("steelblue")), _.hsl("steelblue"));
    },
    "roundtrip to RGB is idempotent": function(hcl) {
      assert.deepEqual(_.rgb(hcl("steelblue")), _.rgb("steelblue"));
    },
    "roundtrip to Lab is idempotent": function(hcl) {
      assert.deepEqual(_.lab(hcl("steelblue")), _.lab("steelblue"));
    },
    "h is defined for non-black grayscale colors (because of the color profile)": function(hcl) {
      assert.inDelta(hcl("#ccc").h, 158.1986, 1e-3);
      assert.inDelta(hcl("gray").h, 158.1986, 1e-3);
      assert.inDelta(hcl(_.rgb("gray")).h, 158.1986, 1e-3);
      assert.inDelta(hcl("#fff").h, 158.1986, 1e-3);
      assert.inDelta(hcl("white").h, 158.1986, 1e-3);
      assert.inDelta(hcl(_.rgb("white")).h, 158.1986, 1e-3);
    },
    "h is preserved when explicitly specified, even for black": function(hcl) {
      assert.strictEqual(hcl(0, 0, 0).h, 0);
      assert.strictEqual(hcl(42, 0, 0).h, 42);
      assert.strictEqual(hcl(118, 0, 0).h, 118);
    },
    "h is undefined when not explicitly specified for black": function(hcl) {
      assert.isNaN(hcl("#000").h);
      assert.isNaN(hcl("black").h);
      assert.isNaN(hcl(_.rgb("black")).h);
    },
    "c is preserved when explicitly specified, even for black": function(hcl) {
      assert.strictEqual(hcl(0, 0, 0).c, 0);
      assert.strictEqual(hcl(0, .42, 0).c, .42);
      assert.strictEqual(hcl(0, 1, 0).c, 1);
    },
    "c is undefined when not explicitly specified for black": function(hcl) {
      assert.isNaN(hcl("#000").c);
      assert.isNaN(hcl("black").c);
      assert.isNaN(hcl(_.rgb("black")).c);
    },
    "can convert black (with undefined hue and chroma) to RGB": function(hcl) {
      assert.strictEqual(hcl(NaN, NaN, 0) + "", "#000000");
    }
  }
});

suite.export(module);