New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Yet another introduction of Protocol extension-based matchers #480

Closed

mosamer wants to merge 5 commits into Quick:master from mosamer:protocol

mosamer commented Nov 9, 2017 •

edited

Loading

This PR is another attempt for #217, which is much less ambitious compared to #218

This PR introduces protocol extension-based matchers for Expectation. It only provides an infrastructure for the technique and would allow users to write their own custom matchers using it. Nimble matchers can be gradually migrated on later pull requests.

It allows the following code;

class NimblePlaygroundTests: XCTestCase {
    
    func testExample() {
        expect(1).to.equal(1)
        expect(1).notTo.equal(2)
        expect(1).toNot.equal(2)
        expect(1).toEventually.equal(1)
        expect(1).toNotEventually.equal(2)
        expect(1).toNotEventually.equal(2)
    }
}

extension ExtensibleExpecation where Type: Equatable {
    func equal(_ expectedValue: Type) {
        match {
            Predicate {actualExpression in
                let actualValue = try actualExpression.evaluate()
                return PredicateResult(
                    bool: actualValue == expectedValue,
                    message: .expectedCustomValueTo(
                        "equal \(stringify(expectedValue))",
                        stringify(actualValue)))
            }
        }
    }
}

Future Work:

Add test cases
Update readme
Migrate Nimble matchers to protocol extensions
Migrate Predicate helpers to ExtensibleExpectation
Better name for ExtensibleExpectation ¯_(ツ)_/¯

mosamer added 4 commits

November 9, 2017 20:51


          initial introduction of ExtensibleExpectation

55dec46


          introduce notTo expectation extension

887c717


          introduce async expectation extension

dc54238


          support non-default timeout & poll interval for async expectation ext…

0eb44d8

…ensions

houndci-bot reviewed

View reviewed changes

Sources/Nimble/ExtinsibleExpecation.swift Outdated

+                  /// Expectation extension to test the actual value using a matcher to not match by checking continously at pollInterval until the timeout is reached.
+                  public func toEventuallyNot(timeout: TimeInterval, pollInterval: TimeInterval) -> ExtensibleExpecation<T> {
+                      return ExtensibleExpecation(base: self, style: .toNotMatch, isAsync: true, timeout: timeout, pollInterval: pollInterval)

houndci-bot Nov 9, 2017

Line Length Violation: Line should be 120 characters or less: currently 128 characters (line_length)

Sources/Nimble/ExtinsibleExpecation.swift Outdated

+                  /// Expectation extension to test the actual value using a matcher to match by checking continously at pollInterval until the timeout is reached.
+                  public func toEventually(timeout: TimeInterval, pollInterval: TimeInterval) -> ExtensibleExpecation<T> {
+                      return ExtensibleExpecation(base: self, style: .toMatch, isAsync: true, timeout: timeout, pollInterval: pollInterval)

houndci-bot Nov 9, 2017

Line Length Violation: Line should be 120 characters or less: currently 125 characters (line_length)

Sources/Nimble/ExtinsibleExpecation.swift Outdated

+                  public func match(description: String? = nil, _ predicateFactory: @escaping () -> Predicate<T>) {
+                      if isAsync {
+                          nimblePrecondition(base.expression.isClosure, "NimbleInternalError", toEventuallyRequiresClosureError.stringValue)

houndci-bot Nov 9, 2017

Line Length Violation: Line should be 120 characters or less: currently 126 characters (line_length)

Sources/Nimble/ExtinsibleExpecation.swift Outdated

+                  }
+              }
+              //MARK: Async Expectation Extensions

houndci-bot Nov 9, 2017

Mark Violation: MARK comment should be in valid format. e.g. '// MARK: ...' or '// MARK: - ...' (mark)

Sources/Nimble/ExtinsibleExpecation.swift Outdated

+                  }
+              }
+              //MARK: Expectation extensions

houndci-bot Nov 9, 2017

Mark Violation: MARK comment should be in valid format. e.g. '// MARK: ...' or '// MARK: - ...' (mark)

Sources/Nimble/ExtinsibleExpecation.swift Outdated

+                  public var to: ExtensibleExpecation<T> {
+                      return ExtensibleExpecation(base: self, style: .toMatch)
+                  }

houndci-bot Nov 9, 2017

Trailing Whitespace Violation: Lines should not have trailing whitespace. (trailing_whitespace)

Sources/Nimble/ExtinsibleExpecation.swift Outdated

+                                timeout: timeout,
+                                poll: pollInterval,
+                                fnName: style == .toMatch ? "toEventually" : "toEventuallyNot")

houndci-bot Nov 9, 2017

Trailing Whitespace Violation: Lines should not have trailing whitespace. (trailing_whitespace)

Sources/Nimble/ExtinsibleExpecation.swift Outdated

+                      if isAsync {
+                          nimblePrecondition(base.expression.isClosure, "NimbleInternalError", toEventuallyRequiresClosureError.stringValue)
+                      }

houndci-bot Nov 9, 2017

Trailing Whitespace Violation: Lines should not have trailing whitespace. (trailing_whitespace)

Sources/Nimble/ExtinsibleExpecation.swift Outdated

+                      self.timeout = timeout
+                      self.pollInterval = pollInterval
+                  }

houndci-bot Nov 9, 2017

Trailing Whitespace Violation: Lines should not have trailing whitespace. (trailing_whitespace)

Sources/Nimble/ExtinsibleExpecation.swift Outdated

+                      ) {
+                      self.base = base
+                      self.style = style

houndci-bot Nov 9, 2017

Trailing Whitespace Violation: Lines should not have trailing whitespace. (trailing_whitespace)


          fix lint issues

80d0682

Author

mosamer commented Jan 20, 2018

@jeffh any chance this could be reviewed anytime soon?

Member

jeffh commented Feb 12, 2018

I haven’t had much free time to do any development for awhile (computer and apt issues).

Is there a reason to introduce a new extensible matched type over extending predicate (or even expectation)?

Also, could you please add tests, thanks!

ikesyo linked an issue

that may be closed by this pull request

Protocol Extension Discoverability #217

Closed

Member

ikesyo commented Oct 8, 2020

Closing as this is stale.

ikesyo closed this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet