AbstractDataBuilder::with() - Code Metrics - spryker/spryker-core - Measure and Improve Code Quality continuously with Scrutinizer

AbstractDataBuilder::with() A
last analyzed 2025-06-20 06:14 UTC

↳ Parent: AbstractDataBuilder

Complexity

Conditions	4
Paths	6

Size

Total Lines	13
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	4
eloc	7
nc	6
nop	1
dl	0
loc	13
rs	10
c	0
b	0
f	0

<?php

/**
 * Copyright © 2016-present Spryker Systems GmbH. All rights reserved.
 * Use of this software requires acceptance of the Evaluation License Agreement. See LICENSE file.
 */

namespace Spryker\Shared\Testify;

use Faker\Factory;
use Spryker\Shared\Kernel\Transfer\AbstractTransfer;
use Spryker\Shared\Testify\Exception\DependencyNotDefinedException;
use Spryker\Shared\Testify\Exception\FieldNotDefinedException;
use Spryker\Shared\Testify\Exception\RuleNotDefinedException;

abstract class AbstractDataBuilder
{
    /**
     * @var \Faker\Generator
     */
    protected static $faker;

    /**
     * @var array<string, string>
     */
    protected $defaultRules = [];

    /**
     * @var array<string, string>
     */
    protected $rules = [];

    /**
     * @var array<string, string>
     */
    protected $dependencies = [];

    /**
     * @var array<mixed>
     */
    protected $nestedBuilders = [];

    /**
     * @var array<string, mixed>
     */
    protected $seedData = [];

    /**
     * @return \Spryker\Shared\Kernel\Transfer\AbstractTransfer
     */
    abstract protected function getTransfer();

    /**
     * @param string $builder
     *
     * @throws \Exception
     *
     * @return \Spryker\Shared\Testify\AbstractDataBuilder
     */
    abstract protected function locateDataBuilder($builder);

    /**
     * @param array<string, mixed> $seed
     */
    public function __construct($seed = [])
    {
        $this->seedData = $seed;
        $this->rules = $this->defaultRules;

        if (static::$faker === null) {
            static::$faker = Factory::create();
        }
    }

    /**
     * Removes all rules
     *
     * @return $this
     */
    public function makeEmpty()
    {
        $this->rules = [];

        return $this;
    }

    /**
     * @return $this
     */
    public function resetData()
    {
        $this->seedData = [];

        return $this;
    }

    /**
     * @param array<string, mixed> $seed
     *
     * @return $this
     */
    public function seed(array $seed = [])
    {
        $this->seedData += $seed;

        return $this;
    }

    /**
     * @param array<string>|string $rules
     *
     * @throws \Spryker\Shared\Testify\Exception\RuleNotDefinedException
     *
     * @return $this
     */
    public function with($rules)
    {
        if (!is_array($rules)) {
            $rules = [];
        }
        foreach ($rules as $rule) {
            if (!isset($this->defaultRules[$rule])) {
                throw new RuleNotDefinedException(sprintf('No rule for "%s" defined', $rule));
            }
            $this->rules[$rule] = $this->defaultRules[$rule];
        }

        return $this;
    }

    /**
     * @param array<string>|string $rules
     *
     * @return $this
     */
    public function except($rules)
    {
        if (!is_array($rules)) {
            $rules = [];
        }
        foreach ($rules as $rule) {
            unset($this->rules[$rule]);
        }

        return $this;
    }

    /**
     * @return \Spryker\Shared\Kernel\Transfer\AbstractTransfer
     */
    public function build()
    {
        $seedData = array_merge($this->generateFields(), $this->seedData);
        $transfer = $this->getTransfer()->fromArray($seedData, true);

        if ($this->nestedBuilders !== []) {
            $this->generateDependencies($transfer);
        }

        return $transfer;
    }

    /**
     * @return array<bool|string>
     */
    protected function generateFields()
    {
        $data = [];
        foreach ($this->rules as $field => $rule) {
            $data[$field] = $this->generateFromRule($rule);
        }

        return $data;
    }

    /**
     * @param string $field
     * @param array<string, mixed> $override
     * @param bool $randomize
     *
     * @throws \Spryker\Shared\Testify\Exception\FieldNotDefinedException
     *
     * @return void
     */
    protected function buildDependency($field, $override = [], $randomize = false)
    {
        if (!isset($this->dependencies[$field])) {
            throw new FieldNotDefinedException(sprintf('Field "%s" not defined in dependencies list', $field));
        }
        $builder = $this->locateDataBuilder($this->dependencies[$field]);
        $builder->seed($override);
        $this->addDependencyBuilder($field, $builder, $randomize);
    }

    /**
     * @param string $field
     * @param \Spryker\Shared\Testify\AbstractDataBuilder $builder
     * @param bool $randomize
     *
     * @return void
     */
    protected function addDependencyBuilder($field, $builder, $randomize)
    {
        $this->nestedBuilders[] = [$field, $builder, $randomize];
    }

    /**
     * @param \Spryker\Shared\Kernel\Transfer\AbstractTransfer $transfer
     *
     * @throws \Spryker\Shared\Testify\Exception\DependencyNotDefinedException
     *
     * @return void
     */
    protected function generateDependencies(AbstractTransfer $transfer)
    {
        foreach ($this->nestedBuilders as $builderInfo) {
            [$name, $dependencyBuilder, $randomize] = $builderInfo;

            if (!$randomize) {
                $parentSeedData = $this->seedData[$name] ?? [];
                $parentSeedData = $parentSeedData instanceof AbstractTransfer ? $parentSeedData->toArray() : $parentSeedData;
                $dependencySeedData = array_merge($dependencyBuilder->getSeedData(), $parentSeedData);

                $dependencyBuilder->seed($dependencySeedData);
            }

            $nestedTransfer = $dependencyBuilder->build();

            if (method_exists($transfer, 'add' . $name)) {
                /** @var callable $callable */
                $callable = [$transfer, 'add' . $name];
                call_user_func($callable, $nestedTransfer);

                continue;
            }

            if (method_exists($transfer, 'set' . $name)) {
                /** @var callable $callable */
                $callable = [$transfer, 'set' . $name];
                call_user_func($callable, $nestedTransfer);

                continue;
            }

            throw new DependencyNotDefinedException(sprintf('Dependency "%s" not defined in "%s"', $name, static::class));
        }
    }

    /**
     * @SuppressWarning(PHPMD.EvalSniff)
     *
     * @param string $rule
     *
     * @return string|bool
     */
    protected function generateFromRule($rule)
    {
        if (strpos($rule, '=') === 0) {
            return substr($rule, 1);
        }

        // @codingStandardsIgnoreStart
        if (strpos($rule, '(') !== false) {
            return eval("return static::\$faker->$rule;");

        }
        return eval("return static::\$faker->$rule();");

        // @codingStandardsIgnoreEnd
    }

    /**
     * @return array<string, mixed>
     */
    public function getSeedData()
    {
        return $this->seedData;
    }
}


1			<?php
2
3			/**
4			* Copyright © 2016-present Spryker Systems GmbH. All rights reserved.
5			* Use of this software requires acceptance of the Evaluation License Agreement. See LICENSE file.
6			*/
7
8			namespace Spryker\Shared\Testify;
9
10			use Faker\Factory;
11			use Spryker\Shared\Kernel\Transfer\AbstractTransfer;
12			use Spryker\Shared\Testify\Exception\DependencyNotDefinedException;
13			use Spryker\Shared\Testify\Exception\FieldNotDefinedException;
14			use Spryker\Shared\Testify\Exception\RuleNotDefinedException;
15
16			abstract class AbstractDataBuilder
17			{
18			/**
19			* @var \Faker\Generator
20			*/
21			protected static $faker;
22
23			/**
24			* @var array<string, string>
25			*/
26			protected $defaultRules = [];
27
28			/**
29			* @var array<string, string>
30			*/
31			protected $rules = [];
32
33			/**
34			* @var array<string, string>
35			*/
36			protected $dependencies = [];
37
38			/**
39			* @var array<mixed>
40			*/
41			protected $nestedBuilders = [];
42
43			/**
44			* @var array<string, mixed>
45			*/
46			protected $seedData = [];
47
48			/**
49			* @return \Spryker\Shared\Kernel\Transfer\AbstractTransfer
50			*/
51			abstract protected function getTransfer();
52
53			/**
54			* @param string $builder
55			*
56			* @throws \Exception
57			*
58			* @return \Spryker\Shared\Testify\AbstractDataBuilder
59			*/
60			abstract protected function locateDataBuilder($builder);
61
62			/**
63			* @param array<string, mixed> $seed
64			*/
65			public function __construct($seed = [])
66			{
67			$this->seedData = $seed;
68			$this->rules = $this->defaultRules;
69
70			if (static::$faker === null) {
71			static::$faker = Factory::create();
72			}
73			}
74
75			/**
76			* Removes all rules
77			*
78			* @return $this
79			*/
80			public function makeEmpty()
81			{
82			$this->rules = [];
83
84			return $this;
85			}
86
87			/**
88			* @return $this
89			*/
90			public function resetData()
91			{
92			$this->seedData = [];
93
94			return $this;
95			}
96
97			/**
98			* @param array<string, mixed> $seed
99			*
100			* @return $this
101			*/
102			public function seed(array $seed = [])
103			{
104			$this->seedData += $seed;
105
106			return $this;
107			}
108
109			/**
110			* @param array<string>\|string $rules
111			*
112			* @throws \Spryker\Shared\Testify\Exception\RuleNotDefinedException
113			*
114			* @return $this
115			*/
116			public function with($rules)
117			{
118			if (!is_array($rules)) {
119			$rules = [];
120			}
121			foreach ($rules as $rule) {
122			if (!isset($this->defaultRules[$rule])) {
123			throw new RuleNotDefinedException(sprintf('No rule for "%s" defined', $rule));
124			}
125			$this->rules[$rule] = $this->defaultRules[$rule];
126			}
127
128			return $this;
129			}
130
131			/**
132			* @param array<string>\|string $rules
133			*
134			* @return $this
135			*/
136			public function except($rules)
137			{
138			if (!is_array($rules)) {
139			$rules = [];
140			}
141			foreach ($rules as $rule) {
142			unset($this->rules[$rule]);
143			}
144
145			return $this;
146			}
147
148			/**
149			* @return \Spryker\Shared\Kernel\Transfer\AbstractTransfer
150			*/
151			public function build()
152			{
153			$seedData = array_merge($this->generateFields(), $this->seedData);
154			$transfer = $this->getTransfer()->fromArray($seedData, true);
155
156			if ($this->nestedBuilders !== []) {
157			$this->generateDependencies($transfer);
158			}
159
160			return $transfer;
161			}
162
163			/**
164			* @return array<bool\|string>
165			*/
166			protected function generateFields()
167			{
168			$data = [];
169			foreach ($this->rules as $field => $rule) {
170			$data[$field] = $this->generateFromRule($rule);
171			}
172
173			return $data;
174			}
175
176			/**
177			* @param string $field
178			* @param array<string, mixed> $override
179			* @param bool $randomize
180			*
181			* @throws \Spryker\Shared\Testify\Exception\FieldNotDefinedException
182			*
183			* @return void
184			*/
185			protected function buildDependency($field, $override = [], $randomize = false)
186			{
187			if (!isset($this->dependencies[$field])) {
188			throw new FieldNotDefinedException(sprintf('Field "%s" not defined in dependencies list', $field));
189			}
190			$builder = $this->locateDataBuilder($this->dependencies[$field]);
191			$builder->seed($override);
192			$this->addDependencyBuilder($field, $builder, $randomize);
193			}
194
195			/**
196			* @param string $field
197			* @param \Spryker\Shared\Testify\AbstractDataBuilder $builder
198			* @param bool $randomize
199			*
200			* @return void
201			*/
202			protected function addDependencyBuilder($field, $builder, $randomize)
203			{
204			$this->nestedBuilders[] = [$field, $builder, $randomize];
205			}
206
207			/**
208			* @param \Spryker\Shared\Kernel\Transfer\AbstractTransfer $transfer
209			*
210			* @throws \Spryker\Shared\Testify\Exception\DependencyNotDefinedException
211			*
212			* @return void
213			*/
214			protected function generateDependencies(AbstractTransfer $transfer)
215			{
216			foreach ($this->nestedBuilders as $builderInfo) {
217			[$name, $dependencyBuilder, $randomize] = $builderInfo;
218
219			if (!$randomize) {
220			$parentSeedData = $this->seedData[$name] ?? [];
221			$parentSeedData = $parentSeedData instanceof AbstractTransfer ? $parentSeedData->toArray() : $parentSeedData;
222			$dependencySeedData = array_merge($dependencyBuilder->getSeedData(), $parentSeedData);
223
224			$dependencyBuilder->seed($dependencySeedData);
225			}
226
227			$nestedTransfer = $dependencyBuilder->build();
228
229			if (method_exists($transfer, 'add' . $name)) {
230			/** @var callable $callable */
231			$callable = [$transfer, 'add' . $name];
232			call_user_func($callable, $nestedTransfer);
233
234			continue;
235			}
236
237			if (method_exists($transfer, 'set' . $name)) {
238			/** @var callable $callable */
239			$callable = [$transfer, 'set' . $name];
240			call_user_func($callable, $nestedTransfer);
241
242			continue;
243			}
244
245			throw new DependencyNotDefinedException(sprintf('Dependency "%s" not defined in "%s"', $name, static::class));
246			}
247			}
248
249			/**
250			* @SuppressWarning(PHPMD.EvalSniff)
251			*
252			* @param string $rule
253			*
254			* @return string\|bool
255			*/
256			protected function generateFromRule($rule)
257			{
258			if (strpos($rule, '=') === 0) {
259			return substr($rule, 1);
260			}
261
262			// @codingStandardsIgnoreStart
263			if (strpos($rule, '(') !== false) {
264			return eval("return static::\$faker->$rule;");
			0 ignored issues – show introduced 2023-02-14 20:08 UTC by Report Bug Copy Issue Report The use of eval() is discouraged. Loading history...
265			}
266			return eval("return static::\$faker->$rule();");
			0 ignored issues – show introduced 2024-03-27 11:28 UTC by Report Bug Copy Issue Report The use of eval() is discouraged. Loading history...
267			// @codingStandardsIgnoreEnd
268			}
269
270			/**
271			* @return array<string, mixed>
272			*/
273			public function getSeedData()
274			{
275			return $this->seedData;
276			}
277			}
278

spryker / spryker-core

AbstractDataBuilder::with() A last analyzed 2025-06-20 06:14 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

AbstractDataBuilder::with() A
last analyzed 2025-06-20 06:14 UTC