BuilderOptions::makeGoBuilderOptions() - Code Metrics - swaggest/json-cli - Measure and Improve Code Quality continuously with Scrutinizer

BuilderOptions::makeGoBuilderOptions() B
last analyzed 2023-12-19 01:16 UTC

↳ Parent: BuilderOptions

Complexity

Conditions	6
Paths	6

Size

Total Lines	38
Code Lines	27

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	6
eloc	27
c	1
b	0
f	0
nc	6
nop	0
dl	0
loc	38
rs	8.8657

<?php

namespace Swaggest\JsonCli\GenGo;

use Swaggest\GoCodeBuilder\JsonSchema\Options;
use Swaggest\JsonCli\ExitCode;
use Swaggest\PhpCodeBuilder\Markdown\TypeBuilder;
use Yaoi\Command\Option;

trait BuilderOptions
{
    /** @var bool */
    public $showConstProperties = false;
    /** @var bool */
    public $keepParentInPropertyNames = false;
    /** @var bool */
    public $ignoreNullable;
    /** @var bool */
    public $ignoreXGoType;
    /** @var bool */
    public $withZeroValues;
    /** @var bool */
    public $enableXNullable;
    /** @var bool */
    public $enableDefaultAdditionalProperties;
    /** @var bool */
    public $fluentSetters;
    /** @var bool */
    public $ignoreRequired = false;

    /** @var array<string, string> */
    public $renames = [];

    /** @var bool */
    public $requireXGenerate = false;

    /** @var bool */
    public $validateRequired = false;

    /** @var string[] */
    public $nameTags = [];

    /** @var string */
    public $config;

    /**
     * @param \stdClass|static $options
     */
    public static function setUpBuilderOptions($options)
    {
        $options->showConstProperties = Option::create()

            ->setDescription('Show properties with constant values, hidden by default');

        $options->keepParentInPropertyNames = Option::create()

            ->setDescription('Keep parent prefix in property name, removed by default');

        $options->ignoreNullable = Option::create()

            ->setDescription('Add `omitempty` to nullable properties, removed by default');

        $options->ignoreXGoType = Option::create()

            ->setName('ignore-x-go-type')
            ->setDescription('Ignore `x-go-type` in schema to skip generation');

        $options->withZeroValues = Option::create()

            ->setDescription('Use pointer types to avoid zero value ambiguity');

        $options->enableXNullable = Option::create()

            ->setDescription('Add `null` to types if `x-nullable` or `nullable` is available');

        $options->enableDefaultAdditionalProperties = Option::create()

            ->setDescription('Add field property for undefined `additionalProperties`');

        $options->fluentSetters = Option::create()

            ->setDescription('Add fluent setters to struct fields');

        $options->ignoreRequired = Option::create()

            ->setDescription('Ignore if property is required when deciding on pointer type or omitempty');

        $options->renames = Option::create()->setIsVariadic()->setType()

            ->setDescription('Map of exported symbol renames, example From:To');

        $options->requireXGenerate = Option::create()

            ->setDescription('Generate properties with `x-generate: true` only');

        $options->validateRequired = Option::create()

            ->setDescription('Generate validation code to check required properties during unmarshal');

        $options->nameTags = Option::create()->setIsVariadic()->setType()

            ->setDescription('Set additional field tags with property name, example "msgp bson"');

        $options->config = Option::create()->setType()

            ->setDescription('Path to config JSON file to load options from. Schema:');

        $tb = new TypeBuilder();
        $tb->getTypeString(Options::schema()->exportSchema());
        $options->config->description .= "\n" . trim(substr($tb->file, 97)); // Stripping header.
    }

    /**
     * @return Options
     * @throws ExitCode
     */
    protected function makeGoBuilderOptions()
    {
        $options = new Options();
        if (!empty($this->config)) {
            $data = file_get_contents($this->config);
            if (empty($data)) {
                throw new ExitCode("empty or missing config file", 1);
            }
            $json = json_decode($data);
            if (empty($json)) {
                throw new ExitCode("invalid json in config file", 1);
            }

            $options = Options::import($json);
        }

        $options = $options->jsonSerialize();

        $options->hideConstProperties = !$this->showConstProperties;
        $options->trimParentFromPropertyNames = !$this->keepParentInPropertyNames;
        $options->ignoreNullable = $this->ignoreNullable;
        $options->ignoreXGoType = $this->ignoreXGoType;
        $options->withZeroValues = $this->withZeroValues;
        $options->enableXNullable = $this->enableXNullable;
        $options->defaultAdditionalProperties = $this->enableDefaultAdditionalProperties;
        $options->fluentSetters = $this->fluentSetters;
        $options->ignoreRequired = $this->ignoreRequired;
        $options->requireXGenerate = $this->requireXGenerate;
        $options->validateRequired = $this->validateRequired;
        $options->nameTags = $this->nameTags;
        if (!empty($this->renames)) {
            foreach ($this->renames as $rename) {
                $rename = explode(':', $rename, 2);
                $options->renames[$rename[0]] = $rename[1];
            }
        }

        return $options;

    }

}

1			<?php
2
3			namespace Swaggest\JsonCli\GenGo;
4
5			use Swaggest\GoCodeBuilder\JsonSchema\Options;
6			use Swaggest\JsonCli\ExitCode;
7			use Swaggest\PhpCodeBuilder\Markdown\TypeBuilder;
8			use Yaoi\Command\Option;
9
10			trait BuilderOptions
11			{
12			/** @var bool */
13			public $showConstProperties = false;
14			/** @var bool */
15			public $keepParentInPropertyNames = false;
16			/** @var bool */
17			public $ignoreNullable;
18			/** @var bool */
19			public $ignoreXGoType;
20			/** @var bool */
21			public $withZeroValues;
22			/** @var bool */
23			public $enableXNullable;
24			/** @var bool */
25			public $enableDefaultAdditionalProperties;
26			/** @var bool */
27			public $fluentSetters;
28			/** @var bool */
29			public $ignoreRequired = false;
30
31			/** @var array<string, string> */
32			public $renames = [];
33
34			/** @var bool */
35			public $requireXGenerate = false;
36
37			/** @var bool */
38			public $validateRequired = false;
39
40			/** @var string[] */
41			public $nameTags = [];
42
43			/** @var string */
44			public $config;
45
46			/**
47			* @param \stdClass\|static $options
48			*/
49			public static function setUpBuilderOptions($options)
50			{
51			$options->showConstProperties = Option::create()
			0 ignored issues – show Documentation Bug introduced 2020-12-13 15:17 UTC by Report Bug Copy Issue Report It seems like `Yaoi\Command\Option::cre...es, hidden by default')` of type `Yaoi\Command\Option` is incompatible with the declared type `boolean` of property `$showConstProperties`. 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...
52			->setDescription('Show properties with constant values, hidden by default');
53
54			$options->keepParentInPropertyNames = Option::create()
			0 ignored issues – show Documentation Bug introduced 2020-12-13 15:17 UTC by Report Bug Copy Issue Report It seems like `Yaoi\Command\Option::cre...e, removed by default')` of type `Yaoi\Command\Option` is incompatible with the declared type `boolean` of property `$keepParentInPropertyNames`. 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...
55			->setDescription('Keep parent prefix in property name, removed by default');
56
57			$options->ignoreNullable = Option::create()
			0 ignored issues – show Documentation Bug introduced 2020-12-13 15:17 UTC by Report Bug Copy Issue Report It seems like `Yaoi\Command\Option::cre...s, removed by default')` of type `Yaoi\Command\Option` is incompatible with the declared type `boolean` of property `$ignoreNullable`. 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...
58			->setDescription('Add `omitempty` to nullable properties, removed by default');
59
60			$options->ignoreXGoType = Option::create()
			0 ignored issues – show Documentation Bug introduced 2020-12-13 15:17 UTC by Report Bug Copy Issue Report It seems like `Yaoi\Command\Option::cre...ma to skip generation')` of type `Yaoi\Command\Option` is incompatible with the declared type `boolean` of property `$ignoreXGoType`. 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...
61			->setName('ignore-x-go-type')
62			->setDescription('Ignore `x-go-type` in schema to skip generation');
63
64			$options->withZeroValues = Option::create()
			0 ignored issues – show Documentation Bug introduced 2020-12-13 15:17 UTC by Report Bug Copy Issue Report It seems like `Yaoi\Command\Option::cre... zero value ambiguity')` of type `Yaoi\Command\Option` is incompatible with the declared type `boolean` of property `$withZeroValues`. 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...
65			->setDescription('Use pointer types to avoid zero value ambiguity');
66
67			$options->enableXNullable = Option::create()
			0 ignored issues – show Documentation Bug introduced 2020-12-13 15:17 UTC by Report Bug Copy Issue Report It seems like Yaoi\Command\Option::cre...ullable` is available') of type `Yaoi\Command\Option` is incompatible with the declared type `boolean` of property `$enableXNullable`. 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...
68			->setDescription('Add `null` to types if `x-nullable` or `nullable` is available');
69
70			$options->enableDefaultAdditionalProperties = Option::create()
			0 ignored issues – show Documentation Bug introduced 2019-10-27 18:20 UTC by Report Bug Copy Issue Report It seems like Yaoi\Command\Option::cre...additionalProperties`') of type `Yaoi\Command\Option` is incompatible with the declared type `boolean` of property `$enableDefaultAdditionalProperties`. 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...
71			->setDescription('Add field property for undefined `additionalProperties`');
72
73			$options->fluentSetters = Option::create()
			0 ignored issues – show Documentation Bug introduced 2020-12-13 15:17 UTC by Report Bug Copy Issue Report It seems like `Yaoi\Command\Option::cre...ters to struct fields')` of type `Yaoi\Command\Option` is incompatible with the declared type `boolean` of property `$fluentSetters`. 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...
74			->setDescription('Add fluent setters to struct fields');
75
76			$options->ignoreRequired = Option::create()
			0 ignored issues – show Documentation Bug introduced 2020-12-13 15:17 UTC by Report Bug Copy Issue Report It seems like `Yaoi\Command\Option::cre...ter type or omitempty')` of type `Yaoi\Command\Option` is incompatible with the declared type `boolean` of property `$ignoreRequired`. 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...
77			->setDescription('Ignore if property is required when deciding on pointer type or omitempty');
78
79			$options->renames = Option::create()->setIsVariadic()->setType()
			0 ignored issues – show Documentation Bug introduced 2020-12-13 11:16 UTC by Report Bug Copy Issue Report It seems like `Yaoi\Command\Option::cre...ames, example From:To')` of type `Yaoi\Command\Option` is incompatible with the declared type `array<string,string>` of property `$renames`. 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...
80			->setDescription('Map of exported symbol renames, example From:To');
81
82			$options->requireXGenerate = Option::create()
			0 ignored issues – show Documentation Bug introduced 2020-12-13 15:17 UTC by Report Bug Copy Issue Report It seems like Yaoi\Command\Option::cre...-generate: true` only') of type `Yaoi\Command\Option` is incompatible with the declared type `boolean` of property `$requireXGenerate`. 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...
83			->setDescription('Generate properties with `x-generate: true` only');
84
85			$options->validateRequired = Option::create()
			0 ignored issues – show Documentation Bug introduced 2020-12-13 15:17 UTC by Report Bug Copy Issue Report It seems like `Yaoi\Command\Option::cre...ties during unmarshal')` of type `Yaoi\Command\Option` is incompatible with the declared type `boolean` of property `$validateRequired`. 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...
86			->setDescription('Generate validation code to check required properties during unmarshal');
87
88			$options->nameTags = Option::create()->setIsVariadic()->setType()
			0 ignored issues – show Documentation Bug introduced 2020-09-30 08:02 UTC by Report Bug Copy Issue Report It seems like `Yaoi\Command\Option::cre..., example "msgp bson"')` of type `Yaoi\Command\Option` is incompatible with the declared type `string[]` of property `$nameTags`. 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...
89			->setDescription('Set additional field tags with property name, example "msgp bson"');
90
91			$options->config = Option::create()->setType()
			0 ignored issues – show Documentation Bug introduced 2022-09-15 23:48 UTC by Report Bug Copy Issue Report It seems like `Yaoi\Command\Option::cre...options from. Schema:')` of type `Yaoi\Command\Option` is incompatible with the declared type `string` of property `$config`. 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...
92			->setDescription('Path to config JSON file to load options from. Schema:');
93
94			$tb = new TypeBuilder();
95			$tb->getTypeString(Options::schema()->exportSchema());
96			$options->config->description .= "\n" . trim(substr($tb->file, 97)); // Stripping header.
97			}
98
99			/**
100			* @return Options
101			* @throws ExitCode
102			*/
103			protected function makeGoBuilderOptions()
104			{
105			$options = new Options();
106			if (!empty($this->config)) {
107			$data = file_get_contents($this->config);
108			if (empty($data)) {
109			throw new ExitCode("empty or missing config file", 1);
110			}
111			$json = json_decode($data);
112			if (empty($json)) {
113			throw new ExitCode("invalid json in config file", 1);
114			}
115
116			$options = Options::import($json);
117			}
118
119			$options = $options->jsonSerialize();
120
121			$options->hideConstProperties = !$this->showConstProperties;
122			$options->trimParentFromPropertyNames = !$this->keepParentInPropertyNames;
123			$options->ignoreNullable = $this->ignoreNullable;
124			$options->ignoreXGoType = $this->ignoreXGoType;
125			$options->withZeroValues = $this->withZeroValues;
126			$options->enableXNullable = $this->enableXNullable;
127			$options->defaultAdditionalProperties = $this->enableDefaultAdditionalProperties;
128			$options->fluentSetters = $this->fluentSetters;
129			$options->ignoreRequired = $this->ignoreRequired;
130			$options->requireXGenerate = $this->requireXGenerate;
131			$options->validateRequired = $this->validateRequired;
132			$options->nameTags = $this->nameTags;
133			if (!empty($this->renames)) {
134			foreach ($this->renames as $rename) {
135			$rename = explode(':', $rename, 2);
136			$options->renames[$rename[0]] = $rename[1];
137			}
138			}
139
140			return $options;
			0 ignored issues – show Bug Best Practice introduced 2022-09-15 23:48 UTC by Report Bug Copy Issue Report The expression `return $options` returns the type `stdClass` which is incompatible with the documented return type `Swaggest\GoCodeBuilder\JsonSchema\Options`. Loading history...
141			}
142
143			}

swaggest / json-cli

BuilderOptions::makeGoBuilderOptions() B last analyzed 2023-12-19 01:16 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

BuilderOptions::makeGoBuilderOptions() B
last analyzed 2023-12-19 01:16 UTC