FileStorage::delete() - Code Metrics - Inspection of "Update fileStorage for common 0.2 (#35)" - php-translation/symfony-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( f18b9d...e02934 )

by Tobias

created 2017-01-01 20:37 UTC

FileStorage::delete() A

↳ Parent: FileStorage

Complexity

Conditions	1
Paths	1

Size

Total Lines	9
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	9
ccs	0
cts	5
cp	0
rs	9.6666
c	0
b	0
f	0
cc	1
eloc	6
nc	1
nop	3
crap	2

<?php

/*
 * This file is part of the PHP Translation package.
 *
 * (c) PHP Translation team <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Translation\Bundle\Storage;

use Symfony\Bundle\FrameworkBundle\Translation\TranslationLoader;
use Symfony\Component\Translation\MessageCatalogue;
use Symfony\Component\Translation\Writer\TranslationWriter;
use Translation\Common\Model\Message;
use Translation\Common\Storage;

/**
 * This storage uses Symfony's writer and loader.
 *
 * @author Tobias Nyholm <[email protected]>
 */
class FileStorage implements Storage
{
    /**
     * @var TranslationWriter
     */
    private $writer;

    /**
     * @var TranslationLoader
     */
    private $loader;

    /**
     * @var string directory path
     */
    private $dir;

    /**
     * @var MessageCatalogue[] Fetched catalogies
     */
    private $catalogues;

    /**
     * @param TranslationWriter $writer
     * @param TranslationLoader $loader
     * @param array             $dir
     */
    public function __construct(TranslationWriter $writer, TranslationLoader $loader, $dir)
    {
        $this->writer = $writer;
        $this->loader = $loader;
        $this->dir = $dir;

    }

    /**
     * {@inheritdoc}
     */
    public function get($locale, $domain, $key)
    {
        $catalogue = $this->getCatalogue($locale);

        $translation = $catalogue->get($key, $domain);

        return new Message($key, $domain, $locale, $translation);
    }

    /**
     * {@inheritdoc}
     */
    public function create(Message $m)
    {
        $catalogue = $this->getCatalogue($m->getLocale());
        if (!$catalogue->defines($m->getKey(), $m->getDomain())) {
            $catalogue->set($m->getKey(), $m->getTranslation(), $m->getDomain());
            $this->writeCatalogue($catalogue, $m->getLocale(), $m->getDomain());
        }
    }

    /**
     * {@inheritdoc}
     */
    public function update(Message $m)
    {
        $catalogue = $this->getCatalogue($m->getLocale());
        $catalogue->set($m->getKey(), $m->getTranslation(), $m->getDomain());
        $this->writeCatalogue($catalogue, $m->getLocale(), $m->getDomain());
    }

    /**
     * {@inheritdoc}
     */
    public function delete($locale, $domain, $key)
    {
        $catalogue = $this->getCatalogue($locale);
        $messages = $catalogue->all($domain);
        unset($messages[$key]);

        $catalogue->replace($messages, $domain);
        $this->writeCatalogue($catalogue, $locale, $domain);
    }

    /**
     * Save catalogue back to file.
     *
     * @param MessageCatalogue $catalogue
     * @param string           $domain
     */
    private function writeCatalogue(MessageCatalogue $catalogue, $locale, $domain)
    {
        $resources = $catalogue->getResources();
        foreach ($resources as $resource) {
            $path = $resource->getResource();
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            if (preg_match('|/'.$domain.'\.'.$locale.'\.([a-z]+)$|', $path, $matches)) {
                $this->writer->writeTranslations($catalogue, $matches[1], ['path' => str_replace($matches[0], '', $path)]);
            }
        }
    }

    /**
     * @param string $locale
     *
     * @return MessageCatalogue
     */
    private function getCatalogue($locale)
    {
        if (empty($this->catalogues[$locale])) {
            $this->loadCatalogue($locale, [$this->dir]);
        }

        return $this->catalogues[$locale];
    }

    /**
     * Load catalogue from files.
     *
     * @param string $locale
     * @param array  $dirs
     */
    private function loadCatalogue($locale, array $dirs)
    {
        $currentCatalogue = new MessageCatalogue($locale);
        foreach ($dirs as $path) {
            if (is_dir($path)) {
                $this->loader->loadMessages($path, $currentCatalogue);
            }
        }

        $this->catalogues[$locale] = $currentCatalogue;
    }
}


1			<?php
2
3			/*
4			* This file is part of the PHP Translation package.
5			*
6			* (c) PHP Translation team <[email protected]>
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace Translation\Bundle\Storage;
13
14			use Symfony\Bundle\FrameworkBundle\Translation\TranslationLoader;
15			use Symfony\Component\Translation\MessageCatalogue;
16			use Symfony\Component\Translation\Writer\TranslationWriter;
17			use Translation\Common\Model\Message;
18			use Translation\Common\Storage;
19
20			/**
21			* This storage uses Symfony's writer and loader.
22			*
23			* @author Tobias Nyholm <[email protected]>
24			*/
25			class FileStorage implements Storage
26			{
27			/**
28			* @var TranslationWriter
29			*/
30			private $writer;
31
32			/**
33			* @var TranslationLoader
34			*/
35			private $loader;
36
37			/**
38			* @var string directory path
39			*/
40			private $dir;
41
42			/**
43			* @var MessageCatalogue[] Fetched catalogies
44			*/
45			private $catalogues;
46
47			/**
48			* @param TranslationWriter $writer
49			* @param TranslationLoader $loader
50			* @param array $dir
51			*/
52			public function __construct(TranslationWriter $writer, TranslationLoader $loader, $dir)
53			{
54			$this->writer = $writer;
55			$this->loader = $loader;
56			$this->dir = $dir;
			0 ignored issues – show Documentation Bug introduced 2016-12-05 10:09 UTC by Report Bug Copy Issue Report It seems like `$dir` of type `array` is incompatible with the declared type `string` of property `$dir`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
57			}
58
59			/**
60			* {@inheritdoc}
61			*/
62			public function get($locale, $domain, $key)
63			{
64			$catalogue = $this->getCatalogue($locale);
65
66			$translation = $catalogue->get($key, $domain);
67
68			return new Message($key, $domain, $locale, $translation);
69			}
70
71			/**
72			* {@inheritdoc}
73			*/
74			public function create(Message $m)
75			{
76			$catalogue = $this->getCatalogue($m->getLocale());
77			if (!$catalogue->defines($m->getKey(), $m->getDomain())) {
78			$catalogue->set($m->getKey(), $m->getTranslation(), $m->getDomain());
79			$this->writeCatalogue($catalogue, $m->getLocale(), $m->getDomain());
80			}
81			}
82
83			/**
84			* {@inheritdoc}
85			*/
86			public function update(Message $m)
87			{
88			$catalogue = $this->getCatalogue($m->getLocale());
89			$catalogue->set($m->getKey(), $m->getTranslation(), $m->getDomain());
90			$this->writeCatalogue($catalogue, $m->getLocale(), $m->getDomain());
91			}
92
93			/**
94			* {@inheritdoc}
95			*/
96			public function delete($locale, $domain, $key)
97			{
98			$catalogue = $this->getCatalogue($locale);
99			$messages = $catalogue->all($domain);
100			unset($messages[$key]);
101
102			$catalogue->replace($messages, $domain);
103			$this->writeCatalogue($catalogue, $locale, $domain);
104			}
105
106			/**
107			* Save catalogue back to file.
108			*
109			* @param MessageCatalogue $catalogue
110			* @param string $domain
111			*/
112			private function writeCatalogue(MessageCatalogue $catalogue, $locale, $domain)
113			{
114			$resources = $catalogue->getResources();
115			foreach ($resources as $resource) {
116			$path = $resource->getResource();
			0 ignored issues – show Bug introduced 2016-12-05 10:09 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Symfony\Component\Config...ource\ResourceInterface` as the method `getResource()` does only exist in the following implementations of said interface: `Symfony\Component\Config...\ClassExistenceResource`, `Symfony\Component\Config...ource\DirectoryResource`, `Symfony\Component\Config...e\FileExistenceResource`, `Symfony\Component\Config\Resource\FileResource`, `Symfony\Component\Depend...AutowireServiceResource`, `Symfony\Component\HttpKe...g\EnvParametersResource`, `Symfony\Component\Translation\Tests\StaleResource`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
117			if (preg_match('\|/'.$domain.'\.'.$locale.'\.([a-z]+)$\|', $path, $matches)) {
118			$this->writer->writeTranslations($catalogue, $matches[1], ['path' => str_replace($matches[0], '', $path)]);
119			}
120			}
121			}
122
123			/**
124			* @param string $locale
125			*
126			* @return MessageCatalogue
127			*/
128			private function getCatalogue($locale)
129			{
130			if (empty($this->catalogues[$locale])) {
131			$this->loadCatalogue($locale, [$this->dir]);
132			}
133
134			return $this->catalogues[$locale];
135			}
136
137			/**
138			* Load catalogue from files.
139			*
140			* @param string $locale
141			* @param array $dirs
142			*/
143			private function loadCatalogue($locale, array $dirs)
144			{
145			$currentCatalogue = new MessageCatalogue($locale);
146			foreach ($dirs as $path) {
147			if (is_dir($path)) {
148			$this->loader->loadMessages($path, $currentCatalogue);
149			}
150			}
151
152			$this->catalogues[$locale] = $currentCatalogue;
153			}
154			}
155

php-translation / symfony-bundle

Push — master ( f18b9d...e02934 )

FileStorage::delete() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like