-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
17 changed files
with
615 additions
and
297 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
142 changes: 142 additions & 0 deletions
142
Sources/DocCStaticExporter/DocCFileSystemExportTarget.swift
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,142 @@ | ||
| // | ||
| // DocCFileSystemExportTarget.swift | ||
| // docc2html | ||
| // | ||
| // Created by Helge Heß. | ||
| // Copyright © 2021 ZeeZide GmbH. All rights reserved. | ||
| // | ||
|
|
||
| import Foundation | ||
| import Logging | ||
|
|
||
| open class DocCFileSystemExportTarget: DocCStaticExportTarget, | ||
| CustomStringConvertible | ||
| { | ||
|
|
||
| public let logger : Logger | ||
| public let fileManager : FileManager | ||
| public let targetPath : String | ||
| open var targetURL : URL { return URL(fileURLWithPath: targetPath) } | ||
|
|
||
| public init(targetPath: String, fileManager: FileManager = .default, | ||
| logger: Logger = Logger(label: "docc2html")) | ||
| { | ||
| self.logger = logger | ||
| self.targetPath = targetPath | ||
| self.fileManager = fileManager | ||
| } | ||
|
|
||
|
|
||
| open func doesTargetExist() -> Bool { | ||
| return fileManager.fileExists(atPath: targetPath) | ||
| } | ||
|
|
||
|
|
||
| // MARK: - Copying Static Resources | ||
|
|
||
| open func copyCSS(_ cssFiles: [ URL ], keepHash: Bool) throws { | ||
| guard !cssFiles.isEmpty else { return } | ||
|
|
||
| let targetURL = self.targetURL.appendingPathComponent("css") | ||
| try ensureTargetDir("css") | ||
|
|
||
| for css in cssFiles { | ||
| let cssContents : String | ||
| do { | ||
| cssContents = try String(contentsOf: css) | ||
| .stringByRemovingDocCDataReferences() | ||
| } | ||
| catch { | ||
| logger.error("Failed to load CSS:", css.path) | ||
| throw DocCStaticExportError | ||
| .couldNotLoadStaticResource(css, underlyingError: error) | ||
| } | ||
|
|
||
| let targetName = keepHash | ||
| ? css.lastPathComponent | ||
| : css.deletingResourceHash().lastPathComponent | ||
|
|
||
| let cssTargetURL = targetURL.appendingPathComponent(targetName) | ||
|
|
||
| logger.trace("Copying CSS \(css.path) to \(cssTargetURL.path)") | ||
|
|
||
| do { | ||
| try cssContents.write(to: cssTargetURL, atomically: false, | ||
| encoding: .utf8) | ||
| } | ||
| catch { | ||
| logger.error("Failed to save CSS:", cssTargetURL.path) | ||
| throw DocCStaticExportError | ||
| .couldNotCopyStaticResource(from: css, to: "css") | ||
| } | ||
| } | ||
| } | ||
|
|
||
| public func copyRaw(_ files: [ URL ], to directory: String, | ||
| keepHash: Bool = true) throws | ||
| { | ||
| guard !files.isEmpty else { return } | ||
|
|
||
| let targetURL = self.targetURL.appendingPathComponent(directory) | ||
| try ensureTargetDir(directory) | ||
|
|
||
| for file in files { | ||
| let targetName = keepHash | ||
| ? file.lastPathComponent | ||
| : file.deletingResourceHash().lastPathComponent | ||
|
|
||
| let fileTargetURL = targetURL.appendingPathComponent(targetName) | ||
|
|
||
| logger.trace("Copying resource \(file.path) to \(fileTargetURL.path)") | ||
|
|
||
| // copyItem fails if the target exists. | ||
| try? fileManager.removeItem(at: fileTargetURL) | ||
|
|
||
| do { | ||
| try fileManager.copyItem(at: file, to: fileTargetURL) | ||
| } | ||
| catch { | ||
| logger.error("Failed to copy resource:", fileTargetURL.path, error) | ||
| throw DocCStaticExportError | ||
| .couldNotCopyStaticResource(from: file, to: directory) | ||
| } | ||
| } | ||
| } | ||
|
|
||
|
|
||
| // MARK: - Files | ||
|
|
||
| open func write(_ content: String, to relativePath: String) throws { | ||
| let url = targetURL.appendingPathComponent(relativePath) | ||
| // TODO: own error | ||
| try content.write(to: url, atomically: false, encoding: .utf8) | ||
| } | ||
|
|
||
|
|
||
| // MARK: - Subdirectories | ||
|
|
||
| open func ensureTargetDir(_ relativePath: String) throws { | ||
| var url = targetURL | ||
| if !relativePath.isEmpty { | ||
| url.appendPathComponent(relativePath) | ||
| } | ||
|
|
||
| do { | ||
| try fileManager | ||
| .createDirectory(at: url, withIntermediateDirectories: true) | ||
| logger.trace("Created output subdir:", url.path) | ||
| } | ||
| catch { | ||
| logger.error("Could not create target directory:", url.path, error) | ||
| throw DocCStaticExportError | ||
| .couldNotCreateTargetDirectory(relativePath, underlyingError: error) | ||
| } | ||
| } | ||
|
|
||
|
|
||
| // MARK: - Description | ||
|
|
||
| open var description: String { | ||
| return targetPath | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| // | ||
| // DocCStaticExportError.swift | ||
| // docc2html | ||
| // | ||
| // Created by Helge Heß. | ||
| // Copyright © 2021 ZeeZide GmbH. All rights reserved. | ||
| // | ||
|
|
||
| import struct Foundation.URL | ||
|
|
||
| public enum DocCStaticExportError: Swift.Error { | ||
|
|
||
| case targetExists(DocCStaticExportTarget) | ||
|
|
||
| case expectedDocCArchive(URL) | ||
|
|
||
| case couldNotLoadStaticResource(URL, underlyingError: Swift.Error) | ||
|
|
||
| case couldNotCopyStaticResource(from: URL, to: String) | ||
|
|
||
| case couldNotCreateTargetDirectory(String, underlyingError: Swift.Error) | ||
| } |
Oops, something went wrong.