yoctore/yocto-mongoose

View on GitHub
src/modules/crud/index.js

Summary

Maintainability
C
1 day
Test Coverage

Function has a complexity of 9.
Open

Crud.prototype.get = function (conditions, filter, method) {
Severity: Minor
Found in src/modules/crud/index.js by eslint

Limit Cyclomatic Complexity (complexity)

Cyclomatic complexity measures the number of linearly independent paths through a program's source code. This rule allows setting a cyclomatic complexity threshold.

function a(x) {
    if (true) {
        return x; // 1st path
    } else if (false) {
        return x+1; // 2nd path
    } else {
        return 4; // 3rd path
    }
}

Rule Details

This rule is aimed at reducing code complexity by capping the amount of cyclomatic complexity allowed in a program. As such, it will warn when the cyclomatic complexity crosses the configured threshold (default is 20).

Examples of incorrect code for a maximum of 2:

/*eslint complexity: ["error", 2]*/

function a(x) {
    if (true) {
        return x;
    } else if (false) {
        return x+1;
    } else {
        return 4; // 3rd path
    }
}

Examples of correct code for a maximum of 2:

/*eslint complexity: ["error", 2]*/

function a(x) {
    if (true) {
        return x;
    } else {
        return 4;
    }
}

Options

Optionally, you may specify a max object property:

"complexity": ["error", 2]

is equivalent to

"complexity": ["error", { "max": 2 }]

Deprecated: the object property maximum is deprecated. Please use the property max instead.

When Not To Use It

If you can't determine an appropriate complexity limit for your code, then it's best to disable this rule.

Further Reading

Related Rules

  • [max-depth](max-depth.md)
  • [max-len](max-len.md)
  • [max-nested-callbacks](max-nested-callbacks.md)
  • [max-params](max-params.md)
  • [max-statements](max-statements.md) Source: http://eslint.org/docs/rules/

Function create has 38 lines of code (exceeds 25 allowed). Consider refactoring.
Open

Crud.prototype.create = function (value) {
  // Create our deferred object, which we will use in our promise chain
  var deferred = Q.defer();
  // create default instance model
  var model = !_.isFunction(this.save) ? new this() : this;
Severity: Minor
Found in src/modules/crud/index.js - About 1 hr to fix

    Function get has 33 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    Crud.prototype.get = function (conditions, filter, method) {
      // process redis usage
      var redis = this[ method === 'findOne' ? 'getOneRedis' : 'getRedis' ];
    
      // defined default method name to use
    Severity: Minor
    Found in src/modules/crud/index.js - About 1 hr to fix

      Function add has 32 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

      Crud.prototype.add = function (schema, exclude, redisIncludes, redis) {
        // valid data ?
        if ((!_.isObject(schema) && !(schema instanceof Schema)) || !_.isArray(exclude)) {
          this.logger.warning('[ Crud.add ] - Schema or exclude item given is invalid');
          // invalid statement
      Severity: Minor
      Found in src/modules/crud/index.js - About 1 hr to fix

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

        Crud.prototype.get = function (conditions, filter, method) {
          // process redis usage
          var redis = this[ method === 'findOne' ? 'getOneRedis' : 'getRedis' ];
        
          // defined default method name to use
        Severity: Minor
        Found in src/modules/crud/index.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 create has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
        Open

        Crud.prototype.create = function (value) {
          // Create our deferred object, which we will use in our promise chain
          var deferred = Q.defer();
          // create default instance model
          var model = !_.isFunction(this.save) ? new this() : this;
        Severity: Minor
        Found in src/modules/crud/index.js - About 55 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

        Avoid deeply nested control flow statements.
        Open

                      if (err) {
                        // reject with error message
                        deferred.reject([ '[ Crud.create ] - Indexes creation failed :', err ].join(' '));
                      } else {
                        // resolve default statement
        Severity: Major
        Found in src/modules/crud/index.js - About 45 mins to fix

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

          Crud.prototype.add = function (schema, exclude, redisIncludes, redis) {
            // valid data ?
            if ((!_.isObject(schema) && !(schema instanceof Schema)) || !_.isArray(exclude)) {
              this.logger.warning('[ Crud.add ] - Schema or exclude item given is invalid');
              // invalid statement
          Severity: Minor
          Found in src/modules/crud/index.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

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

          module.exports = function (l) {
            // is a valid logger ?
            if (_.isUndefined(l) || _.isNull(l)) {
              logger.warning('[ Crud.constructor ] - Invalid logger given. Use internal logger');
              // assign
          Severity: Major
          Found in src/modules/crud/index.js and 5 other locations - About 2 hrs to fix
          src/index.js on lines 973..982
          src/modules/method/index.js on lines 200..209
          src/modules/utils/elastic.js on lines 134..143
          src/modules/utils/redis.js on lines 439..448
          src/modules/validator/index.js on lines 99..108

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

          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

          Identical blocks of code found in 4 locations. Consider refactoring.
          Open

              this.findByIdAndRemove(id, function (error, data) {
                // has error ?
                if (error) {
                  // reject
                  deferred.reject(error);
          Severity: Major
          Found in src/modules/crud/index.js and 3 other locations - About 35 mins to fix
          src/modules/crud/index.js on lines 233..242
          src/modules/crud/index.js on lines 245..254
          src/modules/crud/index.js on lines 349..358

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

          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

          Identical blocks of code found in 4 locations. Consider refactoring.
          Open

              this[method](conditions, update, { new : true }, function (error, data) {
                // has error ?
                if (error) {
                  // reject
                  deferred.reject(error);
          Severity: Major
          Found in src/modules/crud/index.js and 3 other locations - About 35 mins to fix
          src/modules/crud/index.js on lines 195..204
          src/modules/crud/index.js on lines 233..242
          src/modules/crud/index.js on lines 349..358

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

          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

          Identical blocks of code found in 4 locations. Consider refactoring.
          Open

              this.search(query || {}, options || {}, function (error, data) {
                // has error ?
                if (error) {
                  // reject
                  deferred.reject(error);
          Severity: Major
          Found in src/modules/crud/index.js and 3 other locations - About 35 mins to fix
          src/modules/crud/index.js on lines 195..204
          src/modules/crud/index.js on lines 233..242
          src/modules/crud/index.js on lines 245..254

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

          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

          Identical blocks of code found in 4 locations. Consider refactoring.
          Open

              this.where().setOptions({ multi : true }).update(conditions, update, function (error, data) {
                // has error ?
                if (error) {
                  // reject
                  deferred.reject(error);
          Severity: Major
          Found in src/modules/crud/index.js and 3 other locations - About 35 mins to fix
          src/modules/crud/index.js on lines 195..204
          src/modules/crud/index.js on lines 245..254
          src/modules/crud/index.js on lines 349..358

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

          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