ckeditor/ckeditor5-engine

View on GitHub
src/model/documentselection.js

Summary

Maintainability
F
3 days
Test Coverage

File documentselection.js has 464 lines of code (exceeds 250 allowed). Consider refactoring.
Open

/**
 * @license Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved.
 * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
 */

Severity: Minor
Found in src/model/documentselection.js - About 7 hrs to fix

    Function _getSurroundingAttributes has a Cognitive Complexity of 30 (exceeds 5 allowed). Consider refactoring.
    Open

        _getSurroundingAttributes() {
            const position = this.getFirstPosition();
            const schema = this._model.schema;
    
            let attrs = null;
    Severity: Minor
    Found in src/model/documentselection.js - About 4 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

    DocumentSelection has 34 functions (exceeds 20 allowed). Consider refactoring.
    Open

    export default class DocumentSelection {
        /**
         * Creates an empty live selection for given {@link module:engine/model/document~Document}.
         *
         * @param {module:engine/model/document~Document} doc Document which owns this selection.
    Severity: Minor
    Found in src/model/documentselection.js - About 4 hrs to fix

      LiveSelection has 28 functions (exceeds 20 allowed). Consider refactoring.
      Open

      class LiveSelection extends Selection {
          // Creates an empty live selection for given {@link module:engine/model/document~Document}.
          // @param {module:engine/model/document~Document} doc Document which owns this selection.
          constructor( doc ) {
              super();
      Severity: Minor
      Found in src/model/documentselection.js - About 3 hrs to fix

        Function _updateAttributes has a Cognitive Complexity of 14 (exceeds 5 allowed). Consider refactoring.
        Open

            _updateAttributes( clearAll ) {
                const newAttributes = toMap( this._getSurroundingAttributes() );
                const oldAttributes = toMap( this.getAttributes() );
        
                if ( clearAll ) {
        Severity: Minor
        Found in src/model/documentselection.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 _getSurroundingAttributes has 42 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            _getSurroundingAttributes() {
                const position = this.getFirstPosition();
                const schema = this._model.schema;
        
                let attrs = null;
        Severity: Minor
        Found in src/model/documentselection.js - About 1 hr to fix

          Function _updateMarkers has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
          Open

              _updateMarkers() {
                  const markers = [];
                  let changed = false;
          
                  for ( const marker of this._model.markers ) {
          Severity: Minor
          Found in src/model/documentselection.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 constructor has 37 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

              constructor( doc ) {
                  super();
          
                  // List of selection markers.
                  // Marker is a selection marker when selection range is inside the marker range.
          Severity: Minor
          Found in src/model/documentselection.js - About 1 hr to fix

            Function _updateAttributes has 28 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

                _updateAttributes( clearAll ) {
                    const newAttributes = toMap( this._getSurroundingAttributes() );
                    const oldAttributes = toMap( this.getAttributes() );
            
                    if ( clearAll ) {
            Severity: Minor
            Found in src/model/documentselection.js - About 1 hr to fix

              Function _updateMarkers has 26 lines of code (exceeds 25 allowed). Consider refactoring.
              Open

                  _updateMarkers() {
                      const markers = [];
                      let changed = false;
              
                      for ( const marker of this._model.markers ) {
              Severity: Minor
              Found in src/model/documentselection.js - About 1 hr to fix

                Function _setAttributesTo has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
                Open

                    _setAttributesTo( attrs ) {
                        const changed = new Set();
                
                        for ( const [ oldKey, oldValue ] of this.getAttributes() ) {
                            // Do not remove attribute if attribute with same key and value is about to be set.
                Severity: Minor
                Found in src/model/documentselection.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

                Function _getStoredAttributes has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
                Open

                    * _getStoredAttributes() {
                        const selectionParent = this.getFirstPosition().parent;
                
                        if ( this.isCollapsed && selectionParent.isEmpty ) {
                            for ( const key of selectionParent.getAttributeKeys() ) {
                Severity: Minor
                Found in src/model/documentselection.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

                            if ( !attrs ) {
                                let node = nodeAfter;
                
                                while ( node && !attrs ) {
                                    node = node.nextSibling;
                Severity: Minor
                Found in src/model/documentselection.js and 1 other location - About 35 mins to fix
                src/model/documentselection.js on lines 1092..1099

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

                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

                            if ( !this.isGravityOverridden && !attrs ) {
                                let node = nodeBefore;
                
                                while ( node && !attrs ) {
                                    node = node.previousSibling;
                Severity: Minor
                Found in src/model/documentselection.js and 1 other location - About 35 mins to fix
                src/model/documentselection.js on lines 1102..1109

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

                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