Merge pull request #3 from magento-commerce/develop

v6 release scope

Author: sivaschenko

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language.
+* Being respectful of differing viewpoints and experiences.
+* Gracefully accepting constructive criticism.
+* Focusing on what is best for the community.
+* Showing empathy towards other community members.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances.
+* Trolling, insulting/derogatory comments, and personal or political attacks.
+* Public or private harassment.
+* Publishing others' private information, such as a physical or electronic address, without explicit permission.
+* Other conduct which could reasonably be considered inappropriate in a professional setting.
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version].
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

.github/CONTRIBUTING.md

@@ -0,0 +1,48 @@
+# Contributing to Magento Coding Standard code
+
+Contributions to the Magento Coding Standard codebase are done using the fork & pull model.
+This contribution model has contributors maintaining their own fork of the Magento Coding Standard repository.
+The forked repository is then used to submit a request to the base repository to “pull” a set of changes.
+For more information on pull requests please refer to [GitHub Help](https://help.github.com/articles/about-pull-requests/).
+
+Contributions can take the form of new components or features, changes to existing features, tests, documentation (such as developer guides, user guides, examples, or specifications), bug fixes or optimizations.
+
+The Magento Coding Standard development team or community maintainers will review all issues and contributions submitted by the community of developers in the first in, first out order.
+During the review we might require clarifications from the contributor.
+If there is no response from the contributor within two weeks, the pull request will be closed.
+
+For more detailed information on contribution please read our [beginners guide](https://github.com/magento/magento2/wiki/Getting-Started).
+
+## Contribution requirements
+
+1. Contributions must adhere to the [Magento coding standards](https://devdocs.magento.com/guides/v2.3/coding-standards/bk-coding-standards.html).
+2. Pull requests (PRs) must be accompanied by a meaningful description of their purpose. Comprehensive descriptions increase the chances of a pull request being merged quickly and without additional clarification requests.
+3. Commits must be accompanied by meaningful commit messages.
+4. PRs which include bug fixes must be accompanied with a step-by-step description of how to reproduce the bug.
+3. PRs which include new logic or new rules must be submitted along with:
+* Unit test coverage
+* Proposed [documentation](https://devdocs.magento.com) updates. Documentation contributions can be submitted via the [devdocs GitHub](https://github.com/magento/devdocs).
+4. For larger features or changes, please [open an issue](https://github.com/magento/magento-coding-standard/issues) to discuss the proposed changes prior to development. This may prevent duplicate or unnecessary effort and allow other contributors to provide input.
+5. All automated tests must pass (all builds on [Travis CI](https://travis-ci.com/github/magento/magento-coding-standard) must be green).
+
+## Contribution process
+
+If you are a new GitHub user, we recommend that you create your own [free github account](https://github.com/signup/free).
+This will allow you to collaborate with the Magento Coding Standard development team, fork the Magento Coding Standard project and send pull requests.
+
+1. Search current [listed issues](https://github.com/magento/magento-coding-standard/issues) (open or closed) for similar proposals of intended contribution before starting work on a new contribution.
+2. Review the [Contributor License Agreement](https://opensource.adobe.com/cla.html) if this is your first time contributing.
+3. Create and test your work.
+4. Fork the Magento Coding Standard repository according to the [Fork A Repository instructions](https://devdocs.magento.com/guides/v2.3/contributor-guide/contributing.html#fork) and when you are ready to send us a pull request – follow the [Create A Pull Request instructions](https://devdocs.magento.com/guides/v2.3/contributor-guide/contributing.html#pull_request).
+5. Once your contribution is received the Magento Coding Standard development team will review the contribution and collaborate with you as needed.
+
+## Code of Conduct
+
+Please note that this project is released with a Contributor Code of Conduct. We expect you to agree to its terms when participating in this project.
+The full text is available in the repository [Wiki](https://github.com/magento/magento2/wiki/Magento-Code-of-Conduct).
+
+## Connecting with Community!
+
+If you have any questions, join us in [#beginners](https://magentocommeng.slack.com/messages/CH8BGFX9D) Slack chat. If you are not on our slack, [click here](http://tinyurl.com/engcom-slack) to join.
+
+Need to find a project? Check out the [Slack Channels](https://github.com/magento/magento2/wiki/Slack-Channels) (with listed project info) and the [Magento Community Portal](https://opensource.magento.com/).

.travis.yml

@@ -5,7 +5,11 @@ php:
   - 7.1
   - 7.2
   - 7.3
-install: composer install --no-interaction --prefer-source
+  - 7.4
+cache:
+  directories:
+    - $HOME/.composer/cache/files
+install: composer install --no-interaction --prefer-dist
 script:
   - vendor/bin/phpunit
   - vendor/bin/phpcs --standard=Magento2 Magento2/ --extensions=php

LICENSE.TXT renamed to LICENSE.txt

@@ -122,19 +122,15 @@ public function hasDeprecatedWellFormatted($commentStartPtr, $tokens)
             return true;
         }
 
+        $seeTagRequired = false;
         if ($tokens[$deprecatedPtr + 2]['code'] !== T_DOC_COMMENT_STRING) {
-            return false;
+            $seeTagRequired = true;
         }
-
         $seePtr = $this->getTagPosition('@see', $commentStartPtr, $tokens);
         if ($seePtr === -1) {
-            return true;
+            return !$seeTagRequired;
         }
-        if ($tokens[$seePtr + 2]['code'] !== T_DOC_COMMENT_STRING) {
-            return false;
-        }
-
-        return true;
+        return $tokens[$seePtr + 2]['code'] === T_DOC_COMMENT_STRING;
     }
 
     /**

Magento2/Helpers/Commenting/PHPDocFormattingValidator.php

@@ -65,7 +65,7 @@ public function process(File $phpcsFile, $stackPtr)
         if ($this->PHPDocFormattingValidator->providesMeaning($namePtr, $commentStartPtr, $tokens) !== true) {
             $phpcsFile->addWarning(
                 sprintf(
-                    '%s description should contain additional information beyond the name already supplies.',
+                    '%s description must contain meaningful information beyond what its name provides or be removed.',
                     ucfirst($tokens[$stackPtr]['content'])
                 ),
                 $stackPtr,

Magento2/Sniffs/Commenting/ClassAndInterfacePHPDocFormattingSniff.php

@@ -58,17 +58,21 @@ class DiscouragedFunctionSniff extends ForbiddenFunctionsSniff
         '^dngettext$' => null,
         '^domxml_.*$' => null,
         '^fbsql_.*$' => null,
+        '^fbsql$' => null,
         '^fdf_add_doc_javascript$' => null,
         '^fdf_open$' => null,
         '^fopen$' => 'Magento\Framework\Filesystem\DriverInterface::fileOpen()',
         '^fclose$' => 'Magento\Framework\Filesystem\DriverInterface::fileClose()',
-        '^fsockopen$' => null,
+        '^fsockopen$' => 'Magento\Framework\Filesystem\Driver\Http::open()',
         '^ftp_.*$' => null,
         '^fwrite$' => 'Magento\Framework\Filesystem\DriverInterface::fileWrite()',
-        '^gettext$' => null,
+        '^fputs$' => 'Magento\Framework\Filesystem\DriverInterface::fileWrite()',
+        '^gettext$' => 'Magento\Framework\Translate\AdapterInterface::translate()',
+        '^_$' => 'Magento\Framework\Translate\AdapterInterface::translate()',
         '^gz.*$' => null,
         '^header$' => null,
         '^highlight_file$' => null,
+        '^show_source$' => null,
         '^ibase_.*$' => null,
         '^id3_set_tag$' => null,
         '^ifx_.*$' => null,
@@ -88,6 +92,7 @@ class DiscouragedFunctionSniff extends ForbiddenFunctionsSniff
         '^msql_.*$' => null,
         '^mssql_.*$' => null,
         '^mysql_.*$' => null,
+        '^mysql.*$' => null,
         '^odbc_.*$' => null,
         '^opendir$' => null,
         '^openlog$' => null,
@@ -119,9 +124,10 @@ class DiscouragedFunctionSniff extends ForbiddenFunctionsSniff
         '^session_.*$' => null,
         '^set_include_path$' => null,
         '^ini_set$' => null,
+        '^ini_alter$' => null,
         '^set_time_limit$' => null,
         '^setcookie$' => null,
-        '^setlocale$' => null,
+        '^setlocale$' => 'Magento\Framework\Translate\AdapterInterface::setlocale()',
         '^setrawcookie$' => null,
         '^sleep$' => null,
         '^socket_.*$' => null,
@@ -135,7 +141,9 @@ class DiscouragedFunctionSniff extends ForbiddenFunctionsSniff
         '^vprintf$' => null,
         '^mysqli.*$' => null,
         '^oci_connect$' => null,
+        '^ocilogon$' => null,
         '^oci_pconnect$' => null,
+        '^ociplogon$' => null,
         '^quotemeta$' => null,
         '^sqlite_popen$' => null,
         '^time_nanosleep$' => null,
@@ -168,6 +176,7 @@ class DiscouragedFunctionSniff extends ForbiddenFunctionsSniff
         '^ircg_nickname_unescape$' => null,
         '^ldap_get_values$' => null,
         '^mb_decode_mimeheader$' => null,
+        '^i18n_mime_header_decode$' => null,
         '^mb_parse_str$' => null,
         '^mcrypt_decrypt$' => null,
         '^mdecrypt_generic$' => null,
@@ -201,7 +210,6 @@ class DiscouragedFunctionSniff extends ForbiddenFunctionsSniff
         '^stat$' => null,
         '^lchgrp$' => null,
         '^lchown$' => null,
-        '^show_source$' => null,
         '^is_dir$' => 'Magento\Framework\Filesystem\DriverInterface::isDirectory()',
         '^is_executable$' => null,
         '^is_file$' => 'Magento\Framework\Filesystem\DriverInterface::isFile()',
@@ -220,5 +228,6 @@ class DiscouragedFunctionSniff extends ForbiddenFunctionsSniff
         '^intval$' => '(int) construction',
         '^strval$' => '(string) construction',
         '^htmlspecialchars$' => '\Magento\Framework\Escaper->escapeHtml',
+        '^getimagesize$' => 'getimagesizefromstring',
     ];
 }

Magento2/Sniffs/Functions/DiscouragedFunctionSniff.php

@@ -0,0 +1,79 @@
+<?php
+/**
+ * Copyright © Magento. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento2\Sniffs\Methods;
+
+use PHP_CodeSniffer\Sniffs\Sniff;
+use PHP_CodeSniffer\Files\File;
+
+/**
+ * Detects possible use of deprecated model methods.
+ */
+class DeprecatedModelMethodSniff implements Sniff
+{
+    const RESOURCE_METHOD = "getResource";
+
+    /**
+     * String representation of warning.
+     *
+     * @var string
+     */
+    protected $warningMessage = "The use of the deprecated method 'getResource()' to '%s' the data detected.";
+
+    /**
+     * Warning violation code.
+     *
+     * @var string
+     */
+    protected $warningCode = 'FoundDeprecatedModelMethod';
+
+    /**
+     * List of deprecated method.
+     *
+     * @var array
+     */
+    protected $methods = [
+        'save',
+        'load',
+        'delete'
+    ];
+
+    protected $severity = 0;
+
+    /**
+     * @inheritdoc
+     */
+    public function register()
+    {
+        return [
+            T_OBJECT_OPERATOR
+        ];
+    }
+    /**
+     * @inheritdoc
+     */
+    public function process(File $phpcsFile, $stackPtr)
+    {
+        $tokens = $phpcsFile->getTokens();
+        $endOfStatement = $phpcsFile->findEndOfStatement($stackPtr);
+        $resourcePosition = $phpcsFile->findNext(
+            T_STRING,
+            $stackPtr + 1,
+            $endOfStatement,
+            false,
+            self::RESOURCE_METHOD
+        );
+        if ($resourcePosition !== false) {
+            $methodPosition = $phpcsFile->findNext([T_STRING, T_VARIABLE], $resourcePosition + 1, $endOfStatement);
+            if ($methodPosition !== false && in_array($tokens[$methodPosition]['content'], $this->methods, true)) {
+                $phpcsFile->addWarning(
+                    sprintf($this->warningMessage, $tokens[$methodPosition]['content']),
+                    $stackPtr,
+                    $this->warningCode
+                );
+            }
+        }
+    }
+}

Magento2/Sniffs/Methods/DeprecatedModelMethodSniff.php

@@ -0,0 +1,13 @@
+# Rule: Do not import from `Test` namespaces
+## Background
+Sometimes IDE imports the namespace with `Test` automatically for return data type like string, float etc or any other means.
+
+## Reasoning
+Time to time we're getting issue with running tests on PRs in magento/magento2 repository because someone imported `\Magento\Tests\NamingConvention\true\string` by mistake. As result - we have "No build reports available" for "Database Compare build", "Functional Tests build", "Sample Data Tests build" while Static tests are shown as "failing" but in results - we don't really have reason
+
+## How it works
+Any occurrence starts with `Magento\Tests` in import from the namespace will raise the warning. 
+
+## How to fix
+
+Remove `Magento\Tests` from the imported namespaces

Magento2/Sniffs/Namespaces/ImportsFromTestNamespaceSniff.md

@@ -0,0 +1,69 @@
+<?php
+/**
+ * Copyright © Magento. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento2\Sniffs\Namespaces;
+
+use PHP_CodeSniffer\Sniffs\Sniff;
+use PHP_CodeSniffer\Files\File;
+use PHP_CodeSniffer\Util\Tokens;
+
+/**
+ * Detects static test namespace.
+ */
+class ImportsFromTestNamespaceSniff implements Sniff
+{
+    /**
+     * @var string
+     */
+    private $prohibitNamespace = 'Magento\Tests';
+
+    /**
+     * @var string
+     */
+    protected $warningMessage = 'Application modules should not use classed from test modules.';
+
+    /**
+     * @var string
+     */
+    protected $warningCode = 'WrongImport';
+
+    /**
+     * @inheritdoc
+     */
+    public function register()
+    {
+        return [T_USE];
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function process(File $phpcsFile, $stackPtr)
+    {
+        $next = $phpcsFile->findNext([T_COMMA, T_SEMICOLON, T_OPEN_USE_GROUP, T_CLOSE_TAG], ($stackPtr + 1));
+        $tokens = $phpcsFile->getTokens();
+        $getTokenAsContent = $phpcsFile->getTokensAsString($stackPtr, ($next - $stackPtr));
+        if (strpos($getTokenAsContent, $this->prohibitNamespace) !== false) {
+            $phpcsFile->addWarning($this->warningMessage, $stackPtr, $this->warningCode);
+        }
+        if ($next !== false
+            && $tokens[$next]['code'] !== T_SEMICOLON
+            && $tokens[$next]['code'] !== T_CLOSE_TAG
+        ) {
+            $baseUse  = rtrim($phpcsFile->getTokensAsString($stackPtr, ($next - $stackPtr)));
+            $baseUse = str_replace('use \\', '', $baseUse);
+            $closingCurly = $phpcsFile->findNext(T_CLOSE_USE_GROUP, ($next + 1));
+            do {
+                $next = $phpcsFile->findNext(Tokens::$emptyTokens, ($next + 1), $closingCurly, true);
+                $groupedAsContent = $baseUse. $tokens[$next]['content'];
+                $next = $phpcsFile->findNext(T_COMMA, ($next + 1), $closingCurly);
+                if (strpos($groupedAsContent, $this->prohibitNamespace) !== false) {
+                    $phpcsFile->addWarning($this->warningMessage, $stackPtr, $this->warningCode);
+                    return;
+                }
+            } while ($next !== false);
+        }
+    }
+}

Magento2/Sniffs/Namespaces/ImportsFromTestNamespaceSniff.php

@@ -15,12 +15,11 @@ Typical example when `array_merge` is being used in the loop:
 
 In order to reduce execution time `array_merge` can be called only once:
 ``` php
-    $options = [[]];
+    $options = [];
     foreach ($configurationSources as $source) {
         // code here
         $options[] = $source->getOptions();
     }
 
-    // PHP 5.6+
-    $options = array_merge(...$options);
+    $options = array_merge([], ...$options);
 ```