Gabrieljmj\Should\Assert\AbstractAssert

Complexity

Total Complexity

8

Size/Duplication

Total Lines	68
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	setMessage()	0	4	1
A	getMessage()	0	4	1
A	getFailMessage()	0	4	2
A	classToStr()	0	4	2
A	validateClass()	0	8	2
	createFailMessage()	0	1	?

<?php
/**
 * ShouldPHP
 *
 * @author  Gabriel Jacinto <gamjj74@hotmail.com>
 * @status  dev
 * @link    https://github.com/GabrielJMJ/ShouldPHP
 * @license MIT
 */
 
namespace Gabrieljmj\Should\Assert;

use Gabrieljmj\Should\Assert\AssertInterface;
use Gabrieljmj\Should\Exception\ShouldException;

abstract class AbstractAssert implements AssertInterface
{
    /**
     * Custom message in case of fail
     *
     * @var string
     */
    protected $message;
    
    /**
     * Sets the custom message
     *
     * @param string $message
     */
    public function setMessage($message)
    {
        $this->message = $message;
    }
    
    /**
     * Returns a custom message in case of fail
     *
     * @return string
     */
    public function getMessage()
    {
        return $this->message;
    }

    /**
     * Returns teh fail description
     * Null case in case of success
     *
     * @return string|null
     */
    public function getFailMessage()
    {
        return $this->execute() ? null : $this->createFailMessage();
    }

    /**
     * @param object|string $class
     * @return string
     */
    protected function classToStr($class)
    {
        return is_object($class) ? get_class($class) : $class;
    }

    /**
     * @param string|object $class
     */
    protected function validateClass($class)
    {
        $class = $this->classToStr($class);

        if (!class_exists($class)) {
            ShouldException::classDoesNotExist($class);
        }
    }

    /**
     * Creates the fail message
     *
     * @return string
     */
    abstract protected function createFailMessage();
}