Refactoring: Rename "Newsletter" to "Category" (Case 212902) (#31)

Renames the conept "Newsletter" to "Category" (including all derived
terms, like "NewsletterRepository" => "CategoryRepository" etc.).

The entity was named "Newsletter" because the client for whom it was
developed did indeed offer various "Newsletters", each with a in
individual name. We do the rename in order to reserve the name
"Newsletter" for the content that is sent out.

Fixes
#30

Author: janopae

README.md

@@ -62,7 +62,7 @@ In either case, configure Doctrine's interface mapping to deal with your custom
 doctrine:
     orm:
         resolve_target_entities:
-            \Webfactory\NewsletterRegistrationBundle\Entity\NewsletterInterface: '\AppBundle\Newsletter\Entity\Newsletter'
+            \Webfactory\NewsletterRegistrationBundle\Entity\CategoryInterface: '\AppBundle\Newsletter\Entity\Category'
 ```
 
 Side node: The templates and example above assume that you want to keep your Newsletter classes inside a Newsletter
@@ -116,15 +116,15 @@ implementations:
 # src/services.yml
 
 services:
-  AppBundle\Newsletter\Entity\NewsletterRepository:
+  AppBundle\Newsletter\Entity\CategoryRepository:
     factory:
       - '@doctrine.orm.entity_manager'
       - 'getRepository'
     arguments:
-      - 'AppBundle\Newsletter\Entity\Newsletter'
+      - 'AppBundle\Newsletter\Entity\Category'
 
-  Webfactory\NewsletterRegistrationBundle\Entity\NewsletterRepositoryInterface:
-    alias: 'AppBundle\Newsletter\Entity\NewsletterRepository'
+  Webfactory\NewsletterRegistrationBundle\Entity\CategoryRepositoryInterface:
+    alias: 'AppBundle\Newsletter\Entity\CategoryRepository'
 
   AppBundle\Newsletter\Entity\PendingOptInRepository:
     factory:

Resources/app-class-templates/Category.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace AppBundle\Newsletter\Entity;
+
+use Doctrine\ORM\Mapping as ORM;
+
+#[ORM\Entity(repositoryClass: CategoryRepository::class)]
+#[ORM\Table(name: 'wfd_newsletterCategory')]
+class Category extends \Webfactory\NewsletterRegistrationBundle\Entity\Category
+{
+}

Resources/app-class-templates/CategoryRepository.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace AppBundle\Newsletter\Entity;
+
+class CategoryRepository extends \Webfactory\NewsletterRegistrationBundle\Entity\CategoryRepository
+{
+}

Resources/app-class-templates/Newsletter.php

@@ -25,8 +25,8 @@
         <source>edit.registration.updated</source>
         <target>Ihre Registrierung wurde aktualisiert.</target>
       </trans-unit>
-      <trans-unit id="AGtLjHG" resname="edit.registration.updated.no.newsletters.chosen">
-        <source>edit.registration.updated.no.newsletters.chosen</source>
+      <trans-unit id="AGtLjHG" resname="edit.registration.updated.no.categories.chosen">
+        <source>edit.registration.updated.no.categories.chosen</source>
         <target>Ihre Newsletter-Abos wurden gelöscht, aber Ihre Registrierungsdaten sind (wie Ihre Email-Adresse) sind weitertin in unserer Datenbank gespeichert. Wenn Sie diese auch löschen möchten, nutzen Sie bitte den untenstehende Knopf.</target>
       </trans-unit>
       <trans-unit id="T83i0qx" resname="delete.registration.success">

Resources/app-class-templates/NewsletterRepository.php

@@ -25,8 +25,8 @@
         <source>edit.registration.updated</source>
         <target>Your newsletter registration was updated.</target>
       </trans-unit>
-      <trans-unit id="AGtLjHG" resname="edit.registration.updated.no.newsletters.chosen">
-        <source>edit.registration.updated.no.newsletters.chosen</source>
+      <trans-unit id="AGtLjHG" resname="edit.registration.updated.no.categories.chosen">
+        <source>edit.registration.updated.no.categories.chosen</source>
         <target>All your newsletter subscriptions have been deleted, but your registration data (like your email address) is still saved in our database. If you would like to delete that data too, please delete your registration with the button below.</target>
       </trans-unit>
       <trans-unit id="T83i0qx" resname="delete.registration.success">

Resources/translations/webfactory-newsletter-registration+intl-icu.de.xlf

@@ -169,9 +169,9 @@ public function editRegistration(string $uuid, Request $request, FlashBagAwareSe
 
         if ($editForm->isSubmitted() && $editForm->isValid()) {
             $this->editRegistrationTask->editRegistration($recipient);
-            $messageKey = \count($recipient->getNewsletters()) > 0
+            $messageKey = \count($recipient->getCategories()) > 0
                 ? 'edit.registration.updated'
-                : 'edit.registration.updated.no.newsletters.chosen';
+                : 'edit.registration.updated.no.categories.chosen';
             $session->getFlashBag()->add(
                 'success',
                 $this->translator->trans($messageKey, [], 'webfactory-newsletter-registration')

Resources/translations/webfactory-newsletter-registration+intl-icu.en.xlf

@@ -16,7 +16,7 @@ services:
 
     Webfactory\NewsletterRegistrationBundle\StartRegistration\Type:
         arguments:
-            - '@Webfactory\NewsletterRegistrationBundle\Entity\NewsletterRepositoryInterface'
+            - '@Webfactory\NewsletterRegistrationBundle\Entity\CategoryRepositoryInterface'
             - '@Webfactory\NewsletterRegistrationBundle\Entity\PendingOptInFactory'
         tags: ['form.type']
 
@@ -44,7 +44,7 @@ services:
 
     Webfactory\NewsletterRegistrationBundle\EditRegistration\Type:
         arguments:
-            - '@Webfactory\NewsletterRegistrationBundle\Entity\NewsletterRepositoryInterface'
+            - '@Webfactory\NewsletterRegistrationBundle\Entity\CategoryRepositoryInterface'
         tags: ['form.type']
 
     Webfactory\NewsletterRegistrationBundle\DeleteRegistration\Type:

src/Controller.php

@@ -5,25 +5,25 @@
 use Symfony\Component\Form\AbstractType;
 use Symfony\Component\Form\Extension\Core\Type\HiddenType;
 use Symfony\Component\Form\FormBuilderInterface;
-use Webfactory\NewsletterRegistrationBundle\Entity\NewsletterRepositoryInterface;
+use Webfactory\NewsletterRegistrationBundle\Entity\CategoryRepositoryInterface;
 
 class Type extends AbstractType
 {
-    use TypeHasNewslettersElementTrait;
+    use TypeHasCategoriesElementTrait;
 
-    public const ELEMENT_NEWSLETTERS = 'newsletters';
+    public const ELEMENT_CATEGORIES = 'categories';
 
-    public function __construct(NewsletterRepositoryInterface $newsletterRepository)
+    public function __construct(CategoryRepositoryInterface $categoryRepository)
     {
-        $this->newsletterRepository = $newsletterRepository;
+        $this->categoryRepository = $categoryRepository;
     }
 
     public function buildForm(FormBuilderInterface $builder, array $options): void
     {
-        $this->addNewslettersElementToForm($builder, false);
+        $this->addCategoriesElementToForm($builder, false);
 
-        // We need at least one element in addition to the newsletters above, so that Symfony recognizes the form being
-        // submitted even if no newsletters where chosen.
+        // We need at least one element in addition to the categories above, so that Symfony recognizes the form being
+        // submitted even if no categories where chosen.
         $builder->add('hidden', HiddenType::class, ['mapped' => false]);
     }
 }