Helper::getStructureYaml() - Code Metrics - Inspection of "Daily Inspection: Merge pull request #8 from komik..." - slawomirkania/class-generator-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — master (3b8125)

unknown

created 2020-10-28 14:03 UTC

Helper::getStructureYaml() B

↳ Parent: Helper

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	73
rs	8.589
c	0
b	0
f	0
cc	1
nc	1
nop	0

How to fix Long Method

<?php

namespace HelloWordPl\SimpleEntityGeneratorBundle\Tests\Lib;

use Doctrine\Common\Collections\ArrayCollection;
use HelloWordPl\SimpleEntityGeneratorBundle\Lib\Items\ClassManager;
use HelloWordPl\SimpleEntityGeneratorBundle\Lib\Items\PropertyManager;

/**
 * @author Sławomir Kania <[email protected]>
 */
class Helper
{

    /**
     * @param string $name
     * @param string $type
     * @param string $comment
     * @param array $constraintsParts
     * @return PropertyManager
     */
    public static function prepareProperty($name, $type, $comment = "", array $constraintsParts = [])
    {
        $propertyManager = new PropertyManager();
        $propertyManager->setName($name);
        $propertyManager->setType($type);
        $propertyManager->setComment($comment);

        $constraintCollection = new ArrayCollection();
        foreach ($constraintsParts as $constraintPart) {
            $constraintCollection->add($constraintPart);
        }

        $propertyManager->setConstraints($constraintCollection);

        return $propertyManager;
    }

    /**
     * @param string $namespace
     * @return ClassManager
     */
    public static function prepareBasicClassManager($namespace = "\AppBundle\Entity\User")
    {
        $classManager = new ClassManager();
        $classManager->setNamespace($namespace);
        $classManager->setComment("User entity for tests");

        $propertiesCollection = new ArrayCollection();
        $propertiesCollection->add(self::prepareProperty("full_name", "string", "", ["NotBlank()"]));
        $propertiesCollection->add(self::prepareProperty("email", "string", "", ["Email(message = \"Invalid email!\")"]));
        $propertiesCollection->add(self::prepareProperty("active", "boolean", "Wether user active", ["Type(type='boolean')", "IsTrue()"]));
        $propertiesCollection->add(self::prepareProperty("new_posts", "Doctrine\Common\Collections\ArrayCollection<AppBundle\Entity\Post>", "User new posts", ["NotNull()", "Valid()"]));

        $classManager->setProperties($propertiesCollection);

        return $classManager;
    }

    /**
     * @return string
     */
    public static function getStructureYaml()
    {
        return '
-
  namespace: \AppBundle\Entity\User
  extends: \AppBundle\Entity\Base
  comment: "New User entity"
  multiline_comment:
      - \'lorem ipsum\'
      - \'second row\'
      - \'@\Doctrine\Common\Annotations\Entity()\'
  properties:
    -
      name: username
      type: string
      comment: "Username for login"
      constraints:
        - NotBlank(message = "Login can not be empty")
        - NotNull(message = "Login can not be null")
    -
      name: email
      type: string
      comment: "User email"
      multiline_comment:
        - \'@\Doctrine\Common\Annotations\Column()\'
        - \'lorem ipsum\'
        - \'third row\'
      constraints:
        - NotBlank()
        - Email(message = "Invalid email")
    -
      name: active
      type: boolean
      comment: "Wether user is active or not"
      constraints:
        - IsTrue()
    -
      name: posts
      type: Doctrine\Common\Collections\ArrayCollection<AppBundle\Entity\Post>
      comment: User posts
    -
      # default comment
      name: created_at
      type: DateTime
    -
      # default comment
      name: updated_at
      type: DateTime
    -
      # default comment
      name: last_post
      serialized_name: lastPost
      type: AppBundle\Entity\Post
      optional: true
-
  namespace: \AppBundle\Entity\Post
  # no comment
  properties:
    -
      name: content
      type: string
      comment: "Post content"
      constraints:
        - NotBlank()
    -
      # default comment
      name: created_at
      type: DateTime
    -
      # default comment
      name: updated_at
      type: DateTime';
    }

    /**
     * @return string
     */
    public static function getStructureYamlForTemplateChangeTest()
    {
        return '
-
  namespace: \AppBundle\Entity\User
  extends: \AppBundle\Entity\Base
  comment: "New User entity"
  configuration:
    no_interface: false
    no_phpunit_class: false
  multiline_comment:
      - \'lorem ipsum\'
      - \'second row\'
      - \'@\Doctrine\Common\Annotations\Entity()\'
  class_manager_template_path: HelloWordPlSimpleEntityGeneratorBundle/Resources/templates_for_test/ClassTemplate.txt
  class_constructor_manager_template_path: HelloWordPlSimpleEntityGeneratorBundle/Resources/templates_for_test/ClassConstructorTemplate.txt
  interface_manager_template_path: HelloWordPlSimpleEntityGeneratorBundle/Resources/templates_for_test/InterfaceTemplate.txt
  test_class_manager_template_path: HelloWordPlSimpleEntityGeneratorBundle/Resources/templates_for_test/TestClassTemplate.txt
  properties:
    -
      name: id
      type: integer
      method_setter_interface_manager_template_path: HelloWordPlSimpleEntityGeneratorBundle/Resources/templates_for_test/MethodSetterInterfaceTemplate.txt
      method_setter_manager_template_path: HelloWordPlSimpleEntityGeneratorBundle/Resources/templates_for_test/MethodSetterTemplate.txt
      property_manager_template_path: HelloWordPlSimpleEntityGeneratorBundle/Resources/templates_for_test/PropertyTemplate.txt
      test_class_method_manager_template_path: HelloWordPlSimpleEntityGeneratorBundle/Resources/templates_for_test/TestMethodTemplate.txt
      method_getter_interface_manager_template_path: HelloWordPlSimpleEntityGeneratorBundle/Resources/templates_for_test/MethodGetterInterfaceTemplate.txt
      method_getter_manager_template_path: HelloWordPlSimpleEntityGeneratorBundle/Resources/templates_for_test/MethodGetterTemplate.txt
    -
      name: username
      type: string
      comment: "Username for login"
      constraints:
        - NotBlank(message = "Login can not be empty")
        - NotNull(message = "Login can not be null")
    -
      name: posts
      type: Doctrine\Common\Collections\ArrayCollection<AppBundle\Entity\Post>
      comment: User posts
    -
      name: active
      type: boolean
      comment: "Wether user is active or not"
      constraints:
        - IsTrue()
      method_getter_boolean_interface_manager_template_path: HelloWordPlSimpleEntityGeneratorBundle/Resources/templates_for_test/MethodGetterBooleanInterfaceTemplate.txt
      method_getter_boolean_manager_template_path: HelloWordPlSimpleEntityGeneratorBundle/Resources/templates_for_test/MethodGetterBooleanTemplate.txt
      method_getter_manager_template_path: HelloWordPlSimpleEntityGeneratorBundle/Resources/templates_for_test/EmptyTemplate.txt';
    }

    public static function getStructureYamlForTestInlineClassConfuration()
    {
        return '
-
  namespace: \AppBundle\Entity\Post
  configuration:
    no_interface: true
    no_phpunit_class: true
  properties:
    -
      name: id
      type: integer';
    }
}


1			<?php
2
3			namespace HelloWordPl\SimpleEntityGeneratorBundle\Tests\Lib;
4
5			use Doctrine\Common\Collections\ArrayCollection;
6			use HelloWordPl\SimpleEntityGeneratorBundle\Lib\Items\ClassManager;
7			use HelloWordPl\SimpleEntityGeneratorBundle\Lib\Items\PropertyManager;
8
9			/**
10			* @author Sławomir Kania <[email protected]>
11			*/
12			class Helper
13			{
14
15			/**
16			* @param string $name
17			* @param string $type
18			* @param string $comment
19			* @param array $constraintsParts
20			* @return PropertyManager
21			*/
22			public static function prepareProperty($name, $type, $comment = "", array $constraintsParts = [])
23			{
24			$propertyManager = new PropertyManager();
25			$propertyManager->setName($name);
26			$propertyManager->setType($type);
27			$propertyManager->setComment($comment);
28
29			$constraintCollection = new ArrayCollection();
30			foreach ($constraintsParts as $constraintPart) {
31			$constraintCollection->add($constraintPart);
32			}
33
34			$propertyManager->setConstraints($constraintCollection);
35
36			return $propertyManager;
37			}
38
39			/**
40			* @param string $namespace
41			* @return ClassManager
42			*/
43			public static function prepareBasicClassManager($namespace = "\AppBundle\Entity\User")
44			{
45			$classManager = new ClassManager();
46			$classManager->setNamespace($namespace);
47			$classManager->setComment("User entity for tests");
48
49			$propertiesCollection = new ArrayCollection();
50			$propertiesCollection->add(self::prepareProperty("full_name", "string", "", ["NotBlank()"]));
51			$propertiesCollection->add(self::prepareProperty("email", "string", "", ["Email(message = \"Invalid email!\")"]));
52			$propertiesCollection->add(self::prepareProperty("active", "boolean", "Wether user active", ["Type(type='boolean')", "IsTrue()"]));
53			$propertiesCollection->add(self::prepareProperty("new_posts", "Doctrine\Common\Collections\ArrayCollection<AppBundle\Entity\Post>", "User new posts", ["NotNull()", "Valid()"]));
54
55			$classManager->setProperties($propertiesCollection);
56
57			return $classManager;
58			}
59
60			/**
61			* @return string
62			*/
63			public static function getStructureYaml()
64			{
65			return '
66			-
67			namespace: \AppBundle\Entity\User
68			extends: \AppBundle\Entity\Base
69			comment: "New User entity"
70			multiline_comment:
71			- \'lorem ipsum\'
72			- \'second row\'
73			- \'@\Doctrine\Common\Annotations\Entity()\'
74			properties:
75			-
76			name: username
77			type: string
78			comment: "Username for login"
79			constraints:
80			- NotBlank(message = "Login can not be empty")
81			- NotNull(message = "Login can not be null")
82			-
83			name: email
84			type: string
85			comment: "User email"
86			multiline_comment:
87			- \'@\Doctrine\Common\Annotations\Column()\'
88			- \'lorem ipsum\'
89			- \'third row\'
90			constraints:
91			- NotBlank()
92			- Email(message = "Invalid email")
93			-
94			name: active
95			type: boolean
96			comment: "Wether user is active or not"
97			constraints:
98			- IsTrue()
99			-
100			name: posts
101			type: Doctrine\Common\Collections\ArrayCollection<AppBundle\Entity\Post>
102			comment: User posts
103			-
104			# default comment
105			name: created_at
106			type: DateTime
107			-
108			# default comment
109			name: updated_at
110			type: DateTime
111			-
112			# default comment
113			name: last_post
114			serialized_name: lastPost
115			type: AppBundle\Entity\Post
116			optional: true
117			-
118			namespace: \AppBundle\Entity\Post
119			# no comment
120			properties:
121			-
122			name: content
123			type: string
124			comment: "Post content"
125			constraints:
126			- NotBlank()
127			-
128			# default comment
129			name: created_at
130			type: DateTime
131			-
132			# default comment
133			name: updated_at
134			type: DateTime';
135			}
136
137			/**
138			* @return string
139			*/
140			public static function getStructureYamlForTemplateChangeTest()
141			{
142			return '
143			-
144			namespace: \AppBundle\Entity\User
145			extends: \AppBundle\Entity\Base
146			comment: "New User entity"
147			configuration:
148			no_interface: false
149			no_phpunit_class: false
150			multiline_comment:
151			- \'lorem ipsum\'
152			- \'second row\'
153			- \'@\Doctrine\Common\Annotations\Entity()\'
154			class_manager_template_path: HelloWordPlSimpleEntityGeneratorBundle/Resources/templates_for_test/ClassTemplate.txt
155			class_constructor_manager_template_path: HelloWordPlSimpleEntityGeneratorBundle/Resources/templates_for_test/ClassConstructorTemplate.txt
156			interface_manager_template_path: HelloWordPlSimpleEntityGeneratorBundle/Resources/templates_for_test/InterfaceTemplate.txt
157			test_class_manager_template_path: HelloWordPlSimpleEntityGeneratorBundle/Resources/templates_for_test/TestClassTemplate.txt
158			properties:
159			-
160			name: id
161			type: integer
162			method_setter_interface_manager_template_path: HelloWordPlSimpleEntityGeneratorBundle/Resources/templates_for_test/MethodSetterInterfaceTemplate.txt
163			method_setter_manager_template_path: HelloWordPlSimpleEntityGeneratorBundle/Resources/templates_for_test/MethodSetterTemplate.txt
164			property_manager_template_path: HelloWordPlSimpleEntityGeneratorBundle/Resources/templates_for_test/PropertyTemplate.txt
165			test_class_method_manager_template_path: HelloWordPlSimpleEntityGeneratorBundle/Resources/templates_for_test/TestMethodTemplate.txt
166			method_getter_interface_manager_template_path: HelloWordPlSimpleEntityGeneratorBundle/Resources/templates_for_test/MethodGetterInterfaceTemplate.txt
167			method_getter_manager_template_path: HelloWordPlSimpleEntityGeneratorBundle/Resources/templates_for_test/MethodGetterTemplate.txt
168			-
169			name: username
170			type: string
171			comment: "Username for login"
172			constraints:
173			- NotBlank(message = "Login can not be empty")
174			- NotNull(message = "Login can not be null")
175			-
176			name: posts
177			type: Doctrine\Common\Collections\ArrayCollection<AppBundle\Entity\Post>
178			comment: User posts
179			-
180			name: active
181			type: boolean
182			comment: "Wether user is active or not"
183			constraints:
184			- IsTrue()
185			method_getter_boolean_interface_manager_template_path: HelloWordPlSimpleEntityGeneratorBundle/Resources/templates_for_test/MethodGetterBooleanInterfaceTemplate.txt
186			method_getter_boolean_manager_template_path: HelloWordPlSimpleEntityGeneratorBundle/Resources/templates_for_test/MethodGetterBooleanTemplate.txt
187			method_getter_manager_template_path: HelloWordPlSimpleEntityGeneratorBundle/Resources/templates_for_test/EmptyTemplate.txt';
188			}
189
190			public static function getStructureYamlForTestInlineClassConfuration()
191			{
192			return '
193			-
194			namespace: \AppBundle\Entity\Post
195			configuration:
196			no_interface: true
197			no_phpunit_class: true
198			properties:
199			-
200			name: id
201			type: integer';
202			}
203			}
204

slawomirkania / class-generator-bundle

Branch — master (3b8125)

Helper::getStructureYaml() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like