fogine/couchbase-odm

View on GitHub
lib/model.js

Summary

Maintainability
F
3 days
Test Coverage

File model.js has 443 lines of code (exceeds 250 allowed). Consider refactoring.
Open

const util    = require('util');
const _       = require("lodash");
const Promise = require('bluebird');

const StorageAdapter = require("./storageAdapter");
Severity: Minor
Found in lib/model.js - About 6 hrs to fix

    Function getByIdOrFail has 64 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    Model.prototype.getByIdOrFail = Promise.method(function(id, options) {
        let key = id;
        const actions = [];
        const defaults = {
            paranoid: true,
    Severity: Major
    Found in lib/model.js - About 2 hrs to fix

      Function Model has 58 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

      function Model(name, schema, options) {
      
          if (!name || (typeof name !== "string" && !(name instanceof String) )) {
              throw new ModelError("Model's name must be non-empty string value");
          }
      Severity: Major
      Found in lib/model.js - About 2 hrs to fix

        Function _init has 57 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

        Model.prototype._init = function(modelManager) {
        
            const self = this;
        
            this._modelManager = modelManager;
        Severity: Major
        Found in lib/model.js - About 2 hrs to fix

          Function getMulti has 44 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

          Model.prototype.getMulti = Promise.method(function(ids, options) {
          
              const defaults = {
                  indexed         : true,
                  hooks           : true,
          Severity: Minor
          Found in lib/model.js - About 1 hr to fix

            Function build has 27 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

            Model.prototype.build = function(data, options) {
                const defaults = {
                    isNewRecord: true,
                    sanitize: false
                };
            Severity: Minor
            Found in lib/model.js - About 1 hr to fix

              Function attachGetByRefDocMethods has 27 lines of code (exceeds 25 allowed). Consider refactoring.
              Open

              function attachGetByRefDocMethods() {
                  const self = this;
                  const getByRefDocPrefix = 'getBy';
                  const refDocs = this.options.indexes.refDocs;
              
              
              Severity: Minor
              Found in lib/model.js - About 1 hr to fix

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

                Model.prototype.getByIdOrFail = Promise.method(function(id, options) {
                    let key = id;
                    const actions = [];
                    const defaults = {
                        paranoid: true,
                Severity: Minor
                Found in lib/model.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 Model has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
                Open

                function Model(name, schema, options) {
                
                    if (!name || (typeof name !== "string" && !(name instanceof String) )) {
                        throw new ModelError("Model's name must be non-empty string value");
                    }
                Severity: Minor
                Found in lib/model.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

                        self[getByRefDocFnName] = Promise.method(function(id, options) {
                            options = _.clone(options || {});
                            if (!(id instanceof self.RefDocKey)) {
                                id = self.buildRefDocKey(id, {
                                    index: indexName,
                Severity: Major
                Found in lib/model.js and 1 other location - About 3 hrs to fix
                lib/model.js on lines 781..791

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

                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

                        self[getByRefDocOrFailFnName] = Promise.method(function(id, options) {
                            options = _.clone(options || {});
                            if (!(id instanceof self.RefDocKey)) {
                                id = self.buildRefDocKey(id, {
                                    index: indexName,
                Severity: Major
                Found in lib/model.js and 1 other location - About 3 hrs to fix
                lib/model.js on lines 767..777

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

                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

                Model.prototype.unlock = Promise.method(function(id, cas) {
                    let key = id;
                    if (!(id instanceof this.Key)) {
                        key = this.buildKey(id);
                    }
                Severity: Major
                Found in lib/model.js and 1 other location - About 2 hrs to fix
                lib/model.js on lines 709..716

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

                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

                Model.prototype.touch = Promise.method(function(id, expiry) {
                    let key = id;
                    if (!(id instanceof this.Key)) {
                        key = this.buildKey(id);
                    }
                Severity: Major
                Found in lib/model.js and 1 other location - About 2 hrs to fix
                lib/model.js on lines 725..732

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

                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