martinmicunda/employee-scheduling-api

View on GitHub
lib/api/positions/lib/dao.js

Summary

Maintainability
F
5 days
Test Coverage

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

async function update(id, doc) {
    let cas = doc.cas;
    // do not store CAS(version) and document ID as Couchbase already keep these values in metadata for each document
    doc = db.removeMetadataFromDoc(doc);
    doc.type = DOC_TYPE; // map-reduces
Severity: Minor
Found in lib/api/positions/lib/dao.js - About 1 hr to fix

    Function update has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
    Open

    async function update(id, doc) {
        let cas = doc.cas;
        // do not store CAS(version) and document ID as Couchbase already keep these values in metadata for each document
        doc = db.removeMetadataFromDoc(doc);
        doc.type = DOC_TYPE; // map-reduces
    Severity: Minor
    Found in lib/api/positions/lib/dao.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

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

    async function update(id, doc) {
        let cas = doc.cas;
        // do not store CAS(version) and document ID as Couchbase already keep these values in metadata for each document
        doc = db.removeMetadataFromDoc(doc);
        doc.type = DOC_TYPE; // map-reduces
    Severity: Major
    Found in lib/api/positions/lib/dao.js and 2 other locations - About 2 days to fix
    lib/api/locations/lib/dao.js on lines 138..185
    lib/api/partners/lib/dao.js on lines 185..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 388.

    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

    async function insert(doc, id = uuid.v1()) {
        doc.type = DOC_TYPE; // map-reduces
    
        // insert unique referential document first
        await insertRefDoc(doc, id);
    Severity: Major
    Found in lib/api/positions/lib/dao.js and 1 other location - About 5 hrs to fix
    lib/api/locations/lib/dao.js on lines 106..125

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

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

    async function find() {
        const query = db.N1qlQuery.fromString(`SELECT meta().cas, meta().id, \`${db.bucketName}\`.* FROM \`${db.bucketName}\` WHERE type = '${DOC_TYPE}' ORDER BY name`);
    
        try {
            return await db.query(query);
    Severity: Major
    Found in lib/api/positions/lib/dao.js and 5 other locations - About 4 hrs to fix
    lib/api/currencies/lib/dao.js on lines 44..54
    lib/api/languages/lib/dao.js on lines 46..56
    lib/api/locations/lib/dao.js on lines 57..67
    lib/api/partners/lib/dao.js on lines 57..67
    lib/api/settings/lib/dao.js on lines 44..54

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

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

    async function insertRefDoc(doc, refId) {
        const refDocId = generateRefDocId(doc);
        const refDoc = {
            refId: refId
        };
    Severity: Major
    Found in lib/api/positions/lib/dao.js and 3 other locations - About 4 hrs to fix
    lib/api/employees/lib/dao.js on lines 106..119
    lib/api/locations/lib/dao.js on lines 80..93
    lib/api/partners/lib/dao.js on lines 78..91

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

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

    async function remove(id) {
        // remove unique referential document first
        const doc = await findByID(id);
        await removeRefDoc(doc);
    
    
    Severity: Major
    Found in lib/api/positions/lib/dao.js and 3 other locations - About 3 hrs to fix
    lib/api/employees/lib/dao.js on lines 312..327
    lib/api/locations/lib/dao.js on lines 214..229
    lib/api/partners/lib/dao.js on lines 261..276

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

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

    async function findByID(id) {
        try {
            const data = await db.get(id);
    
            return Object.assign({id: id, cas: data.cas}, data.value);
    Severity: Major
    Found in lib/api/positions/lib/dao.js and 4 other locations - About 3 hrs to fix
    lib/api/currencies/lib/dao.js on lines 26..35
    lib/api/locations/lib/dao.js on lines 39..48
    lib/api/partners/lib/dao.js on lines 39..48
    lib/api/settings/lib/dao.js on lines 26..35

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

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

    async function removeRefDoc(doc) {
        const refDocId = generateRefDocId(doc);
    
        try {
            await db.remove(refDocId);
    Severity: Major
    Found in lib/api/positions/lib/dao.js and 3 other locations - About 3 hrs to fix
    lib/api/employees/lib/dao.js on lines 293..303
    lib/api/locations/lib/dao.js on lines 195..205
    lib/api/partners/lib/dao.js on lines 242..252

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

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

    function generateRefDocId(doc) {
        return `${DOC_TYPE}::${doc.name.replace(/ /g,'').toLowerCase()}`
    }
    Severity: Major
    Found in lib/api/positions/lib/dao.js and 3 other locations - About 40 mins to fix
    lib/api/employees/lib/dao.js on lines 27..29
    lib/api/locations/lib/dao.js on lines 27..29
    lib/api/partners/lib/dao.js on lines 27..29

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

    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