, (*1)
About
Class Generator Bundle
- Generate classes, interfaces and PHPUnit test classes from the YAML schema.
- Generator does not overwrite existing methods or properties, only renders new elements.
- Generated entity class is compatible with JMS Serializer, each property has an annotation @Type based on a property type.
- Also each property has an annotation @SerializedName which can be adjusted as in the example below (user_setting).
- Generator allows to add Symfony constraints to a property.
- Generator allows to handle inheritance., (*2)
Installation
$ php composer.phar require slawomirkania/class-generator-bundle dev-master
Symfony configuration
app/config/config.yml, (*3)
framework:
validation: { enable_annotations: true }
app/AppKernel.php, (*4)
public function registerBundles()
{
if (in_array($this->getEnvironment(), array('dev', 'test'), true)) {
//...
$bundles[] = new HelloWordPl\SimpleEntityGeneratorBundle\HelloWordPlSimpleEntityGeneratorBundle();
//...
}
//...
}
Usage
Create YAML structure as below
-
namespace: \AppBundle\Api\Command\UserUpdate
extends: \AppBundle\Api\Command\Request
configuration:
no_interface: true
no_phpunit_class: true
comment: "Update user data command"
# in multiline comment you can put whatever you want eg. annotations, poems etc.
multiline_comment:
- 'lorem ipsum'
- 'second row'
- '@\Doctrine\Common\Annotations\Entity()'
# you can overwrite default template for specific class, constructor, interface and test class
class_manager_template_path: 'YourOwnBundle/Resources/templates/YourOwnClassManagerTemplate.txt'
class_constructor_manager_template_path: 'YourOwnBundle/Resources/templates/YourOwnClassConstructorManagerTemplate.txt'
interface_manager_template_path: 'YourOwnBundle/Resources/templates/YourOwnInterfaceManagerTemplate.txt'
test_class_manager_template_path: 'YourOwnBundle/Resources/templates/YourOwnTestClassManagerTemplate.txt'
properties:
-
name: username
type: string
comment: "Username for login"
constraints:
- NotBlank(message = "Login can not be empty")
- NotNull(message = "Login can not be null")
# you can overwrite default template for specific property, setter, getter etc.
property_manager_template_path: 'YourOwnBundle/Resources/templates/YourOwnPropertyManagerTemplate.txt'
test_class_method_manager_template_path: 'YourOwnBundle/Resources/templates/YourOwnTestClassManagerTemplate.txt'
method_getter_boolean_interface_manager_template_path: 'YourOwnBundle/Resources/templates/YourOwnMethodGetterBooleanInterfaceManagerTemplate.txt'
method_getter_boolean_manager_template_path: 'YourOwnBundle/Resources/templates/YourOwnMethodGetterBooleanManagerTemplate.txt'
method_getter_interface_manager_template_path: 'YourOwnBundle/Resources/templates/YourOwnMethodGetterInterfaceManagerTemplate.txt'
method_getter_manager_template_path: 'YourOwnBundle/Resources/templates/YourOwnMethodGetterManagerTemplate.txt'
-
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:
- Type(type = "boolean")
# you can overwrite default template for specific property, setter, getter etc.
method_setter_interface_manager_template_path: 'YourOwnBundle/Resources/templates/YourOwnMethodSetterInterfaceManagerTemplate.txt'
method_setter_manager_template_path: 'YourOwnBundle/Resources/templates/YourOwnMethodSetterManagerTemplate.txt'
-
name: groups
type: Doctrine\Common\Collections\ArrayCollection<AppBundle\Api\Param\Group>
comment: User groups
-
# default comment
name: user_setting
serialized_name: userSetting
type: AppBundle\Api\Param\Setting
# Setter allows 'null' value. Default 'false'.
optional: true
-
namespace: \AppBundle\Api\Param\Group
# no comment
properties:
-
name: name
type: string
comment: "Group name"
constraints:
- NotBlank()
-
name: description
type: string
comment: "Group description"
-
namespace: \AppBundle\Api\Param\Setting
# no comment
# no properties
Put {file_name_with_extension} YAML file into {bundle_name}\Resources\config\, (*5)
Run Symfony command, (*6)
$ ./bin/console class_generator:generate {bundle_name} {file_name_with_extension}
Options (optional), (*7)
--no-interfaces - Switches off interfaces generating, (*8)
--no-phpunit-classes - Switches off PHPUnit classes generating, (*9)
--only-simulate-file - Simulation of generating classes from file and show summary, (*10)
You can also define configuration for specific class, see \AppBundle\Api\Command\UserUpdate in YAML definition above., (*11)
$ ./bin/console class_generator:generate {bundle_name} {file_name_with_extension} --no-interfaces --no-phpunit-classes
After processing generated tests (if test classes generated), by command e.g., (*12)
phpunit {base_url}/src/AppBundle/Tests/
you should see an error because class \AppBundle\Api\Command\Request does not exist.
Append the following minimalistic code to the YAML structure {bundle_name}\Resources\config{file_name_with_extension}, (*13)
-
namespace: \AppBundle\Api\Command\Request
comment: "Base class for commands"
# no properties
Remove code generated before, because when some class has syntax error, generator can not work properly.
Run Symfony command again.
Execute tests again and then you should see something like this:, (*14)
...IIIIIIIIIII.IIII.
Time: 124 ms, Memory: 6.75Mb
Now you can implement missing tests cases.
Tip: For better code format quality use PHP-CS-Fixer on generated files, (*15)
Generated files namespaces:
- AppBundle\Api\Command\Request
- AppBundle\Api\Command\RequestInterface (when no --no-interfaces option)
-
AppBundle\Tests\Api\Command\RequestTest (when no --no-phpunit-classes option), (*16)
-
AppBundle\Api\Command\UserUpdate, (*17)
- AppBundle\Api\Command\UserUpdateInterface (when no --no-interfaces option)
-
AppBundle\Tests\Api\Command\UserUpdateTest (when no --no-phpunit-classes option), (*18)
-
AppBundle\Api\Param\Group, (*19)
- AppBundle\Api\Param\GroupInterface (when no --no-interfaces option)
-
AppBundle\Tests\Api\Param\GroupTest (when no --no-phpunit-classes option), (*20)
-
AppBundle\Api\Param\Setting, (*21)
- AppBundle\Api\Param\SettingInterface (when no --no-interfaces option)
- AppBundle\Tests\Api\Param\SettingTest (when no --no-phpunit-classes option)
You can check how deserialization of generated classes works., (*22)
{
"username": "slawomir",
"email": "slawomir.kania1@gmail.com",
"active": true,
"groups": [
{
"name": "admin",
"description": "admin group"
},
{
"name": "guest",
"description": "guest group"
}
],
"userSetting": {
}
}
...
$json = "{...}";
$serializer = \JMS\Serializer\SerializerBuilder::create()->build();
$userUpdateDeserialized = $serializer->deserialize($json, "AppBundle\Api\Command\UserUpdate", "json");
var_dump($userUpdateDeserialized);
...
You can override default template for each element in generator.
Templates are placed in src/HelloWordPl/SimpleEntityGeneratorBundle/Resources/templates/ directory., (*23)
ClassConstructorManagerTemplatePath - Constructor template
ClassManagerTemplatePath - Class template
InitPropertyManagerTemplatePath - Initialization ArrayCollection property in constructor template
InterfaceManagerTemplatePath - Interface template
MethodGetterBooleanInterfaceManagerTemplatePath - Interface boolean getter template
MethodGetterBooleanManagerTemplatePath - Class boolean getter template
MethodGetterInterfaceManagerTemplatePath - Interface common getter template
MethodGetterManagerTemplatePath - Class getter template
MethodSetterInterfaceManagerTemplatePath - Interface boolean setter template
MethodSetterManagerTemplatePath - Class setter template
PropertyManagerTemplatePath - Class property template
TestClassManagerTemplatePath - PHPUnit class template
TestMethodManagerTemplatePath - PHPUnit class method template, (*24)
If you want to replace default item template you have to create your own template (take a look at methods getTemplateTags in each Item Manager src/HelloWordPl/SimpleEntityGeneratorBundle/Lib/Items/*.php, for tags which you can use in your own template)..., (*25)
/**
* My own template for interface getter
*
* <comment>
* @return <property_type>
*/
final public function <method_name>MyImagination();
...and set proper template directory (in parameters.yml) which consists of bundle name and path inside this bundle, e.g., (*26)
parameters:
...
MethodGetterInterfaceManagerTemplatePath: 'YourOwnBundle/Resources/templates/YourOwnMethodGetterInterfaceTemplate.txt'
...
You can also overwrite all methods in Renderer, by creating new Renderer class which extends default renderer class.
All you need to do is set new Renderer class namespace in parameters.yml, (*27)
parameters:
...
SegRendererClass: "YourOwnBundle\\Lib\\OwnRendererClass"
...
Changelog
- Ability to disable/enable interface and/or test class generating per class
- Item template overwriting supported
- Multiline comments for class and property supported
- Optional parameter for setter
License
The MIT License (MIT), (*28)
Copyright (c) 2016 Sławomir Kania, (*29)
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:, (*30)
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software., (*31)
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE., (*32)
Wallogit.com
