Merge pull request #211 from vladvlasov256/feature/checkout_path

Add '--swift-package-sources-path' option support

README.md

@@ -109,6 +109,12 @@ You can see options by `license-plist --help`.
 - Support for multiple `Package.swift`
 - Example: `license-plist --package-paths /path/to/package1/Package.swift /path/to/package2/Package.swift`
 
+#### `--package-sources-path`
+
+- Default: None.
+- The directory with cloned Swift package sources. If specified `LicensePlist` uses cloned files instead of GitHub API. For more information, see parameter `-clonedSourcePackagesDirPath` of [xcodebuild](https://developer.apple.com/library/archive/technotes/tn2339/_index.html).
+- Example: `license-plist --package-sources-path ./SourcePackages`
+
 #### `--xcodeproj-path`
 
 - Default: `"*.xcodeproj"`
@@ -157,6 +163,14 @@ You can see options by `license-plist --help`.
 - If this path is specified, a markdown acknowledgements file will be generated.
   - [Example is here](https://github.com/mono0926/LicensePlist/blob/master/Assets/acknowledgements.md)
 
+#### `--license-file-names`
+
+- Default: `LICENSE, LICENSE.*`.
+- License file name variants for cloned Swift packages. 
+  - Case insensitive. 
+  - Supports any non-empty path extensions if `FILENAME.*` is specified.
+  - Used only in combination with `--package-sources-path`.
+
 #### `--force`
 
 - Default: false
@@ -248,12 +262,16 @@ options:
   podsPath: Pods
   packagePaths:
     - Package.swift
+  packageSourcesPath: "./SourcePackages"
   xcodeprojPath: "*.xcodeproj"
   xcworkspacePath: "*.xcworkspace"
   prefix: com.mono0926.LicensePlist
   gitHubToken: YOUR_GITHUB_TOKEN
   htmlPath: acknowledgements.html
   markdownPath: acknowledgements.md
+  licenseFileNames:
+    - LICENSE
+    - LICENSE.*
   force: false
   addVersionNumbers: false
   suppressOpeningDirectory: false

Sources/LicensePlist/main.swift

@@ -36,6 +36,9 @@ struct LicensePlist: ParsableCommand {
     @Option(name: [.customLong("package-path"), .customLong("swift-package-path"), .long, .customLong("swift-package-paths")], parsing: .upToNextOption, completion: .file())
     var packagePaths = [String]()
 
+    @Option(name: [.long, .customLong("swift-package-sources-path")], completion: .directory)
+    var packageSourcesPath: String?
+
     @Option(name: .long, completion: .file())
     var xcworkspacePath: String?
 
@@ -60,6 +63,9 @@ struct LicensePlist: ParsableCommand {
     @Option(name: .long, completion: .file())
     var markdownPath: String?
 
+    @Option(name: .long, parsing: .upToNextOption, completion: .empty)
+    var licenseFileNames = [String]()
+
     @Flag(name: .long, inversion: .prefixedNo)
     var force: Bool?
 
@@ -103,24 +109,29 @@ struct LicensePlist: ParsableCommand {
         let podsPath = podsPath ?? config.options.podsPath ?? Consts.podsDirectoryName
         let configPackagePaths = config.options.packagePaths ?? [Consts.packageName]
         let packagePaths = packagePaths.isEmpty ? configPackagePaths : packagePaths
+        let packageSourcesPath = packageSourcesPath ?? config.options.packageSourcesPath
         let xcworkspacePath = xcworkspacePath ?? config.options.xcworkspacePath ?? Consts.xcworkspacePath
         let xcodeprojPath = xcodeprojPath ?? config.options.xcodeprojPath ?? Consts.xcodeprojPath
         let outputPath = outputPath ?? config.options.outputPath ?? Consts.outputPath
         let githubToken = githubToken ?? config.options.gitHubToken ?? Environment.shared[.githubToken]
         let prefix = prefix ?? config.options.prefix ?? Consts.prefix
         let htmlPath = htmlPath ?? config.options.htmlPath
         let markdownPath = markdownPath ?? config.options.markdownPath
+        let configLicenseFileNames = config.options.licenseFileNames ?? Consts.licenseFileNames
+        let licenseFileNames = licenseFileNames.isEmpty ? configLicenseFileNames : licenseFileNames
         let options = Options(outputPath: URL(fileURLWithPath: outputPath),
                               cartfilePath: URL(fileURLWithPath: cartfilePath),
                               mintfilePath: URL(fileURLWithPath: mintfilePath),
                               podsPath: URL(fileURLWithPath: podsPath),
                               packagePaths: packagePaths.map { URL(fileURLWithPath: $0) },
+                              packageSourcesPath: packageSourcesPath.map { URL(fileURLWithPath: $0, isDirectory: true) },
                               xcworkspacePath: URL(fileURLWithPath: xcworkspacePath),
                               xcodeprojPath: URL(fileURLWithPath: xcodeprojPath),
                               prefix: prefix,
                               gitHubToken: githubToken,
                               htmlPath: htmlPath.map { return URL(fileURLWithPath: $0) },
                               markdownPath: markdownPath.map { return URL(fileURLWithPath: $0) },
+                              licenseFileNames: licenseFileNames,
                               config: config)
         let tool = LicensePlistCore.LicensePlist()
         tool.process(options: options)

Sources/LicensePlistCore/Consts.swift

@@ -14,4 +14,5 @@ public struct Consts {
     public static let configPath = "license_plist.yml"
     public static let version = "3.24.2"
     public static let encoding = String.Encoding.utf8
+    public static let licenseFileNames = ["LICENSE", "LICENSE.*"]
 }

Sources/LicensePlistCore/Entity/GeneralOptions.swift

@@ -8,12 +8,14 @@ public struct GeneralOptions {
     public let mintfilePath: String?
     public let podsPath: String?
     public let packagePaths: [String]?
+    public let packageSourcesPath: String?
     public let xcworkspacePath: String?
     public let xcodeprojPath: String?
     public let prefix: String?
     public let gitHubToken: String?
     public let htmlPath: String?
     public let markdownPath: String?
+    public let licenseFileNames: [String]?
     public let force: Bool?
     public let addVersionNumbers: Bool?
     public let suppressOpeningDirectory: Bool?
@@ -26,12 +28,14 @@ public struct GeneralOptions {
                                              mintfilePath: nil,
                                              podsPath: nil,
                                              packagePaths: nil,
+                                             packageSourcesPath: nil,
                                              xcworkspacePath: nil,
                                              xcodeprojPath: nil,
                                              prefix: nil,
                                              gitHubToken: nil,
                                              htmlPath: nil,
                                              markdownPath: nil,
+                                             licenseFileNames: nil,
                                              force: nil,
                                              addVersionNumbers: nil,
                                              suppressOpeningDirectory: nil,
@@ -44,12 +48,14 @@ public struct GeneralOptions {
                 mintfilePath: String?,
                 podsPath: String?,
                 packagePaths: [String]?,
+                packageSourcesPath: String?,
                 xcworkspacePath: String?,
                 xcodeprojPath: String?,
                 prefix: String?,
                 gitHubToken: String?,
                 htmlPath: String?,
                 markdownPath: String?,
+                licenseFileNames: [String]?,
                 force: Bool?,
                 addVersionNumbers: Bool?,
                 suppressOpeningDirectory: Bool?,
@@ -61,12 +67,14 @@ public struct GeneralOptions {
         self.mintfilePath = mintfilePath
         self.podsPath = podsPath
         self.packagePaths = packagePaths
+        self.packageSourcesPath = packageSourcesPath
         self.xcworkspacePath = xcworkspacePath
         self.xcodeprojPath = xcodeprojPath
         self.prefix = prefix
         self.gitHubToken = gitHubToken
         self.htmlPath = htmlPath
         self.markdownPath = markdownPath
+        self.licenseFileNames = licenseFileNames
         self.force = force
         self.addVersionNumbers = addVersionNumbers
         self.suppressOpeningDirectory = suppressOpeningDirectory
@@ -83,12 +91,14 @@ extension GeneralOptions {
             lhs.mintfilePath == rhs.mintfilePath &&
             lhs.podsPath == rhs.podsPath &&
             lhs.packagePaths == rhs.packagePaths &&
+            lhs.packageSourcesPath == rhs.packageSourcesPath &&
             lhs.xcworkspacePath == rhs.xcworkspacePath &&
             lhs.xcodeprojPath == rhs.xcodeprojPath &&
             lhs.prefix == rhs.prefix &&
             lhs.gitHubToken == rhs.gitHubToken &&
             lhs.htmlPath == rhs.htmlPath &&
             lhs.markdownPath == rhs.markdownPath &&
+            lhs.licenseFileNames == rhs.licenseFileNames &&
             lhs.force == rhs.force &&
             lhs.addVersionNumbers == rhs.addVersionNumbers &&
             lhs.suppressOpeningDirectory == rhs.suppressOpeningDirectory &&
@@ -105,12 +115,14 @@ extension GeneralOptions {
                               mintfilePath: raw["mintfilePath"]?.string,
                               podsPath: raw["podsPath"]?.string,
                               packagePaths: raw["packagePaths"]?.array?.compactMap(\.string),
+                              packageSourcesPath: raw["packageSourcesPath"]?.string,
                               xcworkspacePath: raw["xcworkspacePath"]?.string,
                               xcodeprojPath: raw["xcodeprojPath"]?.string,
                               prefix: raw["prefix"]?.string,
                               gitHubToken: raw["gitHubToken"]?.string,
                               htmlPath: raw["htmlPath"]?.string,
                               markdownPath: raw["markdownPath"]?.string,
+                              licenseFileNames: raw["licenseFileNames"]?.array?.compactMap(\.string),
                               force: raw["force"]?.bool,
                               addVersionNumbers: raw["addVersionNumbers"]?.bool,
                               suppressOpeningDirectory: raw["suppressOpeningDirectory"]?.bool,

Sources/LicensePlistCore/Entity/GitHubLicense.swift

@@ -1,10 +1,11 @@
+import Foundation
 import LoggerAPI
 import APIKit
 
 public struct GitHubLicense: License, Equatable {
     public let library: GitHub
     public let body: String
-    let githubResponse: LicenseResponse
+    let githubResponse: LicenseResponse?
 
     public static func==(lhs: GitHubLicense, rhs: GitHubLicense) -> Bool {
         return lhs.library == rhs.library &&
@@ -66,6 +67,58 @@ extension GitHubLicense {
         }
     }
 
+    public static func readFromDisk(_ libraries: [GitHub], checkoutPath: URL, licenseFileNames: [String]) -> [GitHubLicense] {
+        return libraries.compactMap { library in
+            let owner = library.owner
+            let name = library.name
+            Log.info("license reading from disk start(owner: \(owner), name: \(name))")
+
+            let libraryUrl = checkoutPath.appendingPathComponent(name)
+            let libraryFileUrls = libraryUrl.lp.listDir().filter { !$0.lp.isDirectory }
+
+            // Check several variants of license file name
+            for fileName in licenseFileNames {
+                guard let url = findFile(with: fileName, in: libraryFileUrls) else {
+                    continue
+                }
+                do {
+                    let content = try String(contentsOf: url)
+                    // Return the content of the first matched file
+                    return GitHubLicense(library: library, body: content, githubResponse: nil)
+                } catch {
+                    continue
+                }
+            }
+
+            Log.warning("Failed to read from disk \(name)")
+            return nil
+        }
+    }
+
+    private static func findFile(with fileName: String, in fileUrls: [URL]) -> URL? {
+        let anyExtensionSuffix = ".*"
+        if fileName.hasSuffix(anyExtensionSuffix) {
+            // Check file names without extensions
+            let fileNameWithoutExtension = String(fileName.prefix(fileName.count - anyExtensionSuffix.count))
+            let lowercasedFileName = fileNameWithoutExtension.lowercased()
+            for fileUrl in fileUrls {
+                let candidateFileName = fileUrl.deletingPathExtension().lastPathComponent
+                if candidateFileName.lowercased() == lowercasedFileName {
+                    return fileUrl
+                }
+            }
+        } else {
+            // Check lowercased file names
+            let lowercasedFileName = fileName.lowercased()
+            for fileUrl in fileUrls {
+                if fileUrl.lastPathComponent.lowercased() == lowercasedFileName {
+                    return fileUrl
+                }
+            }
+        }
+        return nil
+    }
+
     private static func statusCode(from error: Error) -> Int? {
         guard let taskError = error as? SessionTaskError else {
             return nil

Sources/LicensePlistCore/Entity/Options.swift

@@ -6,50 +6,58 @@ public struct Options {
     public let mintfilePath: URL
     public let podsPath: URL
     public let packagePaths: [URL]
+    public let packageSourcesPath: URL?
     public let xcworkspacePath: URL
     public let xcodeprojPath: URL
     public let prefix: String
     public let gitHubToken: String?
     public let htmlPath: URL?
     public let markdownPath: URL?
+    public let licenseFileNames: [String]
     public let config: Config
 
     public static let empty = Options(outputPath: URL(fileURLWithPath: ""),
                                       cartfilePath: URL(fileURLWithPath: ""),
                                       mintfilePath: URL(fileURLWithPath: ""),
                                       podsPath: URL(fileURLWithPath: ""),
                                       packagePaths: [],
+                                      packageSourcesPath: nil,
                                       xcworkspacePath: URL(fileURLWithPath: ""),
                                       xcodeprojPath: URL(fileURLWithPath: ""),
                                       prefix: Consts.prefix,
                                       gitHubToken: nil,
                                       htmlPath: nil,
                                       markdownPath: nil,
+                                      licenseFileNames: [],
                                       config: Config.empty)
 
     public init(outputPath: URL,
                 cartfilePath: URL,
                 mintfilePath: URL,
                 podsPath: URL,
                 packagePaths: [URL],
+                packageSourcesPath: URL?,
                 xcworkspacePath: URL,
                 xcodeprojPath: URL,
                 prefix: String,
                 gitHubToken: String?,
                 htmlPath: URL?,
                 markdownPath: URL?,
+                licenseFileNames: [String],
                 config: Config) {
         self.outputPath = outputPath
         self.cartfilePath = cartfilePath
         self.mintfilePath = mintfilePath
         self.podsPath = podsPath
         self.packagePaths = packagePaths
+        self.packageSourcesPath = packageSourcesPath
         self.xcworkspacePath = xcworkspacePath
         self.xcodeprojPath = xcodeprojPath
         self.prefix = prefix
         self.gitHubToken = gitHubToken
         self.htmlPath = htmlPath
         self.markdownPath = markdownPath
+        self.licenseFileNames = licenseFileNames
         self.config = config
     }
 }

Sources/LicensePlistCore/Entity/PlistInfo.swift

@@ -46,7 +46,14 @@ struct PlistInfo {
         Log.info("Swift Package Manager License collect start")
 
         let packages = packageFiles.flatMap { SwiftPackage.loadPackages($0) }
-        let packagesAsGithubLibraries = packages.compactMap { $0.toGitHub(renames: options.config.renames) }.sorted()
+        let checkoutPath = options.packageSourcesPath?.appendingPathComponent("checkouts")
+        let packagesAsGithubLibraries = packages.compactMap {
+             $0.toGitHub(renames: options.config.renames, checkoutPath: checkoutPath)
+         }.sorted()
+
+        if checkoutPath != nil && options.config.excludes.contains(where: { $0.licenseType != nil }) {
+            Log.warning("Filtering by license type is not supported in combination with specified package sources path")
+        }
 
         githubLibraries = (githubLibraries ?? []) + options.config.apply(githubs: packagesAsGithubLibraries)
     }
@@ -77,21 +84,12 @@ struct PlistInfo {
         summaryPath = savePath
     }
 
-    mutating func downloadGitHubLicenses() {
-        guard let githubLibraries = githubLibraries else { preconditionFailure() }
-
-        let queue = OperationQueue()
-        queue.maxConcurrentOperationCount = 10
-        let carthageOperations = githubLibraries.map { GitHubLicense.download($0) }
-        queue.addOperations(carthageOperations, waitUntilFinished: true)
-        githubLicenses = carthageOperations.map { operation in
-            switch operation.result {
-            case let .success(value):
-                return value
-            default:
-                return nil
-            }
-        }.compactMap { $0 }
+    mutating func loadGitHubLicenses() {
+        if let packageSourcesPath = options.packageSourcesPath {
+            readCheckedOutLicenses(from: packageSourcesPath)
+        } else {
+            downloadGitHubLicenses()
+        }
     }
 
     mutating func collectLicenseInfos() {
@@ -162,4 +160,30 @@ struct PlistInfo {
             Log.error("Failed to save summary. Error: \(String(describing: e))")
         }
     }
+
+    private mutating func downloadGitHubLicenses() {
+        guard let githubLibraries = githubLibraries else { preconditionFailure() }
+
+        let queue = OperationQueue()
+        queue.maxConcurrentOperationCount = 10
+        let carthageOperations = githubLibraries.map { GitHubLicense.download($0) }
+        queue.addOperations(carthageOperations, waitUntilFinished: true)
+        githubLicenses = carthageOperations.map { operation in
+            switch operation.result {
+            case let .success(value):
+                return value
+            default:
+                return nil
+            }
+        }.compactMap { $0 }
+    }
+
+    private mutating func readCheckedOutLicenses(from packageSourcesPath: URL) {
+        guard let githubLibraries = githubLibraries else { preconditionFailure() }
+        guard !options.licenseFileNames.isEmpty else { preconditionFailure() }
+        let checkoutPath = packageSourcesPath.appendingPathComponent("checkouts")
+        githubLicenses = GitHubLicense.readFromDisk(githubLibraries,
+                                                    checkoutPath: checkoutPath,
+                                                    licenseFileNames: options.licenseFileNames)
+    }
 }