Adding basic testing routine

Yomguithereal · Yomguithereal · commit c32f6c823a21 · 2016-09-11T19:35:05.000+02:00
diff --git a/package.json b/package.json
@@ -5,6 +5,9 @@
   "homepage": "http://sigmajs.org",
   "bugs": "http://github.com/jacomyal/sigma.js/issues",
   "main": "dist/sigma.js",
+  "scripts": {
+    "test": "mocha --compilers js:babel-core/register ./test/endpoint.js"
+  },
   "repository": {
     "type": "git",
     "url": "http://github.com/jacomyal/sigma.js.git"
@@ -21,10 +24,15 @@
   ],
   "license": "MIT",
   "devDependencies": {
+    "babel-core": "^6.14.0",
+    "babel-preset-es2015": "^6.14.0",
     "graphology": "0.0.4",
     "mocha": "^3.0.2"
   },
   "keywords": [
     "graph"
-  ]
+  ],
+  "babel": {
+    "presets": ["es2015"]
+  }
 }
diff --git a/src/reducers.js b/src/reducers.js
@@ -0,0 +1,21 @@
+/**
+ * Sigma.js Reducers
+ * ==================
+ *
+ * Internal reducers mostly used to map well-known attributes by default &
+ * apply some settings before giving the resulting data to renderers.
+ */
+
+/**
+ * Internal node reducer.
+ *
+ * @param {Sigma} controller - Sigma instance.
+ * @param {Graph} graph      - The bound graph.
+ * @param {any}   node       - The node to reduce.
+ */
+export function internalNodeReducer(controller, graph, node) {
+  return {
+    x: 1,
+    y: 1
+  };
+}
diff --git a/src/sigma.js b/src/sigma.js
@@ -6,9 +6,31 @@
  * a renderer & camera to display the bound graph on screen.
  */
 import Camera from './camera';
-import {isGraph} from './utils';
+import {internalNodeReducer} from './reducers';
+import {assign, isGraph} from './utils';
 
 // TODO: possibility to pass a camera
+// TODO: distinguish with events, full refresh vs. draw
+
+/**
+ * Helper functions not registered as methods not to overload the prototype
+ * and preventing sneaky users to abuse them.
+ */
+function initializeIndex(map, elements) {
+  const index = map ? new Map() : {};
+
+  for (let i = 0, l = elements.length; i < l; i++) {
+    const element = elements[i],
+          object = {computed: {}, state: {}};
+
+    if (map)
+      index.set(element, object);
+    else
+      index[element] = object;
+  }
+
+  return index;
+}
 
 /**
  * Sigma class
@@ -25,7 +47,15 @@ export default class Sigma {
 
     // Properties
     this.graph = graph;
+    this.map = this.graph.map;
     this.camera = new Camera();
+
+    this.state = {};
+    this.nodesIndex = initializeIndex(this.map, graph.nodes());
+    this.edgesIndex = initializeIndex(this.map, graph.edges());
+
+    this.nodeReducers = [internalNodeReducer];
+    this.edgeReducers = [];
   }
 
   /**---------------------------------------------------------------------------
@@ -50,4 +80,38 @@ export default class Sigma {
   getCamera() {
     return this.camera;
   }
+
+  /**---------------------------------------------------------------------------
+   * Drawing
+   **---------------------------------------------------------------------------
+   */
+
+  /**
+   * Method used to refresh display of the graph.
+   *
+   * @return {Sigma} - Returns itself for chaining.
+   */
+  refresh() {
+    const nodes = this.graph.nodes(),
+          egdes = this.graph.edges();
+
+    // 1-- We need to compute reducers
+    for (let i = 0, l = nodes.length; i < l; i++) {
+      const node = nodes[i];
+      let data = {};
+
+      // Applying every reducers
+      for (let j = 0, m = this.nodeReducers.length; j < m; j++) {
+        const reducer = this.nodeReducers[j];
+
+        assign(data, reducer(this, this.graph, node));
+      }
+
+      // Storing computed data
+      if (this.map)
+        this.nodesIndex.get(node).computed = data;
+      else
+        this.nodesIndex[node].computed = data;
+    }
+  }
 }
diff --git a/src/utils.js b/src/utils.js
@@ -5,6 +5,27 @@
  * Various helper functions & classes used throughout the library.
  */
 
+/**
+ * Very simple Object.assign-like function.
+ *
+ * @param  {object} target       - First object.
+ * @param  {object} [...objects] - Objects to merge.
+ * @return {object}
+ */
+export function assign(target, ...objects) {
+  target = target || {};
+
+  for (let i = 0, l = objects.length; i < l; i++) {
+    if (!objects[i])
+      continue;
+
+    for (const k in objects[i])
+      target[k] = objects[i][k];
+  }
+
+  return target;
+}
+
 /**
  * Function returning whether the given value is a graphology Graph instance.
  *
diff --git a/test/endpoint.js b/test/endpoint.js
@@ -0,0 +1,14 @@
+/**
+ * Sigma.js Unit Tests Endpoint
+ * =============================
+ *
+ * Registering every unit test.
+ */
+const util = require('util');
+
+if (util.inspect.defaultOptions)
+  util.inspect.defaultOptions.depth = null;
+
+require('./sigma.js');
+
+
diff --git a/test/sigma.js b/test/sigma.js
@@ -0,0 +1,34 @@
+/**
+ * Sigma.js Core Unit Tests
+ * =========================
+ *
+ * Testing the core class.
+ */
+import assert from 'assert';
+import Graph from 'graphology';
+import Sigma from '../src/sigma';
+
+const graph = new Graph();
+graph.addNodesFrom(['John', 'Mary', 'Martha']);
+
+const sigma = new Sigma(graph);
+sigma.refresh();
+
+console.log(sigma);
+
+describe('Sigma', function() {
+
+  describe('instantiation', function() {
+
+    it('should throw if the given graph is invalid.', function() {
+
+      assert.throws(function() {
+        const sigma = new Sigma();
+      }, /graphology/);
+
+      assert.throws(function() {
+        const sigma = new Sigma(null);
+      }, /graphology/);
+    });
+  });
+});
