Documentation and preparation for v4.0.0

Author: g-amichnia

.jazzy.yaml

@@ -17,6 +17,7 @@ custom_categories:
       - Mockfile
       - Command Line Interface
       - Supported features
+      - Prototyping
 
   - name: Additional Guides
     children:
@@ -62,11 +63,6 @@ custom_categories:
       - XCTAssertThrowsError(_:error:_:file:line:)
       - MockyAssertion
 
-  - name: Deprecated
-    children:
-      - VerifyProperty(_:_:file:line:)
-      - VerifyProperty(_:_:_:file:line:)
-
   - name: Internal
     children:
       - SwiftyMockyTestObserver

Mintfile

@@ -1 +1 @@
-MakeAWishFoundation/SwiftyMocky-CLI@4.0.0-pre
+MakeAWishFoundation/SwiftyMocky-CLI@4.0.0

README.md

@@ -17,7 +17,7 @@ Check out [guides][link-guides-contents], or full [documentation][link-docs]
 ## Table of contents
 
 1. [Overview](#overview)
-1. [Current version](#current-version)
+1. [Current Version](#current-version)
 1. [Getting started:](#getting-started)
     1. [Installing SwiftyMocky CLI](#installation)
     1. [Integrating SwiftyMocky runtime into test target](#integration)
@@ -54,24 +54,28 @@ The idea of **SwiftyMocky** is to automatically mock Swift protocols. The main f
 
 <a name="current-version"></a>
 
-## Current version
+## **Important!!!** Version 4.x.x
 
-We consider current version as stable. We are moving toward using the new [Mockfile][link-guides-mockfile] but the previous configuration format would be still supported, until SwiftyMocky 4.0. Library works with Swift **4.1, 4.2, 5.0, 5.1.2**  and  Sourcery 0.17.0.
+Current version has several significant changes. It removes deprecated methods (which might be breaking) and moves CLI to the new [repository](https://github.com/MakeAWishFoundation/SwiftyMockyCLI).
 
-While it is technically possible to integrate SwiftyMocky on Linux targets, there is no Mock generation feature there yet. You can use SwiftyMokcy runtime via SwiftPM though, as long as your are fine with generating mocks on mac machine.
+**SwiftyPrototype** was also extracted to separate library. There are no more compilation flags, so if you were relying on **SwiftyMocky** with `-DMockyCustom`, you will have to switch to `SwiftyPrototype`.
 
-<a name="getting-started"></a>
+We consider current version as stable. We are moving toward using the new [Mockfile][link-guides-mockfile] but the previous configuration format would be still supported. Library works with Swift **4.1, 4.2, 5.0, 5.1.2**  and  Sourcery 0.17-0.18.
+
+While it is technically possible to integrate SwiftyMocky on Linux targets, there is no Mock generation feature there yet. You can use SwiftyMokcy runtime via SwiftPM though, as long as your are fine with generating mocks on mac machine.
 
 ## Migration from 3.2.0 and below
 
 The migration is not required, you can keep using **SwiftyMocky** as you did before. The [Legacy setup](https://github.com/MakeAWishFoundation/SwiftyMocky/blob/master/guides/Legacy.md) is described in [guides section](https://github.com/MakeAWishFoundation/SwiftyMocky/blob/master/guides/Contents.md).
 
-Still, we would encourage to try new **CLI** and share a feedback. We believe it will make using and setting up **SwiftyMocky** way easier. If you have an existing setup, try:
+Still, we would encourage to try new **CLI** and share a feedback. We believe it will make using and setting up **SwiftyMocky** way easier. If you have an existing setup, install CLI as per this [guide](https://github.com/MakeAWishFoundation/SwiftyMocky/blob/master/guides/Installation.md) and try:
 
 ```bash
 > swiftymocky migrate
 ```
 
+<a name="getting-started"></a>
+
 ## Getting started
 
 To start working with **SwiftyMocky** you need to:
@@ -88,15 +92,19 @@ To start working with **SwiftyMocky** you need to:
 
 ```bash
 > brew install mint
-> mint install MakeAWishFoundation/SwiftyMocky
+> mint install MakeAWishFoundation/SwiftyMocky-CLI
 ```
 
 **[Marathon 🏃](https://github.com/JohnSundell/Marathon)**:
 
 ```bash
-> marathon install MakeAWishFoundation/SwiftyMocky
+> marathon install MakeAWishFoundation/SwiftyMocky-CLI
 ```
 
+**Make**:
+
+Clone from https://github.com/MakeAWishFoundation/SwiftyMockyCLI and run `make` in the root directory.
+
 <a name="integration"></a>
 
 ### 2. Integrating SwiftyMocky runtime into test target:
@@ -180,16 +188,6 @@ protocol ToBeMocked {
 
 Every protocol in source directories, having this annotation, will be added to `Mock.generated.swift`
 
-@objc protocols are also supported, but needs to be explicitly marked with ObjcProtocol annotation:
-
-```swift
-//sourcery: AutoMockable
-//sourcery: ObjcProtocol
-@objc protocol NonSwiftProtocol {
-  // ...
-}
-```
-
 <a name="given"></a>
 
 ## 2. Stubbing return values for mock methods - **Given**
@@ -315,7 +313,7 @@ For more examples, check out our example project, or examples section in [guides
 
 To run the example project, clone the repo, and run `pod install` from the Example directory first.
 
-To trigger mocks generation, run `rake mock` from root directory.
+To trigger mocks generation, run `rake mock` or `swiftymocky generate` from root directory (if you installed CLI).
 
 <a name="roadmap"></a>
 

Sources/Shared/Count.swift

@@ -50,6 +50,7 @@ public enum Count: ExpressibleByIntegerLiteral {
 }
 
 // MARK: - CustomStringConvertible
+
 extension Count: CustomStringConvertible {
     /// Human readable description
     public var description: String {
@@ -79,6 +80,7 @@ extension Count: CustomStringConvertible {
 }
 
 // MARK: - Countable
+
 extension Count: Countable {
 
     /// Returns whether given count matches countable case.

Sources/Shared/Mock+Assertions.swift

@@ -13,18 +13,6 @@ public func Verify<T: Mock>(_ object: T, _ method: T.Verify, file: StaticString
     object.verify(method, count: .moreOrEqual(to: 1), file: file, line: line)
 }
 
-/// Verify that given property getter or setter was called on mock object **at least once**.
-///
-/// - Parameters:
-///   - object: Mock instance
-///   - property: Property name, get or set with wrapped newValue (`Parameter`)
-///   - file: for XCTest print purposes
-///   - line: for XCTest print purposes
-@available(*, deprecated, message: "Use Verify instead!")
-public func VerifyProperty<T: Mock>(_ object: T, _ property: T.Verify, file: StaticString = #file, line: UInt = #line) {
-    object.verify(property, count: .moreOrEqual(to: 1), file: file, line: line)
-}
-
 // MARK: - At least once static member called
 
 /// Verify that given static method was called on mock type **at least once**.
@@ -38,18 +26,6 @@ public func Verify<T: StaticMock>(_ type: T.Type, _ method: T.StaticVerify, file
     T.verify(method, count: .moreOrEqual(to: 1), file: file, line: line)
 }
 
-/// Verify that given static property getter or setter was called on mock object **at least once**.
-///
-/// - Parameters:
-///   - object: Mock type
-///   - property: Property name, get or set with wrapped newValue (`Parameter`)
-///   - file: for XCTest print purposes
-///   - line: for XCTest print purposes
-@available(*, deprecated, message: "Use Verify instead!")
-public func VerifyProperty<T: StaticMock>(_ object: T.Type, _ property: T.StaticVerify, file: StaticString = #file, line: UInt = #line) {
-    T.verify(property, count: .moreOrEqual(to: 1), file: file, line: line)
-}
-
 // MARK: - Instance member called with explicit count
 
 /// Verify that given method was called on mock object **exact number of times**.
@@ -64,19 +40,6 @@ public func Verify<T: Mock>(_ object: T, _ count: Count, _ method: T.Verify, fil
     object.verify(method, count: count, file: file, line: line)
 }
 
-/// Verify that given property get / set was called on mock object **exact number of times**.
-///
-/// - Parameters:
-///   - object: Mock instance
-///   - count: Number of invocations
-///   - method: Property name, get or set with wrapped newValue (`Parameter`)
-///   - file: for XCTest print purposes
-///   - line: for XCTest print purposes
-@available(*, deprecated, message: "Use Verify instead!")
-public func VerifyProperty<T: Mock>(_ object: T, _ count: Count, _ property: T.Verify, file: StaticString = #file, line: UInt = #line) {
-    object.verify(property, count: count, file: file, line: line)
-}
-
 // MARK: - Static member called with explicit count
 
 /// Verify that given static method was called on mock type **exact number of times**.
@@ -91,19 +54,6 @@ public func Verify<T: StaticMock>(_ type: T.Type, _ count: Count, _ method: T.St
     T.verify(method, count: count, file: file, line: line)
 }
 
-/// Verify that given static property get / set was called on mock type **exact number of times**.
-///
-/// - Parameters:
-///   - object: Mock type
-///   - count: Number of invocations
-///   - method: Static property name, get or set with wrapped newValue (`Parameter`)
-///   - file: for XCTest print purposes
-///   - line: for XCTest print purposes
-@available(*, deprecated, message: "Use Verify instead!")
-public func VerifyProperty<T: StaticMock>(_ type: T.Type, _ count: Count, _ property: T.StaticVerify, file: StaticString = #file, line: UInt = #line) {
-    T.verify(property, count: count, file: file, line: line)
-}
-
 // MARK: - Given
 
 /// Setup return value for method stubs in mock instance. When this method will be called on mock, it

Sources/SwiftyMocky/Count.swift

@@ -50,6 +50,7 @@ public enum Count: ExpressibleByIntegerLiteral {
 }
 
 // MARK: - CustomStringConvertible
+
 extension Count: CustomStringConvertible {
     /// Human readable description
     public var description: String {
@@ -79,6 +80,7 @@ extension Count: CustomStringConvertible {
 }
 
 // MARK: - Countable
+
 extension Count: Countable {
 
     /// Returns whether given count matches countable case.

Sources/SwiftyMocky/Mock+Assertions.swift

@@ -13,18 +13,6 @@ public func Verify<T: Mock>(_ object: T, _ method: T.Verify, file: StaticString
     object.verify(method, count: .moreOrEqual(to: 1), file: file, line: line)
 }
 
-/// Verify that given property getter or setter was called on mock object **at least once**.
-///
-/// - Parameters:
-///   - object: Mock instance
-///   - property: Property name, get or set with wrapped newValue (`Parameter`)
-///   - file: for XCTest print purposes
-///   - line: for XCTest print purposes
-@available(*, deprecated, message: "Use Verify instead!")
-public func VerifyProperty<T: Mock>(_ object: T, _ property: T.Verify, file: StaticString = #file, line: UInt = #line) {
-    object.verify(property, count: .moreOrEqual(to: 1), file: file, line: line)
-}
-
 // MARK: - At least once static member called
 
 /// Verify that given static method was called on mock type **at least once**.
@@ -38,18 +26,6 @@ public func Verify<T: StaticMock>(_ type: T.Type, _ method: T.StaticVerify, file
     T.verify(method, count: .moreOrEqual(to: 1), file: file, line: line)
 }
 
-/// Verify that given static property getter or setter was called on mock object **at least once**.
-///
-/// - Parameters:
-///   - object: Mock type
-///   - property: Property name, get or set with wrapped newValue (`Parameter`)
-///   - file: for XCTest print purposes
-///   - line: for XCTest print purposes
-@available(*, deprecated, message: "Use Verify instead!")
-public func VerifyProperty<T: StaticMock>(_ object: T.Type, _ property: T.StaticVerify, file: StaticString = #file, line: UInt = #line) {
-    T.verify(property, count: .moreOrEqual(to: 1), file: file, line: line)
-}
-
 // MARK: - Instance member called with explicit count
 
 /// Verify that given method was called on mock object **exact number of times**.
@@ -64,19 +40,6 @@ public func Verify<T: Mock>(_ object: T, _ count: Count, _ method: T.Verify, fil
     object.verify(method, count: count, file: file, line: line)
 }
 
-/// Verify that given property get / set was called on mock object **exact number of times**.
-///
-/// - Parameters:
-///   - object: Mock instance
-///   - count: Number of invocations
-///   - method: Property name, get or set with wrapped newValue (`Parameter`)
-///   - file: for XCTest print purposes
-///   - line: for XCTest print purposes
-@available(*, deprecated, message: "Use Verify instead!")
-public func VerifyProperty<T: Mock>(_ object: T, _ count: Count, _ property: T.Verify, file: StaticString = #file, line: UInt = #line) {
-    object.verify(property, count: count, file: file, line: line)
-}
-
 // MARK: - Static member called with explicit count
 
 /// Verify that given static method was called on mock type **exact number of times**.
@@ -91,19 +54,6 @@ public func Verify<T: StaticMock>(_ type: T.Type, _ count: Count, _ method: T.St
     T.verify(method, count: count, file: file, line: line)
 }
 
-/// Verify that given static property get / set was called on mock type **exact number of times**.
-///
-/// - Parameters:
-///   - object: Mock type
-///   - count: Number of invocations
-///   - method: Static property name, get or set with wrapped newValue (`Parameter`)
-///   - file: for XCTest print purposes
-///   - line: for XCTest print purposes
-@available(*, deprecated, message: "Use Verify instead!")
-public func VerifyProperty<T: StaticMock>(_ type: T.Type, _ count: Count, _ property: T.StaticVerify, file: StaticString = #file, line: UInt = #line) {
-    T.verify(property, count: count, file: file, line: line)
-}
-
 // MARK: - Given
 
 /// Setup return value for method stubs in mock instance. When this method will be called on mock, it

Sources/SwiftyPrototype/Count.swift

@@ -50,6 +50,7 @@ public enum Count: ExpressibleByIntegerLiteral {
 }
 
 // MARK: - CustomStringConvertible
+
 extension Count: CustomStringConvertible {
     /// Human readable description
     public var description: String {
@@ -79,6 +80,7 @@ extension Count: CustomStringConvertible {
 }
 
 // MARK: - Countable
+
 extension Count: Countable {
 
     /// Returns whether given count matches countable case.

Sources/SwiftyPrototype/Mock+Assertions.swift

@@ -13,18 +13,6 @@ public func Verify<T: Mock>(_ object: T, _ method: T.Verify, file: StaticString
     object.verify(method, count: .moreOrEqual(to: 1), file: file, line: line)
 }
 
-/// Verify that given property getter or setter was called on mock object **at least once**.
-///
-/// - Parameters:
-///   - object: Mock instance
-///   - property: Property name, get or set with wrapped newValue (`Parameter`)
-///   - file: for XCTest print purposes
-///   - line: for XCTest print purposes
-@available(*, deprecated, message: "Use Verify instead!")
-public func VerifyProperty<T: Mock>(_ object: T, _ property: T.Verify, file: StaticString = #file, line: UInt = #line) {
-    object.verify(property, count: .moreOrEqual(to: 1), file: file, line: line)
-}
-
 // MARK: - At least once static member called
 
 /// Verify that given static method was called on mock type **at least once**.
@@ -38,18 +26,6 @@ public func Verify<T: StaticMock>(_ type: T.Type, _ method: T.StaticVerify, file
     T.verify(method, count: .moreOrEqual(to: 1), file: file, line: line)
 }
 
-/// Verify that given static property getter or setter was called on mock object **at least once**.
-///
-/// - Parameters:
-///   - object: Mock type
-///   - property: Property name, get or set with wrapped newValue (`Parameter`)
-///   - file: for XCTest print purposes
-///   - line: for XCTest print purposes
-@available(*, deprecated, message: "Use Verify instead!")
-public func VerifyProperty<T: StaticMock>(_ object: T.Type, _ property: T.StaticVerify, file: StaticString = #file, line: UInt = #line) {
-    T.verify(property, count: .moreOrEqual(to: 1), file: file, line: line)
-}
-
 // MARK: - Instance member called with explicit count
 
 /// Verify that given method was called on mock object **exact number of times**.
@@ -64,19 +40,6 @@ public func Verify<T: Mock>(_ object: T, _ count: Count, _ method: T.Verify, fil
     object.verify(method, count: count, file: file, line: line)
 }
 
-/// Verify that given property get / set was called on mock object **exact number of times**.
-///
-/// - Parameters:
-///   - object: Mock instance
-///   - count: Number of invocations
-///   - method: Property name, get or set with wrapped newValue (`Parameter`)
-///   - file: for XCTest print purposes
-///   - line: for XCTest print purposes
-@available(*, deprecated, message: "Use Verify instead!")
-public func VerifyProperty<T: Mock>(_ object: T, _ count: Count, _ property: T.Verify, file: StaticString = #file, line: UInt = #line) {
-    object.verify(property, count: count, file: file, line: line)
-}
-
 // MARK: - Static member called with explicit count
 
 /// Verify that given static method was called on mock type **exact number of times**.
@@ -91,19 +54,6 @@ public func Verify<T: StaticMock>(_ type: T.Type, _ count: Count, _ method: T.St
     T.verify(method, count: count, file: file, line: line)
 }
 
-/// Verify that given static property get / set was called on mock type **exact number of times**.
-///
-/// - Parameters:
-///   - object: Mock type
-///   - count: Number of invocations
-///   - method: Static property name, get or set with wrapped newValue (`Parameter`)
-///   - file: for XCTest print purposes
-///   - line: for XCTest print purposes
-@available(*, deprecated, message: "Use Verify instead!")
-public func VerifyProperty<T: StaticMock>(_ type: T.Type, _ count: Count, _ property: T.StaticVerify, file: StaticString = #file, line: UInt = #line) {
-    T.verify(property, count: count, file: file, line: line)
-}
-
 // MARK: - Given
 
 /// Setup return value for method stubs in mock instance. When this method will be called on mock, it