JsonLD::sanitizeJsonSource() - Code Metrics - Inspection of "Merge pull request #41 from rvanlaak/patch-1" - jkphl/micrometa - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 6a41ca...195821 )

by Joschi

created 2019-11-01 17:48 UTC

JsonLD::sanitizeJsonSource() A

↳ Parent: JsonLD

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	2.032

Importance

Changes

Metric	Value
dl	0
loc	10
ccs	4
cts	5
cp	0.8
rs	9.9332
c	0
b	0
f	0
cc	2
nc	2
nop	1
crap	2.032

<?php

/**
 * micrometa
 *
 * @category   Jkphl
 * @package    Jkphl\Micrometa
 * @subpackage Jkphl\Micrometa\Infrastructure\Parser
 * @author     Joschi Kuphal <[email protected]> / @jkphl
 * @copyright  Copyright © 2018 Joschi Kuphal <[email protected]> / @jkphl
 * @license    http://opensource.org/licenses/MIT The MIT License (MIT)
 */

/***********************************************************************************
 *  The MIT License (MIT)
 *
 *  Copyright © 2018 Joschi Kuphal <[email protected]> / @jkphl
 *
 *  Permission is hereby granted, free of charge, to any person obtaining a copy of
 *  this software and associated documentation files (the "Software"), to deal in
 *  the Software without restriction, including without limitation the rights to
 *  use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 *  the Software, and to permit persons to whom the Software is furnished to do so,
 *  subject to the following conditions:
 *
 *  The above copyright notice and this permission notice shall be included in all
 *  copies or substantial portions of the Software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 *  FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 *  COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 *  IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 *  CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 ***********************************************************************************/

namespace Jkphl\Micrometa\Infrastructure\Parser;

use Jkphl\Micrometa\Application\Contract\ParsingResultInterface;
use Jkphl\Micrometa\Infrastructure\Parser\JsonLD\CachingContextLoader;
use Jkphl\Micrometa\Infrastructure\Parser\JsonLD\VocabularyCache;
use Jkphl\Micrometa\Ports\Format;
use ML\JsonLD\Exception\JsonLdException;
use ML\JsonLD\JsonLD as JsonLDParser;
use ML\JsonLD\LanguageTaggedString;
use ML\JsonLD\Node;
use ML\JsonLD\NodeInterface;
use ML\JsonLD\TypedValue;
use Psr\Http\Message\UriInterface;
use Psr\Log\LoggerInterface;

/**
 * JsonLD parser
 *
 * @package    Jkphl\Micrometa
 * @subpackage Jkphl\Micrometa\Infrastructure
 * @see        https://jsonld-examples.com/
 * @see        http://www.dr-chuck.com/csev-blog/2016/04/json-ld-performance-sucks-for-api-specs/
 */
class JsonLD extends AbstractParser
{
    /**
     * Format
     *
     * @var int
     */
    const FORMAT = Format::JSON_LD;
    /**
     * Regex pattern for matching leading comments in a JSON string
     *
     * @var string
     */
    const JSON_COMMENT_PATTERN = '#(/\*([^*]|[\r\n]|(\*+([^*/]|[\r\n])))*\*+/)|([\s\t]//.*)|(^//.*)#';
    /**
     * Vocabulary cache
     *
     * @var VocabularyCache
     */
    protected $vocabularyCache;
    /**
     * Context loader
     *
     * @var CachingContextLoader
     */
    protected $contextLoader;

    /**
     * JSON-LD parser constructor
     *
     * @param UriInterface $uri       Base URI
     * @param LoggerInterface $logger Logger
     */
    public function __construct(UriInterface $uri, LoggerInterface $logger)
    {
        parent::__construct($uri, $logger);
        $this->vocabularyCache = new VocabularyCache();
        $this->contextLoader   = new CachingContextLoader($this->vocabularyCache);
    }

    /**
     * Parse a DOM document
     *
     * @param \DOMDocument $dom DOM Document
     *
     * @return ParsingResultInterface Micro information items
     * @throws \ReflectionException
     */
    public function parseDom(\DOMDocument $dom)
    {
        $this->logger->info('Running parser: '.(new \ReflectionClass(__CLASS__))->getShortName());
        $items = [];

        // Find and process all JSON-LD documents
        $xpath      = new \DOMXPath($dom);
        $jsonLDDocs = $xpath->query('//*[local-name(.) = "script"][@type = "application/ld+json"]');
        $this->logger->debug('Processing '.$jsonLDDocs->length.' JSON-LD documents');

        // Run through all JSON-LD documents
        foreach ($jsonLDDocs as $jsonLDDoc) {
            $jsonLDDocSource = preg_replace(self::JSON_COMMENT_PATTERN, '', $jsonLDDoc->textContent);
            $i               = $this->parseDocument($jsonLDDocSource);
            $items           = array_merge($items, $i);
        }

        return new ParsingResult(self::FORMAT, $items);
    }

    /**
     * Parse a JSON-LD document
     *
     * @param string $jsonLDDocSource JSON-LD document
     *
     * @return array Items
     */
    protected function parseDocument($jsonLDDocSource)
    {
        $jsonLDDocSource = $this->sanitizeJsonSource($jsonLDDocSource);

        // Unserialize the JSON-LD document
        $jsonLDDoc = @json_decode($jsonLDDocSource);

        // If this is not a valid JSON document: Return
        if (!is_object($jsonLDDoc) && !is_array($jsonLDDoc)) {
            $this->logger->error('Skipping invalid JSON-LD document');

            return [];
        }

        // Parse the document
        return array_filter(
            is_array($jsonLDDoc) ?
                array_map([$this, 'parseRootNode'], $jsonLDDoc) : [$this->parseRootNode($jsonLDDoc)]
        );
    }

    /**
     * Parse a JSON-LD root node
     *
     * @param \stdClass $jsonLDRoot JSON-LD root node
     */
    protected function parseRootNode($jsonLDRoot)
    {
        $item = null;

        try {
            $jsonDLDocument = JsonLDParser::getDocument($jsonLDRoot, ['documentLoader' => $this->contextLoader]);

            // Run through all nodes to parse the first one
            /** @var Node $node */
            foreach ($jsonDLDocument->getGraph()->getNodes() as $node) {
                $item = $this->parseNode($node);
                break;
            }
        } catch (JsonLdException $exception) {
            $this->logger->error($exception->getMessage(), ['exception' => $exception]);
        }

        return $item;
    }

    /**
     * Parse a JSON-LD node
     *
     * @param NodeInterface $node Node
     *
     * @return \stdClass Item
     */
    protected function parseNode(NodeInterface $node)
    {
        return (object)[
            'type'       => $this->parseNodeType($node),
            'id'         => $node->getId() ?: null,
            'properties' => $this->parseNodeProperties($node),
        ];
    }

    /**
     * Parse the type of a JSON-LD node
     *
     * @param NodeInterface $node Node
     *
     * @return array Item type
     */
    protected function parseNodeType(NodeInterface $node)
    {
        /** @var Node $itemType */
        return ($itemType = $node->getType()) ? [$this->vocabularyCache->expandIRI($itemType->getId())] : [];
    }

    /**
     * Parse the properties of a JSON-LD node
     *
     * @param NodeInterface $node Node
     *
     * @return array Item properties
     */
    protected function parseNodeProperties(NodeInterface $node)
    {
        $properties = [];

        // Run through all node properties
        foreach ($node->getProperties() as $name => $property) {
            // Skip the node type
            if ($name === Node::TYPE) {
                continue;
            }

            // Initialize the property (if necessary)
            $this->initializeNodeProperty($name, $properties);

            // Parse and process the property value
            $this->processNodeProperty($name, $this->parse($property), $properties);
        }

        return $properties;
    }

    /**
     * Initialize a JSON-LD node property (if necessary)
     *
     * @param string $name      Property name
     * @param array $properties Item properties
     */
    protected function initializeNodeProperty($name, array &$properties)
    {
        if (empty($properties[$name])) {
            $properties[$name]         = $this->vocabularyCache->expandIRI($name);
            $properties[$name]->values = [];
        }
    }

    /**
     * Process a property value
     *
     * @param string $name                  Property name
     * @param \stdClass|array|string $value Property value
     * @param array $properties             Item properties
     */
    protected function processNodeProperty($name, $value, array &$properties)
    {
        // If this is a nested item
        if (is_object($value)) {
            $this->processNodePropertyObject($name, $value, $properties);

            // Else: If this is a value list
        } elseif (is_array($value)) {
            foreach ($value as $listValue) {
                $this->processNodeProperty($name, $listValue, $properties);
            }

            // Else: If the value is not empty
        } elseif ($value) {
            $properties[$name]->values[] = $value;
        }
    }

    /**
     * Process a property value object
     *
     * @param string $name      Property name
     * @param \stdClass $value  Property value
     * @param array $properties Properties
     */
    protected function processNodePropertyObject($name, $value, array &$properties)
    {
        if (!empty($value->type) || !empty($value->lang)) {
            $properties[$name]->values[] = $value;

            // @type = @id
        } elseif (!empty($value->id)) {
            $properties[$name]->values[] = $value->id;
        }
    }

    /**
     * Parse a JSON-LD fragment
     *
     * @param NodeInterface|LanguageTaggedString|TypedValue|array $jsonLD JSON-LD fragment
     *
     * @return \stdClass|string|array Parsed fragment
     */
    protected function parse($jsonLD)
    {
        // If it's a node object
        if ($jsonLD instanceof NodeInterface) {
            return $this->parseNode($jsonLD);

            // Else if it's a language tagged string
        } elseif ($jsonLD instanceof LanguageTaggedString) {
            return $this->parseLanguageTaggedString($jsonLD);

            // Else if it's a typed value
        } elseif ($jsonLD instanceof TypedValue) {
            return $this->parseTypedValue($jsonLD);
        }

        // Else if it's a list of items
        return array_map([$this, 'parse'], $jsonLD);
    }

    /**
     * Parse a language tagged string
     *
     * @param LanguageTaggedString $value Language tagged string
     *
     * @return \stdClass Value
     */
    protected function parseLanguageTaggedString(LanguageTaggedString $value)
    {
        return (object)['value' => $value->getValue(), 'lang' => $value->getLanguage()];
    }

    /**
     * Parse a typed value
     *
     * @param TypedValue $value Typed value
     *
     * @return string Value
     */
    protected function parseTypedValue(TypedValue $value)
    {
        return $value->getValue();
    }

    private function sanitizeJsonSource($jsonLDDocSource)
    {
        $jsonLDDocSource = trim($jsonLDDocSource);

        if (substr($jsonLDDocSource, -1) === ';') {
            $jsonLDDocSource = substr_replace($jsonLDDocSource, '', -1);
        }

        return $jsonLDDocSource;
    }
}


1		<?php
2
3		/**
4		* micrometa
5		*
6		* @category Jkphl
7		* @package Jkphl\Micrometa
8		* @subpackage Jkphl\Micrometa\Infrastructure\Parser
9		* @author Joschi Kuphal <[email protected]> / @jkphl
10		* @copyright Copyright © 2018 Joschi Kuphal <[email protected]> / @jkphl
11		* @license http://opensource.org/licenses/MIT The MIT License (MIT)
12		*/
13
14		/***********************************************************************************
15		* The MIT License (MIT)
16		*
17		* Copyright © 2018 Joschi Kuphal <[email protected]> / @jkphl
18		*
19		* Permission is hereby granted, free of charge, to any person obtaining a copy of
20		* this software and associated documentation files (the "Software"), to deal in
21		* the Software without restriction, including without limitation the rights to
22		* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
23		* the Software, and to permit persons to whom the Software is furnished to do so,
24		* subject to the following conditions:
25		*
26		* The above copyright notice and this permission notice shall be included in all
27		* copies or substantial portions of the Software.
28		*
29		* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
30		* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
31		* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
32		* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
33		* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
34		* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
35		***********************************************************************************/
36
37		namespace Jkphl\Micrometa\Infrastructure\Parser;
38
39		use Jkphl\Micrometa\Application\Contract\ParsingResultInterface;
40		use Jkphl\Micrometa\Infrastructure\Parser\JsonLD\CachingContextLoader;
41		use Jkphl\Micrometa\Infrastructure\Parser\JsonLD\VocabularyCache;
42		use Jkphl\Micrometa\Ports\Format;
43		use ML\JsonLD\Exception\JsonLdException;
44		use ML\JsonLD\JsonLD as JsonLDParser;
45		use ML\JsonLD\LanguageTaggedString;
46		use ML\JsonLD\Node;
47		use ML\JsonLD\NodeInterface;
48		use ML\JsonLD\TypedValue;
49		use Psr\Http\Message\UriInterface;
50		use Psr\Log\LoggerInterface;
51
52		/**
53		* JsonLD parser
54		*
55		* @package Jkphl\Micrometa
56		* @subpackage Jkphl\Micrometa\Infrastructure
57		* @see https://jsonld-examples.com/
58		* @see http://www.dr-chuck.com/csev-blog/2016/04/json-ld-performance-sucks-for-api-specs/
59		*/
60		class JsonLD extends AbstractParser
61		{
62		/**
63		* Format
64		*
65		* @var int
66		*/
67		const FORMAT = Format::JSON_LD;
68		/**
69		* Regex pattern for matching leading comments in a JSON string
70		*
71		* @var string
72		*/
73		const JSON_COMMENT_PATTERN = '#(/\([^]\|[\r\n]\|(\+([^/]\|[\r\n])))\+/)\|([\s\t]//.)\|(^//.)#';
74		/**
75		* Vocabulary cache
76		*
77		* @var VocabularyCache
78		*/
79		protected $vocabularyCache;
80		/**
81		* Context loader
82		*
83		* @var CachingContextLoader
84		*/
85		protected $contextLoader;
86
87		/**
88		* JSON-LD parser constructor
89		*
90		* @param UriInterface $uri Base URI
91		* @param LoggerInterface $logger Logger
92		*/
93	5	public function __construct(UriInterface $uri, LoggerInterface $logger)
94		{
95	5	parent::__construct($uri, $logger);
96	5	$this->vocabularyCache = new VocabularyCache();
97	5	$this->contextLoader = new CachingContextLoader($this->vocabularyCache);
98	5	}
99
100		/**
101		* Parse a DOM document
102		*
103		* @param \DOMDocument $dom DOM Document
104		*
105		* @return ParsingResultInterface Micro information items
106		* @throws \ReflectionException
107		*/
108	4	public function parseDom(\DOMDocument $dom)
109		{
110	4	$this->logger->info('Running parser: '.(new \ReflectionClass(__CLASS__))->getShortName());
111	4	$items = [];
112
113		// Find and process all JSON-LD documents
114	4	$xpath = new \DOMXPath($dom);
115	4	$jsonLDDocs = $xpath->query('//*[local-name(.) = "script"][@type = "application/ld+json"]');
116	4	$this->logger->debug('Processing '.$jsonLDDocs->length.' JSON-LD documents');
117
118		// Run through all JSON-LD documents
119	4	foreach ($jsonLDDocs as $jsonLDDoc) {
120	4	$jsonLDDocSource = preg_replace(self::JSON_COMMENT_PATTERN, '', $jsonLDDoc->textContent);
121	4	$i = $this->parseDocument($jsonLDDocSource);
122	3	$items = array_merge($items, $i);
123		}
124
125	3	return new ParsingResult(self::FORMAT, $items);
126		}
127
128		/**
129		* Parse a JSON-LD document
130		*
131		* @param string $jsonLDDocSource JSON-LD document
132		*
133		* @return array Items
134		*/
135	4	protected function parseDocument($jsonLDDocSource)
136		{
137	4	$jsonLDDocSource = $this->sanitizeJsonSource($jsonLDDocSource);
138
139		// Unserialize the JSON-LD document
140	4	$jsonLDDoc = @json_decode($jsonLDDocSource);
141
142		// If this is not a valid JSON document: Return
143	4	if (!is_object($jsonLDDoc) && !is_array($jsonLDDoc)) {
144	3	$this->logger->error('Skipping invalid JSON-LD document');
145
146	2	return [];
147		}
148
149		// Parse the document
150	2	return array_filter(
151	2	is_array($jsonLDDoc) ?
152	2	array_map([$this, 'parseRootNode'], $jsonLDDoc) : [$this->parseRootNode($jsonLDDoc)]
153		);
154		}
155
156		/**
157		* Parse a JSON-LD root node
158		*
159		* @param \stdClass $jsonLDRoot JSON-LD root node
160		*/
161	2	protected function parseRootNode($jsonLDRoot)
162		{
163	2	$item = null;
164
165		try {
166	2	$jsonDLDocument = JsonLDParser::getDocument($jsonLDRoot, ['documentLoader' => $this->contextLoader]);
167
168		// Run through all nodes to parse the first one
169		/** @var Node $node */
170	2	foreach ($jsonDLDocument->getGraph()->getNodes() as $node) {
171	2	$item = $this->parseNode($node);
172	2	break;
173		}
174		} catch (JsonLdException $exception) {
175		$this->logger->error($exception->getMessage(), ['exception' => $exception]);
176		}
177
178	2	return $item;
179		}
180
181		/**
182		* Parse a JSON-LD node
183		*
184		* @param NodeInterface $node Node
185		*
186		* @return \stdClass Item
187		*/
188	2	protected function parseNode(NodeInterface $node)
189		{
190		return (object)[
191	2	'type' => $this->parseNodeType($node),
192	2	'id' => $node->getId() ?: null,
193	2	'properties' => $this->parseNodeProperties($node),
194		];
195		}
196
197		/**
198		* Parse the type of a JSON-LD node
199		*
200		* @param NodeInterface $node Node
201		*
202		* @return array Item type
203		*/
204	2	protected function parseNodeType(NodeInterface $node)
205		{
206		/** @var Node $itemType */
207	2	return ($itemType = $node->getType()) ? [$this->vocabularyCache->expandIRI($itemType->getId())] : [];
208		}
209
210		/**
211		* Parse the properties of a JSON-LD node
212		*
213		* @param NodeInterface $node Node
214		*
215		* @return array Item properties
216		*/
217	2	protected function parseNodeProperties(NodeInterface $node)
218		{
219	2	$properties = [];
220
221		// Run through all node properties
222	2	foreach ($node->getProperties() as $name => $property) {
223		// Skip the node type
224	2	if ($name === Node::TYPE) {
225	2	continue;
226		}
227
228		// Initialize the property (if necessary)
229	2	$this->initializeNodeProperty($name, $properties);
230
231		// Parse and process the property value
232	2	$this->processNodeProperty($name, $this->parse($property), $properties);
233		}
234
235	2	return $properties;
236		}
237
238		/**
239		* Initialize a JSON-LD node property (if necessary)
240		*
241		* @param string $name Property name
242		* @param array $properties Item properties
243		*/
244	2	protected function initializeNodeProperty($name, array &$properties)
245		{
246	2	if (empty($properties[$name])) {
247	2	$properties[$name] = $this->vocabularyCache->expandIRI($name);
248	2	$properties[$name]->values = [];
249		}
250	2	}
251
252		/**
253		* Process a property value
254		*
255		* @param string $name Property name
256		* @param \stdClass\|array\|string $value Property value
257		* @param array $properties Item properties
258		*/
259	2	protected function processNodeProperty($name, $value, array &$properties)
260		{
261		// If this is a nested item
262	2	if (is_object($value)) {
263	2	$this->processNodePropertyObject($name, $value, $properties);
264
265		// Else: If this is a value list
266	2	} elseif (is_array($value)) {
267	2	foreach ($value as $listValue) {
268	2	$this->processNodeProperty($name, $listValue, $properties);
269		}
270
271		// Else: If the value is not empty
272	2	} elseif ($value) {
273	2	$properties[$name]->values[] = $value;
274		}
275	2	}
276
277		/**
278		* Process a property value object
279		*
280		* @param string $name Property name
281		* @param \stdClass $value Property value
282		* @param array $properties Properties
283		*/
284	2	protected function processNodePropertyObject($name, $value, array &$properties)
285		{
286	2	if (!empty($value->type) \|\| !empty($value->lang)) {
287	2	$properties[$name]->values[] = $value;
288
289		// @type = @id
290	2	} elseif (!empty($value->id)) {
291	2	$properties[$name]->values[] = $value->id;
292		}
293	2	}
294
295		/**
296		* Parse a JSON-LD fragment
297		*
298		* @param NodeInterface\|LanguageTaggedString\|TypedValue\|array $jsonLD JSON-LD fragment
299		*
300		* @return \stdClass\|string\|array Parsed fragment
301		*/
302	2	protected function parse($jsonLD)
303		{
304		// If it's a node object
305	2	if ($jsonLD instanceof NodeInterface) {
306	2	return $this->parseNode($jsonLD);
307
308		// Else if it's a language tagged string
309	2	} elseif ($jsonLD instanceof LanguageTaggedString) {
310	1	return $this->parseLanguageTaggedString($jsonLD);
311
312		// Else if it's a typed value
313	2	} elseif ($jsonLD instanceof TypedValue) {
314	2	return $this->parseTypedValue($jsonLD);
315		}
316
317		// Else if it's a list of items
318	2	return array_map([$this, 'parse'], $jsonLD);
319		}
320
321		/**
322		* Parse a language tagged string
323		*
324		* @param LanguageTaggedString $value Language tagged string
325		*
326		* @return \stdClass Value
327		*/
328	1	protected function parseLanguageTaggedString(LanguageTaggedString $value)
329		{
330	1	return (object)['value' => $value->getValue(), 'lang' => $value->getLanguage()];
331		}
332
333		/**
334		* Parse a typed value
335		*
336		* @param TypedValue $value Typed value
337		*
338		* @return string Value
339		*/
340	2	protected function parseTypedValue(TypedValue $value)
341		{
342	2	return $value->getValue();
343		}
344
345	4	private function sanitizeJsonSource($jsonLDDocSource)
346		{
347	4	$jsonLDDocSource = trim($jsonLDDocSource);
348
349	4	if (substr($jsonLDDocSource, -1) === ';') {
350		$jsonLDDocSource = substr_replace($jsonLDDocSource, '', -1);
351		}
352
353	4	return $jsonLDDocSource;
354		}
355		}
356

jkphl / micrometa

Push — master ( 6a41ca...195821 )

JsonLD::sanitizeJsonSource() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like