d3-cloud/test/replicable-layout-spec.js at master · cesine/d3-cloud · GitHub

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
/* globals require, describe, it, expect, console, d3, document, MersenneTwister */
'use strict';

var localdocument;
var locald3;
var d3CloudLayout;
var LocalMersenneTwister;
try {
  localdocument = document;
  locald3 = d3;
  d3CloudLayout = d3.layout.cloud;
  LocalMersenneTwister = MersenneTwister;
} catch (e) {
  var JSDOM = require("jsdom").JSDOM;
  global.document = localdocument = new JSDOM("<!DOCTYPE html><body></body>").window.document;
  locald3 = require("d3");
  d3CloudLayout = require("../");
  LocalMersenneTwister = require("mersenne-twister");
}

describe('Replicable layout', function() {
  var myFewWordsFactory,
    myColorFunction,
    myReproduceableDrawFunction,
    WIDTH = 400,
    HEIGHT = 400,
    SEED = 2;

  // Short hand to build an array of word objects with random importance (as a function to ensure no shared state between the clouds)
  myFewWordsFactory = function(textToUseSoTestingCloudsAreDifferentButGeneratedTheSame) {
    var randomImportanceGenerator = new LocalMersenneTwister(SEED);
    return textToUseSoTestingCloudsAreDifferentButGeneratedTheSame.split(" ")
      .map(function(word) {
        return {
          text: word,
          importance: 10 + randomImportanceGenerator.random() * 90
        };
      });
  };

  myColorFunction = locald3.scale.category20();


  // Declare our own draw function which will be called on the "end" event
  myReproduceableDrawFunction = function(words, element) {
    // if (element && element.children) {
    //   element.innerHTML = "";
    // }
    var svg = locald3.select(element).append("svg");
    svg.attr("width", WIDTH)
      .attr("height", HEIGHT)
      .append("g")
      .attr("transform", "translate(" + WIDTH / 2 + "," + HEIGHT / 2 + ")")
      .selectAll("text")
      .data(words)
      .enter().append("text")
      .style("font-size", function(word) {
        return word.importance + "px";
      })
      .style("font-family", "Impact")
      .style("fill", function(word, i) {
        if (!word.color) {
          word.color = myColorFunction(i);
        }
        return word.color;
      })
      .attr("text-anchor", "middle")
      .attr("transform", function(word) {
        if (!word.transform) {
          word.transform = "translate(" + [word.x, word.y] + ")rotate(" + word.rotate + ")";
        }
        return word.transform;
      })
      .text(function(word) {
        return word.text;
      });
  };


  describe('generate same text data', function() {
    var firstPageLoad = myFewWordsFactory("As a dev I want to be able to generate similar word arrays");
    var secondPageLoad = myFewWordsFactory("As a dev I want to be able to generate similar word arrays");

    it('should have equivalent data', function() {
      expect(secondPageLoad[0].importance).not.toEqual(firstPageLoad[firstPageLoad.length - 1].importance);
      for (var wordIndex = 0; wordIndex < secondPageLoad.length; wordIndex++) {
        expect(secondPageLoad[wordIndex].importance).toEqual(firstPageLoad[wordIndex].importance);
      }
    });

    it('should use the same code but not leak state ', function() {
      expect(firstPageLoad).not.toBe(secondPageLoad);
    });

  });

  describe('Redraw a new random cloud', function() {

    // Hoist all vars
    var myRerenderableCloud,
      redrawNewCloudElement;

    redrawNewCloudElement = localdocument.createElement("div");
    redrawNewCloudElement.setAttribute("id", "redraw-new-cloud");
    localdocument.body.appendChild(redrawNewCloudElement);

    // Ask d3-cloud to make an cloud object for us
    myRerenderableCloud = d3CloudLayout();

    // Configure our cloud with d3 chaining
    myRerenderableCloud
      .size([WIDTH, HEIGHT])
      .words(myFewWordsFactory("As a user I want to be able to remove words and see roughly the same cloud"))
      .padding(5)
      .rotate(function(word) {
        if (word.rotate === null || word.rotate === undefined) {
          word.rotate = ~~(Math.random() * 2) * 90;
        }
        return word.rotate;
      })
      .font("Impact")
      .fontSize(function(word) {
        return word.importance;
      })
      .on("end", function(words) {
        myReproduceableDrawFunction(words, redrawNewCloudElement);
      });

    it('should have its own element', function() {
      expect(redrawNewCloudElement).toBeDefined();
      expect(redrawNewCloudElement.children).toBeDefined();
    });

    it('should have word objects', function() {
      expect(myRerenderableCloud.words().length).toEqual(17);
      expect(myRerenderableCloud.words()[13].text).toEqual('roughly');
      expect(myRerenderableCloud.words()[15].text).toEqual('same');
    });

    it('should add render attributes upon start', function() {
      myRerenderableCloud.start();

      var representativeWord = myRerenderableCloud.words()[15];
      expect(representativeWord.color).toBeDefined();
      expect(representativeWord.transform).toBeDefined();
      expect(representativeWord.rotate).toBeDefined();
      expect(representativeWord.size).toBeDefined();
      expect(representativeWord.padding).toBeDefined();
      expect(representativeWord.width).toBeDefined();
      expect(representativeWord.height).toBeDefined();

      expect(representativeWord.xoff).toBeDefined();
      expect(representativeWord.yoff).toBeDefined();
      expect(representativeWord.x1).toBeDefined();
      expect(representativeWord.y1).toBeDefined();
      expect(representativeWord.x0).toBeDefined();
      expect(representativeWord.y0).toBeDefined();
      expect(representativeWord.x).toBeDefined();
      expect(representativeWord.y).toBeDefined();
    });

    it('should not change word objects render attributes on subsequent start()', function() {
      var wordBeforeRerender = JSON.parse(JSON.stringify(myRerenderableCloud.words()[15]));

      var cleanedWords = myRerenderableCloud.words();
      var removedWord = cleanedWords.splice(13, 1);
      expect(removedWord[0].text).toEqual('roughly');

      myRerenderableCloud.words(cleanedWords);
      expect(myRerenderableCloud.words().length).toEqual(16);

      myRerenderableCloud.start();
      var wordAfterRender = myRerenderableCloud.words()[14];

      expect(wordBeforeRerender.text).toEqual(wordAfterRender.text);
      expect(wordBeforeRerender.value).toEqual(wordAfterRender.value);
      expect(wordBeforeRerender.color).toEqual(wordAfterRender.color);
      expect(wordBeforeRerender.transform).toEqual(wordAfterRender.transform);

      expect(wordBeforeRerender.rotate).toEqual(wordAfterRender.rotate);
      expect(wordBeforeRerender.padding).toEqual(wordAfterRender.padding);

      // If this version of d3.layout.cloud has recursive fit for all words, they might not be the exact same size and therefore width and height
      if (wordBeforeRerender.size === wordAfterRender.size) {
        expect(wordBeforeRerender.size).toEqual(wordAfterRender.size);
        expect(wordBeforeRerender.width).toEqual(wordAfterRender.width);
        expect(wordBeforeRerender.height).toEqual(wordAfterRender.height);
      }

      // These attributes might change but dont seem to affect the render being identical
      // expect(wordBeforeRerender.xoff).toEqual(wordAfterRender.xoff);
      // expect(wordBeforeRerender.yoff).toEqual(wordAfterRender.yoff);
      // expect(wordBeforeRerender.x1).toEqual(wordAfterRender.x1);
      // expect(wordBeforeRerender.y1).toEqual(wordAfterRender.y1);
      // expect(wordBeforeRerender.x0).toEqual(wordAfterRender.x0);
      // expect(wordBeforeRerender.y0).toEqual(wordAfterRender.y0);
      // expect(wordBeforeRerender.x).toEqual(wordAfterRender.x);
      // expect(wordBeforeRerender.y).toEqual(wordAfterRender.y);
    });

  });

  /**
   * https://github.com/jasondavies/d3-cloud/pull/1
   * https://github.com/jasondavies/d3-cloud/pull/8
   * https://github.com/jasondavies/d3-cloud/pull/14
   * https://github.com/jasondavies/d3-cloud/pull/35
   * https://github.com/jasondavies/d3-cloud/pull/45
   * https://github.com/WheatonCS/Lexos/issues/149
   */
  describe('Redraw the same pseudorandom cloud from the same text', function() {
    // Hoist all vars
    var myPseudorandomCloud,
      myPseudorandomCloudsElement,
      myRandomGenerator = new LocalMersenneTwister(SEED),
      myRotateRandomGenerator = new LocalMersenneTwister(SEED),
      mySecondPseudorandomCloud,
      mySecondPseudorandomCloudsElement,
      mySecondRandomGenerator = new LocalMersenneTwister(SEED),
      mySecondRotateRandomGenerator = new LocalMersenneTwister(SEED);

    myPseudorandomCloudsElement = localdocument.createElement("span");
    myPseudorandomCloudsElement.setAttribute("id", "pseudo-random-cloud");
    localdocument.body.appendChild(myPseudorandomCloudsElement);

    mySecondPseudorandomCloudsElement = localdocument.createElement("span");
    mySecondPseudorandomCloudsElement.setAttribute("id", "second-pseudo-random-cloud");
    localdocument.body.appendChild(mySecondPseudorandomCloudsElement);


    // Ask d3-cloud to make an cloud object for us
    myPseudorandomCloud = d3CloudLayout();

    // Configure our cloud with d3 chaining
    myPseudorandomCloud
      .random(function() {
        return myRandomGenerator.random();
      })
      .size([WIDTH, HEIGHT])
      .words(myFewWordsFactory("As a user I want be able to have every draw of the same text look the same"))
      .padding(5)
      .rotate(function(word) {
        if (word.rotate === null || word.rotate === undefined) {
          word.rotate = ~~(myRotateRandomGenerator.random() * 2) * 90;
        }
        return word.rotate;
      })
      .font("Impact")
      .fontSize(function(word) {
        return word.importance;
      })
      .on("end", function(words) {
        myReproduceableDrawFunction(words, myPseudorandomCloudsElement);
      });


    myPseudorandomCloud.start();
    it('should generate a seemingly random cloud', function() {
      var representativeWord = myPseudorandomCloud.words()[15];

      expect(representativeWord).toBeDefined();
      expect(representativeWord).toBe(myPseudorandomCloud.words()[15]);
      expect(representativeWord.rotate).toBeDefined();
      expect(representativeWord.size).toBeDefined();
      expect(representativeWord.padding).toBeDefined();
      expect(representativeWord.width).toBeDefined();
      expect(representativeWord.height).toBeDefined();
    });

    it('should generate a second matching seemingly random cloud', function() {
      // Ask d3-cloud to make an cloud object for us
      mySecondPseudorandomCloud = d3CloudLayout();

      // Configure our cloud with d3 chaining
      mySecondPseudorandomCloud
        .random(function() {
          return mySecondRandomGenerator.random();
        })
        .size([WIDTH, HEIGHT])
        .words(myFewWordsFactory("As a user I want be able to have every draw of the same text look the same"))
        .padding(5)
        .rotate(function(word) {
          if (word.rotate === null || word.rotate === undefined) {
            word.rotate = ~~(mySecondRotateRandomGenerator.random() * 2) * 90;
          }
          return word.rotate;
        })
        .font("Impact")
        .fontSize(function(word) {
          return word.importance;
        })
        .on("end", function(words) {
          myReproduceableDrawFunction(words, mySecondPseudorandomCloudsElement);
        });


      mySecondPseudorandomCloud.start();

      var representativeWord = myPseudorandomCloud.words()[15];
      expect(representativeWord).toBeDefined();
      expect(representativeWord).toBe(myPseudorandomCloud.words()[15]);

      var representativeWordInSecondCloud = mySecondPseudorandomCloud.words()[15];
      expect(representativeWordInSecondCloud).toBeDefined();
      expect(representativeWordInSecondCloud).toBe(mySecondPseudorandomCloud.words()[15]);
      expect(representativeWordInSecondCloud.rotate).toBeDefined();
      expect(representativeWordInSecondCloud.size).toBeDefined();
      expect(representativeWordInSecondCloud.padding).toBeDefined();
      expect(representativeWordInSecondCloud.width).toBeDefined();
      expect(representativeWordInSecondCloud.height).toBeDefined();

      // Make sure that there is NO shared state between clouds, otherwise this proves nothing.
      expect(representativeWordInSecondCloud).not.toBe(representativeWord);

      expect(representativeWordInSecondCloud.text).toEqual(representativeWord.text);
      expect(representativeWordInSecondCloud.value).toEqual(representativeWord.value);
      expect(representativeWordInSecondCloud.rotate).toEqual(representativeWord.rotate);
      expect(representativeWordInSecondCloud.color).toEqual(representativeWord.color);
      expect(representativeWordInSecondCloud.transform).toEqual(representativeWord.transform);
      expect(representativeWordInSecondCloud.size).toEqual(representativeWord.size);
      expect(representativeWordInSecondCloud.padding).toEqual(representativeWord.padding);
      expect(representativeWordInSecondCloud.width).toEqual(representativeWord.width);
      expect(representativeWordInSecondCloud.height).toEqual(representativeWord.height);
      expect(representativeWordInSecondCloud.x).toEqual(representativeWord.x);
      expect(representativeWordInSecondCloud.y).toEqual(representativeWord.y);

    });

  });

  describe('Redraw a persisted cloud', function() {

    // Hoist all vars
    var myPreviousCloudFromAPersistantStore,
      myCloudFromPersistantStore,
      previouslyRenderedCloudElement;

    previouslyRenderedCloudElement = localdocument.createElement("div");
    previouslyRenderedCloudElement.setAttribute("id", "draw-old-cloud");
    localdocument.body.appendChild(previouslyRenderedCloudElement);

    myPreviousCloudFromAPersistantStore = '{"words":[{"text":"previous","importance":65.73438733117655,"font":"Impact","style":"normal","weight":"normal","rotate":0,"size":65,"padding":5,"width":320,"height":130,"xoff":480,"yoff":0,"x1":160,"y1":64,"x0":-160,"y0":-58,"hasText":true,"x":-32,"y":-43,"color":"#ffbb78","transform":"translate(2,-77)rotate(0)"},{"text":"session","importance":20.795548947062343,"font":"Impact","style":"normal","weight":"normal","rotate":90,"size":20,"padding":5,"width":64,"height":89,"xoff":1888,"yoff":0,"x1":32,"y1":43,"x0":-32,"y0":-42,"hasText":true,"x":101,"y":152,"color":"#7f7f7f","transform":"translate(-75,143)rotate(90)"}]}';

    // Ask d3-cloud to make an cloud object for us
    myCloudFromPersistantStore = d3CloudLayout()

    // and configure our cloud with d3 chaining
    myCloudFromPersistantStore.size([WIDTH, HEIGHT])
      .words(JSON.parse(myPreviousCloudFromAPersistantStore).words)
      .padding(5)
      .rotate(function(word) {
        if (word.rotate === null || word.rotate === undefined) {
          word.rotate = ~~(Math.random() * 2) * 90;
        }
        return word.rotate;
      })
      .font("Impact")
      .fontSize(function(word) {
        return word.importance;
      })
      .on("end", function(words) {
        myReproduceableDrawFunction(words, previouslyRenderedCloudElement);
      });

    it('should not change word objects render attributes', function() {
      myCloudFromPersistantStore.start();

      var previousWord = JSON.parse(myPreviousCloudFromAPersistantStore).words[1];
      var reRenderedWord = myCloudFromPersistantStore.words()[1];

      expect(reRenderedWord.text).toEqual(previousWord.text);
      expect(reRenderedWord.value).toEqual(previousWord.value);
      expect(reRenderedWord.rotate).toEqual(previousWord.rotate);
      expect(reRenderedWord.color).toEqual(previousWord.color);
      expect(reRenderedWord.transform).toEqual(previousWord.transform);

      expect(reRenderedWord.size).toEqual(previousWord.size);
      expect(reRenderedWord.padding).toEqual(previousWord.padding);
      expect(reRenderedWord.width).toEqual(previousWord.width);

      // These might be different but the render still looks the same
      // expect(reRenderedWord.height).toEqual(previousWord.height);
      // expect(reRenderedWord.x).toEqual(previousWord.x);
      // expect(reRenderedWord.y).toEqual(previousWord.y);

    });
  });
});