Feature request: better toString() outputs showing expected value

[frstie]

When verifying parameters, the various matchers report the value they were expecting, but not the value they received. This sometimes makes it tricky to figure out what went wrong when the test fails.

Simple example:

interface Emailer {
  send(email: string): void
}

describe("Notifier", () => {
  it("sends correct email", () => {
    let notifier = (emailer: Emailer) => {
      emailer.send("[email protected]")
    }

    let emailer = mock<Emailer>()

    notifier(instance(emailer))

    verify(emailer.send("[email protected]")).once()
  })
})

This results in an error message:

1) Notifier
       sends correct email:
     Error: Expected "send(strictEqual([email protected]))" to be called 1 time(s). But has been called 0 time(s).

I've put together a quick custom matcher that improves toString() to report the value received as well as the requested match:

class StringMatcher extends Matcher {
  private received: string = ""

  constructor(private expected: string) {
    super()
  }

  public match(value: any): boolean {
    this.received = value
    return this.expected === value
  }

  public toString(): string {
    return `string(expected: ${this.expected}, got: ${this.received})`
  }
}

export function stringMatcher(expected: string): any {
  return new StringMatcher(expected) as any
}

The new call to verify:

verify(emailer.send(stringMatcher("[email protected]"))).once()

and the new output:

1) Notifier
       sends correct email:
     Error: Expected "send(string(expected: [email protected], got: [email protected]))" to be called 1 time(s). But has been called 0 time(s).

I'm a new user to the library, wondered if there would be any interest in making the default toString() on the existing matchers support something like this? Happy to contribute a PR if this would be of use to anyone?

[frstie]

Ah, I've just spotted #216 - guess this is handled more elegantly with that PR.

Just found the thread about the various forks - is there any consensus on future directions/merging for the different forks?

[mikeporterdev]

@frstie this feature is now released under the TypeStrong repo https://github.com/TypeStrong/ts-mockito
Another PR for making it handle objects nicely is in progress