Configurator::withFileReader() - Code Metrics - Inspection of "Configurator now has per-instance fileReaders arra..." - tomphp/container-configurator - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#76)

unknown

created 2016-10-11 15:49 UTC

Configurator::withFileReader() A

↳ Parent: Configurator

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	6
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	3
nc	1
nop	2

<?php

namespace TomPHP\ContainerConfigurator;

use Assert\Assertion;
use InvalidArgumentException;
use TomPHP\ContainerConfigurator\Exception\NoMatchingFilesException;
use TomPHP\ContainerConfigurator\Exception\UnknownSettingException;

final class Configurator
{
    const SETTING_PREFIX                     = 'config_prefix';
    const SETTING_SEPARATOR                  = 'config_separator';
    const SETTING_SERVICES_KEY               = 'services_key';
    const SETTING_INFLECTORS_KEY             = 'inflectors_key';
    const SETTING_DEFAULT_SINGLETON_SERVICES = 'default_singleton_services';

    const FILE_READERS = [
        '.json' => FileReader\JSONFileReader::class,
        '.php'  => FileReader\PHPFileReader::class,
        '.yaml' => FileReader\YAMLFileReader::class,
        '.yml'  => FileReader\YAMLFileReader::class,
    ];

    const CONTAINER_ADAPTERS = [
        \League\Container\Container::class => League\LeagueContainerAdapter::class,
        \Pimple\Container::class           => Pimple\PimpleContainerAdapter::class,
    ];

    /**
     * @var ApplicationConfig
     */
    private $config;

    /**
     * @var FileReader\ReaderFactory
     */
    private $readerFactory;

    /**
     * @var mixed[]
     */
    private $settings = [
        self::SETTING_PREFIX                     => 'config',
        self::SETTING_SEPARATOR                  => '.',
        self::SETTING_SERVICES_KEY               => 'di.services',
        self::SETTING_INFLECTORS_KEY             => 'di.inflectors',
        self::SETTING_DEFAULT_SINGLETON_SERVICES => false,
    ];

    /**
     * @var string[]
     */
    private $fileReaders = self::FILE_READERS;

    /**
     * @var string
     */
    private static $containerIdentifier;

    /**
     * @api
     *
     * @return Configurator
     */
    public static function apply()
    {
        return new self();
    }

    private function __construct()
    {
        $this->config = new ApplicationConfig([]);
    }

    /**
     * @api
     *
     * @return string
     */
    public static function container()
    {
        if (!self::$containerIdentifier) {
            self::$containerIdentifier = uniqid(__CLASS__ . '::CONTAINER_ID::');
        }

        return self::$containerIdentifier;
    }

    /**
     * @api
     *
     * @param array $config
     *
     * @return $this
     */
    public function configFromArray(array $config)
    {
        $this->config->merge($config);

        return $this;
    }

    /**
     * @api
     *
     * @param string $filename
     *
     * @throws InvalidArgumentException
     *
     * @return $this
     */
    public function configFromFile($filename)
    {
        Assertion::file($filename);

        $this->readFileAndMergeConfig($filename);

        return $this;
    }

    /**
     * @api
     *
     * @param string $pattern
     *
     * @throws NoMatchingFilesException
     * @throws InvalidArgumentException
     *
     * @return $this
     */
    public function configFromFiles($pattern)
    {
        Assertion::string($pattern);

        $locator = new FileReader\FileLocator();

        $files = $locator->locate($pattern);

        if (count($files) === 0) {
            throw NoMatchingFilesException::fromPattern($pattern);
        }

        foreach ($files as $filename) {
            $this->readFileAndMergeConfig($filename);
        }

        return $this;
    }

    /**
     * @api
     *
     * @param string $name
     * @param mixed  $value
     *
     * @throws UnknownSettingException
     * @throws InvalidArgumentException
     *
     * @return $this
     */
    public function withSetting($name, $value)
    {
        Assertion::string($name);
        Assertion::scalar($value);

        if (!array_key_exists($name, $this->settings)) {
            throw UnknownSettingException::fromSetting($name, array_keys($this->settings));
        }

        $this->settings[$name] = $value;

        return $this;
    }

    /**
     * @param string $extension
     * @param string $className
     *
     * @return $this
     */
    public function withFileReader($extension, $className)
    {
        $this->fileReaders[$extension] = $className;

        return $this;
    }

    /**
     * @api
     *
     * @param object $container
     *
     * @return void
     */
    public function to($container)
    {
        $this->config->setSeparator($this->settings[self::SETTING_SEPARATOR]);

        $factory = new ContainerAdapterFactory(self::CONTAINER_ADAPTERS);

        $configurator = $factory->create($container);

        $configurator->addApplicationConfig($this->config, $this->settings[self::SETTING_PREFIX]);

        if (isset($this->config[$this->settings[self::SETTING_SERVICES_KEY]])) {

            $configurator->addServiceConfig(new ServiceConfig(
                $this->config[$this->settings[self::SETTING_SERVICES_KEY]],
                $this->settings[self::SETTING_DEFAULT_SINGLETON_SERVICES]
            ));
        }

        if (isset($this->config[$this->settings[self::SETTING_INFLECTORS_KEY]])) {

            $configurator->addInflectorConfig(new InflectorConfig(
                $this->config[$this->settings[self::SETTING_INFLECTORS_KEY]]
            ));
        }
    }

    /**
     * @param string $filename
     *
     * @return void
     */
    private function readFileAndMergeConfig($filename)
    {
        $reader = $this->getReaderFor($filename);

        $this->config->merge($reader->read($filename));
    }

    /**
     * @param string $filename
     *
     * @return FileReader\FileReader
     */
    private function getReaderFor($filename)
    {
        if (!$this->readerFactory) {
            $this->readerFactory = new FileReader\ReaderFactory($this->fileReaders);
        }

        return $this->readerFactory->create($filename);
    }
}


1		<?php
2
3		namespace TomPHP\ContainerConfigurator;
4
5		use Assert\Assertion;
6		use InvalidArgumentException;
7		use TomPHP\ContainerConfigurator\Exception\NoMatchingFilesException;
8		use TomPHP\ContainerConfigurator\Exception\UnknownSettingException;
9
10		final class Configurator
11		{
12		const SETTING_PREFIX = 'config_prefix';
13		const SETTING_SEPARATOR = 'config_separator';
14		const SETTING_SERVICES_KEY = 'services_key';
15		const SETTING_INFLECTORS_KEY = 'inflectors_key';
16		const SETTING_DEFAULT_SINGLETON_SERVICES = 'default_singleton_services';
17
18		const FILE_READERS = [
19		'.json' => FileReader\JSONFileReader::class,
20		'.php' => FileReader\PHPFileReader::class,
21		'.yaml' => FileReader\YAMLFileReader::class,
22		'.yml' => FileReader\YAMLFileReader::class,
23		];
24
25		const CONTAINER_ADAPTERS = [
26		\League\Container\Container::class => League\LeagueContainerAdapter::class,
27		\Pimple\Container::class => Pimple\PimpleContainerAdapter::class,
28		];
29
30		/**
31		* @var ApplicationConfig
32		*/
33		private $config;
34
35		/**
36		* @var FileReader\ReaderFactory
37		*/
38		private $readerFactory;
39
40		/**
41		* @var mixed[]
42		*/
43		private $settings = [
44		self::SETTING_PREFIX => 'config',
45		self::SETTING_SEPARATOR => '.',
46		self::SETTING_SERVICES_KEY => 'di.services',
47		self::SETTING_INFLECTORS_KEY => 'di.inflectors',
48		self::SETTING_DEFAULT_SINGLETON_SERVICES => false,
49		];
50
51		/**
52		* @var string[]
53		*/
54		private $fileReaders = self::FILE_READERS;
55
56		/**
57		* @var string
58		*/
59		private static $containerIdentifier;
60
61		/**
62		* @api
63		*
64		* @return Configurator
65		*/
66		public static function apply()
67		{
68		return new self();
69		}
70
71		private function __construct()
72		{
73		$this->config = new ApplicationConfig([]);
74		}
75
76		/**
77		* @api
78		*
79		* @return string
80		*/
81		public static function container()
82		{
83		if (!self::$containerIdentifier) {
84		self::$containerIdentifier = uniqid(__CLASS__ . '::CONTAINER_ID::');
85		}
86
87		return self::$containerIdentifier;
88		}
89
90		/**
91		* @api
92		*
93		* @param array $config
94		*
95		* @return $this
96		*/
97		public function configFromArray(array $config)
98		{
99		$this->config->merge($config);
100
101		return $this;
102		}
103
104		/**
105		* @api
106		*
107		* @param string $filename
108		*
109		* @throws InvalidArgumentException
110		*
111		* @return $this
112		*/
113		public function configFromFile($filename)
114		{
115		Assertion::file($filename);
116
117		$this->readFileAndMergeConfig($filename);
118
119		return $this;
120		}
121
122		/**
123		* @api
124		*
125		* @param string $pattern
126		*
127		* @throws NoMatchingFilesException
128		* @throws InvalidArgumentException
129		*
130		* @return $this
131		*/
132		public function configFromFiles($pattern)
133		{
134		Assertion::string($pattern);
135
136		$locator = new FileReader\FileLocator();
137
138		$files = $locator->locate($pattern);
139
140		if (count($files) === 0) {
141		throw NoMatchingFilesException::fromPattern($pattern);
142		}
143
144		foreach ($files as $filename) {
145		$this->readFileAndMergeConfig($filename);
146		}
147
148		return $this;
149		}
150
151		/**
152		* @api
153		*
154		* @param string $name
155		* @param mixed $value
156		*
157		* @throws UnknownSettingException
158		* @throws InvalidArgumentException
159		*
160		* @return $this
161		*/
162		public function withSetting($name, $value)
163		{
164		Assertion::string($name);
165		Assertion::scalar($value);
166
167		if (!array_key_exists($name, $this->settings)) {
168		throw UnknownSettingException::fromSetting($name, array_keys($this->settings));
169		}
170
171		$this->settings[$name] = $value;
172
173		return $this;
174		}
175
176		/**
177		* @param string $extension
178		* @param string $className
179		*
180		* @return $this
181		*/
182		public function withFileReader($extension, $className)
183		{
184		$this->fileReaders[$extension] = $className;
185
186		return $this;
187		}
188
189		/**
190		* @api
191		*
192		* @param object $container
193		*
194		* @return void
195		*/
196		public function to($container)
197		{
198		$this->config->setSeparator($this->settings[self::SETTING_SEPARATOR]);
199
200		$factory = new ContainerAdapterFactory(self::CONTAINER_ADAPTERS);
201
202		$configurator = $factory->create($container);
203
204		$configurator->addApplicationConfig($this->config, $this->settings[self::SETTING_PREFIX]);
205
206	View Code Duplication	if (isset($this->config[$this->settings[self::SETTING_SERVICES_KEY]])) {
		0 ignored issues – show Duplication introduced 2016-09-13 08:26 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
207		$configurator->addServiceConfig(new ServiceConfig(
208		$this->config[$this->settings[self::SETTING_SERVICES_KEY]],
209		$this->settings[self::SETTING_DEFAULT_SINGLETON_SERVICES]
210		));
211		}
212
213	View Code Duplication	if (isset($this->config[$this->settings[self::SETTING_INFLECTORS_KEY]])) {
		0 ignored issues – show Duplication introduced 2016-09-13 08:26 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
214		$configurator->addInflectorConfig(new InflectorConfig(
215		$this->config[$this->settings[self::SETTING_INFLECTORS_KEY]]
216		));
217		}
218		}
219
220		/**
221		* @param string $filename
222		*
223		* @return void
224		*/
225		private function readFileAndMergeConfig($filename)
226		{
227		$reader = $this->getReaderFor($filename);
228
229		$this->config->merge($reader->read($filename));
230		}
231
232		/**
233		* @param string $filename
234		*
235		* @return FileReader\FileReader
236		*/
237		private function getReaderFor($filename)
238		{
239		if (!$this->readerFactory) {
240		$this->readerFactory = new FileReader\ReaderFactory($this->fileReaders);
241		}
242
243		return $this->readerFactory->create($filename);
244		}
245		}
246

tomphp / container-configurator

Pull Request — master (#76)

Configurator::withFileReader() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like