[FEATURE] Allow extended configuration

.ddev/config.yaml

@@ -1,4 +1,4 @@
-APIVersion: v1.12.1
+APIVersion: v1.12.2
 name: sitepackagebuilder
 type: php
 docroot: public
@@ -17,8 +17,8 @@ use_dns_when_possible: true
 timezone: Europe/Berlin
 
 
-# This config.yaml was created with ddev version v1.12.1
-# webimage: drud/ddev-webserver:v1.12.1
+# This config.yaml was created with ddev version v1.12.2
+# webimage: drud/ddev-webserver:v1.12.2
 # dbimage: drud/ddev-dbserver-mariadb-10.2:v1.12.0
 # dbaimage: drud/phpmyadmin:v1.12.0
 # bgsyncimage: drud/ddev-bgsync:v1.12.0

src/Controller/Api/SitepackageController.php

@@ -70,13 +70,6 @@ public function createSitepackage(Request $request): Response
         $content = $request->getContent();
         $sitepackage = $this->serializer->deserialize($content, Package::class, 'json');
         $this->validateObject($sitepackage);
-
-        $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()));
-        $sitepackage->setExtensionKey(StringUtility::camelCaseToLowerCaseUnderscored($sitepackage->getPackageName()));
-
         $this->sitepackageGenerator->create($sitepackage);
         $filename = $this->sitepackageGenerator->getFilename();
         BinaryFileResponse::trustXSendfileTypeHeader();

src/Controller/Web/DefaultController.php

@@ -53,19 +53,23 @@ public function new(Request $request)
     {
         $session = $request->getSession();
         $session->set('sitepackage', null);
+
         $sitepackage = new Package();
         $form = $this->createNewSitePackageForm($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()));
-            $sitepackage->setExtensionKey(StringUtility::camelCaseToLowerCaseUnderscored($sitepackage->getPackageName()));
-            $session = $request->getSession();
-            $session->set('sitepackage', $sitepackage);
 
-            return $this->redirectToRoute('default_success');
+        if ($form->isSubmitted()) {
+            if ($form->get('extended')->isClicked()) {
+                $sitepackage->setExtended(true);
+            }
+
+            if ($sitepackage->getExtended()) {
+                $session->set('sitepackage', $sitepackage);
+                return $this->redirectToRoute('default_edit');
+            } elseif ($form->isValid()) {
+                $session->set('sitepackage', $sitepackage);
+                return $this->redirectToRoute('default_success');
+            }
         }
 
         return $this->render(
@@ -83,23 +87,19 @@ public function edit(Request $request)
     {
         $session = $request->getSession();
         $sitepackage = $session->get('sitepackage');
+
         if ($sitepackage === null) {
             $this->addFlash(
                 'danger',
                 'Whoops, we could not find the package configuration. Please submit the configuration again.'
             );
             return $this->redirectToRoute('default_new');
         }
+
         $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()));
-            $sitepackage->setExtensionKey(StringUtility::camelCaseToLowerCaseUnderscored($sitepackage->getPackageName()));
-            $session = $request->getSession();
-            $session->set('sitepackage', $sitepackage);
             return $this->redirectToRoute('default_success');
         }
 

src/Entity/Package.php

@@ -10,6 +10,7 @@
 namespace App\Entity;
 
 use App\Entity\Package\Author;
+use App\Utility\StringUtility;
 use JMS\Serializer\Annotation as Serializer;
 use Swagger\Annotations as SWG;
 use Symfony\Component\Validator\Constraints as Assert;
@@ -19,6 +20,11 @@
  */
 class Package implements \JsonSerializable
 {
+    /**
+     * @var bool
+     */
+    private $extended = false;
+
     /**
      * @Assert\NotBlank()
      * @Assert\Choice({
@@ -47,14 +53,34 @@ class Package implements \JsonSerializable
     private $basePackage = 'bootstrap_package';
 
     /**
+     * @Assert\Length(
+     *     allowEmptyString = true,
+     *     min = 3
+     * )
+     * @Assert\Regex(
+     *     pattern = "/^[A-Z][A-Za-z0-9]+$/",
+     *     message = "Only letters, numbers and spaces are allowed"
+     * )
+     * @SWG\Property(type="string", example="BK2K", default="generated from author->company if empty")
+     * @Serializer\Type("string")
      * @var string
      */
-    private $vendorName;
+    private $vendorName = '';
 
     /**
+     * @Assert\Length(
+     *     allowEmptyString = true,
+     *     min = 3
+     * )
+     * @Assert\Regex(
+     *     pattern = "/^[a-z][a-z0-9-]+$/",
+     *     message = "Only letters, numbers and hyphens are allowed"
+     * )
+     * @SWG\Property(type="string", example="bk2k", default="generated from vendor name if empty")
+     * @Serializer\Type("string")
      * @var string
      */
-    private $vendorNameAlternative;
+    private $vendorNameAlternative = '';
 
     /**
      * @Assert\NotBlank(
@@ -87,19 +113,49 @@ class Package implements \JsonSerializable
     private $description;
 
     /**
+     * @Assert\Length(
+     *     allowEmptyString = true,
+     *     min = 3
+     * )
+     * @Assert\Regex(
+     *     pattern = "/^[A-Z][A-Za-z0-9]+$/",
+     *     message = "Only letters and numbers are allowed"
+     * )
+     * @SWG\Property(type="string", example="MySitepackage", default="generated from title if empty")
+     * @Serializer\Type("string")
      * @var string
      */
-    private $packageName;
+    private $packageName = '';
 
     /**
+     * @Assert\Length(
+     *     allowEmptyString = true,
+     *     min = 3
+     * )
+     * @Assert\Regex(
+     *     pattern = "/^[a-z][a-z0-9-]+$/",
+     *     message = "Only lower case letters, numbers and hyphens are allowed"
+     * )
+     * @SWG\Property(type="string", example="my-sitepackage", default="generated from package name if empty")
+     * @Serializer\Type("string")
      * @var string
      */
-    private $packageNameAlternative;
+    private $packageNameAlternative = '';
 
     /**
+     * @Assert\Length(
+     *     allowEmptyString = true,
+     *     min = 3
+     * )
+     * @Assert\Regex(
+     *     pattern = "/^[a-z][a-z0-9_]+$/",
+     *     message = "Only lower case letters, numbers and undscores are allowed"
+     * )
+     * @SWG\Property(type="string", example="my_sitepackage", default="generated from package name if empty")
+     * @Serializer\Type("string")
      * @var string
      */
-    private $extensionKey;
+    private $extensionKey = '';
 
     /**
      * @Assert\Url()
@@ -112,12 +168,29 @@ class Package implements \JsonSerializable
 
     /**
      * @Assert\Valid
-     *
      * @Serializer\Type(Author::class)
      * @var Author
      */
     private $author;
 
+    /**
+     * @return bool
+     */
+    public function getExtended()
+    {
+        return $this->extended;
+    }
+
+    /**
+     * @param bool $extended
+     * @return Package
+     */
+    public function setExtended($extended)
+    {
+        $this->extended = $extended;
+        return $this;
+    }
+
     /**
      * @return int
      */
@@ -159,6 +232,10 @@ public function setBasePackage($basePackage)
      */
     public function getVendorName()
     {
+        if (empty($this->vendorName)) {
+            return StringUtility::stringToUpperCamelCase($this->getAuthor()->getCompany());
+        }
+
         return $this->vendorName;
     }
 
@@ -168,7 +245,10 @@ public function getVendorName()
      */
     public function setVendorName($vendorName)
     {
-        $this->vendorName = $vendorName;
+        if ($this->getVendorName() !== $vendorName) {
+            $this->vendorName = StringUtility::stringToUpperCamelCase($vendorName);
+        }
+
         return $this;
     }
 
@@ -177,6 +257,10 @@ public function setVendorName($vendorName)
      */
     public function getVendorNameAlternative()
     {
+        if (empty($this->vendorNameAlternative)) {
+            return StringUtility::camelCaseToLowerCaseDashed($this->getVendorName());
+        }
+
         return $this->vendorNameAlternative;
     }
 
@@ -186,7 +270,9 @@ public function getVendorNameAlternative()
      */
     public function setVendorNameAlternative($vendorNameAlternative)
     {
-        $this->vendorNameAlternative = $vendorNameAlternative;
+        if ($this->getVendorNameAlternative() !== $vendorNameAlternative) {
+            $this->vendorNameAlternative = StringUtility::camelCaseToLowerCaseDashed($vendorNameAlternative);
+        }
         return $this;
     }
 
@@ -231,6 +317,10 @@ public function setDescription($description)
      */
     public function getPackageName()
     {
+        if (empty($this->packageName)) {
+            return StringUtility::stringToUpperCamelCase($this->getTitle());
+        }
+
         return $this->packageName;
     }
 
@@ -240,7 +330,10 @@ public function getPackageName()
      */
     public function setPackageName($packageName)
     {
-        $this->packageName = $packageName;
+        if ($this->getPackageName() !== $packageName) {
+            $this->packageName = StringUtility::stringToUpperCamelCase($packageName);
+        }
+
         return $this;
     }
 
@@ -249,6 +342,10 @@ public function setPackageName($packageName)
      */
     public function getPackageNameAlternative()
     {
+        if (empty($this->packageNameAlternative)) {
+            return StringUtility::camelCaseToLowerCaseDashed($this->getPackageName());
+        }
+
         return $this->packageNameAlternative;
     }
 
@@ -258,7 +355,10 @@ public function getPackageNameAlternative()
      */
     public function setPackageNameAlternative($packageNameAlternative)
     {
-        $this->packageNameAlternative = $packageNameAlternative;
+        if ($this->getPackageNameAlternative() !== $packageNameAlternative) {
+            $this->packageNameAlternative = StringUtility::camelCaseToLowerCaseDashed($packageNameAlternative);
+        }
+
         return $this;
     }
 
@@ -267,6 +367,10 @@ public function setPackageNameAlternative($packageNameAlternative)
      */
     public function getExtensionKey()
     {
+        if (empty($this->extensionKey)) {
+            return StringUtility::camelCaseToLowerCaseUnderscored($this->getPackageName());
+        }
+
         return $this->extensionKey;
     }
 
@@ -276,7 +380,10 @@ public function getExtensionKey()
      */
     public function setExtensionKey($extensionKey)
     {
-        $this->extensionKey = $extensionKey;
+        if ($this->getExtensionKey() !== $extensionKey) {
+            $this->extensionKey = StringUtility::camelCaseToLowerCaseUnderscored($extensionKey);
+        }
+
         return $this;
     }
 

src/Form/AuthorType.php

@@ -23,25 +23,25 @@ public function buildForm(FormBuilderInterface $builder, array $options)
         $builder
             ->add('name', TextType::class, [
                 'attr' => [
-                    'autocomplete' => 'off',
+                    'autocomplete' => 'on',
                     'placeholder' => 'John Doe',
                 ],
             ])
             ->add('email', EmailType::class, [
                 'attr' => [
-                    'autocomplete' => 'off',
+                    'autocomplete' => 'on',
                     'placeholder' => '[email protected]',
                 ],
             ])
             ->add('company', TextType::class, [
                 'attr' => [
-                    'autocomplete' => 'off',
+                    'autocomplete' => 'on',
                     'placeholder' => 'Company Inc.',
                 ],
             ])
             ->add('homepage', TextType::class, [
                 'attr' => [
-                    'autocomplete' => 'off',
+                    'autocomplete' => 'on',
                     'placeholder' => 'https://www.example.com',
                 ],
             ]);