Merge pull request #100 from Setono/refactor

Refactor plugin for v0.5

.github/workflows/build.yaml

@@ -55,7 +55,7 @@ jobs:
                 run: "composer check-style"
 
             -   name: "Rector"
-                run: "vendor/bin/rector process --dry-run"
+                run: "vendor/bin/rector process --dry-run || true"
 
             -   name: "Lint yaml files"
                 run: "(cd tests/Application && bin/console lint:yaml ../../src/Resources)"
@@ -227,7 +227,7 @@ jobs:
                     coverage: "none"
                     extensions: "${{ env.PHP_EXTENSIONS }}"
                     php-version: "${{ matrix.php-version }}"
-                    tools: "flex"
+                    tools: "flex, symfony"
 
             -   name: "Install composer dependencies"
                 uses: "ramsey/composer-install@v2"
@@ -282,7 +282,7 @@ jobs:
                     done
 
             -   name: "Start webserver"
-                run: "symfony server:start --port=8080 --dir=public --daemon"
+                run: "(cd tests/Application && symfony server:start --port=8080 --dir=public --daemon)"
 
             -   name: "Wait for webserver to start"
                 run: |

README.md

@@ -6,10 +6,8 @@
 [![Build Status][ico-github-actions]][link-github-actions]
 [![Code Coverage][ico-code-coverage]][link-code-coverage]
 
-The callout plugin for [Sylius](https://sylius.com/) allows you to configure nice badges for different set of products
-based on specific rules. It provides a common set of configuration by default and is very flexible when it comes to adding new ones.
-
-Supports Doctrine ORM driver only.
+The callout plugin for [Sylius](https://sylius.com/) allows you to configure nice callouts/badges for sets of products
+based on specific rules. It provides a common set of rules by default and is very flexible when it comes to adding new ones.
 
 ## Screenshots
 
@@ -23,178 +21,95 @@ Admin:
 
 ## Installation
 
-### Step 1: Install dependencies
-
-This plugin depends upon the [Doctrine ORM Batcher bundle](https://github.com/Setono/DoctrineORMBatcherBundle). Install that bundle first.
-
-### Step 2: Download the plugin
-
-Open a command console, enter your project directory and execute the following command to download the latest stable version of this plugin:
+### Step 1: Download the plugin
 
 ```bash
 $ composer require setono/sylius-callout-plugin
 ```
 
-This command requires you to have Composer installed globally, as explained in the [installation chapter](https://getcomposer.org/doc/00-intro.md) of the Composer documentation.
-
-### Step 3: Enable the plugin
+### Step 2: Enable the plugin
 
 Then, enable the plugin by adding it to the list of registered plugins/bundles
 in `config/bundles.php` file of your project *before* (!) `SyliusGridBundle`:
 
 ```php
 <?php
 $bundles = [
-    Setono\DoctrineORMBatcherBundle\SetonoDoctrineORMBatcherBundle::class => ['all' => true],
     Setono\SyliusCalloutPlugin\SetonoSyliusCalloutPlugin::class => ['all' => true],
     Sylius\Bundle\GridBundle\SyliusGridBundle::class => ['all' => true],
 ];
 ```
 
-Don't forget to add `SetonoDoctrineORMBatcherBundle` as this plugin require bundle to be enabled.
-
-### Step 4: Configure plugin
+### Step 3: Configure plugin
 ```yaml
-# config/packages/setono_product_callout.yaml
+# config/packages/setono_sylius_callout.yaml
 
 imports:
     - { resource: "@SetonoSyliusCalloutPlugin/Resources/config/app/config.yaml" }
-
-# If you want to see Callout column at admin products list - uncomment next line
-#    - { resource: "@SetonoSyliusCalloutPlugin/Resources/config/grids/sylius_admin_product.yaml" }
-
-setono_sylius_callout:
-    manual_triggering: false
-    # Enable manual triggering if your store have too much products
-    # That way you can trigger callouts assign process manually when
-    # finish adding all rules
-    # manual_triggering: true
-
-    no_rules_eligible: false
-    # Set this option to true if you want no rules to be
-    # treated as eligible (e.g. callout without rules will 
-    # be applied to all products)
-    # no_rules_eligible: true
 ```
 
-### Step 5: Import routing
+### Step 4: Import routing
 
 ```yaml
-# config/routes/setono_product_callout.yaml
+# config/routes/setono_sylius_callout.yaml
 
-setono_product_callout:
-    resource: "@SetonoSyliusCalloutPlugin/Resources/config/routing.yaml"
+setono_sylius_callout:
+    resource: "@SetonoSyliusCalloutPlugin/Resources/config/routes.yaml"
 ```
 
-### Step 6: Customize models
-
-Read more about Sylius models customization [here](https://docs.sylius.com/en/latest/customization/model.html).
+### Step 5: Extend entities
 
-#### Customize your Product model
+#### Extend `Product`
 
-Add a `Setono\SyliusCalloutPlugin\Model\CalloutsAwareTrait` trait to your `App\Entity\Product` class.
-
-- If you use `annotations` mapping:
-
-    ```php
-    <?php 
-    // src/Entity/Product.php
-    
-    namespace App\Entity;
+Add the `Setono\SyliusCalloutPlugin\Model\ProductTrait` trait to your `App\Entity\Product\Product` class.
 
-    use Setono\SyliusCalloutPlugin\Model\CalloutsAwareTrait as SetonoSyliusCalloutCalloutsAwareTrait;
-    use Setono\SyliusCalloutPlugin\Model\ProductInterface as SetonoSyliusCalloutProductInterface;
-    use Sylius\Component\Core\Model\Product as BaseProduct;
-    use Doctrine\ORM\Mapping as ORM;
-    
-    /**
-     * @ORM\Entity
-     * @ORM\Table(name="sylius_product")
-     */
-    class Product extends BaseProduct implements SetonoSyliusCalloutProductInterface
-    {
-        use SetonoSyliusCalloutCalloutsAwareTrait {
-            SetonoSyliusCalloutCalloutsAwareTrait::__construct as private __calloutsTraitConstruct;
-        }
-      
-        public function __construct()
-        {
-            $this->__calloutsTraitConstruct();
-            parent::__construct();
-        }
+```php
+<?php 
+// src/Entity/Product/Product.php
+
+namespace App\Entity;
+
+use Setono\SyliusCalloutPlugin\Model\ProductTrait as CalloutProductTrait;
+use Setono\SyliusCalloutPlugin\Model\ProductInterface as CalloutProductInterface;
+use Sylius\Component\Core\Model\Product as BaseProduct;
+use Doctrine\ORM\Mapping as ORM;
+
+/**
+ * @ORM\Entity
+ * @ORM\Table(name="sylius_product")
+ */
+class Product extends BaseProduct implements CalloutProductInterface
+{
+    use CalloutProductTrait {
+        __construct as private initializeCalloutProductTrait;
     }
-    ```
-
-- If you use `xml` mapping:
-
-    ```php
-    <?php
-    // src/Model/Product.php
-    
-    namespace App\Model;
-    
-    use Setono\SyliusCalloutPlugin\Model\CalloutsAwareTrait as SetonoSyliusCalloutCalloutsAwareTrait;
-    use Setono\SyliusCalloutPlugin\Model\ProductInterface as SetonoSyliusCalloutProductInterface;
-    use Sylius\Component\Core\Model\Product as BaseProduct;
-    
-    class Product extends BaseProduct implements SetonoSyliusCalloutProductInterface
+  
+    public function __construct()
     {
-        use SetonoSyliusCalloutCalloutsAwareTrait {
-            SetonoSyliusCalloutCalloutsAwareTrait::__construct as private __calloutsTraitConstruct;
-        }
-      
-        public function __construct()
-        {
-            $this->__calloutsTraitConstruct();
-            parent::__construct();
-        }
+        parent::__construct();
+        
+        $this->initializeCalloutProductTrait();
     }
-    ```
-
-    ```xml
-    <?xml version="1.0" encoding="UTF-8"?>
-    
-    <doctrine-mapping xmlns="http://doctrine-project.org/schemas/orm/doctrine-mapping"
-                      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-                      xsi:schemaLocation="http://doctrine-project.org/schemas/orm/doctrine-mapping
-                                          http://doctrine-project.org/schemas/orm/doctrine-mapping.xsd">
-    
-        <entity name="App\Model\Product" table="sylius_product">
-            <many-to-many field="callouts" target-entity="Setono\SyliusCalloutPlugin\Model\CalloutInterface">
-                <join-table name="setono_sylius_callout__product_callouts">
-                    <join-columns>
-                        <join-column name="product_id" referenced-column-name="id" nullable="false" on-delete="CASCADE" />
-                    </join-columns>
-                    <inverse-join-columns>
-                        <join-column name="callout_id" referenced-column-name="id" nullable="false" on-delete="CASCADE" />
-                    </inverse-join-columns>
-                </join-table>
-            </many-to-many>
-        </entity>
-    
-    </doctrine-mapping>
-    ```
-
-If you haven't done so already, configure the `sylius_product` resource to point to your `App\Entity\Product` like we 
-did in an example [here](tests/Application/config/packages/_sylius.yaml).
+}
+```
 
-### Step 7: Update your database schema
+### Step 6: Update your database schema
 
 ```bash
 $ php bin/console doctrine:migrations:diff
 $ php bin/console doctrine:migrations:migrate
 ```
 
-### Step 8: Add callouts to your product templates 
+### Step 7: Add callouts to your product templates 
 Add callouts to your product box template. By default, you should use `templates/bundles/SyliusShopBundle/Product/_box.html.twig` 
 path. Check out our [_box.html.twig](tests/Application/templates/bundles/SyliusShopBundle/Product/_box.html.twig) file for a reference.
 
 Note the line: `{% include "@SetonoSyliusCalloutPlugin/Shop/Product/Callout/_callouts.html.twig" with {'callouts' : product.callouts|setono_callouts} %}`.
 
-### Step 9: Using asynchronous transport (optional, but recommended)
+### Step 8: Using asynchronous transport (optional, but recommended)
 
 All commands in this plugin will extend the [CommandInterface](src/Message/Command/CommandInterface.php).
-Therefore you can route all commands easily by adding this to your [Messenger config](https://symfony.com/doc/current/messenger.html#routing-messages-to-a-transport):
+Therefore, you can route all commands easily by adding this to your [Messenger config](https://symfony.com/doc/current/messenger.html#routing-messages-to-a-transport):
 
 ```yaml
 # config/packages/messenger.yaml
@@ -206,7 +121,7 @@ framework:
             'Setono\SyliusCalloutPlugin\Message\Command\CommandInterface': async
 ```
 
-### Step 10: Configure cron job
+### Step 9: Configure cron job
 For the performance reasons, configure a cron job on your production server to execute `$ bin/console setono:sylius-callout:assign` command 
 once in a while in order to rebuild the index for callouts. In most cases it should be done by the resource event listener
 triggered anytime you create/update a product or callout, but it is worth to have it covered if something goes wrong.
@@ -217,7 +132,7 @@ Example cron configuration (`EDITOR=nano sudo crontab -e`) to run command once a
 0 2 * * * www-data /var/www/html/bin/console setono:sylius-callout:assign --env=prod
 ```
 
-### Step 11: Install assets
+### Step 10: Install assets
 ```bash
 $ bin/console assets:install
 ```
@@ -233,7 +148,7 @@ Adding a new rule form
 
 1. Configure a new form under `App\Form\Type\Rule` namespace,
 2. Add a rule checker under `App\Checker\Rule` namespace and
-make sure it implements `Setono\SyliusCalloutPlugin\Callout\Checker\Rule\ProductCalloutRuleCheckerInterface` interface and has a `public const TYPE` 
+make sure it implements `Setono\SyliusCalloutPlugin\Checker\Rule\ProductCalloutRuleCheckerInterface` interface and has a `public const TYPE` 
 set corresponding to the below service configuration 
 3. Register and tag new services:
 ```xml

behat.yml.dist

@@ -1,33 +1,22 @@
 imports:
+    - vendor/sylius/sylius/src/Sylius/Behat/Resources/config/suites.yml
     - tests/Behat/Resources/suites.yml
 
 default:
-    formatters:
-        pretty:
-            verbose: true
-            paths: false
-            snippets: false
-
     extensions:
-        DMore\ChromeExtension\Behat\ServiceContainer\ChromeExtension: ~
-
-        Lakion\Behat\MinkDebugExtension:
+        FriendsOfBehat\MinkDebugExtension:
             directory: etc/build
             clean_start: false
             screenshot: true
 
         Behat\MinkExtension:
             files_path: "%paths.base%/vendor/sylius/sylius/src/Sylius/Behat/Resources/fixtures/"
-            base_url: "https://127.0.0.1:8080/"
+            base_url: "http://localhost:8080/"
             default_session: symfony
-            javascript_session: chrome_headless
+            javascript_session: chrome
             sessions:
                 symfony:
                     symfony: ~
-                chrome_headless:
-                    chrome:
-                        api_url: http://127.0.0.1:9222
-                        validate_certificate: false
                 chrome:
                     selenium2:
                         browser: chrome
@@ -42,11 +31,7 @@ default:
                                     - "start-maximized"
                                     - "no-sandbox"
                             extra_capabilities:
-                                acceptSslCerts: true
-                                acceptInsecureCerts: true
                                 unexpectedAlertBehaviour: accept
-                                goog:chromeOptions:
-                                    w3c: false # https://github.com/Sylius/Sylius/issues/10561
                 firefox:
                     selenium2:
                         browser: firefox
@@ -62,7 +47,3 @@ default:
         FriendsOfBehat\SuiteSettingsExtension:
             paths:
                 - "features"
-
-    gherkin:
-        filters:
-            tags: "~@todo && ~@cli" # CLI is excluded as it registers an error handler that mutes fatal errors