Resolver::decodePage() - Code Metrics - Inspection of "Adds cache layer" - journeygroup/vssl-render - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 1f5e72...7f5bc2 )

by Justin

created 2017-03-16 19:58 UTC

Resolver::decodePage() A

↳ Parent: Resolver

Complexity

Conditions	3
Paths	3

Size

Total Lines	9
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	3.0416

Importance

Changes

Metric	Value
dl	0
loc	9
ccs	5
cts	6
cp	0.8333
rs	9.6666
c	0
b	0
f	0
cc	3
eloc	6
nc	3
nop	1
crap	3.0416

<?php

namespace Vssl\Render;

use GuzzleHttp\Client;
use Journey\Cache\Adapters\LocalAdapter;
use Journey\Cache\CacheAdapterInterface;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;

class Resolver
{
    /**
     * The request object.
     *
     * @var \Psr\Http\Message\ServerRequestInterface
     */
    protected $request;

    /**
     * Configuration array.
     *
     * @var array
     */
    protected $config;

    /**
     * The page api object.
     *
     * @var \Vssl\Render\PageApi
     */
    protected $api;

    /**
     * Initialize a new Resolver
     */
    public function __construct(ServerRequestInterface $request, $config = false)
    {
        $this->request = $request;
        $this->config = is_array($config) ? static::config($config) : static::config();
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        if (!$this->config['cache'] instanceof CacheAdapterInterface) {
            throw new ResolverException('Cache must implement \Journey\Cache\CacheAdapterInterface.');
        }
        $this->api = new PageApi($request, $this->config);
    }

    /**
     * Get a modified request message.
     *
     * @return \Psr\Http\Message\ServerRequestInterface
     */
    public function getRequest()
    {
        return $this->request->withAttribute('vssl-page', $this->resolve());
    }

    /**
     * Get an instance of the PageApi class.
     *
     * @return \Vssl\Render\PageApi
     */
    public function getPageApi()
    {
        return $this->api;
    }

    /**
     * Resolve the current page from WebStories. Returns a render able page or
     * false.
     *
     * @return array
     */
    public function resolve()
    {
        $response = $this->api->getPage($this->request->getUri()->getPath());
        if ($response && ($page = $this->decodePage($response))) {
            $status = $response->getStatusCode();
            return [
                'status' => $status,
                'data' => $page,
                'page' => (is_array($page) && $status == 200) ? new Renderer($this->config, $page) : $page,
                'metadata' => (is_array($page) && $status == 200) ? new Metadata($this->config, $page) : $page,
                'type' => !empty($page['type']) ? $page['type'] : false
            ];
        }
        return [
            'status' => false,
            'error' => 'An unknown error occurred',
            'data' => [],
            'type' => false
        ];
    }

    /**
     * Decode the body of a particular request.
     *
     * @return mixed
     */
    public function decodePage(ResponseInterface $response)
    {
        $body = (string) $response->getBody();
        if ($response->getHeaderLine('Content-Type') == "application/json") {
            $page = json_decode($body, true);
            return !empty($page['exists']) ? $page['page'] : false;
        }
        return false;
    }

    /**
     * Configure the resolver.
     *
     * @return void
     */
    public static function config($assign = false)
    {
        static $config;

        if (is_array($assign) || !$config) {
            $config = array_merge([
                'cache' => null,
                'cache_ttl' => false,
                'base_uri' => 'https://pages.vssl.io/',
                'required_fields' => [
                    'id',
                    'title',
                    'stripes'
                ],
                // 'templates' => 'your-directory'

            ], $assign);
        }
        return $config ?: [];
    }
}


1		<?php
2
3		namespace Vssl\Render;
4
5		use GuzzleHttp\Client;
6		use Journey\Cache\Adapters\LocalAdapter;
7		use Journey\Cache\CacheAdapterInterface;
8		use Psr\Http\Message\ResponseInterface;
9		use Psr\Http\Message\ServerRequestInterface;
10
11		class Resolver
12		{
13		/**
14		* The request object.
15		*
16		* @var \Psr\Http\Message\ServerRequestInterface
17		*/
18		protected $request;
19
20		/**
21		* Configuration array.
22		*
23		* @var array
24		*/
25		protected $config;
26
27		/**
28		* The page api object.
29		*
30		* @var \Vssl\Render\PageApi
31		*/
32		protected $api;
33
34		/**
35		* Initialize a new Resolver
36		*/
37	7	public function __construct(ServerRequestInterface $request, $config = false)
38		{
39	7	$this->request = $request;
40	7	$this->config = is_array($config) ? static::config($config) : static::config();
		0 ignored issues – show Documentation introduced 2017-02-10 04:34 UTC by Report Bug Copy Issue Report `$config` is of type `array`, but the function expects a `boolean`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
41	7	if (!$this->config['cache'] instanceof CacheAdapterInterface) {
42		throw new ResolverException('Cache must implement \Journey\Cache\CacheAdapterInterface.');
43		}
44	7	$this->api = new PageApi($request, $this->config);
45	7	}
46
47		/**
48		* Get a modified request message.
49		*
50		* @return \Psr\Http\Message\ServerRequestInterface
51		*/
52	4	public function getRequest()
53		{
54	4	return $this->request->withAttribute('vssl-page', $this->resolve());
55		}
56
57		/**
58		* Get an instance of the PageApi class.
59		*
60		* @return \Vssl\Render\PageApi
61		*/
62	3	public function getPageApi()
63		{
64	3	return $this->api;
65		}
66
67		/**
68		* Resolve the current page from WebStories. Returns a render able page or
69		* false.
70		*
71		* @return array
72		*/
73	4	public function resolve()
74		{
75	4	$response = $this->api->getPage($this->request->getUri()->getPath());
76	4	if ($response && ($page = $this->decodePage($response))) {
77	3	$status = $response->getStatusCode();
78		return [
79	3	'status' => $status,
80	3	'data' => $page,
81	3	'page' => (is_array($page) && $status == 200) ? new Renderer($this->config, $page) : $page,
82	3	'metadata' => (is_array($page) && $status == 200) ? new Metadata($this->config, $page) : $page,
83	3	'type' => !empty($page['type']) ? $page['type'] : false
84	3	];
85		}
86		return [
87	1	'status' => false,
88	1	'error' => 'An unknown error occurred',
89	1	'data' => [],
90		'type' => false
91	1	];
92		}
93
94		/**
95		* Decode the body of a particular request.
96		*
97		* @return mixed
98		*/
99	3	public function decodePage(ResponseInterface $response)
100		{
101	3	$body = (string) $response->getBody();
102	3	if ($response->getHeaderLine('Content-Type') == "application/json") {
103	3	$page = json_decode($body, true);
104	3	return !empty($page['exists']) ? $page['page'] : false;
105		}
106		return false;
107		}
108
109		/**
110		* Configure the resolver.
111		*
112		* @return void
113		*/
114	19	public static function config($assign = false)
115		{
116	19	static $config;
117
118	19	if (is_array($assign) \|\| !$config) {
119	13	$config = array_merge([
120	13	'cache' => null,
121	13	'cache_ttl' => false,
122	13	'base_uri' => 'https://pages.vssl.io/',
123		'required_fields' => [
124	13	'id',
125	13	'title',
126		'stripes'
127	13	],
128		// 'templates' => 'your-directory'
		0 ignored issues – show Unused Code Comprehensibility introduced 2017-02-10 04:34 UTC by Report Bug Copy Issue Report `50%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
129	13	], $assign);
130	13	}
131	19	return $config ?: [];
132		}
133		}
134

journeygroup / vssl-render

Push — master ( 1f5e72...7f5bc2 )

Resolver::decodePage() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like