Sign upLogin

uccser/cs-field-guide

View on GitHub
Star
csfieldguide/static/interactives/dictionary-compression/js/dictionary-compression.js

Summary

Maintainability
D
2 days
Test Coverage

Function highlightCodedCharacters has a Cognitive Complexity of 55 (exceeds 5 allowed). Consider refactoring.
Open

function highlightCodedCharacters() {
    // clear the existing references
    for (var i = 0; i < message_characters.length; i++) {
        message_characters[i].CodeIndex = false;
        var character_element = document.querySelectorAll('[data-character-index="' + i.toString() + '"]')[0];
Severity: Minor
Found in csfieldguide/static/interactives/dictionary-compression/js/dictionary-compression.js - About 1 day 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

File dictionary-compression.js has 283 lines of code (exceeds 250 allowed). Consider refactoring.
Open

var codes = [];
var message_characters = [];
// var message_characters = [
//     {
//         Character: 'P',
Severity: Minor
Found in csfieldguide/static/interactives/dictionary-compression/js/dictionary-compression.js - About 2 hrs to fix

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

function highlightCodedCharacters() {
    // clear the existing references
    for (var i = 0; i < message_characters.length; i++) {
        message_characters[i].CodeIndex = false;
        var character_element = document.querySelectorAll('[data-character-index="' + i.toString() + '"]')[0];
Severity: Major
Found in csfieldguide/static/interactives/dictionary-compression/js/dictionary-compression.js - About 2 hrs to fix

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

function readInputMessage() {
    var message_textarea = document.getElementById('dictionary-compression-input');
    var message = message_textarea.value;
    if (message.length == 0) {
        message = message_textarea.placeholder;
Severity: Minor
Found in csfieldguide/static/interactives/dictionary-compression/js/dictionary-compression.js - About 1 hr to fix

Function updateDictionary has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
Open

function updateDictionary() {
    // get the new value entered by the user
    var input_element = document.getElementById('dictionary-compression-user-dictionary-value-input');
    var new_entry_value = input_element.value;
    if (codes.indexOf(new_entry_value) == -1) {
Severity: Minor
Found in csfieldguide/static/interactives/dictionary-compression/js/dictionary-compression.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 highlightCharacters has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
Open

function highlightCharacters(event, highlight) {
    var selected_dictionary_entry = event.srcElement;
    if (event.nodeName == 'P') { // event was changing focus to next input box
        selected_dictionary_entry = event.parentElement;
    }
Severity: Minor
Found in csfieldguide/static/interactives/dictionary-compression/js/dictionary-compression.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 updateDictionary has 26 lines of code (exceeds 25 allowed). Consider refactoring.
Open

function updateDictionary() {
    // get the new value entered by the user
    var input_element = document.getElementById('dictionary-compression-user-dictionary-value-input');
    var new_entry_value = input_element.value;
    if (codes.indexOf(new_entry_value) == -1) {
Severity: Minor
Found in csfieldguide/static/interactives/dictionary-compression/js/dictionary-compression.js - About 1 hr to fix

Avoid deeply nested control flow statements.
Open

                    for (var k = 1; k < code.length; k++) {
                        // get the next code and message characters
                        var next_code_character = code[k];
                        if (next_message_character_index >= message_characters.length) {
                            break;
Severity: Major
Found in csfieldguide/static/interactives/dictionary-compression/js/dictionary-compression.js - About 45 mins to fix

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

    if (dictionary_entry_index !== false) {
        var dictionary_entry_element = document.querySelectorAll('[data-code-index="' + dictionary_entry_index.toString() + '"]')[0];
        if (highlight === true) {
            dictionary_entry_element.classList.add('highlight');
        } else {
Severity: Major
Found in csfieldguide/static/interactives/dictionary-compression/js/dictionary-compression.js and 1 other location - About 2 hrs to fix
csfieldguide/static/interactives/lzss-compression/js/lzss-compression.js on lines 191..198

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

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