feat: stops using "isValid" internally

Author: artem-zakharchenko

bin/gavel

@@ -1,4 +1,5 @@
 #!/usr/bin/env node
+/* eslint-disable */
 
 var cmd = require('commander');
 var httpParser = require('http-string-parser');
@@ -32,20 +33,21 @@ process.stdin.on('end', function() {
     var requestResult = false;
     var responseResult = false;
 
-    gavel.isValid(realRequest, expectedRequest, 'request', function(
+    gavel.validate(realRequest, expectedRequest, 'request', function(
       err,
       result
     ) {
       requestResult = result;
-      gavel.isValid(realResponse, expectedResponse, 'response', function(
+
+      gavel.validate(realResponse, expectedResponse, 'response', function(
         err,
         result
       ) {
         responseResult = result;
       });
     });
 
-    if (requestResult && responseResult) {
+    if (requestResult.isValid && responseResult.isValid) {
       process.exit(0);
     } else {
       process.exit(1);

test/cucumber/step_definitions/validation_errors_thens.js

@@ -1,3 +1,4 @@
+/* eslint-disable */
 module.exports = function() {
   this.Then(/^Gavel will set some error for "([^"]*)"$/, function(
     component,
@@ -56,7 +57,7 @@ module.exports = function() {
   });
 
   this.Then(/^Request or Response is NOT valid$/, function(callback) {
-    return this.isValid((error, result) => {
+    return this.validate((error, result) => {
       if (result) {
         callback(
           new Error('Request or Response is valid and should NOT be valid.')
@@ -67,7 +68,7 @@ module.exports = function() {
   });
 
   return this.Then(/^Request or Response is valid$/, function(callback) {
-    return this.isValid((error, result) => {
+    return this.validate((error, result) => {
       if (!result) {
         callback(
           new Error('Request or Response is NOT valid and should be valid.')

test/cucumber/step_definitions/validators_steps.js

@@ -1,3 +1,4 @@
+/* eslint-disable */
 const tv4 = require('tv4');
 const { assert } = require('chai');
 const deepEqual = require('deep-equal');
@@ -31,7 +32,7 @@ module.exports = function() {
         }
         this.results = JSON.parse(JSON.stringify(result));
 
-        return this.isValid((error, result) => {
+        return this.validate((error, result) => {
           if (error) {
             callback(new Error(error));
           }

test/cucumber/support/world.js

@@ -4,6 +4,7 @@
  * DS102: Remove unnecessary code created because of implicit returns
  * Full docs: https://github.com/decaffeinate/decaffeinate/blob/master/docs/suggestions.md
  */
+/* eslint-disable */
 const gavel = require('../../../lib/gavel');
 const vm = require('vm');
 const util = require('util');
@@ -107,10 +108,6 @@ class World {
     }
   }
 
-  isValid(callback) {
-    return gavel.isValid(this.real, this.expected, 'response', callback);
-  }
-
   validate(callback) {
     return gavel.validate(this.real, this.expected, 'response', callback);
   }

test/unit/mixins/validatable-http-message-test.js

@@ -198,39 +198,6 @@ describe('Http validatable mixin', () => {
             });
           });
 
-          describe('#isValid()', () => {
-            before(() => {
-              instance = new HttpResponse(response);
-              sinon.spy(instance, 'validate');
-            });
-            describe('validation property is empty', () => {
-              it('should perform validation', () => {
-                instance.isValid();
-                assert.isTrue(instance.validate.called);
-              });
-            });
-
-            it('should return boolean', () => {
-              assert.isBoolean(instance.isValid());
-            });
-
-            describe('when any HTTP component contains error message', () => {
-              let instance = null;
-              before(() => {
-                instance = new HttpResponse({});
-                instance.validation = {
-                  headers: {
-                    results: [{ severity: 'error' }]
-                  }
-                };
-              });
-
-              it('should return false', () => {
-                assert.isFalse(instance.isValid());
-              });
-            });
-          });
-
           describe('#validationResults()', () => {
             describe('when HTTP message validation property is empty', () => {
               before(() => {
@@ -1415,6 +1382,9 @@ Unexpected token '\\'' at 1:22
               });
 
               it('should return false boolean result', () => {
+                // TODO Remove/rewrite this.
+                // I am not sure what exactly is being asserted.
+                // There is a high chance this entire functionality has been deprecated.
                 assert.isFalse(instance.isValid());
               });
 

test/unit/validate-test.js

@@ -1,6 +1,6 @@
 const { assert } = require('chai');
 const clone = require('clone');
-const { validate, isValid } = require('../../lib/gavel');
+const { validate } = require('../../lib/gavel');
 
 describe('Gavel proxies to functions with callbacks', () => {
   // Examples from README.md
@@ -42,81 +42,6 @@ describe('Gavel proxies to functions with callbacks', () => {
     body: '{"origin":"1.2.3.4"}'
   };
 
-  describe('isValid', () => {
-    describe('when I provide data', () => {
-      ['response', 'request'].forEach((variant) => {
-        describe(`for two cloned ${variant}s`, () => {
-          let results = null;
-          let error = null;
-
-          before((done) => {
-            isValid(
-              cloneHttpMessage,
-              baseHttpMessage,
-              variant,
-              (err, result) => {
-                error = err;
-                results = result;
-                done();
-              }
-            );
-          });
-
-          it('should call the callback without any errors', () =>
-            assert.isNull(error));
-          it('should be true as a result of isValid', () =>
-            assert.isTrue(results));
-        });
-
-        describe(`for similar ${variant}s`, () => {
-          let results = null;
-          let error = null;
-
-          before((done) => {
-            isValid(
-              similarHttpMessage,
-              baseHttpMessage,
-              variant,
-              (err, result) => {
-                error = err;
-                results = result;
-                done();
-              }
-            );
-          });
-
-          it('should call the callback without any errors', () =>
-            assert.isNull(error));
-          it('should be ok as a result of isValid', () =>
-            assert.isTrue(results));
-        });
-
-        describe(`for different ${variant}s`, () => {
-          let results = null;
-          let error = null;
-
-          before((done) => {
-            isValid(
-              differentHttpMessage,
-              baseHttpMessage,
-              variant,
-              (err, result) => {
-                error = err;
-                results = result;
-                done();
-              }
-            );
-          });
-
-          it('should call the callback without any errors', () =>
-            assert.isNull(error));
-          it('should be false as a result of isValid', () =>
-            assert.isFalse(results));
-        });
-      });
-    });
-  });
-
   describe('validate', () => {
     describe('when I provide data', () => {
       ['response', 'request'].forEach((variant) => {