PSR-2 compliance (Codeception#3105)

* Add composer.lock to .gitignore

* Put direct link to coding standards description

* Fix spacing

* Fix code style for ext and symfony-shim

* Fix PSR2 compliance issues

* Fix PSR2 compliance issues

* Add generated test files to gitginore

* Fix PSR2 compliance issues in tests

* Get rid of long code lines in tests to comply PSR2

* Get rid of long code lines to comply PSR2

* Add code style rule set

* Fix wrong indentation

* Improve code style

.gitignore

@@ -2,8 +2,10 @@
 .roboci
 Dockerfile
 composer.phar
+composer.lock
 vendor
 package/codecept.phar
+tests/support/_generated
 tests/data/app/db
 tests/data/sandbox
 tests/_output/*

CONTRIBUTING.md

@@ -5,7 +5,7 @@ At Codeception we are glad to receive contributions and patches from the communi
 Please check the guide for sending your contributions with Github at https://github.com/Codeception/Codeception/wiki/Git-workflow-for-Codeception-contributors
 
 ## Coding Standards
-All contributions must follow the coding standards described at: https://github.com/Codeception/Codeception/wiki/Codeception-coding-style-standard
+All contributions must follow [PSR-2](http://www.php-fig.org/psr/psr-2/) coding standard.
 
 ## Code
 **Bugfixes should be sent to to current stable branch, which is the same as major version number.**

composer.json

@@ -23,7 +23,7 @@
         "facebook/webdriver": ">=1.0.1 <2.0",
         "guzzlehttp/guzzle": ">=4.1.4 <7.0",
         "guzzlehttp/psr7": "~1.0",
-       "symfony/finder": ">=2.5 <3.1",
+        "symfony/finder": ">=2.5 <3.1",
         "symfony/console": ">=2.5 <3.1",
         "symfony/event-dispatcher": ">=2.5 <3.1",
         "symfony/yaml": ">=2.5 <3.1",

ext/Logger.php

@@ -34,7 +34,7 @@
  */
 class Logger extends Extension
 {
-    static $events = [
+    public static $events = [
         Events::SUITE_BEFORE    => 'beforeSuite',
         Events::TEST_BEFORE     => 'beforeTest',
         Events::TEST_AFTER      => 'afterTest',
@@ -120,5 +120,4 @@ public function beforeStep(StepEvent $e)
     {
         $this->logger->info((string) $e->getStep());
     }
-
-} 
+}

ext/Recorder.php

@@ -33,7 +33,9 @@
  * #### Configuration
  *
  * * `delete_successful` (default: true) - delete records for successfully passed tests (log only failed and errored)
- * * `module` (default: WebDriver) - which module for screenshots to use. Module should implement `Codeception\Lib\Interfaces\ScreenshotSaver` interface. Currently only WebDriver or any its children can be used.
+ * * `module` (default: WebDriver) - which module for screenshots to use.
+ * Module should implement `Codeception\Lib\Interfaces\ScreenshotSaver` interface.
+ * Currently only WebDriver or any its children can be used.
  *
  * ``` yaml
  * extensions:
@@ -207,7 +209,7 @@ class Recorder extends \Codeception\Extension
 </div>
 EOF;
 
-    static $events = [
+    public static $events = [
         Events::SUITE_BEFORE => 'beforeSuite',
         Events::SUITE_AFTER  => 'afterSuite',
         Events::TEST_BEFORE  => 'before',
@@ -236,9 +238,15 @@ public function beforeSuite()
         $this->seed = uniqid();
         $this->webDriverModule = $this->getModule($this->config['module']);
         if (!$this->webDriverModule instanceof ScreenshotSaver) {
-            throw new ExtensionException($this, 'You should pass module which implements Codeception\Lib\Interfaces\ScreenshotSaver interface');
+            throw new ExtensionException(
+                $this,
+                'You should pass module which implements Codeception\Lib\Interfaces\ScreenshotSaver interface'
+            );
         }
-        $this->writeln(sprintf("⏺ <bold>Recording</bold> ⏺ step-by-step screenshots will be saved to <info>%s</info>", codecept_output_dir()));
+        $this->writeln(sprintf(
+            "⏺ <bold>Recording</bold> ⏺ step-by-step screenshots will be saved to <info>%s</info>",
+            codecept_output_dir()
+        ));
         $this->writeln("Directory Format: <debug>record_{$this->seed}_{testname}</debug> ----");
     }
 
@@ -337,5 +345,4 @@ public function afterStep(StepEvent $e)
         $this->stepNum++;
         $this->slides[$filename] = $e->getStep();
     }
-
-}
+}

ext/RunFailed.php

@@ -26,7 +26,7 @@
  */
 class RunFailed extends Extension
 {
-    static $events = [
+    public static $events = [
         Events::RESULT_PRINT_AFTER => 'saveFailed'
     ];
 
@@ -67,5 +67,4 @@ protected function localizePath($path)
         }
         return $path;
     }
-
-} 
+}

ext/SimpleOutput.php

@@ -18,7 +18,7 @@ public function _initialize()
     }
 
     // we are listening for events
-    static $events = [
+    public static $events = [
         Events::SUITE_BEFORE => 'beforeSuite',
         Events::TEST_END     => 'after',
         Events::TEST_SUCCESS => 'success',

package/stub.php

@@ -6,4 +6,4 @@
 
 require_once 'phar://codecept.phar/codecept';
 
-__HALT_COMPILER();
+__halt_compiler();

ruleset.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0"?>
+<ruleset name="Codeception">
+    <description>
+        Codeception coding standard. Inherits from PSR-2.
+    </description>
+
+    <rule ref="PSR2">
+        <exclude name="PSR1.Classes.ClassDeclaration.MissingNamespace"/>
+        <exclude name="PSR1.Files.SideEffects.FoundWithSymbols"/>
+        <exclude name="PSR1.Classes.ClassDeclaration.MultipleClasses"/>
+        <exclude name="PSR2.Methods.MethodDeclaration.Underscore"/>
+        <exclude name="PSR2.Classes.PropertyDeclaration.Underscore"/>
+    </rule>
+</ruleset>

src/Codeception/Codecept.php

@@ -162,7 +162,10 @@ public function registerSubscribers()
 
     public function run($suite, $test = null)
     {
-        ini_set('memory_limit', isset($this->config['settings']['memory_limit']) ? $this->config['settings']['memory_limit'] : '1024M');
+        ini_set(
+            'memory_limit',
+            isset($this->config['settings']['memory_limit']) ? $this->config['settings']['memory_limit'] : '1024M'
+        );
         $settings = Configuration::suiteSettings($suite, Configuration::config());
 
         $selectedEnvironments = $this->options['env'];

src/Codeception/Command/Bootstrap.php

@@ -12,7 +12,8 @@
 use Symfony\Component\Console\Question\Question;
 
 /**
- * Creates default config, tests directory and sample suites for current project. Use this command to start building a test suite.
+ * Creates default config, tests directory and sample suites for current project.
+ * Use this command to start building a test suite.
  *
  * By default it will create 3 suites **acceptance**, **functional**, and **unit**.
  *
@@ -38,7 +39,12 @@ protected function configure()
         $this->setDefinition(
             [
                 new InputArgument('path', InputArgument::OPTIONAL, 'custom installation path', '.'),
-                new InputOption('namespace', 'ns', InputOption::VALUE_OPTIONAL, 'Namespace to add for actor classes and helpers'),
+                new InputOption(
+                    'namespace',
+                    'ns',
+                    InputOption::VALUE_OPTIONAL,
+                    'Namespace to add for actor classes and helpers'
+                ),
                 new InputOption('actor', 'a', InputOption::VALUE_OPTIONAL, 'Custom actor instead of Tester'),
                 new InputOption('empty', 'e', InputOption::VALUE_NONE, 'Don\'t create standard suites')
             ]
@@ -176,7 +182,7 @@ class_name: $actor{$this->actorSuffix}
 
     protected function createAcceptanceSuite($actor = 'Acceptance')
     {
-            $suiteConfig = <<<EOF
+        $suiteConfig = <<<EOF
 # Codeception Test Suite Configuration
 #
 # Suite for acceptance tests.
@@ -244,5 +250,4 @@ protected function createDirs()
             '/* Replace this file with actual dump of your database */'
         );
     }
-
 }

src/Codeception/Command/Build.php

@@ -59,8 +59,8 @@ private function buildActor(array $settings)
 
         $file = $this->buildPath(
             Configuration::supportDir(),
-            $settings['class_name']) . $this->getClassName($settings['class_name']
-        );
+            $settings['class_name']
+        ) . $this->getClassName($settings['class_name']);
         $file .=  '.php';
         return $this->save($file, $content);
     }

src/Codeception/Command/Clean.php

@@ -39,4 +39,4 @@ protected function execute(InputInterface $input, OutputInterface $output)
         FileSystem::doEmptyDir(Configuration::outputDir());
         $output->writeln("Done");
     }
-}
+}

src/Codeception/Command/Console.php

@@ -150,7 +150,7 @@ protected function executeCommands(InputInterface $input, OutputInterface $outpu
     protected function listenToSignals()
     {
         if (function_exists('pcntl_signal')) {
-            declare(ticks = 1);
+            declare (ticks = 1);
             pcntl_signal(SIGINT, SIG_IGN);
             pcntl_signal(SIGTERM, SIG_IGN);
         }

src/Codeception/Command/GenerateCept.php

@@ -46,7 +46,7 @@ public function execute(InputInterface $input, OutputInterface $output)
         $filename = $this->completeSuffix($filename, 'Cept');
         $gen = new Cept($config);
 
-        $full_path = rtrim( $config['path'], DIRECTORY_SEPARATOR ) . DIRECTORY_SEPARATOR . $filename;
+        $full_path = rtrim($config['path'], DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR . $filename;
         $res = $this->save($full_path, $gen->produce());
         if (!$res) {
             $output->writeln("<error>Test $filename already exists</error>");

src/Codeception/Command/GenerateEnvironment.php

@@ -1,4 +1,4 @@
-<?php 
+<?php
 namespace Codeception\Command;
 
 use Codeception\Configuration;
@@ -56,7 +56,5 @@ public function execute(InputInterface $input, OutputInterface $output)
         } else {
             $output->writeln("<error>File $relativePath/$file already exists</error>");
         }
-
     }
-
-}
+}

src/Codeception/Command/GenerateGroup.php

@@ -51,6 +51,8 @@ public function execute(InputInterface $input, OutputInterface $output)
         }
 
         $output->writeln("<info>Group extension was created in $filename</info>");
-        $output->writeln('To use this group extension, include it to "extensions" option of global Codeception config.');
+        $output->writeln(
+            'To use this group extension, include it to "extensions" option of global Codeception config.'
+        );
     }
 }

src/Codeception/Command/GeneratePhpUnit.php

@@ -8,7 +8,6 @@
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 
-
 /**
  * Generates skeleton for unit test as in classical PHPUnit.
  *

src/Codeception/Command/GenerateScenarios.php

@@ -28,9 +28,20 @@ protected function configure()
         $this->setDefinition([
             new InputArgument('suite', InputArgument::REQUIRED, 'suite from which texts should be generated'),
             new InputOption('config', 'c', InputOption::VALUE_REQUIRED, 'Use specified config instead of default'),
-            new InputOption('path', 'p', InputOption::VALUE_REQUIRED, 'Use specified path as destination instead of default'),
+            new InputOption(
+                'path',
+                'p',
+                InputOption::VALUE_REQUIRED,
+                'Use specified path as destination instead of default'
+            ),
             new InputOption('single-file', '', InputOption::VALUE_NONE, 'Render all scenarios to only one file'),
-            new InputOption('format', 'f', InputOption::VALUE_REQUIRED, 'Specify output format: html or text (default)', 'text'),
+            new InputOption(
+                'format',
+                'f',
+                InputOption::VALUE_REQUIRED,
+                'Specify output format: html or text (default)',
+                'text'
+            ),
             new InputOption('config', 'c', InputOption::VALUE_REQUIRED, 'Use specified config instead of default'),
         ]);
         parent::configure();
@@ -56,7 +67,9 @@ protected function execute(InputInterface $input, OutputInterface $output)
         @mkdir($path);
 
         if (!is_writable($path)) {
-            throw new ConfigurationException("Path $path is not writable. Please, set valid permissions for folder to store scenarios.");
+            throw new ConfigurationException(
+                "Path $path is not writable. Please, set valid permissions for folder to store scenarios."
+            );
         }
 
         $path = $path . DIRECTORY_SEPARATOR . $suite;
@@ -138,5 +151,4 @@ private function underscore($name)
         $name = preg_replace('/_Cest$/', '', $name);
         return $name;
     }
-
 }

src/Codeception/Command/GenerateSuite.php

@@ -10,7 +10,6 @@
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Yaml\Yaml;
 
-
 /**
  * Create new test suite. Requires suite name and actor name
  *
@@ -70,7 +69,10 @@ public function execute(InputInterface $input, OutputInterface $output)
         );
         $actorName = $this->removeSuffix($actor, $config['actor']);
 
-        $file = $this->buildPath(\Codeception\Configuration::supportDir() . "Helper", "$actorName.php") . "$actorName.php";
+        $file = $this->buildPath(
+            \Codeception\Configuration::supportDir() . "Helper",
+            "$actorName.php"
+        ) . "$actorName.php";
 
         $gen = new Helper($actorName, $config['namespace']);
         // generate helper
@@ -86,10 +88,12 @@ class_name: {{actor}}
         - {{helper}}
 EOF;
 
-        $this->save($dir . $suite . '.suite.yml', (new Template($conf))
-            ->place('actor', $actorName . $config['actor'])
-            ->place('helper', $gen->getHelperName())
-            ->produce()
+        $this->save(
+            $dir . $suite . '.suite.yml',
+            (new Template($conf))
+                ->place('actor', $actorName . $config['actor'])
+                ->place('helper', $gen->getHelperName())
+                ->produce()
         );
 
         $output->writeln("<info>Suite $suite generated</info>");