chore: remove coke, use cs-fixer and add a makefile (#65)

* chore: remove coke, use cs-fixer and add a makefile * Apply suggestions from code review Co-Authored-By: Oliver THEBAULT <[email protected]> * chore: pr feedbacks * chore: update travis build * chore: fix composer.json after rebase * chore: use PHP71 config to be compatible with CI * chore: remove sf-security-checker in make ci * chore: remove test-dependecies target all together * chore: remove unused code in makefile & travis config
BedrockStreaming · Dec 18, 2019 · 1da320f · 1da320f
1 parent 8711bf2
commit 1da320f
Show file tree

Hide file tree

Showing 26 changed files with 182 additions and 210 deletions.
diff --git a/.coke b/.coke
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,6 @@
+## Why?
+<!-- Explain why you've done it like this -->
+
+## How?
+<!-- Explain how you've done it -->
+
diff --git a/.php_cs.dist b/.php_cs.dist
@@ -0,0 +1,11 @@
+<?php
+$config = new M6Web\CS\Config\Php71();
+$config
+    ->getFinder()
+    ->in(
+        [
+            __DIR__.'/src',
+        ]
+    );
+
+return $config;
diff --git a/.travis.yml b/.travis.yml
@@ -26,8 +26,6 @@ before_install:
 
 install:
   - composer update $COMPOSER_FLAGS --prefer-dist -n
-  - if [ "$COMPOSER_PREFER" = "lowest" ]; then composer update --prefer-lowest -n; fi;
 
 script:
-  - bin/coke
-  - bin/atoum
+  - make ci
diff --git a/Makefile b/Makefile
@@ -0,0 +1,62 @@
+SHELL=bash
+SOURCE_DIR = $(shell pwd)
+BIN_DIR = ${SOURCE_DIR}/bin
+COMPOSER = composer
+
+define printSection
+	@printf "\033[36m\n==================================================\n\033[0m"
+	@printf "\033[36m $1 \033[0m"
+	@printf "\033[36m\n==================================================\n\033[0m"
+endef
+
+.PHONY: all
+all: install quality test test-dependencies
+
+.PHONY: ci
+ci: quality test
+
+.PHONY: install
+install: clean-vendor composer-install
+
+.PHONY: quality
+quality: cs-ci
+
+.PHONY: test
+test: atoum
+
+# Coding Style
+
+.PHONY: cs
+cs:
+	${BIN_DIR}/php-cs-fixer fix --dry-run --stop-on-violation --diff
+
+.PHONY: cs-fix
+cs-fix:
+	${BIN_DIR}/php-cs-fixer fix
+
+.PHONY: cs-ci
+cs-ci:
+	${BIN_DIR}/php-cs-fixer fix --ansi --dry-run --using-cache=no --verbose
+
+#COMPOSER
+
+.PHONY: clean-vendor
+clean-vendor:
+	$(call printSection,CLEAN-VENDOR)
+	rm -rf ${SOURCE_DIR}/vendor
+
+.PHONY: composer-install
+composer-install: ${SOURCE_DIR}/vendor/composer/installed.json
+
+${SOURCE_DIR}/vendor/composer/installed.json:
+	$(call printSection,COMPOSER INSTALL)
+	$(COMPOSER) --no-interaction install --ansi --no-progress --prefer-dist
+
+# CI TOOLS
+
+# TEST
+.PHONY: atoum
+atoum:
+	$(call printSection,TEST atoum)
+	${BIN_DIR}/atoum
+
diff --git a/README.md b/README.md
@@ -271,7 +271,7 @@ First of all, thank you for contributing !
 
 Here are few rules to follow for a easier code review before the maintainers accept and merge your request.
 
-- you MUST follow the Symfony2 coding standard : you can use `./bin/coke` to validate
+- you MUST follow the Symfony2 coding standard : you can use `make cs-fix` to fix the files
 - you MUST run the test
 - you MUST write or update tests
 - you MUST write or update documentation
@@ -281,11 +281,11 @@ Here are few rules to follow for a easier code review before the maintainers acc
 Install the composer dev dependencies
 
 ```shell
-$ composer install --dev
+make install
 ```
 
 Then run the test with [atoum](https://github.com/atoum/atoum) unit test framework
 
 ```shell
-./bin/atoum
+make test
 ```
diff --git a/composer.json b/composer.json
@@ -24,8 +24,7 @@
   "require-dev": {
     "atoum/atoum": "~3.1",
     "atoum/stubs": "*",
-    "m6web/coke": "~2.2",
-    "m6web/symfony2-coding-standard": "~3.3"
+    "m6web/php-cs-fixer-config": "^1.0"
   },
   "autoload": {
     "psr-4": {"M6Web\\Bundle\\GuzzleHttpBundle\\": "src/"}

diff --git a/src/Cache/CacheInterface.php b/src/Cache/CacheInterface.php
@@ -1,4 +1,5 @@
 <?php
+
 namespace M6Web\Bundle\GuzzleHttpBundle\Cache;
 
 /**
@@ -11,7 +12,7 @@ interface CacheInterface
      *
      * @param string $key A unique key
      *
-     * @return Boolean Whether the cache has a value for this key
+     * @return bool Whether the cache has a value for this key
      */
     public function has($key);
 
@@ -27,9 +28,9 @@ public function get($key);
     /**
      * Sets a value in the cache.
      *
-     * @param string  $key   A unique key
-     * @param string  $value The value to cache
-     * @param integer $ttl   Time to live in seconds
+     * @param string $key   A unique key
+     * @param string $value The value to cache
+     * @param int    $ttl   Time to live in seconds
      */
     public function set($key, $value, $ttl = null);
 
@@ -45,7 +46,7 @@ public function remove($key);
      *
      * @param string $key The key
      *
-     * @return integer|false the ttl or false
+     * @return int|false the ttl or false
      */
     public function ttl($key);
 }
diff --git a/src/Cache/InMemory.php b/src/Cache/InMemory.php
@@ -1,4 +1,5 @@
 <?php
+
 namespace M6Web\Bundle\GuzzleHttpBundle\Cache;
 
 /**
@@ -7,10 +8,10 @@
 class InMemory implements CacheInterface
 {
     protected $cache = [];
-    protected $ttl   = [];
+    protected $ttl = [];
 
     /**
-     * {@inheritDoc}
+     * {@inheritdoc}
      */
     public function has($key)
     {
@@ -25,7 +26,7 @@ public function has($key)
     }
 
     /**
-     * {@inheritDoc}
+     * {@inheritdoc}
      */
     public function get($key)
     {
@@ -37,16 +38,16 @@ public function get($key)
     }
 
     /**
-     * {@inheritDoc}
+     * {@inheritdoc}
      */
     public function set($key, $value, $ttl = null)
     {
         $this->cache[$key] = $value;
-        $this->ttl[$key]   = is_null($ttl) ? null : microtime(true) + $ttl;
+        $this->ttl[$key] = is_null($ttl) ? null : microtime(true) + $ttl;
     }
 
     /**
-     * {@inheritDoc}
+     * {@inheritdoc}
      */
     public function remove($key)
     {
@@ -57,7 +58,7 @@ public function remove($key)
     }
 
     /**
-     * {@inheritDoc}
+     * {@inheritdoc}
      */
     public function ttl($key)
     {

diff --git a/src/DataCollector/GuzzleHttpDataCollector.php b/src/DataCollector/GuzzleHttpDataCollector.php
@@ -1,10 +1,11 @@
 <?php
+
 namespace M6Web\Bundle\GuzzleHttpBundle\DataCollector;
 
-use Symfony\Component\HttpKernel\DataCollector\DataCollector;
-use Symfony\Component\HttpFoundation\Response;
-use Symfony\Component\HttpFoundation\Request;
 use M6Web\Bundle\GuzzleHttpBundle\EventDispatcher\AbstractGuzzleHttpEvent;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\HttpKernel\DataCollector\DataCollector;
 
 /**
  * Collect information about guzzlehttp client
@@ -21,6 +22,7 @@ public function __construct()
 
     /**
      * Collect the data
+     *
      * @param Request    $request   The request object
      * @param Response   $response  The response object
      * @param \Exception $exception An exception
@@ -53,8 +55,6 @@ public function getName()
 
     /**
      * Collect data for GuzzleHttp
-     *
-     * @param AbstractGuzzleHttpEvent $event
      */
     public function onGuzzleHttpCommand(AbstractGuzzleHttpEvent $event)
     {
@@ -140,7 +140,7 @@ public function getAvgExecutionTime()
     {
         $totalExecutionTime = $this->getTotalExecutionTime();
 
-        return ($totalExecutionTime) ? ($totalExecutionTime / count($this->getCommands()) ) : 0;
+        return ($totalExecutionTime) ? ($totalExecutionTime / count($this->getCommands())) : 0;
     }
 
     /**
@@ -194,6 +194,6 @@ public function getAvgRedirectionTime()
     {
         $totalExecutionTime = $this->getTotalRedirectionTime();
 
-        return ($totalExecutionTime) ? ($totalExecutionTime / count($this->getRedirects()) ) : 0;
+        return ($totalExecutionTime) ? ($totalExecutionTime / count($this->getRedirects())) : 0;
     }
 }
diff --git a/src/DependencyInjection/Configuration.php b/src/DependencyInjection/Configuration.php
@@ -1,8 +1,9 @@
 <?php
+
 namespace M6Web\Bundle\GuzzleHttpBundle\DependencyInjection;
 
-use Symfony\Component\Config\Definition\ConfigurationInterface;
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;
+use Symfony\Component\Config\Definition\ConfigurationInterface;
 
 /**
  * This is the class that validates and merges configuration from your app/config files
@@ -13,7 +14,7 @@ class Configuration implements ConfigurationInterface
 {
     /**
      * http://symfony.com/fr/doc/current/components/config/definition.html
-     * {@inheritDoc}
+     * {@inheritdoc}
      */
     public function getConfigTreeBuilder()
     {
@@ -27,7 +28,7 @@ public function getConfigTreeBuilder()
                     ->useAttributeAsKey('id', false)
                     ->prototype('array')
                         ->children()
-                            ->scalarNode('base_uri')->defaultValue("")->end()
+                            ->scalarNode('base_uri')->defaultValue('')->end()
                             ->enumNode('redirect_handler')
                                 ->values(['curl', 'guzzle'])
                                 ->defaultValue('curl')
@@ -42,7 +43,7 @@ public function getConfigTreeBuilder()
                                     ->scalarNode('service')->cannotBeEmpty()->end()
                                 ->end()
                             ->end()
-                            ->scalarNode('proxy')->defaultValue("")->end()
+                            ->scalarNode('proxy')->defaultValue('')->end()
                             ->booleanNode('http_errors')->defaultValue(true)->end()
                             ->floatNode('timeout')->defaultValue(5.0)->end()
                             ->arrayNode('headers')