PapercallIoParser - Code Metrics - Inspection of "WIP Feature/add paper call io parser" - joindin/callingallpapers-cli - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#28)

by Andreas

created 2017-08-18 06:26 UTC

PapercallIoParser A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	59
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
wmc	8
c	1
b	0
f	1
lcom	1
cbo	1
dl	0
loc	59
rs	10

3 Methods

Rating	Name	Size	Complexity
A	__construct()	5	1
A	setStartUrl()	4	1
B	parse()	37	6

<?php

/**
 * Copyright (c) Andreas Heigl<[email protected]>
 *
 * 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.
 *
 * @author    Andreas Heigl<[email protected]>
 * @copyright Andreas Heigl
 * @license   http://www.opensource.org/licenses/mit-license.php MIT-License
 * @since     29.07.2016
 * @link      http://github.com/heiglandreas/callingallpapers
 */

namespace Callingallpapers\Parser;

use Callingallpapers\Parser\PapercallIo\EventParser;
use Callingallpapers\Service\TimezoneService;
use Callingallpapers\Writer\WriterInterface;
use DOMDocument;
use DOMXPath;

class PapercallIoParser implements ParserInterface
{
    const SOURCE = 'papercallio';

    protected $tzService;

    private $uri = 'https://papercall.io/cfps?page=%1$s';

    private $parser;

    public function __construct(TimezoneService $tzService, EventParser $parser)
    {
        $this->tzService = $tzService;
        $this->parser = $parser;
    }

    public function setStartUrl(string $uri)
    {
        $this->uri = $uri;
    }

    public function parse(WriterInterface $writer)
    {
        $i = 0;

        $pages = null;

        do {
            $dom = new DOMDocument('1.0', 'UTF-8');
            libxml_use_internal_errors(true);
            $uri = sprintf($this->uri, $i+1);
            $dom->loadHTMLFile($uri);
            libxml_use_internal_errors(false);
            $dom->preserveWhiteSpace = false;
            $xpath = new DOMXPath($dom);

            if (null === $pages) {
                $p = $xpath->query("//ul[contains(@class,'pagination')]/li");
                $pages = $p->length - 2;
            }

            $nodes = $xpath->query("//div[contains(@class,'main')]/div[@class='container'][2]//div[@class='box']");
            if ($nodes->length < 1) {
                continue;
            }

            /** @var DOMNode $node */
            foreach ($nodes as $node) {
                try {
                    $writer->write($this->parser->parseEvent($node), self::SOURCE);
                } catch (\Exception $e) {
                    error_log($e->getMEssage());
                }
            }
        } while (++$i < $pages);

        return true;
class Author {
    private $name;

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

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }
}


1			<?php
2
3			/**
4			* Copyright (c) Andreas Heigl<[email protected]>
5			*
6			* Permission is hereby granted, free of charge, to any person obtaining a copy
7			* of this software and associated documentation files (the "Software"), to deal
8			* in the Software without restriction, including without limitation the rights
9			* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10			* copies of the Software, and to permit persons to whom the Software is
11			* furnished to do so, subject to the following conditions:
12			*
13			* The above copyright notice and this permission notice shall be included in
14			* all copies or substantial portions of the Software.
15			*
16			* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17			* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18			* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19			* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20			* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21			* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22			* THE SOFTWARE.
23			*
24			* @author Andreas Heigl<[email protected]>
25			* @copyright Andreas Heigl
26			* @license http://www.opensource.org/licenses/mit-license.php MIT-License
27			* @since 29.07.2016
28			* @link http://github.com/heiglandreas/callingallpapers
29			*/
30
31			namespace Callingallpapers\Parser;
32
33			use Callingallpapers\Parser\PapercallIo\EventParser;
34			use Callingallpapers\Service\TimezoneService;
35			use Callingallpapers\Writer\WriterInterface;
36			use DOMDocument;
37			use DOMXPath;
38
39			class PapercallIoParser implements ParserInterface
40			{
41			const SOURCE = 'papercallio';
42
43			protected $tzService;
44
45			private $uri = 'https://papercall.io/cfps?page=%1$s';
46
47			private $parser;
48
49			public function __construct(TimezoneService $tzService, EventParser $parser)
50			{
51			$this->tzService = $tzService;
52			$this->parser = $parser;
53			}
54
55			public function setStartUrl(string $uri)
56			{
57			$this->uri = $uri;
58			}
59
60			public function parse(WriterInterface $writer)
61			{
62			$i = 0;
63
64			$pages = null;
65
66			do {
67			$dom = new DOMDocument('1.0', 'UTF-8');
68			libxml_use_internal_errors(true);
69			$uri = sprintf($this->uri, $i+1);
70			$dom->loadHTMLFile($uri);
71			libxml_use_internal_errors(false);
72			$dom->preserveWhiteSpace = false;
73			$xpath = new DOMXPath($dom);
74
75			if (null === $pages) {
76			$p = $xpath->query("//ul[contains(@class,'pagination')]/li");
77			$pages = $p->length - 2;
78			}
79
80			$nodes = $xpath->query("//div[contains(@class,'main')]/div[@class='container'][2]//div[@class='box']");
81			if ($nodes->length < 1) {
82			continue;
83			}
84
85			/** @var DOMNode $node */
86			foreach ($nodes as $node) {
87			try {
88			$writer->write($this->parser->parseEvent($node), self::SOURCE);
89			} catch (\Exception $e) {
90			error_log($e->getMEssage());
91			}
92			}
93			} while (++$i < $pages);
94
95			return true;
			0 ignored issues – show Bug Best Practice introduced 2017-08-17 20:03 UTC by Report Bug Copy Issue Report The return type of `return true;` (`boolean`) is incompatible with the return type declared by the interface `Callingallpapers\Parser\ParserInterface::parse` of type `Callingallpapers\Entity\CfpList`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
96			}
97			}
98

joindin / callingallpapers-cli

Pull Request — master (#28)

PapercallIoParser A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

3 Methods

Duplication Side-by-Side

Filter issues like