Application::initializeSourceFileSystem() - 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-04 18:49 UTC

Application::initializeSourceFileSystem() A

↳ Parent: Application

Complexity

Conditions	4
Paths	1

Size

Total Lines	57
Code Lines	28

Duplication

Lines	0
Ratio	0 %

Importance

Changes	4
Bugs	1	Features	1

Metric	Value
c	4
b	1
f	1
dl	0
loc	57
rs	9.0309
cc	4
eloc	28
nc	1
nop	0

How to fix Long Method

<?php

namespace Karma;

use Karma\Configuration\Reader;
use Karma\Configuration\Parser;
use Gaufrette\Filesystem;
use Gaufrette\Adapter\Local;
use Gaufrette\Adapter\Cache;
use Karma\VCS\Vcs;
use Karma\VCS\Git;
use Karma\VCS\Git\GitWrapperAdapter;
use Karma\FormatterProviders\ProfileProvider;
use Karma\Generator\NameTranslators\FilePrefixTranslator;
use Karma\Generator\VariableProvider;
use Karma\Generator\ConfigurationFileGenerators\YamlGenerator;
use Karma\Filesystem\Adapters\MultipleAdapter;

class Application extends \Pimple
{
    const
        VERSION = '5.4.0',
        DEFAULT_DISTFILE_SUFFIX = '-dist',
        DEFAULT_CONF_DIRECTORY = 'env',
        DEFAULT_MASTER_FILE = 'master.conf',
        BACKUP_SUFFIX = '~',
        FINDER_CACHE_DIRECTORY = 'cache/karma',
        FINDER_CACHE_DURATION = 86400,
        PROFILE_FILENAME = '.karma';

    public function __construct()
    {
        parent::__construct();

        $this->initializeParameters();
class User
{
    private $email;

    public function getEmail()
    {
        return $this->email;
    }

    public function setEmail($email)
    {
        $this->email = $email;
    }
}

        $this->initializeConfiguration();
        $this->initializeProfile();
        $this->initializeFinder();
class User
{
    private $email;

    public function getEmail()
    {
        return $this->email;
    }

    public function setEmail($email)
    {
        $this->email = $email;
    }
}
        $this->initializeSourceFileSystem();
class User
{
    private $email;

    public function getEmail()
    {
        return $this->email;
    }

    public function setEmail($email)
    {
        $this->email = $email;
    }
}
        $this->initializeVcs();

        $this->initializeServices();
    }

    private function initializeParameters()
    {
        $this['configuration.path'] = 'conf';
        $this['configuration.masterFile'] = 'master.conf';

        $this['sources.path'] = 'src';
        $this['target.path'] = null;
        $this['hydrator.allowNonDistFilesOverwrite'] = false;

        $this['distFiles.suffix'] = '-dist';
    }

    private function initializeConfiguration()
    {
        $this['configuration.fileSystem.adapter'] = function($c) {
            return new Local($c['configuration.path']);
        };

        $this['configuration.fileSystem'] = function($c) {
            return new Filesystem($c['configuration.fileSystem.adapter']);
        };

        $this['parser'] = $this->share(function($c) {
            $parser = new Parser($c['configuration.fileSystem']);

            $parser->enableIncludeSupport()
                ->enableExternalSupport()
                ->enableGroupSupport()
                ->setLogger($c['logger'])
                ->parse($c['configuration.masterFile']);

            return $parser;
        });

        $this['configuration'] = $this->share(function($c) {
            $parser = $c['parser'];

            return new Reader(
                $parser->getVariables(),
                $parser->getExternalVariables(),
                $parser->getGroups(),
                $parser->getDefaultEnvironmentsForGroups()
            );
        });
    }

    private function initializeProfile()
    {
        $this['profile.fileSystem.adapter'] = function($c) {

            return new Local(getcwd());
        };

        $this['profile.fileSystem'] = function($c) {
            return new Filesystem($c['profile.fileSystem.adapter']);
        };

        $this['profile'] = $this->share(function($c) {
            return new ProfileReader($c['profile.fileSystem']);
        });
    }

    private function initializeSourceFileSystem()
    {
        $this['sources.fileSystem.adapter'] = function($c) {
            
            $paths = $c['sources.path'];
            
            if(! is_array($paths))
            {
                $paths = array($paths);
            }
            
            $adapter = new MultipleAdapter();
             
            foreach($paths as $path)
            {
                $adapter->mount($path, new Local($path));
            }

            return $adapter;
        };

        $this['target.fileSystem.adapter'] = function($c) {

            if(! empty($c['target.path']))
            {
                $c['hydrator.allowNonDistFilesOverwrite'] = true;

                return new Local($c['target.path']);
            }

            return $this['sources.fileSystem.adapter'];
        };

        $this['target.fileSystem'] = function($c) {
            return new Filesystem($c['target.fileSystem.adapter']);
        };

        $this['sources.fileSystem'] = function($c) {
            return new Filesystem($c['sources.fileSystem.adapter']);
        };

        $this['sources.fileSystem.finder'] = function($c) {
            return $c['sources.fileSystem'];
        };

        $this['sources.fileSystem.cached'] = function($c) {
            $cache = $c['finder.cache.adapter'];
            $adapter = new Cache(
                $c['sources.fileSystem.adapter'],
                $cache,
                $c['finder.cache.duration'],
                $cache
            );

            return new Filesystem($adapter);
        };
    }

    private function initializeFinder()
    {
        $this['finder.cache.path'] = self::FINDER_CACHE_DIRECTORY;
        $this['finder.cache.duration'] = self::FINDER_CACHE_DURATION;

        $this['finder'] = function($c) {

            return new Finder($this['sources.fileSystem.finder']);
        };

        $this['finder.cache.adapter'] = function($c) {
            return new Local($c['finder.cache.path'], true);
        };
    }

    private function initializeVcs()
    {
        $this['rootPath'] = getcwd();

        $this['vcs.fileSystem.adapter'] = function($c) {
            return new Local($c['rootPath']);
        };

        $this['vcs.fileSystem'] = function($c) {
            return new Filesystem($c['vcs.fileSystem.adapter']);
        };

        $this['git.command'] = function($c) {

            return new GitWrapperAdapter();
        };

        $git = function($c) {

            return new Git($this['vcs.fileSystem'], $this['rootPath'], $this['git.command']);
        };

        $this['git'] = $git;
        $this['vcs'] = $git;

        $this['vcsHandler'] = $this->protect(function (Vcs $vcs) {
            $handler = new VcsHandler($vcs, $this['finder']);

            $handler->setLogger($this['logger'])
                ->setSuffix($this['distFiles.suffix']);

            return $handler;
        });
    }

    private function initializeServices()
    {
        $this['logger'] = $this->share(function($c) {

            return new \Psr\Log\NullLogger();
        });

        $this['formatter.provider'] = $this->share(function ($c) {
            return new ProfileProvider($c['profile']);
        });

        $this['hydrator'] = function($c) {
            $hydrator = new Hydrator($c['sources.fileSystem'], $c['target.fileSystem'], $c['configuration'], $c['finder'], $c['formatter.provider']);
            $hydrator->allowNonDistFilesOverwrite($c['hydrator.allowNonDistFilesOverwrite']);

            $hydrator->setLogger($c['logger'])
                ->setSuffix($c['distFiles.suffix']);

            return $hydrator;
        };

        $this['generator.nameTranslator'] = $this->share(function ($c) {
            $translator = new FilePrefixTranslator();
            $translator->changeMasterFile($c['configuration.masterFile']);

            return $translator;
        });

        $this['generator.variableProvider'] = function ($c) {
            $provider = new VariableProvider($c['parser'], $c['configuration.masterFile']);


            $profile = $c['profile'];
            $options = $profile->getGeneratorOptions();
            if(! isset($options['translator']) || $options['translator'] === 'prefix')
            {
                $provider->setNameTranslator($c['generator.nameTranslator']);
            }

            return $provider;
        };

        $this['configurationFilesGenerator'] = $this->share(function ($c) {
            return new YamlGenerator($c['sources.fileSystem'], $c['configuration'], $c['generator.variableProvider']);
        });
    }
}


1			<?php
2
3			namespace Karma;
4
5			use Karma\Configuration\Reader;
6			use Karma\Configuration\Parser;
7			use Gaufrette\Filesystem;
8			use Gaufrette\Adapter\Local;
9			use Gaufrette\Adapter\Cache;
10			use Karma\VCS\Vcs;
11			use Karma\VCS\Git;
12			use Karma\VCS\Git\GitWrapperAdapter;
13			use Karma\FormatterProviders\ProfileProvider;
14			use Karma\Generator\NameTranslators\FilePrefixTranslator;
15			use Karma\Generator\VariableProvider;
16			use Karma\Generator\ConfigurationFileGenerators\YamlGenerator;
17			use Karma\Filesystem\Adapters\MultipleAdapter;
18
19			class Application extends \Pimple
20			{
21			const
22			VERSION = '5.4.0',
23			DEFAULT_DISTFILE_SUFFIX = '-dist',
24			DEFAULT_CONF_DIRECTORY = 'env',
25			DEFAULT_MASTER_FILE = 'master.conf',
26			BACKUP_SUFFIX = '~',
27			FINDER_CACHE_DIRECTORY = 'cache/karma',
28			FINDER_CACHE_DURATION = 86400,
29			PROFILE_FILENAME = '.karma';
30
31			public function __construct()
32			{
33			parent::__construct();
34
35			$this->initializeParameters();
			0 ignored issues – show Unused Code introduced 2015-12-04 15:18 UTC by Report Bug Copy Issue Report The call to the method `Karma\Application::initializeParameters()` seems un-needed as the method has no side-effects. PHP Analyzer performs a side-effects analysis of your code. A side-effect is basically anything that might be visible after the scope of the method is left. Let’s take a look at an example: class User { private $email; public function getEmail() { return $this->email; } public function setEmail($email) { $this->email = $email; } } If we look at the `getEmail()` method, we can see that it has no side-effect. Whether you call this method or not, no future calls to other methods are affected by this. As such code as the following is useless: $user = new User(); $user->getEmail(); // This line could safely be removed as it has no effect. On the hand, if we look at the `setEmail()`, this method _has_ side-effects. In the following case, we could not remove the method call: $user = new User(); $user->setEmail('email@domain'); // This line has a side-effect (it changes an // instance variable). Loading history...
36
37			$this->initializeConfiguration();
38			$this->initializeProfile();
39			$this->initializeFinder();
			0 ignored issues – show Unused Code introduced 2015-12-04 15:18 UTC by Report Bug Copy Issue Report The call to the method `Karma\Application::initializeFinder()` seems un-needed as the method has no side-effects. PHP Analyzer performs a side-effects analysis of your code. A side-effect is basically anything that might be visible after the scope of the method is left. Let’s take a look at an example: class User { private $email; public function getEmail() { return $this->email; } public function setEmail($email) { $this->email = $email; } } If we look at the `getEmail()` method, we can see that it has no side-effect. Whether you call this method or not, no future calls to other methods are affected by this. As such code as the following is useless: $user = new User(); $user->getEmail(); // This line could safely be removed as it has no effect. On the hand, if we look at the `setEmail()`, this method _has_ side-effects. In the following case, we could not remove the method call: $user = new User(); $user->setEmail('email@domain'); // This line has a side-effect (it changes an // instance variable). Loading history...
40			$this->initializeSourceFileSystem();
			0 ignored issues – show Unused Code introduced 2015-12-04 15:18 UTC by Report Bug Copy Issue Report The call to the method `Karma\Application::initializeSourceFileSystem()` seems un-needed as the method has no side-effects. PHP Analyzer performs a side-effects analysis of your code. A side-effect is basically anything that might be visible after the scope of the method is left. Let’s take a look at an example: class User { private $email; public function getEmail() { return $this->email; } public function setEmail($email) { $this->email = $email; } } If we look at the `getEmail()` method, we can see that it has no side-effect. Whether you call this method or not, no future calls to other methods are affected by this. As such code as the following is useless: $user = new User(); $user->getEmail(); // This line could safely be removed as it has no effect. On the hand, if we look at the `setEmail()`, this method _has_ side-effects. In the following case, we could not remove the method call: $user = new User(); $user->setEmail('email@domain'); // This line has a side-effect (it changes an // instance variable). Loading history...
41			$this->initializeVcs();
42
43			$this->initializeServices();
44			}
45
46			private function initializeParameters()
47			{
48			$this['configuration.path'] = 'conf';
49			$this['configuration.masterFile'] = 'master.conf';
50
51			$this['sources.path'] = 'src';
52			$this['target.path'] = null;
53			$this['hydrator.allowNonDistFilesOverwrite'] = false;
54
55			$this['distFiles.suffix'] = '-dist';
56			}
57
58			private function initializeConfiguration()
59			{
60			$this['configuration.fileSystem.adapter'] = function($c) {
61			return new Local($c['configuration.path']);
62			};
63
64			$this['configuration.fileSystem'] = function($c) {
65			return new Filesystem($c['configuration.fileSystem.adapter']);
66			};
67
68			$this['parser'] = $this->share(function($c) {
69			$parser = new Parser($c['configuration.fileSystem']);
70
71			$parser->enableIncludeSupport()
72			->enableExternalSupport()
73			->enableGroupSupport()
74			->setLogger($c['logger'])
75			->parse($c['configuration.masterFile']);
76
77			return $parser;
78			});
79
80			$this['configuration'] = $this->share(function($c) {
81			$parser = $c['parser'];
82
83			return new Reader(
84			$parser->getVariables(),
85			$parser->getExternalVariables(),
86			$parser->getGroups(),
87			$parser->getDefaultEnvironmentsForGroups()
88			);
89			});
90			}
91
92			private function initializeProfile()
93			{
94			$this['profile.fileSystem.adapter'] = function($c) {
			0 ignored issues – show Unused Code introduced 2015-12-04 15:18 UTC by Report Bug Copy Issue Report The parameter `$c` 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...
95			return new Local(getcwd());
96			};
97
98			$this['profile.fileSystem'] = function($c) {
99			return new Filesystem($c['profile.fileSystem.adapter']);
100			};
101
102			$this['profile'] = $this->share(function($c) {
103			return new ProfileReader($c['profile.fileSystem']);
104			});
105			}
106
107			private function initializeSourceFileSystem()
108			{
109			$this['sources.fileSystem.adapter'] = function($c) {
110
111			$paths = $c['sources.path'];
112
113			if(! is_array($paths))
114			{
115			$paths = array($paths);
116			}
117
118			$adapter = new MultipleAdapter();
119
120			foreach($paths as $path)
121			{
122			$adapter->mount($path, new Local($path));
123			}
124
125			return $adapter;
126			};
127
128			$this['target.fileSystem.adapter'] = function($c) {
129
130			if(! empty($c['target.path']))
131			{
132			$c['hydrator.allowNonDistFilesOverwrite'] = true;
133
134			return new Local($c['target.path']);
135			}
136
137			return $this['sources.fileSystem.adapter'];
138			};
139
140			$this['target.fileSystem'] = function($c) {
141			return new Filesystem($c['target.fileSystem.adapter']);
142			};
143
144			$this['sources.fileSystem'] = function($c) {
145			return new Filesystem($c['sources.fileSystem.adapter']);
146			};
147
148			$this['sources.fileSystem.finder'] = function($c) {
149			return $c['sources.fileSystem'];
150			};
151
152			$this['sources.fileSystem.cached'] = function($c) {
153			$cache = $c['finder.cache.adapter'];
154			$adapter = new Cache(
155			$c['sources.fileSystem.adapter'],
156			$cache,
157			$c['finder.cache.duration'],
158			$cache
159			);
160
161			return new Filesystem($adapter);
162			};
163			}
164
165			private function initializeFinder()
166			{
167			$this['finder.cache.path'] = self::FINDER_CACHE_DIRECTORY;
168			$this['finder.cache.duration'] = self::FINDER_CACHE_DURATION;
169
170			$this['finder'] = function($c) {
			0 ignored issues – show Unused Code introduced 2015-12-04 15:18 UTC by Report Bug Copy Issue Report The parameter `$c` 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...
171			return new Finder($this['sources.fileSystem.finder']);
172			};
173
174			$this['finder.cache.adapter'] = function($c) {
175			return new Local($c['finder.cache.path'], true);
176			};
177			}
178
179			private function initializeVcs()
180			{
181			$this['rootPath'] = getcwd();
182
183			$this['vcs.fileSystem.adapter'] = function($c) {
184			return new Local($c['rootPath']);
185			};
186
187			$this['vcs.fileSystem'] = function($c) {
188			return new Filesystem($c['vcs.fileSystem.adapter']);
189			};
190
191			$this['git.command'] = function($c) {
			0 ignored issues – show Unused Code introduced 2015-12-04 15:18 UTC by Report Bug Copy Issue Report The parameter `$c` 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...
192			return new GitWrapperAdapter();
193			};
194
195			$git = function($c) {
			0 ignored issues – show Unused Code introduced 2015-12-04 15:18 UTC by Report Bug Copy Issue Report The parameter `$c` 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...
196			return new Git($this['vcs.fileSystem'], $this['rootPath'], $this['git.command']);
197			};
198
199			$this['git'] = $git;
200			$this['vcs'] = $git;
201
202			$this['vcsHandler'] = $this->protect(function (Vcs $vcs) {
203			$handler = new VcsHandler($vcs, $this['finder']);
204
205			$handler->setLogger($this['logger'])
206			->setSuffix($this['distFiles.suffix']);
207
208			return $handler;
209			});
210			}
211
212			private function initializeServices()
213			{
214			$this['logger'] = $this->share(function($c) {
			0 ignored issues – show Unused Code introduced 2015-12-04 15:18 UTC by Report Bug Copy Issue Report The parameter `$c` 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...
215			return new \Psr\Log\NullLogger();
216			});
217
218			$this['formatter.provider'] = $this->share(function ($c) {
219			return new ProfileProvider($c['profile']);
220			});
221
222			$this['hydrator'] = function($c) {
223			$hydrator = new Hydrator($c['sources.fileSystem'], $c['target.fileSystem'], $c['configuration'], $c['finder'], $c['formatter.provider']);
224			$hydrator->allowNonDistFilesOverwrite($c['hydrator.allowNonDistFilesOverwrite']);
225
226			$hydrator->setLogger($c['logger'])
227			->setSuffix($c['distFiles.suffix']);
228
229			return $hydrator;
230			};
231
232			$this['generator.nameTranslator'] = $this->share(function ($c) {
233			$translator = new FilePrefixTranslator();
234			$translator->changeMasterFile($c['configuration.masterFile']);
235
236			return $translator;
237			});
238
239			$this['generator.variableProvider'] = function ($c) {
240			$provider = new VariableProvider($c['parser'], $c['configuration.masterFile']);
			0 ignored issues – show Unused Code introduced 2015-12-04 15:18 UTC by Report Bug Copy Issue Report The call to `VariableProvider::__construct()` has too many arguments starting with `$c['configuration.masterFile']`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
241
242			$profile = $c['profile'];
243			$options = $profile->getGeneratorOptions();
244			if(! isset($options['translator']) \|\| $options['translator'] === 'prefix')
245			{
246			$provider->setNameTranslator($c['generator.nameTranslator']);
247			}
248
249			return $provider;
250			};
251
252			$this['configurationFilesGenerator'] = $this->share(function ($c) {
253			return new YamlGenerator($c['sources.fileSystem'], $c['configuration'], $c['generator.variableProvider']);
254			});
255			}
256			}
257

Niktux / karma

Pull Request — master (#96)

Application::initializeSourceFileSystem() A

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like