FunctionsScanner::saveGettextFunctions() - Code Metrics - Inspection of "Refactoring twig test fix" - oscarotero/Gettext - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#222)

by Mārtiņš

created 2019-09-05 14:31 UTC

FunctionsScanner::saveGettextFunctions() C

↳ Parent: FunctionsScanner

Complexity

Conditions	12
Paths	17

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	12
nc	17
nop	2
dl	0
loc	50
rs	6.9666
c	0
b	0
f	0

How to fix Complexity

<?php

namespace Gettext\Utils;

use Exception;
use Gettext\Translations;

abstract class FunctionsScanner
{
    /**
     * Scan and returns the functions and the arguments.
     *
     * @param array $constants Constants used in the code to replace
     *
     * @return array
     */
    abstract public function getFunctions(array $constants = []);

    /**
     * Search for specific functions and create translations.
     *
     * @param Translations $translations The translations instance where save the values
     * @param array $options The extractor options
     * @throws Exception
     */
    public function saveGettextFunctions(Translations $translations, array $options)
    {
        $functions = $options['functions'];
        $file = $options['file'];

        foreach ($this->getFunctions($options['constants']) as $function) {
            list($name, $line, $args) = $function;

            if (isset($options['lineOffset'])) {
                $line += $options['lineOffset'];
            }

            if (!isset($functions[$name])) {
                continue;
            }

            $deconstructed = $this->deconstructArgs($functions[$name], $args);

            if (!$deconstructed) {
                continue;
            }

            list($domain, $context, $original, $plural) = $deconstructed;

            if ((string)$original === '') {
                continue;
            }

            $isDefaultDomain = $domain === null;
            $isMatchingDomain = $domain === $translations->getDomain();

            if (!empty($options['domainOnly']) && $isDefaultDomain) {
                // If we want to find translations for a specific domain, skip default domain messages
                continue;
            }

            if (!$isDefaultDomain && !$isMatchingDomain) {
                continue;
            }

            $translation = $translations->insert($context, $original, $plural);
            $translation->addReference($file, $line);

            if (isset($function[3])) {
                foreach ($function[3] as $extractedComment) {
                    $translation->addExtractedComment($extractedComment);
                }
            }
        }
    }

    /**
     * Deconstruct arguments to translation values
     *
     * @param $function
     * @param $args
     * @return array|null
     * @throws Exception
     */
    private function deconstructArgs($function, $args)
    {
        $domain = null;
        $context = null;
        $original = null;
        $plural = null;

        switch ($function) {
            case 'noop':
            case 'gettext':
                if (!isset($args[0])) {
                    return null;
                }

                $original = $args[0];
                break;
            case 'ngettext':
                if (!isset($args[1])) {
                    return null;
                }

                list($original, $plural) = $args;
                break;
            case 'pgettext':
                if (!isset($args[1])) {
                    return null;
                }

                list($context, $original) = $args;
                break;
            case 'dgettext':
                if (!isset($args[1])) {
                    return null;
                }

                list($domain, $original) = $args;
                break;
            case 'dpgettext':
                if (!isset($args[2])) {
                    return null;
                }

                list($domain, $context, $original) = $args;
                break;
            case 'npgettext':
                if (!isset($args[2])) {
                    return null;
                }

                list($context, $original, $plural) = $args;
                break;
            case 'dnpgettext':
                if (!isset($args[3])) {
                    return null;
                }

                list($domain, $context, $original, $plural) = $args;
                break;
            case 'dngettext':
                if (!isset($args[2])) {
                    return null;
                }

                list($domain, $original, $plural) = $args;
                break;
            default:
                throw new Exception(sprintf('Not valid function %s', $function));
        }

        return [$domain, $context, $original, $plural];
    }
}


1			<?php
2
3			namespace Gettext\Utils;
4
5			use Exception;
6			use Gettext\Translations;
7
8			abstract class FunctionsScanner
9			{
10			/**
11			* Scan and returns the functions and the arguments.
12			*
13			* @param array $constants Constants used in the code to replace
14			*
15			* @return array
16			*/
17			abstract public function getFunctions(array $constants = []);
18
19			/**
20			* Search for specific functions and create translations.
21			*
22			* @param Translations $translations The translations instance where save the values
23			* @param array $options The extractor options
24			* @throws Exception
25			*/
26			public function saveGettextFunctions(Translations $translations, array $options)
27			{
28			$functions = $options['functions'];
29			$file = $options['file'];
30
31			foreach ($this->getFunctions($options['constants']) as $function) {
32			list($name, $line, $args) = $function;
33
34			if (isset($options['lineOffset'])) {
35			$line += $options['lineOffset'];
36			}
37
38			if (!isset($functions[$name])) {
39			continue;
40			}
41
42			$deconstructed = $this->deconstructArgs($functions[$name], $args);
43
44			if (!$deconstructed) {
45			continue;
46			}
47
48			list($domain, $context, $original, $plural) = $deconstructed;
49
50			if ((string)$original === '') {
51			continue;
52			}
53
54			$isDefaultDomain = $domain === null;
55			$isMatchingDomain = $domain === $translations->getDomain();
56
57			if (!empty($options['domainOnly']) && $isDefaultDomain) {
58			// If we want to find translations for a specific domain, skip default domain messages
59			continue;
60			}
61
62			if (!$isDefaultDomain && !$isMatchingDomain) {
63			continue;
64			}
65
66			$translation = $translations->insert($context, $original, $plural);
67			$translation->addReference($file, $line);
68
69			if (isset($function[3])) {
70			foreach ($function[3] as $extractedComment) {
71			$translation->addExtractedComment($extractedComment);
72			}
73			}
74			}
75			}
76
77			/**
78			* Deconstruct arguments to translation values
79			*
80			* @param $function
81			* @param $args
82			* @return array\|null
83			* @throws Exception
84			*/
85			private function deconstructArgs($function, $args)
86			{
87			$domain = null;
88			$context = null;
89			$original = null;
90			$plural = null;
91
92			switch ($function) {
93			case 'noop':
94			case 'gettext':
95			if (!isset($args[0])) {
96			return null;
97			}
98
99			$original = $args[0];
100			break;
101			case 'ngettext':
102			if (!isset($args[1])) {
103			return null;
104			}
105
106			list($original, $plural) = $args;
107			break;
108			case 'pgettext':
109			if (!isset($args[1])) {
110			return null;
111			}
112
113			list($context, $original) = $args;
114			break;
115			case 'dgettext':
116			if (!isset($args[1])) {
117			return null;
118			}
119
120			list($domain, $original) = $args;
121			break;
122			case 'dpgettext':
123			if (!isset($args[2])) {
124			return null;
125			}
126
127			list($domain, $context, $original) = $args;
128			break;
129			case 'npgettext':
130			if (!isset($args[2])) {
131			return null;
132			}
133
134			list($context, $original, $plural) = $args;
135			break;
136			case 'dnpgettext':
137			if (!isset($args[3])) {
138			return null;
139			}
140
141			list($domain, $context, $original, $plural) = $args;
142			break;
143			case 'dngettext':
144			if (!isset($args[2])) {
145			return null;
146			}
147
148			list($domain, $original, $plural) = $args;
149			break;
150			default:
151			throw new Exception(sprintf('Not valid function %s', $function));
152			}
153
154			return [$domain, $context, $original, $plural];
155			}
156			}
157

oscarotero / Gettext

Pull Request — master (#222)

FunctionsScanner::saveGettextFunctions() C

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like