[TASK] Make author fields optional

Due to data minimization, users should not be required to enter their email address or website to use the Site Package Builder. The vendor many ppl use is not the same as the company name. Also, not everyone works in a company (freelancers, universities, ...) and some customers or organizations want their own vendor no matter who created the site package. Make vendor its own field.
TYPO3 · Nov 30, 2024 · 892b864 · 892b864
1 parent 124f6dd
commit 892b864
Show file tree

Hide file tree

Showing 7 changed files with 52 additions and 38 deletions.
diff --git a/src/Controller/SitePackageController.php b/src/Controller/SitePackageController.php
@@ -54,7 +54,7 @@ public function new(Request $request): Response
         $form = $this->createNewSitePackageForm($sitepackage);
         $form->handleRequest($request);
         if ($form->isSubmitted() && $form->isValid()) {
-            $sitepackage->setVendorName(StringUtility::stringToUpperCamelCase($sitepackage->getAuthor()->getCompany()));
+            $sitepackage->setVendorName(StringUtility::stringToUpperCamelCase($sitepackage->getVendorName()));
             $sitepackage->setVendorNameAlternative(StringUtility::camelCaseToLowerCaseDashed($sitepackage->getVendorName()));
             $sitepackage->setPackageName(StringUtility::stringToUpperCamelCase($sitepackage->getTitle()));
             $sitepackage->setPackageNameAlternative(StringUtility::camelCaseToLowerCaseDashed($sitepackage->getPackageName()));
@@ -90,7 +90,6 @@ public function edit(Request $request): Response
         $form = $this->createEditSitePackageForm($sitepackage);
         $form->handleRequest($request);
         if ($form->isSubmitted() && $form->isValid()) {
-            $sitepackage->setVendorName(StringUtility::stringToUpperCamelCase($sitepackage->getAuthor()->getCompany()));
             $sitepackage->setVendorNameAlternative(StringUtility::camelCaseToLowerCaseDashed($sitepackage->getVendorName()));
             $sitepackage->setPackageName(StringUtility::stringToUpperCamelCase($sitepackage->getTitle()));
             $sitepackage->setPackageNameAlternative(StringUtility::camelCaseToLowerCaseDashed($sitepackage->getPackageName()));

diff --git a/src/Entity/SitePackage.php b/src/Entity/SitePackage.php
@@ -36,15 +36,18 @@ class SitePackage implements \JsonSerializable
     #[Assert\NotBlank]
     private float $typo3Version = 13.4;
 
-    private string $vendorName;
-
     private string $vendorNameAlternative;
 
     #[Assert\NotBlank(message: 'Please enter a title for your site package')]
     #[Assert\Length(min: 3)]
     #[Assert\Regex(pattern: '/^[A-Za-z0-9\x7f-\xff .:&-]+$/', message: 'Only letters, numbers and spaces are allowed')]
     private string $title;
 
+    #[Assert\NotBlank(message: 'Please enter a vendor, CamelCase')]
+    #[Assert\Length(min: 3)]
+    #[Assert\Regex(pattern: '/^[A-Za-z0-9]+$/', message: 'Only letters and numbers are allowed')]
+    private string $vendorName;
+
     #[Assert\Regex(pattern: '/^[A-Za-z0-9\x7f-\xff .,:!?&-]+$/', message: 'Only letters, numbers and spaces are allowed')]
     private string $description;
 

diff --git a/src/Entity/SitePackage/Author.php b/src/Entity/SitePackage/Author.php
@@ -30,21 +30,18 @@
  */
 class Author implements \JsonSerializable
 {
-    #[Assert\NotBlank(message: "Please enter the authors' name.")]
-    #[Assert\Length(min: 3)]
+    #[OA\Property(type: 'string', example: 'J. Doe')]
     private string $name;
 
-    #[Assert\NotBlank(message: "Please enter the authors' email address.")]
+    #[OA\Property(type: 'string', example: '[email protected]')]
     #[Assert\Email(message: "The email '{{ value }}' is not a valid email.")]
     private string $email;
 
-    #[Assert\NotBlank(message: "Please enter the authors' company.")]
-    #[Assert\Length(min: 3)]
-    #[Assert\Regex(pattern: '/^[A-Za-z0-9\x7f-\xff .:&-]+$/', message: 'Only letters, numbers and spaces are allowed')]
+    #[Assert\Regex(pattern: '/^[\p{L}\p{N} .:&-]+$/u', message: 'Invalid characters in company name.')]
+    #[OA\Property(type: 'string', example: 'TYPO3')]
     private string $company;
 
-    #[Assert\NotBlank(message: "Please enter the authors' homepage URL.")]
-    #[Assert\Url]
+    #[OA\Property(type: 'string', example: 'https://typo3.com')]
     private string $homepage;
 
     public function getName(): string

diff --git a/src/Form/AuthorType.php b/src/Form/AuthorType.php
@@ -36,6 +36,8 @@ public function buildForm(FormBuilderInterface $builder, array $options)
     {
         $builder
             ->add('name', TextType::class, [
+                'required' => false,
+                'empty_data' => '',
                 'attr' => [
                     'autocomplete' => 'off',
                     'placeholder' => 'John Doe',
@@ -45,6 +47,8 @@ public function buildForm(FormBuilderInterface $builder, array $options)
                 ],
             ])
             ->add('email', EmailType::class, [
+                'required' => false,
+                'empty_data' => '',
                 'attr' => [
                     'autocomplete' => 'off',
                     'placeholder' => '[email protected]',
@@ -54,6 +58,8 @@ public function buildForm(FormBuilderInterface $builder, array $options)
                 ],
             ])
             ->add('company', TextType::class, [
+                'required' => false,
+                'empty_data' => '',
                 'attr' => [
                     'autocomplete' => 'off',
                     'placeholder' => 'Company Inc.',
@@ -63,6 +69,8 @@ public function buildForm(FormBuilderInterface $builder, array $options)
                 ],
             ])
             ->add('homepage', TextType::class, [
+                'required' => false,
+                'empty_data' => '',
                 'attr' => [
                     'autocomplete' => 'off',
                     'placeholder' => 'https://www.example.com',

diff --git a/src/Form/SitePackageType.php b/src/Form/SitePackageType.php
@@ -78,7 +78,16 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
                     'placeholder' => 'My Site Package',
                 ],
                 'documentation' => [
-                    'example' => 'My SitePackage',
+                    'example' => 'My Site Package',
+                ],
+            ])
+            ->add('vendor_name', TextType::class, [
+                'attr' => [
+                    'autocomplete' => 'off',
+                    'placeholder' => 'MyCompany',
+                ],
+                'documentation' => [
+                    'example' => 'MyCompany',
                 ],
             ])
             ->add('description', TextareaType::class, [

diff --git a/templates/sitepackage/success.html.twig b/templates/sitepackage/success.html.twig
@@ -105,17 +105,27 @@
             <dt class="col-sm-3">Composer</dt>
             <dd class="col-sm-9">{{ sitepackage.vendorNameAlternative }}/{{ sitepackage.packageNameAlternative }}</dd>
         </dl>
-        <h3>Author</h3>
-        <dl class="row">
-            <dt class="col-sm-3">Name</dt>
-            <dd class="col-sm-9">{{ sitepackage.author.name }}</dd>
-            <dt class="col-sm-3">E-Mail</dt>
-            <dd class="col-sm-9">{{ sitepackage.author.email }}</dd>
-            <dt class="col-sm-3">Company</dt>
-            <dd class="col-sm-9">{{ sitepackage.author.company }}</dd>
-            <dt class="col-sm-3">Homepage</dt>
-            <dd class="col-sm-9">{{ sitepackage.author.homepage }}</dd>
-        </dl>
+        {%- if sitepackage.author.name or sitepackage.author.email or sitepackage.author.company or sitepackage.author.homepage  %}
+            <h3>Author</h3>
+            <dl class="row">
+                {%- if sitepackage.author.name  %}
+                <dt class="col-sm-3">Name</dt>
+                <dd class="col-sm-9">{{ sitepackage.author.name }}</dd>
+                {%- endif %}
+                {%- if sitepackage.author.email  %}
+                <dt class="col-sm-3">E-Mail</dt>
+                <dd class="col-sm-9">{{ sitepackage.author.email }}</dd>
+                {%- endif %}
+                {%- if sitepackage.author.company  %}
+                <dt class="col-sm-3">Company</dt>
+                <dd class="col-sm-9">{{ sitepackage.author.company }}</dd>
+                {%- endif %}
+                {%- if sitepackage.author.homepage  %}
+                <dt class="col-sm-3">Homepage</dt>
+                <dd class="col-sm-9">{{ sitepackage.author.homepage }}</dd>
+                {%- endif %}
+            </dl>
+        {%- endif %}
         <p>
             <a href="{{ path('sitepackage_new') }}" class="btn btn-light">
                 <span class="btn-text">Restart</span>

diff --git a/tests/Functional/Controller/Api/SitePackageControllerTest.php b/tests/Functional/Controller/Api/SitePackageControllerTest.php
@@ -45,6 +45,7 @@ public function createSitePackage(): void
                 'base_package' => 'bootstrap_package',
                 'typo3_version' => 13.4,
                 'title' => 'My Site Package',
+                'vendor_name' => 'MyVendor',
                 'description' => 'Project Configuration for Client',
                 'repository_url' => 'https://github.com/FriendsOfTYPO3/introduction',
                 'author' => [
@@ -85,26 +86,13 @@ public function validationMissingCheck(): void
         $responseContent = json_decode((string)$response->getContent(), true, 512, JSON_THROW_ON_ERROR);
         self::assertSame($responseContent, [
             'errors' => [
+                'Please enter a vendor, CamelCase',
                 'typo3_version' => [
                     'The selected choice is invalid.',
                 ],
                 'title' => [
                     'Please enter a title for your site package',
                 ],
-                'author' => [
-                    'name' => [
-                        'Please enter the authors\' name.',
-                    ],
-                    'email' => [
-                        'Please enter the authors\' email address.',
-                    ],
-                    'company' => [
-                        'Please enter the authors\' company.',
-                    ],
-                    'homepage' => [
-                        'Please enter the authors\' homepage URL.',
-                    ],
-                ],
             ],
         ]);
     }