ParamHelpers::generateDummyValue() - Code Metrics - Inspection of "V4" - mpociot/laravel-apidoc-generator - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#638)

unknown

created 2019-11-07 20:22 UTC

ParamHelpers::generateDummyValue() A

↳ Parent: ParamHelpers

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	34
rs	9.376
c	0
b	0
f	0
cc	2
nc	2
nop	1

<?php

namespace Mpociot\ApiDoc\Extracting;

use Faker\Factory;

trait ParamHelpers
{
    protected function generateDummyValue(string $type)
    {
        $faker = Factory::create();
        if ($this->config->get('faker_seed')) {
            $faker->seed($this->config->get('faker_seed'));
class MyClass { }

$x = new MyClass();
$x->foo = true;
        }
        $fakeFactories = [
            'integer' => function () use ($faker) {
                return $faker->numberBetween(1, 20);
            },
            'number' => function () use ($faker) {
                return $faker->randomFloat();
            },
            'float' => function () use ($faker) {
                return $faker->randomFloat();
            },
            'boolean' => function () use ($faker) {
                return $faker->boolean();
            },
            'string' => function () use ($faker) {
                return $faker->word;
            },
            'array' => function () {
                return [];
            },
            'object' => function () {
                return new \stdClass;
            },
        ];

        $fakeFactory = $fakeFactories[$type] ?? $fakeFactories['string'];

        return $fakeFactory();
    }

    /**
     * Cast a value from a string to a specified type.
     *
     * @param string $value
     * @param string $type
     *
     * @return mixed
     */
    protected function castToType(string $value, string $type)
    {
        $casts = [
            'integer' => 'intval',
            'int' => 'intval',
            'float' => 'floatval',
            'number' => 'floatval',
            'double' => 'floatval',
            'boolean' => 'boolval',
            'bool' => 'boolval',
        ];

        // First, we handle booleans. We can't use a regular cast,
        //because PHP considers string 'false' as true.
        if ($value == 'false' && ($type == 'boolean' || $type == 'bool')) {
            return false;
        }

        if (isset($casts[$type])) {
            return $casts[$type]($value);
        }

        return $value;
    }

    /**
     * Normalizes the stated "type" of a parameter (eg "int", "integer", "double")
     * to a number of standard types (integer, boolean, float).
     *
     * @param string $type
     *
     * @return mixed|string
     */
    protected function normalizeParameterType(string $type)
    {
        $typeMap = [
            'int' => 'integer',
            'bool' => 'boolean',
            'double' => 'float',
        ];

        return $type ? ($typeMap[$type] ?? $type) : 'string';
    }

    /**
     * Allows users to specify that we shouldn't generate an example for the parameter
     * by writing 'No-example'.
     *
     * @param string $description
     *
     * @return bool If true, don't generate an example for this.
     */
    protected function shouldExcludeExample(string $description)
    {
        return strpos($description, ' No-example') !== false;
    }

    /**
     * Allows users to specify an example for the parameter by writing 'Example: the-example',
     * to be used in example requests and response calls.
     *
     * @param string $description
     * @param string $type The type of the parameter. Used to cast the example provided, if any.
     *
     * @return array The description and included example.
     */
    protected function parseParamDescription(string $description, string $type)
    {
        $example = null;
        if (preg_match('/(.*)\bExample:\s*(.+)\s*/', $description, $content)) {
            $description = trim($content[1]);

            // examples are parsed as strings by default, we need to cast them properly
            $example = $this->castToType($content[2], $type);
        }

        return [$description, $example];
    }
}


1			<?php
2
3			namespace Mpociot\ApiDoc\Extracting;
4
5			use Faker\Factory;
6
7			trait ParamHelpers
8			{
9			protected function generateDummyValue(string $type)
10			{
11			$faker = Factory::create();
12			if ($this->config->get('faker_seed')) {
13			$faker->seed($this->config->get('faker_seed'));
			0 ignored issues – show Bug introduced 2019-09-02 20:57 UTC by Report Bug Copy Issue Report The property `config` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
14			}
15			$fakeFactories = [
16			'integer' => function () use ($faker) {
17			return $faker->numberBetween(1, 20);
18			},
19			'number' => function () use ($faker) {
20			return $faker->randomFloat();
21			},
22			'float' => function () use ($faker) {
23			return $faker->randomFloat();
24			},
25			'boolean' => function () use ($faker) {
26			return $faker->boolean();
27			},
28			'string' => function () use ($faker) {
29			return $faker->word;
30			},
31			'array' => function () {
32			return [];
33			},
34			'object' => function () {
35			return new \stdClass;
36			},
37			];
38
39			$fakeFactory = $fakeFactories[$type] ?? $fakeFactories['string'];
40
41			return $fakeFactory();
42			}
43
44			/**
45			* Cast a value from a string to a specified type.
46			*
47			* @param string $value
48			* @param string $type
49			*
50			* @return mixed
51			*/
52			protected function castToType(string $value, string $type)
53			{
54			$casts = [
55			'integer' => 'intval',
56			'int' => 'intval',
57			'float' => 'floatval',
58			'number' => 'floatval',
59			'double' => 'floatval',
60			'boolean' => 'boolval',
61			'bool' => 'boolval',
62			];
63
64			// First, we handle booleans. We can't use a regular cast,
65			//because PHP considers string 'false' as true.
66			if ($value == 'false' && ($type == 'boolean' \|\| $type == 'bool')) {
67			return false;
68			}
69
70			if (isset($casts[$type])) {
71			return $casts[$type]($value);
72			}
73
74			return $value;
75			}
76
77			/**
78			* Normalizes the stated "type" of a parameter (eg "int", "integer", "double")
79			* to a number of standard types (integer, boolean, float).
80			*
81			* @param string $type
82			*
83			* @return mixed\|string
84			*/
85			protected function normalizeParameterType(string $type)
86			{
87			$typeMap = [
88			'int' => 'integer',
89			'bool' => 'boolean',
90			'double' => 'float',
91			];
92
93			return $type ? ($typeMap[$type] ?? $type) : 'string';
94			}
95
96			/**
97			* Allows users to specify that we shouldn't generate an example for the parameter
98			* by writing 'No-example'.
99			*
100			* @param string $description
101			*
102			* @return bool If true, don't generate an example for this.
103			*/
104			protected function shouldExcludeExample(string $description)
105			{
106			return strpos($description, ' No-example') !== false;
107			}
108
109			/**
110			* Allows users to specify an example for the parameter by writing 'Example: the-example',
111			* to be used in example requests and response calls.
112			*
113			* @param string $description
114			* @param string $type The type of the parameter. Used to cast the example provided, if any.
115			*
116			* @return array The description and included example.
117			*/
118			protected function parseParamDescription(string $description, string $type)
119			{
120			$example = null;
121			if (preg_match('/(.)\bExample:\s(.+)\s*/', $description, $content)) {
122			$description = trim($content[1]);
123
124			// examples are parsed as strings by default, we need to cast them properly
125			$example = $this->castToType($content[2], $type);
126			}
127
128			return [$description, $example];
129			}
130			}
131

mpociot / laravel-apidoc-generator

Pull Request — master (#638)

ParamHelpers::generateDummyValue() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like