ProfileReader::getGeneratorOptions() - Code Metrics - Inspection of "Add targetPath for config output" - Niktux/karma - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#96)

by Sébastien

created 2016-06-02 12:08 UTC

ProfileReader::getGeneratorOptions() A

↳ Parent: ProfileReader

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	0

<?php

namespace Karma;

use Gaufrette\Filesystem;
use Symfony\Component\Yaml\Yaml;
use Symfony\Component\Yaml\Exception\ParseException;

class ProfileReader implements FormattersDefinition
{
    const
        TEMPLATE_SUFFIX_INDEX = 'suffix',
        MASTER_FILENAME_INDEX = 'master',
        CONFIGURATION_DIRECTORY_INDEX = 'confDir',
        SOURCE_PATH_INDEX = 'sourcePath',
        TARGET_PATH_INDEX = 'targetPath',
        DEFAULT_FORMATTER_INDEX = 'defaultFormatter',
        FORMATTERS_INDEX = 'formatters',
        FILE_EXTENSION_FORMATTERS_INDEX = 'fileExtensionFormatters',
        GENERATOR_INDEX = 'generator';

    private
        $attributes;

    public function __construct(Filesystem $fs)
    {
        $this->attributes = array(
            self::TEMPLATE_SUFFIX_INDEX => null,
            self::MASTER_FILENAME_INDEX => null,
            self::CONFIGURATION_DIRECTORY_INDEX => null,
            self::SOURCE_PATH_INDEX => null,
            self::TARGET_PATH_INDEX => null,
            self::DEFAULT_FORMATTER_INDEX => self::DEFAULT_FORMATTER_NAME,
            self::FORMATTERS_INDEX => array(),
            self::FILE_EXTENSION_FORMATTERS_INDEX => array(),
            self::GENERATOR_INDEX => array(),
        );

        $this->read($fs);
    }

    private function read(Filesystem $fs)
    {
        $profileFilename = Application::PROFILE_FILENAME;

        if($fs->has($profileFilename))
        {
            $this->processProfileContent($fs->read($profileFilename));
        }
    }

    private function processProfileContent($content)
    {
        try
        {
            $values = Yaml::parse($content);
        }
        catch(ParseException $e)
        {
            throw new \RuntimeException(sprintf(
               'Error while parsing profile : %s',
                $e->getMessage()
            ));
        }

        foreach(array_keys($this->attributes) as $name)
        {
            if(isset($values[$name]))
            {
                $this->attributes[$name] = $values[$name];
            }
        }
    }

    public function hasTemplatesSuffix()
    {
        return $this->hasString(self::TEMPLATE_SUFFIX_INDEX);
    }

    public function getTemplatesSuffix()
    {
        return $this->getString(self::TEMPLATE_SUFFIX_INDEX);
    }

    public function hasMasterFilename()
    {
        return $this->hasString(self::MASTER_FILENAME_INDEX);
    }

    public function getMasterFilename()
    {
        return $this->getString(self::MASTER_FILENAME_INDEX);
    }

    public function hasConfigurationDirectory()
    {
        return $this->hasString(self::CONFIGURATION_DIRECTORY_INDEX);
    }

    public function getConfigurationDirectory()
    {
        return $this->getString(self::CONFIGURATION_DIRECTORY_INDEX);
    }

    public function hasSourcePath()
    {
        return $this->has(self::SOURCE_PATH_INDEX);
    }

    public function getSourcePath()
    {
        return $this->get(self::SOURCE_PATH_INDEX);
    }

    public function hasTargetPath()
    {
        return $this->has(self::TARGET_PATH_INDEX);
    }

    public function getTargetPath()
    {
        return $this->get(self::TARGET_PATH_INDEX);
    }

    public function getDefaultFormatterName()
    {
        return $this->getString(self::DEFAULT_FORMATTER_INDEX);
    }

    public function getFormatters()
    {
        return $this->get(self::FORMATTERS_INDEX);
    }

    public function getFileExtensionFormatters()
    {
        return $this->get(self::FILE_EXTENSION_FORMATTERS_INDEX);
    }

    public function getGeneratorOptions()
    {
        return $this->get(self::GENERATOR_INDEX);
    }

    private function has($attributeName)
    {
        return isset($this->attributes[$attributeName]);
    }

    private function hasString($attributeName)
    {
        return isset($this->attributes[$attributeName]) && is_string($this->attributes[$attributeName]);
    }

    private function get($attributeName)

    {
        $value = null;

        if($this->has($attributeName))
        {
            $value = $this->attributes[$attributeName];
        }

        return $value;
    }

    private function getString($attributeName)

    {
        $value = null;

        if($this->hasString($attributeName))
        {
            $value = $this->attributes[$attributeName];
        }

        return $value;
    }
}


1		<?php
2
3		namespace Karma;
4
5		use Gaufrette\Filesystem;
6		use Symfony\Component\Yaml\Yaml;
7		use Symfony\Component\Yaml\Exception\ParseException;
8
9		class ProfileReader implements FormattersDefinition
10		{
11		const
12		TEMPLATE_SUFFIX_INDEX = 'suffix',
13		MASTER_FILENAME_INDEX = 'master',
14		CONFIGURATION_DIRECTORY_INDEX = 'confDir',
15		SOURCE_PATH_INDEX = 'sourcePath',
16		TARGET_PATH_INDEX = 'targetPath',
17		DEFAULT_FORMATTER_INDEX = 'defaultFormatter',
18		FORMATTERS_INDEX = 'formatters',
19		FILE_EXTENSION_FORMATTERS_INDEX = 'fileExtensionFormatters',
20		GENERATOR_INDEX = 'generator';
21
22		private
23		$attributes;
24
25		public function __construct(Filesystem $fs)
26		{
27		$this->attributes = array(
28		self::TEMPLATE_SUFFIX_INDEX => null,
29		self::MASTER_FILENAME_INDEX => null,
30		self::CONFIGURATION_DIRECTORY_INDEX => null,
31		self::SOURCE_PATH_INDEX => null,
32		self::TARGET_PATH_INDEX => null,
33		self::DEFAULT_FORMATTER_INDEX => self::DEFAULT_FORMATTER_NAME,
34		self::FORMATTERS_INDEX => array(),
35		self::FILE_EXTENSION_FORMATTERS_INDEX => array(),
36		self::GENERATOR_INDEX => array(),
37		);
38
39		$this->read($fs);
40		}
41
42		private function read(Filesystem $fs)
43		{
44		$profileFilename = Application::PROFILE_FILENAME;
45
46		if($fs->has($profileFilename))
47		{
48		$this->processProfileContent($fs->read($profileFilename));
49		}
50		}
51
52		private function processProfileContent($content)
53		{
54		try
55		{
56		$values = Yaml::parse($content);
57		}
58		catch(ParseException $e)
59		{
60		throw new \RuntimeException(sprintf(
61		'Error while parsing profile : %s',
62		$e->getMessage()
63		));
64		}
65
66		foreach(array_keys($this->attributes) as $name)
67		{
68		if(isset($values[$name]))
69		{
70		$this->attributes[$name] = $values[$name];
71		}
72		}
73		}
74
75		public function hasTemplatesSuffix()
76		{
77		return $this->hasString(self::TEMPLATE_SUFFIX_INDEX);
78		}
79
80		public function getTemplatesSuffix()
81		{
82		return $this->getString(self::TEMPLATE_SUFFIX_INDEX);
83		}
84
85		public function hasMasterFilename()
86		{
87		return $this->hasString(self::MASTER_FILENAME_INDEX);
88		}
89
90		public function getMasterFilename()
91		{
92		return $this->getString(self::MASTER_FILENAME_INDEX);
93		}
94
95		public function hasConfigurationDirectory()
96		{
97		return $this->hasString(self::CONFIGURATION_DIRECTORY_INDEX);
98		}
99
100		public function getConfigurationDirectory()
101		{
102		return $this->getString(self::CONFIGURATION_DIRECTORY_INDEX);
103		}
104
105		public function hasSourcePath()
106		{
107		return $this->has(self::SOURCE_PATH_INDEX);
108		}
109
110		public function getSourcePath()
111		{
112		return $this->get(self::SOURCE_PATH_INDEX);
113		}
114
115		public function hasTargetPath()
116		{
117		return $this->has(self::TARGET_PATH_INDEX);
118		}
119
120		public function getTargetPath()
121		{
122		return $this->get(self::TARGET_PATH_INDEX);
123		}
124
125		public function getDefaultFormatterName()
126		{
127		return $this->getString(self::DEFAULT_FORMATTER_INDEX);
128		}
129
130		public function getFormatters()
131		{
132		return $this->get(self::FORMATTERS_INDEX);
133		}
134
135		public function getFileExtensionFormatters()
136		{
137		return $this->get(self::FILE_EXTENSION_FORMATTERS_INDEX);
138		}
139
140		public function getGeneratorOptions()
141		{
142		return $this->get(self::GENERATOR_INDEX);
143		}
144
145		private function has($attributeName)
146		{
147		return isset($this->attributes[$attributeName]);
148		}
149
150		private function hasString($attributeName)
151		{
152		return isset($this->attributes[$attributeName]) && is_string($this->attributes[$attributeName]);
153		}
154
155	View Code Duplication	private function get($attributeName)
		0 ignored issues – show Duplication introduced 2015-12-04 15:18 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
156		{
157		$value = null;
158
159		if($this->has($attributeName))
160		{
161		$value = $this->attributes[$attributeName];
162		}
163
164		return $value;
165		}
166
167	View Code Duplication	private function getString($attributeName)
		0 ignored issues – show Duplication introduced 2015-12-04 15:18 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
168		{
169		$value = null;
170
171		if($this->hasString($attributeName))
172		{
173		$value = $this->attributes[$attributeName];
174		}
175
176		return $value;
177		}
178		}
179

Niktux / karma

Pull Request — master (#96)

ProfileReader::getGeneratorOptions() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like