Merge pull request #2 from PHPOffice/master

Sync with Base
PHPOffice · May 19, 2020 · 7d58ba8 · 7d58ba8
2 parents 1861412 + be415fa
commit 7d58ba8
Show file tree

Hide file tree

Showing 560 changed files with 7,157 additions and 6,218 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -1,4 +1,16 @@
-/tests export-ignore
-README.md export-ignore
 *.min.js binary
+/.gitattributes export-ignore
 /.github export-ignore
+/.gitignore export-ignore
+/.php_cs.dist export-ignore
+/.sami.php export-ignore
+/.scrutinizer.yml export-ignore
+/.travis.yml export-ignore
+/CHANGELOG.PHPExcel.md export-ignore
+/bin export-ignore
+/composer.lock export-ignore
+/docs export-ignore
+/mkdocs.yml export-ignore
+/phpunit.xml.dist export-ignore
+/samples export-ignore
+/tests export-ignore
diff --git a/.php_cs.dist b/.php_cs.dist
@@ -1,33 +1,36 @@
 <?php
 
 $finder = PhpCsFixer\Finder::create()
-    ->exclude(['vendor', 'tests/data/Calculation'])
-    ->in('samples')
-    ->in('src')
-    ->in('tests/PhpSpreadsheetTests')
-    ;
+    ->exclude('vendor')
+    ->in(__DIR__);
 
 return PhpCsFixer\Config::create()
     ->setRiskyAllowed(true)
     ->setFinder($finder)
     ->setCacheFile(sys_get_temp_dir() . '/php-cs-fixer' . preg_replace('~\W~', '-', __DIR__))
     ->setRules([
         'align_multiline_comment' => true,
+        'array_indentation' => true,
         'array_syntax' => ['syntax' => 'short'],
         'backtick_to_shell_exec' => true,
         'binary_operator_spaces' => true,
         'blank_line_after_namespace' => true,
         'blank_line_after_opening_tag' => true,
+        'blank_line_before_return' => false, // Deprecated
         'blank_line_before_statement' => true,
         'braces' => true,
         'cast_spaces' => true,
         'class_attributes_separation' => ['elements' => ['method', 'property']], // const are often grouped with other related const
         'class_definition' => true,
-        'class_keyword_remove' => false, // ::class keyword gives us beter support in IDE
+        'class_keyword_remove' => false, // ::class keyword gives us better support in IDE
         'combine_consecutive_issets' => true,
         'combine_consecutive_unsets' => true,
+        'combine_nested_dirname' => true,
+        'comment_to_phpdoc' => true,
         'compact_nullable_typehint' => true,
         'concat_space' => ['spacing' => 'one'],
+        'constant_case' => true,
+        'date_time_immutable' => false, // Break our unit tests
         'declare_equal_normalize' => true,
         'declare_strict_types' => false, // Too early to adopt strict types
         'dir_constant' => true,
@@ -38,39 +41,57 @@ return PhpCsFixer\Config::create()
         'elseif' => true,
         'encoding' => true,
         'ereg_to_preg' => true,
+        'error_suppression' => true,
         'escape_implicit_backslashes' => true,
         'explicit_indirect_variable' => false, // I feel it makes the code actually harder to read
         'explicit_string_variable' => false, // I feel it makes the code actually harder to read
+        'final_class' => false, // We need non-final classes
         'final_internal_class' => true,
+        'final_public_method_for_abstract_class' => false, // We need non-final methods
+        'final_static_access' => true,
+        'fopen_flag_order' => true,
+        'fopen_flags' => true,
         'full_opening_tag' => true,
+        'fully_qualified_strict_types' => true,
         'function_declaration' => true,
         'function_to_constant' => true,
         'function_typehint_space' => true,
-        'general_phpdoc_annotation_remove' => false, // No use for that
-        'hash_to_slash_comment' => true,
+        'general_phpdoc_annotation_remove' => ['access', 'category', 'copyright', 'method', 'throws'],
+        'global_namespace_import' => true,
+        'hash_to_slash_comment' => false, // Deprecated
         'header_comment' => false, // We don't use common header in all our files
+        'heredoc_indentation' => false, // Requires PHP >= 7.3
         'heredoc_to_nowdoc' => false, // Not sure about this one
+        'implode_call' => true,
         'include' => true,
         'increment_style' => true,
         'indentation_type' => true,
-        'is_null' => ['use_yoda_style' => false],
-        'linebreak_after_opening_tag' => true,
+        'is_null' => true,
         'line_ending' => true,
+        'linebreak_after_opening_tag' => true,
         'list_syntax' => ['syntax' => 'short'],
+        'logical_operators' => true,
         'lowercase_cast' => true,
-        'lowercase_constants' => true,
+        'lowercase_constants' => false, // Deprecated
         'lowercase_keywords' => true,
+        'lowercase_static_reference' => true,
         'magic_constant_casing' => true,
+        'magic_method_casing' => true,
         'mb_str_functions' => false, // No, too dangerous to change that
         'method_argument_space' => true,
         'method_chaining_indentation' => true,
-        'method_separation' => true,
+        'method_separation' => false, // Deprecated
         'modernize_types_casting' => true,
         'multiline_comment_opening_closing' => true,
+        'multiline_whitespace_before_semicolons' => true,
+        'native_constant_invocation' => false, // Micro optimization that look messy
         'native_function_casing' => true,
-        '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
+        'native_function_invocation' => false, // I suppose this would be best, but I am still unconvinced about the visual aspect of it
+        'native_function_type_declaration_casing' => true,
         'new_with_braces' => true,
         'no_alias_functions' => true,
+        'no_alternative_syntax' => true,
+        'no_binary_string' => true,
         'no_blank_lines_after_class_opening' => true,
         'no_blank_lines_after_phpdoc' => true,
         'no_blank_lines_before_namespace' => false, // we want 1 blank line before namespace
@@ -80,46 +101,71 @@ return PhpCsFixer\Config::create()
         'no_empty_phpdoc' => true,
         'no_empty_statement' => true,
         'no_extra_blank_lines' => true,
+        'no_extra_consecutive_blank_lines' => false, // Deprecated
         'no_homoglyph_names' => true,
         'no_leading_import_slash' => true,
         'no_leading_namespace_whitespace' => true,
         'no_mixed_echo_print' => true,
         'no_multiline_whitespace_around_double_arrow' => true,
-        'no_multiline_whitespace_before_semicolons' => true,
-        'non_printable_character' => true,
+        'no_multiline_whitespace_before_semicolons' => false, // Deprecated
         'no_null_property_initialization' => true,
         'no_php4_constructor' => true,
-        'normalize_index_brace' => true,
         'no_short_bool_cast' => true,
         'no_short_echo_tag' => true,
         'no_singleline_whitespace_before_semicolons' => true,
         'no_spaces_after_function_name' => true,
         'no_spaces_around_offset' => true,
         'no_spaces_inside_parenthesis' => true,
         'no_superfluous_elseif' => false, // Might be risky on a huge code base
-        'not_operator_with_space' => false, // No we prefer to keep '!' without spaces
-        'not_operator_with_successor_space' => false, // idem
+        'no_superfluous_phpdoc_tags' => ['allow_mixed' => true],
         'no_trailing_comma_in_list_call' => true,
         'no_trailing_comma_in_singleline_array' => true,
-        'no_trailing_whitespace_in_comment' => true,
         'no_trailing_whitespace' => true,
+        'no_trailing_whitespace_in_comment' => true,
         'no_unneeded_control_parentheses' => true,
         'no_unneeded_curly_braces' => true,
         'no_unneeded_final_method' => true,
         'no_unreachable_default_argument_value' => true,
+        'no_unset_cast' => 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,
+        'non_printable_character' => true,
+        'normalize_index_brace' => true,
+        'not_operator_with_space' => false, // No we prefer to keep '!' without spaces
+        'not_operator_with_successor_space' => false, // idem
+        'nullable_type_declaration_for_default_null_value' => true,
         'object_operator_without_whitespace' => true,
         'ordered_class_elements' => false, // We prefer to keep some freedom
         'ordered_imports' => true,
+        'ordered_interfaces' => true,
+        'php_unit_construct' => true,
+        'php_unit_dedicate_assert' => true,
+        'php_unit_dedicate_assert_internal_type' => true,
+        'php_unit_expectation' => true,
+        'php_unit_fqcn_annotation' => true,
+        'php_unit_internal_class' => false, // Because tests are excluded from package
+        'php_unit_method_casing' => true,
+        'php_unit_mock' => true,
+        'php_unit_mock_short_will_return' => 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_size_class' => false, // That seems extra work to maintain for little benefits
+        'php_unit_strict' => false, // We sometime actually need assertEquals
+        'php_unit_test_annotation' => true,
+        'php_unit_test_case_static_method_calls' => ['call_type' => 'self'],
+        'php_unit_test_class_requires_covers' => false, // We don't care as much as we should about coverage
         'phpdoc_add_missing_param_annotation' => true,
         'phpdoc_align' => false, // Waste of time
         'phpdoc_annotation_without_dot' => true,
         'phpdoc_indent' => true,
         'phpdoc_inline_tag' => true,
+        'phpdoc_line_span' => false, // Unfortunately our old comments turn even uglier with this
         'phpdoc_no_access' => true,
         'phpdoc_no_alias_tag' => true,
         'phpdoc_no_empty_return' => true,
@@ -132,43 +178,46 @@ return PhpCsFixer\Config::create()
         'phpdoc_single_line_var_spacing' => true,
         'phpdoc_summary' => true,
         'phpdoc_to_comment' => true,
+        'phpdoc_to_param_type' => false, // Because experimental, but interesting for one shot use
+        'phpdoc_to_return_type' => false, // idem
         'phpdoc_trim' => true,
-        'phpdoc_types_order' => true,
+        'phpdoc_trim_consecutive_blank_line_separation' => true,
         'phpdoc_types' => true,
+        'phpdoc_types_order' => true,
+        'phpdoc_var_annotation_correct_order' => true,
         'phpdoc_var_without_name' => true,
-        'php_unit_construct' => true,
-        'php_unit_dedicate_assert' => true,
-        'php_unit_expectation' => true,
-        'php_unit_fqcn_annotation' => true,
-        'php_unit_mock' => true,
-        'php_unit_namespaced' => true,
-        'php_unit_no_expectation_annotation' => true,
-        'php_unit_strict' => false, // We sometime actually need assertEquals
-        'php_unit_test_annotation' => true,
-        'php_unit_test_class_requires_covers' => false, // We don't care as much as we should about coverage
-        'pow_to_exponentiation' => false,
+        'pow_to_exponentiation' => true,
+        'pre_increment' => false, // Deprecated
         'protected_to_private' => true,
         'psr0' => true,
         'psr4' => true,
-        'random_api_migration' => false, // This breaks our unit tests
+        'random_api_migration' => true,
+        'return_assignment' => false, // Sometimes useful for clarity or debug
         'return_type_declaration' => true,
         'self_accessor' => true,
+        'self_static_accessor' => true,
         'semicolon_after_instruction' => false, // Buggy in `samples/index.php`
+        'set_type_to_cast' => true,
         'short_scalar_cast' => true,
-        'silenced_deprecation_error' => true,
-        'simplified_null_return' => false, // While technically correct we prefer to be explicit when returning null
+        'silenced_deprecation_error' => false, // Deprecated
+        'simple_to_complex_string_variable' => false, // Would differ from TypeScript without obvious advantages
+        'simplified_null_return' => false, // Even if technically correct we prefer to be explicit
         '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' => true,
+        'single_line_throw' => false, // I don't see any reason for having a special case for Exception
         'single_quote' => true,
+        'single_trait_insert_per_statement' => true,
         'space_after_semicolon' => true,
+        'standardize_increment' => true,
         'standardize_not_equals' => true,
         'static_lambda' => false, // Risky if we can't guarantee nobody use `bindTo()`
         'strict_comparison' => false, // No, too dangerous to change that
         'strict_param' => false, // No, too dangerous to change that
+        'string_line_ending' => true,
         'switch_case_semicolon_to_colon' => true,
         'switch_case_space' => true,
         'ternary_operator_spaces' => true,
@@ -177,7 +226,7 @@ return PhpCsFixer\Config::create()
         'trim_array_spaces' => true,
         'unary_operator_spaces' => true,
         'visibility_required' => true,
-        'void_return' => false, // Cannot use that with PHP 5.6
+        'void_return' => true,
         'whitespace_after_comma_in_array' => true,
         'yoda_style' => false,
     ]);
diff --git a/.travis.yml b/.travis.yml
@@ -41,9 +41,9 @@ jobs:
       if: tag is present AND branch = master
       php: 7.4
       before_script:
-      - curl -O https://github.com/phpDocumentor/phpDocumentor/releases/download/v3.0.0-rc/phpDocumentor.phar
+        - curl -LO https://github.com/phpDocumentor/phpDocumentor/releases/download/v3.0.0-rc/phpDocumentor.phar
       script:
-      - php phpDocumentor.phar --directory src/ --target docs/api
+        - php phpDocumentor.phar --directory src/ --target docs/api
       deploy:
         provider: pages
         skip-cleanup: true

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,9 +7,24 @@ and this project adheres to [Semantic Versioning](https://semver.org).
 
 ## [Unreleased]
 
+### Added
+
+- Support writing to streams in all writers [#1292](https://github.com/PHPOffice/PhpSpreadsheet/issues/1292)
+- Support CSV files with data wrapping a lot of lines [#1468](https://github.com/PHPOffice/PhpSpreadsheet/pull/1468)
+
+### Fixed
+
+- Fix Chart samples by updating chart parameter from 0 to DataSeries::EMPTY_AS_GAP [#1448](https://github.com/PHPOffice/PhpSpreadsheet/pull/1448)
+- Fix return type in docblock for the Cells::get() [#1398](https://github.com/PHPOffice/PhpSpreadsheet/pull/1398)
+- Fix RATE, PRICE, XIRR, and XNPV Functions [#1456](https://github.com/PHPOffice/PhpSpreadsheet/pull/1456)
+- Save Excel 2010+ functions properly in XLSX [#1461](https://github.com/PHPOffice/PhpSpreadsheet/pull/1461)
+- Several improvements in HTML writer [#1464](https://github.com/PHPOffice/PhpSpreadsheet/pull/1464)
+
 ### Changed
 
 - Drop support for PHP 7.1, according to https://phpspreadsheet.readthedocs.io/en/latest/#php-version-support
+- Drop partial migration tool in favor of complete migration via RectorPHP [#1445](https://github.com/PHPOffice/PhpSpreadsheet/issues/1445)
+- Limit composer package to `src/` [#1424](https://github.com/PHPOffice/PhpSpreadsheet/pull/1424)
 
 ## [1.12.0] - 2020-04-27
 

diff --git a/README.md b/README.md
@@ -22,6 +22,8 @@ PhpSpreadsheet is the next version of PHPExcel. It breaks compatibility to drama
 
 Because all efforts have shifted to PhpSpreadsheet, PHPExcel will no longer be maintained. All contributions for PHPExcel, patches and new features, should target PhpSpreadsheet `master` branch.
 
+Do you need to migrate? There is [an automated tool](/docs/topics/migration-from-PHPExcel.md) for that.
+
 ## License
 
 PhpSpreadsheet is licensed under [MIT](https://github.com/PHPOffice/PhpSpreadsheet/blob/master/LICENSE).
diff --git a/bin/generate-document b/bin/generate-document
@@ -4,7 +4,7 @@
 use PhpOffice\PhpSpreadsheet\Calculation\Calculation;
 use PhpOffice\PhpSpreadsheet\DocumentGenerator;
 
-require_once __DIR__ . '/../src/Bootstrap.php';
+require_once 'vendor/autoload.php';
 
 try {
     $phpSpreadsheetFunctionsProperty = (new ReflectionClass(Calculation::class))->getProperty('phpSpreadsheetFunctions');
@@ -19,6 +19,6 @@ try {
         DocumentGenerator::generateFunctionListByName($phpSpreadsheetFunctions)
     );
 } catch (ReflectionException $e) {
-    fwrite(STDERR, (string)$e);
+    fwrite(STDERR, (string) $e);
     exit(1);
 }
diff --git a/bin/migrate-from-phpexcel b/bin/migrate-from-phpexcel
diff --git a/composer.json b/composer.json
@@ -55,7 +55,8 @@
         "ext-zlib": "*",
         "markbaker/complex": "^1.4",
         "markbaker/matrix": "^1.2",
-        "psr/simple-cache": "^1.0"
+        "psr/simple-cache": "^1.0",
+        "maennchen/zipstream-php": "^2.0"
     },
     "require-dev": {
         "dompdf/dompdf": "^0.8.5",