Sign upLogin

opensheetmusicdisplay/opensheetmusicdisplay

View on GitHub
Star
src/MusicalScore/ScoreIO/MusicSymbolModules/ArticulationReader.ts

Summary

Maintainability
F
4 days
Test Coverage

Function addArticulationExpression has a Cognitive Complexity of 54 (exceeds 5 allowed). Consider refactoring.
Open

  public addArticulationExpression(node: IXmlElement, currentVoiceEntry: VoiceEntry): void {
    if (node !== undefined && node.elements().length > 0) {
      const childNodes: IXmlElement[] = node.elements();
      for (let idx: number = 0, len: number = childNodes.length; idx < len; ++idx) {
        const childNode: IXmlElement = childNodes[idx];
Severity: Minor
Found in src/MusicalScore/ScoreIO/MusicSymbolModules/ArticulationReader.ts - 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

Function addOrnament has a Cognitive Complexity of 45 (exceeds 5 allowed). Consider refactoring.
Open

  public addOrnament(ornamentsNode: IXmlElement, currentVoiceEntry: VoiceEntry): void {
    if (ornamentsNode) {
      let ornament: OrnamentContainer = undefined;

      interface XMLElementToOrnamentEnum {
Severity: Minor
Found in src/MusicalScore/ScoreIO/MusicSymbolModules/ArticulationReader.ts - About 6 hrs 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 addArticulationExpression has 78 lines of code (exceeds 25 allowed). Consider refactoring.
Open

  public addArticulationExpression(node: IXmlElement, currentVoiceEntry: VoiceEntry): void {
    if (node !== undefined && node.elements().length > 0) {
      const childNodes: IXmlElement[] = node.elements();
      for (let idx: number = 0, len: number = childNodes.length; idx < len; ++idx) {
        const childNode: IXmlElement = childNodes[idx];
Severity: Major
Found in src/MusicalScore/ScoreIO/MusicSymbolModules/ArticulationReader.ts - About 3 hrs to fix

    File ArticulationReader.ts has 294 lines of code (exceeds 250 allowed). Consider refactoring.
    Open

    import {ArticulationEnum, VoiceEntry} from "../../VoiceData/VoiceEntry";
import {IXmlAttribute, IXmlElement} from "../../../Common/FileIO/Xml";
import log from "loglevel";
import {TechnicalInstruction, TechnicalInstructionType} from "../../VoiceData/Instructions/TechnicalInstruction";
import {OrnamentContainer, OrnamentEnum} from "../../VoiceData/OrnamentContainer";
    Severity: Minor
    Found in src/MusicalScore/ScoreIO/MusicSymbolModules/ArticulationReader.ts - About 3 hrs to fix

      Function addTechnicalArticulations has a Cognitive Complexity of 18 (exceeds 5 allowed). Consider refactoring.
      Open

        public addTechnicalArticulations(technicalNode: IXmlElement, currentVoiceEntry: VoiceEntry, currentNote: Note): void {
    interface XMLElementToArticulationEnum {
      [xmlElement: string]: ArticulationEnum;
    }
    const xmlElementToArticulationEnum: XMLElementToArticulationEnum = {
      Severity: Minor
      Found in src/MusicalScore/ScoreIO/MusicSymbolModules/ArticulationReader.ts - About 2 hrs 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 addOrnament has 59 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

        public addOrnament(ornamentsNode: IXmlElement, currentVoiceEntry: VoiceEntry): void {
    if (ornamentsNode) {
      let ornament: OrnamentContainer = undefined;

      interface XMLElementToOrnamentEnum {
      Severity: Major
      Found in src/MusicalScore/ScoreIO/MusicSymbolModules/ArticulationReader.ts - About 2 hrs to fix

        Function addTechnicalArticulations has 48 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

          public addTechnicalArticulations(technicalNode: IXmlElement, currentVoiceEntry: VoiceEntry, currentNote: Note): void {
    interface XMLElementToArticulationEnum {
      [xmlElement: string]: ArticulationEnum;
    }
    const xmlElementToArticulationEnum: XMLElementToArticulationEnum = {
        Severity: Minor
        Found in src/MusicalScore/ScoreIO/MusicSymbolModules/ArticulationReader.ts - About 1 hr to fix

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

            private getAccEnumFromString(input: string): AccidentalEnum {
    switch (input) {
      case "sharp":
        return AccidentalEnum.SHARP;
      case "flat":
          Severity: Minor
          Found in src/MusicalScore/ScoreIO/MusicSymbolModules/ArticulationReader.ts - About 1 hr to fix

            Avoid deeply nested control flow statements.
            Open

                          if (currentVoiceEntry.Articulations.length > 0 &&
                currentVoiceEntry.Articulations[0].articulationEnum !== ArticulationEnum.staccato) {
                currentVoiceEntry.Articulations.splice(0, 0, newArticulation); // TODO can't this overwrite another articulation?
              }
            Severity: Major
            Found in src/MusicalScore/ScoreIO/MusicSymbolModules/ArticulationReader.ts - About 45 mins to fix

              Avoid deeply nested control flow statements.
              Open

                          if (accidentalNode.hasAttributes && placementAttr) {
              text = placementAttr.value;
              if (text === "above") {
                placement = PlacementEnum.Above;
              } else if (text === "below") {
              Severity: Major
              Found in src/MusicalScore/ScoreIO/MusicSymbolModules/ArticulationReader.ts - About 45 mins to fix

                Avoid deeply nested control flow statements.
                Open

                            else if (name === "breathmark") { // breath-mark
              if (placement === PlacementEnum.NotYetDefined) {
                newArticulation.placement = PlacementEnum.Above;
              }
            }
                Severity: Major
                Found in src/MusicalScore/ScoreIO/MusicSymbolModules/ArticulationReader.ts - About 45 mins to fix

                  Avoid deeply nested control flow statements.
                  Open

                              if (placementString === "below") {
              ornament.placement = PlacementEnum.Below;
            }
                  Severity: Major
                  Found in src/MusicalScore/ScoreIO/MusicSymbolModules/ArticulationReader.ts - About 45 mins to fix

                    Avoid deeply nested control flow statements.
                    Open

                                if (placement === PlacementEnum.Above) {
              ornament.AccidentalAbove = accidental;
            } else if (placement === PlacementEnum.Below) {
              ornament.AccidentalBelow = accidental;
            }
                    Severity: Major
                    Found in src/MusicalScore/ScoreIO/MusicSymbolModules/ArticulationReader.ts - About 45 mins to fix

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

                                    if (text === "above") {
                placement = PlacementEnum.Above;
              } else if (text === "below") {
                placement = PlacementEnum.Below;
              }
                      Severity: Minor
                      Found in src/MusicalScore/ScoreIO/MusicSymbolModules/ArticulationReader.ts and 2 other locations - About 30 mins to fix
                      src/MusicalScore/ScoreIO/MusicSymbolModules/ArticulationReader.ts on lines 80..84
                      src/MusicalScore/ScoreIO/VoiceGenerator.ts on lines 416..420

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

                      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 (placementValue === "above") {
              placement = PlacementEnum.Above;
            } else if (placementValue === "below") {
              placement = PlacementEnum.Below;
            }
                      Severity: Minor
                      Found in src/MusicalScore/ScoreIO/MusicSymbolModules/ArticulationReader.ts and 2 other locations - About 30 mins to fix
                      src/MusicalScore/ScoreIO/MusicSymbolModules/ArticulationReader.ts on lines 319..323
                      src/MusicalScore/ScoreIO/VoiceGenerator.ts on lines 416..420

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

                      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