Merge pull request #311 from OndraM/psr-2

PSR-2 codestyle

Author: gfosco

.gitignore

@@ -1,10 +1,11 @@
 composer.phar
 composer.lock
 vendor
+.php_cs.cache
 
 # generic files to ignore
 *.lock
 *.DS_Store
 *~
 *.swp
-.idea
+.idea

.php_cs

@@ -0,0 +1,41 @@
+<?php
+
+$finder = Symfony\CS\Finder\DefaultFinder::create()
+    ->in(array(__DIR__ . '/lib', __DIR__ . '/tests'));
+
+return Symfony\CS\Config\Config::create()
+    ->fixers(array(
+        'duplicate_semicolon',
+        'extra_empty_lines',
+        'multiline_array_trailing_comma',
+        'namespace_no_leading_whitespace',
+        'new_with_braces',
+        'no_blank_lines_after_class_opening',
+        'no_empty_lines_after_phpdocs',
+        'object_operator',
+        'operators_spaces',
+        'trim_array_spaces',
+        'phpdoc_indent',
+        'phpdoc_no_access',
+        'phpdoc_no_empty_return',
+        'phpdoc_no_package',
+        'phpdoc_scalar',
+        'phpdoc_trim',
+        'phpdoc_types',
+        'phpdoc_order',
+        'unused_use',
+        'ordered_use',
+        'remove_leading_slash_use',
+        'remove_lines_between_uses',
+        'function_typehint_space',
+        'self_accessor',
+        'single_array_no_trailing_comma',
+        'single_blank_line_before_namespace',
+        'single_quote',
+        'spaces_cast',
+        'whitespacy_lines',
+        'newline_after_open_tag',
+    ))
+    ->level(Symfony\CS\FixerInterface::PSR2_LEVEL)
+    ->setUsingCache(true)
+    ->finder($finder);

.travis.yml

@@ -10,6 +10,12 @@ php:
   - 7
   - hhvm
 
+matrix:
+  include:
+    # Add PHP 7 build to check codestyle only in PHP 7 build
+    - php: 7
+      env: CHECK_CODESTYLE=1
+
 env:
   global:
     - DISPLAY=:99.0
@@ -19,18 +25,21 @@ cache:
     - $HOME/.composer/cache
 
 before_install:
-  - composer self-update
+  - travis_retry composer self-update
 
 install:
-  - composer install --no-interaction --prefer-source
+  - travis_retry composer install --no-interaction --prefer-source
 
 before_script:
-  - sh -e /etc/init.d/xvfb start
-  - wget -q -t 3 http://selenium-release.storage.googleapis.com/2.45/selenium-server-standalone-2.45.0.jar
-  - java -jar selenium-server-standalone-2.45.0.jar -log selenium.log &
-  - until $(echo | nc localhost 4444); do sleep 1; echo waiting for selenium-server...; done;
-
-script: ./vendor/bin/phpunit
+  - if [ -z "$CHECK_CODESTYLE" ]; then sh -e /etc/init.d/xvfb start; fi
+  - if [ -z "$CHECK_CODESTYLE" ]; then wget -q -t 3 http://selenium-release.storage.googleapis.com/2.45/selenium-server-standalone-2.45.0.jar; fi
+  - if [ -z "$CHECK_CODESTYLE" ]; then java -jar selenium-server-standalone-2.45.0.jar -log selenium.log; fi &
+  - if [ -z "$CHECK_CODESTYLE" ]; then until $(echo | nc localhost 4444); do sleep 1; echo waiting for selenium-server...; done; fi
+
+script:
+  - if [ -n "$CHECK_CODESTYLE" ]; then ./vendor/bin/php-cs-fixer fix --diff --dry-run; fi
+  - if [ -n "$CHECK_CODESTYLE" ]; then ./vendor/bin/phpcs --standard=PSR2 ./lib/ ./tests/; fi
+  - if [ -z "$CHECK_CODESTYLE" ]; then ./vendor/bin/phpunit; fi
 
 after_script:
   - cat selenium.log

CHANGELOG.md

@@ -3,6 +3,7 @@ This project versioning adheres to [Semantic Versioning](http://semver.org/).
 
 ## Unreleased
 - Fixed FirefoxProfile to support installation of extensions with custom namespace prefix in their manifest file
+- Comply codestyle with [PSR-2](http://www.php-fig.org/psr/psr-2/)
 
 ## 1.1.2 - 2016-06-04
 - Added ext-curl to composer.json

CONTRIBUTING.md

@@ -9,7 +9,7 @@ send a pull request (see bellow) with your contribution.
 
 1. Fork the project on GitHub
 2. Implement your code changes into separate branch
-3. Make sure all PHPUnit tests passes (see below). We also have Travis CI build which will automatically run tests on your pull request).
+3. Make sure all PHPUnit tests passes and code-style matches PSR-2 (see below). We also have Travis CI build which will automatically run tests on your pull request.
 4. When implementing notable change, fix or a new feature, add record to Unreleased section of [CHANGELOG.md](CHANGELOG.md)
 5. Submit your [pull request](https://github.com/facebook/php-webdriver/pulls) against community branch
 
@@ -34,3 +34,10 @@ For the functional tests you must first download and start the selenium server,
 
     java -jar selenium-server-standalone-2.48.2.jar -log selenium.log &
     ./vendor/bin/phpunit --testsuite functional
+
+### Check coding style
+
+Your code-style should comply with [PSR-2](http://www.php-fig.org/psr/psr-2/). To make sure your code matches this requirement run:
+
+    ./vendor/bin/php-cs-fixer fix --diff --dry-run
+    ./vendor/bin/phpcs --standard=PSR2 ./lib/ ./tests/

composer.json

@@ -15,7 +15,9 @@
     "ext-curl": "*"
   },
   "require-dev": {
-    "phpunit/phpunit": "4.6.*"
+    "phpunit/phpunit": "4.6.* || ~5.0",
+    "friendsofphp/php-cs-fixer": "^1.11",
+    "squizlabs/php_codesniffer": "^2.6"
   },
   "suggest": {
     "phpdocumentor/phpdocumentor": "2.*"

lib/Chrome/ChromeDriver.php

@@ -15,72 +15,72 @@
 
 namespace Facebook\WebDriver\Chrome;
 
+use Facebook\WebDriver\Exception\WebDriverException;
 use Facebook\WebDriver\Remote\DesiredCapabilities;
 use Facebook\WebDriver\Remote\DriverCommand;
-use Facebook\WebDriver\Remote\Service\DriverCommandExecutor;
-use Facebook\WebDriver\Exception\WebDriverException;
 use Facebook\WebDriver\Remote\RemoteWebDriver;
+use Facebook\WebDriver\Remote\Service\DriverCommandExecutor;
 use Facebook\WebDriver\Remote\WebDriverCommand;
 
-class ChromeDriver extends RemoteWebDriver {
+class ChromeDriver extends RemoteWebDriver
+{
+    public static function start(DesiredCapabilities $desired_capabilities = null, ChromeDriverService $service = null)
+    {
+        if ($desired_capabilities === null) {
+            $desired_capabilities = DesiredCapabilities::chrome();
+        }
+        if ($service === null) {
+            $service = ChromeDriverService::createDefaultService();
+        }
+        $executor = new DriverCommandExecutor($service);
+        $driver = new static();
+        $driver->setCommandExecutor($executor)
+            ->startSession($desired_capabilities);
 
-  public static function start(
-    DesiredCapabilities $desired_capabilities = null,
-    ChromeDriverService $service = null
-  ) {
-    if ($desired_capabilities === null) {
-      $desired_capabilities = DesiredCapabilities::chrome();
+        return $driver;
     }
-    if ($service === null) {
-      $service = ChromeDriverService::createDefaultService();
-    }
-    $executor = new DriverCommandExecutor($service);
-    $driver = new static();
-    $driver->setCommandExecutor($executor)
-           ->startSession($desired_capabilities);
-    return $driver;
-  }
 
-  public function startSession($desired_capabilities) {
-    $command = new WebDriverCommand(
-      null,
-      DriverCommand::NEW_SESSION,
-      array(
-        'desiredCapabilities' => $desired_capabilities->toArray(),
-      )
-    );
-    $response = $this->executor->execute($command);
-    $this->setSessionID($response->getSessionID());
-  }
+    public function startSession($desired_capabilities)
+    {
+        $command = new WebDriverCommand(
+            null,
+            DriverCommand::NEW_SESSION,
+            array(
+                'desiredCapabilities' => $desired_capabilities->toArray(),
+            )
+        );
+        $response = $this->executor->execute($command);
+        $this->setSessionID($response->getSessionID());
+    }
 
-  /**
-   * Always throws an exception. Use ChromeDriver::start() instead.
-   *
-   * @throws WebDriverException
-   */
-  public static function create(
-    $url = 'http://localhost:4444/wd/hub',
-    $desired_capabilities = null,
-    $connection_timeout_in_ms = null,
-    $request_timeout_in_ms = null,
-    $http_proxy = null,
-    $http_proxy_port = null
-  ) {
-    throw new WebDriverException('Please use ChromeDriver::start() instead.');
-  }
+    /**
+     * Always throws an exception. Use ChromeDriver::start() instead.
+     *
+     * @throws WebDriverException
+     */
+    public static function create(
+        $url = 'http://localhost:4444/wd/hub',
+        $desired_capabilities = null,
+        $connection_timeout_in_ms = null,
+        $request_timeout_in_ms = null,
+        $http_proxy = null,
+        $http_proxy_port = null
+    ) {
+        throw new WebDriverException('Please use ChromeDriver::start() instead.');
+    }
 
-  /**
-   * Always throws an exception. Use ChromeDriver::start() instead.
-   *
-   * @param string $session_id The existing session id
-   * @param string $url        The url of the remote server
-   *
-   * @throws WebDriverException
-   */
-  public static function createBySessionID(
-    $session_id,
-    $url = 'http://localhost:4444/wd/hub'
-  ) {
-    throw new WebDriverException('Please use ChromeDriver::start() instead.');
-  }
+    /**
+     * Always throws an exception. Use ChromeDriver::start() instead.
+     *
+     * @param string $session_id The existing session id
+     * @param string $url The url of the remote server
+     *
+     * @throws WebDriverException
+     */
+    public static function createBySessionID(
+        $session_id,
+        $url = 'http://localhost:4444/wd/hub'
+    ) {
+        throw new WebDriverException('Please use ChromeDriver::start() instead.');
+    }
 }

lib/Chrome/ChromeDriverService.php

@@ -17,17 +17,18 @@
 
 use Facebook\WebDriver\Remote\Service\DriverService;
 
-class ChromeDriverService extends DriverService {
+class ChromeDriverService extends DriverService
+{
+    // The environment variable storing the path to the chrome driver executable.
+    const CHROME_DRIVER_EXE_PROPERTY = 'webdriver.chrome.driver';
 
-  // The environment variable storing the path to the chrome driver executable.
-  const CHROME_DRIVER_EXE_PROPERTY = "webdriver.chrome.driver";
-
-  public static function createDefaultService() {
-    $exe = getenv(self::CHROME_DRIVER_EXE_PROPERTY);
-    $port = 9515; // TODO: Get another port if the default port is used.
-    $args = array("--port=$port");
-    $service = new ChromeDriverService($exe, $port, $args);
-    return $service;
-  }
+    public static function createDefaultService()
+    {
+        $exe = getenv(self::CHROME_DRIVER_EXE_PROPERTY);
+        $port = 9515; // TODO: Get another port if the default port is used.
+        $args = array("--port=$port");
+        $service = new self($exe, $port, $args);
 
+        return $service;
+    }
 }