[CM-1263] Rename YCalendarPicker (#10)

* [OTHER] renamed YCalendarPicker to CalendarPicker and respective classes

[OTHER] folder structure changed

* [UPDATE] readme file update with new name

* [OTHER] restructured and some file renamed

* [UPDATE] readme comment updated

[UPDATE] remove rename note from readme

[UPDATE] dropped swift tool to 5.5

Author: SahilSainiYML

Package.swift

@@ -1,4 +1,4 @@
-// swift-tools-version: 5.6
+// swift-tools-version: 5.5
 
 import PackageDescription
 

README.md

@@ -18,15 +18,15 @@ Documentation is automatically generated from source code comments and rendered
 Usage
 ----------
 
-### `YCalendarPicker` (UIKit)
-`YCalendarPicker` is a subclass of `UIControl` with an api similar to `UIDatePicker`.
+### `CalendarPicker` (UIKit)
+`CalendarPicker` is a subclass of `UIControl` with an api similar to `UIDatePicker`.
 
-### `YCalendarView` (SwiftUI)
-`YCalendarView` is a struct that conforms to the SwiftUI `View` protocol.
+### `CalendarView` (SwiftUI)
+`CalendarView` is a struct that conforms to the SwiftUI `View` protocol.
 
 ### Initializers
 
-Both `YCalendarPicker` and `YCalendarView` can be initialized with the same five parameters (`YCalendarPicker` uses `YCalendarView` internally):
+Both `CalendarPicker` and `CalendarView` can be initialized with the same five parameters (`CalendarPicker` uses `CalendarView` internally):
 
 ```swift
 init(
@@ -39,7 +39,7 @@ init(
 ```
 The standard initializer lets you specify the first day of the week, appearance, optional minimum and maximum dates, and the locale, although it provides sensible defaults for all of these.
 
-`YCalendarPicker` has an additional initializer:
+`CalendarPicker` has an additional initializer:
 
 ```swift
 init?(coder: NSCoder)
@@ -50,12 +50,12 @@ A calendar picker created this way begins with the default appearance, but you c
 
 ### Customization
 
-`YCalendarPicker` and `YCalendarView` both have an `appearance` property of type `Appearance`.
+`CalendarPicker` and `CalendarView` both have an `appearance` property of type `Appearance`.
 
 `Appearance` lets you customize the picker's appearance. You have full control over the colors, typographies, and images used. The default appearance is dark mode compatible and WCAG 2.0 AA compliant for color contrast.
 
 ```swift
-/// Appearance for YCalendarPicker that contains typography and color properties
+/// Appearance for CalendarPicker that contains typography and color properties
 public struct Appearance {
     /// Appearance for days within current month
     public var normalDayAppearance: Day
@@ -124,7 +124,7 @@ public struct Day {
 
     ```swift
     // Create calendar picker with default values
-    let calendarPicker = YCalendarPicker()
+    let calendarPicker = CalendarPicker()
 
     // add calendar picker to any view
     view.addSubview(calendarPicker)
@@ -134,8 +134,8 @@ public struct Day {
 
     ```swift
     // Create a calendar picker with the weekday text color set to green
-    var calendarPicker = YCalendarPicker(
-        appearance: YCalendarPicker.Appearance(weekdayStyle: (textColor: .green, typography: .weekday)
+    var calendarPicker = CalendarPicker(
+        appearance: CalendarPicker.Appearance(weekdayStyle: (textColor: .green, typography: .weekday)
     )
 
     // Change the weekday text color to red
@@ -162,20 +162,20 @@ public struct Day {
     calendarPicker.addTarget(self, action: #selector(onDateChange), for: .valueChanged)
     ```
 
-    If you wish to know when the user has switched months (via the previous and next buttons), you can use the picker's `delegate` property and conform to the `YCalendarPickerDelegate` protocol.
+    If you wish to know when the user has switched months (via the previous and next buttons), you can use the picker's `delegate` property and conform to the `CalendarPickerDelegate` protocol.
 
     ```swift
     // Create calendar picker
-    let calendarPicker = YCalendarPicker()
+    let calendarPicker = CalendarPicker()
 
     // set the delegate to be notified when the month changes
     calendarPicker.delegate = self
     ```    
 
     ```swift
     // This will notify when the user presses the next/previous buttons
-    extension DemoViewController: YCalendarPickerDelegate {
-        func calendarPicker(_ calendarPicker: YCalendarPicker, didChangeMonthTo date: Date) {
+    extension DemoViewController: CalendarPickerDelegate {
+        func calendarPicker(_ calendarPicker: CalendarPicker, didChangeMonthTo date: Date) {
             print("New month: \(date)")
         }
     }
@@ -192,20 +192,20 @@ Our calendar picker also supports Swift UI!
     ```
 
 2. **Create a calendar view**
-    `YCalendarView` conforms to SwiftUI's `View` protocol so we can directly integrate `YCalendarView` with any SwiftUI view.
+    `CalendarView` conforms to SwiftUI's `View` protocol so we can directly integrate `CalendarView` with any SwiftUI view.
     ```swift
     var body: some View {
-        YCalendarView()
+        CalendarView()
     }
     ```
 
 3. **Customize and then update appearance**
 
     ```swift
     struct CustomCalendar {
-        @State var calendar: YCalendarView = {
+        @State var calendar: CalendarView = {
             // Create a calendar picker with the weekday text color set to green
-            var calendar = YCalendarView()
+            var calendar = CalendarView()
             calendar.appearance.weekdayStyle.textColor = .green
             return calendar
         }()
@@ -228,7 +228,7 @@ Our calendar picker also supports Swift UI!
 
     ```swift
     struct CustomCalendar {
-        @State var calendar = YCalendarView()
+        @State var calendar = CalendarView()
     }
 
     extension CustomCalendar: View {
@@ -250,10 +250,10 @@ Our calendar picker also supports Swift UI!
     ```
 
 5. **Receive change notifications**
-    To be notified when the user selects a date or changes the month, you can use the `delegate` property and conform to the `YCalendarViewDelegate` protocol.
+    To be notified when the user selects a date or changes the month, you can use the `delegate` property and conform to the `CalendarViewDelegate` protocol.
 
     ```swift
-    extension DemoView: YCalendarViewDelegate {
+    extension DemoView: CalendarViewDelegate {
         // Date was selected
         func calendarViewDidSelectDate(_ date: Date?) {
             if let date {

Sources/YCalendarPicker/Enums/YCalendarPicker+Strings.swift renamed to Sources/YCalendarPicker/Enums/CalendarPicker+Strings.swift

@@ -1,5 +1,5 @@
 //
-//  YCalendarPicker+Strings.swift
+//  CalendarPicker+Strings.swift
 //  YCalendarPicker
 //
 //  Created by Mark Pospesel on 1/13/23.
@@ -9,7 +9,7 @@
 import Foundation
 import YCoreUI
 
-extension YCalendarPicker {
+extension CalendarPicker {
     enum Strings: String, Localizable, CaseIterable {
         case previousMonthA11yLabel = "Previous_Month_Button_A11y_Label"
         case nextMonthA11yLabel = "Next_Month_Button_A11y_Label"

Sources/YCalendarPicker/Model/CalendarMonthItem+DayAppearance.swift

@@ -9,7 +9,7 @@
 import Foundation
 
 extension CalendarMonthItem {
-    func getDayAppearance(from appearance: YCalendarPicker.Appearance) -> YCalendarPicker.Appearance.Day {
+    func getDayAppearance(from appearance: CalendarPicker.Appearance) -> CalendarPicker.Appearance.Day {
         if isBooked {
             return appearance.bookedDayAppearance
         } else if !isEnabled {

Sources/YCalendarPicker/Protocols/YCalendarPickerDelegate.swift renamed to Sources/YCalendarPicker/Protocols/CalendarPickerDelegate.swift

@@ -1,5 +1,5 @@
 //
-//  YCalendarPickerDelegate.swift
+//  CalendarPickerDelegate.swift
 //  YCalendarPicker
 //
 //  Created by Sahil Saini on 03/02/23.
@@ -8,8 +8,8 @@
 
 import Foundation
 /// Protocol to observe changes in month
-public protocol YCalendarPickerDelegate: AnyObject {
+public protocol CalendarPickerDelegate: AnyObject {
     /// Observe changes in month (Next/Previous).
     /// Called after the user changes the month.
-    func calendarPicker(_ calendarPicker: YCalendarPicker, didChangeMonthTo date: Date)
+    func calendarPicker(_ calendarPicker: CalendarPicker, didChangeMonthTo date: Date)
 }

Sources/YCalendarPicker/Protocols/YCalendarViewDelegate.swift renamed to Sources/YCalendarPicker/Protocols/CalendarViewDelegate.swift

@@ -1,5 +1,5 @@
 //
-//  YCalendarViewDelegate.swift
+//  CalendarViewDelegate.swift
 //  YCalendarPicker
 //
 //  Created by Sahil Saini on 07/02/23.
@@ -8,7 +8,7 @@
 
 import Foundation
 /// Protocol to observe changes in date(s)
-public protocol YCalendarViewDelegate: AnyObject {
+public protocol CalendarViewDelegate: AnyObject {
     /// Method for change in selected date.
     /// Called after the user changes the selection.
     /// - Parameter date: new selected date.

Sources/YCalendarPicker/Views/YCalendarView+AppearanceObserver.swift renamed to Sources/YCalendarPicker/SwiftUI/Observers/CalendarView+AppearanceObserver.swift

@@ -1,5 +1,5 @@
 //
-//  YCalendarView+AppearanceObserver.swift
+//  CalendarView+AppearanceObserver.swift
 //  YCalendarPicker
 //
 //  Created by Sahil Saini on 29/11/22.
@@ -9,13 +9,13 @@
 import Foundation
 
 // Observe changes in appearance.
-extension YCalendarView {
+extension CalendarView {
     class AppearanceObserver: ObservableObject {
-        @Published var appearance: YCalendarPicker.Appearance
+        @Published var appearance: CalendarPicker.Appearance
 
         /// Initializes an appearance (theme) observer.
         /// - Parameter appearance: appearance object
-        init(appearance: YCalendarPicker.Appearance = .default) {
+        init(appearance: CalendarPicker.Appearance = .default) {
             self.appearance = appearance
         }
     }

Sources/YCalendarPicker/Views/YCalendarView+DateObserver.swift renamed to Sources/YCalendarPicker/SwiftUI/Observers/CalendarView+DateObserver.swift

@@ -1,5 +1,5 @@
 //
-//  YCalendarView+DateObserver.swift
+//  CalendarView+DateObserver.swift
 //  YCalendarPicker
 //
 //  Created by Sahil Saini on 06/01/23.
@@ -9,7 +9,7 @@
 import Foundation
 
 // Observe key dates.
-extension YCalendarView {
+extension CalendarView {
     class DateObserver: ObservableObject {
         @Published var minimumDate: Date?
         @Published var maximumDate: Date?

Sources/YCalendarPicker/Views/YCalendarView.swift renamed to Sources/YCalendarPicker/SwiftUI/Views/CalendarView.swift

@@ -1,5 +1,5 @@
 //
-//  YCalendarView.swift
+//  CalendarView.swift
 //  YCalendarPicker
 //
 //  Created by Sahil on 28/10/22.
@@ -9,7 +9,13 @@
 import SwiftUI
 
 /// Swift UI month calendar picker
-public struct YCalendarView {
+///
+/// Renamed to `CalendarView`.
+@available(*, deprecated, renamed: "CalendarView")
+public typealias YCalendarView = CalendarView
+
+/// Swift UI month calendar picker
+public struct CalendarView {
     /// Unique identifier
     ///
     /// This facilitates connection between SwiftUI & UIKit layers
@@ -24,7 +30,7 @@ public struct YCalendarView {
     var firstWeekday: Int = Locale.current.calendar.firstWeekday
     var locale: Locale = Locale.current
     /// Delegate for date/month change
-    weak public var delegate: YCalendarViewDelegate?
+    weak public var delegate: CalendarViewDelegate?
 
     /// Selected date (if any)
     public var date: Date? {
@@ -37,7 +43,7 @@ public struct YCalendarView {
     }
 
     /// Calendar appearance
-    public var appearance: YCalendarPicker.Appearance {
+    public var appearance: CalendarPicker.Appearance {
         get {
             self.appearanceObserver.appearance
         }
@@ -88,7 +94,7 @@ public struct YCalendarView {
     ///   - locale: locale for data formatting e.g Date format. Default is `nil`.
     public init(
         firstWeekday: Int? = nil,
-        appearance: YCalendarPicker.Appearance = .default,
+        appearance: CalendarPicker.Appearance = .default,
         minimumDate: Date? = nil,
         maximumDate: Date? = nil,
         locale: Locale? = nil
@@ -101,7 +107,7 @@ public struct YCalendarView {
     }
 }
 
-extension YCalendarView: View {
+extension CalendarView: View {
     /// :nodoc:
     public var body: some View {
         VStack(spacing: 0) {
@@ -166,7 +172,7 @@ extension YCalendarView: View {
     }
 }
 
-extension YCalendarView {
+extension CalendarView {
     func isDateBeforeMinimumDate(_ date: Date?) -> Bool {
         guard let date = date,
               let minDate = minimumDate else { return false }
@@ -233,9 +239,9 @@ extension YCalendarView {
     }
 }
 
-struct YCalendarView_Previews: PreviewProvider {
+struct CalendarView_Previews: PreviewProvider {
     static var previews: some View {
-        YCalendarView(
+        CalendarView(
             minimumDate: Date().startDateOfMonth().date(byAddingMonth: -1),
             maximumDate: Date().startDateOfMonth().date(byAddingMonth: 2)
         )

Sources/YCalendarPicker/Views/DayView.swift renamed to Sources/YCalendarPicker/SwiftUI/Views/DayView.swift

@@ -17,7 +17,7 @@ struct DayView {
     /// horizontal and vertical padding around day view circles
     static let padding: CGFloat = 2
 
-    let appearance: YCalendarPicker.Appearance
+    let appearance: CalendarPicker.Appearance
     let dateItem: CalendarMonthItem
     let locale: Locale
     @Binding var selectedDate: Date?
@@ -29,7 +29,7 @@ extension DayView: View {
         getDayView(appearance: appearance)
     }
 
-    func getDayView(appearance: YCalendarPicker.Appearance.Day) -> some View {
+    func getDayView(appearance: CalendarPicker.Appearance.Day) -> some View {
         ZStack {
             TextStyleLabel(dateItem.day, typography: appearance.typography, configuration: { label in
                 label.isUserInteractionEnabled = true
@@ -60,11 +60,11 @@ extension DayView: View {
         var accessibilityText = dateItem.date.toString(withTemplate: "dEEEEMMMM", locale: locale) ?? ""
 
         if dateItem.isToday {
-            accessibilityText.append(YCalendarPicker.Strings.todayDayDescriptor.localized)
+            accessibilityText.append(CalendarPicker.Strings.todayDayDescriptor.localized)
         }
 
         if dateItem.isBooked {
-            accessibilityText.append(YCalendarPicker.Strings.bookedDayDescriptor.localized)
+            accessibilityText.append(CalendarPicker.Strings.bookedDayDescriptor.localized)
         }
 
         return accessibilityText
@@ -82,10 +82,10 @@ extension DayView: View {
         guard dateItem.isSelectable,
               !dateItem.isSelected else { return "" }
 
-        return YCalendarPicker.Strings.dayButtonA11yHint.localized
+        return CalendarPicker.Strings.dayButtonA11yHint.localized
     }
 
-    func getDayAppearance() -> YCalendarPicker.Appearance.Day {
+    func getDayAppearance() -> CalendarPicker.Appearance.Day {
         dateItem.getDayAppearance(from: appearance)
     }
 }