Change register function and add test

Author: mdtusz

src/index.js

@@ -46,21 +46,19 @@ exports.Queue = Plotly.Queue;
 // export d3 used in the bundle
 exports.d3 = require('d3');
 
-Plotly.register({
-    traces: {
-        bar: require('./traces/bar'),
-        box: require('./traces/box'),
-        heatmap: require('./traces/heatmap'),
-        histogram: require('./traces/histogram'),
-        histogram2d: require('./traces/histogram2d'),
-        histogram2dcontour: require('./traces/histogram2dcontour'),
-        pie: require('./traces/pie'),
-        contour: require('./traces/contour'),
-        scatter3d: require('./traces/scatter3d'),
-        surface: require('./traces/surface'),
-        mesh3d: require('./traces/mesh3d'),
-        scattergeo: require('./traces/scattergeo'),
-        choropleth: require('./traces/choropleth'),
-        scattergl: require('./traces/scattergl')
-    }
-});
+Plotly.register([
+    require('./traces/bar'),
+    require('./traces/box'),
+    require('./traces/heatmap'),
+    require('./traces/histogram'),
+    require('./traces/histogram2d'),
+    require('./traces/histogram2dcontour'),
+    require('./traces/pie'),
+    require('./traces/contour'),
+    require('./traces/scatter3d'),
+    require('./traces/surface'),
+    require('./traces/mesh3d'),
+    require('./traces/scattergeo'),
+    require('./traces/choropleth'),
+    require('./traces/scattergl')
+]);

src/plotly.js

@@ -46,8 +46,8 @@ var Gl3d = require('./plots/gl3d');
 Plots.registerSubplot(Gl3d);
 
 var Gl2d = require('./plots/gl2d');
-
 Plots.registerSubplot(Gl2d);
+
 exports.Axes = require('./plots/cartesian/axes');
 exports.Fx = require('./plots/cartesian/graph_interact');
 exports.micropolar = require('./plots/polar/micropolar');
@@ -65,21 +65,27 @@ exports.Titles = require('./components/titles');
 exports.Legend = require('./components/legend');
 exports.ModeBar = require('./components/modebar');
 
-// Traces are registered in index.js
-exports.register = function register(options) {
-    if(!options || options === {}){
-        throw new Error('You must pass a config object to Plotly.register.');
+exports.register = function register(_modules) {
+    if(!_modules){
+        throw new Error('No argument passed to Plotly.register.');
+    } else if(_modules && !Array.isArray(_modules)){
+        _modules = [_modules];
     }
 
-    for(var trace in options.traces){
-        var newTrace = options.traces[trace];
-        Plots.register(newTrace, newTrace._type, newTrace._categories, newTrace._meta);
+
+    for(var i = 0; i < _modules.length; i++){
+        var newModule = _modules[i];
+
+        if(newModule && newModule.moduleType !== 'trace'){
+            throw new Error('Invalid module was attempted to be registered!');
+        } else {
+            Plots.register(newModule, newModule.name, newModule.categories, newModule.meta);
+        }
     }
 };
 
-exports.register({
-    traces: [require('./traces/scatter')]
-});
+
+exports.register(require('./traces/scatter'));
 
 // Scatter is the only trace included by default
 exports.Scatter = Plots.getModule('scatter');

test/jasmine/tests/register_test.js

@@ -0,0 +1,48 @@
+var Plotly = require('@src/plotly');
+
+describe('the register function', function() {
+
+    it('should throw an error when no argument is given', function() {
+        expect(function() {
+            Plotly.register();
+        }).toThrowError(Error, 'No argument passed to Plotly.register.');
+    });
+
+    it('should work with a single module', function() {
+        var mockTrace1 = {
+            moduleType: 'trace',
+            name: 'mockTrace1',
+            meta: 'Meta string',
+            categories: ['categories', 'array']
+        };
+
+        expect(function() {
+            Plotly.register(mockTrace1);
+        }).not.toThrow();
+
+        expect(Plotly.Plots.getModule('mockTrace1')).toBe(mockTrace1);
+    });
+
+    it('should work with an array of modules', function() {
+        var mockTrace2 = {
+            moduleType: 'trace',
+            name: 'mockTrace2',
+            meta: 'Meta string',
+            categories: ['categories', 'array']
+        };
+
+        expect(function() {
+            Plotly.register([mockTrace2]);
+        }).not.toThrow();
+
+        expect(Plotly.Plots.getModule('mockTrace2')).toBe(mockTrace2);
+    });
+
+    it('should throw an error when an invalid module is given', function() {
+        var invalidTrace = { moduleType: 'invalid' };
+
+        expect(function() {
+            Plotly.register([invalidTrace]);
+        }).toThrowError(Error, 'Invalid module was attempted to be registered!');
+    });
+});