uccser/cs-field-guide

View on GitHub
csfieldguide/static/interactives/cfg-parsing-challenge/js/cfg-parsing-challenge.js

Summary

Maintainability
F
3 days
Test Coverage

File cfg-parsing-challenge.js has 519 lines of code (exceeds 250 allowed). Consider refactoring.
Open

var urlParameters = require('../../../js/third-party/url-parameters.js');

/**
* Productions in the default grammar.
* A number or a string that begins and ends with an inverted comma (') is

Function findPossibleExpressionsAtDepth has a Cognitive Complexity of 40 (exceeds 5 allowed). Consider refactoring.
Open

function findPossibleExpressionsAtDepth(depth) {
  if (depth <= 1) {
    // Look for productions that result in terminals
    for (let nonterminal of Object.keys(productions_)) {
      expressionsAtDepth_[1][nonterminal] = [];

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 parseUrlParameters has a Cognitive Complexity of 19 (exceeds 5 allowed). Consider refactoring.
Open

function parseUrlParameters() {
  if (urlParameters.getUrlParameter('hide-builder') == 'true') {
    $('#grammar-builder-button').hide();
  }
  if (urlParameters.getUrlParameter('editable-target') == 'true') {

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 parseUrlParameters has 49 lines of code (exceeds 25 allowed). Consider refactoring.
Open

function parseUrlParameters() {
  if (urlParameters.getUrlParameter('hide-builder') == 'true') {
    $('#grammar-builder-button').hide();
  }
  if (urlParameters.getUrlParameter('editable-target') == 'true') {

Function findPossibleExpressionsAtDepth has 43 lines of code (exceeds 25 allowed). Consider refactoring.
Open

function findPossibleExpressionsAtDepth(depth) {
  if (depth <= 1) {
    // Look for productions that result in terminals
    for (let nonterminal of Object.keys(productions_)) {
      expressionsAtDepth_[1][nonterminal] = [];

Avoid deeply nested control flow statements.
Open

          while (d<depth) {
            if (expressionsAtDepth_[d][element].length > 0) {
              path[path.length - 1].push([d, element]);
              innerSuccess = true;
            }

Avoid deeply nested control flow statements.
Open

          if (!innerSuccess) {
            outerSuccess = false;
          }

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

function recursiveRandomExpression(depth, nonterminal) {
  if (expressionsAtDepth_[depth][nonterminal].length <= 0) {
    throw (`${depth}: No possible replacements for ${nonterminal}.`
    + 'If this is NOT the first level of recursion then we have a problem.');
  }

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 getLink has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
Open

function getLink() {
  var instruction = gettext("This link will open the interactive with your set productions:");
  var productions = $("#cfg-grammar-input").val().trim();
  if (productions.length <= 0) {
    $("#cfg-grammar-link").html("");

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 isCompressable has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
Open

function isCompressable(replacements) {
  if (replacements.length < 2) return false;
  let firstValue = replacements[0];
  if (!(firstValue.length == 1 && isIntegerTerminal(firstValue[0]))) {
    return false;

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

  } else {
    $('#cfg-equation').removeClass('success');
    $('#generate-button').removeClass('success');
    $('#generate-dropdown').removeClass('success');
  }
csfieldguide/static/interactives/cfg-parsing-challenge/js/cfg-parsing-challenge.js on lines 379..383
csfieldguide/static/interactives/data-visualisation/js/data-visualisation.js on lines 468..473

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

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 ($('#cfg-target').val().trim() == $('#cfg-equation').html().trim()) {
    $('#cfg-equation').addClass('success');
    $('#generate-button').addClass('success');
    $('#generate-dropdown').addClass('success');
  } else {
csfieldguide/static/interactives/cfg-parsing-challenge/js/cfg-parsing-challenge.js on lines 383..387
csfieldguide/static/interactives/data-visualisation/js/data-visualisation.js on lines 468..473

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

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