janhalousek / rubicon

Swift parser + mock generator

Rubicon

Again available on AppStore https://itunes.apple.com/cz/app/rubicon/id1453837387

Swift parser + mock generator

Rubicon generates spys for protocol. Generating methods for parent protocol is not supported.

Example

input:

protocol Car {

    var name: String? { get }
    var color: Int { get set }

    func go()
    func load(with stuff: Int, label: String) throws -> Int
    func isFull() -> Bool
    func download() async throws -> [String]

}

Spy

output:

class CarSpy: Car {

    enum SpyError: Error {
        case spyError
    }
    typealias ThrowBlock = () throws -> Void

    var name: String?
    var color: Int

    struct Load {
        let stuff: Int
        let label: String
    }

    var goCount = 0
    var load = [Load]()
    var loadThrowBlock: ThrowBlock?
    var loadReturn: Int
    var isFullCount = 0
    var isFullReturn: Bool
    var downloadCount = 0
    var downloadThrowBlock: ThrowBlock?
    var downloadReturn: [String]

    init(color: Int, loadReturn: Int, isFullReturn: Bool, downloadReturn: [String]) {
        self.color = color
        self.loadReturn = loadReturn
        self.isFullReturn = isFullReturn
        self.downloadReturn = downloadReturn
    }

    func go() {
        goCount += 1
    }

    func load(with stuff: Int, label: String) throws -> Int {
        let item = Load(stuff: stuff, label: label)
        load.append(item)
        try loadThrowBlock?()
        return loadReturn
    }

    func isFull() -> Bool {
        isFullCount += 1
        return isFullReturn
    }

    func download() async throws -> [String] {
        downloadCount += 1
        try downloadThrowBlock?()
        return downloadReturn
    }
}

Mock

output:

class CarStub: Car {

    enum StubError: Error {
        case stubError
    }
    typealias ThrowBlock = () throws -> Void

    var name: String?
    var color: Int

    var loadThrowBlock: ThrowBlock?
    var loadReturn: Int
    var isFullReturn: Bool
    var downloadThrowBlock: ThrowBlock?
    var downloadReturn: [String]

    init(color: Int, loadReturn: Int, isFullReturn: Bool, downloadReturn: [String]) {
        self.color = color
        self.loadReturn = loadReturn
        self.isFullReturn = isFullReturn
        self.downloadReturn = downloadReturn
    }

    func go() {
    }

    func load(with stuff: Int, label: String) throws -> Int {
        try loadThrowBlock?()
        return loadReturn
    }

    func isFull() -> Bool {
        return isFullReturn
    }

    func download() async throws -> [String] {
        try downloadThrowBlock?()
        return downloadReturn
    }
}

Dummy

output:

class CarDummy: Car {

    var name: String? {
        fatalError()
    }
    var color: Int {
        get {
            fatalError()
        }
        set {
            fatalError()
        }
    }

    func go() {
        fatalError()
    }

    func load(with stuff: Int, label: String) throws -> Int {
        fatalError()
    }

    func isFull() -> Bool {
        fatalError()
    }

    func download() async throws -> [String] {
        fatalError()
    }
}

Usage in tests:

let carSpy = CarSpy()

...

XCTAssertEqual(carSpy.goCount, 1)
XCTAssertEqual(carSpy.load.count, 1)
XCTAssertEqual(carSpy.load[0].stuff, 2)
XCTAssertEqual(carSpy.load[0].label, "name")

CLI

Rubicon cli can generate mocks for every protocol in folder. Script runs through every swift file and find every protocol definition. Result is printed at standard out.

example:

$ ./rubicon --spy .

Options:

--mocks path - generates spies (deprecated)

--spy path - generates spies

--stub path - generates stubs

--dummy path - generates dummies

Xcode extension

Xcode extension can generate Spy for every or selected protocol in current file. Spy can be written to source file or pasteboard.