Merge pull request #21 from SNQ-2001/main

Include URL in library information

Author: Kyome22

README.md

@@ -51,6 +51,10 @@ import LicenseList
 // in ViewController
 let vc = LicenseListViewController()
 vc.title = "LICENSE"
+
+// If you want to anchor link of the repository
+vc.licenseListViewStyle = .withRepositoryAnchorLink
+
 navigationController?.pushViewController(vc, animated: true)
 ```
 
@@ -63,6 +67,8 @@ struct ContentView: View {
     var body: some View {
         NavigationView {
             LicenseListView()
+                // If you want to anchor link of the repository
+                .licenseListViewStyle(.withRepositoryAnchorLink)
                 .navigationTitle("LICENSE")
         }
     }

Sources/LicenseList/LegacyLicenseView.swift

@@ -10,6 +10,8 @@ import SwiftUI
 public struct LegacyLicenseView: View {
     @State private var lines = [[LegacyLicenseSentence]]()
 
+    @Environment(\.licenseListViewStyle) private var licenseListViewStyle: LicenseListViewStyle
+
     private let library: Library
 
     public init(library: Library) {
@@ -52,6 +54,11 @@ public struct LegacyLicenseView: View {
             lines = resolve(library.licenseBody)
         }
         .navigationBarTitleInlineIfPossible(library.name)
+        ._licenseListViewStyle(licenseListViewStyle) {
+            if let url = library.url {
+                UIApplication.shared.open(url)
+            }
+        }
     }
 
     private func resolve(_ inputText: String) -> [[LegacyLicenseSentence]] {

Sources/LicenseList/Library.swift

@@ -10,10 +10,12 @@ import Foundation
 public struct Library: Identifiable, Hashable {
     public let id: UUID = .init()
     public let name: String
+    public let url: URL?
     public let licenseBody: String
 
-    public init(name: String, licenseBody: String) {
+    public init(name: String, url: String, licenseBody: String) {
         self.name = name
+        self.url = URL(string: url)
         self.licenseBody = licenseBody
     }
 }
@@ -27,8 +29,12 @@ extension Library {
             return []
         }
         return (dict["libraries"] as? [[String: Any]])?.compactMap({ info -> Library? in
-            guard let name = info["name"] as? String, let body = info["licenseBody"] as? String else { return nil }
-            return Library(name: name, licenseBody: body)
+            guard let name = info["name"] as? String,
+                  let url = info["url"] as? String,
+                  let body = info["licenseBody"] as? String else {
+                return nil
+            }
+            return Library(name: name, url: url, licenseBody: body)
         }) ?? []
     }
 }

Sources/LicenseList/LicenseListView.swift

@@ -9,6 +9,8 @@ import UIKit
 import SwiftUI
 
 public struct LicenseListView: View {
+    @Environment(\.licenseListViewStyle) private var licenseListViewStyle: LicenseListViewStyle
+
     let libraries: [Library]
     let useUINavigationController: Bool
     let navigationHandler: ((Library) -> Void)?
@@ -28,10 +30,11 @@ public struct LicenseListView: View {
         }
         libraries = (dict["libraries"] as? [[String: Any]])?.compactMap({ info -> Library? in
             guard let name = info["name"] as? String,
+                  let url = info["url"] as? String,
                   let body = info["licenseBody"] as? String else {
                 return nil
             }
-            return Library(name: name, licenseBody: body)
+            return Library(name: name, url: url, licenseBody: body)
         }) ?? []
     }
 
@@ -62,11 +65,17 @@ public struct LicenseListView: View {
     @ViewBuilder
     func libraryNavigationLink(_ library: Library) -> some View {
         if #available(iOS 15, *) {
-            NavigationLink(destination: LicenseView(library: library)) {
+            NavigationLink {
+                LicenseView(library: library)
+                    .licenseListViewStyle(licenseListViewStyle)
+            } label: {
                 Text(library.name)
             }
         } else {
-            NavigationLink(destination: LegacyLicenseView(library: library)) {
+            NavigationLink {
+                LegacyLicenseView(library: library)
+                    .licenseListViewStyle(licenseListViewStyle)
+            } label: {
                 Text(library.name)
             }
         }

Sources/LicenseList/LicenseListViewController.swift

@@ -11,6 +11,8 @@ import SwiftUI
 public class LicenseListViewController: UIViewController {
     let fileURL: URL
 
+    public var licenseListViewStyle: LicenseListViewStyle = .plain
+
     public init(fileURL: URL) {
         self.fileURL = fileURL
         super.init(nibName: nil, bundle: nil)
@@ -46,8 +48,10 @@ public class LicenseListViewController: UIViewController {
         let hostingController = UIHostingController(rootView: Group {
             if #available(iOS 15, *) {
                 LicenseView(library: library)
+                    .licenseListViewStyle(licenseListViewStyle)
             } else {
                 LegacyLicenseView(library: library)
+                    .licenseListViewStyle(licenseListViewStyle)
             }
         })
         hostingController.title = library.name

Sources/LicenseList/LicenseListViewStyle.swift

@@ -0,0 +1,26 @@
+//
+//  LicenseListViewStyle.swift
+//
+//
+//  Created by 宮本大新 on 2023/11/16.
+//
+
+import SwiftUI
+
+public enum LicenseListViewStyle {
+    case plain
+    case withRepositoryAnchorLink
+}
+
+struct LicenseListViewStyleEnvironmentKey: EnvironmentKey {
+    typealias Value = LicenseListViewStyle
+
+    static var defaultValue: LicenseListViewStyle = .plain
+}
+
+extension EnvironmentValues {
+    var licenseListViewStyle: LicenseListViewStyle {
+        get { self[LicenseListViewStyleEnvironmentKey.self] }
+        set { self[LicenseListViewStyleEnvironmentKey.self] = newValue }
+    }
+}

Sources/LicenseList/LicenseView.swift

@@ -11,6 +11,9 @@ import SwiftUI
 public struct LicenseView: View {
     @State private var attributedLicenseBody = AttributedString(stringLiteral: "")
 
+    @Environment(\.openURL) private var openURL: OpenURLAction
+    @Environment(\.licenseListViewStyle) private var licenseListViewStyle: LicenseListViewStyle
+
     private let library: Library
 
     public init(library: Library) {
@@ -28,6 +31,11 @@ public struct LicenseView: View {
                 }
         }
         .navigationBarTitle(library.name)
+        ._licenseListViewStyle(licenseListViewStyle) {
+            if let url = library.url {
+                openURL(url)
+            }
+        }
     }
 
     private func attribute(_ inputText: String) -> AttributedString {

Sources/LicenseList/View+Extensions.swift

@@ -27,4 +27,41 @@ extension View {
             }
         }
     }
+    
+    func navigationBarRepositoryAnchorLink(action: @escaping () -> Void) -> some View {
+        Group {
+            if #available(iOS 14, *) {
+                self.toolbar {
+                    ToolbarItem(placement: .topBarTrailing) {
+                        Button {
+                            action()
+                        } label: {
+                            Image(systemName: "link")
+                        }
+                    }
+                }
+            } else {
+                self.navigationBarItems(trailing: Button {
+                    action()
+                } label: {
+                    Image(systemName: "link")
+                })
+            }
+        }
+    }
+    
+    func _licenseListViewStyle(_ style: LicenseListViewStyle, action: @escaping () -> Void) -> some View {
+        Group {
+            switch style {
+            case .plain:
+                self
+            case .withRepositoryAnchorLink:
+                self.navigationBarRepositoryAnchorLinkIfPossible(action: action)
+            }
+        }
+    }
+    
+    public func licenseListViewStyle(_ style: LicenseListViewStyle) -> some View {
+        self.environment(\.licenseListViewStyle, style)
+    }
 }

Sources/SourcePackagesParser/Library.swift

@@ -9,5 +9,6 @@ import Foundation
 
 struct Library: Hashable {
     let name: String
+    let url: String
     let licenseBody: String
 }

Sources/SourcePackagesParser/SourcePackagesParser.swift

@@ -36,7 +36,11 @@ final class SourcePackagesParser {
             guard let licenseBody = extractLicenseBody(directoryURL) else {
                 return nil
             }
-            return Library(name: dependency.packageRef.name, licenseBody: licenseBody)
+            return Library(
+                name: dependency.packageRef.name,
+                url: dependency.packageRef.location,
+                licenseBody: licenseBody
+            )
         }
         .sorted { $0.name.lowercased() < $1.name.lowercased() }
 
@@ -84,6 +88,7 @@ final class SourcePackagesParser {
         let array: [[String: Any]] = libraries.map { library in
             return [
                 "name": library.name,
+                "url": library.url,
                 "licenseBody": library.licenseBody
             ]
         }