Merge uber/remove-sourcekit

Remove sourcekitten parser

Author: Ellie Shin

MockoloFramework.podspec

@@ -4,7 +4,6 @@ import PackageDescription
 var dependencies: [Package.Dependency] = [
     .package(url: "https://github.com/apple/swift-argument-parser", .upToNextMinor(from: "0.0.4")),
     .package(url: "https://github.com/apple/swift-tools-support-core.git", .branch("master")),
-    .package(url: "https://github.com/jpsim/SourceKitten", from: "0.29.0"),
     .package(name: "SwiftSyntax", url: "https://github.com/apple/swift-syntax.git", .exact("0.50200.0"))
 ]
 
@@ -29,7 +28,6 @@ let package = Package(
         .target(
             name: "MockoloFramework",
             dependencies: [
-                .product(name: "SourceKittenFramework", package: "SourceKitten"),
                 .product(name: "SwiftSyntax", package: "SwiftSyntax"),
             ]
         ),

Package.swift

@@ -103,7 +103,6 @@ OPTIONS:
   --testable-imports, -i  If set, @testable import statments will be added for each module name in this list.
   --concurrency-limit, -j Maximum number of threads to execute concurrently (default = number of cores on the running machine).
   --logging-level, -v     The logging level to use. Default is set to 0 (info only). Set 1 for verbose, 2 for warning, and 3 for error.
-  --use-sourcekit         If this argument is added, it will use SourceKit for parsing. By default it uses SwiftSyntax.
   --help, -h                  Displays available options.
   ```
 
@@ -270,7 +269,6 @@ public class FooMock: Foo {
 ## Used libraries
 
 [SwiftSyntax](https://github.com/apple/swift-syntax) | 
-[SourceKitten](https://github.com/jpsim/SourceKitten)
 
 
 ## How to contribute to Mockolo

README.md

@@ -40,7 +40,6 @@ class Executor {
     private var useMockObservable: OptionArgument<Bool>!
     private var mockAll: OptionArgument<Bool>!
     private var concurrencyLimit: OptionArgument<Int>!
-    private var useSourceKit: OptionArgument<Bool>!
 
     /// Initializer.
     ///
@@ -129,9 +128,6 @@ class Executor {
                                       shortName: "-j",
                                       kind: Int.self,
                                       usage: "Maximum number of threads to execute concurrently (default = number of cores on the running machine).")
-        useSourceKit = parser.add(option: "--use-sourcekit",
-                             kind: Bool.self,
-                             usage: "Whether to use SourceKit for parsing. By default it will use SwiftSyntax.")
     }
 
     private func fullPath(_ path: String) -> String {
@@ -185,15 +181,14 @@ class Executor {
         let testableImports = arguments.get(self.testableImports)
         let customImports = arguments.get(self.customImports)
         let excludeImports = arguments.get(self.excludeImports)
-        let shouldUseSourceKit = arguments.get(useSourceKit) ?? false
         let shouldUseTemplateFunc = arguments.get(useTemplateFunc) ?? false
         let shouldUseMockObservable = arguments.get(useMockObservable) ?? false
         let shouldMockAll = arguments.get(mockAll) ?? false
 
         do {
             try generate(sourceDirs: srcDirs,
                          sourceFiles: srcs,
-                         parser: shouldUseSourceKit ? ParserViaSourceKit() : ParserViaSwiftSyntax(),
+                         parser: ParserViaSwiftSyntax(),
                          exclusionSuffixes: exclusionSuffixes,
                          mockFilePaths: mockFilePaths,
                          annotation: annotation,

Sources/Mockolo/Executor.swift

@@ -15,7 +15,6 @@
 //
 
 import Foundation
-import SourceKittenFramework
 
 public enum MethodKind: Equatable {
     case funcKind
@@ -128,65 +127,6 @@ final class MethodModel: Model {
         self.accessLevel = acl
     }
 
-    init(_ ast: Structure, encloserType: DeclType, filepath: String, data: Data, processed: Bool) {
-        // This will split func signature into name and the rest (params, return type). In case it's a generic func,
-        // its type parameters will be in its substrctures (and < > are omitted in the func ast.name), so it will only
-        // give the name part that we expect.
-        var comps = ast.name.components(separatedBy: CharacterSet(arrayLiteral: ":", "(", ")")).filter {!$0.isEmpty}
-        let nameString = comps.removeFirst()
-        self.filePath = filepath
-        self.data = data
-        self.name = nameString
-        self.type = Type(ast.typeName)
-        self.isStatic = ast.isStaticMethod
-        self.processed = processed
-        self.shouldOverride = ast.isOverride || encloserType == .classType
-        if ast.isSubscript {
-            self.kind = .subscriptKind
-        } else if ast.isInitializer {
-            let isRequired = ast.isRequired || encloserType == .protocolType
-            self.kind = .initKind(required: isRequired, override: shouldOverride)
-        } else {
-            self.kind = .funcKind
-        }
-        self.offset = ast.range.offset
-        self.length = ast.range.length
-        let needVarDecl = encloserType == .protocolType // Params in protocol init should be declared as private vars if not done already
-        
-        let paramDecls = ast.substructures.filter(path: \.isVarParameter)
-        assert(paramDecls.count == comps.count)
-        
-        let zippedParams = zip(paramDecls, comps)
-        self.params = zippedParams.map { (argAst: Structure, argLabel: String) -> ParamModel in
-            return ParamModel(argAst, label: argLabel, offset: argAst.offset, length: argAst.length, data: data, inInit: ast.isInitializer, needVarDecl: needVarDecl)
-        }
-        
-        self.genericTypeParams = ast.substructures
-            .filter(path: \.isGenericTypeParam)
-            .map { (arg: Structure) -> ParamModel in
-                ParamModel(arg, label: arg.name, offset: arg.offset, length: arg.length, data: data, isGeneric: true, needVarDecl: false)
-        }
-        
-        // Sourcekit structure api doesn't provide info on throws/rethrows, so manually parse it here
-        let suffixOffset = ast.nameOffset + ast.nameLength + 1
-        let suffixLen = ast.offset + ast.length - suffixOffset
-        if suffixLen > 0, suffixOffset > ast.bodyOffset - 1 {
-            let suffixPart = data.toString(offset: suffixOffset, length: suffixLen).trimmingCharacters(in: .whitespacesAndNewlines)
-            if suffixPart.hasPrefix("\(String.SwiftKeywords.rethrows.rawValue)") {
-                self.suffix = String.SwiftKeywords.rethrows.rawValue
-            } else if suffixPart.hasPrefix("\(String.SwiftKeywords.throws.rawValue)") {
-                self.suffix = String.SwiftKeywords.throws.rawValue
-            } else {
-                self.suffix = ""
-            }
-        } else {
-            self.suffix = ""
-        }
-        
-        self.accessLevel = ast.accessLevel
-        self.attributes = ast.hasAvailableAttribute ? ast.extractAttributes(data, filterOn: SwiftDeclarationAttributeKind.available.rawValue) : []
-    }
-
     var fullName: String {
         return self.name + self.signatureComponents.joined() + staticKind
     }
@@ -204,7 +144,7 @@ final class MethodModel: Model {
         if processed {
             var prefix = shouldOverride  ? "\(String.override) " : ""
 
-            if case .initKind(required: let isRequired, override: let override) = self.kind {
+            if case .initKind(required: let isRequired, override: _) = self.kind {
                 if isRequired {
                     prefix = ""
                 }

Sources/MockoloFramework/Models/MethodModel.swift

@@ -15,7 +15,6 @@
 //
 
 import Foundation
-import SourceKittenFramework
 
 final class ParamModel: Model {
     var name: String
@@ -51,21 +50,6 @@ final class ParamModel: Model {
         self.needVarDecl = needVarDecl
     }
 
-    init(_ ast: Structure, label: String = "", offset: Int64, length: Int64, data: Data, isGeneric: Bool = false, inInit: Bool = false, needVarDecl: Bool) {
-        self.name = ast.name
-        self.offset = offset
-        self.length = length
-        // Sourcekit doesn't specify if a func arg is variadic, so look ahead for the following characters to  determine.
-        let lookahead = data.toString(offset: offset + length, length: 3)
-        let isVariadic = lookahead == "..."
-        self.isGeneric = isGeneric
-        self.inInit = inInit
-        self.needVarDecl = needVarDecl
-        let typeArg = isGeneric ? (ast.inheritedTypes.first ?? .unknownVal) : (isVariadic ? ast.typeName + "..." : ast.typeName)
-        self.type = Type(typeArg)
-        self.label = ast.name != label ? label : ""
-    }
-
     var underlyingName: String {
         return "_\(name)"
     }

Sources/MockoloFramework/Models/ParamModel.swift

@@ -15,7 +15,6 @@
 //
 
 import Foundation
-import SourceKittenFramework
 
 /// Metadata containing unique models and potential init params ready to be rendered for output
 struct ResolvedEntity {

Sources/MockoloFramework/Models/ParsedEntity.swift

@@ -15,8 +15,6 @@
 //
 
 import Foundation
-import SourceKittenFramework
-
 
 final class TypeAliasModel: Model {
     var filePath: String = ""
@@ -55,32 +53,6 @@ final class TypeAliasModel: Model {
         }
     }
 
-    init(_ ast: Structure, filepath: String, data: Data, overrideTypes: [String: String]?, processed: Bool) {
-        self.name = ast.name
-        self.filePath = filepath
-        self.offset = ast.offset
-        self.length = ast.length
-        self.typeOffset = ast.nameOffset + ast.nameLength + 1
-        self.typeLength = ast.offset + ast.length - typeOffset
-        self.accessLevel = ast.accessLevel
-        self.processed = processed
-        self.overrideTypes = overrideTypes
-        self.modelDescription = ast.description
-        // If there's an override typealias value, set it to type
-        if let val = overrideTypes?[self.name] {
-            self.type  = Type(val)
-        } else {
-            // Sourcekit doesn't give inheritance type info for an associatedtype, so need to manually parse it from the content
-            if typeLength < 0 {
-                self.type = Type(String.any)
-            } else {
-                let charset = CharacterSet(arrayLiteral: "=", ":").union(.whitespaces)
-                let typeArg = data.toString(offset: typeOffset, length: typeLength).trimmingCharacters(in: charset)
-                self.type = Type(typeArg)
-            }
-        }
-    }
-
     var fullName: String {
         return self.name + self.type.displayName
     }

Sources/MockoloFramework/Models/TypeAliasModel.swift

@@ -1,5 +1,4 @@
 import Foundation
-import SourceKittenFramework
 
 final class VariableModel: Model {
     var name: String
@@ -58,22 +57,6 @@ final class VariableModel: Model {
         self.modelDescription = modelDescription
     }
 
-    init(_ ast: Structure, encloserType: DeclType, filepath: String, data: Data, overrideTypes: [String: String]?, processed: Bool) {
-        name = ast.name
-        type = Type(ast.typeName)
-        offset = ast.range.offset
-        length = ast.range.length
-        canBeInitParam = ast.canBeInitParam
-        isStatic = ast.isStaticVariable
-        shouldOverride = ast.isOverride || encloserType == .classType
-        accessLevel = ast.accessLevel
-        attributes = ast.hasAvailableAttribute ? ast.extractAttributes(data, filterOn: SwiftDeclarationAttributeKind.available.rawValue) : nil
-        self.processed = processed
-        self.overrideTypes = overrideTypes
-        self.data = data
-        self.filePath = filepath
-    }
-    
     func render(with identifier: String, encloser: String, useTemplateFunc: Bool = false, useMockObservable: Bool = false) -> String? {
         if processed {
             var prefix = ""

Sources/MockoloFramework/Models/VariableModel.swift

@@ -21,12 +21,6 @@ enum InputError: Error {
     case sourceFilesError
 }
 
-public enum ParserType {
-    case swiftSyntax
-    case sourceKit
-    case random
-}
-
 /// Performs end to end mock generation flow
 public func generate(sourceDirs: [String]?,
                      sourceFiles: [String]?,