AbstractAnonymizer::getWhereConditionInConfig() - Code Metrics - Inspection of "Fixed circleci driver" - edyan/neuralyzer - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( bf62c3...8c031b )

by Emmanuel

created 2018-04-02 10:55 UTC

AbstractAnonymizer::getWhereConditionInConfig() A

↳ Parent: AbstractAnonymizer

Complexity

Conditions	2
Paths	2

Size

Total Lines	10
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	1
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	10
ccs	1
cts	1
cp	1
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	5
nc	2
nop	0
crap	2

<?php
/**
 * neuralyzer : Data Anonymization Library and CLI Tool
 *
 * PHP Version 7.1
 *
 * @author Emmanuel Dyan
 * @author Rémi Sauvat
 * @copyright 2018 Emmanuel Dyan
 *
 * @package edyan/neuralyzer
 *
 * @license GNU General Public License v2.0
 *
 * @link https://github.com/edyan/neuralyzer
 */

namespace Edyan\Neuralyzer\Anonymizer;

use Edyan\Neuralyzer\Configuration\Reader;
use Edyan\Neuralyzer\Exception\NeuralizerConfigurationException;

/**
 * Abstract Anonymizer, that can be implemented as DB Anonymizer for example
 * Its goal is only to anonymize any data, from a simple array
 * not to write or read it from anywhere
 *
 */
abstract class AbstractAnonymizer
{
    /**
     * Constant to define the type of action for that table
     */
    const TRUNCATE_TABLE = 1;

    /**
     * Constant to define the type of action for that table
     */
    const UPDATE_TABLE = 2;

    /**
     * Contain the configuration object
     *
     * @var Reader
     */
    protected $configuration;

    /**
     * Configuration of entities
     *
     * @var array
     */
    protected $configEntites = [];

    /**
     * Current table (entity) to process
     * @var string
     */
    protected $entity;

    /**
     * Current table (entity) Columns
     * @var array
     */
    protected $entityCols;


    /**
     * Process the entity according to the anonymizer type
     *
     * @param string        $entity         Entity's name
     * @param callable|null $callback       Callback function with current row num as parameter
     * @param bool          $pretend        Simulate update
     * @param bool          $returnRes      Return queries
     */
    abstract public function processEntity(
        string $entity,
        callable $callback = null,
        bool $pretend = true,
        bool $returnRes = false
    ): array;


    /**
     * Set the configuration
     *
     * @param Reader $configuration
     */
    public function setConfiguration(Reader $configuration)
    {
        $this->configuration = $configuration;
        $this->configEntites = $configuration->getConfigValues()['entities'];
    }


    /**
     * Evaluate, from the configuration if I have to update or Truncate the table
     *
     * @return int
     */
    protected function whatToDoWithEntity(): int
    {
        $this->checkEntityIsInConfig();

        $entityConfig = $this->configEntites[$this->entity];

        $actions = 0;
        if (array_key_exists('delete', $entityConfig) && $entityConfig['delete'] === true) {
            $actions |= self::TRUNCATE_TABLE;
        }

        if (array_key_exists('cols', $entityConfig)) {
            $actions |= self::UPDATE_TABLE;
        }

        return $actions;
    }


    /**
     * Returns the 'delete_where' parameter for an entity in config (or empty)
     *
     * @return string
     */
    public function getWhereConditionInConfig(): string
    {
        $this->checkEntityIsInConfig();

        if (!array_key_exists('delete_where', $this->configEntites[$this->entity])) {
            return '';
        }

        return $this->configEntites[$this->entity]['delete_where'];
    }


    /**
     * Generate fake data for an entity and return it as an Array
     *
     * @return array
     */
    protected function generateFakeData(): array
    {
        $this->checkEntityIsInConfig();

        $faker = \Faker\Factory::create($this->configuration->getConfigValues()['language']);

        $colsInConfig = $this->configEntites[$this->entity]['cols'];
        $row = [];
        foreach ($colsInConfig as $colName => $colProps) {
            $this->checkColIsInEntity($colName);
            $args = empty($colProps['params']) ? [] : $colProps['params'];
            $data = call_user_func_array([$faker, $colProps['method']], $args);
            if (!is_scalar($data)) {
                $msg = "You must use faker methods that generate strings: '{$colProps['method']}' forbidden";
                throw new NeuralizerConfigurationException($msg);
            }

            $row[$colName] = $data;

            $colLength = $this->entityCols[$colName]['length'];
            // Cut the value if too long ...
            if (!empty($colLength) && strlen($data) > $colLength) {
                $row[$colName] = substr($data, 0, $this->entityCols[$colName]['length']);
            }
        }

        return $row;
    }


    /**
     * Make sure that entity is defined in the configuration
     *
     * @throws NeuralizerConfigurationException
     */
    private function checkEntityIsInConfig()
    {
        if (empty($this->configEntites)) {
            throw new NeuralizerConfigurationException(
                'No entities found. Have you loaded a configuration file ?'
            );
        }
        if (!array_key_exists($this->entity, $this->configEntites)) {
            throw new NeuralizerConfigurationException(
                "No configuration for that entity ({$this->entity})"
            );
        }
    }

    /**
     * Verify a column is defined in the real entityCols
     * @param  string $colName
     */
    private function checkColIsInEntity(string $colName)
    {
        if (!array_key_exists($colName, $this->entityCols)) {
            throw new NeuralizerConfigurationException("Col $colName does not exist");
        }
    }
}


1		<?php
2		/**
3		* neuralyzer : Data Anonymization Library and CLI Tool
4		*
5		* PHP Version 7.1
6		*
7		* @author Emmanuel Dyan
8		* @author Rémi Sauvat
9		* @copyright 2018 Emmanuel Dyan
10		*
11		* @package edyan/neuralyzer
12		*
13		* @license GNU General Public License v2.0
14		*
15		* @link https://github.com/edyan/neuralyzer
16		*/
17
18		namespace Edyan\Neuralyzer\Anonymizer;
19
20		use Edyan\Neuralyzer\Configuration\Reader;
21		use Edyan\Neuralyzer\Exception\NeuralizerConfigurationException;
22
23		/**
24		* Abstract Anonymizer, that can be implemented as DB Anonymizer for example
25		* Its goal is only to anonymize any data, from a simple array
26		* not to write or read it from anywhere
27		*
28		*/
29		abstract class AbstractAnonymizer
30		{
31		/**
32		* Constant to define the type of action for that table
33		*/
34		const TRUNCATE_TABLE = 1;
35
36		/**
37		* Constant to define the type of action for that table
38		*/
39		const UPDATE_TABLE = 2;
40
41		/**
42		* Contain the configuration object
43		*
44		* @var Reader
45		*/
46		protected $configuration;
47
48		/**
49		* Configuration of entities
50		*
51		* @var array
52		*/
53		protected $configEntites = [];
54
55		/**
56		* Current table (entity) to process
57		* @var string
58		*/
59		protected $entity;
60
61		/**
62		* Current table (entity) Columns
63		* @var array
64		*/
65		protected $entityCols;
66
67
68		/**
69		* Process the entity according to the anonymizer type
70		*
71		* @param string $entity Entity's name
72		* @param callable\|null $callback Callback function with current row num as parameter
73		* @param bool $pretend Simulate update
74		* @param bool $returnRes Return queries
75		*/
76		abstract public function processEntity(
77		string $entity,
78		callable $callback = null,
79		bool $pretend = true,
80		bool $returnRes = false
81		): array;
82
83
84		/**
85		* Set the configuration
86		*
87		* @param Reader $configuration
88		*/
89		public function setConfiguration(Reader $configuration)
90		{
91		$this->configuration = $configuration;
92		$this->configEntites = $configuration->getConfigValues()['entities'];
93		}
94	17
95
96	17	/**
97	17	* Evaluate, from the configuration if I have to update or Truncate the table
98	17	*
99		* @return int
100		*/
101		protected function whatToDoWithEntity(): int
102		{
103		$this->checkEntityIsInConfig();
104
105		$entityConfig = $this->configEntites[$this->entity];
106	13
107		$actions = 0;
108	13	if (array_key_exists('delete', $entityConfig) && $entityConfig['delete'] === true) {
109		$actions \|= self::TRUNCATE_TABLE;
110	11	}
111
112	11	if (array_key_exists('cols', $entityConfig)) {
113	11	$actions \|= self::UPDATE_TABLE;
114	4	}
115
116		return $actions;
117	11	}
118	11
119	11
120	11	/**
121	11	* Returns the 'delete_where' parameter for an entity in config (or empty)
122		*
123		* @return string
124		*/
125		public function getWhereConditionInConfig(): string
126		{
127		$this->checkEntityIsInConfig();
128	11
129		if (!array_key_exists('delete_where', $this->configEntites[$this->entity])) {
130		return '';
131		}
132
133		return $this->configEntites[$this->entity]['delete_where'];
134		}
135
136
137	4	/**
138		* Generate fake data for an entity and return it as an Array
139	4	*
140		* @return array
141	4	*/
142	1	protected function generateFakeData(): array
143		{
144		$this->checkEntityIsInConfig();
145	3
146		$faker = \Faker\Factory::create($this->configuration->getConfigValues()['language']);
147
148		$colsInConfig = $this->configEntites[$this->entity]['cols'];
149		$row = [];
150		foreach ($colsInConfig as $colName => $colProps) {
151		$this->checkColIsInEntity($colName);
152		$args = empty($colProps['params']) ? [] : $colProps['params'];
153		$data = call_user_func_array([$faker, $colProps['method']], $args);
154	9	if (!is_scalar($data)) {
155		$msg = "You must use faker methods that generate strings: '{$colProps['method']}' forbidden";
156	9	throw new NeuralizerConfigurationException($msg);
157		}
158	9
159		$row[$colName] = $data;
160	9
161	9	$colLength = $this->entityCols[$colName]['length'];
162	9	// Cut the value if too long ...
163	9	if (!empty($colLength) && strlen($data) > $colLength) {
164	8	$row[$colName] = substr($data, 0, $this->entityCols[$colName]['length']);
165	8	}
166	8	}
167
168		return $row;
169	8	}
170	1
171	1
172		/**
173		* Make sure that entity is defined in the configuration
174	8	*
175		* @throws NeuralizerConfigurationException
176	8	*/
177		private function checkEntityIsInConfig()
178	8	{
179	8	if (empty($this->configEntites)) {
180		throw new NeuralizerConfigurationException(
181		'No entities found. Have you loaded a configuration file ?'
182		);
183	7	}
184		if (!array_key_exists($this->entity, $this->configEntites)) {
185		throw new NeuralizerConfigurationException(
186		"No configuration for that entity ({$this->entity})"
187		);
188		}
189		}
190
191		/**
192	13	* Verify a column is defined in the real entityCols
193		* @param string $colName
194	13	*/
195	1	private function checkColIsInEntity(string $colName)
196	1	{
197		if (!array_key_exists($colName, $this->entityCols)) {
198		throw new NeuralizerConfigurationException("Col $colName does not exist");
199	12	}
200	1	}
201		}
202

edyan / neuralyzer

Push — master ( bf62c3...8c031b )

AbstractAnonymizer::getWhereConditionInConfig() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like