ISSUE-345: style fix

tatevikg1 · tatevikg1 · commit 33986d792fa6 · 2025-06-17T22:03:39.000+04:00
diff --git a/src/Common/Controller/BaseController.php b/src/Common/Controller/BaseController.php
@@ -11,6 +11,7 @@
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
 
+/**  @SuppressWarnings(PHPMD.NumberOfChildren) */
 abstract class BaseController extends AbstractController
 {
     protected Authentication $authentication;
diff --git a/src/Statistics/Controller/AnalyticsController.php b/src/Statistics/Controller/AnalyticsController.php
@@ -25,26 +25,27 @@ class AnalyticsController extends BaseController
 {
     public const BATCH_SIZE = 20;
     private AnalyticsService $analyticsService;
-    private CampaignStatisticsNormalizer $campaignStatisticsNormalizer;
-    private ViewOpensStatisticsNormalizer $viewOpensStatisticsNormalizer;
+    private CampaignStatisticsNormalizer $campaignStatsNormalizer;
+    private ViewOpensStatisticsNormalizer $viewOpensStatsNormalizer;
 
     public function __construct(
         Authentication $authentication,
         RequestValidator $validator,
         AnalyticsService $analyticsService,
-        CampaignStatisticsNormalizer $campaignStatisticsNormalizer,
-        ViewOpensStatisticsNormalizer $viewOpensStatisticsNormalizer
+        CampaignStatisticsNormalizer $campaignStatsNormalizer,
+        ViewOpensStatisticsNormalizer $viewOpensStatsNormalizer
     ) {
         parent::__construct($authentication, $validator);
         $this->analyticsService = $analyticsService;
-        $this->campaignStatisticsNormalizer = $campaignStatisticsNormalizer;
-        $this->viewOpensStatisticsNormalizer = $viewOpensStatisticsNormalizer;
+        $this->campaignStatsNormalizer = $campaignStatsNormalizer;
+        $this->viewOpensStatsNormalizer = $viewOpensStatsNormalizer;
     }
 
     #[Route('/campaigns', name: 'campaign_statistics', methods: ['GET'])]
     #[OA\Get(
         path: '/analytics/campaigns',
-        description: 'Returns statistics overview for campaigns.',
+        description: '🚧 **Status: Beta** – This method is under development. Avoid using in production. ' .
+            'Returns statistics overview for campaigns.',
         summary: 'Gets campaign statistics.',
         tags: ['analytics'],
         parameters: [
@@ -106,7 +107,7 @@ public function getCampaignStatistics(Request $request): JsonResponse
         $lastId = (int) $request->query->get('after_id', 0);
 
         $data = $this->analyticsService->getCampaignStatistics($limit, $lastId);
-        $normalizedData = $this->campaignStatisticsNormalizer->normalize($data, null, [
+        $normalizedData = $this->campaignStatsNormalizer->normalize($data, null, [
             'limit' => $limit,
             'campaign_statistics' => true,
         ]);
@@ -117,7 +118,8 @@ public function getCampaignStatistics(Request $request): JsonResponse
     #[Route('/view-opens', name: 'view_opens_statistics', methods: ['GET'])]
     #[OA\Get(
         path: '/analytics/view-opens',
-        description: 'Returns statistics for view opens.',
+        description: '🚧 **Status: Beta** – This method is under development. Avoid using in production. ' .
+            'Returns statistics for view opens.',
         summary: 'Gets view opens statistics.',
         tags: ['analytics'],
         parameters: [
@@ -179,7 +181,7 @@ public function getViewOpensStatistics(Request $request): JsonResponse
         $lastId = (int) $request->query->get('after_id', 0);
 
         $data = $this->analyticsService->getViewOpensStatistics($limit, $lastId);
-        $normalizedData = $this->viewOpensStatisticsNormalizer->normalize($data, null, [
+        $normalizedData = $this->viewOpensStatsNormalizer->normalize($data, null, [
             'view_opens_statistics' => true,
             'limit' => $limit
         ]);
@@ -190,7 +192,8 @@ public function getViewOpensStatistics(Request $request): JsonResponse
     #[Route('/domains/top', name: 'top_domains', methods: ['GET'])]
     #[OA\Get(
         path: '/analytics/domains/top',
-        description: 'Returns statistics for the top domains with more than 5 subscribers.',
+        description: '🚧 **Status: Beta** – This method is under development. Avoid using in production. ' .
+            'Returns statistics for the top domains with more than 5 subscribers.',
         summary: 'Gets top domains statistics.',
         tags: ['analytics'],
         parameters: [
@@ -265,7 +268,8 @@ public function getTopDomains(Request $request): JsonResponse
     #[Route('/domains/confirmation', name: 'domain_confirmation_statistics', methods: ['GET'])]
     #[OA\Get(
         path: '/analytics/domains/confirmation',
-        description: 'Returns statistics for domains showing confirmation status.',
+        description: '🚧 **Status: Beta** – This method is under development. Avoid using in production. ' .
+            'Returns statistics for domains showing confirmation status.',
         summary: 'Gets domain confirmation statistics.',
         tags: ['analytics'],
         parameters: [
@@ -363,7 +367,8 @@ public function getDomainConfirmationStatistics(Request $request): JsonResponse
     #[Route('/local-parts/top', name: 'top_local_parts', methods: ['GET'])]
     #[OA\Get(
         path: '/analytics/local-parts/top',
-        description: 'Returns statistics for the top local-parts of email addresses.',
+        description: '🚧 **Status: Beta** – This method is under development. Avoid using in production. ' .
+            'Returns statistics for the top local-parts of email addresses.',
         summary: 'Gets top local-parts statistics.',
         tags: ['analytics'],
         parameters: [
diff --git a/src/Statistics/Serializer/CampaignStatisticsNormalizer.php b/src/Statistics/Serializer/CampaignStatisticsNormalizer.php
@@ -10,51 +10,51 @@
 class CampaignStatisticsNormalizer implements NormalizerInterface
 {
     /**
-     * Normalizes campaign statistics data into an array.
-     *
-     * @param mixed $object The object to normalize
-     * @param string|null $format The format being (de)serialized from or into
-     * @param array $context Context options for the normalizer
-     *
-     * @return array
+     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
      */
     public function normalize(mixed $object, string $format = null, array $context = []): array
     {
         if (!is_array($object) || !isset($object['campaigns'])) {
             return [];
         }
 
+        $items = [];
+        foreach ($object['campaigns'] as $item) {
+            $items[] = $this->normalizeCampaign($item);
+        }
+        return [
+            'items' => $items,
+            'pagination' => $this->normalizePagination($object, $context),
+        ];
+    }
+
+    private function normalizeCampaign(array $campaign): array
+    {
+        return [
+            'campaign_id' => $campaign['campaignId'] ?? 0,
+            'subject' => $campaign['subject'] ?? '',
+            'sent' => $campaign['sent'] ?? 0,
+            'bounces' => $campaign['bounces'] ?? 0,
+            'forwards' => $campaign['forwards'] ?? 0,
+            'unique_views' => $campaign['uniqueViews'] ?? 0,
+            'total_clicks' => $campaign['totalClicks'] ?? 0,
+            'unique_clicks' => $campaign['uniqueClicks'] ?? 0,
+            'date_sent' => $campaign['dateSent'] ?? null,
+        ];
+    }
+
+    private function normalizePagination(array $object, array $context): array
+    {
         return [
-            'items' => array_map(function ($campaign) {
-                return [
-                    'campaign_id' => $campaign['campaignId'] ?? 0,
-                    'subject' => $campaign['subject'] ?? '',
-                    'sent' => $campaign['sent'] ?? 0,
-                    'bounces' => $campaign['bounces'] ?? 0,
-                    'forwards' => $campaign['forwards'] ?? 0,
-                    'unique_views' => $campaign['uniqueViews'] ?? 0,
-                    'total_clicks' => $campaign['totalClicks'] ?? 0,
-                    'unique_clicks' => $campaign['uniqueClicks'] ?? 0,
-                    'date_sent' => $campaign['dateSent'] ?? null,
-                ];
-            }, $object['campaigns']),
-            'pagination' => [
-                'total' => $object['total'] ?? 0,
-                'limit' => $context['limit'] ?? AnalyticsController::BATCH_SIZE,
-                'has_more' => $object['hasMore'] ?? false,
-                'next_cursor' => $object['lastId'] ? $object['lastId'] + 1 : 0,
-            ],
+            'total' => $object['total'] ?? 0,
+            'limit' => $context['limit'] ?? AnalyticsController::BATCH_SIZE,
+            'has_more' => $object['hasMore'] ?? false,
+            'next_cursor' => $object['lastId'] ? $object['lastId'] + 1 : 0,
         ];
     }
 
     /**
-     * Checks whether the given class is supported for normalization by this normalizer.
-     *
-     * @param mixed $data Data to normalize
-     * @param string|null $format The format being (de)serialized from or into
-     * @param array $context Context options for the normalizer
-     *
-     * @return bool
+     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
      */
     public function supportsNormalization(mixed $data, string $format = null, array $context = []): bool
     {
diff --git a/src/Statistics/Serializer/ViewOpensStatisticsNormalizer.php b/src/Statistics/Serializer/ViewOpensStatisticsNormalizer.php
@@ -10,47 +10,48 @@
 class ViewOpensStatisticsNormalizer implements NormalizerInterface
 {
     /**
-     * Normalizes view opens statistics data into an array.
-     *
-     * @param mixed $object The object to normalize
-     * @param string|null $format The format being (de)serialized from or into
-     * @param array $context Context options for the normalizer
-     *
-     * @return array
+     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
      */
     public function normalize(mixed $object, string $format = null, array $context = []): array
     {
         if (!is_array($object) || !isset($object['campaigns'])) {
             return [];
         }
 
+        $items = [];
+        foreach ($object['campaigns'] as $item) {
+            $items[] = $this->normalizeCampaign($item);
+        }
+
+        return [
+            'items' => $items,
+            'pagination' => $this->normalizePagination($object, $context),
+        ];
+    }
+
+    private function normalizeCampaign(array $item): array
+    {
+        return [
+            'campaign_id' => $item['campaignId'] ?? 0,
+            'subject' => $item['subject'] ?? '',
+            'sent' => $item['sent'] ?? 0,
+            'unique_views' => $item['uniqueViews'] ?? 0,
+            'rate' => $item['rate'] ?? 0.0,
+        ];
+    }
+
+    private function normalizePagination(array $object, array $context): array
+    {
         return [
-            'items' => array_map(function ($item) {
-                return [
-                    'campaign_id' => $item['campaignId'] ?? 0,
-                    'subject' => $item['subject'] ?? '',
-                    'sent' => $item['sent'] ?? 0,
-                    'unique_views' => $item['uniqueViews'] ?? 0,
-                    'rate' => $item['rate'] ?? 0.0,
-                ];
-            }, $object['campaigns']),
-            'pagination' => [
-                'total' => $object['total'] ?? 0,
-                'limit' => $context['limit'] ?? AnalyticsController::BATCH_SIZE,
-                'has_more' => $object['hasMore'] ?? false,
-                'next_cursor' => $object['lastId'] ? $object['lastId'] + 1 : 0,
-            ],
+            'total' => $object['total'] ?? 0,
+            'limit' => $context['limit'] ?? AnalyticsController::BATCH_SIZE,
+            'has_more' => $object['hasMore'] ?? false,
+            'next_cursor' => $object['lastId'] ? $object['lastId'] + 1 : 0,
         ];
     }
 
     /**
-     * Checks whether the given class is supported for normalization by this normalizer.
-     *
-     * @param mixed $data Data to normalize
-     * @param string|null $format The format being (de)serialized from or into
-     * @param array $context Context options for the normalizer
-     *
-     * @return bool
+     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
      */
     public function supportsNormalization(mixed $data, string $format = null, array $context = []): bool
     {
diff --git a/tests/Helpers/DummyAnalyticsController.php b/tests/Helpers/DummyAnalyticsController.php
@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpList\RestBundle\Tests\Helpers;
+
+use PhpList\RestBundle\Statistics\Controller\AnalyticsController;
+use Symfony\Component\HttpFoundation\JsonResponse;
+
+class DummyAnalyticsController extends AnalyticsController
+{
+    protected function json($data, int $status = 200, array $headers = [], array $context = []): JsonResponse
+    {
+        return new JsonResponse($data, $status, $headers);
+    }
+}
diff --git a/tests/Unit/Statistics/Controller/AnalyticsControllerTest.php b/tests/Unit/Statistics/Controller/AnalyticsControllerTest.php
@@ -13,48 +13,35 @@
 use PhpList\RestBundle\Statistics\Controller\AnalyticsController;
 use PhpList\RestBundle\Statistics\Serializer\CampaignStatisticsNormalizer;
 use PhpList\RestBundle\Statistics\Serializer\ViewOpensStatisticsNormalizer;
+use PhpList\RestBundle\Tests\Helpers\DummyAnalyticsController;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\HttpFoundation\JsonResponse;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\Security\Core\Exception\AccessDeniedException;
 
-/**
- * Test-specific subclass of AnalyticsController that overrides the json() method
- * to avoid relying on the container.
- */
-class TestableAnalyticsController extends AnalyticsController
-{
-    protected function json($data, int $status = 200, array $headers = [], array $context = []): JsonResponse
-    {
-        return new JsonResponse($data, $status, $headers);
-    }
-}
-
 class AnalyticsControllerTest extends TestCase
 {
     private Authentication|MockObject $authentication;
-    private RequestValidator|MockObject $validator;
     private AnalyticsService|MockObject $analyticsService;
-    private CampaignStatisticsNormalizer|MockObject $campaignStatisticsNormalizer;
     private AnalyticsController $controller;
     private Administrator|MockObject $administrator;
     private Privileges|MockObject $privileges;
 
     protected function setUp(): void
     {
         $this->authentication = $this->createMock(Authentication::class);
-        $this->validator = $this->createMock(RequestValidator::class);
+        $validator = $this->createMock(RequestValidator::class);
         $this->analyticsService = $this->createMock(AnalyticsService::class);
-        $this->campaignStatisticsNormalizer = new CampaignStatisticsNormalizer();
-        $this->viewOpensStatisticsNormalizer = new ViewOpensStatisticsNormalizer();
-        $this->controller = new TestableAnalyticsController(
+        $campaignStatisticsNormalizer = new CampaignStatisticsNormalizer();
+        $viewOpensStatisticsNormalizer = new ViewOpensStatisticsNormalizer();
+        $this->controller = new DummyAnalyticsController(
             $this->authentication,
-            $this->validator,
+            $validator,
             $this->analyticsService,
-            $this->campaignStatisticsNormalizer,
-            $this->viewOpensStatisticsNormalizer,
+            $campaignStatisticsNormalizer,
+            $viewOpensStatisticsNormalizer,
         );
 
         $this->privileges = $this->createMock(Privileges::class);

Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,7 @@`
`11`	`11`	`use Symfony\Component\HttpFoundation\Request;`
`12`	`12`	`use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;`
`13`	`13`
	`14`	`+/** @SuppressWarnings(PHPMD.NumberOfChildren) */`
`14`	`15`	`abstract class BaseController extends AbstractController`
`15`	`16`	`{`
`16`	`17`	`protected Authentication $authentication;`