Peridot\Leo\Matcher\SubStringMatcher

Complexity

Total Complexity

3

Size/Duplication

Total Lines	30
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes	1
Bugs	0	Features	1

2 Methods

Rating	Name	Duplication	Size	Complexity
A	doMatch()	0	8	2
A	getDefaultTemplate()	0	7	1

<?php

namespace Peridot\Leo\Matcher;

use Peridot\Leo\Matcher\Template\ArrayTemplate;
use Peridot\Leo\Matcher\Template\TemplateInterface;

/**
 * SubStringMatcher determines if an actual string contains the expected sub string.
 *
 * @package Peridot\Leo\Matcher
 */
class SubStringMatcher extends AbstractMatcher
{
    /**
     * Match that actual value has the expected sub string.
     *
     * @param  string $actual
     * @return mixed
     */
    protected function doMatch($actual)
    {
        if (!is_string($actual)) {
            throw new \InvalidArgumentException('SubStringMatcher requires string value');
        }

        return strpos($actual, $this->expected) !== false;
    }

    /**
     * {@inheritdoc}
     *
     * @return TemplateInterface
     */
    public function getDefaultTemplate()
    {
        return new ArrayTemplate([
            'default' => 'Expected {{actual}} to contain {{expected}}',
            'negated' => 'Expected {{actual}} to not contain {{expected}}',
        ]);
    }
}