Skip to content
This repository was archived by the owner on May 28, 2024. It is now read-only.

Commit 0459670

Browse files
troosantroosan
authored
Enable php-cs-fixer in build & fix resulting warnings (PHPOffice#1099)
* enable php 7.1 build * upgrade to dompdf/dompdf 0.8.* * update phpunit & hide output during tests * run code coverage analysis on 1 build only * Add php-cs * Update Copyright
1 parent 0beeb27 commit 0459670

File tree

392 files changed

+6645
-6949
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

392 files changed

+6645
-6949
lines changed

‎.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,4 @@ vendor
1919
phpword.ini
2020
/.buildpath
2121
/.project
22+
/.php_cs.cache

‎.php_cs.dist

+146
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,146 @@
1+
<?php
2+
3+
$finder = PhpCsFixer\Finder::create()
4+
->notName('pclzip.lib.php')
5+
->notName('OLERead.php')
6+
->in('samples')
7+
->in('src')
8+
->in('tests');
9+
10+
return PhpCsFixer\Config::create()
11+
->setRiskyAllowed(true)
12+
->setFinder($finder)
13+
->setRules(array(
14+
'array_syntax' => array('syntax' => 'long'),
15+
'binary_operator_spaces' => array('align_double_arrow' => true),
16+
'blank_line_after_namespace' => true,
17+
'blank_line_after_opening_tag' => false,
18+
'blank_line_before_return' => true,
19+
'braces' => true,
20+
'cast_spaces' => true,
21+
'class_definition' => true,
22+
'class_keyword_remove' => false, // ::class keyword gives us beter support in IDE
23+
'combine_consecutive_unsets' => true,
24+
'concat_space' => array('spacing' => 'one'),
25+
'declare_equal_normalize' => true,
26+
'declare_strict_types' => false, // Too early to adopt strict types
27+
'dir_constant' => true,
28+
'elseif' => true,
29+
'encoding' => true,
30+
'ereg_to_preg' => true,
31+
'full_opening_tag' => true,
32+
'function_declaration' => true,
33+
'function_typehint_space' => true,
34+
'general_phpdoc_annotation_remove' => false, // No use for that
35+
'hash_to_slash_comment' => true,
36+
'header_comment' => false, // We don't use common header in all our files
37+
'heredoc_to_nowdoc' => false, // Not sure about this one
38+
'is_null' => false, // Risky
39+
'include' => true,
40+
'indentation_type' => true,
41+
'line_ending' => true,
42+
'linebreak_after_opening_tag' => true,
43+
'lowercase_cast' => true,
44+
'lowercase_constants' => true,
45+
'lowercase_keywords' => true,
46+
'mb_str_functions' => false, // No, too dangerous to change that
47+
'method_argument_space' => true,
48+
'method_separation' => true,
49+
'modernize_types_casting' => true,
50+
'native_function_casing' => true,
51+
'native_function_invocation'=> false, // This is risky and seems to be micro-optimization that make code uglier so not worth it, at least for now
52+
'new_with_braces' => true,
53+
'no_alias_functions' => true,
54+
'no_blank_lines_after_class_opening' => true,
55+
'no_blank_lines_after_phpdoc' => true,
56+
'no_blank_lines_before_namespace' => false, // we want 1 blank line before namespace
57+
'no_closing_tag' => true,
58+
'no_empty_comment' => true,
59+
'no_empty_phpdoc' => true,
60+
'no_empty_statement' => true,
61+
'no_extra_consecutive_blank_lines' => array('break', 'continue', 'extra', 'return', 'throw', 'use', 'useTrait', 'curly_brace_block', 'parenthesis_brace_block', 'square_brace_block'),
62+
'no_leading_import_slash' => true,
63+
'no_leading_namespace_whitespace' => true,
64+
'no_mixed_echo_print' => true,
65+
'no_multiline_whitespace_around_double_arrow' => true,
66+
'no_multiline_whitespace_before_semicolons' => true,
67+
'no_php4_constructor' => true,
68+
'no_short_bool_cast' => true,
69+
'no_short_echo_tag' => true,
70+
'no_singleline_whitespace_before_semicolons' => true,
71+
'no_spaces_after_function_name' => true,
72+
'no_spaces_around_offset' => true,
73+
'no_spaces_inside_parenthesis' => true,
74+
'no_trailing_comma_in_list_call' => true,
75+
'no_trailing_comma_in_singleline_array' => true,
76+
'no_trailing_whitespace' => true,
77+
'no_trailing_whitespace_in_comment' => true,
78+
'no_unneeded_control_parentheses' => true,
79+
'no_unreachable_default_argument_value' => true,
80+
'no_unused_imports' => true,
81+
'no_useless_else' => true,
82+
'no_useless_return' => true,
83+
'no_whitespace_before_comma_in_array' => true,
84+
'no_whitespace_in_blank_line' => true,
85+
'normalize_index_brace' => true,
86+
'not_operator_with_space' => false, // No we prefer to keep '!' without spaces
87+
'not_operator_with_successor_space' => false, // idem
88+
'object_operator_without_whitespace' => true,
89+
'ordered_class_elements' => false, // We prefer to keep some freedom
90+
'ordered_imports' => true,
91+
'php_unit_construct' => true,
92+
'php_unit_dedicate_assert' => true,
93+
'php_unit_fqcn_annotation' => true,
94+
'php_unit_strict' => false, // We sometime actually need assertEquals
95+
'phpdoc_add_missing_param_annotation' => true,
96+
'phpdoc_align' => false, // Waste of time
97+
'phpdoc_annotation_without_dot' => true,
98+
'phpdoc_indent' => true,
99+
'phpdoc_inline_tag' => true,
100+
'phpdoc_no_access' => true,
101+
'phpdoc_no_alias_tag' => true,
102+
'phpdoc_no_empty_return' => true,
103+
'phpdoc_no_package' => true,
104+
'phpdoc_no_useless_inheritdoc' => true,
105+
'phpdoc_order' => true,
106+
'phpdoc_return_self_reference' => true,
107+
'phpdoc_scalar' => true,
108+
'phpdoc_separation' => false,
109+
'phpdoc_single_line_var_spacing' => true,
110+
'phpdoc_summary' => false,
111+
'phpdoc_to_comment' => true,
112+
'phpdoc_trim' => true,
113+
'phpdoc_types' => true,
114+
'phpdoc_var_without_name' => true,
115+
'pow_to_exponentiation' => false,
116+
'pre_increment' => false,
117+
'protected_to_private' => true,
118+
'psr0' => true,
119+
'psr4' => true,
120+
'random_api_migration' => false, // This breaks our unit tests
121+
'return_type_declaration' => true,
122+
'self_accessor' => true,
123+
'semicolon_after_instruction' => false, // Buggy in `samples/index.php`
124+
'short_scalar_cast' => true,
125+
'silenced_deprecation_error' => true,
126+
'simplified_null_return' => false, // While technically correct we prefer to be explicit when returning null
127+
'single_blank_line_at_eof' => true,
128+
'single_blank_line_before_namespace' => true,
129+
'single_class_element_per_statement' => true,
130+
'single_import_per_statement' => true,
131+
'single_line_after_imports' => true,
132+
'single_quote' => true,
133+
'space_after_semicolon' => true,
134+
'standardize_not_equals' => true,
135+
'strict_comparison' => false, // No, too dangerous to change that
136+
'strict_param' => false, // No, too dangerous to change that
137+
'switch_case_semicolon_to_colon' => true,
138+
'switch_case_space' => true,
139+
'ternary_operator_spaces' => true,
140+
'ternary_to_null_coalescing' => false, // Cannot use that with PHP 5.6
141+
'trailing_comma_in_multiline_array' => true,
142+
'trim_array_spaces' => false,
143+
'unary_operator_spaces' => true,
144+
'visibility_required' => true,
145+
'whitespace_after_comma_in_array' => true,
146+
));

‎.travis.yml

+21-9
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,21 @@ php:
88
- 5.5
99
- 5.6
1010
- 7.0
11-
## - hhvm
11+
- 7.1
1212

1313
matrix:
14+
include:
15+
- php: 5.6
16+
env: COVERAGE=1
1417
allow_failures:
1518
- php: 7.0
16-
## - php: hhvm
19+
- php: 7.1
20+
21+
cache:
22+
directories:
23+
- vendor
24+
- $HOME/.composer/cache
25+
- .php-cs.cache
1726

1827
env:
1928
global:
@@ -25,6 +34,8 @@ before_install:
2534
- sudo apt-get install -y graphviz
2635

2736
before_script:
37+
## Deactivate xdebug if we don't do code coverage
38+
- if [ -z "$COVERAGE" ]; then phpenv config-rm xdebug.ini ; fi
2839
## Composer
2940
- composer self-update
3041
- composer install --prefer-source
@@ -34,19 +45,20 @@ before_script:
3445

3546
script:
3647
## PHP_CodeSniffer
37-
- ./vendor/bin/phpcs src/ tests/ --standard=PSR2 -n --ignore=src/PhpWord/Shared/PCLZip
48+
- if [ -z "$COVERAGE" ]; then ./vendor/bin/phpcs src/ tests/ --standard=PSR2 -n --ignore=src/PhpWord/Shared/PCLZip ; fi
49+
## PHP-CS-Fixer
50+
- if [ -n "$COVERAGE" ]; then ./vendor/bin/php-cs-fixer fix --diff --verbose --dry-run ; fi
3851
## PHP Mess Detector
39-
- ./vendor/bin/phpmd src/,tests/ text ./phpmd.xml.dist --exclude pclzip.lib.php
52+
- if [ -z "$COVERAGE" ]; then ./vendor/bin/phpmd src/,tests/ text ./phpmd.xml.dist --exclude pclzip.lib.php ; fi
4053
## PHPUnit
41-
- ./vendor/bin/phpunit -c ./ --coverage-text --coverage-html ./build/coverage
54+
- ./vendor/bin/phpunit -c ./ $(if [ -n "$COVERAGE" ]; then echo --coverage-text; else echo --no-coverage; fi)
4255
## PHPLOC
43-
- ./vendor/bin/phploc src/
56+
- if [ -z "$COVERAGE" ]; then ./vendor/bin/phploc src/ ; fi
4457
## PHPDocumentor
45-
- ./vendor/bin/phpdoc -q -d ./src -t ./build/docs --ignore "*/src/PhpWord/Shared/*/*" --template="responsive-twig"
58+
- if [ -z "$COVERAGE" ]; then ./vendor/bin/phpdoc -q -d ./src -t ./build/docs --ignore "*/src/PhpWord/Shared/*/*" --template="responsive-twig" ; fi
4659

4760
after_script:
4861
## PHPDocumentor
4962
- bash .travis_shell_after_success.sh
5063
## Scrutinizer
51-
- wget https://scrutinizer-ci.com/ocular.phar
52-
- php ocular.phar code-coverage:upload --format=php-clover build/logs/clover.xml
64+
- if [ -n "$COVERAGE" ]; then wget https://scrutinizer-ci.com/ocular.phar && php ocular.phar code-coverage:upload --format=php-clover build/logs/clover.xml ; fi

‎.travis_shell_after_success.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ echo "TRAVIS_REPO_SLUG: $TRAVIS_REPO_SLUG"
55
echo "TRAVIS_PHP_VERSION: $TRAVIS_PHP_VERSION"
66
echo "TRAVIS_PULL_REQUEST: $TRAVIS_PULL_REQUEST"
77

8-
if [ "$TRAVIS_REPO_SLUG" == "PHPOffice/PHPWord" ] && [ "$TRAVIS_PULL_REQUEST" == "false" ] && [ "$TRAVIS_PHP_VERSION" == "5.5" ]; then
8+
if [ "$TRAVIS_REPO_SLUG" == "PHPOffice/PHPWord" ] && [ "$TRAVIS_PULL_REQUEST" == "false" ] && [ "$TRAVIS_PHP_VERSION" == "5.6" ]; then
99

1010
echo -e "Publishing PHPDoc...\n"
1111

‎bootstrap.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@
1010
* file that was distributed with this source code. For the full list of
1111
* contributors, visit https://github.com/PHPOffice/PHPWord/contributors. test bootstrap
1212
*
13-
* @link https://github.com/PHPOffice/PHPWord
14-
* @copyright 2010-2016 PHPWord contributors
13+
* @see https://github.com/PHPOffice/PHPWord
14+
* @copyright 2010-2017 PHPWord contributors
1515
* @license http://www.gnu.org/licenses/lgpl.txt LGPL version 3
1616
*/
1717

‎composer.json

+5-3
Original file line numberDiff line numberDiff line change
@@ -39,12 +39,14 @@
3939
"phpoffice/common": "^0.2"
4040
},
4141
"require-dev": {
42-
"phpunit/phpunit": "3.7.*",
42+
"phpunit/phpunit": "4.8.*",
4343
"phpdocumentor/phpdocumentor":"2.*",
44-
"squizlabs/php_codesniffer": "1.*",
44+
"twig/twig":"1.27",
45+
"squizlabs/php_codesniffer": "^2.7",
46+
"friendsofphp/php-cs-fixer": "^2.0",
4547
"phpmd/phpmd": "2.*",
4648
"phploc/phploc": "2.*",
47-
"dompdf/dompdf":"0.6.*",
49+
"dompdf/dompdf":"0.8.*",
4850
"tecnickcom/tcpdf": "6.*",
4951
"mpdf/mpdf": "5.*"
5052
},

‎docs/elements.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -135,12 +135,12 @@ Text breaks are empty new lines. To add text breaks, use the following syntax. A
135135
Page breaks
136136
~~~~~~~~~~~
137137

138-
There are two ways to insert a page breaks, using the ``addPageBreak``
138+
There are two ways to insert a page break, using the ``addPageBreak``
139139
method or using the ``pageBreakBefore`` style of paragraph.
140140

141-
:: code-block:: php
141+
.. code-block:: php
142142
143-
\\$section->addPageBreak();
143+
$section->addPageBreak();
144144
145145
Lists
146146
-----

‎run_tests.sh

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
#!/bin/bash
2+
3+
## PHP_CodeSniffer
4+
./vendor/bin/phpcs src/ tests/ --standard=PSR2 -n --ignore=src/PhpWord/Shared/PCLZip
5+
6+
## PHP-CS-Fixer
7+
./vendor/bin/php-cs-fixer fix --diff --verbose --dry-run
8+
9+
## PHP Mess Detector
10+
./vendor/bin/phpmd src/,tests/ text ./phpmd.xml.dist --exclude pclzip.lib.php
11+
12+
## PHPUnit
13+
./vendor/bin/phpunit -c ./ --no-coverage
14+

‎samples/Sample_01_SimpleText.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?php
2-
use PhpOffice\PhpWord\Style\Paragraph;
32
use PhpOffice\PhpWord\Style\Font;
3+
use PhpOffice\PhpWord\Style\Paragraph;
44

55
include_once 'Sample_Header.php';
66

‎samples/Sample_02_TabStops.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
new \PhpOffice\PhpWord\Style\Tab('left', 1550),
1515
new \PhpOffice\PhpWord\Style\Tab('center', 3200),
1616
new \PhpOffice\PhpWord\Style\Tab('right', 5300),
17-
)
17+
),
1818
)
1919
);
2020

0 commit comments

Comments
 (0)