Sign upLogin

mac-/ratify

View on GitHub
Star
lib/SwaggerManager.js

Summary

Maintainability
F
6 days
Test Coverage

Function SwaggerManager has a Cognitive Complexity of 147 (exceeds 5 allowed). Consider refactoring.
Open

var SwaggerManager = function(options) {

    options = options || {};

    var swaggerHooks = options.swaggerHooks || {};
Severity: Minor
Found in lib/SwaggerManager.js - About 2 days 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 SwaggerManager has 313 lines of code (exceeds 25 allowed). Consider refactoring.
Open

var SwaggerManager = function(options) {

    options = options || {};

    var swaggerHooks = options.swaggerHooks || {};
Severity: Major
Found in lib/SwaggerManager.js - About 1 day to fix

    File SwaggerManager.js has 318 lines of code (exceeds 250 allowed). Consider refactoring.
    Open

    var _ = require('lodash'),
    fs = require('fs');

var SwaggerManager = function(options) {
    Severity: Minor
    Found in lib/SwaggerManager.js - About 3 hrs to fix

      Function getSwaggerParams has 63 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

              getSwaggerParams = function(route, type, operationNickname) {
            var params = [], prop, param;
            if (swaggerParamTypeMap[type] &&
                route.settings.plugins &&
                route.settings.plugins[options.pluginName] &&
      Severity: Major
      Found in lib/SwaggerManager.js - About 2 hrs to fix

        Function getApiDeclarationModel has 54 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            this.getApiDeclarationModel = function(routes, apiName) {
        var cached = apiDocsCache[apiName];
        if (cached){
            return cached;
        }
        Severity: Major
        Found in lib/SwaggerManager.js - About 2 hrs to fix

          Function getSwaggerOperationForRoute has 53 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

                  getSwaggerOperationForRoute = function(route, resourceType, path) {
            var pathParts = path.split('/'),
                regex = /^\{.+\}$/,
                lastPart = pathParts.pop(),
                resourceId = (regex.test(lastPart)) ? lastPart : null,
          Severity: Major
          Found in lib/SwaggerManager.js - About 2 hrs to fix

            Avoid deeply nested control flow statements.
            Open

                                        if (schema.properties[prop].hasOwnProperty('maximum')) {
                                param.maximum = schema.properties[prop].maximum;
                            }
            Severity: Major
            Found in lib/SwaggerManager.js - About 45 mins to fix

              Avoid deeply nested control flow statements.
              Open

                                          if (schema.properties[prop].hasOwnProperty('items')) {
                                param.items = schema.properties[prop].items;
                            }
              Severity: Major
              Found in lib/SwaggerManager.js - About 45 mins to fix

                Avoid deeply nested control flow statements.
                Open

                                            if (schema.properties[prop].hasOwnProperty('enum')) {
                                param.enum = schema.properties[prop].enum;
                            }
                Severity: Major
                Found in lib/SwaggerManager.js - About 45 mins to fix

                  Avoid deeply nested control flow statements.
                  Open

                                              if (schema.properties[prop].hasOwnProperty('minimum')) {
                                param.minimum = (schema.properties[prop].exclusiveMinimum) ? schema.properties[prop].minimum + 1 : schema.properties[prop].minimum;
                            }
                  Severity: Major
                  Found in lib/SwaggerManager.js - About 45 mins to fix

                    Avoid deeply nested control flow statements.
                    Open

                                                if (schema.properties.hasOwnProperty(prop)) {
                                var formParam = {
                                    paramType: 'form',
                                    name: prop,
                                    description: schema.properties[prop].description,
                    Severity: Major
                    Found in lib/SwaggerManager.js - About 45 mins to fix

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

                                          if (schema.oneOf &&
                        Array.isArray(schema.oneOf) &&
                        schema.oneOf.length > 0) {
                        schema = schema.oneOf[0];
                    }
                      Severity: Major
                      Found in lib/SwaggerManager.js and 1 other location - About 1 hr to fix
                      lib/SwaggerManager.js on lines 230..232

                      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 58.

                      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(model.oneOf && Array.isArray(model.oneOf) && model.oneOf.length > 0) {
                    model = model.oneOf[0];
                }
                      Severity: Major
                      Found in lib/SwaggerManager.js and 1 other location - About 1 hr to fix
                      lib/SwaggerManager.js on lines 178..182

                      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 58.

                      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 3 locations. Consider refactoring.
                      Open

                                                  if (schema.properties[prop].hasOwnProperty('enum')) {
                                param.enum = schema.properties[prop].enum;
                            }
                      Severity: Minor
                      Found in lib/SwaggerManager.js and 2 other locations - About 35 mins to fix
                      lib/SwaggerManager.js on lines 116..118
                      lib/SwaggerManager.js on lines 122..124

                      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 46.

                      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 3 locations. Consider refactoring.
                      Open

                                                  if (schema.properties[prop].hasOwnProperty('items')) {
                                param.items = schema.properties[prop].items;
                            }
                      Severity: Minor
                      Found in lib/SwaggerManager.js and 2 other locations - About 35 mins to fix
                      lib/SwaggerManager.js on lines 116..118
                      lib/SwaggerManager.js on lines 119..121

                      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 46.

                      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 3 locations. Consider refactoring.
                      Open

                                                  if (schema.properties[prop].hasOwnProperty('maximum')) {
                                param.maximum = schema.properties[prop].maximum;
                            }
                      Severity: Minor
                      Found in lib/SwaggerManager.js and 2 other locations - About 35 mins to fix
                      lib/SwaggerManager.js on lines 119..121
                      lib/SwaggerManager.js on lines 122..124

                      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 46.

                      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