datasift / storyplayer

src/php/Prose/FromTestEnvironment.php

Doc Comments +4 added lines, -1 removed lines

@@ -125,6 +125,9 @@ 
         return $value;
     }
 
+    /**
+     * @param string $setting
+     */
     public function getModuleSetting($setting)
     {
         // what are we doing?
@@ -154,7 +157,7 @@ 
      * We've standardised on 'getConfig()' as the documented name for this
      * functionality across all three of the config-related modules.
      *
-     * @return object
+     * @return string
      */
     public function getAllSettings()
     {

Spacing +1 added lines, -1 removed lines

@@ -132,7 +132,7 @@
 
         // get the details
         $fullPath = 'target.moduleSettings.' . $setting;
-        $config  = $this->st->getConfig();
+        $config = $this->st->getConfig();
 
         $value = null;
         if ($config->hasData($fullPath)) {

src/php/Prose/UsingHost.php

Doc Comments +6 added lines

@@ -114,6 +114,9 @@ 
         return $result;
     }
 
+    /**
+     * @param string $command
+     */
     public function runCommandAndIgnoreErrors($command)
     {
         // what are we doing?
@@ -156,6 +159,9 @@ 
         return $result;
     }
 
+    /**
+     * @param string $commandLine
+     */
     public function startInScreen($sessionName, $commandLine)
     {
         // what are we doing?

Spacing +1 added lines, -1 removed lines

@@ -242,7 +242,7 @@
 
         // has this worked?
         $isStopped = $log->addStep("wait for process to terminate", function() use($pid, $grace, $log) {
-            for($i = 0; $i < $grace; $i++) {
+            for ($i = 0; $i < $grace; $i++) {
                 if (!fromHost($this->args[0])->getPidIsRunning($pid)) {
                     return true;
                 }

src/php/Prose/UsingPDODB.php

Doc Comments +4 added lines

@@ -62,6 +62,10 @@
  */
 class UsingPDODB extends Prose
 {
+    /**
+     * @param \DataSift\Storyplayer\PlayerLib\StoryTeller $st
+     * @param PDO[] $args
+     */
     public function __construct($st, $args)
     {
         // call our parent first

Braces +10 added lines, -20 removed lines

@@ -81,8 +81,7 @@ 
         // what are we doing?
         $log = usingLog()->startAction(["run SQL query:", $sql, "/ with params:", $params, "and driver params:", $driverParams]);
 
-        try
-        {
+        try {
             // create a prepared statement
             //
             // we do this so that we can inject the $params into the SQL statement
@@ -95,8 +94,7 @@ 
             $log->endAction();
             return $stmt;
         }
-        catch (Exception $e)
-        {
+        catch (Exception $e) {
             throw new E5xx_ActionFailed(__METHOD__, $e->getMessage());
         }
     }
@@ -106,8 +104,7 @@ 
         // what are we doing?
         $log = usingLog()->startAction(["run raw SQL query:", $sql, "with driver params: ", $driverParams]);
 
-        try
-        {
+        try {
             // execute the prepared statement
             //
             // we do this directly so that you can (hopefully) attempt
@@ -118,8 +115,7 @@ 
             $log->endAction();
             return $stmt;
         }
-        catch (Exception $e)
-        {
+        catch (Exception $e) {
             throw new E5xx_ActionFailed(__METHOD__, $e->getMessage());
         }
     }
@@ -129,15 +125,13 @@ 
         // what are we doing?
         $log = usingLog()->startAction("begin PDO database transaction");
 
-        try
-        {
+        try {
             $this->args[0]->beginTransaction();
 
             // all done
             $log->endAction();
         }
-        catch (Exception $e)
-        {
+        catch (Exception $e) {
             throw new E5xx_ActionFailed(__METHOD__, $e->getMessage());
         }
     }
@@ -147,15 +141,13 @@ 
         // what are we doing?
         $log = usingLog()->startAction("commit PDO database transaction");
 
-        try
-        {
+        try {
             $this->args[0]->commit();
 
             // all done
             $log->endAction();
         }
-        catch (Exception $e)
-        {
+        catch (Exception $e) {
             throw new E5xx_ActionFailed(__METHOD__, $e->getMessage());
         }
     }
@@ -165,15 +157,13 @@ 
         // what are we doing?
         $log = usingLog()->startAction("rollback PDO database transaction");
 
-        try
-        {
+        try {
             $this->args[0]->rollBack();
 
             // all done
             $log->endAction();
         }
-        catch (Exception $e)
-        {
+        catch (Exception $e) {
             throw new E5xx_ActionFailed(__METHOD__, $e->getMessage());
         }
     }

src/php/Storyplayer/TestEnvironments/Vagrant/VirtualboxHostAdapter.php

Doc Comments +1 added lines, -1 removed lines

@@ -69,7 +69,7 @@
 	 *         the group that we belong to
 	 * @param  string $hostId
 	 *         the alias for this host
-	 * @return object
+	 * @return Vagrant_VirtualboxHostDefinition
 	 *         a host definition to populate
 	 */
 	public function newHostDefinition(TestEnvironment_GroupDefinition $groupDef, $hostId)

Indentation +14 added lines, -14 removed lines

@@ -62,18 +62,18 @@
 
 class Vagrant_VirtualboxHostAdapter extends Vagrant_HostAdapter
 {
-	/**
-	 * create an empty host definition for this kind of host
-	 *
-	 * @param  TestEnvironment_GroupDefinition $groupDef
-	 *         the group that we belong to
-	 * @param  string $hostId
-	 *         the alias for this host
-	 * @return object
-	 *         a host definition to populate
-	 */
-	public function newHostDefinition(TestEnvironment_GroupDefinition $groupDef, $hostId)
-	{
-		return new Vagrant_VirtualboxHostDefinition($groupDef, $hostId, $this);
-	}
+    /**
+     * create an empty host definition for this kind of host
+     *
+     * @param  TestEnvironment_GroupDefinition $groupDef
+     *         the group that we belong to
+     * @param  string $hostId
+     *         the alias for this host
+     * @return object
+     *         a host definition to populate
+     */
+    public function newHostDefinition(TestEnvironment_GroupDefinition $groupDef, $hostId)
+    {
+        return new Vagrant_VirtualboxHostDefinition($groupDef, $hostId, $this);
+    }
 }
\ No newline at end of file

src/php/DataSift/Storyplayer/BrowserLib/BaseElementAction.php

Spacing +5 added lines, -5 removed lines

@@ -121,11 +121,11 @@ 
 
     protected $tagTypes = array(
         'button'        => array('input', 'button'),
-        'buttons'       => array('input','button'),
+        'buttons'       => array('input', 'button'),
         'cell'          => 'td',
         'cells'         => 'td',
-        'heading'       => array('h1', 'h2', 'h3', 'h4', 'h5','h6'),
-        'headings'      => array('h1', 'h2', 'h3', 'h4', 'h5','h6'),
+        'heading'       => array('h1', 'h2', 'h3', 'h4', 'h5', 'h6'),
+        'headings'      => array('h1', 'h2', 'h3', 'h4', 'h5', 'h6'),
         'link'          => 'a',
         'links'         => 'a',
         'orderedlist'   => 'ol',
@@ -154,7 +154,7 @@ 
         'unorderedlist' => self::SINGLE_TARGET
     );
 
-    protected $searchTypes = array (
+    protected $searchTypes = array(
         'id'            => 'ById',
         'label'         => 'ByLabel',
         'labelled'      => 'ByLabel',
@@ -296,7 +296,7 @@ 
     {
         // we need to know which element they want
         $words = $this->convertMethodNameToWords($methodName);
-        $indexType  = $this->determineIndexType($words);
+        $indexType = $this->determineIndexType($words);
 
         // get all the elements that match
         $elements = $this->retrieveElements($methodName, $methodArgs);

Braces +2 added lines, -1 removed lines

@@ -323,7 +323,8 @@
         $searchTerm = $methodArgs[0];
 
         $searchType = $this->determineSearchType($words);
-        if ($searchType === null) {             // we do not understand how to find the target field
+        if ($searchType === null) {
+// we do not understand how to find the target field
             throw new E5xx_ActionFailed(__CLASS__ . '::' . $methodName, "could not work out how to find the target to action upon");
         }
 

src/php/DataSift/Storyplayer/BrowserLib/DomElementSearch.php

Braces +2 added lines, -4 removed lines

@@ -245,8 +245,7 @@ 
 
         // search all of the label elements to find an associated input
         // element that we can safely use
-        foreach ($labelElements as $labelElement)
-        {
+        foreach ($labelElements as $labelElement) {
             try {
                 // add each element that matches this label
                 $retval[] = $this->getElementAssociatedWithLabelElement($labelElement, $labelText);
@@ -289,8 +288,7 @@ 
         }
 
         // what do we do next?
-        if ($inputElementId !== null)
-        {
+        if ($inputElementId !== null) {
             // where does the 'for' attribute go?
             try {
                 $inputElement = $log->addStep("find the input element with the id '{$inputElementId}'", function() use($topElement, $inputElementId) {

src/php/DataSift/Storyplayer/BrowserLib/MultiElementAction.php

Spacing +1 added lines, -1 removed lines

@@ -87,7 +87,7 @@
         $words = $this->convertMethodNameToWords($methodName);
 
         // how many elements are we searching for?
-        $countType  = $this->determineCountType($words);
+        $countType = $this->determineCountType($words);
 
         // get the elements we need
         $elements = $this->retrieveElements($methodName, $methodArgs);

src/php/DataSift/Storyplayer/Cli/BuildTestEnvironment/Command.php

Indentation +1 added lines, -1 removed lines

@@ -302,7 +302,7 @@
         // do we skip destroying the test environment?
         if ($this->st->getPersistTestEnvironment()) {
             echo PHP_EOL . "* Warning: NOT destroying test environment" . PHP_EOL
-                 .         "           --reuse-target flag is set" . PHP_EOL;
+                    .         "           --reuse-target flag is set" . PHP_EOL;
         }
 
         // cleanup

Braces +1 added lines, -2 removed lines

@@ -218,8 +218,7 @@
         // $this->playerList contains one or more things to play
         //
         // let's play each of them in order
-        foreach ($this->playerList as $player)
-        {
+        foreach ($this->playerList as $player) {
             // execute each player in turn
             //
             // they may also have their own list of nested players

Spacing +1 added lines, -1 removed lines

@@ -231,7 +231,7 @@
 
         // setup signal handling
         pcntl_signal(SIGTERM, array($this, 'sigtermHandler'));
-        pcntl_signal(SIGINT , array($this, 'sigtermHandler'));
+        pcntl_signal(SIGINT, array($this, 'sigtermHandler'));
     }
 
     /**

src/php/DataSift/Storyplayer/Cli/E4xx/NoSystemUnderTestSpecified.php

Indentation +1 added lines, -1 removed lines

@@ -61,7 +61,7 @@
     public function __construct()
     {
         $msg = "You need to use -s to specify which system to test." . PHP_EOL . PHP_EOL
-             . "Use 'storyplayer --list-systems' to see the list of known systems under test.";
+                . "Use 'storyplayer --list-systems' to see the list of known systems under test.";
         parent::__construct(400, $msg, $msg);
     }
 }
\ No newline at end of file