zhuhaow/NEKit

View on GitHub
src/Crypto/SodiumStreamCrypto.swift

Summary

Maintainability
B
4 hrs
Test Coverage

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

    open func update(_ data: inout Data) {
        guard data.count > 0 else {
            return
        }

Severity: Minor
Found in src/Crypto/SodiumStreamCrypto.swift - About 1 hr to fix

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

        open func update(_ data: inout Data) {
            guard data.count > 0 else {
                return
            }
    
    
    Severity: Minor
    Found in src/Crypto/SodiumStreamCrypto.swift - 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

    import Foundation
    import Sodium
    
    open class SodiumStreamCrypto: StreamCryptoProtocol {
        public enum Alogrithm {
    Severity: Major
    Found in src/Crypto/SodiumStreamCrypto.swift and 1 other location - About 2 hrs to fix
    src/Crypto/SodiumStreamCrypto.swift on lines 1..69

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

    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

    Function should have at least one blank line after it
    Open

        }
    Severity: Minor
    Found in src/Crypto/SodiumStreamCrypto.swift by tailor

    function-whitespace

    Every function and method declaration should have one blank line before and after itself. An exception to this rule are functions that are declared at the start of a file (only need one blank line after their declaration) or at the end of a file (only need one blank line before their declaration). Comments immediately before a function declaration (no blank lines between them and the function) are considered to be part of the declaration.

    Preferred

    func function1() {
      var text = 1
      var text = 2
    }
    
    function1()
    
    // a comment
    func function2() {
      // something goes here
    }
    
    struct SomeStruct {
    
      func function3() {
        // something goes here
      }
    
      func function4() {
        // something else goes here
      };
    
    }
    
    func function5() {
      // something goes here
    }

    Not Preferred

    func function1() {
      var text = 1
      var text = 2
    }
    function1()
    // a comment
    func function2() {
      // something goes here
    }
    
    struct SomeStruct {
      func function3() {
        // something goes here
      }
    
      func function4() {
        // something else goes here
      };
    }
    func function5() {
      // something goes here
    }

    There are no issues that match your filters.

    Category
    Status