Merge pull request #34 from SpacePossum/2_0_update_cs

Update CS
GeckoPackages · Jun 20, 2017 · 5b9e962 · 5b9e962
2 parents c565b8e + da71f90
commit 5b9e962
Show file tree

Hide file tree

Showing 13 changed files with 100 additions and 71 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -2,7 +2,7 @@
 .editorconfig export-ignore
 .gitattributes export-ignore
 .gitignore export-ignore
-.php_cs export-ignore
+.php_cs.dist export-ignore
 .travis.yml export-ignore
 phpunit.xml.dist export-ignore
 *       text=auto eol=lf

diff --git a/.php_cs b/.php_cs
diff --git a/.php_cs.dist b/.php_cs.dist
@@ -0,0 +1,62 @@
+<?php
+
+/*
+ * This file is part of the GeckoPackages.
+ *
+ * (c) GeckoPackages https://github.com/GeckoPackages
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+$header = <<<'EOF'
+This file is part of the GeckoPackages.
+
+(c) GeckoPackages https://github.com/GeckoPackages
+
+This source file is subject to the MIT license that is bundled
+with this source code in the file LICENSE.
+EOF;
+
+return (new PhpCsFixer\Config('GeckoPackagesCS'))
+    ->setRiskyAllowed(true)
+    ->setRules([
+        '@Symfony' => true,
+        '@Symfony:risky' => true,
+        'array_syntax' => ['syntax' => 'long'],
+        'class_definition' => ['singleItemSingleLine' => true, 'multiLineExtendsEachSingleLine' => true],
+        'combine_consecutive_unsets' => true,
+        'dir_constant' => true,
+        'ereg_to_preg' => true,
+        'header_comment' => ['header' => $header],
+        'heredoc_to_nowdoc' => true,
+        'modernize_types_casting' => true,
+        'no_extra_consecutive_blank_lines' => ['break', 'continue', 'curly_brace_block', 'extra', 'parenthesis_brace_block', 'return', 'square_brace_block', 'throw', 'use', 'useTrait'],
+        'no_multiline_whitespace_before_semicolons' => false,
+        'no_php4_constructor' => true,
+        'no_short_echo_tag' => true,
+        'no_unreachable_default_argument_value' => true,
+        'no_useless_else' => true,
+        'no_useless_return' => true,
+        'ordered_class_elements' => false,
+        'ordered_imports' => true,
+        'php_unit_fqcn_annotation' => false,
+        'php_unit_strict' => true,
+        'phpdoc_add_missing_param_annotation' => ['only_untyped' => false],
+        'phpdoc_order' => true,
+        'pow_to_exponentiation' => true,
+        'protected_to_private' => true,
+        'random_api_migration' => true,
+        'semicolon_after_instruction' => true,
+        'strict_comparison' => true,
+        'strict_param' => true,
+        'ternary_to_null_coalescing' => true,
+        // remove import from set
+        'phpdoc_summary' => false,
+    ])
+    ->setFinder(
+        PhpCsFixer\Finder::create()
+            ->in(__DIR__.'/src/')
+            ->in(__DIR__.'/tests/')
+            ->name('*.php')
+    );
diff --git a/.travis.yml b/.travis.yml
@@ -9,38 +9,35 @@ matrix:
     fast_finish: true
     include:
         - php: 5.3
-          env: COMPOSER_FLAGS="--prefer-stable --prefer-lowest"
+          env: COMPOSER_FLAGS="--prefer-stable --prefer-lowest --optimize-autoloader"
         - php: 5.4
-          env: COMPOSER_FLAGS="--prefer-stable --prefer-lowest"
+          env: COMPOSER_FLAGS="--prefer-stable --prefer-lowest --optimize-autoloader"
         - php: 5.5
-          env: COMPOSER_FLAGS="--prefer-stable"
+          env: COMPOSER_FLAGS="--prefer-stable --optimize-autoloader"
         - php: 5.6
-          env: COMPOSER_FLAGS="--prefer-stable"
+          env: COMPOSER_FLAGS="--prefer-stable --optimize-autoloader"
         - php: 7.0
-          env: COMPOSER_FLAGS="--prefer-stable"
+          env: COMPOSER_FLAGS="--prefer-stable --optimize-autoloader"
         - php: 7.1
+          env: COMPOSER_FLAGS="--prefer-stable --optimize-autoloader"
+        - php: nightly
           env: COMPOSER_FLAGS="--dev"
-        - php: hhvm-3.9
-          sudo: required
-          dist: trusty
-          group: edge
-          env: COMPOSER_FLAGS="--prefer-stable"
         - php: hhvm-nightly
           sudo: required
           dist: trusty
           group: edge
-          env: COMPOSER_FLAGS="--dev"
+          env: COMPOSER_FLAGS="--dev --optimize-autoloader"
     allow_failures:
-        - php: 7.1
+        - php: nightly
         - php: hhvm-nightly
 
 install:
     - composer update $COMPOSER_FLAGS --no-interaction -v
-    - if [[ $TRAVIS_PHP_VERSION = 7.0 ]]; then curl -L https://github.com/FriendsOfPHP/PHP-CS-Fixer/releases/download/v1.13.1/php-cs-fixer.phar -o php-cs-fixer.phar; fi
+    - if [[ $TRAVIS_PHP_VERSION = 7.0 ]]; then curl -L https://github.com/FriendsOfPHP/PHP-CS-Fixer/releases/download/v2.3.2/php-cs-fixer.phar -o php-cs-fixer.phar; fi
 
 script:
     - chmod 755 tests/assets/dir
     - chmod 644 tests/assets/dir/test_file.txt
-    - if [[ $TRAVIS_PHP_VERSION = 5.3 ]]; then phpunit --verbose --testsuite "5.3.6"; else phpunit --verbose; fi
+    - if [[ $TRAVIS_PHP_VERSION = 5.3 ]]; then vendor/bin/phpunit --verbose --testsuite "5.3.6"; else vendor/bin/phpunit --verbose; fi
     - phpenv config-rm xdebug.ini || return 0
     - if [[ $TRAVIS_PHP_VERSION = 7.0 ]]; then php php-cs-fixer.phar --dry-run -vvv fix; fi
diff --git a/README.md b/README.md
@@ -300,6 +300,6 @@ Contributions are welcome!
 
 This project follows [Semantic Versioning](http://semver.org/).
 
-Kindly note:
-We do not keep a backwards compatible promise on the tests and tooling (such as document generation) of the project itself 
-nor the content and/or format of exception messages.
+<sub>Kindly note:
+We do not keep a backwards compatible promise on code annotated with `@internal`, the tests and tooling (such as document generation) of the project itself
+nor the content and/or format of exception/error messages.</sub>
diff --git a/composer.json b/composer.json
@@ -9,7 +9,7 @@
         "php": "^5.3.6 || ^7.0"
     },
     "require-dev": {
-        "phpunit/phpunit": "4.0"
+        "phpunit/phpunit": "^4.8.35 || ^5.4.3"
     },
     "autoload": {
         "psr-4": {

diff --git a/tests/PHPUnit/Tests/AbstractGeckoPHPUnitTest.php b/tests/PHPUnit/Tests/AbstractGeckoPHPUnitTest.php
@@ -14,7 +14,7 @@
  *
  * @author SpacePossum
  */
-abstract class AbstractGeckoPHPUnitTest extends \PHPUnit_Framework_TestCase
+abstract class AbstractGeckoPHPUnitTest extends GeckoTestCase
 {
     /**
      * @return string

diff --git a/tests/PHPUnit/Tests/Asserts/RangeAssertTraitTest.php b/tests/PHPUnit/Tests/Asserts/RangeAssertTraitTest.php
@@ -18,7 +18,7 @@
  *
  * @author SpacePossum
  */
-final class RangeAssertTraitTest extends \PHPUnit_Framework_TestCase
+final class RangeAssertTraitTest extends GeckoTestCase
 {
     use RangeAssertTrait;
 

diff --git a/tests/PHPUnit/Tests/Asserts/ScalarAssertTraitTest.php b/tests/PHPUnit/Tests/Asserts/ScalarAssertTraitTest.php
@@ -18,7 +18,7 @@
  *
  * @author SpacePossum
  */
-final class ScalarAssertTraitTest extends \PHPUnit_Framework_TestCase
+final class ScalarAssertTraitTest extends GeckoTestCase
 {
     use ScalarAssertTrait;
 

diff --git a/tests/PHPUnit/Tests/GeckoTestCase.php b/tests/PHPUnit/Tests/GeckoTestCase.php
@@ -0,0 +1,14 @@
+<?php
+
+/*
+ * This file is part of the GeckoPackages.
+ *
+ * (c) GeckoPackages https://github.com/GeckoPackages
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+abstract class GeckoTestCase extends \PHPUnit_Framework_TestCase
+{
+}
diff --git a/tests/PHPUnit/Tests/ReadMe/ReadMeGenerator.php b/tests/PHPUnit/Tests/ReadMe/ReadMeGenerator.php
@@ -190,9 +190,9 @@ public function testFilePermissionsOfThisFile()
 
 This project follows [Semantic Versioning](http://semver.org/).
 
-Kindly note:
-We do not keep a backwards compatible promise on the tests and tooling (such as document generation) of the project itself 
-nor the content and/or format of exception messages.
+<sub>Kindly note:
+We do not keep a backwards compatible promise on code annotated with `@internal`, the tests and tooling (such as document generation) of the project itself
+nor the content and/or format of exception/error messages.</sub>
 
 EOF;
         $readMeTemplate = str_replace('#GENERATED_LISTING#', $listing, $readMeTemplate);

diff --git a/tests/PHPUnit/Tests/ReadMe/ReadMeTest.php b/tests/PHPUnit/Tests/ReadMe/ReadMeTest.php
@@ -14,7 +14,7 @@
  *
  * @author SpacePossum
  */
-final class ReadMeTest extends \PHPUnit_Framework_TestCase
+final class ReadMeTest extends GeckoTestCase
 {
     public function generateReadMe()
     {

diff --git a/tests/autoload.php b/tests/autoload.php
@@ -16,5 +16,6 @@
 }
 
 require_once __DIR__.'/../vendor/autoload.php';
+require_once __DIR__.'/PHPUnit/Tests/GeckoTestCase.php';
 require_once __DIR__.'/PHPUnit/Tests/AbstractGeckoPHPUnitTest.php';
 require_once __DIR__.'/PHPUnit/Tests/AbstractGeckoPHPUnitFileTest.php';