[UPMERGE] 2.0 -> 2.1 (#392)

This PR has been generated automatically.
For more details see
[upmerge_pr.yaml](/Sylius/InvoicingPlugin/blob/1.0/.github/workflows/upmerge_pr.yaml).

**Remember!** The upmerge should always be merged with using `Merge pull
request` button.

In case of conflicts, please resolve them manually with usign the
following commands:
```
git fetch upstream
gh pr checkout <this-pr-number>
git merge upstream/2.1 -m "Resolve conflicts between 2.0 and 2.1"
```

If you use other name for the upstream remote, please replace `upstream`
with the name of your remote pointing to the `Sylius/InvoicingPlugin`
repository.

Once the conflicts are resolved, please run `git merge --continue` and
push the changes to this PR.

Author: Rafikooo

.github/workflows/build.yaml

@@ -207,10 +207,6 @@ jobs:
                 name: Run analysis
                 run: composer analyse
 
-            -
-                name: Run PHPSpec
-                run: vendor/bin/phpspec run --ansi -f progress --no-interaction
-
             -
                 name: Run PHPUnit
                 run: vendor/bin/phpunit --colors=always

.github/workflows/upmerge_pr.yaml

@@ -23,6 +23,9 @@ jobs:
                     -
                         base_branch: "1.0"
                         target_branch: "2.0"
+                    -
+                        base_branch: "2.0"
+                        target_branch: "2.1"
 
         steps:
             -

README.md

@@ -17,125 +17,22 @@
 SyliusInvoicingPlugin creates new immutable invoice when the order is in given state (default: created) and allows
 both customer and admin to download invoices related to the order.
 
-![Screenshot showing invoice](docs/screenshot_invoice.png)
-![Screenshot showing invoice browsing page in administration panel](docs/screenshot_admin.png)
+---
 
-## Business value
+## Documentation
 
-The primary aim of Invoicing Plugin is to create a document representing Customer's will to buy particular products and
-pay for them.
+📖 Full documentation is available here:
+👉 [Invoicing Plugin Documentation](https://docs.sylius.com/invoicing-plugin)
 
-An Invoice can also be treated as a proof of placing an Order. Thus, it is downloadable as .pdf file and can be sent to
-Customer manually by the Administrator or automatically once an Order is paid.
-
-Additional feature of the plugin that fulfills Invoicing domain is the ability to set billing data on a Seller.
-
-## Installation
-
-#### Beware!
-
-This installation instruction assumes that you're using Symfony Flex. If you don't, take a look at the
-[legacy installation instruction](docs/legacy_installation.md). However, we strongly encourage you to use
-Symfony Flex, it's much quicker!
-
-1. Require plugin with composer:
-
-    ```bash
-    composer require sylius/invoicing-plugin
-    ```
-
-    > Remember to allow community recipes with `composer config extra.symfony.allow-contrib true` or during plugin installation process
-
-2. Apply migrations to your database:
-
-    ```bash
-    bin/console doctrine:migrations:migrate
-    ```
-
-3. Default configuration assumes enabled PDF file generation. If you don't want to use that feature change your app configuration:
-
-    ```yaml
-    # config/packages/sylius_invoicing.yaml
-    sylius_invoicing:
-        pdf_generator:
-            enabled: false
-    ```
-
-    Otherwise, check if you have wkhtmltopdf binary. If not, you can download it [here](https://wkhtmltopdf.org/downloads.html).
-
-    In case wkhtmltopdf is not located in `/usr/local/bin/wkhtmltopdf` modify the `WKHTMLTOPDF_PATH` environment variable in the `.env` file:
-
-    ```
-    WKHTMLTOPDF_PATH=/usr/local/bin/wkhtmltopdf # Change this! :)
-    ```
-
-4. If you want to generate invoices for orders placed before plugin's installation run the following command using your terminal:
-
-   ```bash
-   bin/console sylius-invoicing:generate-invoices
-   ```
-
-## Extension points
-
-The majority of actions contained in the SyliusInvoicingPlugin are executed after an event related to the change of the Order’s state.
-
-Here is an example using Symfony’s workflow:
-
-```xml
-<service id="sylius_invoicing_plugin.event_listener.workflow.payment.produce_order_payment_paid"
-       class="Sylius\InvoicingPlugin\EventListener\Workflow\Payment\ProduceOrderPaymentPaidListener">
-   <argument type="service" id="sylius_invoicing_plugin.event_producer.order_payment_paid" />
-
-   <tag name="kernel.event_listener" event="workflow.sylius_payment.completed.complete" priority="100" />
-</service>
-```
-
-Additionally, the Invoice model is treated as a Resource.
-
-You can read more about Resources here:
-
-<http://docs.sylius.com/en/latest/components_and_bundles/bundles/SyliusResourceBundle/index.html>.
-
-Hence, the template for displaying the list of Invoices is defined in the `routing.yml` file:
-
-```yaml
-sylius_invoicing_invoice:
-    resource: |
-        alias: sylius_invoicing.invoice
-        section: admin
-        templates: "@SyliusAdmin\\Crud"
-        only: ['index']
-        grid: sylius_invoicing_invoice
-        permission: true
-        vars:
-            all:
-                subheader: sylius_invoicing.ui.manage_invoices
-            index:
-                icon: inbox
-    type: sylius.resource
-```
-
-Another aspect that can be both replaced and customized is displaying Invoices list on Order show view.
-Code responsible for displaying Invoices related to the Order is injected to existing Sylius template using
-Sonata events. You can read about customizing templates via events here:
-
-<http://docs.sylius.com/en/latest/customization/template.html>
-
-### Invoices files
-
-By default, when the order is paid, an immutable Invoice pdf file is saved on the server. The save directory is specified
-with `%sylius_invoicing.invoice_save_path%` parameter, that can be overridden if needed.
+## Security issues
 
-There is no direct relation between `Sylius\InvoicingPlugin\Entity\Invoice` entity and its file. It's resolved based on
-the `Invoice::$number`, which is defined in `Sylius\InvoicingPlugin\Provider\InvoiceFileProviderInterface` service.
-By overriding this service, you can change a logic that is used to retrieve the invoice file.
+If you think that you have found a security issue, please do not use the issue tracker and do not post it publicly.
+Instead, all security issues must be sent to `security@sylius.com`.
 
-## Fixtures
+## Community
 
-You can add `ShopBillingData` fixtures into a yaml to add Channel ShopBillingData info to your installation.
-More instructions on the [fixtures configuration instructions](docs/fixtures.md).
+For online communication, we invite you to chat with us and other users on [Sylius Slack](https://sylius.com/slack).
 
-## Security issues
+## License
 
-If you think that you have found a security issue, please do not use the issue tracker and do not post it publicly.
-Instead, all security issues must be sent to `security@sylius.com`.
+This plugin is released under the [MIT License](LICENSE).

composer.json

@@ -37,13 +37,12 @@
         "friends-of-behat/variadic-extension": "^1.6",
         "matthiasnoback/symfony-config-test": "^5.1",
         "matthiasnoback/symfony-dependency-injection-test": "^5.1",
-        "phpspec/phpspec": "^7.5",
         "phpstan/extension-installer": "^1.4",
         "phpstan/phpstan": "^1.12",
         "phpstan/phpstan-doctrine": "^1.5",
         "phpstan/phpstan-symfony": "^1.4",
         "phpstan/phpstan-webmozart-assert": "^1.2",
-        "phpunit/phpunit": "^9.5",
+        "phpunit/phpunit": "^10.5",
         "polishsymfonycommunity/symfony-mocker-container": "^1.0",
         "sylius-labs/coding-standard": "^4.4",
         "sylius/test-application": "^2.0.0@alpha",
@@ -70,10 +69,10 @@
         "analyse": [
             "@composer validate --strict",
             "vendor/bin/phpstan analyse -c phpstan.neon -l max",
-            "vendor/bin/ecs check src/ spec/"
+            "vendor/bin/ecs check src/"
         ],
         "fix": [
-            "vendor/bin/ecs check --fix src/ spec/"
+            "vendor/bin/ecs check --fix src/"
         ]
     },
     "config": {

docs/fixtures.md

@@ -2,12 +2,12 @@
 
 <phpunit
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-    xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/8.1/phpunit.xsd"
+    xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.5/phpunit.xsd"
     colors="true"
     bootstrap="vendor/sylius/test-application/config/bootstrap.php"
 >
     <testsuites>
-        <testsuite name="SyliusInvoicingPlugin Test Suite">
+        <testsuite name="sylius_invoicing_plugin_test_suite">
             <directory>tests</directory>
         </testsuite>
     </testsuites>