webgriffe/sylius-elasticsearch-plugin

Plugin allowing to search products in Sylius.

v0.1.3 2024-08-19 10:13 UTC

Requires

• php: ^8.2
• elasticsearch/elasticsearch: ^7.17
• sylius/sylius: ^1.12 || ^1.13
• symfony/webpack-encore-bundle: ^1.15

Requires (Dev)

• behat/behat: ^3.6.1
• behat/mink-selenium2-driver: ^1.4
• dbrekelmans/bdi: ^1.1
• dmore/behat-chrome-extension: ^1.3
• dmore/chrome-mink-driver: ^2.7
• friends-of-behat/mink: ^1.8
• friends-of-behat/mink-browserkit-driver: ^1.4
• friends-of-behat/mink-debug-extension: ^2.0.0
• friends-of-behat/mink-extension: ^2.4
• friends-of-behat/page-object-extension: ^0.3
• friends-of-behat/suite-settings-extension: ^1.0
• friends-of-behat/symfony-extension: ^2.1
• friends-of-behat/variadic-extension: ^1.3
• phpspec/phpspec: ^7.2
• phpstan/extension-installer: ^1.0
• phpstan/phpstan: ^1.8.1
• phpstan/phpstan-doctrine: 1.3.69
• phpstan/phpstan-strict-rules: ^1.3.0
• phpstan/phpstan-webmozart-assert: ^1.2.0
• phpunit/phpunit: ^10.5
• polishsymfonycommunity/symfony-mocker-container: ^1.0
• robertfausk/behat-panther-extension: ^1.1
• sylius-labs/coding-standard: ^4.2
• sylius-labs/suite-tags-extension: ^0.2
• symfony/browser-kit: ^6.4
• symfony/debug-bundle: ^6.4
• symfony/dotenv: ^6.4
• symfony/flex: ^2.4
• symfony/intl: ^6.4
• symfony/web-profiler-bundle: ^6.4
• vimeo/psalm: ^5.9

proprietary

• elasticsearch
• sylius
• sylius-plugin

README

Sylius Elasticsearch Plugin

Sylius plugin for Elasticsearch query engine.

Installation

1. Run:

   composer require webgriffe/sylius-elasticsearch-plugin

2. Add Webgriffe\SyliusElasticsearchPlugin\WebgriffeSyliusElasticsearchPlugin::class => ['all' => true] to your config/bundles.php.

   Normally, the plugin is automatically added to the config/bundles.php file by the composer require command. If it is not, you have to add it manually.

3. Import the plugin configs. Add the following to your config/packages/webgriffe_sylius_elasticsearch_plugin.yaml file:

   imports:
       - { resource: "@WebgriffeSyliusElasticsearchPlugin/config/config.php" }

4. Import the routes needed for cancelling the payments. Add the following to your config/routes.yaml file:

   webgriffe_sylius_elasticsearch_plugin:
       resource: "@WebgriffeSyliusElasticsearchPlugin/config/shop_routing.php"

   NB: if you have locales prefix enabled you should prefix import with that.

5. Make your ProductRepository implements the DocumentTypeRepositoryInterface. Remember to update your product resource configuration to use the new repository. For example:

   sylius_product:
       resources:
           product:
               classes:
                   repository: App\Doctrine\ORM\ProductRepository

6. Make your ProductAttribute and ProductOption entities implements the FilterableInterface. You can implement it by using our ready DoctrineORMFilterableTrait. For example:

   use Webgriffe\SyliusElasticsearchPlugin\Doctrine\ORM\FilterableTrait;use Webgriffe\SyliusElasticsearchPlugin\Model\FilterableInterface;
   
   class ProductAttribute implements FilterableInterface
   {
       use FilterableTrait;
   }

Usage

Contributing

For a comprehensive guide on Sylius Plugins development please go to Sylius documentation, there you will find the Plugin Development Guide, that is full of examples.

Quickstart Installation

Traditional

1. Run composer create-project sylius/plugin-skeleton ProjectName.

2. From the plugin skeleton root directory, run the following commands:

   $ (cd tests/Application && yarn install)
   $ (cd tests/Application && yarn build)
   $ (cd tests/Application && APP_ENV=test bin/console assets:install public)
   
   $ (cd tests/Application && APP_ENV=test bin/console doctrine:database:create)
   $ (cd tests/Application && APP_ENV=test bin/console doctrine:schema:create)

To be able to set up a plugin's database, remember to configure you database credentials in tests/Application/.env and tests/Application/.env.test.

Docker

1. Execute docker compose up -d

2. Initialize plugin docker compose exec app make init

3. See your browser open localhost

Usage

Running plugin tests

• PHPUnit

  vendor/bin/phpunit

• PHPSpec

  vendor/bin/phpspec run

• Behat (non-JS scenarios)

  vendor/bin/behat --strict --tags="~@javascript"

• Behat (JS scenarios)

  1. Install Symfony CLI command.

  2. Start Headless Chrome:

  google-chrome-stable --enable-automation --disable-background-networking --no-default-browser-check --no-first-run --disable-popup-blocking --disable-default-apps --allow-insecure-localhost --disable-translate --disable-extensions --no-sandbox --enable-features=Metal --headless --remote-debugging-port=9222 --window-size=2880,1800 --proxy-server='direct://' --proxy-bypass-list='*' http://127.0.0.1

  1. Install SSL certificates (only once needed) and run test application's webserver on 127.0.0.1:8080:

  symfony server:ca:install
  APP_ENV=test symfony server:start --port=8080 --dir=tests/Application/public --daemon

  1. Run Behat:

  vendor/bin/behat --strict --tags="@javascript"

• Static Analysis

  • Psalm

    vendor/bin/psalm

  • PHPStan

    vendor/bin/phpstan analyse -c phpstan.neon -l max src/  

• Coding Standard

  vendor/bin/ecs check

Opening Sylius with your plugin

• Using test environment:

  (cd tests/Application && APP_ENV=test bin/console sylius:fixtures:load)
  (cd tests/Application && APP_ENV=test bin/console server:run -d public)

• Using dev environment:

  (cd tests/Application && APP_ENV=dev bin/console sylius:fixtures:load)
  (cd tests/Application && APP_ENV=dev bin/console server:run -d public)