Configuration::addUIViewTemplate() - Code Metrics - Inspection of "~" - turnaev/monitor-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 0ec4b3...bff059 )

by Vladimir

created 2018-10-17 11:14 UTC

Configuration::addUIViewTemplate() A

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	1

Importance

Changes

Metric	Value
eloc	4
dl	0
loc	6
ccs	5
cts	5
cp	1
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0
crap	1

<?php

/**

 * This file is part of the `tvi/monitor-bundle` project.

 * (c) https://github.com/turnaev/monitor-bundle/graphs/contributors

 * For the full copyright and license information, please view the LICENSE.md

 * file that was distributed with this source code.

*/

Coding Style introduced 2018-09-26 08:01 UTC by

PHP version not specified

Coding Style introduced 2018-09-26 08:01 UTC by

Missing @category tag in file comment

Coding Style introduced 2018-09-26 08:01 UTC by

Missing @package tag in file comment

Coding Style introduced 2018-09-26 08:01 UTC by

Missing @author tag in file comment

Coding Style introduced 2018-09-26 08:01 UTC by

Missing @license tag in file comment

Coding Style introduced 2018-09-26 08:01 UTC by

Missing @link tag in file comment

namespace Tvi\MonitorBundle\DependencyInjection;

use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;

use Symfony\Component\Config\Definition\Builder\ScalarNodeDefinition;

use Symfony\Component\Config\Definition\Builder\TreeBuilder;

use Symfony\Component\Config\Definition\ConfigurationInterface;

use Tvi\MonitorBundle\Check\CheckPluginFinder;

/**

 * This class contains the configuration information for the bundle.

 * This information is solely responsible for how the different configuration

 * sections are normalized, and merged.

 * @author Vladimir Turnaev <[email protected]>

*/

Coding Style introduced 2018-09-26 08:01 UTC by

Missing @category tag in class comment

Coding Style introduced 2018-09-26 08:01 UTC by

Missing @package tag in class comment

Coding Style introduced 2018-09-26 08:01 UTC by

Missing @license tag in class comment

Coding Style introduced 2018-09-26 08:01 UTC by

Missing @link tag in class comment

class Configuration implements ConfigurationInterface

/**

Coding Style introduced 2018-09-24 09:59 UTC by

Missing short description in doc comment

     * @var array

*/

    private $checkPlugins = [];

Coding Style introduced 2018-10-05 08:58 UTC by

Private member variable "checkPlugins" must be prefixed with an underscore

    private $checkPluginClasses = [];

Coding Style introduced 2018-10-05 08:58 UTC by

Private member variable "checkPluginClasses" must be prefixed with an underscore

/**

Coding Style introduced 2018-10-05 08:58 UTC by

Parameter $pluginFinder should have a doc-comment as per coding-style.

     * Configuration constructor.

*/

    public function __construct(CheckPluginFinder $pluginFinder)

        $this->checkPluginClasses = $pluginFinder->find();

    public function getCheckPlugins(): array

Coding Style introduced 2018-10-05 09:04 UTC by

Missing doc comment for function getCheckPlugins()

        return $this->checkPlugins;

/**

     * Generates the configuration tree.

     * @return TreeBuilder

*/

    public function getConfigTreeBuilder()

        $treeBuilder = new TreeBuilder();

        $treeBuilder->root('tvi_monitor', 'array')

            ->children()

                ->append($this->addUIViewTemplate())

Coding Style introduced 2018-10-17 11:20 UTC by

Object operator not indented correctly; expected 12 spaces but found 16

                ->append($this->addChecksSearchPaths())

Coding Style introduced 2018-10-05 08:58 UTC by

Object operator not indented correctly; expected 12 spaces but found 16

                ->append($this->addGroups())

Coding Style introduced 2018-10-08 07:29 UTC by

Object operator not indented correctly; expected 12 spaces but found 16

                ->append($this->addTags())

Coding Style introduced 2018-10-05 08:58 UTC by

Object operator not indented correctly; expected 12 spaces but found 16

                ->append($this->addReporers())

Coding Style introduced 2018-09-24 09:59 UTC by

Object operator not indented correctly; expected 12 spaces but found 16

                ->append($this->addChecks())

Coding Style introduced 2018-09-24 09:59 UTC by

Object operator not indented correctly; expected 12 spaces but found 16

            ->end()

        ->end();

Coding Style introduced 2018-09-24 09:59 UTC by

Object operator not indented correctly; expected 12 spaces but found 8

        return $treeBuilder;

    private function addChecks(): ArrayNodeDefinition

Coding Style introduced 2018-09-24 09:59 UTC by

Missing doc comment for function addChecks()

Coding Style introduced 2018-09-24 09:59 UTC by

Private method name "Configuration::addChecks" must be prefixed with an underscore

        $builder = new TreeBuilder();

        $checkPligins = $this->checkPlugins;

        $addChecks = function ($rootNode) use ($checkPligins, $builder) {

Unused Code introduced 2018-10-05 08:58 UTC by

The import $checkPligins is not used and could be removed.

            foreach ($this->checkPluginClasses as $checkPluginClass) {

                $checkPligin = new $checkPluginClass();

                $confMethods = array_filter(get_class_methods($checkPligin), static function ($n) {

Coding Style introduced 2018-10-03 08:53 UTC by

The opening parenthesis of a multi-line function call should be the last content on the line.

                    return preg_match('/Conf$/', $n);

});

Coding Style introduced 2018-10-03 08:53 UTC by

For multi-line function calls, the closing parenthesis should be on a new line.

                foreach ($confMethods as $confMethod) {

                    /* @var ArrayNodeDefinition $node */

                    $node = $checkPligin->$confMethod($builder);

                    $checkName = $node->getNode(true)->getName();

                    $serviceName = preg_replace('/_factory$/', '', $checkName);

                    $this->checkPlugins[$checkName] = [

                        'checkServicePath' => $checkPligin::PATH.\DIRECTORY_SEPARATOR.'check.yml',

                        'service' => $serviceName,

                        'pligin' => $checkPligin,

];

100

                    $rootNode->append($node);

101

102

103

104

            return $rootNode;

105

};

106

107

        $node = $builder

108

            ->root('checks', 'array')

109

            ->beforeNormalization()

110

            ->always(static function ($value) {

Coding Style introduced 2018-10-01 15:24 UTC by

The opening parenthesis of a multi-line function call should be the last content on the line.

111

                $value = $value ? $value : [];

112

                foreach ($value as $k => $v) {

113

                    $newK = str_replace('(s)', '_factory', $k);

114

                    if ($newK !== $k) {

115

                        $value[$newK] = $value[$k];

116

                        unset($value[$k]);

117

118

119

120

                return $value;

121

})

Coding Style introduced 2018-10-04 11:37 UTC by

For multi-line function calls, the closing parenthesis should be on a new line.

122

            ->end()

123

            ->children(); //--

124

        $node = $addChecks($node)

125

            ->end();

126

127

        return $node;

128

129

130

    private function addReporers(): ArrayNodeDefinition

Coding Style introduced 2018-09-24 09:59 UTC by

Missing doc comment for function addReporers()

Coding Style introduced 2018-09-24 09:59 UTC by

Private method name "Configuration::addReporers" must be prefixed with an underscore

131

132

        return (new TreeBuilder())

133

            ->root('reporters', 'array')

134

            ->children()

135

                ->arrayNode('mailer')

Coding Style introduced 2018-09-24 09:59 UTC by

Object operator not indented correctly; expected 12 spaces but found 16

136

                    ->children()

Coding Style introduced 2018-09-24 09:59 UTC by

Object operator not indented correctly; expected 12 spaces but found 20

137

                        ->scalarNode('recipient')

Coding Style introduced 2018-09-24 09:59 UTC by

Object operator not indented correctly; expected 12 spaces but found 24

138

                            ->isRequired()

Coding Style introduced 2018-09-24 09:59 UTC by

Object operator not indented correctly; expected 12 spaces but found 28

139

                            ->cannotBeEmpty()

Coding Style introduced 2018-09-24 09:59 UTC by

Object operator not indented correctly; expected 12 spaces but found 28

140

                        ->end()

Coding Style introduced 2018-09-24 09:59 UTC by

Object operator not indented correctly; expected 12 spaces but found 24

141

                        ->scalarNode('sender')

Coding Style introduced 2018-09-24 09:59 UTC by

Object operator not indented correctly; expected 12 spaces but found 24

142

                            ->isRequired()

Coding Style introduced 2018-09-24 09:59 UTC by

Object operator not indented correctly; expected 12 spaces but found 28

143

                            ->cannotBeEmpty()

Coding Style introduced 2018-09-24 09:59 UTC by

Object operator not indented correctly; expected 12 spaces but found 28

144

                        ->end()

Coding Style introduced 2018-09-24 09:59 UTC by

Object operator not indented correctly; expected 12 spaces but found 24

145

                        ->scalarNode('subject')

Coding Style introduced 2018-09-24 09:59 UTC by

Object operator not indented correctly; expected 12 spaces but found 24

146

                            ->isRequired()

Coding Style introduced 2018-09-24 09:59 UTC by

Object operator not indented correctly; expected 12 spaces but found 28

147

                            ->cannotBeEmpty()

Coding Style introduced 2018-09-24 09:59 UTC by

Object operator not indented correctly; expected 12 spaces but found 28

148

                        ->end()

Coding Style introduced 2018-09-24 09:59 UTC by

Object operator not indented correctly; expected 12 spaces but found 24

149

                        ->booleanNode('send_on_warning')

Coding Style introduced 2018-09-24 09:59 UTC by

Object operator not indented correctly; expected 12 spaces but found 24

150

                            ->defaultTrue()

Coding Style introduced 2018-09-24 09:59 UTC by

Object operator not indented correctly; expected 12 spaces but found 28

151

                        ->end()

Coding Style introduced 2018-09-24 09:59 UTC by

Object operator not indented correctly; expected 12 spaces but found 24

152

                    ->end()

Coding Style introduced 2018-09-24 09:59 UTC by

Object operator not indented correctly; expected 12 spaces but found 20

153

                ->end()

Coding Style introduced 2018-09-24 09:59 UTC by

Object operator not indented correctly; expected 12 spaces but found 16

154

            ->end();

155

156

157

    private function addTags(): ArrayNodeDefinition

Coding Style introduced 2018-09-24 09:59 UTC by

Missing doc comment for function addTags()

Coding Style introduced 2018-09-24 09:59 UTC by

Private method name "Configuration::addTags" must be prefixed with an underscore

158

159

        return (new TreeBuilder())

160

            ->root('tags', 'array')

161

            ->prototype('array')

Bug introduced 2018-10-08 07:29 UTC by

The method prototype() does not exist on Symfony\Component\Config...\Builder\NodeDefinition. It seems like you code against a sub-type of Symfony\Component\Config...\Builder\NodeDefinition such as Symfony\Component\Config...der\ArrayNodeDefinition. ( Ignorable by Annotation )

162

                ->children()

Coding Style introduced 2018-10-08 07:29 UTC by

Object operator not indented correctly; expected 12 spaces but found 16

163

                    ->scalarNode('name')->end()

Coding Style introduced 2018-10-08 07:29 UTC by

Object operator not indented correctly; expected 12 spaces but found 20

164

                    ->scalarNode('descr')->end()

Coding Style introduced 2018-10-08 07:29 UTC by

Object operator not indented correctly; expected 12 spaces but found 20

165

                ->end()

Coding Style introduced 2018-10-08 07:29 UTC by

Object operator not indented correctly; expected 12 spaces but found 16

166

            ->end();

167

168

169

    private function addGroups(): ArrayNodeDefinition

Coding Style introduced 2018-10-08 07:29 UTC by

Missing doc comment for function addGroups()

Coding Style introduced 2018-10-08 07:29 UTC by

Private method name "Configuration::addGroups" must be prefixed with an underscore

170

171

        return (new TreeBuilder())

172

            ->root('groups', 'array')

173

            ->prototype('array')

174

                ->children()

Coding Style introduced 2018-10-08 07:29 UTC by

Object operator not indented correctly; expected 12 spaces but found 16

175

                    ->scalarNode('name')->end()

Coding Style introduced 2018-10-08 07:29 UTC by

Object operator not indented correctly; expected 12 spaces but found 20

176

                    ->scalarNode('descr')->end()

Coding Style introduced 2018-10-08 07:29 UTC by

Object operator not indented correctly; expected 12 spaces but found 20

177

                ->end()

Coding Style introduced 2018-10-08 07:29 UTC by

Object operator not indented correctly; expected 12 spaces but found 16

178

            ->end();

179

180

181

    private function addChecksSearchPaths(): ArrayNodeDefinition

Coding Style introduced 2018-10-05 08:58 UTC by

Missing doc comment for function addChecksSearchPaths()

Coding Style introduced 2018-10-05 08:58 UTC by

Private method name "Configuration::addChecksSearchPaths" must be prefixed with an underscore

182

183

        return (new TreeBuilder())

184

            ->root('checks_search_paths', 'array')

185

            ->prototype('scalar')->end();

186

187

188

    private function addUIViewTemplate()

Coding Style introduced 2018-10-17 11:20 UTC by

Missing doc comment for function addUIViewTemplate()

Coding Style introduced 2018-10-17 11:20 UTC by

Private method name "Configuration::addUIViewTemplate" must be prefixed with an underscore

189

190

        return (new TreeBuilder())

191

            ->root('ui_view_template', 'scalar')

192

                ->cannotBeEmpty()

Coding Style introduced 2018-10-17 11:20 UTC by

Object operator not indented correctly; expected 12 spaces but found 16

193

                ->defaultValue('@TviMonitor/UI/index.html.twig')

Coding Style introduced 2018-10-17 11:20 UTC by

Object operator not indented correctly; expected 12 spaces but found 16

Coding Style introduced 2018-10-17 11:20 UTC by

Space after closing parenthesis of function call prohibited

194

195

196

197

turnaev / monitor-bundle

Push — master ( 0ec4b3...bff059 )

Configuration::addUIViewTemplate() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like