Gabrieljmj\Should\Report\Report

Complexity

Total Complexity

14

Size/Duplication

Total Lines	147
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	getName()	0	4	1
A	addAssert()	0	6	2
A	getTotal()	0	4	1
A	getSuccessTotal()	0	4	1
A	getFailTotal()	0	4	1
A	getAssertList()	0	4	1
A	serialize()	0	26	5
A	unserialize()	0	4	1

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

class Report
{
    /**
     * Name of the tested ambient
     *
     * @var string
     */
    private $name;

    /**
     * Total of assertions executed
     *
     * @var integer
     */
    private $total = 0;

    /**
     * Total of successful assertions
     *
     * @var integer
     */
    private $successTotal = 0;

    /**
     * Total of unsuccessful assertions
     *
     * @var integer
     */
    private $failTotal = 0;

    /**
     * Executed assertions details
     *
     * @var array
     */
    private $assertList = [];

    public function __construct($name)
    {
        $this->name = $name;
    }

    /**
     * Returns the name of the tested ambient
     *
     * @return string
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * Adds an assert to assert list
     *
     * @param \Gabrieljmj\Should\Report\AssertReport $report
     */
    public function addAssert(AssertReport $report)
    {
        $this->total++;
        $report->getStatus() === 'success' ? $this->successTotal++ : $this->failTotal++;
        $this->assertList[$report->getType()][$report->getStatus()][$report->getTestedElement()][] = $report;
    }

    /**
     * Returns the total of assertions executed
     *
     * @return integer
     */
    public function getTotal()
    {
        return $this->total;
    }

    /**
     * Returns the total of successful assertions
     *
     * @return integer
     */
    public function getSuccessTotal()
    {
        return $this->successTotal;
    }

    /**
     * Return the total of unsuccessful assertions
     *
     * @return integer
     */
    public function getFailTotal()
    {
        return $this->failTotal;
    }

    /**
     * Returns the executed assertions
     * Each array element is an instance of \Gabrieljmj\Should\Report\ReportAssertion
     *
     * @return array
     */
    public function getAssertList()
    {
        return $this->assertList;
    }

    /**
     * Serializes the report
     *
     * @return string
     */
    public function serialize()
    {
        $report = [
            'total' => $this->getTotal(),
            'success_total' => $this->getSuccessTotal(),
            'fail_total' => $this->getFailTotal(),
            'elements' => []
        ];

        foreach ($this->getAssertList() as $typeName => $type) {
            foreach ($type as $status => $elements) {
                foreach ($elements as $elementName => $element) {
                    foreach ($element as $assert) {
                        $report['elements'][$typeName][$elementName][$status][] = [
                            'name' => $assert->getName(),
                            'description' => $assert->getDescription(),
                            'fail_message' => $assert->getFailMessage(),
                            'message' => $assert->getMessage()
                        ];
                    }
                }
            }
        }

        return serialize($report);
    }

    /**
     * Unserializes a string of a report
     *
     * @param string $str
     */
    public function unserialize($str)

The parameter $str is not used and could be removed.

    {
        return ;
    }
}