address line notes

Author: timelyportfolio

src/plot_api/to_image.js

@@ -6,8 +6,6 @@
 * LICENSE file in the root directory of this source tree.
 */
 
-/*eslint dot-notation: [2, {"allowPattern": "^catch$"}]*/
-
 'use strict';
 
 var Plotly = require('../plotly');
@@ -30,10 +28,18 @@ function toImage(gd, opts) {
         // default to png
         opts.format = opts.format || 'png';
 
-        if(
-            (opts.width && isNumeric(opts.width) && opts.width < 1) ||
-            (opts.height && isNumeric(opts.height) && opts.height < 1)
-        ) {
+        var isSizeGood = function(size) {
+            // undefined and null are valid options
+            if(size === undefined || size === null) {
+                return true;
+            }
+
+            if(isNumeric(size) && size > 1) {
+                return true;
+            }
+        };
+
+        if(!isSizeGood(opts.width) || !isSizeGood(opts.height)) {
             reject(new Error('Height and width should be pixel values.'));
         }
 

src/snapshot/svgtoimg.js

@@ -6,12 +6,12 @@
 * LICENSE file in the root directory of this source tree.
 */
 
-var EventEmitter = require('events').EventEmitter;
-
 'use strict';
 
+var EventEmitter = require('events').EventEmitter;
+
 function svgToImg(opts) {
-  
+
     var ev = opts.emitter || new EventEmitter();
 
     var promise = new Promise(function(resolve, reject) {
@@ -55,15 +55,15 @@ function svgToImg(opts) {
                     reject(new Error('Image format is not jpeg, png or svg'));
                     // eventually remove the ev
                     //  in favor of promises
-                    if(!opts.promise){
-                      return ev.emit('error', 'Image format is not jpeg, png or svg');
+                    if(!opts.promise) {
+                        return ev.emit('error', 'Image format is not jpeg, png or svg');
                     }
             }
             resolve(imgData);
             // eventually remove the ev
             //  in favor of promises
-            if(!opts.promise){
-              ev.emit('success', imgData);
+            if(!opts.promise) {
+                ev.emit('success', imgData);
             }
         };
 
@@ -72,8 +72,8 @@ function svgToImg(opts) {
             reject(err);
             // eventually remove the ev
             //  in favor of promises
-            if(!opts.promise){
-              return ev.emit('error', err);
+            if(!opts.promise) {
+                return ev.emit('error', err);
             }
         };
 
@@ -84,9 +84,9 @@ function svgToImg(opts) {
     //  move to only Promise in 2.0.0
     //  and eliminate the EventEmitter
     if(opts.promise) {
-      return promise;
+        return promise;
     }
-    
+
     return ev;
 }
 

test/jasmine/tests/download_test.js

@@ -54,9 +54,9 @@ describe('Plotly.downloadImage', function() {
 
         // create an observer instance
         var observer = new MutationObserver(function(mutations) {
-          mutations.forEach(function(mutation) {
-              domchanges.push(mutation);
-          });
+            mutations.forEach(function(mutation) {
+                domchanges.push(mutation);
+            });
         });
 
         Plotly.plot(gd, textchartMock.data, textchartMock.layout).then(function(gd) {
@@ -68,17 +68,17 @@ describe('Plotly.downloadImage', function() {
             observer.observe(target, config);
 
             return Plotly.downloadImage(gd, {format: 'jpeg', height: 300, width: 300, filename: 'plotly_download'});
-        }).then(function() {
+        }).then(function(filename) {
             // stop observing
             observer.disconnect();
             // look for an added and removed link
             var linkadded = domchanges[domchanges.length-2].addedNodes[0].outerHTML;
             var linkdeleted = domchanges[domchanges.length-1].removedNodes[0].outerHTML;
 
             // check for a <a element and proper file type
-            expect(linkadded.substr(0,25)).toBe('<a href="data:image/jpeg;');
+            expect(linkadded.split('href="')[1].split('jpeg;')[0]).toEqual('data:image/');
             // check that filename option handled properly
-            expect(linkadded.substr(linkadded.length-26,15)).toBe('plotly_download');
+            expect(filename).toBe('plotly_download.jpeg');
 
             // check that link removed
             expect(linkadded).toBe(linkdeleted);

test/jasmine/tests/toimage_test.js

@@ -5,7 +5,6 @@ var Plotly = require('@lib/index');
 var createGraphDiv = require('../assets/create_graph_div');
 var destroyGraphDiv = require('../assets/destroy_graph_div');
 var subplotMock = require('../../image/mocks/multiple_subplots.json');
-var plot3dMock = require('../../image/mocks/gl3d_bunny.json');
 
 
 describe('Plotly.toImage', function() {
@@ -35,24 +34,28 @@ describe('Plotly.toImage', function() {
         returnValue.then(done);
     });
 
-    it('should throw error with unsupported file type', function(done) {
+    it('should throw error with unsupported file type',function(done) {
         // error should actually come in the svgToImg step
 
         Plotly.plot(gd, subplotMock.data, subplotMock.layout)
             .then(function(gd) {
-                Plotly.toImage(gd, {format: 'x'}).catch(function(err) {
+                Plotly.toImage(gd,{format: 'x'}).catch(function(err) {
                     expect(err.message).toEqual('Image format is not jpeg, png or svg');
                     done();
                 });
             });
 
     });
 
-    it('should throw error with height and width < 1', function(done) {
+    it('should throw error with height and/or width < 1', function(done) {
         // let user know that Plotly expects pixel values
         Plotly.plot(gd, subplotMock.data, subplotMock.layout)
             .then(function(gd) {
-                Plotly.toImage(gd, {height: 0.5}).catch(function(err){
+                return Plotly.toImage(gd, {height: 0.5}).catch(function(err) {
+                    expect(err.message).toEqual('Height and width should be pixel values.');
+                });
+            }).then(function() {
+                Plotly.toImage(gd, {width: 0.5}).catch(function(err) {
                     expect(err.message).toEqual('Height and width should be pixel values.');
                     done();
                 });
@@ -69,16 +72,22 @@ describe('Plotly.toImage', function() {
         Plotly.plot(gd, subplotMock.data, subplotMock.layout).then(function(gd) {
             return Plotly.toImage(gd);
         }).then(function(url) {
-            img.src = url;
-            expect(img.height).toBe(600);
-            expect(img.width).toBe(700);
-            // now provide height and width in opts
-            return Plotly.toImage(gd, {height: 400, width: 400});
+            return new Promise(function(resolve) {
+                img.src = url;
+                img.onload = function() {
+                    expect(img.height).toBe(600);
+                    expect(img.width).toBe(700);
+                };
+                // now provide height and width in opts
+                resolve(Plotly.toImage(gd, {height: 400, width: 400}));
+            });
         }).then(function(url) {
             img.src = url;
-            expect(img.height).toBe(400);
-            expect(img.width).toBe(400);
-            done();
+            img.onload = function() {
+                expect(img.height).toBe(400);
+                expect(img.width).toBe(400);
+                done();
+            };
         });
     });
 
@@ -88,15 +97,15 @@ describe('Plotly.toImage', function() {
         plot.then(function(gd) {
             return Plotly.toImage(gd, {format: 'png'});
         }).then(function(url) {
-            expect(url.substr(0,15)).toBe('data:image/png;');
+            expect(url.split('png')[0]).toBe('data:image/');
             // now do jpeg
             return Plotly.toImage(gd, {format: 'jpeg'});
         }).then(function(url) {
-            expect(url.substr(0,16)).toBe('data:image/jpeg;');
+            expect(url.split('jpeg')[0]).toBe('data:image/');
             // now do webp
             return Plotly.toImage(gd, {format: 'webp'});
         }).then(function(url) {
-            expect(url.substr(0,16)).toBe('data:image/webp;');
+            expect(url.split('webp')[0]).toBe('data:image/');
             // now do svg
             return Plotly.toImage(gd, {format: 'svg'});
         }).then(function(url) {