Housecleaning, preparing for the release

Author: alexindigo

.editorconfig

@@ -0,0 +1,10 @@
+# editorconfig.org
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

.eslintrc

@@ -0,0 +1,33 @@
+{
+  "rules": {
+    "indent": [2, 2],
+    "quotes": [2, "single"],
+    "linebreak-style": [2, "unix"],
+    "semi": [2, "always"],
+    "curly": [2, "all"],
+    "brace-style": [2, "1tbs", { "allowSingleLine": true }],
+    "handle-callback-err": [2, "^err"],
+    "valid-jsdoc": [2, {
+      "requireReturn": false,
+      "requireReturnDescription": false,
+      "prefer": {
+        "return": "returns"
+      }
+    }],
+    "key-spacing": 0,
+    "strict": 0,
+    "no-underscore-dangle": 0,
+    "no-use-before-define": 0,
+    "dot-notation": 0,
+    "eol-last": 0,
+    "no-new": 0,
+    "semi-spacing": 0,
+    "no-multi-spaces": 0,
+    "eqeqeq": 0,
+    "no-mixed-requires": 0
+  },
+  "env": {
+    "node": true,
+    "browser": true
+  }
+}

Makefile

@@ -34,7 +34,7 @@ FormData.prototype.append = function(field, value, options) {
 
   // all that streamy business can't handle numbers
   if (typeof value == 'number') {
-    value = ''+value;
+    value = '' + value;
   }
 
   // https://github.com/felixge/node-form-data/issues/38
@@ -84,8 +84,7 @@ FormData.prototype._trackLength = function(header, value, options) {
   }
 
   // no need to bother with the length
-  if (!options.knownLength)
-  {
+  if (!options.knownLength) {
     this._lengthRetrievers.push(function(next) {
 
       if (value.hasOwnProperty('fd')) {
@@ -102,7 +101,7 @@ FormData.prototype._trackLength = function(header, value, options) {
           // when end specified
           // no need to calculate range
           // inclusive, starts with 0
-          next(null, value.end+1 - (value.start ? value.start : 0));
+          next(null, value.end + 1 - (value.start ? value.start : 0));
 
         // not that fast snoopy
         } else {
@@ -230,14 +229,14 @@ FormData.prototype.getHeaders = function(userHeaders) {
 };
 
 FormData.prototype.getCustomHeaders = function(contentType) {
-    contentType = contentType ? contentType : 'multipart/form-data';
+  contentType = contentType ? contentType : 'multipart/form-data';
 
-    var formHeaders = {
-        'content-type': contentType + '; boundary=' + this.getBoundary(),
-        'content-length': this.getLengthSync()
-    };
+  var formHeaders = {
+    'content-type': contentType + '; boundary=' + this.getBoundary(),
+    'content-length': this.getLengthSync()
+  };
 
-    return formHeaders;
+  return formHeaders;
 };
 
 FormData.prototype.getBoundary = function() {
@@ -318,16 +317,17 @@ FormData.prototype.submit = function(params, cb) {
   // parse provided url if it's string
   // or treat it as options object
   if (typeof params == 'string') {
-    params = parseUrl(params);
 
+    params = parseUrl(params);
     options = populate({
       port: params.port,
       path: params.pathname,
       host: params.hostname
     }, defaults);
-  }
-  else // use custom params
-  {
+
+  // use custom params
+  } else {
+
     options = populate(params, defaults);
     // if no port provided use default one
     if (!options.port) {
@@ -375,10 +375,6 @@ FormData.prototype._error = function(err) {
   }
 };
 
-/*
- * Santa's little helpers
- */
-
 // populates missing values
 function populate(dst, src) {
   for (var prop in src) {

lib/form_data.js

@@ -10,9 +10,11 @@
   "main": "./lib/form_data",
   "browser": "./lib/browser",
   "scripts": {
-    "test": "./test/run.js"
+    "test": "./test/run.js",
+    "lint": "eslint -c .eslintrc {lib/*,test/**/*}.js"
   },
   "pre-commit": [
+    "lint",
     "test"
   ],
   "engines": {
@@ -25,6 +27,7 @@
   },
   "license": "MIT",
   "devDependencies": {
+    "eslint": "^0.24.1",
     "fake": "^0.2.2",
     "far": "^0.0.7",
     "formidable": "^1.0.17",

package.json

@@ -7,7 +7,7 @@ var rootDir = path.join(__dirname, '..');
 common.dir = {
   lib: path.join(rootDir, '/lib'),
   fixture: path.join(rootDir, '/test/fixture'),
-  tmp: path.join(rootDir, '/test/tmp'),
+  tmp: path.join(rootDir, '/test/tmp')
 };
 
 common.assert = require('assert');

test/common.js

@@ -31,40 +31,41 @@ var FIELDS = {
 var fieldsPassed = false;
 
 var server = http.createServer(function(req, res) {
-    var body = '';
-    var boundry = req.headers['content-type'].split('boundary=').pop();
-
-    req.on('data', function (data) { body += data.toString('utf-8'); });
-    req.on('end', function () {
-        // Separate body into individual files/fields and remove leading and trailing content.
-        var fields = body.split(boundry).slice(1, -1);
-
-        assert.ok(fields.length === 4);
-        
-        assert.ok(fields[0].indexOf('name="no_type"') > -1);
-        assert.ok(fields[0].indexOf('Content-Type"') === -1);
-        
-        assert.ok(fields[1].indexOf('name="custom_type"') > -1);
-        assert.ok(fields[1].indexOf('Content-Type: ' + FIELDS.custom_type.expectedType) > -1);
-        
-        assert.ok(fields[2].indexOf('name="default_type"') > -1);
-        assert.ok(fields[2].indexOf('Content-Type: ' + FIELDS.default_type.expectedType) > -1);
-
-        assert.ok(fields[3].indexOf('name="implicit_type"') > -1);
-        assert.ok(fields[3].indexOf('Content-Type: ' + FIELDS.implicit_type.expectedType) > -1);
-    
-        fieldsPassed = true;
-        res.end();
-    });
+  var body = '';
+  var boundry = req.headers['content-type'].split('boundary=').pop();
 
+  req.on('data', function (data) { body += data.toString('utf-8'); });
+  req.on('end', function () {
+    // Separate body into individual files/fields and remove leading and trailing content.
+    var fields = body.split(boundry).slice(1, -1);
+
+    assert.ok(fields.length === 4);
+
+    assert.ok(fields[0].indexOf('name="no_type"') > -1);
+    assert.ok(fields[0].indexOf('Content-Type"') === -1);
+
+    assert.ok(fields[1].indexOf('name="custom_type"') > -1);
+    assert.ok(fields[1].indexOf('Content-Type: ' + FIELDS.custom_type.expectedType) > -1);
+
+    assert.ok(fields[2].indexOf('name="default_type"') > -1);
+    assert.ok(fields[2].indexOf('Content-Type: ' + FIELDS.default_type.expectedType) > -1);
+
+    assert.ok(fields[3].indexOf('name="implicit_type"') > -1);
+    assert.ok(fields[3].indexOf('Content-Type: ' + FIELDS.implicit_type.expectedType) > -1);
+
+    fieldsPassed = true;
+    res.end();
+  });
 });
 
 server.listen(common.port, function() {
 
   var form = new FormData();
-  
+
   var field;
   for (var name in FIELDS) {
+    if (!FIELDS.hasOwnProperty(name)) { continue; }
+
     field = FIELDS[name];
     // important to append ReadStreams within the same tick
     if ((typeof field.value == 'function')) {
@@ -95,4 +96,4 @@ server.listen(common.port, function() {
 
 process.on('exit', function() {
   assert.ok(fieldsPassed);
-});
+});

test/integration/test-custom-content-type.js

@@ -22,21 +22,21 @@ var server = http.createServer(function(req, res) {
   var form = new IncomingForm({uploadDir: common.dir.tmp});
 
   form.parse(req, function (err, fields, files) {
-      assert(!err);
-    
-      assert('my_file1' in files);
-      assert.strictEqual(files['my_file1'].name, options.filename);
-      assert.strictEqual(files['my_file1'].type, options.contentType);
+    assert(!err);
 
-      assert('my_file2' in files);
-      assert.strictEqual(files['my_file2'].name, options.filename);
-      assert.strictEqual(files['my_file2'].type, mime.lookup(options.filename));
+    assert('my_file1' in files);
+    assert.strictEqual(files['my_file1'].name, options.filename);
+    assert.strictEqual(files['my_file1'].type, options.contentType);
 
-      assert('my_file3' in files);
-      assert.strictEqual(files['my_file3'].type, FormData.DEFAULT_CONTENT_TYPE);
+    assert('my_file2' in files);
+    assert.strictEqual(files['my_file2'].name, options.filename);
+    assert.strictEqual(files['my_file2'].type, mime.lookup(options.filename));
 
-      res.writeHead(200);
-      res.end('done');
+    assert('my_file3' in files);
+    assert.strictEqual(files['my_file3'].type, FormData.DEFAULT_CONTENT_TYPE);
+
+    res.writeHead(200);
+    res.end('done');
   });
 });
 

test/integration/test-custom-filename.js

@@ -17,8 +17,6 @@ var expectedLength;
 
 
 var server = http.createServer(function(req, res) {
-  var data = '';
-
   assert.ok( typeof req.headers['content-length'] !== 'undefined' );
   assert.equal(req.headers['content-length'], expectedLength);
 

test/integration/test-custom-headers.js

@@ -10,11 +10,11 @@ var http = require('http');
 
   var form = new FormData();
 
-  var callback = fake.callback(arguments.callee.name + '-onError-append');
+  var callback = fake.callback('testAppendArray-onError-append');
   fake.expectAnytime(callback, ['Arrays are not supported.']);
 
   form.on('error', function(err) {
-    // workaroud for expectAnytime handling objects
+    // workaround for expectAnytime handling objects
     callback(err.message);
   });
 
@@ -49,7 +49,7 @@ var http = require('http');
   expectedLength += form._overheadLength + form._lastBoundary().length;
 
 
-  var callback = fake.callback(arguments.callee.name + '-onError-getLengthSync');
+  var callback = fake.callback('testGetLengthSync-onError-getLengthSync');
   fake.expectAnytime(callback, ['Cannot calculate proper length in synchronous way.']);
 
   form.on('error', function(err) {

test/integration/test-errors.js

@@ -1,7 +1,6 @@
 var common = require('../common');
 var assert = common.assert;
 var FormData = require(common.dir.lib + '/form_data');
-var fake = require('fake').create();
 var fs = require('fs');
 
 (function testGetLengthSync() {
@@ -25,7 +24,7 @@ var fs = require('fs');
 
   fields.forEach(function(field) {
     form.append(field.name, field.value);
-    expectedLength += (''+field.value).length;
+    expectedLength += ('' + field.value).length;
   });
 
   expectedLength += form._overheadLength + form._lastBoundary().length;
@@ -65,7 +64,7 @@ var fs = require('fs');
       var stat = fs.statSync(field.value.path);
       expectedLength += stat.size;
     } else {
-      expectedLength += (''+field.value).length;
+      expectedLength += ('' + field.value).length;
     }
   });
   expectedLength += form._overheadLength + form._lastBoundary().length;

test/integration/test-form-get-length-sync.js

@@ -6,7 +6,7 @@ var fs = require('fs');
 
 (function testEmptyForm() {
   var form = new FormData();
-  var callback = fake.callback(arguments.callee.name + '-getLength');
+  var callback = fake.callback('testEmptyForm-getLength');
   var calls = fake.expectAnytime(callback, [null, 0]).calls;
 
   form.getLength(callback);
@@ -21,7 +21,7 @@ var fs = require('fs');
 
   var form = new FormData();
   form.append(FIELD, VALUE);
-  var callback = fake.callback(arguments.callee.name + '-getLength');
+  var callback = fake.callback('testUtf8String-getLength');
 
   var expectedLength =
     form._overheadLength +
@@ -38,7 +38,7 @@ var fs = require('fs');
 
   var form = new FormData();
   form.append(FIELD, VALUE);
-  var callback = fake.callback(arguments.callee.name + '-getLength');
+  var callback = fake.callback('testBuffer-getLength');
 
   var expectedLength =
     form._overheadLength +
@@ -54,20 +54,20 @@ var fs = require('fs');
   var fields = [
     {
       name: 'my_field',
-      value: 'Test 123',
+      value: 'Test 123'
     },
     {
       name: 'my_image',
-      value: fs.createReadStream(common.dir.fixture + '/unicycle.jpg'),
+      value: fs.createReadStream(common.dir.fixture + '/unicycle.jpg')
     },
     {
       name: 'my_buffer',
-      value: new Buffer('123'),
+      value: new Buffer('123')
     },
     {
       name: 'my_txt',
-      value: fs.createReadStream(common.dir.fixture + '/veggies.txt'),
-    },
+      value: fs.createReadStream(common.dir.fixture + '/veggies.txt')
+    }
   ];
 
   var form = new FormData();
@@ -85,7 +85,7 @@ var fs = require('fs');
 
   expectedLength += form._overheadLength + form._lastBoundary().length;
 
-  var callback = fake.callback(arguments.callee.name + '-getLength');
+  var callback = fake.callback('testStringFileBufferFile-getLength');
   fake.expectAnytime(callback, [null, expectedLength]);
   form.getLength(callback);
 })();