BigstickCarpet/swagger-express-middleware

View on GitHub
lib/helpers/json-schema.js

Summary

Maintainability
F
1 wk
Test Coverage

File json-schema.js has 520 lines of code (exceeds 250 allowed). Consider refactoring.
Open

"use strict";

module.exports = JsonSchema;

const tv4 = require("tv4");
Severity: Major
Found in lib/helpers/json-schema.js - About 1 day to fix

    Function parseDate has a Cognitive Complexity of 27 (exceeds 5 allowed). Consider refactoring.
    Open

    function parseDate (schema, value, propPath) {
      let parsedValue;
    
      // Handle missing, required, and default
      value = getValueToValidate(schema, value);
    Severity: Minor
    Found in lib/helpers/json-schema.js - About 3 hrs to fix

    Cognitive Complexity

    Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

    A method's cognitive complexity is based on a few simple rules:

    • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
    • Code is considered more complex for each "break in the linear flow of the code"
    • Code is considered more complex when "flow breaking structures are nested"

    Further reading

    Function parseDate has 45 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    function parseDate (schema, value, propPath) {
      let parsedValue;
    
      // Handle missing, required, and default
      value = getValueToValidate(schema, value);
    Severity: Minor
    Found in lib/helpers/json-schema.js - About 1 hr to fix

      Function parseFile has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
      Open

      function parseFile (schema, value, propPath) {
        // Handle missing, required, and default
        value = getValueToValidate(schema, value);
      
        // Parse the value
      Severity: Minor
      Found in lib/helpers/json-schema.js - About 1 hr to fix

      Cognitive Complexity

      Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

      A method's cognitive complexity is based on a few simple rules:

      • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
      • Code is considered more complex for each "break in the linear flow of the code"
      • Code is considered more complex when "flow breaking structures are nested"

      Further reading

      Function sampleDate has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
      Open

      function sampleDate (schema) {
        let min, max;
        if (schema.minimum !== undefined) {
          min = parseInt(new Date(schema.minimum).valueOf()) + (schema.exclusiveMinimum ? 1 : 0);
        }
      Severity: Minor
      Found in lib/helpers/json-schema.js - About 1 hr to fix

      Cognitive Complexity

      Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

      A method's cognitive complexity is based on a few simple rules:

      • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
      • Code is considered more complex for each "break in the linear flow of the code"
      • Code is considered more complex when "flow breaking structures are nested"

      Further reading

      Function parseFile has 26 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

      function parseFile (schema, value, propPath) {
        // Handle missing, required, and default
        value = getValueToValidate(schema, value);
      
        // Parse the value
      Severity: Minor
      Found in lib/helpers/json-schema.js - About 1 hr to fix

        Function sampleNumber has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
        Open

        function sampleNumber (schema) {
          let min, max;
          if (schema.minimum !== undefined) {
            min = parseFloat(schema.minimum) + (schema.exclusiveMinimum ? EPSILON : 0);
          }
        Severity: Minor
        Found in lib/helpers/json-schema.js - About 45 mins to fix

        Cognitive Complexity

        Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

        A method's cognitive complexity is based on a few simple rules:

        • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
        • Code is considered more complex for each "break in the linear flow of the code"
        • Code is considered more complex when "flow breaking structures are nested"

        Further reading

        Function sampleInteger has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
        Open

        function sampleInteger (schema) {
          let min, max;
          if (schema.minimum !== undefined) {
            min = parseInt(schema.minimum) + (schema.exclusiveMinimum ? 1 : 0);
          }
        Severity: Minor
        Found in lib/helpers/json-schema.js - About 45 mins to fix

        Cognitive Complexity

        Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

        A method's cognitive complexity is based on a few simple rules:

        • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
        • Code is considered more complex for each "break in the linear flow of the code"
        • Code is considered more complex when "flow breaking structures are nested"

        Further reading

        Function getValueToValidate has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
        Open

        function getValueToValidate (schema, value) {
          // Is the value empty?
          if (value === undefined || value === "" ||
            (schema.type === "object" && _.isObject(value) && _.isEmpty(value))) {
        
        
        Severity: Minor
        Found in lib/helpers/json-schema.js - About 35 mins to fix

        Cognitive Complexity

        Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

        A method's cognitive complexity is based on a few simple rules:

        • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
        • Code is considered more complex for each "break in the linear flow of the code"
        • Code is considered more complex when "flow breaking structures are nested"

        Further reading

        Function parseArray has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
        Open

        function parseArray (schema, value, propPath) {
          // Handle missing, required, and default
          value = getValueToValidate(schema, value);
        
          let parsedValue = value;
        Severity: Minor
        Found in lib/helpers/json-schema.js - About 25 mins to fix

        Cognitive Complexity

        Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

        A method's cognitive complexity is based on a few simple rules:

        • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
        • Code is considered more complex for each "break in the linear flow of the code"
        • Code is considered more complex when "flow breaking structures are nested"

        Further reading

        Function sampleArray has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
        Open

        function sampleArray (schema) {
          let minItems, maxItems;
          if (schema.minItems !== undefined) {
            minItems = parseInt(schema.minItems);
          }
        Severity: Minor
        Found in lib/helpers/json-schema.js - About 25 mins to fix

        Cognitive Complexity

        Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

        A method's cognitive complexity is based on a few simple rules:

        • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
        • Code is considered more complex for each "break in the linear flow of the code"
        • Code is considered more complex when "flow breaking structures are nested"

        Further reading

        Similar blocks of code found in 2 locations. Consider refactoring.
        Open

        JsonSchema.prototype.parse = function (value, propPath) {
          switch (this.schema.type) {
            case "number":
              return parseNumber(this.schema, value, propPath);
            case "integer":
        Severity: Major
        Found in lib/helpers/json-schema.js and 1 other location - About 1 day to fix
        lib/helpers/json-schema.js on lines 116..142

        Duplicated Code

        Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

        Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

        When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

        Tuning

        This issue has a mass of 213.

        We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

        The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

        If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

        See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

        Refactorings

        Further Reading

        Similar blocks of code found in 2 locations. Consider refactoring.
        Open

        JsonSchema.prototype.serialize = function (value, propPath) {
          switch (this.schema.type) {
            case "number":
              return serializeNumber(this.schema, value, propPath);
            case "integer":
        Severity: Major
        Found in lib/helpers/json-schema.js and 1 other location - About 1 day to fix
        lib/helpers/json-schema.js on lines 80..106

        Duplicated Code

        Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

        Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

        When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

        Tuning

        This issue has a mass of 213.

        We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

        The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

        If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

        See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

        Refactorings

        Further Reading

        Similar blocks of code found in 2 locations. Consider refactoring.
        Open

          if (schema.minimum) {
            let minDate = new Date(schema.minimum);
            if (isNaN(minDate.getTime())) {
              throw ono({ status: 500 }, 'The "minimum" value in the Swagger API is invalid (%j)', schema.minimum);
            }
        Severity: Major
        Found in lib/helpers/json-schema.js and 1 other location - About 6 hrs to fix
        lib/helpers/json-schema.js on lines 645..660

        Duplicated Code

        Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

        Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

        When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

        Tuning

        This issue has a mass of 156.

        We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

        The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

        If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

        See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

        Refactorings

        Further Reading

        Similar blocks of code found in 2 locations. Consider refactoring.
        Open

          if (schema.maximum) {
            let maxDate = new Date(schema.maximum);
            if (isNaN(maxDate.getTime())) {
              throw ono({ status: 500 }, 'The "maximum" value in the Swagger API is invalid (%j)', schema.maximum);
            }
        Severity: Major
        Found in lib/helpers/json-schema.js and 1 other location - About 6 hrs to fix
        lib/helpers/json-schema.js on lines 628..643

        Duplicated Code

        Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

        Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

        When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

        Tuning

        This issue has a mass of 156.

        We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

        The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

        If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

        See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

        Refactorings

        Further Reading

        Similar blocks of code found in 2 locations. Consider refactoring.
        Open

          if (schema.minLength) {
            let minLength = parseInt(schema.minLength);
            if (isNaN(minLength)) {
              throw ono({ status: 500 }, 'The "minLength" value in the Swagger API is invalid (%j)', schema.minLength);
            }
        Severity: Major
        Found in lib/helpers/json-schema.js and 1 other location - About 2 hrs to fix
        lib/helpers/json-schema.js on lines 569..579

        Duplicated Code

        Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

        Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

        When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

        Tuning

        This issue has a mass of 94.

        We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

        The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

        If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

        See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

        Refactorings

        Further Reading

        Similar blocks of code found in 2 locations. Consider refactoring.
        Open

          if (schema.maxLength) {
            let maxLength = parseInt(schema.maxLength);
            if (isNaN(maxLength)) {
              throw ono({ status: 500 }, 'The "maxLength" value in the Swagger API is invalid (%j)', schema.maxLength);
            }
        Severity: Major
        Found in lib/helpers/json-schema.js and 1 other location - About 2 hrs to fix
        lib/helpers/json-schema.js on lines 557..567

        Duplicated Code

        Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

        Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

        When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

        Tuning

        This issue has a mass of 94.

        We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

        The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

        If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

        See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

        Refactorings

        Further Reading

        Similar blocks of code found in 2 locations. Consider refactoring.
        Open

          if (range) {
            if (parsedValue < range.min || parsedValue > range.max) {
              throw ono({ status: 400 }, '"%s" is not a valid %s. Must be between %d and %d',
                propPath || parsedValue, schema.format, range.min, range.max);
            }
        Severity: Major
        Found in lib/helpers/json-schema.js and 1 other location - About 1 hr to fix
        lib/helpers/json-schema.js on lines 291..296

        Duplicated Code

        Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

        Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

        When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

        Tuning

        This issue has a mass of 68.

        We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

        The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

        If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

        See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

        Refactorings

        Further Reading

        Similar blocks of code found in 2 locations. Consider refactoring.
        Open

          if (range) {
            if (parsedValue < range.min || parsedValue > range.max) {
              throw ono({ status: 400 }, '"%s" is not a valid %s. Must be between %d and %d',
                propPath || value, schema.format, range.min, range.max);
            }
        Severity: Major
        Found in lib/helpers/json-schema.js and 1 other location - About 1 hr to fix
        lib/helpers/json-schema.js on lines 240..245

        Duplicated Code

        Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

        Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

        When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

        Tuning

        This issue has a mass of 68.

        We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

        The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

        If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

        See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

        Refactorings

        Further Reading

        Similar blocks of code found in 2 locations. Consider refactoring.
        Open

          if (schema.maxItems !== undefined) {
            maxItems = parseInt(schema.maxItems);
          }
          else {
            maxItems = Math.max(50, minItems);
        Severity: Minor
        Found in lib/helpers/json-schema.js and 1 other location - About 45 mins to fix
        lib/helpers/json-schema.js on lines 384..389

        Duplicated Code

        Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

        Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

        When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

        Tuning

        This issue has a mass of 50.

        We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

        The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

        If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

        See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

        Refactorings

        Further Reading

        Similar blocks of code found in 2 locations. Consider refactoring.
        Open

          if (schema.maxLength !== undefined) {
            maxLength = parseInt(schema.maxLength);
          }
          else {
            maxLength = Math.max(50, minLength);
        Severity: Minor
        Found in lib/helpers/json-schema.js and 1 other location - About 45 mins to fix
        lib/helpers/json-schema.js on lines 477..482

        Duplicated Code

        Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

        Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

        When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

        Tuning

        This issue has a mass of 50.

        We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

        The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

        If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

        See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

        Refactorings

        Further Reading

        There are no issues that match your filters.

        Category
        Status