Makefile

COMPOSER            = composer
MKDOCS              = mkdocs
PHP                 = php
PHP_CS_FIXER        = tools/php-cs-fixer/vendor/bin/php-cs-fixer
PHPUNIT             = tools/phpunit/vendor/bin/phpunit
PSALM               = tools/psalm/vendor/bin/psalm
CHURN               = tools/churn/vendor/bin/churn
PSALM_BASELINE_FILE = psalm-baseline.xml
BARD                = src/SonsOfPHP/Bard/bin/bard

COVERAGE_DIR = docs/coverage

XDEBUG_MODE ?= off
PHPUNIT_TESTSUITE ?= all
PHPUNIT_OPTIONS ?=

.DEFAULT_GOAL = help
.PHONY        = help

##
## ███████╗ ██████╗ ███╗   ██╗███████╗     ██████╗ ███████╗    ██████╗ ██╗  ██╗██████╗
## ██╔════╝██╔═══██╗████╗  ██║██╔════╝    ██╔═══██╗██╔════╝    ██╔══██╗██║  ██║██╔══██╗
## ███████╗██║   ██║██╔██╗ ██║███████╗    ██║   ██║█████╗      ██████╔╝███████║██████╔╝
## ╚════██║██║   ██║██║╚██╗██║╚════██║    ██║   ██║██╔══╝      ██╔═══╝ ██╔══██║██╔═══╝
## ███████║╚██████╔╝██║ ╚████║███████║    ╚██████╔╝██║         ██║     ██║  ██║██║
## ╚══════╝ ╚═════╝ ╚═╝  ╚═══╝╚══════╝     ╚═════╝ ╚═╝         ╚═╝     ╚═╝  ╚═╝╚═╝
##

help:
	@grep -E '(^[a-zA-Z0-9_-]+:.*?##.*$$)|(^##)' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}{printf "\033[32m%-30s\033[0m %s\n", $$1, $$2}' | sed -e 's/\[32m##/[33m/'

install: composer-install tools-install ## Install Dependencies

upgrade: tools-upgrade

composer-install: composer.json # Install Dependencies via Composer
	XDEBUG_MODE=off $(COMPOSER) install --no-interaction --prefer-dist --optimize-autoloader
	XDEBUG_MODE=off $(COMPOSER) install --working-dir=src/SonsOfPHP/Bard --no-interaction --prefer-dist --optimize-autoloader

purge: # Purge vendor and lock files
	rm -rf vendor/ composer.lock
	rm -rf src/SonsOfPHP/Bard/vendor/ src/SonsOfPHP/Bard/composer.lock
	rm -rf src/SonsOfPHP/Bridge/*/vendor/ src/SonsOfPHP/Bridge/*/composer.lock
	rm -rf src/SonsOfPHP/Bundle/*/vendor/ src/SonsOfPHP/Bundle/*/composer.lock
	rm -rf src/SonsOfPHP/Component/*/vendor/ src/SonsOfPHP/Component/*/composer.lock
	rm -rf src/SonsOfPHP/Contract/*/vendor/ src/SonsOfPHP/Contract/*/composer.lock
	rm -rf src/tools/*/vendor/ src/tools/*/composer.lock

test: phpunit ## Run PHPUnit Tests

test-cache: PHPUNIT_TESTSUITE=cache
test-cache: phpunit

test-clock: PHPUNIT_TESTSUITE=clock
test-clock: phpunit

test-container: PHPUNIT_TESTSUITE=container
test-container: phpunit

test-cookie: PHPUNIT_TESTSUITE=cookie
test-cookie: phpunit

test-cqrs: PHPUNIT_TESTSUITE=cqrs
test-cqrs: phpunit

test-event-dispatcher: PHPUNIT_TESTSUITE=event-dispatcher
test-event-dispatcher: phpunit

test-http-factory: PHPUNIT_TESTSUITE=http-factory
test-http-factory: phpunit

test-http-handler: PHPUNIT_TESTSUITE=http-handler
test-http-handler: phpunit

test-link: PHPUNIT_TESTSUITE=link
test-link: phpunit

test-logger: PHPUNIT_TESTSUITE=logger
test-logger: phpunit

test-mailer: PHPUNIT_TESTSUITE=mailer
test-mailer: phpunit

test-money: PHPUNIT_TESTSUITE=money
test-money: phpunit

test-pager: PHPUNIT_TESTSUITE=pager
test-pager: phpunit

test-user-agent: PHPUNIT_TESTSUITE=user-agent
test-user-agent: phpunit

phpunit:
	XDEBUG_MODE=$(XDEBUG_MODE) \
	$(PHP) \
	-dxdebug.mode=$(XDEBUG_MODE) \
	-dapc.enable_cli=1 \
	$(PHPUNIT) \
	--cache-result \
	--order-by=defects \
	--testsuite=$(PHPUNIT_TESTSUITE) \
	$(PHPUNIT_OPTIONS)

phpunit-install:
	XDEBUG_MODE=off $(COMPOSER) install --working-dir=tools/phpunit --no-interaction --prefer-dist --optimize-autoloader

phpunit-upgrade:
	XDEBUG_MODE=off $(COMPOSER) upgrade --working-dir=tools/phpunit --no-interaction --prefer-dist --optimize-autoloader --with-all-dependencies

lint: lint-php ## Lint files

lint-php: # lint php files
	find src -name "*.php" -not -path "src/**/vendor/*" | xargs -I{} $(PHP) -l '{}'

coverage: XDEBUG_MODE=coverage
coverage: PHPUNIT_OPTIONS=--coverage-html $(COVERAGE_DIR)
coverage: phpunit ## Build Code Coverage Report

coverage-cache: PHPUNIT_TESTSUITE=cache
coverage-cache: coverage

coverage-clock: PHPUNIT_TESTSUITE=clock
coverage-clock: coverage

coverage-container: PHPUNIT_TESTSUITE=container
coverage-container: coverage

coverage-cookie: PHPUNIT_TESTSUITE=cookie
coverage-cookie: coverage

coverage-cqrs: PHPUNIT_TESTSUITE=cqrs
coverage-cqrs: coverage

coverage-event-dispatcher: PHPUNIT_TESTSUITE=event-dispatcher
coverage-event-dispatcher: coverage

coverage-event-sourcing:
	XDEBUG_MODE=coverage $(PHP) -dxdebug.mode=coverage $(PHPUNIT) --testsuite event-sourcing --coverage-html $(COVERAGE_DIR)

coverage-feature-toggle:
	XDEBUG_MODE=coverage $(PHP) -dxdebug.mode=coverage $(PHPUNIT) --testsuite feature-toggle --coverage-html $(COVERAGE_DIR)

coverage-filesystem:
	XDEBUG_MODE=coverage $(PHP) -dxdebug.mode=coverage $(PHPUNIT) --testsuite filesystem --coverage-html $(COVERAGE_DIR)

coverage-http-factory:
	XDEBUG_MODE=coverage $(PHP) -dxdebug.mode=coverage $(PHPUNIT) --testsuite http-factory --coverage-html $(COVERAGE_DIR)

coverage-http-handler: PHPUNIT_TESTSUITE=http-handler
coverage-http-handler: coverage

coverage-http-message:
	XDEBUG_MODE=coverage $(PHP) -dxdebug.mode=coverage $(PHPUNIT) --testsuite http-message --coverage-html $(COVERAGE_DIR)

coverage-json:
	XDEBUG_MODE=coverage $(PHP) -dxdebug.mode=coverage $(PHPUNIT) --testsuite json --coverage-html $(COVERAGE_DIR)

coverage-link: PHPUNIT_TESTSUITE=link
coverage-link: coverage

coverage-logger: PHPUNIT_TESTSUITE=logger
coverage-logger: coverage

coverage-mailer: PHPUNIT_TESTSUITE=mailer
coverage-mailer: coverage

coverage-money: PHPUNIT_TESTSUITE=money
coverage-money: coverage

coverage-pager: PHPUNIT_TESTSUITE=pager
coverage-pager: coverage

coverage-version:
	XDEBUG_MODE=coverage $(PHP) -dxdebug.mode=coverage $(PHPUNIT) --testsuite version --coverage-html $(COVERAGE_DIR)

psalm: ## Run psalm
	XDEBUG_MODE=off $(PHP) $(PSALM)

psalm-baseline: # Updates the baseline file
	XDEBUG_MODE=off $(PHP) -dxdebug.mode=off $(PSALM) --update-baseline --set-baseline=$(PSALM_BASELINE_FILE)

psalm-github: # used with GitHub
	XDEBUG_MODE=off $(PHP) -dxdebug.mode=off $(PSALM) --long-progress --monochrome --output-format=github --report=results.sarif

psalm-install:
	XDEBUG_MODE=off $(COMPOSER) install --working-dir=tools/psalm --no-interaction --prefer-dist --optimize-autoloader

psalm-upgrade:
	XDEBUG_MODE=off $(COMPOSER) upgrade --working-dir=tools/psalm --no-interaction --prefer-dist --optimize-autoloader --with-all-dependencies

php-cs-fixer: ## run php-cs-fixer
	XDEBUG_MODE=off $(PHP) -dxdebug.mode=off $(PHP_CS_FIXER) fix -vv --diff --allow-risky=yes --config=.php-cs-fixer.dist.php

php-cs-fixer-install:
	XDEBUG_MODE=off $(COMPOSER) install --working-dir=tools/php-cs-fixer --no-interaction --prefer-dist --optimize-autoloader

php-cs-fixer-upgrade:
	XDEBUG_MODE=off $(COMPOSER) upgrade --working-dir=tools/php-cs-fixer --no-interaction --prefer-dist --optimize-autoloader --with-all-dependencies

testdox: ## Run tests and output testdox
	XDEBUG_MODE=off $(PHP) -dxdebug.mode=off $(PHPUNIT) --testdox

infection:
	XDEBUG_MODE=develop \
	$(PHP) \
	-dxdebug.mode=develop \
	-dapc.enable_cli=1 \
	tools/infection/vendor/bin/infection --debug -vvv --show-mutations

churn: ## Run Churn PHP
	$(CHURN)

churn-install:
	$(COMPOSER) install --working-dir=tools/churn --no-interaction --prefer-dist --optimize-autoloader

churn-upgrade:
	$(COMPOSER) upgrade --working-dir=tools/churn --no-interaction --prefer-dist --optimize-autoloader --with-all-dependencies

tools-install: psalm-install php-cs-fixer-install phpunit-install churn-install

tools-upgrade: psalm-upgrade php-cs-fixer-upgrade phpunit-upgrade churn-upgrade

## Documentation
docs-install: ## Install deps for building docs
	pip install mkdocs
	pip install mkdocs-material

docs-upgrade: ## upgrade mkdocs
	pip install --upgrade mkdocs-material

docs-watch: ## Preview documentation locally
	$(MKDOCS) serve

docs-build: ## Build Site
	$(MKDOCS) build

## Package Management
packages-install: ## Runs `composer install` on each package
	$(BARD) install -n -vvv

packages-update: ## Runs `composer update` on each package
	$(BARD) update -n -vvv

packages-merge: ## Merges each package's composer.json into the root composer.json
	$(BARD) merge -n -vvv

packages-publish: ## Packages are published to their read-only repository
	$(BARD) publish -n -vvv

packages-release-patch: ## Release patch (0.0.x)
	$(BARD) release -n -vvv patch