Merge branch 'develop'

Lighter-swift · Aug 24, 2022 · bdc3b91 · bdc3b91
2 parents c2a80a7 + db127eb
commit bdc3b91
Show file tree

Hide file tree

Showing 18 changed files with 422 additions and 70 deletions.
diff --git a/Plugins/Enlighter/Enlighter.swift b/Plugins/Enlighter/Enlighter.swift
@@ -57,10 +57,11 @@ struct Enlighter: BuildToolPlugin {
       ?? (rootJSON["outputFile"] as? String)
 
       let targetConfig = EnlighterTargetConfig(
-        extensions : extensions(in: rootJSON, target: target.name),
-        outputFile : outputFile,
-        verbose    : verbose,
-        configURL  : configURL
+        dbExtensions : dbExtensions(in: rootJSON, target: target.name),
+        extensions   : extensions(in: rootJSON, target: target.name),
+        outputFile   : outputFile,
+        verbose      : verbose,
+        configURL    : configURL
       )
       guard !targetConfig.extensions.isEmpty else {
         print("Skipping \"\(target.name)\",",
@@ -97,6 +98,16 @@ struct Enlighter: BuildToolPlugin {
     #endif
   }
 
+  fileprivate func dbExtensions(in rootJSON: [ String : Any ], target: String)
+                   -> Set<String>
+  {
+    let targetJSON = rootJSON[target] as? [ String : Any ]
+    let exts1 = (targetJSON?  ["databaseExtensions"] as? [ String ])
+             ?? (rootJSON     ["databaseExtensions"] as? [ String ])
+             ?? (defaultConfig["databaseExtensions"] as? [ String ])
+             ?? []
+    return Set(exts1)
+  }
   fileprivate func extensions(in rootJSON: [ String : Any ], target: String)
                    -> Set<String>
   {
@@ -112,7 +123,7 @@ struct Enlighter: BuildToolPlugin {
 
     return Set(exts1).union(exts2)
   }
-
+    
   fileprivate func locateConfigFile(in context: PackagePlugin.PluginContext)
                    -> URL?
   {
@@ -151,7 +162,7 @@ struct Enlighter: BuildToolPlugin {
     }
     return result
   }
-
+    
   private func generate(context       : PackagePlugin.PluginContext,
                         target        : SwiftSourceModuleTarget,
                         configuration : EnlighterTargetConfig,
@@ -191,8 +202,9 @@ struct Enlighter: BuildToolPlugin {
         if configuration.verbose {
           args.append("--verbose")
         }
-        if !group.resourceURLs.isEmpty {
-          args.append("--has-resources")
+        if let name = group.moduleFilename(using: configuration.dbExtensions) {
+          args.append("--module-filename")
+          args.append(name)
         }
         args.append(configuration.configURL?.path ?? "default")
         args.append(target.name) // required to resolve configs
@@ -264,10 +276,11 @@ extension Enlighter: XcodeBuildToolPlugin {
       ?? (rootJSON["outputFile"] as? String)
 
       let targetConfig = EnlighterTargetConfig(
-        extensions : extensions(in: rootJSON, target: target.name),
-        outputFile : outputFile,
-        verbose    : verbose,
-        configURL  : configURL
+        dbExtensions : dbExtensions(in: rootJSON, target: target.name),
+        extensions   : extensions(in: rootJSON, target: target.name),
+        outputFile   : outputFile,
+        verbose      : verbose,
+        configURL    : configURL
       )
       guard !targetConfig.extensions.isEmpty else {
         print("Skipping \"\(target.name)\",",
@@ -353,8 +366,9 @@ extension Enlighter: XcodeBuildToolPlugin {
         if configuration.verbose {
           args.append("--verbose")
         }
-        if !group.resourceURLs.isEmpty {
-          args.append("--has-resources")
+        if let name = group.moduleFilename(using: configuration.dbExtensions) {
+          args.append("--module-filename")
+          args.append(name)
         }
         args.append(configuration.configURL?.path ?? "default")
         args.append(target.name) // required to resolve configs

diff --git a/Plugins/Enlighter/EnlighterGroup.swift b/Plugins/Enlighter/EnlighterGroup.swift
@@ -32,6 +32,14 @@ struct EnlighterGroup: CustomStringConvertible {
     matches.map(\.lastPathComponent).joined(separator: ",") + ">"
   }
 
+  func moduleFilename(using extensions: Set<String>) -> String? {
+    guard !resourceURLs.isEmpty && !extensions.isEmpty else { return nil }
+    for url in resourceURLs {
+      if extensions.contains(url.pathExtension) { return url.lastPathComponent }
+    }
+    return nil
+  }
+
   static func load(from    baseURL : URL,
                    resourcesPathes : Set<String>,
                    configuration   : EnlighterTargetConfig)

diff --git a/Plugins/Enlighter/EnlighterTargetConfig.swift b/Plugins/Enlighter/EnlighterTargetConfig.swift
@@ -3,13 +3,14 @@
 //  Copyright © 2022 ZeeZide GmbH.
 //
 
-import Foundation
+import struct Foundation.URL
 
 struct EnlighterTargetConfig { // that's all we need from Lighter.json
 
-  let extensions : Set<String>
-  let outputFile : String?
+  let dbExtensions : Set<String>
+  let extensions   : Set<String>
+  let outputFile   : String?
 
-  let verbose    : Bool
-  let configURL  : URL?
+  let verbose      : Bool
+  let configURL    : URL?
 }
diff --git a/Plugins/GenerateCodeForSQLite/EnlighterGroup.swift b/Plugins/GenerateCodeForSQLite/EnlighterGroup.swift
@@ -31,7 +31,15 @@ struct EnlighterGroup: CustomStringConvertible {
     "<Group[\(stem)]: " +
     matches.map(\.lastPathComponent).joined(separator: ",") + ">"
   }
-
+
+  func moduleFilename(using extensions: Set<String>) -> String? {
+    guard !resourceURLs.isEmpty && !extensions.isEmpty else { return nil }
+    for url in resourceURLs {
+      if extensions.contains(url.pathExtension) { return url.lastPathComponent }
+    }
+    return nil
+  }
+
   static func load(from    baseURL : URL,
                    resourcesPathes : Set<String>,
                    configuration   : EnlighterTargetConfig)

diff --git a/Plugins/GenerateCodeForSQLite/EnlighterTargetConfig.swift b/Plugins/GenerateCodeForSQLite/EnlighterTargetConfig.swift
@@ -3,13 +3,14 @@
 //  Copyright © 2022 ZeeZide GmbH.
 //
 
-import Foundation
+import struct Foundation.URL
 
 struct EnlighterTargetConfig { // that's all we need from Lighter.json
 
-  let extensions : Set<String>
-  let outputFile : String?
+  let dbExtensions : Set<String>
+  let extensions   : Set<String>
+  let outputFile   : String?
 
-  let verbose    : Bool
-  let configURL  : URL?
+  let verbose      : Bool
+  let configURL    : URL?
 }
diff --git a/Plugins/GenerateCodeForSQLite/GenerateCodeForSQLite.swift b/Plugins/GenerateCodeForSQLite/GenerateCodeForSQLite.swift
@@ -75,10 +75,11 @@ struct GenerateCodeForSQLite: CommandPlugin {
         ?? (rootJSON["outputFile"] as? String)
 
         let targetConfig = EnlighterTargetConfig(
-          extensions : extensions(in: rootJSON, target: target.name),
-          outputFile : outputFile,
-          verbose    : args.verbose,
-          configURL  : configURL
+          dbExtensions : dbExtensions(in: rootJSON, target: target.name),
+          extensions   : extensions(in: rootJSON, target: target.name),
+          outputFile   : outputFile,
+          verbose      : args.verbose,
+          configURL    : configURL
         )
         guard !targetConfig.extensions.isEmpty else {
           if args.verbose {
@@ -117,6 +118,16 @@ struct GenerateCodeForSQLite: CommandPlugin {
     #endif
   }
 
+  fileprivate func dbExtensions(in rootJSON: [ String : Any ], target: String)
+                   -> Set<String>
+  {
+    let targetJSON = rootJSON[target] as? [ String : Any ]
+    let exts1 = (targetJSON?  ["databaseExtensions"] as? [ String ])
+             ?? (rootJSON     ["databaseExtensions"] as? [ String ])
+             ?? (defaultConfig["databaseExtensions"] as? [ String ])
+             ?? []
+    return Set(exts1)
+  }
   fileprivate func extensions(in rootJSON: [ String : Any ], target: String)
                    -> Set<String>
   {
@@ -208,8 +219,9 @@ struct GenerateCodeForSQLite: CommandPlugin {
         if configuration.verbose {
           args.append("--verbose")
         }
-        if !group.resourceURLs.isEmpty {
-          args.append("--has-resources")
+        if let name = group.moduleFilename(using: configuration.dbExtensions) {
+          args.append("--module-filename")
+          args.append(name)
         }
         args.append(configuration.configURL?.path ?? "default")
         args.append(target.name) // required to resolve configs
@@ -281,10 +293,11 @@ extension GenerateCodeForSQLite: XcodeCommandPlugin {
         ?? (rootJSON["outputFile"] as? String)
 
         let targetConfig = EnlighterTargetConfig(
-          extensions : extensions(in: rootJSON, target: target.name),
-          outputFile : outputFile,
-          verbose    : args.verbose,
-          configURL  : configURL
+          dbExtensions : dbExtensions(in: rootJSON, target: target.name),
+          extensions   : extensions(in: rootJSON, target: target.name),
+          outputFile   : outputFile,
+          verbose      : args.verbose,
+          configURL    : configURL
         )
         guard !targetConfig.extensions.isEmpty else {
           if args.verbose {
@@ -369,8 +382,9 @@ extension GenerateCodeForSQLite: XcodeCommandPlugin {
         if configuration.verbose {
           args.append("--verbose")
         }
-        if !group.resourceURLs.isEmpty {
-          args.append("--has-resources")
+        if let name = group.moduleFilename(using: configuration.dbExtensions) {
+          args.append("--module-filename")
+          args.append(name)
         }
         args.append(configuration.configURL?.path ?? "default")
         args.append(target.name) // required to resolve configs

diff --git a/Plugins/Libraries/LighterGeneration/GenModel/Property.swift b/Plugins/Libraries/LighterGeneration/GenModel/Property.swift
@@ -86,7 +86,13 @@ public extension EntityInfo {
 
     /// Whether this property has a type that can be generated by the SQLite
     /// database.
+    /// https://www.sqlite.org/lang_createtable.html#rowid
+    /// https://www.sqlite.org/autoinc.html
+    /// Note: This is only really true for `INTEGER`, just `INT` doesn't trigger
+    ///       the ID generation!!
     public var canBeDatabaseGenerated : Bool {
+      // If the key is synthesized, i.e. not marked as a pkey in the DB, the DB
+      // won't generate a value for it!
       columnType == .integer && isPrimaryKey && !isPrimaryKeySynthesized
     }
   }

diff --git a/Plugins/Libraries/LighterGeneration/LighterConfiguration/FancyfierConfig.swift b/Plugins/Libraries/LighterGeneration/LighterConfiguration/FancyfierConfig.swift
@@ -5,7 +5,7 @@
 
 public extension Fancifier.Options {
 
-  // swiftMapping
+  // SwiftMapping dictionary
   init(section: ConfigFile.Section?) {
     self.init()
     guard let section = section else { return }

diff --git a/Plugins/Libraries/LighterGeneration/LighterConfiguration/LighterConfiguration.swift b/Plugins/Libraries/LighterGeneration/LighterConfiguration/LighterConfiguration.swift
@@ -11,21 +11,21 @@ import LighterCodeGenAST
  *
  * Example:
  * ```json
- * "codeStyle": {
+ * "CodeStyle": {
  *   "functionCommentStyle" : "**",
  *   "indent"               : "  ",
  *   "lineLength"           : 80
  * },
  *
- * "embeddedLighter": {
+ * "EmbeddedLighter": {
  *   "selects": {
  *     "syncYield"  : { "columns": 8, "sorts": 2 },
  *     "syncArray"  : { "columns": 8, "sorts": 2 },
  *     "asyncArray" : { "columns": 8, "sorts": 2 }
  *   }
  * },
  *
- * "swiftMapping": {
+ * "SwiftMapping": {
  *   "databaseTypeName": { ... }
  * }
  * ```
@@ -112,11 +112,13 @@ public extension LighterConfiguration {
       embeddedLighter = .disabled
     }
     else {
-      embeddedLighter = .init(section: section?[section: "EmbeddedLighter"])
+      embeddedLighter = LighterConfiguration
+        .EmbeddedLighter(section: section?[section: "EmbeddedLighter"])
     }
 
-    swiftMapping = .init(section: section?[section: "SwiftMapping"])
+    swiftMapping = Fancifier.Options(section: section?[section: "SwiftMapping"])
 
-    codeGeneration = .init(section: section?[section: "CodeGeneration"])
+    codeGeneration = EnlighterASTGenerator
+      .Options(section: section?[section: "CodeGeneration"])
   }
 }
diff --git a/Plugins/Libraries/LighterGeneration/RecordGeneration/GenerateRecordStructure.swift b/Plugins/Libraries/LighterGeneration/RecordGeneration/GenerateRecordStructure.swift
@@ -3,6 +3,7 @@
 //  Copyright © 2022 ZeeZide GmbH.
 //
 
+import Foundation
 import LighterCodeGenAST
 
 extension EnlighterASTGenerator {
@@ -44,9 +45,7 @@ extension EnlighterASTGenerator {
                comment: commentForPropertyVariable(property))
       },
       computedProperties : idProperty.flatMap({ [ $0 ] }) ?? [],
-      functions          : [
-        buildRegularInitForEntity(entity)
-      ],
+      functions          : [ buildRegularInitForEntity(entity) ],
       comment            : generateCommentForRecordStruct(entity)
     )
   }
@@ -57,10 +56,23 @@ extension EnlighterASTGenerator {
   func buildInitParameter(_ property: EntityInfo.Property)
        -> FunctionDeclaration.Parameter
   {
-    .init(
+    FunctionDeclaration.Parameter(
       keyword: property.name, name: property.name,
       type: type(for: property),
-      defaultValue: defaultValue(for: property)
+      defaultValue: defaultValue(for: property) ?? {
+        if property.isPrimaryKey {
+          if property.propertyType == .uuid { // null or not
+            // If the primary key is a UUID, generate a default value for that.
+            return .call(name: "UUID")
+          }
+          if property.canBeDatabaseGenerated && property.isNotNull &&
+             property.propertyType == .integer
+          {
+            return .variableReference(instance: "Int", name: "min")
+          }
+        }
+        return nil
+      }()
     )
   }
 
@@ -89,13 +101,17 @@ extension EnlighterASTGenerator {
     let sqlType      = property.columnType ?? .any
 
     var ms = "\(prefix) `\(property.externalName)` (`\(sqlType.rawValue)`), "
-    ms += property.isNotNull    ? "required"    : "optional"
+    ms += property.isNotNull ? "required"    : "optional"
     switch defaultValue {
+      case .none                         : break // no defaults
       case .literal(.nil)                : ms += " (default: `nil`)"
       case .literal(.integer(let value)) : ms += " (default: `\(value)`)"
       case .literal(.double (let value)) : ms += " (default: `\(value)`)"
-      case .literal(.string)             : ms += " (has default string)"
-      default                            : ms += " (has default)"
+      case .literal(.string (let value)) :
+        if value.isEmpty { ms += " (empty string as default)" }
+        else { ms += " (has default string #\(value.count))" }
+      default: // this is hit w/ complex expressions!
+        ms += " (has default)"
     }
     ms += "."
     return ms