Add convenience ::expectFilterRemoved() ::expectActionRemoved() Fix #157

[BrianHenryIE]

Summary

As said in #157:

WP_Mock provides useful helpers for expectFilterAdded and expectFilterNotAdded, and [their] companion actions. However, we have no canonical way of checking remove_action nor remove_filter calls.

See: remove_filter().

Closes: #157

Details

It's really just a convenience function on top of WP_Mock::userFunction().

public static function expectFilterRemoved(string $filter, $callback, $priority = null) : void
{
    self::userFunction(
        'remove_filter'
        array(
            'args'   => array_filter(func_get_args()),
            'times'  => 1,
        )
    );
}

We're using array_filter() there to handle the optional use of $priority in remove_filter().

::expectFilterNotRemoved() is the same with 'times' => 0.

Contributor checklist

• I agree to follow this project's Code of Conduct.
• I have updated the documentation accordingly
• I have added tests to cover changes introduced by this pull request
• All new and existing tests pass

Testing

Reviewer checklist

• Code changes review
• Documentation changes review
• Unit tests pass
• Static analysis passes

[coveralls]

coverage: 64.889% (-1.6%) from 66.445%
when pulling 6701778 on BrianHenryIE:add/remove-action-remove-filter
into 48b7f22 on 10up:trunk.

[coveralls]

coverage: 67.522% (+1.1%) from 66.445%
when pulling 7d01fcb on BrianHenryIE:add/remove-action-remove-filter
into 48b7f22 on 10up:trunk.

[coveralls]

coverage: 67.651% (+1.2%) from 66.445%
when pulling cd4cff5 on BrianHenryIE:add/remove-action-remove-filter
into 48b7f22 on 10up:trunk.

[coveralls]

coverage: 67.651% (+1.2%) from 66.445%
when pulling f56c557 on BrianHenryIE:add/remove-action-remove-filter
into 48b7f22 on 10up:trunk.

[coveralls]

coverage: 67.651% (+1.3%) from 66.312%
when pulling 32b8898 on BrianHenryIE:add/remove-action-remove-filter
into 010d556 on 10up:trunk.

[nmolham-godaddy]

Thanks @BrianHenryIE for this nice PR, I have a couple of suggestions below, which I added for one method, but apply for all of the other new methods as well.

[nmolham-godaddy]

How about returning the expectation once set? incase it was needed to for later. As well as adding nullable-int data type for the $priority argument

Suggested change

	* @return void
	* @throws InvalidArgumentException
	*/
	public static function expectActionRemoved(string $action, $callback, $priority = null) : void
	* @return Mockery\Expectation
	* @throws InvalidArgumentException
	*/
	public static function expectActionRemoved(string $action, $callback, ?int $priority = null) : Mockery\Expectation

[nmolham-godaddy]

For better performance, it would be ideal to be more implicit about the aguments instead of reaching for the func_get_args, that way the interpreter won't have to do much assumption work with the data types.

Also, we are trying to move away from the classic array syntax towards.

Suggested change

	self::userFunction(
	'remove_action',
	array(
	'args' => array_filter(func_get_args()),
	'times' => 1,
	)
	);
	$args = [$action, $callback];
	if ($priority) {
	$args[] = $priority;
	}
	return self::userFunction('remove_action', [
	'args' => $args,
	'times' => 1,
	]);