CommentSubmitModule::redirectToComment() - Code Metrics - Inspection of "Removes dual-write of comments" - jacobemerick/web - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 2a302c...68e9dc )

by Jacob

created 2016-08-03 12:28 UTC

CommentSubmitModule::redirectToComment() A

↳ Parent: CommentSubmitModule

Complexity

Conditions	1
Paths	1

Size

Total Lines	9
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	9
rs	9.6666
cc	1
eloc	6
nc	1
nop	1

<?php


Loader::load('utility', [
    'Request',
    'Validate',
]);

use Jacobemerick\Web\Domain\Comment\Comment\ServiceCommentRepository;

class CommentSubmitModule
namespace YourVendor;

class YourClass { }
{

    private $site;
    private $path;
    private $fullPath;

    public function __construct($site, $path, $fullPath, $pageTitle)

    {
        $this->site = $site;
        $this->path = $path;
        $this->fullPath = $fullPath;
    }

    public function activate()
    {
        // todo why is this responsible for checking on valid calls
        if (!Request::hasPost()) {
            return false;
        }
        if (!Request::getPost('submit') == 'Submit Comment') {
            return false;
        }
        if (!Request::getPost('catch') !== '') {
            return false;
        }

        $errors = $this->checkValidation();
        if (count($errors) > 0) {
            return $errors;
        }

        $commentId = $this->save(Request::getPost());
        // todo broken notifications
        $this->redirectToComment($commentId);
    }

    private function checkValidation()
    {
        $errors = array();
        if (!Validate::checkRequest('post', 'name', 'name')) {
            $errors['name'] = 'You must include a valid name';
        }
        if (!Validate::checkRequest('post', 'email', 'email')) {
            $errors['email'] = 'You must include a valid email';
        }
        if (Request::getPost('website') && !Validate::checkRequest('post', 'website', 'url')) {
            $errors['website'] = 'Please enter a valid website';
        }
        if (!Validate::checkRequest('post', 'comment', 'string')) {
            $errors['comment'] = 'You must enter a comment';
        }
        if (Request::getPost('notify') && Request::getPost('notify') != 'check') {
            $errors['notify'] = 'You entered an invalid notify request';
        }
        if (Request::getPost('reply') && !Validate::checkRequest('post', 'reply', 'integer')) {
            $errors['reply'] = 'You entered an invalid reply request';
        }

        return $errors;
    }

    private function save(array $data)
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

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

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        $path = $_SERVER['REQUEST_URI'];
        $path = explode('/', $path);
        $path = array_filter($path);
        $path = array_slice($path, 0, 2);
        $path = implode('/', $path);

        $body = [
            'commenter' => [
                'name' => $data['name'],
                'email' => $data['email'],
                'website' => $data['website'],
            ],
            'body' => $data['comment'],
            'should_notify' => (isset($data['notify']) && $data['notify'] == 'check'),
            'domain' => (URLDecode::getSite() == 'blog' ? 'blog.jacobemerick.com' : 'waterfallsofthekeweenaw.com'),
            'path' => $path,
            'url' => "{$this->fullPath}#comment-{{id}}",
            'thread' => 'comments',
            'reply_to' => ($data['type'] == 'new' ? 0 : $data['type']),
            'ip_address' => $_SERVER['REMOTE_ADDR'],
            'user_agent' => $_SERVER['HTTP_USER_AGENT'],
            'referrer' => $_SERVER['HTTP_REFERER'],
        ];

        global $container;
function myFunction($a, $b) {
    // Do something
}
        $repository = new ServiceCommentRepository($container['comment_service_api']);
        try {
            $response = $repository->createComment($body);
        } catch (Exception $e) {
            $container['logger']->warning("CommentService | Create | {$e->getMessage()}");
        }

        return $response->getId();

    }

    private function redirectToComment($commentId)
    {
        $url = '';
        $url .= $this->fullPath;
        $url .= "#comment-{$commentId}";

        Loader::loadNew('controller', 'Error303Controller', array($url))->activate();
        exit;

    }
}


1			<?php
			0 ignored issues – show Coding Style Compatibility introduced 2016-08-03 12:42 UTC by Report Bug Copy Issue Report For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 10 and the first side effect is on line 3. The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file. The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place. To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1. Loading history...
2
3			Loader::load('utility', [
4			'Request',
5			'Validate',
6			]);
7
8			use Jacobemerick\Web\Domain\Comment\Comment\ServiceCommentRepository;
9
10			class CommentSubmitModule
			0 ignored issues – show Coding Style Compatibility introduced 2016-08-03 12:42 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
11			{
12
13			private $site;
14			private $path;
15			private $fullPath;
16
17			public function __construct($site, $path, $fullPath, $pageTitle)
			0 ignored issues – show Unused Code introduced 2016-08-03 12:42 UTC by Report Bug Copy Issue Report The parameter `$pageTitle` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
18			{
19			$this->site = $site;
20			$this->path = $path;
21			$this->fullPath = $fullPath;
22			}
23
24			public function activate()
25			{
26			// todo why is this responsible for checking on valid calls
27			if (!Request::hasPost()) {
28			return false;
29			}
30			if (!Request::getPost('submit') == 'Submit Comment') {
31			return false;
32			}
33			if (!Request::getPost('catch') !== '') {
34			return false;
35			}
36
37			$errors = $this->checkValidation();
38			if (count($errors) > 0) {
39			return $errors;
40			}
41
42			$commentId = $this->save(Request::getPost());
43			// todo broken notifications
44			$this->redirectToComment($commentId);
45			}
46
47			private function checkValidation()
48			{
49			$errors = array();
50			if (!Validate::checkRequest('post', 'name', 'name')) {
51			$errors['name'] = 'You must include a valid name';
52			}
53			if (!Validate::checkRequest('post', 'email', 'email')) {
54			$errors['email'] = 'You must include a valid email';
55			}
56			if (Request::getPost('website') && !Validate::checkRequest('post', 'website', 'url')) {
57			$errors['website'] = 'Please enter a valid website';
58			}
59			if (!Validate::checkRequest('post', 'comment', 'string')) {
60			$errors['comment'] = 'You must enter a comment';
61			}
62			if (Request::getPost('notify') && Request::getPost('notify') != 'check') {
63			$errors['notify'] = 'You entered an invalid notify request';
64			}
65			if (Request::getPost('reply') && !Validate::checkRequest('post', 'reply', 'integer')) {
66			$errors['reply'] = 'You entered an invalid reply request';
67			}
68
69			return $errors;
70			}
71
72			private function save(array $data)
			0 ignored issues – show Coding Style introduced 2016-08-03 12:42 UTC by Report Bug Copy Issue Report `save` uses the super-global variable `$_SERVER` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
73			{
74			$path = $_SERVER['REQUEST_URI'];
75			$path = explode('/', $path);
76			$path = array_filter($path);
77			$path = array_slice($path, 0, 2);
78			$path = implode('/', $path);
79
80			$body = [
81			'commenter' => [
82			'name' => $data['name'],
83			'email' => $data['email'],
84			'website' => $data['website'],
85			],
86			'body' => $data['comment'],
87			'should_notify' => (isset($data['notify']) && $data['notify'] == 'check'),
88			'domain' => (URLDecode::getSite() == 'blog' ? 'blog.jacobemerick.com' : 'waterfallsofthekeweenaw.com'),
89			'path' => $path,
90			'url' => "{$this->fullPath}#comment-{{id}}",
91			'thread' => 'comments',
92			'reply_to' => ($data['type'] == 'new' ? 0 : $data['type']),
93			'ip_address' => $_SERVER['REMOTE_ADDR'],
94			'user_agent' => $_SERVER['HTTP_USER_AGENT'],
95			'referrer' => $_SERVER['HTTP_REFERER'],
96			];
97
98			global $container;
			0 ignored issues – show Compatibility Best Practice introduced 2016-08-03 12:42 UTC by Report Bug Copy Issue Report Use of `global` functionality is not recommended; it makes your code harder to test, and less reusable. Instead of relying on `global` state, we recommend one of these alternatives: 1. Pass all data via parameters function myFunction($a, $b) { // Do something } 2. Create a class that maintains your state class MyClass { private $a; private $b; public function __construct($a, $b) { $this->a = $a; $this->b = $b; } public function myFunction() { // Do something } } Loading history...
99			$repository = new ServiceCommentRepository($container['comment_service_api']);
100			try {
101			$response = $repository->createComment($body);
102			} catch (Exception $e) {
103			$container['logger']->warning("CommentService \| Create \| {$e->getMessage()}");
104			}
105
106			return $response->getId();
			0 ignored issues – show Bug introduced 2016-08-03 12:42 UTC by Report Bug Copy Issue Report The method `getId` cannot be called on `$response` (of type `array<string,string\|arra...ng","thread":"string"}>`). Methods can only be called on objects. This check looks for methods being called on variables that have been inferred to never be objects. Loading history...
107			}
108
109			private function redirectToComment($commentId)
110			{
111			$url = '';
112			$url .= $this->fullPath;
113			$url .= "#comment-{$commentId}";
114
115			Loader::loadNew('controller', 'Error303Controller', array($url))->activate();
116			exit;
			0 ignored issues – show Coding Style Compatibility introduced 2016-08-03 12:42 UTC by Report Bug Copy Issue Report The method `redirectToComment()` contains an exit expression. An exit expression should only be used in rare cases. For example, if you write a short command line script. In most cases however, using an `exit` expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage. Loading history...
117			}
118			}
119

jacobemerick / web

Push — master ( 2a302c...68e9dc )

CommentSubmitModule::redirectToComment() A

Complexity

Size

Duplication

Importance

1. Pass all data via parameters

2. Create a class that maintains your state

Duplication Side-by-Side

Filter issues like