adding a setting to display branch names in Dashboard (#1295)

* adding a setting to display branch names in Dashboard

* changing method name to be camel caps

* fixed Code Sniffer and Dockblock Checker errors in TapParser

* removed white space in TapParser docblock and added new line in css file

* fixed branch name

Author: JoolsMcFly

PHPCI/Controller/HomeController.php

@@ -59,6 +59,8 @@ public function index()
             $build = BuildFactory::getBuild($build);
         }
 
+        $this->view->display_branch = $this->config->get('phpci.latest_builds.show_branch', false);
+
         $this->view->builds   = $builds;
         $this->view->groups = $this->getGroupInfo();
 

PHPCI/Controller/SettingsController.php

@@ -66,6 +66,11 @@ public function index()
             $buildSettings = $this->settings['phpci']['build'];
         }
 
+        $latestBuildsSettings = array();
+        if (isset($this->settings['phpci']['latest_builds'])) {
+            $latestBuildsSettings = $this->settings['phpci']['latest_builds'];
+        }
+
         $emailSettings = array();
         if (isset($this->settings['phpci']['email_settings'])) {
             $emailSettings = $this->settings['phpci']['email_settings'];
@@ -78,6 +83,7 @@ public function index()
 
         $this->view->configFile = PHPCI_CONFIG_FILE;
         $this->view->basicSettings = $this->getBasicForm($basicSettings);
+        $this->view->latestBuildsSettings = $this->getLatestBuildsForm($latestBuildsSettings);
         $this->view->buildSettings = $this->getBuildForm($buildSettings);
         $this->view->github = $this->getGithubForm();
         $this->view->emailSettings = $this->getEmailForm($emailSettings);
@@ -178,6 +184,26 @@ public function basic()
 
         return $response;
     }
+    /**
+     * Save basic settings.
+     */
+    public function latestBuilds()
+    {
+        $this->requireAdmin();
+
+        $this->settings['phpci']['latest_builds'] = $this->getParams();
+        $error = $this->storeSettings();
+
+        $response = new b8\Http\Response\RedirectResponse();
+
+        if ($error) {
+            $response->setHeader('Location', PHPCI_URL . 'settings?saved=2');
+        } else {
+            $response->setHeader('Location', PHPCI_URL . 'settings?saved=1');
+        }
+
+        return $response;
+    }
 
     /**
      * Handle authentication settings
@@ -427,6 +453,40 @@ protected function getBuildForm($values = array())
         return $form;
     }
 
+    /**
+     * Get the Build settings form.
+     * @param array $values
+     * @return Form
+     */
+    protected function getLatestBuildsForm($values = array())
+    {
+        $form = new Form();
+        $form->setMethod('POST');
+        $form->setAction(PHPCI_URL . 'settings/latestBuilds');
+
+        $field = new Form\Element\Checkbox('show_branch');
+        $field->setRequired(false);
+        $field->setLabel(Lang::get('show_branch'));
+        $field->setContainerClass('form-group');
+        $field->setClass('ml20px');
+        $field->setCheckedValue(1);
+
+        if (isset($values['show_branch'])) {
+            $field->setValue((int)$values['show_branch']);
+        }
+
+        $form->addField($field);
+
+        $field = new Form\Element\Submit();
+        $field->setValue(Lang::get('save'));
+        $field->setClass('btn btn-success pull-right');
+        $form->addField($field);
+
+        $form->setValues($values);
+
+        return $form;
+    }
+
     /**
      * Get the Basic settings form.
      * @param array $values
@@ -474,6 +534,7 @@ protected function getAuthenticationForm($values = array())
         $field = new Form\Element\Checkbox('disable_authentication');
         $field->setCheckedValue(1);
         $field->setRequired(false);
+        $field->setClass('ml20px');
         $field->setLabel('Disable Authentication?');
         $field->setContainerClass('form-group');
         $field->setValue(0);

PHPCI/Languages/lang.en.php

@@ -282,6 +282,9 @@
     '1_hour' => '1 Hour',
     '3_hours' => '3 Hours',
 
+    // Latest Builds
+    'show_branch' => 'Display branches',
+
     // Plugins
     'cannot_update_composer' => 'PHPCI cannot update composer.json for you as it is not writable.',
     'x_has_been_removed' => '%s has been removed.',
@@ -373,7 +376,7 @@
     'commit_id_option' => 'Commit ID to build',
     'branch_name_option' => 'Branch to build',
     'add_to_queue_failed' => 'Build created successfully, but failed to add to build queue. This usually happens
-                                when PHPCI is set to use a beanstalkd server that does not exist, 
+                                when PHPCI is set to use a beanstalkd server that does not exist,
                                 or your beanstalkd server has stopped.',
 
     // Run Command

PHPCI/Languages/lang.es.php

@@ -265,6 +265,8 @@
     '1_hour' => '1 Hora',
     '3_hours' => '3 Horas',
 
+    'show_branch' => 'Mostrar las ramas',
+
     // Plugins
     'cannot_update_composer' => 'PHPCI no puede actualizar composer.json porque no tiene permisos de escritura.',
     'x_has_been_removed' => '%s ha sido elimiando.',

PHPCI/Languages/lang.fr.php

@@ -282,6 +282,8 @@
     '1_hour' => '1 Heure',
     '3_hours' => '3 Heures',
 
+    'show_branch' => 'Afficher les branches',
+
     // Plugins
     'cannot_update_composer' => 'PHPCI ne peut pas mettre à jour le fichier composer.json pour vous, il n\'est pas modifiable.',
     'x_has_been_removed' => '%s a été supprimé.',

PHPCI/Plugin/Util/TapParser.php

@@ -149,14 +149,21 @@ protected function testLine($line)
         return false;
     }
 
-    protected function testDepends($line) {
+    /**
+     *
+     * @param string $line
+     *
+     * @return boolean
+     */
+    protected function testDepends($line)
+    {
         if (preg_match(self::TEST_DEPENDS_PATTERN, $line)) {
             $this->skippedTests++;
 
-            return TRUE;
+            return true;
         }
 
-        return FALSE;
+        return false;
     }
 
     /**

PHPCI/View/Home/index.phtml

@@ -74,9 +74,17 @@
                                 <span class="time"><i class="fa fa-clock-o"></i> <?php print Lang::formatDateTime($updated, 'LT'); ?></span>
                                 <h3 class="timeline-header">
                                     <a href="<?php print PHPCI_URL; ?>project/view/<?php print $build->getProjectId(); ?>">
-                                        <?php print $build->getProject()->getTitle(); ?>
+                                        <?php echo $build->getProject()->getTitle()?>
                                     </a>
-                                    -
+                                    <?php
+                                    if ($display_branch) {
+                                    ?>
+                                    (
+                                    <a href="<?php echo $build->getBranchLink();?>"><?php echo $build->getBranch(); ?></a>
+                                    )
+                                    <?php
+                                    }
+                                    ?>
                                     <a href="<?php print PHPCI_URL; ?>build/view/<?php print $build->getId(); ?>">
                                         Build #<?php print $build->getId(); ?>
                                     </a>

PHPCI/View/Settings/index.phtml

@@ -36,6 +36,13 @@
     </div>
 </div>
 
+<div class="box box-primary">
+    <div class="box-header"><h3 class="box-title"><?php Lang::out('latest_builds'); ?></h3></div>
+    <div class="box-body clearfix">
+        <?php print $latestBuildsSettings; ?>
+    </div>
+</div>
+
 <div class="box box-primary">
     <div class="box-header"><h3 class="box-title"><?php Lang::out('build_settings'); ?></h3></div>
     <div class="box-body clearfix">

public/assets/css/AdminLTE-custom.css

@@ -82,3 +82,7 @@
 #phpunit-data .error td { background: none; color: #f56954; }
 #phpunit-data .skipped td { background: none; color: #e08e0b; }
 #phpunit-data .todo td { background: none; color: #00c0ef; }
+
+.ml20px {
+    margin-left: 20px
+}