From cb91b1ba8e2ecb4b6fbfb5e2f8c25f84ac8f2a09 Mon Sep 17 00:00:00 2001 From: Jakub Theimer Date: Sat, 20 Nov 2021 18:34:09 +0100 Subject: [PATCH 1/2] Update php cs fixer config --- .php-cs-fixer.dist | 164 +++++++++++++++++++++++++++++++++++---------- 1 file changed, 128 insertions(+), 36 deletions(-) diff --git a/.php-cs-fixer.dist b/.php-cs-fixer.dist index 82f33ae..fc619cb 100644 --- a/.php-cs-fixer.dist +++ b/.php-cs-fixer.dist @@ -1,43 +1,135 @@ notPath('bootstrap/*') - ->notPath('storage/*') - ->notPath('resources/view/mail/*') - ->in([ - __DIR__ . '/src', - __DIR__ . '/tests', - ]) +$rules = [ + '@PSR2' => true, + 'array_syntax' => ['syntax' => 'short'], + 'array_indentation' => true, + 'binary_operator_spaces' => [ + 'default' => 'single_space', + ], + 'blank_line_after_namespace' => true, + 'blank_line_after_opening_tag' => true, + 'blank_line_before_statement' => [ + 'statements' => ['break', 'continue', 'declare', 'return', 'throw', 'try'], + ], + 'braces' => true, + 'cast_spaces' => true, + 'class_definition' => true, + 'concat_space' => [ + 'spacing' => 'none', + ], + 'declare_equal_normalize' => true, + 'elseif' => true, + 'encoding' => true, + 'full_opening_tag' => true, + 'fully_qualified_strict_types' => true, // added by Shift + 'function_declaration' => true, + 'function_typehint_space' => true, + 'heredoc_to_nowdoc' => true, + 'include' => true, + 'increment_style' => ['style' => 'post'], + 'indentation_type' => true, + 'linebreak_after_opening_tag' => true, + 'line_ending' => true, + 'magic_constant_casing' => true, + 'method_argument_space' => true, + 'native_function_casing' => true, + 'no_alias_functions' => true, + 'no_extra_blank_lines' => [ + 'tokens' => [ + 'extra', + 'throw', + 'use', + 'use_trait', + ], + ], + 'no_blank_lines_after_class_opening' => true, + 'no_blank_lines_after_phpdoc' => true, + 'no_closing_tag' => true, + 'no_empty_phpdoc' => true, + 'no_empty_statement' => true, + 'no_leading_import_slash' => true, + 'no_leading_namespace_whitespace' => true, + 'no_mixed_echo_print' => [ + 'use' => 'echo', + ], + 'no_multiline_whitespace_around_double_arrow' => true, + 'multiline_whitespace_before_semicolons' => [ + 'strategy' => 'no_multi_line', + ], + 'no_short_bool_cast' => true, + 'no_singleline_whitespace_before_semicolons' => true, + 'no_spaces_after_function_name' => true, + 'no_spaces_around_offset' => true, + 'no_spaces_inside_parenthesis' => true, + 'no_trailing_comma_in_list_call' => true, + 'no_trailing_comma_in_singleline_array' => true, + 'no_trailing_whitespace' => true, + 'no_trailing_whitespace_in_comment' => true, + 'no_unneeded_control_parentheses' => true, + 'no_unreachable_default_argument_value' => true, + 'no_unused_imports' => true, + 'no_useless_return' => true, + 'no_whitespace_before_comma_in_array' => true, + 'no_whitespace_in_blank_line' => true, + 'normalize_index_brace' => true, + 'not_operator_with_successor_space' => true, + 'object_operator_without_whitespace' => true, + 'ordered_imports' => ['sort_algorithm' => 'alpha'], + 'phpdoc_indent' => true, + 'phpdoc_no_access' => true, + 'phpdoc_no_package' => true, + 'phpdoc_no_useless_inheritdoc' => true, + 'phpdoc_scalar' => true, + 'phpdoc_single_line_var_spacing' => true, + 'phpdoc_summary' => true, + 'phpdoc_trim' => true, + 'phpdoc_types' => true, + 'phpdoc_var_without_name' => true, + 'psr_autoloading' => true, + 'self_accessor' => true, + 'short_scalar_cast' => true, + 'simplified_null_return' => true, + 'single_blank_line_at_eof' => true, + 'single_blank_line_before_namespace' => true, + 'single_class_element_per_statement' => true, + 'single_import_per_statement' => true, + 'single_line_after_imports' => true, + 'single_line_comment_style' => [ + 'comment_types' => ['hash'], + ], + 'single_quote' => true, + 'single_trait_insert_per_statement' => true, + 'space_after_semicolon' => true, + 'standardize_not_equals' => true, + 'switch_case_semicolon_to_colon' => true, + 'switch_case_space' => true, + 'ternary_operator_spaces' => true, + 'trailing_comma_in_multiline' => true, + 'trim_array_spaces' => true, + 'unary_operator_spaces' => true, + 'visibility_required' => [ + 'elements' => ['method', 'property'], + ], + 'whitespace_after_comma_in_array' => true, +]; + +$finder = PhpCsFixer\Finder::create() + ->notPath('bootstrap') + ->notPath('storage') + ->notPath('vendor') + ->in(getcwd()) ->name('*.php') ->notName('*.blade.php') + ->notName('index.php') + ->notName('server.php') ->ignoreDotFiles(true) ->ignoreVCS(true); -return PhpCsFixer\Config::create() - ->setRules([ - '@PSR2' => true, - 'array_syntax' => ['syntax' => 'short'], - 'ordered_imports' => ['sortAlgorithm' => 'alpha'], - 'no_unused_imports' => true, - 'not_operator_with_successor_space' => true, - 'trailing_comma_in_multiline_array' => true, - 'phpdoc_scalar' => true, - 'unary_operator_spaces' => true, - 'binary_operator_spaces' => true, - 'blank_line_before_statement' => [ - 'statements' => ['break', 'continue', 'declare', 'return', 'throw', 'try'], - ], - 'phpdoc_single_line_var_spacing' => true, - 'phpdoc_var_without_name' => true, - 'class_attributes_separation' => [ - 'elements' => [ - 'method', - ], - ], - 'method_argument_space' => [ - 'on_multiline' => 'ensure_fully_multiline', - 'keep_multiple_spaces_after_comma' => true, - ], - 'single_trait_insert_per_statement' => true, - ]) - ->setFinder($finder); \ No newline at end of file +$config = new PhpCsFixer\Config(); + +return $config + ->setFinder($finder) + ->setRules($rules) + ->setRiskyAllowed(true) + ->setUsingCache(true); From 2152aa049ada3abf93c1f37a0a3e27f4fd6df340 Mon Sep 17 00:00:00 2001 From: theimerj Date: Sat, 20 Nov 2021 17:34:28 +0000 Subject: [PATCH 2/2] Fix styling --- .../Repositories/RepositoryInterface.php | 26 ++++++++--------- .../Madzipper/Repositories/ZipRepository.php | 28 +++++++++---------- tests/Repositories/ZipRepositoryTest.php | 2 +- 3 files changed, 28 insertions(+), 28 deletions(-) diff --git a/src/Madnest/Madzipper/Repositories/RepositoryInterface.php b/src/Madnest/Madzipper/Repositories/RepositoryInterface.php index ea959d8..30ae868 100644 --- a/src/Madnest/Madzipper/Repositories/RepositoryInterface.php +++ b/src/Madnest/Madzipper/Repositories/RepositoryInterface.php @@ -3,14 +3,14 @@ namespace Madnest\Madzipper\Repositories; /** - * RepositoryInterface that needs to be implemented by every Repository + * RepositoryInterface that needs to be implemented by every Repository. * * Class RepositoryInterface */ interface RepositoryInterface { /** - * Construct with a given path + * Construct with a given path. * * @param $filePath * @param bool $new @@ -19,7 +19,7 @@ interface RepositoryInterface public function __construct($filePath, $new = false, $archiveImplementation = null); /** - * Add a file to the opened Archive + * Add a file to the opened Archive. * * @param $pathToFile * @param $pathInArchive @@ -27,7 +27,7 @@ public function __construct($filePath, $new = false, $archiveImplementation = nu public function addFile($pathToFile, $pathInArchive); /** - * Add a file to the opened Archive using its contents + * Add a file to the opened Archive using its contents. * * @param $name * @param $content @@ -35,21 +35,21 @@ public function addFile($pathToFile, $pathInArchive); public function addFromString($name, $content); /** - * Add an empty directory + * Add an empty directory. * * @param $dirName */ public function addEmptyDir($dirName); /** - * Remove a file permanently from the Archive + * Remove a file permanently from the Archive. * * @param $pathInArchive */ public function removeFile($pathInArchive); /** - * Get the content of a file + * Get the content of a file. * * @param $pathInArchive * @@ -58,7 +58,7 @@ public function removeFile($pathInArchive); public function getFileContent($pathInArchive); /** - * Get the stream of a file + * Get the stream of a file. * * @param $pathInArchive * @@ -68,14 +68,14 @@ public function getFileStream($pathInArchive); /** * Will loop over every item in the archive and will execute the callback on them - * Will provide the filename for every item + * Will provide the filename for every item. * * @param $callback */ public function each($callback); /** - * Checks whether the file is in the archive + * Checks whether the file is in the archive. * * @param $fileInArchive * @@ -84,7 +84,7 @@ public function each($callback); public function fileExists($fileInArchive); /** - * Sets the password to be used for decompressing + * Sets the password to be used for decompressing. * * @param $password * @@ -93,14 +93,14 @@ public function fileExists($fileInArchive); public function usePassword($password); /** - * Returns the status of the archive as a string + * Returns the status of the archive as a string. * * @return string */ public function getStatus(); /** - * Closes the archive and saves it + * Closes the archive and saves it. */ public function close(); } diff --git a/src/Madnest/Madzipper/Repositories/ZipRepository.php b/src/Madnest/Madzipper/Repositories/ZipRepository.php index 55fc737..9a49b88 100644 --- a/src/Madnest/Madzipper/Repositories/ZipRepository.php +++ b/src/Madnest/Madzipper/Repositories/ZipRepository.php @@ -10,7 +10,7 @@ class ZipRepository implements RepositoryInterface private $archive; /** - * Construct with a given path + * Construct with a given path. * * @param $filePath * @param bool $create @@ -30,12 +30,12 @@ public function __construct($filePath, $create = false, $archive = null) $res = $this->archive->open($filePath, ($create ? ZipArchive::CREATE : null)); if ($res !== true) { - throw new Exception("Error: Failed to open $filePath! Error: " . $this->getErrorMessage($res)); + throw new Exception("Error: Failed to open $filePath! Error: ".$this->getErrorMessage($res)); } } /** - * Add a file to the opened Archive + * Add a file to the opened Archive. * * @param $pathToFile * @param $pathInArchive @@ -46,7 +46,7 @@ public function addFile($pathToFile, $pathInArchive) } /** - * Add an empty directory + * Add an empty directory. * * @param $dirName */ @@ -56,7 +56,7 @@ public function addEmptyDir($dirName) } /** - * Add a file to the opened Archive using its contents + * Add a file to the opened Archive using its contents. * * @param $name * @param $content @@ -67,7 +67,7 @@ public function addFromString($name, $content) } /** - * Remove a file permanently from the Archive + * Remove a file permanently from the Archive. * * @param $pathInArchive */ @@ -77,7 +77,7 @@ public function removeFile($pathInArchive) } /** - * Get the content of a file + * Get the content of a file. * * @param $pathInArchive * @@ -89,7 +89,7 @@ public function getFileContent($pathInArchive) } /** - * Get the stream of a file + * Get the stream of a file. * * @param $pathInArchive * @@ -102,13 +102,13 @@ public function getFileStream($pathInArchive) /** * Will loop over every item in the archive and will execute the callback on them - * Will provide the filename for every item + * Will provide the filename for every item. * * @param $callback */ public function each($callback) { - for ($i = 0; $i < $this->archive->numFiles; ++$i) { + for ($i = 0; $i < $this->archive->numFiles; $i++) { //skip if folder $stats = $this->archive->statIndex($i); if ($stats['size'] === 0 && $stats['crc'] === 0) { @@ -119,7 +119,7 @@ public function each($callback) } /** - * Checks whether the file is in the archive + * Checks whether the file is in the archive. * * @param $fileInArchive * @@ -132,7 +132,7 @@ public function fileExists($fileInArchive) /** * Sets the password to be used for decompressing - * function named usePassword for clarity + * function named usePassword for clarity. * * @param $password * @@ -144,7 +144,7 @@ public function usePassword($password) } /** - * Returns the status of the archive as a string + * Returns the status of the archive as a string. * * @return string */ @@ -154,7 +154,7 @@ public function getStatus() } /** - * Closes the archive and saves it + * Closes the archive and saves it. */ public function close() { diff --git a/tests/Repositories/ZipRepositoryTest.php b/tests/Repositories/ZipRepositoryTest.php index 2dc342d..a16084e 100644 --- a/tests/Repositories/ZipRepositoryTest.php +++ b/tests/Repositories/ZipRepositoryTest.php @@ -53,7 +53,7 @@ public function it_throws_an_exception_when_trying_to_open_something_else_than_a { $this->expectException(Exception::class); $this->expectExceptionMessageMatches('/Error: Failed to open (.*)ZipRepositoryTest.php! Error: ZipArchive::ER_NOZIP - Not a zip archive./'); - new ZipRepository(__DIR__ . DIRECTORY_SEPARATOR . 'ZipRepositoryTest.php', false); + new ZipRepository(__DIR__.DIRECTORY_SEPARATOR.'ZipRepositoryTest.php', false); } /**