JohnCoates/Aerial

View on GitHub
Aerial/Source/Models/Time/Solar.swift

Summary

Maintainability
C
1 day
Test Coverage

Function calculate has 52 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    fileprivate func calculate(_ sunriseSunset: SunriseSunset, for date: Date, and zenith: Zenith) -> Date? {
        guard let utcTimezone = TimeZone(identifier: "UTC") else { return nil }

        // Get the day of the year
        var calendar = Calendar(identifier: .gregorian)
Severity: Major
Found in Aerial/Source/Models/Time/Solar.swift - About 2 hrs to fix

    Function getTimeSlice has 36 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        public func getTimeSlice() -> String {
            guard
                let _ = sunrise,
                let _ = sunset
                else {
    Severity: Minor
    Found in Aerial/Source/Models/Time/Solar.swift - About 1 hr to fix

      Function getTimeSlice has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
      Open

          public func getTimeSlice() -> String {
              guard
                  let _ = sunrise,
                  let _ = sunset
                  else {
      Severity: Minor
      Found in Aerial/Source/Models/Time/Solar.swift - 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 isDaytime has 30 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          public func isDaytime(zenith: Zenith) -> Bool {
              guard
                  let _ = sunrise,
                  let _ = sunset
                  else {
      Severity: Minor
      Found in Aerial/Source/Models/Time/Solar.swift - About 1 hr to fix

        Function calculate has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
        Open

            public mutating func calculate() {
                strictSunrise = calculate(.sunrise, for: date, and: .strict)
                strictSunset = calculate(.sunset, for: date, and: .strict)
                sunrise = calculate(.sunrise, for: date, and: .official)
                sunset = calculate(.sunset, for: date, and: .official)
        Severity: Minor
        Found in Aerial/Source/Models/Time/Solar.swift - 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 calculate has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
        Open

            fileprivate func calculate(_ sunriseSunset: SunriseSunset, for date: Date, and zenith: Zenith) -> Date? {
                guard let utcTimezone = TimeZone(identifier: "UTC") else { return nil }
        
                // Get the day of the year
                var calendar = Calendar(identifier: .gregorian)
        Severity: Minor
        Found in Aerial/Source/Models/Time/Solar.swift - 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

        Avoid too many return statements within this function.
        Open

                    return "day"
        Severity: Major
        Found in Aerial/Source/Models/Time/Solar.swift - About 30 mins to fix

          Avoid too many return statements within this function.
          Open

                  return calendar.date(from: components)
          Severity: Major
          Found in Aerial/Source/Models/Time/Solar.swift - About 30 mins to fix

            Constant should be lowerCamelCase
            Open

                    let T = H + RA - (0.06571 * t) - 6.622

            constant-naming

            Global constants should follow either UpperCamelCase or lowerCamelCase naming conventions. Local constants should follow lowerCamelCase naming conventions.

            Preferred

            let MaxHeight = 42
            let maxHeight = 42

            Not Preferred

            let max_height = 42

            Constant should be lowerCamelCase
            Open

                    let M = (0.9856 * t) - 3.289

            constant-naming

            Global constants should follow either UpperCamelCase or lowerCamelCase naming conventions. Local constants should follow lowerCamelCase naming conventions.

            Preferred

            let MaxHeight = 42
            let maxHeight = 42

            Not Preferred

            let max_height = 42

            Constant should be lowerCamelCase
            Open

                    let Lquadrant = floor(L / 90) * 90

            constant-naming

            Global constants should follow either UpperCamelCase or lowerCamelCase naming conventions. Local constants should follow lowerCamelCase naming conventions.

            Preferred

            let MaxHeight = 42
            let maxHeight = 42

            Not Preferred

            let max_height = 42

            Variable names should be lowerCamelCase
            Open

                    var L = M + subexpression1 + subexpression2 + 282.634

            lower-camel-case

            method and var names should follow lowerCamelCase naming convention: first letter of the entire word is lowercase, but subsequent first letters are uppercase.

            Method and selector names

            Preferred

            func someMethod() {
                // method definition goes here
            }

            Not Preferred

            func some-method() {
                // method definition goes here
            }

            Variable names

            Preferred

            var someVariable = someValue

            Not Preferred

            var Some_Var1able = someValue

            Constant should be lowerCamelCase
            Open

                    let H = tempH / 15.0

            constant-naming

            Global constants should follow either UpperCamelCase or lowerCamelCase naming conventions. Local constants should follow lowerCamelCase naming conventions.

            Preferred

            let MaxHeight = 42
            let maxHeight = 42

            Not Preferred

            let max_height = 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
            }

            There are no issues that match your filters.

            Category
            Status