VGirol\JsonApiFaker\Factory\ErrorFactory

Complexity

Total Complexity

18

Size/Duplication

Total Lines	199
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	2
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
C	toArray()	0	29	9
A	fake()	0	10	1
A	fakeDetails()	0	5	1
A	fakeSource()	0	7	1
A	setSource()	0	5	1
A	fakeStatus()	0	12	1
A	fakeTitle()	0	5	1
A	fakeCode()	0	5	1
A	set()	0	9	2

<?php

declare(strict_types=1);

namespace VGirol\JsonApiFaker\Factory;

use VGirol\JsonApiConstant\Members;
use VGirol\JsonApiFaker\Contract\ErrorContract;
use VGirol\JsonApiFaker\Exception\JsonApiFakerException;
use VGirol\JsonApiFaker\Messages;

/**
 * A factory for error object
 */
class ErrorFactory extends BaseFactory implements ErrorContract
{
    use HasIdentifier;
    use HasLinks;
    use HasMeta;

    /**
     * The "status" member
     *
     * @var string
     */
    public $status;

    /**
     * The "code" member
     *
     * @var string
     */
    public $code;

    /**
     * The "title" member
     *
     * @var string
     */
    public $title;

    /**
     * The "details" member
     *
     * @var string
     */
    public $details;

    /**
     * The "source" member
     *
     * @var array
     */
    public $source;

    /**
     * Set one of the following member : status, code, title, details
     *
     * @param string $key
     * @param string $value
     *
     * @return static
     * @throws JsonApiFakerException
     */
    public function set(string $key, string $value)
    {
        if (!property_exists($this, $key)) {
            throw new JsonApiFakerException(sprintf(Messages::ERROR_OBJECT_INEXISTANT_KEY, $key));
        }

        $this->{$key} = $value;

        return $this;
    }

    /**
     * Set the "source" member
     *
     * @param array $source
     *
     * @return static
     */
    public function setSource(array $source)
    {
        $this->source = $source;

        return $this;
    }

    /**
     * @return array
     */
    public function toArray(): array
    {
        $resource = [];
        if (isset($this->id)) {
            $resource[Members::ID] = $this->id;
        }
        if (isset($this->links)) {
            $resource[Members::LINKS] = $this->links;
        }
        if (isset($this->status)) {
            $resource[Members::ERROR_STATUS] = $this->status;
        }
        if (isset($this->code)) {
            $resource[Members::ERROR_CODE] = $this->code;
        }
        if (isset($this->title)) {
            $resource[Members::ERROR_TITLE] = $this->title;
        }
        if (isset($this->details)) {
            $resource[Members::ERROR_DETAILS] = $this->details;
        }
        if (isset($this->source)) {
            $resource[Members::ERROR_SOURCE] = $this->source;
        }
        if (isset($this->meta)) {
            $resource[Members::META] = $this->meta;
        }

        return $resource;
    }

    /**
     * Fill the error object with fake values
     * ("id", "links", "meta", "status", "code", "title", "details" and "source").
     *
     * @return static
     * @throws JsonApiFakerException
     */
    public function fake()
    {
        return $this->fakeIdentifier()
            ->fakeLinks([Members::LINK_ABOUT => ['url']])
            ->fakeMeta()
            ->fakeStatus()
            ->fakeCode()
            ->fakeTitle()
            ->fakeDetails()
            ->fakeSource();
    }

    /**
     * Fill the "status" member with fake value
     *
     * @return static
     * @throws JsonApiFakerException
     */
    private function fakeStatus()
    {
        $allowedStatus = [
            '200', '201', '202', '203', '204', '205', '206', '207', '208', '226',
            '300', '301', '302', '303', '304', '305', '307', '308',
            '400', '401', '402', '403', '404', '405', '406', '407', '408', '409',
            '410', '411', '412', '413', '414', '415', '416', '417', '422', '423', '424', '426', '428', '429', '431',
            '500', '501', '502', '503', '504', '505', '506', '507', '508', '510', '511'
        ];
        $faker = \Faker\Factory::create();

        return $this->set(Members::ERROR_STATUS, strval($faker->randomElement($allowedStatus)));
    }

    /**
     * Fill the "code" member with fake value
     *
     * @return static
     * @throws JsonApiFakerException
     */
    private function fakeCode()
    {
        $faker = \Faker\Factory::create();

        return $this->set(Members::ERROR_CODE, strval($faker->numberBetween(1, 100)));
    }

    /**
     * Fill the "title" member with fake value
     *
     * @return static
     * @throws JsonApiFakerException
     */
    private function fakeTitle()
    {
        $faker = \Faker\Factory::create();

        return $this->set(Members::ERROR_TITLE, $faker->sentence);
    }

    /**
     * Fill the "details" member with fake value
     *
     * @return static
     * @throws JsonApiFakerException
     */
    private function fakeDetails()
    {
        $faker = \Faker\Factory::create();

        return $this->set(Members::ERROR_DETAILS, $faker->paragraph);
    }

    /**
     * Fill the "source" member with fake value
     *
     * @return static
     */
    private function fakeSource()
    {
        $faker = \Faker\Factory::create();

        return $this->setSource(
            [
                Members::ERROR_PARAMETER => $faker->word
            ]
        );
    }
}