Merge pull request #3 from fd6130/updates

Update for version 1.1.0

Author: fd6130

README.md

@@ -1,23 +1,12 @@
 # hsl-bundle
 
-hsl-bundle provide you some nice feature that you might / might not needed:
+hsl-bundle provide you some nice feature that can help you to speed up your development:
 
 - maker command for DTOs (DTOs are use for POST and PUT request)
 - maker command for Transformers (customize your result)
 - maker command for API CRUD Controller (boilerplate code for your need)
 - pagination (it is integrated during the controller creation)
 
-## For php 8 user
-
-There is one library that will cause error in php 8, for temporarily solution please add this code to your composer.json before require this bundle:
-
-```json
-"repositories": [
-    {
-        "type": "vcs",
-        "url": "https://github.com/fd6130/api-filter-bundle.git"
-    }
-]
 ```
 
 ## Prerequisites

composer.json

@@ -1,6 +1,7 @@
 {
     "name": "fd6130/hsl-bundle",
-    "description": "This bundle provide some ease of development for Symfony beginner.",
+    "description": "This bundle provide some ease of development for Symfony beginner. You can now create a CRUD controller very fast and it comes with DTO validation, mapping and pagination.",
+    "keywords": ["Symfony", "symfony", "bundle", "DTO", "dto", "dto validation", "dto mapping", "pagination", "controller"],
     "type": "symfony-bundle",
     "license": "MIT",
     "autoload": {
@@ -10,34 +11,24 @@
     },
     "require": {
         "php": ">=7.2.5",
-        "samj/fractal-bundle": "^4.0",
         "babdev/pagerfanta-bundle": "^3.0",
         "mark-gerarts/automapper-plus-bundle": "^1.2",
-        "fd6130/api-filter-bundle": "1.2.*",
-        "symfony-bundles/json-request-bundle": "^4.0",
+        "monterhealth/api-filter-bundle": "1.2.*",
         "pagerfanta/pagerfanta": "^3.0",
+        "symfony-bundles/json-request-bundle": "^4.0",
+        "samj/fractal-bundle": "^4.0",
         "symfony/validator": "^4.4|^5.0",
-        "doctrine/annotations": "^1.13"
+        "symfony/yaml": "^4.4|^5.0",
+        "doctrine/inflector": "^2.0"
     },
     "require-dev": {
-        "symfony/maker-bundle": "^1.0",
-        "easycorp/easy-deploy-bundle": "^1.0"
+        "symfony/maker-bundle": "^1.0"
     },
     "suggest": {
+        "easycorp/easy-deploy-bundle": "For easy deploy",
         "vich/uploader-bundle": "For file upload",
         "lexik/jwt-authentication-bundle": "Install this if you need JWT authentication",
-        "etnynl/jwt-refresh-token-bundle": "Install this if you need JWT refresh token",
-        "symfony/webpack-encore-bundle": "Install this if you need Webpack to manage your assets",
-        "twig/cssinliner-extra": "For email css",
-        "twig/extra-bundle": "For email css",
-        "twig/inky-extra": "For email css",
         "nesbot/carbon": "Easy format your datetime",
         "nelmio/cors-bundle": "CORS management"
-    },
-    "repositories": [
-        {
-            "type": "vcs",
-            "url": "https://github.com/fd6130/api-filter-bundle.git"
-        }
-    ]
+    }
 }

src/Dto/DtoRequestResolver.php

@@ -60,7 +60,7 @@ public function resolve(Request $request, ArgumentMetadata $argument)
                 $errorMessages [] = $error->getPropertyPath() . ' => ' . $error->getMessage();
             }
 
-            throw new DtoValidationException(sprintf("Fail to pass DTO validation at '%s'", get_class($dto)), $errorMessages);
+            throw new DtoValidationException('', $errorMessages);
         }
 
         yield $dto;

src/Dto/Validator/DtoValidator.php

@@ -0,0 +1,39 @@
+<?php
+
+namespace Fd\HslBundle\Dto\Validator;
+
+use Fd\HslBundle\Dto\DtoRequestInterface;
+use Fd\HslBundle\Exception\DtoValidationException;
+use Symfony\Component\Validator\Validator\ValidatorInterface;
+
+class DtoValidator implements DtoValidatorInterface
+{
+    private $validator;
+
+    public function __construct(ValidatorInterface $validator)
+    {
+        $this->validator = $validator;
+    }
+
+    /**
+     * @param DtoRequestInterface $dto The data transfer object class
+     * 
+     * @throws DtoValidationException
+     */
+    public function validate(DtoRequestInterface $dto)
+    {
+        $errors = $this->validator->validate($dto);
+        
+        if(count($errors) > 0)
+        {
+            $errorMessages = [];
+
+            foreach($errors as $error)
+            {
+                $errorMessages [] = $error->getPropertyPath() . ' => ' . $error->getMessage();
+            }
+
+            throw new DtoValidationException($errorMessages);
+        }
+    }
+}

src/Dto/Validator/DtoValidatorInterface.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace Fd\HslBundle\Dto\Validator;
+
+use Fd\HslBundle\Dto\DtoRequestInterface;
+
+interface DtoValidatorInterface
+{
+    /**
+     * @param DtoRequestInterface $dto The data transfer object class
+     * 
+     * @throws DtoValidationException
+     */
+    public function validate(DtoRequestInterface $dto);
+}

src/Exception/DtoValidationException.php

@@ -10,11 +10,11 @@ class DtoValidationException extends HttpException
     protected $context = [];
 
     /**
-     * @param null|string|array     $message  Message for this error
+     * @param string|array $message 
      */
     public function __construct(?string $message = '', array $context = [])
     {
-        $message = $message ? $message : 'DTO validation fail.';
+        $message = !empty($message) ? $message : 'DTO validation fail.';
         $this->context = $context;
 
         parent::__construct(400, $message, null, [] , 0);

src/Maker/MakeHslCrud.php

@@ -35,9 +35,7 @@ public function __construct(DoctrineHelper $doctrineHelper)
     {
         $this->doctrineHelper = $doctrineHelper;
 
-        if (class_exists(InflectorFactory::class)) {
-            $this->inflector = InflectorFactory::create()->build();
-        }
+        $this->inflector = InflectorFactory::create()->build();
     }
 
     public static function getCommandName(): string
@@ -47,7 +45,7 @@ public static function getCommandName(): string
 
     public static function getCommandDescription(): string
     {
-        return 'Creates a new controller class';
+        return 'Create a generic CRUD controller.';
     }
 
     /**
@@ -174,19 +172,11 @@ public function configureDependencies(DependencyBuilder $dependencies)
 
     private function pluralize(string $word): string
     {
-        if (null !== $this->inflector) {
-            return $this->inflector->pluralize($word);
-        }
-
-        return LegacyInflector::pluralize($word);
+        return $this->inflector->pluralize($word);
     }
 
     private function singularize(string $word): string
     {
-        if (null !== $this->inflector) {
-            return $this->inflector->singularize($word);
-        }
-
-        return LegacyInflector::singularize($word);
+        return $this->inflector->singularize($word);
     }
 }

src/Maker/MakeHslDto.php

@@ -42,10 +42,9 @@ public static function getCommandName(): string
 
     public static function getCommandDescription(): string
     {
-        return 'Creates a new dto class';
+        return 'Create a data transfer object class for mapping purpose.';
     }
 
-
     public function configureCommand(Command $command, InputConfiguration $inputConf)
     {
         $command

src/Maker/MakeHslTransformer.php

@@ -49,10 +49,9 @@ public static function getCommandName(): string
 
     public static function getCommandDescription(): string
     {
-        return 'Creates a new transformer class';
+        return 'Create a transformer class for transforming data to your flavour.';
     }
 
-
     public function configureCommand(Command $command, InputConfiguration $inputConf)
     {
         $command

src/Resources/config/services.yaml

@@ -14,17 +14,24 @@ services:
     tags: ["maker.command"]
 
   # Dto services
-  fdhsl.dto.dto_request_resolver:
-    class: Fd\HslBundle\Dto\DtoRequestResolver
+  Fd\HslBundle\Dto\DtoRequestResolver:
     arguments: ["@validator"]
     tags:
       - { name: "controller.argument_value_resolver", priority: 50 }
 
+  fdhsl.dto.validator.dto_validator:
+    class: Fd\HslBundle\Dto\Validator\DtoValidator
+    arguments: ["@validator"]
+  Fd\HslBundle\Dto\Validator\DtoValidator:
+    arguments: ["@validator"]
+  Fd\HslBundle\Dto\Validator\DtoValidatorInterface: "@fdhsl.dto.validator.dto_validator"
+
   # paginator
   fdhsl.pagination.paginator:
     class: Fd\HslBundle\Pagination\Paginator
     arguments: ["@router", "@request_stack"]
-
+  Fd\HslBundle\Pagination\Paginator:
+    arguments: ["@router", "@request_stack"]
   Fd\HslBundle\Pagination\PaginatorInterface: "@fdhsl.pagination.paginator"
 
   # DtoValidationException