feat: support overriding baseURL parameter via a commandline option

Author: GeneralD

Sources/AssetConfig/Common/CommonMetadata.swift

@@ -3,7 +3,7 @@ import Foundation
 public protocol CommonMetadata {
 	associatedtype TraitDataType: CommonTraitData
 
-	var baseUrl: URL { get }
+	var baseUrl: URL? { get }
 	var nameFormat: String { get }
 	var descriptionFormat: String { get }
 	var externalUrlFormat: String? { get }

Sources/AssetConfigLoader/Codables/AssetConfigCodable.swift

@@ -95,7 +95,7 @@ struct AssetConfigCodable: CommonAssetConfig, SummonAssetConfig, EnchantAssetCon
 	struct MetadataCodable: CommonMetadata, EnchantMetadata, Codable, Equatable, DefaultValueProvider {
 		static let `default`: Self = .init()
 
-		@Default<BlankURL> var baseUrl: URL
+		@Default<Nil> var baseUrl: URL?
 		@Default<Empty> var nameFormat: String
 		@Default<Empty> var descriptionFormat: String
 		@Default<Nil> var externalUrlFormat: String?

Sources/AssetConfigLoader/Codables/DefaultValues.swift

@@ -29,10 +29,6 @@ enum FontMidiumSize: DefaultValueProvider {
 	public static let `default`: CGFloat = 14
 }
 
-enum BlankURL: DefaultValueProvider {
-	public static let `default` = URL(fileURLWithPath: "")
-}
-
 enum Nil<T>: DefaultValueProvider where T: Equatable, T: Codable {
 	public static var `default`: T? { nil }
 }

Sources/BoilerplateCommand/BoilerplateAssetConfig.swift

@@ -51,7 +51,7 @@ struct BoilerplateAssetConfig: SummonAssetConfig, Encodable {
 	}
 
 	struct BoilerplateMetadata: CommonMetadata, Encodable {
-		let baseUrl: URL
+		let baseUrl: URL?
 		let nameFormat: String
 		let descriptionFormat: String
 		let externalUrlFormat: String?

Sources/CommandCommon/URL+SwiftCLI.swift

@@ -0,0 +1,8 @@
+import Foundation
+import SwiftCLI
+
+extension URL: ConvertibleFromString {
+	public init?(input: String) {
+		self.init(string: input)
+	}
+}

Sources/EnchantCommand/EnchantCommand.swift

@@ -41,6 +41,9 @@ public class EnchantCommand: Command {
 	@Key("-r", "--reprint", description: "Pickup assets based on data.sqlite file", completion: .filename)
 	var sqliteFile: File?
 
+	@Key("--baseurl", description: "Base URL to place metadata (default is difined in config.json)", completion: .none)
+	var baseURL: URL?
+
 	@Flag("-e", "--embedded", description: "Embed encoded image in metadata")
 	var embedDecodedImageInMetadata: Bool
 
@@ -155,22 +158,30 @@ private extension EnchantCommand {
 		let exifReader = ExifReader(fileURL: assetFile.url)
 		let spells = exifReader.spells.map(\.phrase)
 
-		switch metadataFactory.generateMetadata(from: .completedAsset(name: assetFile.nameExcludingExtension, spells: spells, config: config), as: nameFactory.fileName(from: index), serial: index, imageType: fileType, embededImage: imageData) {
-		case let .success(file):
-			stdout <<< "Created: \(file.path)"
-			return true
-		case let .failure(error):
-			switch error {
-			case .creatingFileFailed:
-				stderr <<< "Couldn't create file to write metadata."
-			case .invalidMetadataSortConfig:
-				stderr <<< "Sorting metadata config should cover all trait you defined."
-			case .invalidBackgroundColorCode:
-				stderr <<< "backgroundColor in metadata should be 3 or 6 hex code without # prefix."
-			case .writingFileFailed:
-				stderr <<< "Writing metadata failed."
-			}
-			return false
+		switch metadataFactory.generateMetadata(
+			from: .completedAsset(name: assetFile.nameExcludingExtension, spells: spells, config: config),
+			as: nameFactory.fileName(from: index),
+			serial: index,
+			imageType: fileType,
+			overrideBaseURL: baseURL,
+			embededImage: imageData) {
+			case let .success(file):
+				stdout <<< "Created: \(file.path)"
+				return true
+			case let .failure(error):
+				switch error {
+					case .creatingFileFailed:
+						stderr <<< "Couldn't create file to write metadata."
+					case .invalidMetadataSortConfig:
+						stderr <<< "Sorting metadata config should cover all trait you defined."
+					case .invalidBackgroundColorCode:
+						stderr <<< "backgroundColor in metadata should be 3 or 6 hex code without # prefix."
+					case .writingFileFailed:
+						stderr <<< "Writing metadata failed."
+					case .undifinedBaseURL:
+						stderr <<< "BaseURL is not defined."
+				}
+				return false
 		}
 	}
 

Sources/MetadataFactory/MetadataFactory.swift

@@ -17,7 +17,7 @@ public struct MetadataFactory {
 
 public extension MetadataFactory {
 	@discardableResult
-	func generateMetadata(from subject: MetadataSubject, as name: String, serial: Int, imageType: UTType, embededImage: Data? = nil) -> Result<File, MetadataFactoryError> {
+	func generateMetadata(from subject: MetadataSubject, as name: String, serial: Int, imageType: UTType, overrideBaseURL: URL? = nil, embededImage: Data? = nil) -> Result<File, MetadataFactoryError> {
 		guard let jsonFile = try? outputFolder.createFileIfNeeded(withName: "\(name).json") else { return .failure(.creatingFileFailed) }
 
 		let attributes = attributes(subject: subject)
@@ -28,14 +28,18 @@ public extension MetadataFactory {
 			}
 
 		let config = subject.config
+		guard let baseURL = overrideBaseURL ?? config.baseUrl else {
+			try? jsonFile.delete()
+			return .failure(.undifinedBaseURL)
+		}
 
 		// sort attributes
 		guard let sortedAttribute = sort(attributes: attributes, traitOrder: config.traitOrder) else {
 			try? jsonFile.delete()
 			return .failure(.invalidMetadataSortConfig)
 		}
 
-		let imageURLType = embededImage.map(ImageURLType.dataURL(data: )) ?? .locationURL(baseURL: config.baseUrl, name: name)
+		let imageURLType = embededImage.map(ImageURLType.dataURL(data: )) ?? .locationURL(baseURL: baseURL, name: name)
 		let imageURL = imageURL(urlType: imageURLType, imageType: imageType)
 
 		let name = replace(in: config.nameFormat, attributes: attributes, serial: serial)

Sources/MetadataFactory/MetadataFactoryError.swift

@@ -3,4 +3,5 @@ public enum MetadataFactoryError: Error {
 	case invalidMetadataSortConfig
 	case invalidBackgroundColorCode
 	case writingFileFailed
+	case undifinedBaseURL
 }

Sources/SummonCommand/SummonCommand.swift

@@ -50,6 +50,9 @@ public class SummonCommand: Command {
 	@Key("-t", "--type", description: "Type to generate image (default is gif)", completion: .values([(name: "gif", description: ""), (name: "png", description: "")]), validation: [.custom("unsupported image type") { $0 == .gif || $0 == .png }])
 	var imageType: UTType!
 
+	@Key("--baseurl", description: "Base URL to place metadata (default is difined in config.json)", completion: .none)
+	var baseURL: URL?
+
 	@Flag("-e", "--embedded", description: "Embed encoded image in metadata")
 	var embedDecodedImageInMetadata: Bool
 
@@ -276,7 +279,13 @@ private extension SummonCommand {
 		guard !noMetadata else { return .nothing }
 		let imageData = embedDecodedImageInMetadata ? data : nil
 
-		switch metadataFactory.generateMetadata(from: input.assets.metadataSubject(config: config), as: nameFactory.fileName(from: index), serial: index, imageType: imageType, embededImage: imageData) {
+		switch metadataFactory.generateMetadata(
+			from: input.assets.metadataSubject(config: config),
+			as: nameFactory.fileName(from: index),
+			serial: index,
+			imageType: imageType,
+			overrideBaseURL: baseURL,
+			embededImage: imageData) {
 			case let .success(file):
 				stdout <<< "Created: \(file.path)"
 				return .success(file: file)
@@ -290,6 +299,8 @@ private extension SummonCommand {
 						stderr <<< "backgroundColor in metadata should be 3 or 6 hex code without # prefix."
 					case .writingFileFailed:
 						stderr <<< "Writing metadata failed."
+					case .undifinedBaseURL:
+						stderr <<< "BaseURL is not defined."
 				}
 				return .failure
 		}