Bloombox/Swift

View on GitHub
Sources/Client/TelemetryClient+Generic.swift

Summary

Maintainability
A
1 hr
Test Coverage

Function event has 6 arguments (exceeds 4 allowed). Consider refactoring.
Open

  public func event(collection: EventCollection,
                    uuid: String? = nil,
                    payload: [String: Any]? = nil,
                    occurred: Double? = nil,
                    context: EventContext? = nil,
Severity: Minor
Found in Sources/Client/TelemetryClient+Generic.swift - About 45 mins to fix

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

        if let c = context {
          var exported = c.export()
          let globalContext = settings.export()
          let serialized = try globalContext.serializedData()
          try exported.merge(serializedData: serialized)
    Severity: Major
    Found in Sources/Client/TelemetryClient+Generic.swift and 2 other locations - About 1 hr to fix
    Sources/Client/TelemetryClient+Commercial.swift on lines 99..107
    Sources/Client/TelemetryClient+Search.swift on lines 66..74

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

    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

    Multiline comment should end with whitespace
    Open

    **/

    comment-whitespace

    Prefer at least one whitespace character after a comment opening symbol (//, ///, /*, or /**) and at least one whitespace character before a comment closing symbol (*/).

    Preferred

    // This is a comment
    
    /// This is a documentation comment
    
    /* This is a
    multi-line comment */
    
    /* This is a
    multi-line comment
    */
    
    /** This is a
    documentation multi-line
    comment
    */

    Not Preferred

    //This is a comment
    
    ///This is a documentation comment
    
    /*This is a
    multi-line comment*/
    
    /**This is a multi-line
    documentation comment */

    Initializer expression should not be enclosed within parentheses
    Open

        let eventPayload: ProtobufStruct? = (

    redundant-parentheses

    Control flow constructs (if, else if, switch, for, while, repeat-while, and guard statements), Exception handling constructs (throw, and do/catch statements), and Initializers (array, dictionary, initializer patterns) should not be enclosed in parentheses.

    Additionally, method calls with no parameters and a trailing closure should not have empty parentheses following the method name.

    Control flow constructs

    • if, else if statement

    Preferred

    if SomeCondition {
    
    } else if SomeOtherCondition {
    }

    Not Preferred

    if (SomeCondition) {
    
    } else if (SomeOtherCondition) {
    }
    • switch statement

    Preferred

    switch SomeData {
        default:
            break
    }

    Not Preferred

    switch (SomeData) {
        default:
            break
    }
    • for loop

    Preferred

    for var i = 0; i < 10; i+=1 {
    
    }

    Not Preferred

    for (var i = 0; i < 10; i+=1) {
    
    }
    • while loop

    Preferred

    while SomeCondition {
    
    }

    Not Preferred

    while (SomeCondition) {
    
    }
    • repeat-while loop

    Preferred

    repeat {
    
    } while SomeCondition

    Not Preferred

    repeat {
    
    } while (SomeCondition)
    • guard clause

    Preferred

    guard true else {   }

    Not Preferred

    guard (true) else {   }

    Exception handling constructs

    • do/catch statement

    Preferred

    do  {
    
    } catch SomeException {
    
    }

    Not Preferred

    do  {
    
    } catch (SomeException) {
    
    }
    • throw statement

    Preferred

    throw SomeException

    Not Preferred

    throw (SomeException)

    Initializers

    • array items

    Preferred

    var shoppingList: [String] = ["Eggs", "Milk"]

    Not Preferred

    var shoppingList: [String] = [("Eggs"), ("Milk")]
    • dictionary items

    Preferred

    var airports: [String: String] = ["YYZ": "Toronto Pearson", "DUB": "Dublin"]

    Not Preferred

    var airports: [String: String] = [("YYZ"): ("Toronto Pearson"), ("DUB"): ("Dublin")]
    • initializer patterns

    Preferred

    var x: Int = 2
    var y: String = "Sleekbyte"
    var x = 2

    Not Preferred

    var x: Int = (2)
    var y: String = ("Sleekbyte")
    var x = (2)

    Method calls

    Preferred

    items.map {
      item in item.transform()
    }

    Not Preferred

    items.map() {
      item in item.transform()
    }

    There are no issues that match your filters.

    Category
    Status