Refactor SunKit's Sun

Sources/SunKit/Angle.swift

@@ -16,11 +16,10 @@
 //   See the License for the specific language governing permissions and
 //   limitations under the License.
 
-
 import Foundation
 
+
 public struct Angle: Equatable, Hashable, Codable, Sendable {
-
     public static var zero: Angle = .init()
 
     public init() {
@@ -30,11 +29,11 @@ public struct Angle: Equatable, Hashable, Codable, Sendable {
     public init(radians: Double) {
         _radians = radians
     }
-
+    
     public init(degrees: Double) {
         _radians = degrees * Double.pi / 180.0
     }
-        
+
     public var degrees: Double {
         get { _radians * 180.0 / Double.pi }
         set { _radians = newValue * Double.pi / 180 }
@@ -54,5 +53,4 @@ public struct Angle: Equatable, Hashable, Codable, Sendable {
     public static func radians(_ value: Double) -> Angle {
         .init(radians: value)
     }
-
 }

Sources/SunKit/DMS.swift

@@ -18,16 +18,20 @@
 
 import Foundation
 
+
 /// DMS format to express angles
 public struct DMS: Equatable, Hashable, Codable, Sendable {
-
     public var degrees: Double
     public var minutes: Double
     public var seconds: Double
     public var isANegativeZero: Bool
 
-
-    init(degrees: Double, minutes: Double, seconds: Double, isANegativeZero: Bool = false) {
+    init(
+        degrees: Double,
+        minutes: Double,
+        seconds: Double,
+        isANegativeZero: Bool = false
+    ) {
         self.degrees = degrees
         self.minutes = minutes
         self.seconds = seconds
@@ -36,8 +40,7 @@ public struct DMS: Equatable, Hashable, Codable, Sendable {
 
     ///From decimal it will create the corresponding angle in DMS format
     /// - Parameter decimal: Decimal angle that will be converted in DMS format
-    public init(decimal: Double){
-
+    public init(decimal: Double) {
         //Step1:
         let sign = decimal < 0 ? -1 : 1
         //Step2:
@@ -50,26 +53,23 @@ public struct DMS: Equatable, Hashable, Codable, Sendable {
         let seconds = 60 * (60 * dec.truncatingRemainder(dividingBy: 1)).truncatingRemainder(dividingBy: 1)
         //Step6:
         degrees *= sign
+
         if degrees == 0 && sign == -1 {
             self.degrees = Double(degrees)
             self.minutes = Double(minutes)
             self.seconds = seconds
             self.isANegativeZero = true
-        }
-        else{
+        } else {
             self.degrees = Double(degrees)
             self.minutes = Double(minutes)
             self.seconds = seconds
             self.isANegativeZero = false
         }
-
-
     }
 
     /// It converts from DMS format to decimal
     /// - Returns: DMS of the instance expressed in decimal format
     public func dMS2Decimal() -> Double {
-
         //Step1:
         let sign: Double = degrees < 0 ? -1 : 1
         //Step2:
@@ -86,7 +86,6 @@ public struct DMS: Equatable, Hashable, Codable, Sendable {
         decimal *= sign
 
         if isANegativeZero{
-
             decimal *= -1
         }
 

Sources/SunKit/Extensions/Calendar+startOfYear.swift

@@ -0,0 +1,34 @@
+//
+//  Calendar+startOfYear.swift
+//
+//
+//   Copyright 2024 Leonardo Bertinelli, Davide Biancardi, Raffaele Fulgente, Clelia Iovine, Nicolas Mariniello, Fabio Pizzano
+//
+//   Licensed under the Apache License, Version 2.0 (the "License");
+//   you may not use this file except in compliance with the License.
+//   You may obtain a copy of the License at
+//
+//       http://www.apache.org/licenses/LICENSE-2.0
+//
+//   Unless required by applicable law or agreed to in writing, software
+//   distributed under the License is distributed on an "AS IS" BASIS,
+//   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//   See the License for the specific language governing permissions and
+//   limitations under the License.
+
+import Foundation
+
+
+extension Calendar {
+    func numberOfDaysSinceStartOfTheYear(for date: Date) -> Int {
+        let startOfTheYear: Date = startOfYear(date)
+        let startOfTheDay = startOfDay(for: date)
+        let numberOfDays = dateComponents([.day], from: startOfTheYear, to: startOfTheDay)
+
+        return numberOfDays.day! + 1
+    }
+
+    func startOfYear(_ date: Date) -> Date {
+        return self.date(from: self.dateComponents([.year], from: date))!
+    }
+}

Sources/SunKit/Extensions.swift → Sources/SunKit/Extensions/Date+Strideable.swift

@@ -1,6 +1,6 @@
 //
-//  Extensions.swift
-//  
+//  Date+Strideable.swift
+//
 //
 //   Copyright 2024 Leonardo Bertinelli, Davide Biancardi, Raffaele Fulgente, Clelia Iovine, Nicolas Mariniello, Fabio Pizzano
 //
@@ -18,7 +18,8 @@
 
 import Foundation
 
-//It consents us too loop between two dates for n as interval time
+
+// Allows us to loop between two dates using interval time n.
 extension Date: @retroactive Strideable {
     public func distance(to other: Date) -> TimeInterval {
         return other.timeIntervalSinceReferenceDate - self.timeIntervalSinceReferenceDate
@@ -27,42 +28,17 @@ extension Date: @retroactive Strideable {
     func toString(_ timeZone: TimeZone) -> String {
         let df = DateFormatter()
         df.timeZone = timeZone
-        let custom = DateFormatter.dateFormat(fromTemplate: "MMdd HH:mm",
-                                              options: 0,
-                                              locale: Locale(identifier: "en"))
+        let custom = DateFormatter.dateFormat(
+            fromTemplate: "MMdd HH:mm",
+            options: 0,
+            locale: Locale(identifier: "en")
+        )
         df.dateFormat = custom
+
         return df.string(from: self)
     }
 
     public func advanced(by n: TimeInterval) -> Date {
         return self + n
     }
 }
-
-extension Calendar {
-    func numberOfDaysSinceStartOfTheYear(for date: Date) -> Int {
-        let startOfTheYear: Date = startOfYear(date)
-        let startOfTheDay = startOfDay(for: date)
-        let numberOfDays = dateComponents([.day], from: startOfTheYear, to: startOfTheDay)
-
-        return numberOfDays.day! + 1
-    }
-
-    func startOfYear(_ date: Date) -> Date {
-        return self.date(from: self.dateComponents([.year], from: date))!
-    }
-
-}
-
-extension TimeZone {
-
-    func offset(_ date: Date) -> Double {
-        let res =
-        Int(self.secondsFromGMT(for: date))
-        + Int(self.daylightSavingTimeOffset(for: date))
-        - Int(Calendar.current.timeZone.secondsFromGMT(for: date))
-        - Int(Calendar.current.timeZone.daylightSavingTimeOffset(for: date))
-        return Double(res)/SECONDS_IN_ONE_HOUR
-
-    }
-}

Sources/SunKit/Extensions/TimeZone+offset.swift

@@ -0,0 +1,31 @@
+//
+//  TimeZone+offset.swift
+//
+//
+//   Copyright 2024 Leonardo Bertinelli, Davide Biancardi, Raffaele Fulgente, Clelia Iovine, Nicolas Mariniello, Fabio Pizzano
+//
+//   Licensed under the Apache License, Version 2.0 (the "License");
+//   you may not use this file except in compliance with the License.
+//   You may obtain a copy of the License at
+//
+//       http://www.apache.org/licenses/LICENSE-2.0
+//
+//   Unless required by applicable law or agreed to in writing, software
+//   distributed under the License is distributed on an "AS IS" BASIS,
+//   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//   See the License for the specific language governing permissions and
+//   limitations under the License.
+
+import Foundation
+
+
+extension TimeZone {
+    func offset(_ date: Date) -> Double {
+        let res = Int(self.secondsFromGMT(for: date))
+        + Int(self.daylightSavingTimeOffset(for: date))
+        - Int(Calendar.current.timeZone.secondsFromGMT(for: date))
+        - Int(Calendar.current.timeZone.daylightSavingTimeOffset(for: date))
+
+        return Double(res) / SECONDS_IN_ONE_HOUR
+    }
+}

Sources/SunKit/HMS.swift

@@ -1,6 +1,6 @@
 //
 //  HMS.swift
-//  
+//
 //
 //   Copyright 2024 Leonardo Bertinelli, Davide Biancardi, Raffaele Fulgente, Clelia Iovine, Nicolas Mariniello, Fabio Pizzano
 //
@@ -21,13 +21,11 @@ import Foundation
 
 /// Time expressed in HMS format
 public struct HMS: Equatable, Hashable, Codable, Sendable {
-
     public var hours: Double
     public var minutes: Double
     public var seconds: Double
 
     public init(from date: Date){
-
         var calendar: Calendar = .init(identifier: .gregorian)
         calendar.timeZone = .init(abbreviation: "GMT")!
 
@@ -37,14 +35,12 @@ public struct HMS: Equatable, Hashable, Codable, Sendable {
     }
 
     public init(hours: Double,minutes: Double,seconds: Double){
-
         self.hours = hours
         self.minutes = minutes
         self.seconds = seconds
     }
 
     public init(decimal: Double){
-
         //Step1:
         let sign = decimal < 0 ? -1 : 1
         //Step2:
@@ -57,17 +53,16 @@ public struct HMS: Equatable, Hashable, Codable, Sendable {
         let seconds = 60 * (60 * dec.truncatingRemainder(dividingBy: 1)).truncatingRemainder(dividingBy: 1)
         //Step6:
         hours *= sign
-
+        
         self.hours = Double(hours)
         self.minutes = Double(minutes)
         self.seconds = seconds
-
+        
     }
 
     /// It converts from HMS format to decimal
     /// - Returns: HMS of the instance expressed in decimal format
     public func hMS2Decimal() -> Double {
-
         //Step3:
         let dm: Double = Double(seconds / 60)
         //Step4:
@@ -79,5 +74,4 @@ public struct HMS: Equatable, Hashable, Codable, Sendable {
 
         return decimalHour
     }
-
 }

Sources/SunKit/EclipticCoordinates.swift → Sources/SunKit/Sun Coordinates/EclipticCoordinates.swift

@@ -20,33 +20,21 @@ import Foundation
 
 
 public struct EclipticCoordinates: Equatable, Hashable, Codable, Sendable {
-
     public static let obliquityOfTheEcliptic: Angle = .init(degrees: 23.439292)
 
     public var eclipticLatitude: Angle //beta
     public var eclipticLongitude: Angle //lambda
 
     /// Converts ecliptic coordinatates to equatorial coordinates
     /// - Returns: Equatorial coordinates of the instance
-    public func ecliptic2Equatorial() -> EquatorialCoordinates{
-
-        //Step4:
+    public func ecliptic2Equatorial() -> EquatorialCoordinates {
         let tEclipticToEquatorial: Angle = .init(radians: sin(eclipticLatitude.radians) * cos(EclipticCoordinates.obliquityOfTheEcliptic.radians) + cos(eclipticLatitude.radians) * sin(EclipticCoordinates.obliquityOfTheEcliptic.radians) * sin(eclipticLongitude.radians))
-
-        //Step5:
         let moonDeclination: Angle = .init(radians: asin(tEclipticToEquatorial.radians))
-
-        //Step6:
         let yEclipticToEquatorial = sin(eclipticLongitude.radians) * cos(EclipticCoordinates.obliquityOfTheEcliptic.radians) - tan(eclipticLatitude.radians) * sin(EclipticCoordinates.obliquityOfTheEcliptic.radians)
-
-        //Step7:
         let xEclipticToEquatorial = cos(eclipticLongitude.radians)
-
-        //Step8:
         var r: Angle = .init(radians: atan(yEclipticToEquatorial / xEclipticToEquatorial))
 
-        //Step9:
-        switch (yEclipticToEquatorial >= 0,xEclipticToEquatorial >= 0){
+        switch (yEclipticToEquatorial >= 0, xEclipticToEquatorial >= 0) {
 
         case (true, true):
             break
@@ -58,7 +46,7 @@ public struct EclipticCoordinates: Equatable, Hashable, Codable, Sendable {
             r.degrees += 180
         }
 
-        let alfa: Angle  = .init(degrees: r.degrees / 15)
+        let alfa: Angle = .init(degrees: r.degrees / 15)
         let delta: Angle = .init(degrees: moonDeclination.degrees)
 
         return .init(declination: delta, rightAscension: alfa)