Update Makefile and some other files

Author: maximehuran

DEVELOPMENT.md

@@ -0,0 +1,15 @@
+## Node
+
+Be sure you have node 14 on your machine. You can use NVM to easily switch versions.
+
+# Docker
+
+Be sure you have docker on your machine.
+
+# Symfony
+
+Be sure you have the Symfony binary on your machine.
+
+```
+ curl -sS https://get.symfony.com/cli/installer | bash 
+ ```

LICENSE

@@ -0,0 +1,7 @@
+Copyright 2021 Monsieur Biz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

LICENSE.txt

@@ -1,29 +1,29 @@
 .DEFAULT_GOAL := help
 SHELL=/bin/bash
 APP_DIR=tests/Application
+SYLIUS_VERSION=1.10
 SYMFONY=cd ${APP_DIR} && symfony
 COMPOSER=symfony composer
 CONSOLE=${SYMFONY} console
 export COMPOSE_PROJECT_NAME=search
+PLUGIN_NAME=sylius-${COMPOSE_PROJECT_NAME}-plugin
 COMPOSE=docker-compose
 YARN=yarn
-PHPSTAN=symfony php vendor/bin/phpstan
-PHPUNIT=symfony php vendor/bin/phpunit
-PHPSPEC=symfony php vendor/bin/phpspec
 
 ###
 ### DEVELOPMENT
 ### ¯¯¯¯¯¯¯¯¯¯¯
 
-install: platform sylius ## Install the plugin
+install: application platform sylius es.reindex ## Install the plugin
 .PHONY: install
 
 up: docker.up server.start ## Up the project (start docker, start symfony server)
 stop: server.stop docker.stop ## Stop the project (stop docker, stop symfony server)
 down: server.stop docker.down ## Down the project (removes docker containers, stop symfony server)
 
 reset: docker.down ## Stop docker and remove dependencies
-	rm -rf ${APP_DIR}/{node_modules} ${APP_DIR}/yarn.lock
+	rm -rf ${APP_DIR}/node_modules ${APP_DIR}/yarn.lock
+	rm -rf ${APP_DIR}
 	rm -rf vendor composer.lock
 .PHONY: reset
 
@@ -32,7 +32,9 @@ dependencies: vendor node_modules ## Setup the dependencies
 
 .php-version: .php-version.dist
 	cp .php-version.dist .php-version
-	(cd ${APP_DIR} && ln -sf ../../.php-version)
+
+php.ini: php.ini.dist
+	cp php.ini.dist php.ini
 
 vendor: composer.lock ## Install the PHP dependencies using composer
 ifdef GITHUB_ACTIONS
@@ -51,6 +53,7 @@ endif
 yarn.install: ${APP_DIR}/yarn.lock
 
 ${APP_DIR}/yarn.lock:
+	ln -sf ${APP_DIR}/node_modules node_modules
 	cd ${APP_DIR} && ${YARN} install && ${YARN} build
 	${YARN} install
 	${YARN} encore prod
@@ -59,23 +62,61 @@ node_modules: ${APP_DIR}/node_modules ## Install the Node dependencies using yar
 
 ${APP_DIR}/node_modules: yarn.install
 
+###
+### TEST APPLICATION
+### ¯¯¯¯¯
+
+application: .php-version php.ini ${APP_DIR} setup_application ${APP_DIR}/docker-compose.yaml
+
+${APP_DIR}:
+	(${COMPOSER} create-project --prefer-dist --no-scripts --no-progress --no-install sylius/sylius-standard="${SYLIUS_VERSION}" ${APP_DIR})
+
+setup_application:
+	rm -f ${APP_DIR}/yarn.lock
+	(cd ${APP_DIR} && ${COMPOSER} config repositories.plugin '{"type": "path", "url": "../../"}')
+	(cd ${APP_DIR} && ${COMPOSER} config extra.symfony.allow-contrib true)
+	(cd ${APP_DIR} && ${COMPOSER} require --no-scripts --no-progress --no-install --no-update monsieurbiz/${PLUGIN_NAME}="*@dev")
+	$(MAKE) apply_dist
+	$(MAKE) ${APP_DIR}/.php-version
+	$(MAKE) ${APP_DIR}/php.ini
+	(cd ${APP_DIR} && ${COMPOSER} install)
+
+${APP_DIR}/docker-compose.yaml:
+	rm -f ${APP_DIR}/docker-compose.yml
+	rm -f ${APP_DIR}/docker-compose.yaml
+	cp docker-compose.yaml.dist ${APP_DIR}/docker-compose.yaml
+.PHONY: ${APP_DIR}/docker-compose.yaml
+
+${APP_DIR}/.php-version: .php-version
+	(cd ${APP_DIR} && ln -sf ../../.php-version)
+
+${APP_DIR}/php.ini: php.ini
+	(cd ${APP_DIR} && ln -sf ../../php.ini)
+
+apply_dist:
+	cp -Rv dist/* ${APP_DIR}
+	cp -Rv dist/.env.local ${APP_DIR}/.env.local
+
 ###
 ### TESTS
 ### ¯¯¯¯¯
 
-test.all: test.composer test.phpstan test.phpunit test.phpspec test.phpcs test.yaml test.schema test.twig ## Run all tests in once
+test.all: test.composer test.phpstan test.phpmd test.phpunit test.phpspec test.phpcs test.yaml test.schema test.twig test.container ## Run all tests in once
 
 test.composer: ## Validate composer.json
 	${COMPOSER} validate --strict
 
 test.phpstan: ## Run PHPStan
-	${PHPSTAN} analyse -c phpstan.neon src/
+	${COMPOSER} phpstan || true
+
+test.phpmd: ## Run PHPMD
+	${COMPOSER} phpmd || true
 
 test.phpunit: ## Run PHPUnit
-	${PHPUNIT}
+	${COMPOSER} phpunit
 
 test.phpspec: ## Run PHPSpec
-	${PHPSPEC} run
+	${COMPOSER} phpspec
 
 test.phpcs: ## Run PHP CS Fixer in dry-run
 	${COMPOSER} run -- phpcs --dry-run -v
@@ -87,7 +128,7 @@ test.container: ## Lint the symfony container
 	${CONSOLE} lint:container
 
 test.yaml: ## Lint the symfony Yaml files
-	${CONSOLE} lint:yaml ../../recipes ../../src/Resources/config --parse-tags
+	${CONSOLE} lint:yaml ../../recipes ../../src/Resources/config
 
 test.schema: ## Validate MySQL Schema
 	${CONSOLE} doctrine:schema:validate
@@ -115,12 +156,6 @@ sylius.assets: ## Install all assets with symlinks
 	${CONSOLE} sylius:install:assets
 	${CONSOLE} sylius:theme:assets:install --symlink
 
-###
-### JANE
-### ¯¯¯¯¯¯
-jane.generate: ## Generate Models classes with Jane
-	${COMPOSER} run -- jane-generate
-
 ###
 ### PLATFORM
 ### ¯¯¯¯¯¯¯¯
@@ -130,11 +165,6 @@ platform: .php-version up ## Setup the platform tools
 
 docker.pull: ## Pull the docker images
 	cd ${APP_DIR} && ${COMPOSE} pull
-.PHONY: docker.pull
-
-docker.build: ## Build (and pull) the docker images
-	cd ${APP_DIR} && ${COMPOSE} build --pull
-.PHONY: docker.build
 
 docker.up: ## Start the docker containers
 	cd ${APP_DIR} && ${COMPOSE} up -d
@@ -148,13 +178,19 @@ docker.down: ## Stop and remove the docker containers
 	cd ${APP_DIR} && ${COMPOSE} down
 .PHONY: docker.down
 
+docker.logs: ## Logs the docker containers
+	cd ${APP_DIR} && ${COMPOSE} logs -f
+.PHONY: docker.logs
+
 server.start: ## Run the local webserver using Symfony
-	${SYMFONY} local:proxy:domain:attach ${COMPOSE_PROJECT_NAME}
 	${SYMFONY} local:server:start -d
 
 server.stop: ## Stop the local webserver
 	${SYMFONY} local:server:stop
 
+es.reindex: ## Reindex elasticsearch
+	${CONSOLE} monsieurbiz:search:populate
+
 ###
 ### HELP
 ### ¯¯¯¯

Makefile

@@ -1,78 +1,58 @@
 # Testing
 
-Be sure you've run the `composer install` before reading this file.
-With Symfony binary, you should run `symfony composer install`
+## Requirements
 
-## Installation
+You'll need:
 
-1. To be able to run yarn build correctly, create symlink for `node_modules` :
+- PHP 7.4 minimum.
+- docker, for the database.
+- symfony CLI, to run the local server.
+- composer, to install PHP dependencies.
+- npm and yarn, to install ui dependencies and build the JS/CSS files.
 
-    ```bash
-    ln -s tests/Application/node_modules node_modules
-    ```
+## Installation
 
-2. From the plugin root directory, run the following commands:
+```bash
+make install
+```
 
-    ```bash
-    $ (cd tests/Application && yarn install)
-    $ (cd tests/Application && yarn build)
-    $ (cd tests/Application && bin/console assets:install public -e test)
-    $ (cd tests/Application && bin/console doctrine:database:drop --force -e test --if-exists)
-    $ (cd tests/Application && bin/console doctrine:database:create -e test)
-    $ (cd tests/Application && bin/console doctrine:schema:create -e test)
-    ```
-
-To be able to setup the plugin's database, remember to configure your database credentials in `tests/Application/.env` 
-and `tests/Application/.env.test`. You can also add custom configuration in `tests/Application/.env.test.local`.
+This will run a Sylius app (the one in `tests/Application/`) with the plugin
+installed and all Sylius' sample data. It uses the symfony binary.
 
 ## Usage
 
-### Running plugin tests
+### List all available commands
 
-  - PHPUnit
+```bash
+make help
+```
 
-    ```bash
-    $ vendor/bin/phpunit
-    ```
+### Running minimum plugin tests
 
-  - PHPSpec
+- PHPUnit
 
     ```bash
-    $ vendor/bin/phpspec run
+    make test.phpunit
     ```
-    
-  - PHPStan
-  
-    ```bash
-    $ vendor/bin/phpstan analyse src
-    ```
-
-### Opening Sylius with the plugin
-
-- Using `test` environment:
 
-    ```bash
-    $ (cd tests/Application && bin/console sylius:fixtures:load -e test)
-    $ (cd tests/Application && bin/console server:run -d public -e test)
-    ```
-    
-- Using `dev` environment:
+- PHP CS fixer
 
     ```bash
-    $ (cd tests/Application && bin/console sylius:fixtures:load -e 1.0-dev)
-    $ (cd tests/Application && bin/console server:run -d public -e 1.0-dev)
+    make test.phpcs
     ```
 
-### Reindex Elasticsearch
+    > Tip: You can fix your code with `make test.phpcs.fix`!
 
-- Using `test` environment:
+- PHPSpec
 
     ```bash
-    $ (cd tests/Application && bin/console monsieurbiz:search:populate -e test)
+    make test.phpspec
     ```
-    
-- Using `dev` environment:
+
+- PHPStan
 
     ```bash
-    $ (cd tests/Application && bin/console monsieurbiz:search:populate -e 1.0-dev)
+    make test.phpstan
     ```
+
+> Tip: You can run all tests with `make test.all`!

TESTING.md

@@ -0,0 +1,20 @@
+version: '3.8'
+services:
+    database:
+        image: mysql:8.0
+        ports:
+            - 3306
+        environment:
+          MYSQL_ALLOW_EMPTY_PASSWORD: 1
+          MYSQL_DATABASE: sylius
+        volumes:
+            - database:/var/lib/mysql
+
+    mailer:
+        image: monsieurbiz/mailcatcher
+        ports:
+            - 1025
+            - 1080
+
+volumes:
+    database: {}

docker-compose.yaml.dist

@@ -0,0 +1 @@
+memory_limit=-1

php.ini.dist

@@ -44,7 +44,7 @@
     <rule ref="rulesets/naming.xml/ShortClassName"/>
     <rule ref="rulesets/naming.xml/ShortVariable">
         <properties>
-            <property name="exceptions" value="id,qb"/>
+            <property name="exceptions" value="id,em,qb"/>
         </properties>
     </rule>
     <rule ref="rulesets/naming.xml/ShortMethodName"/>

phpmd.xml

@@ -2,3 +2,5 @@ suites:
     main:
         namespace: MonsieurBiz\SyliusSearchPlugin
         psr4_prefix: MonsieurBiz\SyliusSearchPlugin
+        src_path: src
+        spec_path: tests

phpspec.yml.dist

@@ -11,5 +11,4 @@ parameters:
         - 'src/DependencyInjection/MonsieurBizSyliusSearchExtension.php'
 
         # Test dependencies
-        - 'tests/Application/app/**.php'
-        - 'tests/Application/src/**.php'
+        - 'tests/Application/**/*'