BB-15559: Make PHPMD settings same for all packages (#28627)

- Updated Jenkinsfile and php_code_style_standalone.sh to run a single combined PHP codestyle build. - Updated platform/build/phpmd.xml to use PHPMD defaults and removed phpmd.xml in other packages. - Suppressed PHPMD.CyclomaticComplexity, PHPMD.TooManyPublicMethods, PHPMD.TooManyMethods, PHPMD.TooManyFields in existing code.
oroinc · Aug 27, 2020 · 67d67db · 67d67db
1 parent cf8315e
commit 67d67db
Show file tree

Hide file tree

Showing 11 changed files with 28 additions and 5 deletions.
diff --git a/Entity/Recurrence.php b/Entity/Recurrence.php
@@ -487,6 +487,7 @@ public function getTimeZone()
      *
      * @param Recurrence|null $other
      * @return bool
+     * @SuppressWarnings(PHPMD.CyclomaticComplexity)
      */
     public function isEqual($other)
     {

diff --git a/Form/EventListener/AttendeesSubscriber.php b/Form/EventListener/AttendeesSubscriber.php
@@ -8,6 +8,10 @@
 use Symfony\Component\Form\FormEvent;
 use Symfony\Component\Form\FormEvents;
 
+/**
+ * Makes sure indexes of attendees from request are equal to indexes of the same
+ * attendees so that in the end we end up with correct data.
+ */
 class AttendeesSubscriber implements EventSubscriberInterface
 {
     /**
@@ -26,6 +30,7 @@ public static function getSubscribedEvents()
      * Makes sure indexes of attendees from request are equal to indexes of the same
      * attendees so that in the end we end up with correct data.
      *
+     * @SuppressWarnings(PHPMD.CyclomaticComplexity)
      * @param FormEvent $event
      */
     public function fixSubmittedData(FormEvent $event)

diff --git a/Form/Handler/CalendarEventApiHandler.php b/Form/Handler/CalendarEventApiHandler.php
@@ -5,13 +5,17 @@
 use Oro\Bundle\CalendarBundle\Entity\CalendarEvent;
 use Oro\Bundle\CalendarBundle\Manager\CalendarEvent\NotificationManager;
 
+/**
+ * Form handler for calendar event form, used in legacy REST API.
+ */
 class CalendarEventApiHandler extends AbstractCalendarEventHandler
 {
     /**
      * Process form
      *
      * @param  CalendarEvent $entity
      * @return bool  True on successful processing, false otherwise
+     * @SuppressWarnings(PHPMD.CyclomaticComplexity)
      */
     public function process(CalendarEvent $entity)
     {
@@ -26,7 +30,6 @@ public function process(CalendarEvent $entity)
             $this->form->submit($request->request->all());
 
             if ($this->form->isValid()) {
-                // TODO: should be refactored after finishing BAP-8722
                 // Contexts handling should be moved to common for activities form handler
                 if ($this->form->has('contexts') && $request->request->has('contexts')) {
                     $contexts = $this->form->get('contexts')->getData();

diff --git a/Form/Type/SystemCalendarType.php b/Form/Type/SystemCalendarType.php
@@ -85,6 +85,7 @@ public function configureOptions(OptionsResolver $resolver)
      * PRE_SET_DATA event handler
      *
      * @param FormEvent $event
+     * @SuppressWarnings(PHPMD.CyclomaticComplexity)
      */
     public function preSetData(FormEvent $event)
     {

diff --git a/Model/Recurrence/MonthNthStrategy.php b/Model/Recurrence/MonthNthStrategy.php
@@ -5,6 +5,9 @@
 use Oro\Bundle\CalendarBundle\Entity;
 use Oro\Bundle\CalendarBundle\Model\Recurrence;
 
+/**
+ * Calendar strategy for events reocurring every Nth month.
+ */
 class MonthNthStrategy extends AbstractStrategy
 {
     /**
@@ -17,6 +20,7 @@ public function getName()
 
     /**
      * {@inheritdoc}
+     * @SuppressWarnings(PHPMD.CyclomaticComplexity)
      */
     public function getOccurrences(Entity\Recurrence $recurrence, \DateTime $start, \DateTime $end)
     {

diff --git a/Model/Recurrence/WeeklyStrategy.php b/Model/Recurrence/WeeklyStrategy.php
@@ -6,9 +6,6 @@
 use Oro\Bundle\CalendarBundle\Model\Recurrence;
 
 /**
- * Class WeeklyStrategy
- * @package Oro\Bundle\CalendarBundle\Model\Recurrence
- *
  * The weekly strategy for the first week takes into account only that days that are later than start
  * of recurrence and then it selects next days according to its interval.
  * For example, the rule 'Weekly every 2 weeks on Monday, Friday every 2 weeks'
@@ -96,7 +93,7 @@ public function getOccurrences(Entity\Recurrence $recurrence, \DateTime $start,
                 ) {
                     $result[] = $next;
                 }
-                
+
                 $fromStartInterval = $next >= $recurrence->getStartTime() ? $fromStartInterval +1 : $fromStartInterval;
             }
             $fullWeeks += $interval;
@@ -186,6 +183,7 @@ protected function sortWeekDays(&$weekDays)
      * {@inheritdoc}
      *
      * @SuppressWarnings(PHPMD.NPathComplexity)
+     * @SuppressWarnings(PHPMD.CyclomaticComplexity)
      */
     public function getLastOccurrence(Entity\Recurrence $recurrence)
     {

diff --git a/Provider/CalendarPropertyProvider.php b/Provider/CalendarPropertyProvider.php
@@ -12,6 +12,9 @@
 use Oro\Bundle\EntityExtendBundle\Tools\ExtendHelper;
 use Oro\Component\DoctrineUtils\ORM\QueryBuilderUtil;
 
+/**
+ * Provides utility methods for retrieval of calendar properties.
+ */
 class CalendarPropertyProvider
 {
     const CALENDAR_PROPERTY_CLASS = 'Oro\Bundle\CalendarBundle\Entity\CalendarProperty';
@@ -56,6 +59,7 @@ public function __construct(
      * @param int $calendarId
      *
      * @return array
+     * @SuppressWarnings(PHPMD.CyclomaticComplexity)
      */
     public function getItems($calendarId)
     {

diff --git a/Tests/Functional/API/Rest/RecurringEventUpdateExceptionTest.php b/Tests/Functional/API/Rest/RecurringEventUpdateExceptionTest.php
@@ -32,6 +32,7 @@
  * @dbIsolationPerTest
  *
  * @SuppressWarnings(PHPMD.ExcessiveClassLength)
+ * @SuppressWarnings(PHPMD.TooManyPublicMethods)
  */
 class RecurringEventUpdateExceptionTest extends AbstractTestCase
 {

diff --git a/Tests/Unit/Manager/CalendarEvent/NotificationManagerTest.php b/Tests/Unit/Manager/CalendarEvent/NotificationManagerTest.php
@@ -14,6 +14,8 @@
 
 /**
  * @SuppressWarnings(PHPMD.ExcessiveClassLength)
+ * @SuppressWarnings(PHPMD.TooManyMethods)
+ * @SuppressWarnings(PHPMD.TooManyPublicMethods)
  */
 class NotificationManagerTest extends \PHPUnit\Framework\TestCase
 {

diff --git a/Tests/Unit/Manager/CalendarEventManagerTest.php b/Tests/Unit/Manager/CalendarEventManagerTest.php
@@ -13,6 +13,9 @@
 use Oro\Bundle\OrganizationBundle\Entity\Organization;
 use Oro\Bundle\SecurityBundle\Authentication\TokenAccessorInterface;
 
+/**
+ * @SuppressWarnings(PHPMD.TooManyPublicMethods)
+ */
 class CalendarEventManagerTest extends \PHPUnit\Framework\TestCase
 {
     /** @var \PHPUnit\Framework\MockObject\MockObject */

diff --git a/Validator/RecurringCalendarEventExceptionValidator.php b/Validator/RecurringCalendarEventExceptionValidator.php
@@ -83,6 +83,7 @@ protected function validateRecurrence(
      *
      * @param CalendarEvent $value
      * @param RecurringCalendarEventExceptionConstraint $constraint
+     * @SuppressWarnings(PHPMD.CyclomaticComplexity)
      */
     protected function validateCalendarUid(
         CalendarEvent $value,