Docs fix (#318)

* Clean-up TripKitUI and InterApp as they no longer support Objective-C * Latest setup-python * Trying to get jazzy * Docs need latest Xcode, too * Unify #if os calls * Tie to modules rather than OS * Slight tweaks to docs
skedgo · Nov 24, 2023 · d0ba31b · d0ba31b
1 parent 5434956
commit d0ba31b
Show file tree

Hide file tree

Showing 35 changed files with 90 additions and 130 deletions.
diff --git a/.github/workflows/docs-dryrun.yml b/.github/workflows/docs-dryrun.yml
@@ -13,7 +13,10 @@ jobs:
     steps:
       - name: Checkout main
         uses: actions/checkout@v4
-      - uses: actions/setup-python@v2
+      - uses: maxim-lobanov/setup-xcode@v1
+        with:
+          xcode-version: latest-stable
+      - uses: actions/setup-python@v4
         with:
           python-version: 3.x
       - name: Prepare dependencies
@@ -24,6 +27,7 @@ jobs:
           pip install mkdocs
           pip install pymdown-extensions    
           mkdocs --version 
+          bundle install
 
       - name: Build docs
         run: |

diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -13,7 +13,10 @@ jobs:
     steps:
       - name: Checkout main
         uses: actions/checkout@v4
-      - uses: actions/setup-python@v2
+      - uses: maxim-lobanov/setup-xcode@v1
+        with:
+          xcode-version: latest-stable
+      - uses: actions/setup-python@v4
         with:
           python-version: 3.x
       - name: Prepare dependencies
@@ -24,6 +27,7 @@ jobs:
           pip install mkdocs
           pip install pymdown-extensions    
           mkdocs --version 
+          bundle install
 
       - name: Build docs
         run: |

diff --git a/Gemfile.lock b/Gemfile.lock
@@ -3,7 +3,7 @@ GEM
   specs:
     CFPropertyList (3.0.6)
       rexml
-    activesupport (7.1.1)
+    activesupport (7.1.2)
       base64
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
@@ -23,12 +23,12 @@ GEM
     base64 (0.2.0)
     bigdecimal (3.1.4)
     claide (1.0.3)
-    cocoapods (1.14.2)
+    cocoapods (1.14.3)
       addressable (~> 2.8)
       claide (>= 1.0.2, < 2.0)
-      cocoapods-core (= 1.14.2)
+      cocoapods-core (= 1.14.3)
       cocoapods-deintegrate (>= 1.0.3, < 2.0)
-      cocoapods-downloader (>= 2.0)
+      cocoapods-downloader (>= 2.1, < 3.0)
       cocoapods-plugins (>= 1.0.0, < 2.0)
       cocoapods-search (>= 1.0.0, < 2.0)
       cocoapods-trunk (>= 1.6.0, < 2.0)
@@ -41,7 +41,7 @@ GEM
       nap (~> 1.0)
       ruby-macho (>= 2.3.0, < 3.0)
       xcodeproj (>= 1.23.0, < 2.0)
-    cocoapods-core (1.14.2)
+    cocoapods-core (1.14.3)
       activesupport (>= 5.0, < 8)
       addressable (~> 2.8)
       algoliasearch (~> 1.0)
@@ -52,7 +52,7 @@ GEM
       public_suffix (~> 4.0)
       typhoeus (~> 1.0)
     cocoapods-deintegrate (1.0.5)
-    cocoapods-downloader (2.0)
+    cocoapods-downloader (2.1)
     cocoapods-plugins (1.0.0)
       nap
     cocoapods-search (1.0.1)
@@ -71,8 +71,7 @@ GEM
       commander (>= 4.3.5)
       highline (>= 1.7.1)
       security
-    domain_name (0.5.20190701)
-      unf (>= 0.0.5, < 1.0.0)
+    domain_name (0.6.20231109)
     drb (2.2.0)
       ruby2_keywords
     escape (0.0.4)
@@ -141,13 +140,10 @@ GEM
       plist (>= 3.1.0, < 4.0.0)
     sqlite3 (1.6.8)
       mini_portile2 (~> 2.8.0)
-    typhoeus (1.4.0)
+    typhoeus (1.4.1)
       ethon (>= 0.9.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unf (0.1.4)
-      unf_ext
-    unf_ext (0.0.8.2)
     xcinvoke (0.3.0)
       liferaft (~> 0.0.6)
     xcode-install (2.0.9)

diff --git a/Scripts/docs/tripkit.jazzy.yaml b/Scripts/docs/tripkit.jazzy.yaml
@@ -18,13 +18,12 @@ abstract: api/*.md
 custom_categories:
   - name: Setup & Configuration
     children:
-      - TKTripKit
+      - TripKit
       - TKConfig
       - TKRegion
       - TKRegionManager
       - TKServer
       - TKSettings
-      - TKUserProfileHelper
   - name: Trip Planning
     children:
       - TKRouter

diff --git a/Scripts/docs/tripkitui.jazzy.yaml b/Scripts/docs/tripkitui.jazzy.yaml
@@ -10,8 +10,7 @@ podspec: ../../TripKitUI.podspec
 
 exclude:
   - /*/TripKitUI/helper/Categories/*
-  - /*/TripKitUI/vendor/Differentiator/*
-  - /*/TripKitUI/vendor/RxDataSources/*
+  - /*/TripKitUI/vendor/*
 
 custom_categories:
   - name: Trip Planning

diff --git a/Sources/TripKit/UIKit/TKStyleManager+UIKit.swift b/Sources/TripKit/UIKit/TKStyleManager+UIKit.swift
@@ -6,7 +6,7 @@
 //  Copyright © 2021 SkedGo Pty Ltd. All rights reserved.
 //
 
-#if os(iOS) || os(tvOS)
+#if canImport(UIKit)
 
 import UIKit
 

diff --git a/Sources/TripKit/UIKit/UIColor+TripKit.swift b/Sources/TripKit/UIKit/UIColor+TripKit.swift
@@ -6,7 +6,7 @@
 //  Copyright © 2019 SkedGo Pty Ltd. All rights reserved.
 //
 
-#if os(iOS) || os(tvOS)
+#if canImport(UIKit)
 
 import Foundation
 import UIKit

diff --git a/Sources/TripKit/UIKit/UIColor+TripKitDefault.swift b/Sources/TripKit/UIKit/UIColor+TripKitDefault.swift
@@ -6,7 +6,7 @@
 //  Copyright © 2019 SkedGo Pty Ltd. All rights reserved.
 //
 
-#if os(iOS) || os(tvOS)
+#if canImport(UIKit)
 
 import Foundation
 import UIKit

diff --git a/Sources/TripKit/core/Loc+TripKit.swift b/Sources/TripKit/core/Loc+TripKit.swift
@@ -8,7 +8,7 @@
 
 import Foundation
 
-#if os(iOS) || os(tvOS)
+#if canImport(UIKit)
 import UIKit
 #endif
 
@@ -168,7 +168,7 @@ extension Loc {
   }
 
   public static func fromTime(_ from: String, toTime to: String) -> String {
-#if os(iOS) || os(tvOS)
+#if canImport(UIKit)
     switch UIView.userInterfaceLayoutDirection(for: .unspecified) {
     case .leftToRight:
       return String(format: "%@ → %@", from, to)

diff --git a/Sources/TripKit/core/TKCrossPlatform.swift b/Sources/TripKit/core/TKCrossPlatform.swift
@@ -8,12 +8,12 @@
 
 import Foundation
 
-#if os(iOS) || os(tvOS)
+#if canImport(UIKit)
   import UIKit
   public typealias TKColor = UIColor
   public typealias TKImage = UIImage
   public typealias TKFont  = UIFont
-#elseif os(OSX)
+#elseif canImport(AppKit)
   import AppKit
   public typealias TKColor = NSColor
   public typealias TKImage = NSImage

diff --git a/Sources/TripKit/core/TKImage+TripKit.swift b/Sources/TripKit/core/TKImage+TripKit.swift
@@ -62,10 +62,10 @@ extension TKImage {
 
   private static func named(_ name: String) -> TKImage {
 
-    #if os(iOS) || os(tvOS)
+#if canImport(UIKit)
     return TKImage(named: name, in: .tripKit, compatibleWith: nil)!
-    #elseif os(OSX)
+#elseif os(macOS)
     return TripKit.bundle.image(forResource: name)!
-    #endif
+#endif
   }
 }
diff --git a/Sources/TripKit/helpers/TKImageBuilder.swift b/Sources/TripKit/helpers/TKImageBuilder.swift
@@ -8,7 +8,7 @@
 
 import Foundation
 
-#if os(iOS) || os(tvOS)
+#if canImport(UIKit)
 import UIKit
 
 class TKImageBuilder {

diff --git a/Sources/TripKit/managers/TKCalendarManager+Autocompleting.swift b/Sources/TripKit/managers/TKCalendarManager+Autocompleting.swift
@@ -59,7 +59,7 @@ extension TKCalendarManager: TKAutocompleting {
     }
   }
 
-  #if os(iOS) || os(tvOS)
+#if os(iOS) || os(tvOS) || os(visionOS)
   @objc
   public func additionalActionTitle() -> String? {
     if isAuthorized { return nil }
@@ -70,7 +70,7 @@ extension TKCalendarManager: TKAutocompleting {
   public func triggerAdditional(presenter: UIViewController, completion: @escaping (Bool) -> Void) {
     tryAuthorization(in: presenter, completion: completion)
   }
-  #endif
+#endif
 
 }
 

diff --git a/Sources/TripKit/managers/TKContactsManager+TKAutocompleting.swift b/Sources/TripKit/managers/TKContactsManager+TKAutocompleting.swift
@@ -52,7 +52,7 @@ extension TKContactsManager: TKAutocompleting {
     }
   }
 
-  #if os(iOS) || os(tvOS)
+#if os(iOS) || os(tvOS) || os(visionOS)
   @objc
   public func additionalActionTitle() -> String? {
     if isAuthorized { return nil }
@@ -63,7 +63,7 @@ extension TKContactsManager: TKAutocompleting {
   public func triggerAdditional(presenter: UIViewController, completion: @escaping (Bool) -> Void) {
     tryAuthorization(in: presenter, completion: completion)
   }
-  #endif
+#endif
 
   private static func geocode(_ contact: ContactAddress, completion: @escaping (Result<TKNamedCoordinate, Error>) -> Void) {
     let geocoder = CLGeocoder()

diff --git a/Sources/TripKit/managers/TKContactsManager.swift b/Sources/TripKit/managers/TKContactsManager.swift
@@ -81,12 +81,12 @@ public class TKContactsManager: NSObject, TKPermissionManager {
 
     guard isAuthorized else { return [] }
 
-    #if os(iOS) || os(tvOS)
-    return [] // not yet supported
-    #elseif os(OSX)
+#if os(macOS)
     let contact = try store.unifiedMeContactWithKeys(toFetch: TKContactsManager.keysToFetch)
     return contact.toContactAddresses().filter { $0.matches(kind) }
-    #endif
+#else
+    return [] // not yet supported
+#endif
   }
 
   // MARK: - TKPermissionManager
@@ -130,12 +130,12 @@ extension CNContact {
   }
 
   fileprivate func circularThumbnail() -> TKImage? {
-    #if os(iOS) || os(tvOS)
+#if canImport(UIKit)
     guard let data = thumbnailImageData, let thumbnail = TKImage(data: data) else { return nil }
     return TKImageBuilder.drawCircularImage(insideImage: thumbnail)
 
-    #elseif os(OSX)
+#else
     return nil
-    #endif
+#endif
   }
 }
diff --git a/Sources/TripKit/managers/TKPermissionManager+AuthorizationAlert.swift b/Sources/TripKit/managers/TKPermissionManager+AuthorizationAlert.swift
@@ -8,7 +8,7 @@
 
 import Foundation
 
-#if os(iOS)
+#if canImport(UIKit)
 import UIKit
 
 extension TKPermissionManager {

diff --git a/Sources/TripKit/managers/TKStyleManager.swift b/Sources/TripKit/managers/TKStyleManager.swift
@@ -8,16 +8,16 @@
 
 import Foundation
 
-#if os(iOS) || os(tvOS)
+#if canImport(UIKit)
 import UIKit
 #endif
 
 extension TKColor {
 
   @objc public static var routeDashColorNonTravelled: TKColor {
-#if os(iOS) || os(tvOS)
+#if canImport(UIKit)
     return .secondarySystemFill
-#elseif os(OSX)
+#else
     return TKColor.lightGray.withAlphaComponent(0.25)
 #endif
   }
@@ -68,12 +68,12 @@ extension TKStyleManager {
 
   public static func activityImage(_ partial: String) -> TKImage {
     let name: String
-#if os(iOS) || os(tvOS)
+#if canImport(UIKit)
     switch UIDevice.current.userInterfaceIdiom {
     case .phone: name = "icon-actionBar-\(partial)-30"
     default: name = "icon-actionBar-\(partial)-38"
     }
-#elseif os(OSX)
+#else
     name = "icon-actionBar-\(partial)-38"
 #endif
     return image(named: name)
@@ -86,10 +86,12 @@ extension TKStyleManager {
   }
 
   public static func optionalImage(named: String) -> TKImage? {
-#if os(iOS) || os(tvOS)
+#if canImport(UIKit)
     return TKImage(named: named, in: .tripKit, compatibleWith: nil)
-#elseif os(OSX)
+#elseif os(macOS)
     return TripKit.bundle.image(forResource: named)
+#else
+    return nil
 #endif
   }
 
@@ -174,7 +176,7 @@ extension TKStyleManager {
     }
   }
 
-#if os(iOS) || os(tvOS)
+#if canImport(UIKit)
   //// This method returns a font with custom font face for a given text style and weight.
   /// If there's no custom font face specified in the plist, system font face is used.
   /// This method is typically used on `UILabel`, `UITextField`, and `UITextView` but
@@ -213,7 +215,7 @@ extension TKStyleManager {
     return font(size: size, weight: .medium)
   }
 
-#if os(iOS) || os(tvOS)
+#if canImport(UIKit)
   // @available(*, deprecated, renamed: "font(textStyle:weight:)")
   public static func customFont(forTextStyle textStyle: UIFont.TextStyle) -> UIFont {
     return font(textStyle: textStyle, weight: .regular)

diff --git a/Sources/TripKit/model/API/BaseAPIModels.swift b/Sources/TripKit/model/API/BaseAPIModels.swift
@@ -83,7 +83,7 @@ extension TKAPI {
       return TKColor(red: CGFloat(red) / 255, green: CGFloat(green) / 255, blue: CGFloat(blue) / 255, alpha: 1)
     }
 
-    #if os(iOS) || os(tvOS)
+#if canImport(UIKit)
       public init?(for color: TKColor?) {
         guard let color = color else { return nil }
         var red: CGFloat = 0
@@ -97,7 +97,7 @@ extension TKAPI {
           return nil
         }
       }
-    #elseif os(OSX)
+#elseif canImport(AppKit)
     public init?(for color: TKColor?) {
       guard let color = color else { return nil }
       var red: CGFloat = 0
@@ -108,7 +108,7 @@ extension TKAPI {
       self.green = Int(green * 255)
       self.blue = Int(blue * 255)
     }
-    #endif
+#endif
   }
 
 }