JohnCoates/Aerial

View on GitHub
Aerial/Source/Models/API/OneCall.swift

Summary

Maintainability
D
2 days
Test Coverage

Function fetch has a Cognitive Complexity of 31 (exceeds 5 allowed). Consider refactoring.
Open

    static func fetch(completion: @escaping(Result<OCOneCall, NetworkError>) -> Void) {
        guard testJson == "" else {
            let jsonData = testJson.data(using: .utf8)!

            do {
Severity: Minor
Found in Aerial/Source/Models/API/OneCall.swift - 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

Function fetch has 58 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    static func fetch(completion: @escaping(Result<OCOneCall, NetworkError>) -> Void) {
        guard testJson == "" else {
            let jsonData = testJson.data(using: .utf8)!

            do {
Severity: Major
Found in Aerial/Source/Models/API/OneCall.swift - About 2 hrs to fix

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

        private static func fetchData(from urlString: String, completion: @escaping (Result<String, NetworkError>) -> Void) {
            // check the URL is OK, otherwise return with a failure
            guard let url = URL(string: urlString) else {
                completion(.failure(.badURL))
                return
    Severity: Minor
    Found in Aerial/Source/Models/API/OneCall.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

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

        private static func fetchData(from urlString: String, completion: @escaping (Result<String, NetworkError>) -> Void) {
            // check the URL is OK, otherwise return with a failure
            guard let url = URL(string: urlString) else {
                completion(.failure(.badURL))
                return
    Severity: Major
    Found in Aerial/Source/Models/API/OneCall.swift and 3 other locations - About 2 hrs to fix
    Aerial/Source/Models/API/Forecast.swift on lines 228..251
    Aerial/Source/Models/API/GeoCoding.swift on lines 83..106
    Aerial/Source/Models/API/OpenWeather.swift on lines 223..246

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

    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

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

        static func getShortcodeLanguage() -> String {
            // Those are the languages supported by OpenWeather
            let weatherLanguages = ["af", "al", "ar", "az", "bg", "ca", "cz", "da", "de", "el", "en",
                                    "eu", "fa", "fi", "fr", "gl", "he", "hi", "hr", "hu", "id", "it",
                                    "ja", "kr", "la", "lt", "mk", "no", "nl", "pl", "pt", "pt_br", "ro",
    Severity: Major
    Found in Aerial/Source/Models/API/OneCall.swift and 2 other locations - About 2 hrs to fix
    Aerial/Source/Models/API/Forecast.swift on lines 119..140
    Aerial/Source/Models/API/OpenWeather.swift on lines 114..135

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

    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

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

                    fetchData(from: makeUrl(lat: lat, lon: lon)) { result in
                        switch result {
                        case .success(let jsonString):
                            let jsonData = jsonString.data(using: .utf8)!
    
    
    Severity: Major
    Found in Aerial/Source/Models/API/OneCall.swift and 1 other location - About 1 hr to fix
    Aerial/Source/Models/API/OneCall.swift on lines 241..256

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

    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

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

                        fetchData(from: makeUrl(lat: geoLocation.lat, lon: geoLocation.lon)) { result in
                            switch result {
                            case .success(let jsonString):
                                let jsonData = jsonString.data(using: .utf8)!
    
    
    Severity: Major
    Found in Aerial/Source/Models/API/OneCall.swift and 1 other location - About 1 hr to fix
    Aerial/Source/Models/API/OneCall.swift on lines 217..232

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

    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

        static func makeUrl(lat: String, lon: String) -> String {
            return "http://api.openweathermap.org/data/2.5/onecall"
                + "?lat=\(lat)&lon=\(lon)"
                + "&units=\(getUnits())"
                + "&lang=\(getShortcodeLanguage())"
    Severity: Major
    Found in Aerial/Source/Models/API/OneCall.swift and 2 other locations - About 40 mins to fix
    Aerial/Source/Models/API/Forecast.swift on lines 142..148
    Aerial/Source/Models/API/OpenWeather.swift on lines 137..143

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

    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 */

    Function should have at least one blank line after it
    Open

        }

    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
    }

    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 */

    Line should not have any trailing whitespace
    Open

            

    trailing-whitespace

    Flag whitespace after the last non-whitespace character on each line until the newline.

    Preferred

    let number = 42¬

    Not Preferred

    let number = 42••¬

    Function should have at least one blank line after it
    Open

        }

    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
    }

    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 */

    There are no issues that match your filters.

    Category
    Status