Take copy paste and security checker into the score

Author: jdlabails

DependencyInjection/Configuration.php

@@ -69,6 +69,8 @@ public function getConfigTreeBuilder()
                     ->children()
                         ->booleanNode('enable')->defaultTrue()->end()
                         ->scalarNode('csWeight')->defaultValue('100')->cannotBeEmpty()->end()
+                        ->scalarNode('cpWeight')->defaultValue('100')->cannotBeEmpty()->end()
+                        ->scalarNode('scWeight')->defaultValue('100')->cannotBeEmpty()->end()
                         ->scalarNode('testWeight')->defaultValue('100')->cannotBeEmpty()->end()
                         ->scalarNode('locWeight')->defaultValue('100')->cannotBeEmpty()->end()
                         ->scalarNode('projectSize')->defaultValue('medium')->cannotBeEmpty()->end()

Entities/Analyze.php

@@ -29,6 +29,11 @@ class Analyze
      */
     private $csSuccess;
 
+    /**
+     * @var boolean
+     */
+    private $cpSuccess;
+
     /**
      * @var boolean
      */
@@ -223,6 +228,29 @@ public function getCsSuccess()
         return $this->csSuccess;
     }
 
+    /**
+     * Set cpSuccess
+     *
+     * @param boolean $cpSuccess
+     * @return analyze
+     */
+    public function setCpSuccess($cpSuccess)
+    {
+        $this->cpSuccess = $cpSuccess;
+
+        return $this;
+    }
+
+    /**
+     * Get cpSuccess
+     *
+     * @return boolean
+     */
+    public function getCpSuccess()
+    {
+        return $this->cpSuccess;
+    }
+
     /**
      * Set securitySuccess
      *

Resources/translations/messages.en.yml

@@ -14,6 +14,8 @@ score.popContent.fitWeighting: You can adjust the weighting of these elements in
 score.popContent.currentSet: "You are currently set as:"
 score.popContent.weight: weight
 score.popContent.csWeight: Code sniffer weight
+score.popContent.cpWeight: Copy paste weight
+score.popContent.scWeight: Security checker weight
 score.popContent.testWeight: Tests weight
 score.popContent.sizeWeight: Size weight
 score.popContent.scale: Project scale

Resources/translations/messages.fr.yml

@@ -13,6 +13,8 @@ score.popContent.sizeProject: Taille du projet
 score.popContent.fitWeighting: Vous pouvez adapter la pondération de ces éléments dans le param.yml.
 score.popContent.currentSet: "Vous êtes paramétrés comme suit :"
 score.popContent.csWeight: Pondération de code sniffer
+score.popContent.cpWeight: Pondération de copy paste
+score.popContent.scWeight: Pondération de security checker
 score.popContent.testWeight: Pondération des tests
 score.popContent.sizeWeight: Pondération de la taille
 score.popContent.scale: Echelle du projet

Resources/views/Main/header.html.twig

@@ -35,7 +35,9 @@
 
                     <ul>
                     <li>Code Sniffer score</li>
-                    <li>Tests status X code coverage</li>
+                    <li>Copy paste score</li>
+                    <li>Security checker score</li>
+                    <li>Tests status x code coverage</li>
                     <li>{% trans %}score.popContent.sizeProject{%endtrans %}</li>
                     </ul>
                     {% trans %}score.popContent.fitWeighting{%endtrans %}
@@ -46,6 +48,14 @@
                             {% trans %}score.popContent.csWeight{%endtrans %} :
                             {{ projectAnalyzer.getScoreWeightParam('csWeight')}}
                         </li>
+                        <li>
+                            {% trans %}score.popContent.cpWeight{%endtrans %} :
+                            {{ projectAnalyzer.getScoreWeightParam('cpWeight')}}
+                        </li>
+                        <li>
+                            {% trans %}score.popContent.scWeight{%endtrans %} :
+                            {{ projectAnalyzer.getScoreWeightParam('scWeight')}}
+                        </li>
                         <li>
                             {% trans %}score.popContent.testWeight{%endtrans %} :
                             {{ projectAnalyzer.getScoreWeightParam('testWeight')}}

Tests/Traits/ScoreCalculatorTest.php

@@ -44,17 +44,16 @@ public function testGetScoreWeightParam()
         $this->assertEquals($this->getScoreWeightParam('locWeight'), 100);
     }
 
-    /**
-     * Test du formatage des dates
-     */
     public function testCalculateScore()
     {
         // resultats de l'analyse
         $this->oAnalyze = new Analyze();
         $this->oAnalyze
-            ->setCov('100%')
+            ->setCov(100)
+            ->setCpSuccess(false)
             ->setCsSuccess(true)
-            ->setLoc(10000)
+            ->setSecuritySuccess(false)
+            ->setLoc(8564)
             ->setTuSuccess(true)
             ;
 
@@ -66,12 +65,21 @@ public function testCalculateScore()
         // scoring enable
         $this->parameters['score'] = [
             'enable' => true,
-            'testWeight' => '100',
-            'locWeight' => '100',
-            'csWeight' => '100',
+            'testWeight' => '20',
+            'cpWeight' => '30',
+            'scWeight' => '40',
+            'locWeight' => '50',
+            'csWeight' => '60',
         ];
 
+        $note   =
+            60 + // cs
+            20 + // test
+            8564 * 50 / 10000; // loc
+        $divide = (20 + 30 + 40 + 50 + 60) / 20;
+        $score  = round(($note / $divide), 2);
+
         $this->calculateScore();
-        $this->assertEquals($this->oAnalyze->getScore(), 14.67);
+        $this->assertEquals($this->oAnalyze->getScore(), $score);
     }
 }

Traits/ScoreCalculator.php

@@ -15,7 +15,7 @@ trait ScoreCalculator
 
     /**
      * Return true if score is enable by the config file
-     * @return type
+     * @return boolean
      */
     public function isScoreEnable()
     {
@@ -35,10 +35,14 @@ protected function calculateScore()
 
         $loc  = (int) $this->oAnalyze->getLoc();
         $cs   = (int) ($this->oAnalyze->getCsSuccess() === true);
+        $cp = (int) ($this->oAnalyze->getCpSuccess() === true);
+        $sc = (int) ($this->oAnalyze->getSecuritySuccess() === true);
         $test = (int) ($this->oAnalyze->getTuSuccess() === true);
         $cc   = (float) $this->oAnalyze->getCov();
 
         $csWeight = $this->getScoreWeightParam('csWeight');
+        $cpWeight = $this->getScoreWeightParam('cpWeight');
+        $scWeight = $this->getScoreWeightParam('scWeight');
         $testWeight = $this->getScoreWeightParam('testWeight');
         $locWeight = $this->getScoreWeightParam('locWeight');
 
@@ -53,22 +57,27 @@ protected function calculateScore()
             $maxSize = 100000;
         }
 
-        $note   = $cs * $csWeight + $test * $testWeight * ($cc / 100) + $loc * $locWeight / $maxSize;
-        $divide = ($csWeight + $testWeight + $locWeight) / 20;
+        $note   =
+            $cp * $cpWeight +
+            $sc * $scWeight +
+            $cs * $csWeight +
+            $test * $testWeight * ($cc / 100) +
+            $loc * $locWeight / $maxSize;
+        $divide = ($csWeight + $scWeight + $cpWeight + $testWeight + $locWeight) / 20;
         $score  = round(($note / $divide), 2);
 
         $this->oAnalyze->setScore($score);
     }
 
     /**
      * Return weight of the given parameter
-     * @param type $name
+     * @param string $name
      * @return int
      */
     public function getScoreWeightParam($name)
     {
         $weight = $this->getParam('score', $name);
-        if (!is_int($weight)) {
+        if (!is_numeric($weight)) {
             return 100;
         }