ApiCfpWriter::setOutput() - Code Metrics - Inspection of "Reworked API" - joindin/callingallpapers-cli - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#7)

by Andreas

created 2016-03-27 20:02 UTC

ApiCfpWriter::setOutput() A

↳ Parent: ApiCfpWriter

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	4
rs	10
cc	1
eloc	2
nc	1
nop	1

<?php
/**
 * Copyright (c) 2015-2016 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 2015-2016 Andreas Heigl/callingallpapers.com
 * @license   http://www.opensource.org/licenses/mit-license.php MIT-License
 * @version   0.0
 * @since     01.12.2015
 * @link      http://github.com/heiglandreas/callingallpapers-cli
 */
namespace Callingallpapers\Writer;

use Callingallpapers\Entity\Cfp;
use GuzzleHttp\Client;
use GuzzleHttp\Exception\BadResponseException;
use Symfony\Component\Console\Output\OutputInterface;

class ApiCfpWriter implements WriterInterface
{
    protected $baseUri;

    protected $bearerToken;

    protected $client;

    protected $output;

    public function __construct($baseUri, $bearerToken)
    {
        $this->baseUri = $baseUri;
        $this->bearerToken = $bearerToken;
        $this->client = new Client(['headers' => [
            'Accept' => 'application/json',
        ]]);
        $this->output = new NullOutput();
    }

    public function write(Cfp $cfp)
    {
        $body = [
            'name'           => $cfp->conferenceName,
            'dateCfpStart'   => $cfp->dateStart->format('c'),
            'dateCfpEnd'     => $cfp->dateEnd->format('c'),
            'dateEventStart' => $cfp->eventStartDate->format('c'),
            'dateEventEnd'   => $cfp->eventEndDate->format('c'),
            'timezone'       => $cfp->timezone,
            'uri'            => $cfp->uri,
            'eventUri'       => $cfp->conferenceUri,
            'iconUri'        => $cfp->iconUri,
            'description'    => $cfp->description,
            'location'       => $cfp->location,
            'latitude'       => $cfp->latitude,
            'longitude'      => $cfp->longitude,
            'tags'           => $cfp->tags,
        ];

        try {
            $this->client->request('GET', sprintf(
                $this->baseUri . '/%1$s',
                sha1($cfp->conferenceUri)
            ), []);
            $exists = true;
        } catch (BadResponseException $e) {
            $exists = false;
        }

        try {
            if ($exists === false) {
                // Doesn't exist, so create it

                $response = $this->client->request('POST', sprintf(
                    $this->baseUri
                ), [
                    'headers' => [
                        'Authenticate' => 'Bearer ' . $this->bearerToken,
                    ],
                    'form_params' => $body
                ]);
            } else {
                // Exists, so update it
                $response = $this->client->request('PUT', sprintf(
                    $this->baseUri . '/%1$s',
                    sha1($cfp->conferenceUri)
                ), [
                    'headers' => [
                        'Authenticate' => 'Bearer ' . $this->bearerToken,
                    ],
                    'form_params' => $body
                ]);
            }
        } catch (BadResponseException $e) {
            $this->output->writeln($e->getMessage());
            return;
        } catch (\Exception $e) {
            $this->output->writeln($e->getMessage());
            return;
        }

        $this->output->writeln(sprintf(
            'Conference "%1$s" succcessfully %2$s.',
            $cfp->conferenceName,
            ($exists)?'updated':'created'
        ));

        return isset($response) && ($response->getStatusCode() === 200 || $response->getStatusCode() === 201);
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());
}
    }

    public function setOutput(OutputInterface $output)
    {
        $this->output = $output;
    }
}


1			<?php
2			/**
3			* Copyright (c) 2015-2016 Andreas Heigl<[email protected]>
4			*
5			* Permission is hereby granted, free of charge, to any person obtaining a copy
6			* of this software and associated documentation files (the "Software"), to deal
7			* in the Software without restriction, including without limitation the rights
8			* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9			* copies of the Software, and to permit persons to whom the Software is
10			* furnished to do so, subject to the following conditions:
11			*
12			* The above copyright notice and this permission notice shall be included in
13			* all copies or substantial portions of the Software.
14			*
15			* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16			* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17			* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18			* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19			* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20			* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21			* THE SOFTWARE.
22			*
23			* @author Andreas Heigl<[email protected]>
24			* @copyright 2015-2016 Andreas Heigl/callingallpapers.com
25			* @license http://www.opensource.org/licenses/mit-license.php MIT-License
26			* @version 0.0
27			* @since 01.12.2015
28			* @link http://github.com/heiglandreas/callingallpapers-cli
29			*/
30			namespace Callingallpapers\Writer;
31
32			use Callingallpapers\Entity\Cfp;
33			use GuzzleHttp\Client;
34			use GuzzleHttp\Exception\BadResponseException;
35			use Symfony\Component\Console\Output\OutputInterface;
36
37			class ApiCfpWriter implements WriterInterface
38			{
39			protected $baseUri;
40
41			protected $bearerToken;
42
43			protected $client;
44
45			protected $output;
46
47			public function __construct($baseUri, $bearerToken)
48			{
49			$this->baseUri = $baseUri;
50			$this->bearerToken = $bearerToken;
51			$this->client = new Client(['headers' => [
52			'Accept' => 'application/json',
53			]]);
54			$this->output = new NullOutput();
55			}
56
57			public function write(Cfp $cfp)
58			{
59			$body = [
60			'name' => $cfp->conferenceName,
61			'dateCfpStart' => $cfp->dateStart->format('c'),
62			'dateCfpEnd' => $cfp->dateEnd->format('c'),
63			'dateEventStart' => $cfp->eventStartDate->format('c'),
64			'dateEventEnd' => $cfp->eventEndDate->format('c'),
65			'timezone' => $cfp->timezone,
66			'uri' => $cfp->uri,
67			'eventUri' => $cfp->conferenceUri,
68			'iconUri' => $cfp->iconUri,
69			'description' => $cfp->description,
70			'location' => $cfp->location,
71			'latitude' => $cfp->latitude,
72			'longitude' => $cfp->longitude,
73			'tags' => $cfp->tags,
74			];
75
76			try {
77			$this->client->request('GET', sprintf(
78			$this->baseUri . '/%1$s',
79			sha1($cfp->conferenceUri)
80			), []);
81			$exists = true;
82			} catch (BadResponseException $e) {
83			$exists = false;
84			}
85
86			try {
87			if ($exists === false) {
88			// Doesn't exist, so create it
89
90			$response = $this->client->request('POST', sprintf(
91			$this->baseUri
92			), [
93			'headers' => [
94			'Authenticate' => 'Bearer ' . $this->bearerToken,
95			],
96			'form_params' => $body
97			]);
98			} else {
99			// Exists, so update it
100			$response = $this->client->request('PUT', sprintf(
101			$this->baseUri . '/%1$s',
102			sha1($cfp->conferenceUri)
103			), [
104			'headers' => [
105			'Authenticate' => 'Bearer ' . $this->bearerToken,
106			],
107			'form_params' => $body
108			]);
109			}
110			} catch (BadResponseException $e) {
111			$this->output->writeln($e->getMessage());
112			return;
113			} catch (\Exception $e) {
114			$this->output->writeln($e->getMessage());
115			return;
116			}
117
118			$this->output->writeln(sprintf(
119			'Conference "%1$s" succcessfully %2$s.',
120			$cfp->conferenceName,
121			($exists)?'updated':'created'
122			));
123
124			return isset($response) && ($response->getStatusCode() === 200 \|\| $response->getStatusCode() === 201);
			0 ignored issues – show Bug Best Practice introduced 2016-03-27 20:04 UTC by Report Bug Copy Issue Report The return type of `return isset($response) ...tStatusCode() === 201);` (`boolean`) is incompatible with the return type declared by the interface `Callingallpapers\Writer\WriterInterface::write` of type `string`. 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...
125			}
126
127			public function setOutput(OutputInterface $output)
128			{
129			$this->output = $output;
130			}
131			}
132

joindin / callingallpapers-cli

Pull Request — master (#7)

ApiCfpWriter::setOutput() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like