Move to level 5

This commit is contained in:
James Cole
2023-11-05 20:18:16 +01:00
parent 6f6b8d9b3e
commit 0022201c4f
15 changed files with 59 additions and 54 deletions

View File

@@ -19,59 +19,64 @@
~ along with this program. If not, see <https://www.gnu.org/licenses/>. ~ along with this program. If not, see <https://www.gnu.org/licenses/>.
--> -->
<ruleset name="Firefly III ruleset" <ruleset name="pcsg-generated-ruleset"
xmlns="http://pmd.sf.net/ruleset/1.0.0" xmlns="http://pmd.sf.net/ruleset/1.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://pmd.sf.net/ruleset/1.0.0 http://pmd.sf.net/ruleset_xml_schema.xsd" xsi:schemaLocation="http://pmd.sf.net/ruleset/1.0.0 http://pmd.sf.net/ruleset_xml_schema.xsd"
xsi:noNamespaceSchemaLocation="http://pmd.sf.net/ruleset_xml_schema.xsd"> xsi:noNamespaceSchemaLocation="http://pmd.sf.net/ruleset_xml_schema.xsd">
<description>Firefly III ruleset</description> <description>Firefly III ruleset.</description>
<!-- Import the entire controversial code rule set -->
<rule ref="rulesets/controversial.xml">
<exclude name="CamelCasePropertyName" />
</rule>
<!-- <!-- clean code -->
Commando vanuit firefly directory: <!-- <rule ref="rulesets/codesize.xml" /> -->
phpmd database,app,tests html /gdrive-all/development/phpmd/phpmd.xml > public/report.html <rule ref="rulesets/design.xml" />
--> <rule ref="rulesets/unusedcode.xml" />
<!-- Import the entire controversial code rule set -->
<rule ref="rulesets/controversial.xml">
<exclude name="CamelCasePropertyName" />
</rule>
<!-- clean code -->
<rule ref="rulesets/design.xml/" />
<rule ref="rulesets/naming.xml" />
<rule ref="rulesets/unusedcode.xml" />
<rule ref="rulesets/codesize.xml/CyclomaticComplexity">
<properties> <rule ref="rulesets/naming.xml/ShortMethodName">
<properties>
<!-- TODO we want to be at minimum 3. But we start low, and raise the bar slowly. -->
<property name="minimum" value="1"/>
</properties>
</rule>
<!-- code size -->
<rule ref="rulesets/codesize.xml/CyclomaticComplexity">
<properties>
<!-- TODO we want to be at report level 5. But we start high, and drop the bar slowly. --> <!-- TODO we want to be at report level 5. But we start high, and drop the bar slowly. -->
<property name="reportLevel" value="500"/> <property name="reportLevel" value="500"/>
</properties> </properties>
</rule> </rule>
<rule ref="rulesets/codesize.xml/NPathComplexity"> <rule ref="rulesets/codesize.xml/NPathComplexity">
<properties> <properties>
<!-- TODO we want to be at a value of 128. But we start high, and drop the bar slowly. --> <!-- TODO we want to be at a value of 128. But we start high, and drop the bar slowly. -->
<property name="minimum" value="99000"/> <property name="minimum" value="100000"/>
</properties> </properties>
</rule> </rule>
<rule ref="rulesets/codesize.xml/ExcessiveMethodLength"> <rule ref="rulesets/codesize.xml/ExcessiveMethodLength">
<properties> <properties>
<!-- TODO we want to be at a value of 40. But we start high, and drop the bar slowly. --> <!-- TODO we want to be at a value of 40. But we start high, and drop the bar slowly. -->
<property name="minimum" value="400"/> <property name="minimum" value="400"/>
</properties> </properties>
</rule> </rule>
<rule ref="rulesets/codesize.xml/ExcessiveParameterList"> <rule ref="rulesets/codesize.xml/ExcessiveParameterList">
<properties> <properties>
<!-- TODO we want to be at a value of 4. But we start high, and drop the bar slowly. --> <!-- TODO we want to be at a value of 4. But we start high, and drop the bar slowly. -->
<property name="minimum" value="5"/> <property name="minimum" value="5"/>
</properties> </properties>
</rule> </rule>
<!-- include clean code manually --> <!-- include clean code manually -->
<rule ref="rulesets/cleancode.xml/BooleanArgumentFlag" /> <rule ref="rulesets/cleancode.xml/BooleanArgumentFlag" />
<rule ref="rulesets/cleancode.xml/ElseExpression" /> <rule ref="rulesets/cleancode.xml/ElseExpression" />
<rule ref="rulesets/cleancode.xml/MissingImport" /> <rule ref="rulesets/cleancode.xml/MissingImport" />
<rule ref="rulesets/cleancode.xml/UndefinedVariable" /> <rule ref="rulesets/cleancode.xml/UndefinedVariable" />
<rule ref="rulesets/cleancode.xml/IfStatementAssignment" />
<!-- no this one --> <rule ref="rulesets/cleancode.xml/DuplicatedArrayKey" />
<!--<rule ref="rulesets/cleancode.xml/StaticAccess" />--> <rule ref="rulesets/cleancode.xml/ErrorControlOperator" />
</ruleset> </ruleset>

View File

@@ -56,5 +56,5 @@ parameters:
# The level 8 is the highest level. original was 5 # The level 8 is the highest level. original was 5
# TODO: slowly up the level and fix the issues found. # TODO: slowly up the level and fix the issues found.
level: 1 level: 5

View File

@@ -88,8 +88,8 @@ use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
class Attachment extends Model class Attachment extends Model
{ {
use ReturnsIntegerIdTrait; use ReturnsIntegerIdTrait;
use SoftDeletes;
use ReturnsIntegerUserIdTrait; use ReturnsIntegerUserIdTrait;
use SoftDeletes;
protected $casts protected $casts
= [ = [

View File

@@ -71,8 +71,8 @@ use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
class AvailableBudget extends Model class AvailableBudget extends Model
{ {
use ReturnsIntegerIdTrait; use ReturnsIntegerIdTrait;
use SoftDeletes;
use ReturnsIntegerUserIdTrait; use ReturnsIntegerUserIdTrait;
use SoftDeletes;
protected $casts protected $casts
= [ = [

View File

@@ -106,8 +106,8 @@ use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
class Bill extends Model class Bill extends Model
{ {
use ReturnsIntegerIdTrait; use ReturnsIntegerIdTrait;
use SoftDeletes;
use ReturnsIntegerUserIdTrait; use ReturnsIntegerUserIdTrait;
use SoftDeletes;
protected $casts protected $casts
= [ = [

View File

@@ -87,8 +87,8 @@ use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
class Budget extends Model class Budget extends Model
{ {
use ReturnsIntegerIdTrait; use ReturnsIntegerIdTrait;
use SoftDeletes;
use ReturnsIntegerUserIdTrait; use ReturnsIntegerUserIdTrait;
use SoftDeletes;
protected $casts protected $casts
= [ = [

View File

@@ -76,8 +76,8 @@ use FireflyIII\Support\Models\ReturnsIntegerIdTrait;
class Category extends Model class Category extends Model
{ {
use ReturnsIntegerIdTrait; use ReturnsIntegerIdTrait;
use SoftDeletes;
use ReturnsIntegerUserIdTrait; use ReturnsIntegerUserIdTrait;
use SoftDeletes;
protected $casts protected $casts
= [ = [

View File

@@ -72,8 +72,8 @@ use Carbon\Carbon;
class CurrencyExchangeRate extends Model class CurrencyExchangeRate extends Model
{ {
use ReturnsIntegerIdTrait; use ReturnsIntegerIdTrait;
use SoftDeletes;
use ReturnsIntegerUserIdTrait; use ReturnsIntegerUserIdTrait;
use SoftDeletes;
protected $casts protected $casts

View File

@@ -94,8 +94,8 @@ use FireflyIII\Support\Models\ReturnsIntegerIdTrait;
class Recurrence extends Model class Recurrence extends Model
{ {
use ReturnsIntegerIdTrait; use ReturnsIntegerIdTrait;
use SoftDeletes;
use ReturnsIntegerUserIdTrait; use ReturnsIntegerUserIdTrait;
use SoftDeletes;
protected $casts protected $casts

View File

@@ -84,8 +84,8 @@ use FireflyIII\Support\Models\ReturnsIntegerIdTrait;
class Rule extends Model class Rule extends Model
{ {
use ReturnsIntegerIdTrait; use ReturnsIntegerIdTrait;
use SoftDeletes;
use ReturnsIntegerUserIdTrait; use ReturnsIntegerUserIdTrait;
use SoftDeletes;
protected $casts protected $casts

View File

@@ -75,8 +75,8 @@ use FireflyIII\Support\Models\ReturnsIntegerIdTrait;
class RuleGroup extends Model class RuleGroup extends Model
{ {
use ReturnsIntegerIdTrait; use ReturnsIntegerIdTrait;
use SoftDeletes;
use ReturnsIntegerUserIdTrait; use ReturnsIntegerUserIdTrait;
use SoftDeletes;
protected $casts protected $casts

View File

@@ -83,8 +83,8 @@ use FireflyIII\Support\Models\ReturnsIntegerIdTrait;
class Tag extends Model class Tag extends Model
{ {
use ReturnsIntegerIdTrait; use ReturnsIntegerIdTrait;
use SoftDeletes;
use ReturnsIntegerUserIdTrait; use ReturnsIntegerUserIdTrait;
use SoftDeletes;
protected $casts protected $casts

View File

@@ -67,8 +67,8 @@ use FireflyIII\Support\Models\ReturnsIntegerIdTrait;
class TransactionGroup extends Model class TransactionGroup extends Model
{ {
use ReturnsIntegerIdTrait; use ReturnsIntegerIdTrait;
use SoftDeletes;
use ReturnsIntegerUserIdTrait; use ReturnsIntegerUserIdTrait;
use SoftDeletes;
protected $casts protected $casts

View File

@@ -127,8 +127,8 @@ class TransactionJournal extends Model
{ {
use HasFactory; use HasFactory;
use ReturnsIntegerIdTrait; use ReturnsIntegerIdTrait;
use SoftDeletes;
use ReturnsIntegerUserIdTrait; use ReturnsIntegerUserIdTrait;
use SoftDeletes;
protected $casts protected $casts

View File

@@ -81,8 +81,8 @@ use FireflyIII\Support\Models\ReturnsIntegerIdTrait;
class Webhook extends Model class Webhook extends Model
{ {
use ReturnsIntegerIdTrait; use ReturnsIntegerIdTrait;
use SoftDeletes;
use ReturnsIntegerUserIdTrait; use ReturnsIntegerUserIdTrait;
use SoftDeletes;
protected $casts protected $casts
= [ = [