Expanded the rules to cover additional use cases

Author: mnocon

README.md

@@ -69,6 +69,7 @@ composer phpstan -- --generate-baseline
 ### Deptrac
 
 This repository uses Deptrac to test the code samples. To run the tests locally execute the commands below:
+
 ```bash
 composer update
 composer deptrac

code_samples/catalog/custom_attribute_type/src/Attribute/Percent/Storage/PercentStorageConverter.php

@@ -5,14 +5,13 @@
 namespace App\Attribute\Percent\Storage;
 
 use Ibexa\Contracts\ProductCatalog\Local\Attribute\StorageConverterInterface;
-use Ibexa\ProductCatalog\Local\Persistence\Legacy\Attribute\Float\StorageSchema;
 use Webmozart\Assert\Assert;
 
 final class PercentStorageConverter implements StorageConverterInterface
 {
     public function fromPersistence(array $data)
     {
-        $value = $data[StorageSchema::COLUMN_VALUE];
+        $value = $data['value'];
         Assert::nullOrNumeric($value);
 
         return $value;
@@ -23,7 +22,7 @@ public function toPersistence($value): array
         Assert::nullOrNumeric($value);
 
         return [
-            StorageSchema::COLUMN_VALUE => $value,
+            'value' => $value,
         ];
     }
 }

code_samples/catalog/custom_attribute_type/src/Attribute/Percent/Storage/PercentStorageDefinition.php

@@ -10,19 +10,18 @@
 
 use Doctrine\DBAL\Types\Types;
 use Ibexa\Contracts\ProductCatalog\Local\Attribute\StorageDefinitionInterface;
-use Ibexa\ProductCatalog\Local\Persistence\Legacy\Attribute\Float\StorageSchema;
 
 final class PercentStorageDefinition implements StorageDefinitionInterface
 {
     public function getColumns(): array
     {
         return [
-            StorageSchema::COLUMN_VALUE => Types::FLOAT,
+            'value' => Types::FLOAT,
         ];
     }
 
     public function getTableName(): string
     {
-        return StorageSchema::TABLE_NAME;
+        return 'app_product_specification_attribute_percent';
     }
 }

deptrac.baseline.yaml

@@ -1,27 +1,7 @@
 deptrac:
   skip_violations:
-    Acme\ExampleBundle\DependencyInjection\AcmeExampleExtension:
-      - Ibexa\Bundle\Core\DependencyInjection\Configuration\SiteAccessAware\ConfigurationProcessor
-      - Ibexa\Bundle\Core\DependencyInjection\Configuration\SiteAccessAware\ContextualizerInterface
-    Acme\ExampleBundle\DependencyInjection\Configuration:
-      - Ibexa\Bundle\Core\DependencyInjection\Configuration\SiteAccessAware\Configuration
     App\AI\REST\Input\Parser\TranscribeAudio:
-      - Ibexa\ConnectorAi\REST\Input\Parser\Action
       - Ibexa\Rest\Input\BaseParser
-    App\AI\REST\Output\Resolver\AudioTextResolver:
-      - Ibexa\ConnectorAi\REST\Output\ResolverInterface
-    App\AI\REST\Value\AudioText:
-      - Ibexa\ConnectorAi\REST\Value\RestActionResponse
-    App\Attribute\Percent\Form\PercentValueFormMapper:
-      - Ibexa\Bundle\ProductCatalog\Validator\Constraints\AttributeValue
-    App\Attribute\Percent\PercentOptionsFormMapper:
-      - Ibexa\Bundle\ProductCatalog\Validator\Constraints\AttributeDefinitionOptions
-    App\Attribute\Percent\Storage\PercentStorageConverter:
-      - Ibexa\ProductCatalog\Local\Persistence\Legacy\Attribute\Float\StorageSchema
-    App\Attribute\Percent\Storage\PercentStorageDefinition:
-      - Ibexa\ProductCatalog\Local\Persistence\Legacy\Attribute\Float\StorageSchema
-    App\AutomatedTranslation\AiClient:
-      - Ibexa\AutomatedTranslation\Exception\ClientNotConfiguredException
     App\AutomatedTranslation\ImageFieldEncoder:
       - Ibexa\Core\FieldType\Image\Value
     App\Block\Listener\MyBlockListener:
@@ -73,7 +53,7 @@ deptrac:
     App\Controller\CustomCheckoutController:
       - Ibexa\Bundle\Core\Controller
     App\Controller\CustomController:
-      - Ibexa\Bundle\Core\Controller
+      - Ibexa\Core\MVC\Symfony\Security\Authorization\Attribute
     App\Controller\CustomFilterController:
       - Ibexa\Bundle\Core\Controller
       - Ibexa\Core\MVC\Symfony\View\ContentView
@@ -158,8 +138,12 @@ deptrac:
       - Ibexa\Migration\ValueObject\Step\StepInterface
     App\Migrations\Step\ReplaceNameStepNormalizer:
       - Ibexa\Migration\ValueObject\Step\StepInterface
+    App\Notification\ListRenderer:
+      - Ibexa\Core\Notification\Renderer\NotificationRenderer
+      - Ibexa\Core\Notification\Renderer\TypedNotificationRendererInterface
     App\Notification\MyRenderer:
       - Ibexa\Core\Notification\Renderer\NotificationRenderer
+      - Ibexa\Core\Notification\Renderer\TypedNotificationRendererInterface
     App\OAuth\GoogleResourceOwnerMapper:
       - Ibexa\OAuth2Client\ResourceOwner\ResourceOwnerToExistingOrNewUserMapper
     App\QueryType\LatestContentQueryType:

deptrac.yaml

@@ -13,15 +13,40 @@ deptrac:
           collectors:
               - type: classLike
                 value: .*Ibexa\\Contracts\\.*
-        - name: IbexaNotContracts
+        - name: IbexaSiteAccessConfiguration
+          collectors:
+              - type: classLike
+                value: .*Ibexa\\Bundle\\Core\\DependencyInjection\\Configuration\\SiteAccessAware\\.*
+        - name: IbexaInternal
+          collectors:
+            - type: tagValueRegex
+              tag: '@internal'
+        - name: IbexaRest
+          collectors:
+              - type: classLike
+                value: .*Ibexa\\.*\\Rest\\.*
+        - name: IbexaConstraints
+          collectors:
+              - type: classLike
+                value: .*Ibexa\\.*\\Constraints\\.*
+        - name: IbexaNotAllowed
           collectors:
           - type: bool
             must:
               - type: classLike
                 value: .*Ibexa\\.*
             must_not:
-              - type: classLike
-                value: .*Ibexa\\Contracts.*
+              - type: layer
+                value: IbexaContracts
+              - type: layer
+                value: IbexaSiteAccessConfiguration
+              - type: layer
+                value: IbexaRest
+              - type: layer
+                value: IbexaConstraints
     ruleset:
         CodeSamples:
           - IbexaContracts
+          - IbexaSiteAccessConfiguration
+          - IbexaRest
+          - IbexaConstraints

docs/pim/create_custom_attribute_type.md

@@ -120,6 +120,25 @@ Register the validator as a service and tag it with `ibexa.product_catalog.attri
 
 To ensure that values of the new attributes are stored correctly, you need to provide a storage converter and storage definition services.
 
+### Database schema design
+
+The values are going to be stored within a table named `app_product_specification_attribute_percent`, in a column named `value`.
+
+=== "MySQL"
+
+    ``` sql
+    CREATE TABLE app_product_specification_attribute_percent (id INT NOT NULL, value DOUBLE PRECISION DEFAULT NULL, INDEX app_product_specification_attribute_percent_value_idx (value), PRIMARY KEY(id)) DEFAULT CHARACTER SET utf8mb4 COLLATE `utf8mb4_unicode_520_ci` ENGINE = InnoDB;
+    ALTER TABLE app_product_specification_attribute_percent ADD CONSTRAINT app_product_specification_attribute_percent_fk FOREIGN KEY (id) REFERENCES ibexa_product_specification_attribute (id) ON UPDATE CASCADE ON DELETE CASCADE;
+    ```
+
+=== "PostgreSQL"
+
+    ``` sql
+    CREATE TABLE app_product_specification_attribute_percent (id INT NOT NULL, value DOUBLE PRECISION DEFAULT NULL, PRIMARY KEY(id));
+    CREATE INDEX app_product_specification_attribute_percent_value_idx ON app_product_specification_attribute_percent (value);
+    ALTER TABLE app_product_specification_attribute_percent ADD CONSTRAINT app_product_specification_attribute_percent_fk FOREIGN KEY (id) REFERENCES ibexa_product_specification_attribute (id) ON UPDATE CASCADE ON DELETE CASCADE NOT DEFERRABLE INITIALLY IMMEDIATE;
+    ```
+
 ### Storage converter
 
 Start by creating a `PercentStorageConverter` class, which implements `Ibexa\Contracts\ProductCatalog\Local\Attribute\StorageConverterInterface`.