Merge pull request #619 from nicolasmure/fix/apply-cs-fix-on-1.x

merge master on 1.x and apply cs fix on 1.x

.editorconfig

@@ -13,3 +13,6 @@ trim_trailing_whitespace = false
 
 [*.yml]
 indent_size = 2
+
+[Makefile]
+indent_style = tab

.env.dist

@@ -2,6 +2,16 @@ AWS_KEY=
 AWS_SECRET=
 AWS_BUCKET=
 
+AZURE_ACCOUNT=
+AZURE_KEY=
+AZURE_CONTAINER=
+
+FTP_HOST=ftp
+FTP_PORT=21
+FTP_USER=gaufrette
+FTP_PASSWORD=gaufrette
+FTP_BASE_DIR=/gaufrette
+
 # see /doc/adapters/google-cloud-storage.md
 GCS_PROJECT_ID=
 GCS_BUCKET_NAME=
@@ -28,13 +38,3 @@ SFTP_PORT=22
 SFTP_USER=gaufrette
 SFTP_PASSWORD=gaufrette
 SFTP_BASE_DIR=gaufrette
-
-FTP_HOST=ftp
-FTP_PORT=21
-FTP_USER=gaufrette
-FTP_PASSWORD=gaufrette
-FTP_BASE_DIR=/gaufrette
-
-AZURE_ACCOUNT=
-AZURE_KEY=
-AZURE_CONTAINER=

.gitignore

@@ -1,11 +1,12 @@
 bin/*
 !bin/tests
 !bin/tests-all
+composer.lock
 doc/.couscous
-tests/adapters/*
-!tests/adapters/*.dist
-vendor/
 .env
-composer.lock
+.php_cs.cache
 phpunit.xml
 secrets/
+tests/adapters/*
+!tests/adapters/*.dist
+vendor/

.php_cs.dist

@@ -0,0 +1,41 @@
+<?php
+
+return PhpCsFixer\Config::create()
+    ->setFinder(PhpCsFixer\Finder::create()
+        ->exclude('vendor')
+        ->in(__DIR__)
+    )
+    ->setRules([
+        '@PSR1' => true,
+        '@PSR2' => true,
+        'array_syntax' => [ 'syntax' => 'short' ],
+        'binary_operator_spaces' => [ 'align_equals' => false, 'align_double_arrow' => false ],
+        'blank_line_before_statement' => true,
+        'cast_spaces' => true,
+        'combine_consecutive_unsets' => true,
+        'concat_space' => [ 'spacing' => 'one' ],
+        'linebreak_after_opening_tag' => true,
+        'method_argument_space' => ['ensure_fully_multiline' => false],
+        'no_blank_lines_after_class_opening' => true,
+        'no_blank_lines_after_phpdoc' => true,
+        'no_break_comment' => false,
+        'no_extra_consecutive_blank_lines' => true,
+        'no_spaces_around_offset' => true,
+        'no_trailing_comma_in_singleline_array' => true,
+        'no_unused_imports' => true,
+        'no_useless_else' => true,
+        'no_useless_return' => true,
+        'no_whitespace_before_comma_in_array' => true,
+        'no_whitespace_in_blank_line' => true,
+        'normalize_index_brace' => true,
+        'PedroTroller/phpspec' => true,
+        'phpdoc_indent' => true,
+        'phpdoc_to_comment' => true,
+        'phpdoc_trim' => true,
+        'single_quote' => true,
+        'ternary_to_null_coalescing' => true,
+        'trailing_comma_in_multiline_array' => true,
+        'trim_array_spaces' => true,
+    ])
+    ->registerCustomFixers(new PedroTroller\CS\Fixer\Fixers())
+;

.travis.yml

@@ -41,5 +41,6 @@ install:
   - composer update --prefer-dist --no-progress --no-suggest --ansi
 
 script:
+  - php vendor/bin/php-cs-fixer fix --diff --dry-run --show-progress=none --verbose
   - php vendor/bin/phpspec run -fpretty --verbose
   - find tests/ -name "*Test.php" | vendor/bin/fastest -vvv "vendor/bin/phpunit --verbose {};"

Makefile

@@ -19,3 +19,15 @@ tests:
 .PHONY: clear-deps
 clear-deps:
 	rm -rf vendor/ composer.lock
+
+.PHONY: php-cs-compare
+php-cs-compare:
+	docker/run-task php${PHP_VERSION} vendor/bin/php-cs-fixer fix \
+		--diff \
+		--dry-run \
+		--show-progress=none \
+		--verbose
+
+.PHONY: php-cs-fix
+php-cs-fix:
+	docker/run-task php${PHP_VERSION} vendor/bin/php-cs-fixer fix

README.md

@@ -105,6 +105,17 @@ $ make clear-deps
 $ PHP_VERSION=<the_version_you_want_to_use> make build install-deps
 ```
 
+5) Apply Coding Standards
+
+You should check for CS violations by using
+```bash
+$ make php-cs-compare
+```
+and fix them with 
+```bash
+$ make php-cs-fix
+```
+
 ### Note
 
 This project does not have any stable release yet but we do not want to break BC now.

composer.json

@@ -37,7 +37,8 @@
         "akeneo/phpspec-skip-example-extension": "^4.0",
         "liuggio/fastest": "^1.6",
         "google/cloud-storage": "~1.0",
-        "php-opencloud/openstack": "~3.0.0"
+        "php-opencloud/openstack": "~3.0.0",
+        "pedrotroller/php-cs-custom-fixer": "^2.17"
     },
     "suggest": {
         "knplabs/knp-gaufrette-bundle": "to use with Symfony",

phpunit.xml.dist

@@ -10,34 +10,7 @@
          stopOnFailure="false"
          bootstrap="vendor/autoload.php"
 >
-
-    <php>
-        <!-- Parameters for GridFS adapter -->
-        <!--<env name="MONGO_URI" value="mongodb://localhost:27017" />
-        <env name="MONGO_DBNAME" value="gridfs_test" />-->
-
-        <!-- Configuration for AwsS3 adapter -->
-        <!--<env name="AWS_KEY" value="" />
-        <env name="AWS_SECRET" value="" />
-        <env name="AWS_BUCKET" value="" />-->
-
-        <!-- Configuration for PhpseclibSftp adapter -->
-        <!--<env name="SFTP_HOST" value="" />
-        <env name="SFTP_PORT" value="" />
-        <env name="SFTP_USER" value="" />
-        <env name="SFTP_PASSWORD" value="" />-->
-
-        <!-- Configuration for Ftp adapter -->
-        <!--<env name="FTP_HOST" value="" />
-        <env name="FTP_USER" value="" />
-        <env name="FTP_PASSWORD" value="" />
-        <env name="FTP_BASE_DIR" value="" />-->
-
-        <!-- Configuration for Azure adapter -->
-        <!--<env name="AZURE_ACCOUNT" value="" />
-        <env name="AZURE_KEY" value="" />
-        <env name="AZURE_CONTAINER" value="" />-->
-    </php>
+    <!-- The env vars are defined in the .env file -->
 
     <testsuites>
         <testsuite name="Gaufrette Test Suite">

spec/Gaufrette/Adapter/AzureBlobStorage/BlobProxyFactory.php

@@ -2,19 +2,19 @@
 
 namespace spec\Gaufrette\Adapter\AzureBlobStorage;
 
-use PHPSpec2\ObjectBehavior;
+use PhpSpec\ObjectBehavior;
 
 class BlobProxyFactory extends ObjectBehavior
 {
     /**
      * @param string $connectionString
      */
-    public function let($connectionString)
+    function let($connectionString)
     {
         $this->beConstructedWith($connectionString);
     }
 
-    public function it_should_be_initializable()
+    function it_should_be_initializable()
     {
         $this->shouldHaveType('Gaufrette\Adapter\AzureBlobStorage\BlobProxyFactory');
         $this->shouldHaveType('Gaufrette\Adapter\AzureBlobStorage\BlobProxyFactoryInterface');