Merge pull request #94 from alexislefebvre/add-Makefile

alexisLefebvre · web-flow · commit 0a21bf63e68e · 2020-07-11T18:00:54.000+02:00
Add Makefile
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -7,17 +7,17 @@ jobs:
     steps:
       - checkout
       - run: echo 'memory_limit = -1' | sudo tee -a /usr/local/etc/php/conf.d/docker-php-memlimit.ini
-      - run: composer require symfony/config:^4.4 symfony/form:^4.4 symfony/framework-bundle:^4.4 symfony/templating:^4.4 symfony/security-csrf:^4.4 symfony/var-dumper:^4.4 --no-update
+      - run: SYMFONY_VERSION="^4.4" make composer-require-symfony-version
       - restore_cache:
           keys:
           - composer-v1-{{ .Branch }}
           # fallback to using the latest cache if no exact match is found
           - composer-v1-
-      - run: composer install --no-interaction --profile --no-progress
-      - run: php ./vendor/bin/phpspec run --format=pretty
+      - run: make composer-install
+      - run: make phpspec
       - run: mkdir -p ~/phpunit
       - run: php ./vendor/bin/phpunit --log-junit ~/phpunit/junit.xml tests
-      - run: php ./vendor/bin/behat --colors --strict --format=progress -vv
+      - run: make behat
       - store_test_results:
           path: ~/phpunit
       - store_artifacts:
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -37,10 +37,7 @@ jobs:
           restore-keys: ${{ runner.os }}-composer-
 
       - name: Install Composer dependencies
-        run: composer install --no-progress --prefer-dist --optimize-autoloader --no-progress --no-suggest
+        run: make composer-install
 
-      - name: Run a multi-line script
-        run: |
-          php ./vendor/bin/phpspec run --format=pretty
-          php ./vendor/bin/phpunit $PHPUNIT_FLAGS
-          php ./vendor/bin/behat --colors --strict --format=progress -vv
+      - name: Run tests
+        run: make tests
diff --git a/.scrutinizer.yml b/.scrutinizer.yml
@@ -12,22 +12,22 @@ filter:
 build:
   environment:
     php:
-      version: 7.1
+      version: 7.2
   dependencies:
     override:
       -
-        command: 'composer require symfony/config:^4.4 symfony/form:^4.4 symfony/framework-bundle:^4.4 symfony/templating:^4.4 symfony/security-csrf:^4.4 symfony/var-dumper:^4.4 --no-update'
+        command: 'SYMFONY_VERSION="^4.4" make composer-require-symfony-version'
       -
-        command: 'composer install --no-interaction -vv --profile --no-progress'
+        command: 'make composer-install'
         idle_timeout: 900
   tests:
     override:
       -
-        command: './vendor/bin/phpspec run --format=pretty'
+        command: 'make phpspec'
       -
         command: './vendor/bin/phpunit --coverage-clover=coverage-clover'
         coverage:
           file: 'coverage-clover'
           format: 'php-clover'
       -
-        command: './vendor/bin/behat --colors --strict --format=progress -vv'
+        command: 'make behat'
diff --git a/.travis.yml b/.travis.yml
@@ -26,53 +26,74 @@ jobs:
     - stage: analysis
       name: "php-cs-fixer"
       before_install:
-        - docker pull jakzal/phpqa:1.25-php7.2-alpine
+        - make pull-docker-image
       script:
-        - docker run --volume $PWD:/app --workdir /app jakzal/phpqa:1.25-php7.2-alpine php-cs-fixer fix src/ --dry-run
+        - make php-cs-fixer
     - name: "phpstan"
       before_install:
+        - make pull-docker-image
         - echo "memory_limit = -1" >> ~/.phpenv/versions/$(phpenv version-name)/etc/conf.d/travis.ini
       install:
-        - composer install --no-interaction --profile --no-progress
+        - make composer-install
       script:
-        - docker run --volume $PWD:/app --workdir /app jakzal/phpqa:1.25-php7.2-alpine phpstan analyse --level 6 src/ --no-progress
+        - make phpstan
 
     - stage: test
       name: "PHP 7.2 / Symfony 3.4"
       php: 7.2
       env:
-        - SYMFONY_VERSION="3.4.*"
+        - SYMFONY_VERSION="^3.4"
       before_install:
         - phpenv config-rm xdebug.ini
         - echo "memory_limit = -1" >> ~/.phpenv/versions/$(phpenv version-name)/etc/conf.d/travis.ini
 
       install:
-        - composer require symfony/config:${SYMFONY_VERSION} symfony/form:${SYMFONY_VERSION} symfony/framework-bundle:${SYMFONY_VERSION} symfony/templating:${SYMFONY_VERSION} symfony/security-csrf:${SYMFONY_VERSION} symfony/var-dumper:${SYMFONY_VERSION} --no-update
-        - composer install --no-interaction --profile --no-progress
+        - make composer-require-symfony-version
+        - make composer-install
 
       script:
-        - php ./vendor/bin/phpspec run --format=pretty
-        - php ./vendor/bin/phpunit $PHPUNIT_FLAGS
-        - php ./vendor/bin/behat --colors --strict --format=progress -vv
+        - make tests
+
     - name: "PHP 7.3 / Symfony 4.4 / Code coverage"
       php: 7.3
       env:
-        - SYMFONY_VERSION="4.4.*"
+        - SYMFONY_VERSION="^4.4"
       # Only send code coverage to Code Climate for the current versions of PHP and Symfony LTS
       # https://github.com/doctrine/doctrine2/blob/3570f4a49afc7e98fed71e0596dded6a39d4fd7b/.travis.yml#L16
       before_install:
         - echo "memory_limit = -1" >> ~/.phpenv/versions/$(phpenv version-name)/etc/conf.d/travis.ini
         - DEPENDENCY="codeclimate/php-test-reporter:~0.3 satooshi/php-coveralls:~1.0"
 
       install:
-        - composer require symfony/config:${SYMFONY_VERSION} symfony/form:${SYMFONY_VERSION} symfony/framework-bundle:${SYMFONY_VERSION} symfony/templating:${SYMFONY_VERSION} symfony/security-csrf:${SYMFONY_VERSION} symfony/var-dumper:${SYMFONY_VERSION} $DEPENDENCY --no-update
-        - composer install --no-interaction --profile --no-progress
+        - make composer-require-symfony-version
+        - make composer-install
 
       script:
-        - php ./vendor/bin/phpspec run --format=pretty
+        - make phpspec
         - php ./vendor/bin/phpunit --coverage-clover ./build/logs/clover.xml
-        - php ./vendor/bin/behat --colors --strict --format=progress -vv
+        - make behat
 
       after_success:
         - php ./vendor/bin/test-reporter
         - travis_retry php vendor/bin/coveralls -v --config .coveralls.yml
+
+    - name: "PHP 7.4 / Symfony 5.1"
+      php: 7.4
+      env:
+        - SYMFONY_VERSION="^5.1"
+      before_install:
+        - phpenv config-rm xdebug.ini
+        - echo "memory_limit = -1" >> ~/.phpenv/versions/$(phpenv version-name)/etc/conf.d/travis.ini
+
+      install:
+        - make composer-require-symfony-version
+        - make composer-install
+
+      script:
+        - make phpspec
+        - php ./vendor/bin/phpunit --coverage-clover ./build/logs/clover.xml
+        - make behat
+
+    allow_failures:
+      - php: 7.4
+        env: SYMFONY_VERSION=^5.1
diff --git a/Makefile b/Makefile
@@ -0,0 +1,53 @@
+PHP = php
+
+DOCKER_RUN = docker run --volume $(PWD):/app --workdir /app jakzal/phpqa:1.25-php7.2-alpine
+
+##
+## Dependencies
+## -----
+##
+
+composer-require-symfony-version: ## Require specific version of Symfony
+	composer require symfony/config:$(SYMFONY_VERSION) symfony/form:$(SYMFONY_VERSION) symfony/framework-bundle:$(SYMFONY_VERSION) symfony/templating:$(SYMFONY_VERSION) symfony/security-csrf:$(SYMFONY_VERSION) symfony/var-dumper:$(SYMFONY_VERSION) --no-update
+
+composer-install: ## Install Composer dependencies
+	composer install --no-progress --prefer-dist --optimize-autoloader --no-progress --no-suggest
+
+pull-docker-image: ## Pull Docker image for QA
+	docker pull jakzal/phpqa:1.25-php7.2-alpine
+
+##
+## Tests
+## -----
+##
+
+phpspec: ## phpspec
+	$(PHP) ./vendor/bin/phpspec run --format=pretty
+
+phpunit: ## PHPUnit
+	$(PHP) ./vendor/bin/phpunit
+
+behat: ## Behat
+	$(PHP) ./vendor/bin/behat --colors --strict --format=progress -vv
+
+tests: phpspec phpunit behat ## Run all tests
+
+##
+## QA
+## --
+##
+
+php-cs-fixer: ## PHP-CS-Fixer
+	$(DOCKER_RUN) php-cs-fixer fix src/ --dry-run
+
+phpstan: ## PHPStan
+	$(DOCKER_RUN) phpstan analyse --level 6 src/ --no-progress
+
+qa: php-cs-fixer phpstan ## Run all QA tasks
+
+.PHONY: php-cs-fixer phpstan
+
+.DEFAULT_GOAL := help
+help:
+	@grep -E '(^[a-zA-Z_-]+:.*?##.*$$)|(^##)' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[32m%-30s\033[0m %s\n", $$1, $$2}' | sed -e 's/\[32m##/[33m/'
+.PHONY: help
diff --git a/README.md b/README.md
@@ -90,10 +90,13 @@ This bundle is also used to test several CI (Continuous Integration) services.
  - [abraham/twitteroauth][twitteroauth] (^0.6.0)
  - [twitter/bootstrap][Twitter Bootstrap] (use [Bootswatch 3.3.2][Bootstrap CDN])
 
-
 ### Tests:
 
-    php vendor/bin/phpunit 
+    make tests
+
+### Quality Assurance:
+
+    make qa
 
 [Packagist]: https://packagist.org/packages/alexislefebvre/async-tweets-bundle
 [Packagist Stable Image]: https://poser.pugx.org/alexislefebvre/async-tweets-bundle/v/stable.svg
diff --git a/composer.json b/composer.json
@@ -3,24 +3,24 @@
     "type" : "symfony-bundle",
     "description" : "Symfony bundle providing a Twitter reader for asynchronous reading",
     "keywords" : ["symfony", "twitter", "reader", "bundle"],
-    "homepage": "https://asynctweets.alexislefebvre.com/",
+    "homepage": "http://asynctweets.alexislefebvre.com/",
     "license" : "MIT",
     "authors" : [{
         "name" : "Alexis Lefebvre",
         "email" : "alexislefebvre@gmail.com",
-        "homepage": "https://alexislefebvre.com/",
+        "homepage": "http://alexislefebvre.com/",
         "role": "Developer"
     }],
     "require" : {
         "php": ">=7.2",
         "ext-mbstring": "*",
-        "symfony/config": "^3.4|^4.2",
-        "symfony/form": "^3.4|^4.2",
-        "symfony/framework-bundle": "^3.4|^4.2",
-        "symfony/security-csrf": "^3.4|^4.2",
-        "symfony/templating": "^3.4|^4.2",
-        "symfony/twig-bundle": "^3.4|^4.2",
-        "symfony/var-dumper": "^3.4|^4.2",
+        "symfony/config": "^3.4|^4.4",
+        "symfony/form": "^3.4|^4.4",
+        "symfony/framework-bundle": "^3.4|^4.4",
+        "symfony/security-csrf": "^3.4|^4.4",
+        "symfony/templating": "^3.4|^4.4",
+        "symfony/twig-bundle": "^3.4|^4.4",
+        "symfony/var-dumper": "^3.4|^4.4",
         "doctrine/orm": "^2.4.8",
         "abraham/twitteroauth": "~0.6"
     },

Original file line number	Diff line number	Diff line change
`@@ -12,22 +12,22 @@ filter:`
`12`	`12`	`build:`
`13`	`13`	`environment:`
`14`	`14`	`php:`
`15`		`- version: 7.1`
	`15`	`+ version: 7.2`
`16`	`16`	`dependencies:`
`17`	`17`	`override:`
`18`	`18`	`-`
`19`		`- command: 'composer require symfony/config:^4.4 symfony/form:^4.4 symfony/framework-bundle:^4.4 symfony/templating:^4.4 symfony/security-csrf:^4.4 symfony/var-dumper:^4.4 --no-update'`
	`19`	`+ command: 'SYMFONY_VERSION="^4.4" make composer-require-symfony-version'`
`20`	`20`	`-`
`21`		`- command: 'composer install --no-interaction -vv --profile --no-progress'`
	`21`	`+ command: 'make composer-install'`
`22`	`22`	`idle_timeout: 900`
`23`	`23`	`tests:`
`24`	`24`	`override:`
`25`	`25`	`-`
`26`		`- command: './vendor/bin/phpspec run --format=pretty'`
	`26`	`+ command: 'make phpspec'`
`27`	`27`	`-`
`28`	`28`	`command: './vendor/bin/phpunit --coverage-clover=coverage-clover'`
`29`	`29`	`coverage:`
`30`	`30`	`file: 'coverage-clover'`
`31`	`31`	`format: 'php-clover'`
`32`	`32`	`-`
`33`		`- command: './vendor/bin/behat --colors --strict --format=progress -vv'`
	`33`	`+ command: 'make behat'`