JohnCoates/Aerial

View on GitHub
Resources/MainUI/Settings panels/OverlaysViewController.swift

Summary

Maintainability
B
4 hrs
Test Coverage

Function drawInfoPanel has 47 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    func drawInfoPanel(forType: InfoType) {
        resetInfoPanel()

        // Add the common block of features (enabled, font, position, screen)
        infoScrollableView.addSubview(infoCommonView)
Severity: Minor
Found in Resources/MainUI/Settings panels/OverlaysViewController.swift - About 1 hr to fix

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

        func openWeatherPreview(weather: OWeather) {
            if !weatherPanel.isVisible {
                weatherPanel.makeKeyAndOrderFront(self)
            }
    
    
    Resources/MainUI/Settings panels/OverlaysViewController.swift on lines 217..227

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

    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

        func openWeatherPreview(weather: ForecastElement) {
            if !weatherPanel.isVisible {
                weatherPanel.makeKeyAndOrderFront(self)
            }
    
    
    Resources/MainUI/Settings panels/OverlaysViewController.swift on lines 204..214

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

    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

    //
    //  OverlaysViewController.swift
    //  Aerial
    //
    //  Created by Guillaume Louel on 19/07/2020.
    Severity: Minor
    Found in Resources/MainUI/Settings panels/OverlaysViewController.swift and 2 other locations - About 35 mins to fix
    Resources/MainUI/Settings panels/OverlaysViewController.swift on lines 1..232
    Resources/MainUI/Settings panels/OverlaysViewController.swift on lines 1..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 47.

    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

    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••¬

    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••¬

    Single-line comment should start with whitespace
    Open

        //@IBOutlet var infoContainerView: InfoContainerView!

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

    Single-line comment should start with whitespace
    Open

            //infoBox.title = "Advanced text settings"

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

    Single-line comment should start with whitespace
    Open

            //infoContainerView.addSubview(infoCommonView)

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

    Single-line comment should start with whitespace
    Open

                //infoScrollableView.setFrameSize(NSSize(width: infoScrollableView.frame.width, height: infoCommonView.frame.height + infoLocationView.frame.height))

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

    Single-line comment should start with whitespace
    Open

            //infoScrollView.documentView?.scroll(.zero)

    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••¬

    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••¬

    Single-line comment should start with whitespace
    Open

                //infoScrollableView.setFrameSize(NSSize(width: infoScrollableView.frame.width, height: infoCommonView.frame.height + infoLocationView.frame.height))

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

    Single-line comment should start with whitespace
    Open

                //infoScrollableView.setFrameSize(NSSize(width: infoScrollableView.frame.width, height: infoCommonView.frame.height + infoTimerView.frame.height))

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

    Single-line comment should start with whitespace
    Open

        //@IBOutlet var infoBox: NSBox!

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

    Single-line comment should start with whitespace
    Open

                //infoScrollableView.setFrameSize(NSSize(width: infoScrollableView.frame.width, height: infoCommonView.frame.height + infoBatteryView.frame.height))

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

    Single-line comment should start with whitespace
    Open

                //infoScrollableView.setFrameSize(NSSize(width: infoScrollableView.frame.width, height: infoCommonView.frame.height + infoMusicView.frame.height))

    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••¬

    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
    }

    Single-line comment should start with whitespace
    Open

                //infoScrollableView.setFrameSize(NSSize(width: infoScrollableView.frame.width, height: infoCommonView.frame.height + infoWeatherView.frame.height))

    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••¬

    Single-line comment should start with whitespace
    Open

                //infoScrollableView.setFrameSize(NSSize(width: infoScrollableView.frame.width, height: infoCommonView.frame.height + infoCountdownView.frame.height))

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

    Single-line comment should start with whitespace
    Open

                //infoScrollableView.setFrameSize(NSSize(width: infoScrollableView.frame.width, height: infoCommonView.frame.height + infoClockView.frame.height))

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

    Single-line comment should start with whitespace
    Open

            //infoContainerView.addSubview(infoSettingsView)

    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••¬

    Single-line comment should start with whitespace
    Open

                //infoScrollableView.setFrameSize(NSSize(width: infoScrollableView.frame.width, height: infoCommonView.frame.height + infoDateView.frame.height))

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

    Closure is the function's final argument and may be passed as a trailing closure instead
    Open

            infoScrollableView.subviews.forEach({ $0.removeFromSuperview() })

    trailing-closure

    Closures that are the last argument of a function should be passed into the function using trailing closure syntax.

    Preferred

    reversed = names.sort { s1, s2 in return s1 > s2 }

    Not Preferred

    reversed = names.sort({ s1, s2 in return s1 > s2 })

    There are no issues that match your filters.

    Category
    Status