Page::toArray() - Code Metrics - Inspection of "add missing unittests" - Astrotomic/stancy - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 1a4395...30513c )

by Tom

created 2019-10-04 14:07 UTC

Page::toArray() A

↳ Parent: Page

Complexity

Conditions	2
Paths	2

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	2

Importance

Changes

Metric	Value
eloc	1
dl	0
loc	3
ccs	2
cts	2
cp	1
rs	10
c	0
b	0
f	0
cc	2
nc	2
nop	0
crap	2

<?php

namespace Astrotomic\Stancy\Models;

use Astrotomic\Stancy\Contracts\Page as PageContract;
use Exception;
use Illuminate\Contracts\View\Factory as ViewFactoryContract;
use Illuminate\Contracts\View\View;
use Illuminate\Support\Arr;
use RuntimeException;
use Spatie\Feed\FeedItem;
use Spatie\Sheets\Facades\Sheets;
use Spatie\Sheets\Sheet;
use Spatie\Sitemap\Tags\Tag;
use Symfony\Component\HttpFoundation\Response;

class Page implements PageContract
{
    /** @var string|null */
    protected $view;

    /** @var string|null */
    protected $page;

    /** @var PageData|array */

    protected $data = [];

    /** @var ViewFactoryContract */
    protected $viewFactory;

    public function __construct(ViewFactoryContract $viewFactory, array $data = [], ?string $page = null)

    {
        $this->viewFactory = $viewFactory;

        $this->view($data['_view'] ?? null);

        $page = $page ?? $data['_pageData'] ?? null;

        $data = array_merge($data, $this->getSheetData($data['_sheets'] ?? []));

        $this->data($data);
        $this->page($page);
    }

    public function page(?string $page): PageContract
    {
        if (is_string($page)) {
            if (! is_subclass_of($page, PageData::class, true)) {
                throw new Exception(sprintf('The page data class [%s] has to extend %s.', $page, PageData::class));
            }
        }

        $this->page = $page;

        $this->parse();

        return $this;
    }

    public function data(array $data): PageContract

    {
        $this->data = $this->prepareData($data);

        $this->parse();

        return $this;
    }

    public function view(?string $view): PageContract
    {
        $this->view = $view;

        return $this;
    }

    public function render(): View
    {
        if (empty($this->view)) {
            throw new Exception('You have to define a view before the page can render.');
        }

        return $this->viewFactory->make($this->view, $this->data);
    }

    public function toHtml(): string
    {
        return $this->render()->render();

    }

    public function toArray(): array

    {
        return is_array($this->data) ? $this->data : $this->data->toArray();
    }

    public function jsonSerialize(): array

    {
        return $this->toArray();
    }

    /** {@inheritdoc} */
    public function toJson($options = 0): string
    {
        return json_encode($this->jsonSerialize(), $options);
    }

    /** {@inheritdoc} */
    public function toResponse($request): Response
    {
        if ($request->wantsJson()) {
            return response()->json($this->jsonSerialize());
        }

        return response($this->render());
    }

    public function toFeedItem(): FeedItem
    {
        if (! ($this->data instanceof PageData)) {
            throw new Exception(sprintf('The page data has to extend %s to allow transformation to %s.', PageData::class, FeedItem::class));
        }

        return $this->data->toFeedItem();
    }

    public function toSitemapItem(): Tag
    {
        if (! ($this->data instanceof PageData)) {
            throw new Exception(sprintf('The page data has to extend %s to allow transformation to %s.', PageData::class, Tag::class));
        }

        return $this->data->toSitemapItem();
    }

    protected function parse(): void
    {
        if ($this->page === null) {
            return;
        }

        $this->data = forward_static_call(
            [$this->page, 'make'],
            $this->toArray()
        );
    }

    protected function getSheetData(array $sheets): array

    {
        if (empty($sheets)) {
            return [];
        }

        if (! Arr::isAssoc($sheets)) {
            throw new RuntimeException('The [_sheets] data has to be an associative array.');
        }

        $data = [];

        foreach ($sheets as $key => $sheet) {
            [$collection, $path] = explode(':', $sheet);

            if ($path === '*') {
                $data[$key] = Sheets::collection($collection)->all()->map(function (Sheet $sheet) {
                    return $this->prepareData($sheet->toArray());
                })->all();

                continue;
            }

            $data[$key] = $this->prepareData(Sheets::collection($collection)->get($path)->toArray());
        }

        return $data;
    }

    protected function prepareData(array $data): array

    {
        unset($data['_view'], $data['_pageData'], $data['_sheets']);

        return $data;
    }
}


1		<?php
2
3		namespace Astrotomic\Stancy\Models;
4
5		use Astrotomic\Stancy\Contracts\Page as PageContract;
6		use Exception;
7		use Illuminate\Contracts\View\Factory as ViewFactoryContract;
8		use Illuminate\Contracts\View\View;
9		use Illuminate\Support\Arr;
10		use RuntimeException;
11		use Spatie\Feed\FeedItem;
12		use Spatie\Sheets\Facades\Sheets;
13		use Spatie\Sheets\Sheet;
14		use Spatie\Sitemap\Tags\Tag;
15		use Symfony\Component\HttpFoundation\Response;
16
17		class Page implements PageContract
18		{
19		/** @var string\|null */
20		protected $view;
21
22		/** @var string\|null */
23		protected $page;
24
25		/** @var PageData\|array */
		0 ignored issues – show introduced 2019-09-24 13:19 UTC by Report Bug Copy Issue Report @var annotation of property \Astrotomic\Stancy\Models\Page::$data does not specify type hint for its items. Loading history...
26		protected $data = [];
27
28		/** @var ViewFactoryContract */
29		protected $viewFactory;
30
31	21	public function __construct(ViewFactoryContract $viewFactory, array $data = [], ?string $page = null)
		0 ignored issues – show introduced 2019-09-24 13:19 UTC by Report Bug Copy Issue Report Method \Astrotomic\Stancy\Models\Page::__construct() does not have @param annotation for its traversable parameter $data. Loading history...
32		{
33	21	$this->viewFactory = $viewFactory;
34
35	21	$this->view($data['_view'] ?? null);
36
37	21	$page = $page ?? $data['_pageData'] ?? null;
38
39	21	$data = array_merge($data, $this->getSheetData($data['_sheets'] ?? []));
40
41	20	$this->data($data);
42	20	$this->page($page);
43	17	}
44
45	20	public function page(?string $page): PageContract
46		{
47	20	if (is_string($page)) {
48	13	if (! is_subclass_of($page, PageData::class, true)) {
49	2	throw new Exception(sprintf('The page data class [%s] has to extend %s.', $page, PageData::class));
50		}
51		}
52
53	18	$this->page = $page;
54
55	18	$this->parse();
56
57	17	return $this;
58		}
59
60	20	public function data(array $data): PageContract
		0 ignored issues – show introduced 2019-09-24 13:19 UTC by Report Bug Copy Issue Report Method \Astrotomic\Stancy\Models\Page::data() does not have @param annotation for its traversable parameter $data. Loading history...
61		{
62	20	$this->data = $this->prepareData($data);
63
64	20	$this->parse();
65
66	20	return $this;
67		}
68
69	21	public function view(?string $view): PageContract
70		{
71	21	$this->view = $view;
72
73	21	return $this;
74		}
75
76	4	public function render(): View
77		{
78	4	if (empty($this->view)) {
79	1	throw new Exception('You have to define a view before the page can render.');
80		}
81
82	3	return $this->viewFactory->make($this->view, $this->data);
83		}
84
85	3	public function toHtml(): string
86		{
87	3	return $this->render()->render();
		0 ignored issues – show Bug Best Practice introduced 2019-09-24 13:19 UTC by Report Bug Copy Issue Report The expression `return $this->render()->render()` could return the type `array` which is incompatible with the type-hinted return `string`. Consider adding an additional type-check to rule them out. Loading history...
88		}
89
90	11	public function toArray(): array
		0 ignored issues – show introduced 2019-09-25 10:20 UTC by Report Bug Copy Issue Report Method \Astrotomic\Stancy\Models\Page::toArray() does not have @return annotation for its traversable return value. Loading history...
91		{
92	11	return is_array($this->data) ? $this->data : $this->data->toArray();
93		}
94
95	2	public function jsonSerialize(): array
		0 ignored issues – show introduced 2019-09-25 10:20 UTC by Report Bug Copy Issue Report Method \Astrotomic\Stancy\Models\Page::jsonSerialize() does not have @return annotation for its traversable return value. Loading history...
96		{
97	2	return $this->toArray();
98		}
99
100		/** {@inheritdoc} */
101	1	public function toJson($options = 0): string
102		{
103	1	return json_encode($this->jsonSerialize(), $options);
104		}
105
106		/** {@inheritdoc} */
107	4	public function toResponse($request): Response
108		{
109	4	if ($request->wantsJson()) {
110	1	return response()->json($this->jsonSerialize());
111		}
112
113	3	return response($this->render());
114		}
115
116	3	public function toFeedItem(): FeedItem
117		{
118	3	if (! ($this->data instanceof PageData)) {
119	1	throw new Exception(sprintf('The page data has to extend %s to allow transformation to %s.', PageData::class, FeedItem::class));
120		}
121
122	2	return $this->data->toFeedItem();
123		}
124
125	2	public function toSitemapItem(): Tag
126		{
127	2	if (! ($this->data instanceof PageData)) {
128	1	throw new Exception(sprintf('The page data has to extend %s to allow transformation to %s.', PageData::class, Tag::class));
129		}
130
131	1	return $this->data->toSitemapItem();
132		}
133
134	20	protected function parse(): void
135		{
136	20	if ($this->page === null) {
137	20	return;
138		}
139
140	11	$this->data = forward_static_call(
141	11	[$this->page, 'make'],
142	11	$this->toArray()
143		);
144	9	}
145
146	21	protected function getSheetData(array $sheets): array
		0 ignored issues – show introduced 2019-10-01 13:56 UTC by Report Bug Copy Issue Report Method \Astrotomic\Stancy\Models\Page::getSheetData() does not have @param annotation for its traversable parameter $sheets. Loading history... introduced 2019-10-01 13:56 UTC by Report Bug Copy Issue Report Method \Astrotomic\Stancy\Models\Page::getSheetData() does not have @return annotation for its traversable return value. Loading history...
147		{
148	21	if (empty($sheets)) {
149	19	return [];
150		}
151
152	2	if (! Arr::isAssoc($sheets)) {
153	1	throw new RuntimeException('The [_sheets] data has to be an associative array.');
154		}
155
156	1	$data = [];
157
158	1	foreach ($sheets as $key => $sheet) {
159	1	[$collection, $path] = explode(':', $sheet);
160
161	1	if ($path === '*') {
162		$data[$key] = Sheets::collection($collection)->all()->map(function (Sheet $sheet) {
163	1	return $this->prepareData($sheet->toArray());
164	1	})->all();
165
166	1	continue;
167		}
168
169	1	$data[$key] = $this->prepareData(Sheets::collection($collection)->get($path)->toArray());
170		}
171
172	1	return $data;
173		}
174
175	20	protected function prepareData(array $data): array
		0 ignored issues – show introduced 2019-10-01 13:56 UTC by Report Bug Copy Issue Report Method \Astrotomic\Stancy\Models\Page::prepareData() does not have @param annotation for its traversable parameter $data. Loading history... introduced 2019-10-01 13:56 UTC by Report Bug Copy Issue Report Method \Astrotomic\Stancy\Models\Page::prepareData() does not have @return annotation for its traversable return value. Loading history...
176		{
177	20	unset($data['_view'], $data['_pageData'], $data['_sheets']);
178
179	20	return $data;
180		}
181		}
182

Astrotomic / stancy

Push — master ( 1a4395...30513c )

Page::toArray() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like