Skip to content

Latest commit

 

History

History
77 lines (62 loc) · 3.57 KB

MIGRATION_GUIDE.md

File metadata and controls

77 lines (62 loc) · 3.57 KB

Migration Guide

MuslimDate Version 1.x to 2.x

Introduction

This migration guide assists developers in transitioning from version 1.x to version 2.x of the muslim-data-ios library. Version 2 introduces improvements in database schema and table relations, including changes to the Location object structure and accessing its data through repository pattern.

Changes Overview

  • Improved database table normalization and rearranged table relations.
  • Restructured the Location object schema for better data management and consistency.
  • Implemented the Repository pattern for accessing data, replacing direct access through class methods.

Migration Steps

Repository Pattern

  • Refactor your code to utilize the MuslimRepository for accessing data instead of direct access through class methods.
  • Replace instances of direct data access with calls to appropriate methods provided by MuslimRepository class.
  • Update your codebase to follow the repository pattern for improved testability and ease of mocking.

The following code snippet shows how to access to PrayerTimes via MuslimRepository and the reset other examples can be found in the README file.

// Version 1.x
PrayerTime.getPrayerTimes(location: location, date: Date(), attributes: attributes) { prayerTime, error in
    print("prayer times: \(prayerTime!)")
}

// Version 2.x
let prayerTime = try await MuslimRepository().getPrayerTimes(location: location, date: Date(), attributes: attributes)
print("prayer times: \(prayerTime!)")

Update Location Object

  • Modify the Location object structure in your code to align with version 2.x. 
    // Version 1.x
public struct Location {
    public let latitude: Double
    public let longitude: Double
    public let cityName: String
    public let countryCode: String
    public let countryName: String
    public var hasFixedPrayerTime: Bool
}

// Version 2.x
public struct Location {
    public let id: Int
    public let name: String
    public let latitude: Double
    public let longitude: Double
    public let countryCode: String
    public let countryName: String
    public var hasFixedPrayerTime: Bool
    public let prayerDependentId: Int?
}
    • Add the id and name properties to the Location object to ensure consistency with the updated schema.
    • Update any references to the Location object throughout your codebase to use the new structure.

Geocoding locations

  • One of the geocoding locations has been changed from geocoder(latitude: Double, longitude: Double) to reverseGeocoder(latitude: Double, longitude: Double).

Location Retrieval and Prayer Times

  • Update any methods or functions responsible for fetching user locations, geocoding, reverse geocoding, and obtaining prayer times to use the new Location object structure.

Compatibility Notes

  • Version 2.x maintains backward compatibility with existing projects using version 1.x, but requires modifications to the Location object structure.
  • Ensure all dependencies and integrations with the library are updated to version 2.x to avoid compatibility issues.

Testing Recommendations

  • Thoroughly test your application after implementing the migration steps to ensure compatibility and functionality with the updated library version.

Feedback

  • Report any migration issues or suggestions for improvement here.

Versioning Information

  • muslim-data-ios follows semantic versioning. Future updates will maintain backward compatibility whenever possible.