Skip to content

Commit

Permalink
Equal predicate for array of tuples
Browse files Browse the repository at this point in the history
Added ability to check an array of tuples for equivalence (useful for MOCs generated by Sourcery)
  • Loading branch information
roman-falchuk authored and faroman committed Jul 15, 2023
1 parent 831000d commit ff76587
Show file tree
Hide file tree
Showing 3 changed files with 371 additions and 0 deletions.
10 changes: 10 additions & 0 deletions Nimble.xcodeproj/project.pbxproj
Original file line number Diff line number Diff line change
Expand Up @@ -455,6 +455,10 @@
B20058C520E92CE400C1264D /* ElementsEqualTest.swift in Sources */ = {isa = PBXBuildFile; fileRef = B20058C420E92CE400C1264D /* ElementsEqualTest.swift */; };
B20058C620E92CE400C1264D /* ElementsEqualTest.swift in Sources */ = {isa = PBXBuildFile; fileRef = B20058C420E92CE400C1264D /* ElementsEqualTest.swift */; };
B20058C720E92CE400C1264D /* ElementsEqualTest.swift in Sources */ = {isa = PBXBuildFile; fileRef = B20058C420E92CE400C1264D /* ElementsEqualTest.swift */; };
C576224D2A61D3AE00BD6A8C /* Equal+TupleArray.swift in Sources */ = {isa = PBXBuildFile; fileRef = C576224C2A61D3AE00BD6A8C /* Equal+TupleArray.swift */; };
C576224E2A61D3AE00BD6A8C /* Equal+TupleArray.swift in Sources */ = {isa = PBXBuildFile; fileRef = C576224C2A61D3AE00BD6A8C /* Equal+TupleArray.swift */; };
C576224F2A61D3AE00BD6A8C /* Equal+TupleArray.swift in Sources */ = {isa = PBXBuildFile; fileRef = C576224C2A61D3AE00BD6A8C /* Equal+TupleArray.swift */; };
C57622502A61D3AE00BD6A8C /* Equal+TupleArray.swift in Sources */ = {isa = PBXBuildFile; fileRef = C576224C2A61D3AE00BD6A8C /* Equal+TupleArray.swift */; };
CD3D9A79232647BC00802581 /* CwlCatchBadInstructionPosix.swift in Sources */ = {isa = PBXBuildFile; fileRef = CD3D9A78232647BC00802581 /* CwlCatchBadInstructionPosix.swift */; };
CD79C99E1D2CC832004B6F9A /* ObjCAsyncTest.m in Sources */ = {isa = PBXBuildFile; fileRef = 1F4A56651A3B305F009E1637 /* ObjCAsyncTest.m */; };
CD79C99F1D2CC835004B6F9A /* ObjCSyncTest.m in Sources */ = {isa = PBXBuildFile; fileRef = 1F8A37AF1B7C5042001C8357 /* ObjCSyncTest.m */; };
Expand Down Expand Up @@ -811,6 +815,7 @@
AE7ADE481C80C00D00B94CD3 /* MatchErrorTest.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = MatchErrorTest.swift; sourceTree = "<group>"; };
B20058C020E92C7500C1264D /* ElementsEqual.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ElementsEqual.swift; sourceTree = "<group>"; };
B20058C420E92CE400C1264D /* ElementsEqualTest.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ElementsEqualTest.swift; sourceTree = "<group>"; };
C576224C2A61D3AE00BD6A8C /* Equal+TupleArray.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = "Equal+TupleArray.swift"; sourceTree = "<group>"; };
CD3D9A78232647BC00802581 /* CwlCatchBadInstructionPosix.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = CwlCatchBadInstructionPosix.swift; sourceTree = "<group>"; };
CDBC39B82462EA7D00069677 /* PredicateTest.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PredicateTest.swift; sourceTree = "<group>"; };
CDC157902511957100EAA480 /* DSLTest.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = DSLTest.swift; sourceTree = "<group>"; };
Expand Down Expand Up @@ -1101,6 +1106,7 @@
1FD8CD1B1968AB07008ED995 /* EndWith.swift */,
1FD8CD1C1968AB07008ED995 /* Equal.swift */,
CDF5C57A2647B89B0036532C /* Equal+Tuple.swift */,
C576224C2A61D3AE00BD6A8C /* Equal+TupleArray.swift */,
472FD1341B9E085700C7B8DA /* HaveCount.swift */,
DDB4D5EC19FE43C200E9D9FE /* Match.swift */,
1FD8CD1D1968AB07008ED995 /* MatcherProtocols.swift */,
Expand Down Expand Up @@ -1670,6 +1676,7 @@
F8A1BE2F1CB3710900031679 /* XCTestObservationCenter+Register.m in Sources */,
1F1871C61CA89EDB00A34BF2 /* DSL.m in Sources */,
89F5E092290B9D5C001F9377 /* AssertionRecorder+Async.swift in Sources */,
C576224E2A61D3AE00BD6A8C /* Equal+TupleArray.swift in Sources */,
1FD8CD301968AB07008ED995 /* AdapterProtocols.swift in Sources */,
AE7ADE451C80BF8000B94CD3 /* MatchError.swift in Sources */,
1FC494AA1C29CBA40010975C /* NimbleEnvironment.swift in Sources */,
Expand Down Expand Up @@ -1815,6 +1822,7 @@
1F5DF1761BDCA0F500C3A531 /* AllPass.swift in Sources */,
AE4BA9AF1C88DDB500B73906 /* Errors.swift in Sources */,
1F5DF1861BDCA0F500C3A531 /* HaveCount.swift in Sources */,
C576224F2A61D3AE00BD6A8C /* Equal+TupleArray.swift in Sources */,
1F5DF1811BDCA0F500C3A531 /* BeLogical.swift in Sources */,
1F1871DB1CA89EF100A34BF2 /* NMBExpectation.swift in Sources */,
CDFB6A4F1F7E084600AD8CC7 /* CwlMachBadInstructionHandler.m in Sources */,
Expand Down Expand Up @@ -1991,6 +1999,7 @@
F8A1BE301CB3710900031679 /* XCTestObservationCenter+Register.m in Sources */,
1FD8CD311968AB07008ED995 /* AdapterProtocols.swift in Sources */,
89F5E091290B9D5C001F9377 /* AssertionRecorder+Async.swift in Sources */,
C576224D2A61D3AE00BD6A8C /* Equal+TupleArray.swift in Sources */,
1F1871D21CA89EEE00A34BF2 /* DSL.m in Sources */,
AE7ADE461C80BF8000B94CD3 /* MatchError.swift in Sources */,
1FC494AB1C29CBA40010975C /* NimbleEnvironment.swift in Sources */,
Expand Down Expand Up @@ -2136,6 +2145,7 @@
D95F897E267EA20A004B1B4D /* BeWithin.swift in Sources */,
D95F8928267EA1CA004B1B4D /* NMBExceptionCapture.m in Sources */,
D95F8981267EA20A004B1B4D /* BeginWith.swift in Sources */,
C57622502A61D3AE00BD6A8C /* Equal+TupleArray.swift in Sources */,
D95F8965267EA20A004B1B4D /* BeLogical.swift in Sources */,
D95F895D267EA205004B1B4D /* Expectation.swift in Sources */,
D95F8959267EA205004B1B4D /* NMBExpectation.swift in Sources */,
Expand Down
204 changes: 204 additions & 0 deletions Sources/Nimble/Matchers/Equal+TupleArray.swift
Original file line number Diff line number Diff line change
@@ -0,0 +1,204 @@
// swiftlint:disable large_tuple vertical_whitespace

// MARK: Tuple2 Array

/// A Nimble matcher that succeeds when the actual array of tuples is equal to the expected array of tuples.
/// Values can support equal by supporting the Equatable protocol.
public func equal<T1: Equatable, T2: Equatable>(
_ expectedValue: [(T1, T2)]?
) -> Predicate<[(T1, T2)]> {
equalTupleArray(expectedValue, by: ==)
}

public func ==<T1: Equatable, T2: Equatable>(
lhs: SyncExpectation<[(T1, T2)]>,
rhs: [(T1, T2)]?
) {
lhs.to(equal(rhs))
}

public func ==<T1: Equatable, T2: Equatable>(
lhs: AsyncExpectation<[(T1, T2)]>,
rhs: [(T1, T2)]?
) async {
await lhs.to(equal(rhs))
}

public func !=<T1: Equatable, T2: Equatable>(
lhs: SyncExpectation<[(T1, T2)]>,
rhs: [(T1, T2)]?
) {
lhs.toNot(equal(rhs))
}

public func !=<T1: Equatable, T2: Equatable>(
lhs: AsyncExpectation<[(T1, T2)]>,
rhs: [(T1, T2)]?
) async {
await lhs.toNot(equal(rhs))
}

// MARK: Tuple3 Array

/// A Nimble matcher that succeeds when the actual array of tuples is equal to the expected array of tuples.
/// Values can support equal by supporting the Equatable protocol.
public func equal<T1: Equatable, T2: Equatable, T3: Equatable>(
_ expectedValue: [(T1, T2, T3)]?
) -> Predicate<[(T1, T2, T3)]> {
equalTupleArray(expectedValue, by: ==)
}

public func ==<T1: Equatable, T2: Equatable, T3: Equatable>(
lhs: SyncExpectation<[(T1, T2, T3)]>,
rhs: [(T1, T2, T3)]?
) {
lhs.to(equal(rhs))
}

public func ==<T1: Equatable, T2: Equatable, T3: Equatable>(
lhs: AsyncExpectation<[(T1, T2, T3)]>,
rhs: [(T1, T2, T3)]?
) async {
await lhs.to(equal(rhs))
}

public func !=<T1: Equatable, T2: Equatable, T3: Equatable>(
lhs: SyncExpectation<[(T1, T2, T3)]>,
rhs: [(T1, T2, T3)]?
) {
lhs.toNot(equal(rhs))
}

public func !=<T1: Equatable, T2: Equatable, T3: Equatable>(
lhs: AsyncExpectation<[(T1, T2, T3)]>,
rhs: [(T1, T2, T3)]?
) async {
await lhs.toNot(equal(rhs))
}

// MARK: Tuple4 Array

/// A Nimble matcher that succeeds when the actual array of tuples is equal to the expected array of tuples.
/// Values can support equal by supporting the Equatable protocol.
public func equal<T1: Equatable, T2: Equatable, T3: Equatable, T4: Equatable>(
_ expectedValue: [(T1, T2, T3, T4)]?
) -> Predicate<[(T1, T2, T3, T4)]> {
equalTupleArray(expectedValue, by: ==)
}

public func ==<T1: Equatable, T2: Equatable, T3: Equatable, T4: Equatable>(
lhs: SyncExpectation<[(T1, T2, T3, T4)]>,
rhs: [(T1, T2, T3, T4)]?
) {
lhs.to(equal(rhs))
}

public func ==<T1: Equatable, T2: Equatable, T3: Equatable, T4: Equatable>(
lhs: AsyncExpectation<[(T1, T2, T3, T4)]>,
rhs: [(T1, T2, T3, T4)]?
) async {
await lhs.to(equal(rhs))
}

public func !=<T1: Equatable, T2: Equatable, T3: Equatable, T4: Equatable>(
lhs: SyncExpectation<[(T1, T2, T3, T4)]>,
rhs: [(T1, T2, T3, T4)]?
) {
lhs.toNot(equal(rhs))
}

public func !=<T1: Equatable, T2: Equatable, T3: Equatable, T4: Equatable>(
lhs: AsyncExpectation<[(T1, T2, T3, T4)]>,
rhs: [(T1, T2, T3, T4)]?
) async {
await lhs.toNot(equal(rhs))
}

// MARK: Tuple5 Array

/// A Nimble matcher that succeeds when the actual array of tuples is equal to the expected array of tuples.
/// Values can support equal by supporting the Equatable protocol.
public func equal<T1: Equatable, T2: Equatable, T3: Equatable, T4: Equatable, T5: Equatable>(
_ expectedValue: [(T1, T2, T3, T4, T5)]?
) -> Predicate<[(T1, T2, T3, T4, T5)]> {
equalTupleArray(expectedValue, by: ==)
}

public func ==<T1: Equatable, T2: Equatable, T3: Equatable, T4: Equatable, T5: Equatable>(
lhs: SyncExpectation<[(T1, T2, T3, T4, T5)]>,
rhs: [(T1, T2, T3, T4, T5)]?
) {
lhs.to(equal(rhs))
}

public func ==<T1: Equatable, T2: Equatable, T3: Equatable, T4: Equatable, T5: Equatable>(
lhs: AsyncExpectation<[(T1, T2, T3, T4, T5)]>,
rhs: [(T1, T2, T3, T4, T5)]?
) async {
await lhs.to(equal(rhs))
}

public func !=<T1: Equatable, T2: Equatable, T3: Equatable, T4: Equatable, T5: Equatable>(
lhs: SyncExpectation<[(T1, T2, T3, T4, T5)]>,
rhs: [(T1, T2, T3, T4, T5)]?
) {
lhs.toNot(equal(rhs))
}

public func !=<T1: Equatable, T2: Equatable, T3: Equatable, T4: Equatable, T5: Equatable>(
lhs: AsyncExpectation<[(T1, T2, T3, T4, T5)]>,
rhs: [(T1, T2, T3, T4, T5)]?
) async {
await lhs.toNot(equal(rhs))
}

// MARK: Tuple6 Array

/// A Nimble matcher that succeeds when the actual array of tuples is equal to the expected array of tuples.
/// Values can support equal by supporting the Equatable protocol.
public func equal<T1: Equatable, T2: Equatable, T3: Equatable, T4: Equatable, T5: Equatable, T6: Equatable>(
_ expectedValue: [(T1, T2, T3, T4, T5, T6)]?
) -> Predicate<[(T1, T2, T3, T4, T5, T6)]> {
equalTupleArray(expectedValue, by: ==)
}

public func ==<T1: Equatable, T2: Equatable, T3: Equatable, T4: Equatable, T5: Equatable, T6: Equatable>(
lhs: SyncExpectation<[(T1, T2, T3, T4, T5, T6)]>,
rhs: [(T1, T2, T3, T4, T5, T6)]?
) {
lhs.to(equal(rhs))
}

public func ==<T1: Equatable, T2: Equatable, T3: Equatable, T4: Equatable, T5: Equatable, T6: Equatable>(
lhs: AsyncExpectation<[(T1, T2, T3, T4, T5, T6)]>,
rhs: [(T1, T2, T3, T4, T5, T6)]?
) async {
await lhs.to(equal(rhs))
}

public func !=<T1: Equatable, T2: Equatable, T3: Equatable, T4: Equatable, T5: Equatable, T6: Equatable>(
lhs: SyncExpectation<[(T1, T2, T3, T4, T5, T6)]>,
rhs: [(T1, T2, T3, T4, T5, T6)]?
) {
lhs.toNot(equal(rhs))
}

public func !=<T1: Equatable, T2: Equatable, T3: Equatable, T4: Equatable, T5: Equatable, T6: Equatable>(
lhs: AsyncExpectation<[(T1, T2, T3, T4, T5, T6)]>,
rhs: [(T1, T2, T3, T4, T5, T6)]?
) async {
await lhs.toNot(equal(rhs))
}

// swiftlint:enable large_tuple vertical_whitespace

// MARK: Implementation Helpers

private func equalTupleArray<Tuple>(
_ expectedValue: [(Tuple)]?,
by areTuplesEquivalent: @escaping (Tuple, Tuple) -> Bool
) -> Predicate<[Tuple]> {
equal(expectedValue) {
$0.elementsEqual($1, by: areTuplesEquivalent)
}
}
Loading

0 comments on commit ff76587

Please sign in to comment.