Merge branch 'tuleap-131-filter-my-capsules-by-groups' into 'demo-202202'

tuleap-131-filter-my-capsules-by-groups

See merge request !54

src/Builder/CapsuleBuilder.php

@@ -3,6 +3,7 @@
 namespace App\Builder;
 
 use App\Entity\Capsule;
+use App\Entity\Group;
 use App\Entity\User;
 use App\Helper\ContractHelper;
 
@@ -90,6 +91,12 @@ class CapsuleBuilder
         return $this;
     }
 
+    public function withGroup(Group $group): CapsuleBuilder
+    {
+        $this->capsule->addGroup($group);
+        return $this;
+    }
+
     public function createCapsule(): Capsule
     {
         $this->createEditionLink();

src/Controller/CapsuleController.php

@@ -12,6 +12,9 @@ use App\Helper\StringHelper;
 use App\Repository\CapsuleRepository;
 use App\Builder\CapsuleBuilder;
 use App\Form\CreateCapsuleFormType;
+use App\Repository\GroupRepository;
+use ArrayObject;
+use Doctrine\ORM\EntityManagerInterface;
 use Knp\Component\Pager\PaginatorInterface;
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
 use Symfony\Component\Filesystem\Filesystem;
@@ -26,13 +29,16 @@ class CapsuleController extends AbstractController
 {
     private CapsuleRepository $capsule_repository;
     private TranslatorInterface $translator;
+    private EntityManagerInterface $entity_manager;
 
     public function __construct(
         CapsuleRepository $capsule_repository,
-        TranslatorInterface $translator
+        TranslatorInterface $translator,
+        EntityManagerInterface $entity_manager
     ) {
         $this->capsule_repository = $capsule_repository;
         $this->translator = $translator;
+        $this->entity_manager = $entity_manager;
     }
 
     /**
@@ -49,9 +55,9 @@ class CapsuleController extends AbstractController
             return $this->redirectToRoute('app_logout');
         }
 
-        $all_capsules = $current_user->getCapsules();
-
-        $form = $this->createForm(FilterByGroupFormType::class, ['groups' => $current_user->getGroups()]);
+        // get all capsules without any filter
+        $all_capsules = $current_user->getCapsules()->toArray();
+        $form = $this->createGroupFilterForm($current_user);
         $form->handleRequest($request);
 
         if ($form->isSubmitted() && $form->isValid()) {
@@ -61,7 +67,9 @@ class CapsuleController extends AbstractController
                 throw new \Exception('Group not found');
             }
 
-            $all_capsules = $current_user->getCapsulesFilteredByGroup($group);
+            if ($group->getId() !== Group::$ALL_GROUP_ID) {
+                $all_capsules = $group->getCapsulesIntersection($all_capsules);
+            }
         }
 
         $capsules = $paginator->paginate(
@@ -175,8 +183,7 @@ class CapsuleController extends AbstractController
             return $this->redirectToRoute('app_logout');
         }
 
-        $entityManager = $this->getDoctrine()->getManager();
-        $capsule = $entityManager->getRepository(Capsule::class)->find($id);
+        $capsule = $this->capsule_repository->findOneBy(['id' => $id]);
 
         if (! $capsule) {
             throw $this->createNotFoundException(
@@ -202,8 +209,8 @@ class CapsuleController extends AbstractController
         if ($form->isSubmitted() && $form->isValid()) {
             $current_user->removeCapsule($capsule);
             $capsule->removeEditor($current_user);
-            $entityManager->remove($capsule);
-            $entityManager->flush();
+            $this->entity_manager->remove($capsule);
+            $this->entity_manager->flush();
 
             $this->addFlash(
                 'success',
@@ -240,8 +247,7 @@ class CapsuleController extends AbstractController
             return $this->redirectToRoute('app_logout');
         }
 
-        $entityManager = $this->getDoctrine()->getManager();
-        $parent_capsule = $entityManager->getRepository(Capsule::class)->find($id);
+        $parent_capsule = $this->capsule_repository->findOneBy(['id' => $id]);
 
         if (! $parent_capsule instanceof Capsule) {
             throw new \Exception('The retrieved capsule is not an instance of Capsule.');
@@ -301,7 +307,6 @@ class CapsuleController extends AbstractController
         $password = StringHelper::generateRandomHashedString();
         $preview_link = Uuid::v4();
 
-        $entityManager = $this->getDoctrine()->getManager();
         $capsule_builder = new CapsuleBuilder();
         $capsule = $capsule_builder
             ->withName($capsule_name)
@@ -312,9 +317,30 @@ class CapsuleController extends AbstractController
             ->withPassword($password)
             ->createCapsule();
 
-        $entityManager->persist($capsule);
-        $entityManager->flush();
+        $this->entity_manager->persist($capsule);
+        $this->entity_manager->flush();
 
         return $capsule;
     }
+
+    private function getDefaultGroup(): Group
+    {
+            $noGroup = new Group();
+
+            // TODO : to be translated
+            $noGroup->setName($this->translator->trans('groups.filter.no_filter'));
+            $noGroup->setId(Group::$ALL_GROUP_ID);
+
+            return $noGroup;
+    }
+
+    private function createGroupFilterForm(User $current_user): FormInterface
+    {
+        $groups = new ArrayObject($current_user->getGroups());
+        $groups = $groups->getArrayCopy();
+        array_unshift($groups, self::getDefaultGroup());
+
+
+        return $this->createForm(FilterByGroupFormType::class, ['groups' => $groups]);
+    }
 }

src/DataFixtures/GroupFixtures.php

+<?php
+
+namespace App\DataFixtures;
+
+use App\Entity\Group;
+use Doctrine\Bundle\FixturesBundle\Fixture;
+use Doctrine\Persistence\ObjectManager;
+
+class GroupFixtures extends Fixture
+{
+    public function load(ObjectManager $manager): void
+    {
+        $group_all = new Group();
+        $group_all->setName("All");
+        $manager->persist($group_all);
+        $manager->flush();
+    }
+
+    /** @phpstan-ignore-next-line  */
+    public function getDependencies(): array
+    {
+        return [
+            CapsuleFixtures::class,
+        ];
+    }
+}

src/Entity/Group.php

@@ -15,6 +15,7 @@ use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
  */
 class Group
 {
+    public static int $ALL_GROUP_ID = -1;
     /**
      * @ORM\Id
      * @ORM\GeneratedValue
@@ -43,6 +44,11 @@ class Group
         return $this->id;
     }
 
+    public function setId(int $id): void
+    {
+        $this->id = $id;
+    }
+
     public function getName(): string
     {
         return $this->name;
@@ -67,6 +73,19 @@ class Group
     {
         if (!$this->capsules->contains($capsule)) {
             $this->capsules[] = $capsule;
+            $capsule->addGroup($this);
+        }
+
+        return $this;
+    }
+
+    /**
+     * @param array<Capsule> $capsules
+     */
+    public function addCapsules(array $capsules): self
+    {
+        foreach ($capsules as $capsule) {
+            $this->addCapsule($capsule);
         }
 
         return $this;
@@ -78,4 +97,19 @@ class Group
 
         return $this;
     }
+
+    /**
+     * @param array<Capsule> $capsules
+     * @return array<Capsule>
+     */
+    public function getCapsulesIntersection(array $capsules): array
+    {
+        return array_uintersect(
+            $capsules,
+            $this->getCapsules()->toArray(),
+            function ($obj_a, $obj_b) {
+                return $obj_a->getId() - $obj_b->getId();
+            }
+        );
+    }
 }

src/Entity/User.php

@@ -316,18 +316,4 @@ class User implements UserInterface, LegacyPasswordAuthenticatedUserInterface
 
         return $existing_groups_for_current_editor;
     }
-
-    /**
-     * @return array<Capsule>
-     */
-    public function getCapsulesFilteredByGroup(Group $group): array
-    {
-        return array_uintersect(
-            $this->getCapsules()->toArray(),
-            $group->getCapsules()->toArray(),
-            function ($obj_a, $obj_b) {
-                return $obj_a->getId() - $obj_b->getId();
-            }
-        );
-    }
 }

templates/capsule/groups/edit.html.twig

@@ -38,6 +38,7 @@
                     </h5>
                     <ul class="ps-0">
                         {% for group in groups %}
+                            {% if group.getName() != 'All' %}
                                 <li class="text-capitalize text-secondary list-unstyled p-1">
                                     {{ group.getName() }}
                                         -
@@ -45,6 +46,7 @@
                                             {{ 'groups.remove.link'|trans }}
                                         </a>
                                 </li>
+                            {% endif %}
                         {% endfor %}
                     </ul>
                 </div>

templates/capsule/index.html.twig

@@ -13,13 +13,14 @@
                 {{ 'capsule.title'|trans }}
             </h2>
 
+            {% if app.request.query.get('page')|default(1) == 1 %}
                 <div class="mb-3 mb-sm-0">
                     {{ form_start(filterByGroupForm, {'attr': {novalidate: 'novalidate', 'class': 'd-flex flex-column flex-sm-row mb-0 align-items-center pt-3'}}) }}
                     {{ form_row(filterByGroupForm.name, {'attr': {'class': ''}})  }}
                     {{ form_row(filterByGroupForm.filter, {'attr': {'class': 'ms-2'}})  }}
                     {{ form_end(filterByGroupForm) }}
                 </div>
-
+            {% endif %}
 
             <form class="d-flex mb-4 mb-lg-0">
                 <button id="btn-orange" formaction="/create">

translations/messages.en.yaml

@@ -181,4 +181,5 @@ groups:
     title: Remove group
     success: Group group_name removed successfully
   filter:
-    button: Filter by group
\ No newline at end of file
+    button: Apply group filter
+    no_filter: Show all
\ No newline at end of file

translations/messages.fr.yaml

@@ -181,3 +181,4 @@ groups:
     success: Le groupe group_name a bien été supprimé
   filter:
     button: Filtrer par groupe
+    no_filter: Tout afficher
\ No newline at end of file

[Ghost User]

This commit references: TULEAP-131.

[Ghost User]

This commit references: TULEAP-131.