Fixes #34. Updated HISTORY file. Updated create_mock_dbs script to have travis build sqlserver as well (hopefull).

Author: Kyle Farris

HISTORY.md

@@ -6,16 +6,26 @@ you spot any mistakes.
 
 ## v2.0.0 (2018-06-15)
 
-* Added mssql support
-* Updated class files to use new ES6 class syntax for easier-maintainability
+### Breaking Changes
 * Changed the Query Builder instantiation syntax
+* Passing an empty array to `where_in` and `where_not_in` no longer throws an error ([#34](https://github.com/kylefarris/node-querybuilder/issues/34))
+
+# General Enhancements/Changes/Features
+* Added mssql (t-sql) support using `tedious` as the underlying driver
+* Updated class files to use new ES6 class syntax for easier-maintainability
 * Added new options:
 ** `pool_min` (minimum number of pooled connections (`mssql` driver only))
 ** `acquireTimeout` (milliseconds before a timeout occurs during the connection acquisition)
 * Added new query building method: `returning()` to allow for insert IDs to be returned. See docs for more info.
 * Added new tests
+
+### Bug Fixes
 * Fixed [#18](https://github.com/kylefarris/node-querybuilder/issues/18)
+* Fixed [#23](https://github.com/kylefarris/node-querybuilder/issues/23)
 * Fixed [#26](https://github.com/kylefarris/node-querybuilder/issues/26)
+* Fixed [#28](https://github.com/kylefarris/node-querybuilder/issues/28)
+* Fixed [#30](https://github.com/kylefarris/node-querybuilder/issues/30)
+* Fixed [#33](https://github.com/kylefarris/node-querybuilder/issues/33)
 
 
 ## v1.2.0 (2018-05-18)

Makefile

@@ -1,5 +1,5 @@
 TESTS = test/mysql/*.js test/mssql/*.js test/*.js
-#TESTS = test/mssql/01-tests-like.js
+#TESTS = test/mssql/01-tests-where_in.js
 #TESTS = test/05-multiple-drivers.js
 test:
 	mocha --timeout 5000 --reporter spec $(TESTS)

drivers/query_builder.js

@@ -540,21 +540,19 @@ class GenericQueryBuilder {
            throw new Error("where_" + (not === '' ? '' : not.toLowerCase() + '_') + "in(): Invalid field name provided.");
        }
 
-       // Values must be an array...
+       // `values` must be an array...
        if (!Array.isArray(values)) {
-           throw new Error("where_" + (not === '' ? '' : not.toLowerCase() + '_') + "in(): Invalid second parameter provided--it must be an array of scalar values.");
-       }
-       else {
-           if (values.length == 0) {
-               throw new Error("where_" + (not === '' ? '' : not.toLowerCase() + '_') + "in(): You have provided an empty list of values to limit resultset by.");
-           }
+           throw new Error("where_" + (not === '' ? '' : not.toLowerCase() + '_') + "in(): Invalid second parameter provided--it must be an array of scalar values or an empty array.");
        }
 
+       // If array is empty, ignore this request
+       else if (values.length === 0) return;
+
        for (let i in values) {
            this.where_in_array.push(this._qb_escape(values[i]));
        }
 
-       const prefix = (this.where_array.length == 0 ? '' : type);
+       const prefix = (this.where_array.length === 0 ? '' : type);
        const where_in = prefix + this._protect_identifiers(key, false, escape) + not + " IN (" + this.where_in_array.join(', ') + ")";
        this.where_array.push(where_in);
 

test/create_mock_dbs.sh

@@ -1,3 +1,3 @@
 #!/usr/bin/env bash
 ./mysql/create_mysql_mock.sh
-#./mssql/create_mssql_mock.sh
+./mssql/create_mssql_mock.sh

test/mssql/01-tests-where_in.js

@@ -37,7 +37,6 @@ describe('MSSQL: where_in()', () => {
     });
     it('should not accept anything but a non-empty array of values as second parameter', () => {
         qb.reset_query();
-        expect(() => qb.where_in('planet'), 'nothing provided').to.throw(Error);
         expect(() => qb.where_in('planet', null), 'null provided').to.throw(Error);
         expect(() => qb.where_in('planet', false), 'false provided').to.throw(Error);
         expect(() => qb.where_in('planet', true), 'true provided').to.throw(Error);
@@ -47,17 +46,23 @@ describe('MSSQL: where_in()', () => {
         expect(() => qb.where_in('planet', 3.5), 'float provided').to.throw(Error);
         expect(() => qb.where_in('planet', NaN), 'NaN provided').to.throw(Error);
         expect(() => qb.where_in('planet', Infinity), 'Infinity provided').to.throw(Error);
-        expect(() => qb.where_in('planet', []), 'empty array provided').to.throw(Error);
         expect(() => qb.where_in('planet', ''), 'empty string provided').to.throw(Error);
         expect(() => qb.where_in('planet', /foobar/), 'regex provided').to.throw(Error);
 
+        expect(() => qb.where_in('planet'), 'nothing provided (empty array is default value)').to.not.throw(Error);
+        expect(() => qb.where_in('planet', []), 'empty array provided').to.not.throw(Error);
         expect(() => qb.where_in('planet', ['Mars','Earth','Venus','Mercury']), 'non-empty array provided').to.not.throw(Error);
     });
     it('should require both a field name an array of values as first and second parameters, respectively', () => {
         qb.reset_query();
         qb.where_in('planet_position', [1,2,3]);
         qb.where_array.should.eql(['[planet_position] IN (1, 2, 3)']);
     });
+    it('should ignore the request if an empty array is provided to the second parameter', () => {
+        qb.reset_query();
+        qb.where_in('planet_position', []);
+        qb.where_array.should.eql([]);
+    });
     it('should concatenate multiple WHERE IN clauses with AND ', () => {
         qb.reset_query();
         qb.where_in('planet',['Mercury','Venus','Earth','Mars']);

test/mysql/01-tests-where_in.js

@@ -35,9 +35,8 @@ describe('MySQL: where_in()', () => {
 
         expect(() => qb.where_in('planet_position',[1,2,3]), 'valid string provided').to.not.throw(Error);
     });
-    it('should not accept anything but a non-empty array of values as second parameter', () => {
+    it('should not accept anything but an array of values as second parameter', () => {
         qb.reset_query();
-        expect(() => qb.where_in('planet'), 'nothing provided').to.throw(Error);
         expect(() => qb.where_in('planet',null), 'null provided').to.throw(Error);
         expect(() => qb.where_in('planet',false), 'false provided').to.throw(Error);
         expect(() => qb.where_in('planet',true), 'true provided').to.throw(Error);
@@ -47,31 +46,37 @@ describe('MySQL: where_in()', () => {
         expect(() => qb.where_in('planet',3.5), 'float provided').to.throw(Error);
         expect(() => qb.where_in('planet',NaN), 'NaN provided').to.throw(Error);
         expect(() => qb.where_in('planet',Infinity), 'Infinity provided').to.throw(Error);
-        expect(() => qb.where_in('planet',[]), 'empty array provided').to.throw(Error);
         expect(() => qb.where_in('planet',''), 'empty string provided').to.throw(Error);
         expect(() => qb.where_in('planet',/foobar/), 'regex provided').to.throw(Error);
 
-        expect(() => qb.where_in('planet',['Mars','Earth','Venus','Mercury']), 'non-empty array provided').to.not.throw(Error);
+        expect(() => qb.where_in('planet'), 'nothing provided (empty array is default value)').to.not.throw(Error);
+        expect(() => qb.where_in('planet', []), 'empty array provided').to.not.throw(Error);
+        expect(() => qb.where_in('planet', ['Mars','Earth','Venus','Mercury']), 'non-empty array provided').to.not.throw(Error);
     });
-    it('should require both a field name an array of values as first and second parameters, respectively', () => {
+    it('should accept both a field name and array of values as first and second parameters, respectively', () => {
         qb.reset_query();
-        qb.where_in('planet_position',[1,2,3]);
+        qb.where_in('planet_position', [1,2,3]);
         qb.where_array.should.eql(['`planet_position` IN (1, 2, 3)']);
     });
+    it('should ignore the request if an empty array is provided to the second parameter', () => {
+        qb.reset_query();
+        qb.where_in('planet_position', []);
+        qb.where_array.should.eql([]);
+    });
     it('should concatenate multiple WHERE IN clauses with AND ', () => {
         qb.reset_query();
         qb.where_in('planet',['Mercury','Venus','Earth','Mars']);
-        qb.where_in('galaxy_id',[123,456,789,0110]);
+        qb.where_in('galaxy_id', [123, 456, 789, 0110]);
         qb.where_array.should.eql(["`planet` IN ('Mercury', 'Venus', 'Earth', 'Mars')","AND `galaxy_id` IN (123, 456, 789, 72)"]);
     });
     it('should be chainable', () => {
         qb.reset_query();
-        qb.where_in('planet',['Mercury','Venus','Earth','Mars']).where_in('planet_position',[1,2,3,4]);
+        qb.where_in('planet',['Mercury','Venus','Earth','Mars']).where_in('planet_position', [1,2,3,4]);
         qb.where_array.should.eql(["`planet` IN ('Mercury', 'Venus', 'Earth', 'Mars')","AND `planet_position` IN (1, 2, 3, 4)"]);
     });
     it('should not escape fields if asked not to', () => {
         qb.reset_query();
-        qb.where_in('planet_position',[1,2,3],false);
+        qb.where_in('planet_position', [1,2,3], false);
         qb.where_array.should.eql(['planet_position IN (1, 2, 3)']);
     });
 });