Merge pull request #156 from koriym/cs

Apply new coding standard based on bear/cs
bearsunday · Oct 23, 2018 · 12ef4e7 · 12ef4e7
2 parents a7cf6e8 + 4971a7f
commit 12ef4e7
Show file tree

Hide file tree

Showing 144 changed files with 789 additions and 1,073 deletions.
diff --git a/.php_cs b/.php_cs
@@ -1,131 +1,184 @@
 <?php
 
-$header = <<<'EOF'
-This file is part of the BEAR.Resource package.
+/*
+ * PHP Coding Standards Fixer Config file for PHP7.0 and up
+ *
+ * @see https://github.com/FriendsOfPHP/PHP-CS-Fixer/blob/master/README.rst
+ */
 
-@license http://opensource.org/licenses/MIT MIT
+$header = <<<'EOF'
 EOF;
 
+$finder = PhpCsFixer\Finder::create()
+    ->exclude(['tests/Fake', 'tests/tmp', 'src-deprecated'])
+    ->in(__DIR__);
+
 return \PhpCsFixer\Config::create()
     ->setRiskyAllowed(true)
-    ->setRules(array(
+    ->setRules([
         '@PSR2' => true,
-        'header_comment' => ['header' => $header, 'commentType' => 'PHPDoc', 'separate' => 'none'],
+        '@PHP70Migration:risky' => true,
+        'align_multiline_comment' => true,
+        'array_indentation' => true,
         'array_syntax' => ['syntax' => 'short'],
-        'binary_operator_spaces' => ['align_equals' => false, 'align_double_arrow' => false],
-        'blank_line_after_opening_tag' => false,
-        'blank_line_after_namespace' => false,
+        'backtick_to_shell_exec' => true,
+        'binary_operator_spaces' => true, // @Symfony
+        'blank_line_after_opening_tag' => true, // @Symfony
         'blank_line_before_return' => true,
-        'cast_spaces' => true,
+        'blank_line_before_statement' => ['statements' => ['break', 'continue', 'declare', 'return', 'throw']], // @Symfony
+        'cast_spaces' => true, // @Symfony
+        'class_attributes_separation' => ['elements' => ['const', 'method']], // @Symfony
 //      'class_keyword_remove' => true,
+        'combine_consecutive_issets' => true,
         'combine_consecutive_unsets' => true,
-        'concat_space' => ['spacing' => 'one'],
-        'declare_equal_normalize' => true,
-        'declare_strict_types' => false,
-        'dir_constant' => true,
-        'ereg_to_preg' => true,
-        'function_typehint_space' => true,
-        'general_phpdoc_annotation_remove' => true,
-        'hash_to_slash_comment' => true,
+//      'comment_to_phpdoc' => true,
+        'compact_nullable_typehint' => true,
+        'concat_space' => ['spacing' => 'one'], // @Symfony
+//      'date_time_immutable' => true,
+        'declare_equal_normalize' => true, // @Symfony
+        'dir_constant' => true, // @Symfony:risky
+        'ereg_to_preg' => true, // @Symfony:risky
+        'error_suppression' => true, // @Symfony:risky
+        'escape_implicit_backslashes' => true,
+        'explicit_indirect_variable' => true,
+        'explicit_string_variable' => true,
+//      'final_internal_class' => true,
+        'fully_qualified_strict_types' => true,
+        'function_to_constant' => true, // @Symfony:risky
+        'function_typehint_space' => true, // @Symfony
+        'general_phpdoc_annotation_remove' => ['author', 'category', 'package', 'copyright', 'version'],
+        'header_comment' => ['header' => ''],
         'heredoc_to_nowdoc' => true,
-        'include' => true,
+        'include' => true, // @Symfony
+//      'increment_style' => 'pre', // @Symfony
         'indentation_type' => true,
-        'is_null' => ['use_yoda_style' => false],
-        'linebreak_after_opening_tag' => false,
-        'lowercase_cast' => true,
+        'is_null' => ['use_yoda_style' => false], // @Symfony:risky
+        'linebreak_after_opening_tag' => true,
+//      'list_syntax' => true,
+//      'logical_operators' => true,
+        'lowercase_cast' => true, // @Symfony
+        'lowercase_static_reference' => true, // @Symfony
+        'magic_constant_casing' => true,
 //      'mb_str_functions' => true,
+        'method_chaining_indentation' => true,
         'method_separation' => true,
-        'modernize_types_casting' => true,
-        'native_function_casing' => true,
+        'modernize_types_casting' => true, // @Symfony:risky
+        'multiline_comment_opening_closing' => true,
+        'multiline_whitespace_before_semicolons' => true,
+//      'native_constant_invocation' => true,
+        'native_function_casing' => true, // @Symfony
 //      'native_function_invocation' => true,
-        'new_with_braces' => false, //
-        'no_alias_functions' => true,
-        'no_blank_lines_after_class_opening' => true,
-        'no_blank_lines_after_phpdoc' => true,
-        'no_blank_lines_before_namespace' => true,
-        'no_empty_comment' => true,
-        'no_empty_phpdoc' => true,
-        'no_empty_statement' => true,
-        'no_extra_consecutive_blank_lines' => ['break', 'continue', 'curly_brace_block', 'extra', 'parenthesis_brace_block', 'return', 'square_brace_block', 'throw', 'use', 'useTrait'],
-        'no_leading_import_slash' => true,
-        'no_leading_namespace_whitespace' => true,
-        'no_mixed_echo_print' => ['use' => 'echo'],
-        'no_multiline_whitespace_around_double_arrow' => true,
-        'no_multiline_whitespace_before_semicolons' => true,
-        'no_php4_constructor' => false,
-        'no_short_bool_cast' => true,
+//      'new_with_braces' => true, // @Symfony
+        'no_alias_functions' => true, // @Symfony:risky
+        'no_alternative_syntax' => true,
+        'no_binary_string' => true,
+        'no_blank_lines_after_class_opening' => true, // @Symfony
+        'no_blank_lines_after_phpdoc' => true, // @Symfony
+//      'no_blank_lines_before_namespace' => true,
+        'no_empty_comment' => true, // @Symfony
+        'no_empty_phpdoc' => true, // @Symfony
+        'no_empty_statement' => true, // @Symfony
+        'no_extra_blank_lines' => true,
+        'no_homoglyph_names' => true, // @Symfony:risky
+        'no_leading_import_slash' => true, // @Symfony
+        'no_leading_namespace_whitespace' => true, // @Symfony
+        'no_mixed_echo_print' => true, // @Symfony
+        'no_multiline_whitespace_around_double_arrow' => true, // @Symfony
+        'no_null_property_initialization' => true,
+        'no_php4_constructor' => true,
+        'no_short_bool_cast' => true, // @Symfony
         'no_short_echo_tag' => false,
-        'no_singleline_whitespace_before_semicolons' => true,
-        'no_spaces_around_offset' => true,
-        'no_trailing_comma_in_list_call' => true,
-        'no_trailing_comma_in_singleline_array' => true,
+        'no_singleline_whitespace_before_semicolons' => true, // @Symfony
+        'no_spaces_around_offset' => true, // @Symfony
+        'no_superfluous_elseif' => true,
+        'no_superfluous_phpdoc_tags' => true,
+        'no_trailing_comma_in_list_call' => true, // @Symfony
+        'no_trailing_comma_in_singleline_array' => true, // @Symfony
         'no_trailing_whitespace' => true,
         'no_trailing_whitespace_in_comment' => true,
-        'no_unneeded_control_parentheses' => true,
+        'no_unneeded_control_parentheses' => true, // @Symfony
+        'no_unneeded_curly_braces' => true, // @Symfony
+        'no_unneeded_final_method' => true, // @Symfony
         'no_unreachable_default_argument_value' => true,
+        'no_unset_on_property' => 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,
+        'no_whitespace_before_comma_in_array' => true, // @Symfony
+        'no_whitespace_in_blank_line' => true, // @Symfony
+        'non_printable_character' => true, // @Symfony
+        'normalize_index_brace' => true, // @Symfony
         'not_operator_with_space' => false,
         'not_operator_with_successor_space' => true,
-        'object_operator_without_whitespace' => true,
+        'object_operator_without_whitespace' => true, // @Symfony
         'ordered_class_elements' => true,
         'ordered_imports' => true,
-        'php_unit_construct' => true,
+        'php_unit_construct' => true, // @Symfony:risky
         'php_unit_dedicate_assert' => true,
-        'php_unit_fqcn_annotation' => true,
+        'php_unit_expectation' => true,
+        'php_unit_fqcn_annotation' => true, // @Symfony
+//      'php_unit_internal_class' => true, // @Symfony]
+//      'php_unit_mock' => true,
+        'php_unit_namespaced' => true,
+        'php_unit_no_expectation_annotation' => true,
+        'php_unit_ordered_covers' => true,
+        'php_unit_set_up_tear_down_visibility' => true,
         'php_unit_strict' => true,
-        'phpdoc_add_missing_param_annotation' => true,
-        'phpdoc_align' => true,
-        'phpdoc_annotation_without_dot' => true,
-        'phpdoc_indent' => true,
-        'phpdoc_inline_tag' => true,
-        'phpdoc_no_access' => true,
-        'phpdoc_no_alias_tag' => ['property-read' => 'property', 'property-write' => 'property', 'type' => 'var'],
-        'phpdoc_no_empty_return' => true,
-        'phpdoc_no_package' => true,
-        'phpdoc_no_useless_inheritdoc' => true,
+//      'php_unit_test_annotation' => true,
+//      'php_unit_test_case_static_method_calls' => true,
+//      'php_unit_test_class_requires_covers' => true,
+//      'phpdoc_add_missing_param_annotation' => true,
+        'phpdoc_align' => true, // @Symfony]
+        'phpdoc_annotation_without_dot' => true, // @Symfony]
+        'phpdoc_indent' => true, // @Symfony]
+        'phpdoc_inline_tag' => true, // @Symfony]
+        'phpdoc_no_access' => true, // @Symfony]
+        'phpdoc_no_alias_tag' => true, // @Symfony
+        'phpdoc_no_empty_return' => true, // @Symfony
+        'phpdoc_no_package' => true, // @Symfony
+//      'phpdoc_no_useless_inheritdoc' => true, // @Symfony
         'phpdoc_order' => true,
-        'phpdoc_return_self_reference' => true,
-        'phpdoc_scalar' => true,
-        'phpdoc_separation' => true,
-        'phpdoc_single_line_var_spacing' => true,
-//      'phpdoc_summary' => true,
-        'phpdoc_to_comment' => true,
-        'phpdoc_trim' => true,
-        'phpdoc_types' => true,
-        'phpdoc_var_without_name' => true,
-        'pow_to_exponentiation' => true,
-//      'pre_increment' => true,
+        'phpdoc_return_self_reference' => true, // @Symfony
+        'phpdoc_scalar' => true, // @Symfony
+        'phpdoc_separation' => true, // @Symfony
+        'phpdoc_single_line_var_spacing' => true, // @Symfony
+//      'phpdoc_summary' => true, // @Symfony
+        'phpdoc_to_comment' => true, // @Symfony
+        'phpdoc_trim' => true, // @Symfony
+        'phpdoc_trim_consecutive_blank_line_separation' => true,
+        'phpdoc_types' => true, // @Symfony
+        'phpdoc_types_order' => true, // @Symfony
+        'phpdoc_var_without_name' => true, // @Symfony
         'protected_to_private' => true,
         'psr0' => true,
-        'psr4' => true,
-        'random_api_migration' => true,
+        'psr4' => true, // @Symfony:risky
+        'return_assignment' => true,
         'return_type_declaration' =>  ['space_before' => 'one'],
-        'self_accessor' => true,
-        'short_scalar_cast' => true,
-        'silenced_deprecation_error' => true,
-//      'simplified_null_return' => true,
-//      'single_blank_line_before_namespace' => true,
-        'single_quote' => true,
-        'space_after_semicolon' => true,
-        'standardize_not_equals' => true,
+        'self_accessor' => true, // @Symfony:risky
+        'semicolon_after_instruction' => true, // @Symfony
+        'set_type_to_cast' => true, // @Symfony:risky
+        'short_scalar_cast' => true, // @Symfony:risky
+        'simplified_null_return' => true,
+        'single_blank_line_before_namespace' => true, // @Symfony
+//      'single_line_comment_style' => true, // @Symfony
+        'single_line_after_imports' => true,
+        'single_quote' => true, // @Symfony
+        'space_after_semicolon' => true, // @Symfony
+        'standardize_increment' => true, // @Symfony
+        'standardize_not_equals' => true, // @Symfony
+//      'static_lambda' => true,
 //      'strict_comparison' => true,
-        'ternary_operator_spaces' => true,
         'strict_param' => true,
-        'ternary_to_null_coalescing' => true,
-//      'trailing_comma_in_multiline_array' => true,
-        'trim_array_spaces' => true,
-        'unary_operator_spaces' => true,
-        'whitespace_after_comma_in_array' => true
-    ))
-    ->setFinder(
-        PhpCsFixer\Finder::create()
-            ->exclude('demo/tmp')
-            ->exclude('tests/tmp')
-            ->exclude('src-deprecated')
-            ->in(__DIR__)
-    )->setLineEnding("\n");
+//      'string_line_ending' => true,
+        'switch_case_semicolon_to_colon' => true,
+        'switch_case_space' => true,
+        'ternary_operator_spaces' => true,
+//      'trailing_comma_in_multiline_array' => true, // @Symfony
+        'trim_array_spaces' => true, // @Symfony
+        'unary_operator_spaces' => true, // @Symfony
+        'visibility_required' => true,
+//      'void_return' => true, // @PHP71Migration:risky
+        'whitespace_after_comma_in_array' => true, // @Symfony
+//      'yoda_style' => true // @Symfony
+    ])
+    ->setFinder($finder);
diff --git a/composer.json b/composer.json
@@ -25,7 +25,8 @@
         "phpdocumentor/reflection-docblock": "^3.1|^4.0",
         "koriym/http-constants": "^1.0",
         "ray/web-param-module": "^2.0",
-        "justinrainbow/json-schema": "^5.2"
+        "justinrainbow/json-schema": "^5.2",
+        "bear/cs": "^1.0"
     },
     "require-dev": {
         "phpunit/phpunit": "^6.2"

diff --git a/demo/1.basic.php b/demo/1.basic.php
@@ -1,10 +1,7 @@
 <?php
+
 declare(strict_types=1);
-/**
- * This file is part of the BEAR.Resource package.
- *
- * @license http://opensource.org/licenses/MIT MIT
- */
+
 namespace MyVendor\Demo\Resource\App;
 
 use BEAR\Resource\Module\ResourceModule;

diff --git a/demo/2.link-self.php b/demo/2.link-self.php
@@ -1,9 +1,7 @@
-<?php declare(strict_types=1);
-/**
- * This file is part of the BEAR.Resource package.
- *
- * @license http://opensource.org/licenses/MIT MIT
- */
+<?php
+
+declare(strict_types=1);
+
 namespace MyVendor\Demo\Resource\App;
 
 use BEAR\Resource\Annotation\Link;

diff --git a/demo/3.link-crawl.php b/demo/3.link-crawl.php
@@ -1,9 +1,7 @@
-<?php declare(strict_types=1);
-/**
- * This file is part of the BEAR.Resource package.
- *
- * @license http://opensource.org/licenses/MIT MIT
- */
+<?php
+
+declare(strict_types=1);
+
 namespace MyVendor\Demo\Resource\App {
     require dirname(__DIR__) . '/vendor/autoload.php';
 
@@ -197,6 +195,7 @@ public function onGet(string $post_id) : ResourceObject
         }
     }
 }
+
 namespace MyVendor\Demo\Resource\App\Tag {
     use BEAR\Resource\ResourceObject;
     use MyVendor\Demo\Resource\App\SelectTrait;
@@ -228,6 +227,7 @@ public function onGet(string $tag_id) : ResourceObject
         }
     }
 }
+
 namespace Main {
     use BEAR\Resource\Module\HalModule;
     use BEAR\Resource\Module\ResourceModule;

diff --git a/demo/4.restbucks.php b/demo/4.restbucks.php
@@ -1,10 +1,9 @@
-<?php declare(strict_types=1);
-/**
- * This file is part of the BEAR.Resource package.
- *
- * @license http://opensource.org/licenses/MIT MIT
- */
+<?php
+
+declare(strict_types=1);
+
 namespace MyVendor\Demo\Resource\App;
+
 /*
  * This file is part of the BEAR.Resource package.
  *
@@ -24,9 +23,6 @@ class Menu extends ResourceObject
 {
     private $menu = [];
 
-    /**
-     * @param resource $resource
-     */
     public function __construct()
     {
         $this->menu = ['coffee' => 300, 'latte' => 400];
@@ -75,7 +71,7 @@ public function onPost(string $drink) : ResourceObject
             'order_id' => $orderId
         ];
         $this->code = 201; // created
-        $this->headers['Location'] = "/order/?id=$orderId"; // hyper link
+        $this->headers['Location'] = "/order/?id=${orderId}"; // hyper link
 
         return $this;
     }
@@ -113,7 +109,7 @@ public function onPut(
 
 // payment done, enjoy coffee !
 $code = new Code;
-echo "$ro->code: " . $code->statusText[$ro->code] . PHP_EOL;
+echo "{$ro->code}: " . $code->statusText[$ro->code] . PHP_EOL;
 echo 'Location: ' . $ro->headers['Location'] . PHP_EOL;
 echo 'Order: ' . (($ro->code === 201) ? 'Success' : 'Failure') . PHP_EOL;