gem-hunter

Description

Installation

dependencies: [
  .package(url: "https://github.com/markbattistella/ZodiacKit", from: "26.2.21")
]

Caution

v1.x to v2.x has some breaking changes. v2.x to v3.x has some breaking changes.

Requirements

Usage

import ZodiacKit

Basic Usage

let zodiacService = ZodiacService()
let dateComponents = DateComponents(year: 1991, month: 5, day: 29)
let birthDate = Calendar.current.date(from: dateComponents)!

let westernZodiacSign = try zodiacService.getWesternZodiac(from: birthDate)
let chineseZodiacSign = try zodiacService.getChineseZodiac(from: birthDate)

// westernZodiacSign.name: Gemini 
// chineseZodiacSign.name: Goat

Custom date ranges (Western only)

let customZodiacs: [Zodiac] = [
  Zodiac(
    sign: .aquarius,
    start: .init(day: 22, month: 1),
    end: .init(day: 19, month: 2)
  ),
  // ...
]

let zodiacService = ZodiacService(system: .custom(customZodiacs))

In-app usage

UIKit

import UIKit
import ZodiacKit

class ViewController: UIViewController {
    override func viewDidLoad() {
        super.viewDidLoad()

        do {
            let zodiacService = ZodiacService()
            let dateComponents = DateComponents(year: 1991, month: 5, day: 29)
            let birthDate = Calendar.current.date(from: dateComponents)!

            let westernZodiacSign = try zodiacService.getWesternZodiac(from: birthDate)
            let chineseZodiacSign = try zodiacService.getChineseZodiac(from: birthDate)

            // Use signs...
            print(westernZodiacSign.name) // Gemini
            print(chineseZodiacSign.name) // Goat
        } catch {
            print("Failed to get zodiac sign: \(error)")
        }
    }
}

SwiftUI

import SwiftUI
import ZodiacKit

struct ContentView: View {
  @StateObject private var zodiacService = ZodiacService()

  @State private var westernZodiacSign: Western?
  @State private var chineseZodiacSign: Chinese?

  var body: some View {
    VStack {
      if let westernSign = westernZodiacSign, let chineseSign = chineseZodiacSign {
        Text("Your zodiac sign is \(westernSign.name)")
        Text("Your Chinese zodiac sign is \(chineseSign.name)")
      } else {
        Text("Failed to get zodiac sign")
      }
    }
    .task {
      do {
        let dateComponents = DateComponents(year: 1991, month: 5, day: 29)
        let birthDate = Calendar.current.date(from: dateComponents)!
        westernZodiacSign = try zodiacService.getWesternZodiac(from: birthDate)
        chineseZodiacSign = try zodiacService.getChineseZodiac(from: birthDate)
      } catch {
        print("Failed to get zodiac sign: \(error)")
      }
    }
  }
}

AppKit

import AppKit
import ZodiacKit

class ViewController: NSViewController {
    override func viewDidLoad() {
        super.viewDidLoad()

        do {
            let zodiacService = ZodiacService()
            let dateComponents = DateComponents(year: 1991, month: 5, day: 29)
            let birthDate = Calendar.current.date(from: dateComponents)!

            let westernZodiacSign = try zodiacService.getWesternZodiac(from: birthDate)
            let chineseZodiacSign = try zodiacService.getChineseZodiac(from: birthDate)

            // Use signs...
            print(westernZodiacSign.name) // Gemini
            print(chineseZodiacSign.name) // Goat
        } catch {
            print("Failed to get zodiac sign: \(error)")
        }
    }
}

Default Date Ranges

Tropical System

Sidereal System (Vedic)

Equal-Length System

Astronomical (IAU) System

Validation

Error Handling

Example

/// A demo view that shows zodiac sign results from multiple Western systems and the Chinese zodiac. Users can select a date, and the relevant signs are calculated and displayed.
struct ZodiacDemo: View {
  @StateObject private var serviceTropical = ZodiacService(system: .tropical)
  @StateObject private var serviceSidereal = ZodiacService(system: .sidereal)
  @StateObject private var serviceEqual = ZodiacService(system: .equalLength)
  @StateObject private var serviceIAU = ZodiacService(system: .astronomicalIAU)

  @State private var western: (
    tropical: Western,
    sidereal: Western,
    equal: Western,
    iau: Western
  )? = nil

  @State private var chinese: Chinese? = nil
  @State private var selectedDate: Date = .now

  var body: some View {
    Form {
      if let western {
        Section("Western Zodiac") {
          LabeledContent("Tropical", value: western.tropical.name)
          LabeledContent("Sidereal", value: western.sidereal.name)
          LabeledContent("Equal Length", value: western.equal.name)
          LabeledContent("Astronomical IAU", value: western.iau.name)
        }
      }

      if let chinese {
        Section("Chinese Zodiac") {
          LabeledContent("Chinese", value: chinese.name)
        }
      }

      DatePicker(
        "Select a date",
        selection: $selectedDate,
        displayedComponents: [.date]
      )
      .datePickerStyle(.graphical)
    }
    .task { loadZodiac(for: selectedDate) }
    .onChange(of: selectedDate) { _, newDate in
      loadZodiac(for: newDate)
    }
    .scrollBounceBehavior(.basedOnSize)
  }

  /// Loads zodiac signs for all supported systems based on the given date.
  /// Western signs are loaded from four different systems, and Chinese zodiac is shared across.
  private func loadZodiac(for date: Date) {
    Task {
      do {
        let tropical = try serviceTropical.getWesternZodiac(from: date)
        let sidereal = try serviceSidereal.getWesternZodiac(from: date)
        let equal = try serviceEqual.getWesternZodiac(from: date)
        let iau = try serviceIAU.getWesternZodiac(from: date)

        self.western = (tropical, sidereal, equal, iau)
        self.chinese = try serviceTropical.getChineseZodiac(from: date)
      } catch {
        print("Failed to get zodiac signs: \(error.localizedDescription)")
        self.western = nil
        self.chinese = nil
      }
    }
  }
}

Attributes

Western

Chinese

Contributing

Licence