Merge pull request #175 from coord-e/fix-notice-falsy-example-and-default

fix: don't ignore "0" example value

Author: honzajavorek

src/compile-uri/compile-params.js

@@ -8,10 +8,11 @@ module.exports = function compileParams(hrefVariablesElement) {
     const typeAttributes = memberElement.attributes.getValue('typeAttributes') || [];
     const values = valueElement.attributes.getValue('enumerations') || [];
 
+    const example = valueElement.toValue();
     params[name] = {
       required: Array.from(typeAttributes).includes('required'),
       default: valueElement.attributes.getValue('default'),
-      example: valueElement.toValue() || values[0],
+      example: typeof example === 'undefined' || example === null ? values[0] : example,
       values
     };
 

src/compile-uri/expand-uri-template.js

@@ -45,9 +45,9 @@ Parameter not defined in API description document: ${uriParameter}\
       uriParameters.forEach((uriParameter) => {
         param = params[uriParameter];
 
-        if (param.example) {
+        if (typeof param.example !== 'undefined' && param.example !== '') {
           toExpand[uriParameter] = param.example;
-        } else if (param.default) {
+        } else if (typeof param.default !== 'undefined' && param.default !== '') {
           toExpand[uriParameter] = param.default;
         } else if (param.required) {
           ambiguous = true;
@@ -58,7 +58,7 @@ document: ${uriParameter}\
 `);
         }
 
-        if (param.required && param.default) {
+        if (param.required && typeof param.default !== 'undefined' && param.default !== '') {
           result.warnings.push(`\
 Required URI parameter '${uriParameter}' has a default value.
 Default value for a required parameter doesn't make sense from \

src/compile-uri/validate-params.js

@@ -5,7 +5,7 @@ module.exports = function validateParams(params) {
     let text;
     const param = params[paramName];
 
-    if (param.required && !param.example && !param.default) {
+    if (param.required && !(typeof param.example !== 'undefined' && param.example !== '') && !(typeof param.default !== 'undefined' && param.default !== '')) {
       text = `Required URI parameter '${paramName}' has no example or default value.`;
       result.errors.push(text);
     }

test/unit/compile-uri/compile-params-test.js

@@ -71,6 +71,22 @@ describe('compileParams', () => {
     });
   });
 
+  it('should compile a primitive example variable which its value is 0', () => {
+    const hrefVariables = new fury.minim.elements.HrefVariables();
+    hrefVariables.set('example', 0);
+
+    const parameters = compileParams(hrefVariables);
+
+    assert.deepEqual(parameters, {
+      example: {
+        default: undefined,
+        example: 0,
+        required: false,
+        values: []
+      }
+    });
+  });
+
   it('should compile an array href variable', () => {
     const hrefVariables = new fury.minim.elements.HrefVariables();
     hrefVariables.set('names', []);

test/unit/compile-uri/expand-uri-template-test.js

@@ -52,6 +52,41 @@ describe('expandUriTemplate', () => {
       it('it should return some errror', () => assert.notEqual(data.errors.length, 0));
     });
 
+    describe('when "example" is zero', () => {
+      before(() => {
+        uriTemplate = '/machines{/id}';
+        parameters = {
+          id: {
+            description: 'Machine id',
+            type: 'number',
+            required: true,
+            example: 0
+          }
+        };
+
+        data = expandUriTemplate(uriTemplate, parameters);
+      });
+
+      it('should return expandend URI', () => assert.equal(data.uri, '/machines/0'));
+    });
+
+    describe('when "default" is zero', () => {
+      before(() => {
+        uriTemplate = '/machines{/id}';
+        parameters = {
+          id: {
+            description: 'Machine id',
+            type: 'number',
+            required: true,
+            default: 0
+          }
+        };
+
+        data = expandUriTemplate(uriTemplate, parameters);
+      });
+
+      it('should return expandend URI', () => assert.equal(data.uri, '/machines/0'));
+    });
 
     describe('when URI with no URI template expression given', () => {
       before(() => {

test/unit/compile-uri/validate-parameters-test.js

@@ -37,6 +37,24 @@ describe('validateParams', () => {
     })
   );
 
+  describe('when type is number and example is zero', () =>
+    it('should set no error', () => {
+      const params = {
+        name: {
+          description: 'Machine name',
+          type: 'number',
+          required: true,
+          example: 0,
+          default: '',
+          values: []
+        }
+      };
+
+      const result = validateParams(params);
+      assert.equal(result.errors.length, 0);
+    })
+  );
+
   // Based on bug report:
   // https://github.com/apiaryio/dredd/issues/106
   describe('when type is string and example is a string but starting with a number', () =>