README

Table Rate Shipping Plugin

This plugin allows to define shipping rates using weight tables.

Installation

Run composer require --no-scripts webgriffe/sylius-table-rate-shipping-plugin.

Add the plugin to the config/bundles.php file:

Webgriffe\SyliusTableRateShippingPlugin\WebgriffeSyliusTableRateShippingPlugin::class => ['all' => true],

Add the plugin's config to by creating the file config/packages/webgriffe_sylius_table_rate_shipping_plugin.yaml with the following content:
```
imports:
    - { resource: "@WebgriffeSyliusTableRateShippingPlugin/Resources/config/config.yml" }
```

Add the plugin's routing by creating the file config/routes/webgriffe_sylius_table_rate_shipping_plugin.yaml with the following content:

webgriffe_sylius_table_rate_shipping_plugin_shop:
  resource: "@WebgriffeSyliusTableRateShippingPlugin/Resources/config/shop_routing.yml"
  prefix: /{_locale}
  requirements:
    _locale: ^[A-Za-z]{2,4}(_([A-Za-z]{4}|[0-9]{3}))?(_([A-Za-z]{2}|[0-9]{3}))?$

webgriffe_sylius_table_rate_shipping_plugin_admin:
  resource: "@WebgriffeSyliusTableRateShippingPlugin/Resources/config/admin_routing.yml"
  prefix: /%sylius_admin.path_name%

Finish the installation by updating the database schema and installing assets:

bin/console cache:clear
bin/console doctrine:migrations:diff
bin/console doctrine:migrations:migrate
bin/console assets:install
bin/console sylius:theme:assets:install

Contributing

To contribute you need to:

Clone this repository into you development environment and go to the plugin's root directory,
Then, from the plugin's root directory, run the following commands:
```
composer install
```
Copy tests/TestApplication/.env in tests/TestApplication/.env.local and set configuration specific for your development environment.
Run docker (create a compose.override.yml if you need to customize services):
```
docker-compose up -d
```
Then, from the plugin's root directory, run the following commands:
```
composer test-app-init
```

Run your local server:

symfony server:ca:install
symfony server:start -d

Now at http://localhost:8080/ you have a full Sylius testing application which runs the plugin

Testing

After your changes you must ensure that the tests are still passing.

First setup your test database:

```bash
APP_ENV=test vendor/bin/console doctrine:database:create
APP_ENV=test vendor/bin/console doctrine:migrations:migrate -n
# Optionally load data fixtures
APP_ENV=test vendor/bin/console sylius:fixtures:load -n
```

This plugin's test application already comes with a test configuration that uses SQLite as test database. If you don't want this you can create a tests/TestApplication/.env.test.local with a different DATABASE_URL.

The current CI suite runs the following tests:

Easy Coding Standard
```
vendor/bin/ecs check src/ tests/Behat/
```

PHPStan

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

PHPUnit
```
vendor/bin/phpunit
```
PHPSpec
```
vendor/bin/phpspec run
```
Behat (without Javascript)
```
vendor/bin/behat --tags="~@javascript"
```
Behat (only Javascript)
```
vendor/bin/behat --tags="@javascript"
```

To run them all with a single command run:

composer suite

To run Behat's Javascript scenarios you need to setup Selenium and Chromedriver. Do the following:

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

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/TestApplication/public --daemon

License

This library is under the MIT license. See the complete license in the LICENSE file.

Credits

Developed by Webgriffe®.

webgriffe / sylius-table-rate-shipping-plugin

Maintainers

Details