[BUGFIX] #13 Fixed bug where selected admin user could not be de-selected

Author: therouv

src/app/code/community/FireGento/AdminMonitoring/Block/Adminhtml/History/Grid.php

@@ -113,7 +113,7 @@ protected function _prepareColumns()
 
         /* @var $adminUsers FireGento_AdminMonitoring_Model_System_Config_Source_Admin_User */
         $adminUsers = Mage::getModel('firegento_adminmonitoring/system_config_source_admin_user');
-        $userOptions = $adminUsers->toOptionHash();
+        $userOptions = $adminUsers->toOptionHash(false);
         $this->addColumn('user_id', array(
             'header'  => $this->getMonitoringHelper()->__('User'),
             'index'   => 'user_id',

src/app/code/community/FireGento/AdminMonitoring/Model/System/Config/Source/Admin/User.php

@@ -32,9 +32,10 @@ class FireGento_AdminMonitoring_Model_System_Config_Source_Admin_User
     /**
      * Retrieve the option array
      *
+     * @param  bool $withEmpty Flag if empty value should be added
      * @return array
      */
-    public function toOptionArray()
+    public function toOptionArray($withEmpty = true)
     {
         if (null === $this->_options) {
             $userCollection = Mage::getModel('admin/user')->getCollection();
@@ -45,6 +46,13 @@ public function toOptionArray()
                     'label' => $user->getData('username'),
                 );
             }
+
+            if ($withEmpty) {
+                array_unshift($this->_options, array(
+                    'value' => '',
+                    'label' => $this->_getHelper()->__('No admin user')
+                ));
+            }
         }
 
         return $this->_options;

src/app/code/community/FireGento/AdminMonitoring/Model/System/Config/Source/History/Action.php

@@ -32,9 +32,10 @@ class FireGento_AdminMonitoring_Model_System_Config_Source_History_Action
     /**
      * Retrieve the option array
      *
+     * @param  bool $withEmpty Flag if empty value should be added
      * @return array
      */
-    public function toOptionArray()
+    public function toOptionArray($withEmpty = true)
     {
         if (null === $this->_options) {
             $this->_options = array(

src/app/code/community/FireGento/AdminMonitoring/Model/System/Config/Source/History/Status.php

@@ -32,19 +32,20 @@ class FireGento_AdminMonitoring_Model_System_Config_Source_History_Status
     /**
      * Retrieve the option array
      *
+     * @param  bool $withEmpty Flag if empty value should be added
      * @return array
      */
-    public function toOptionArray()
+    public function toOptionArray($withEmpty = true)
     {
         if (null === $this->_options) {
             $this->_options = array(
                 array(
                     'value' => FireGento_AdminMonitoring_Helper_Data::STATUS_SUCCESS,
-                    'label' => Mage::helper('firegento_adminmonitoring')->__('Success'),
+                    'label' => $this->_getHelper()->__('Success'),
                 ),
                 array(
                     'value' => FireGento_AdminMonitoring_Helper_Data::STATUS_FAILURE,
-                    'label' => Mage::helper('firegento_adminmonitoring')->__('Failure'),
+                    'label' => $this->_getHelper()->__('Failure'),
                 )
             );
         }

src/app/code/community/FireGento/AdminMonitoring/Model/System/Config/Source/SourceAbstract.php

@@ -36,18 +36,20 @@ abstract class FireGento_AdminMonitoring_Model_System_Config_Source_SourceAbstra
     /**
      * Retrieve the option array
      *
+     * @param  bool $withEmpty Flag if empty value should be added
      * @return array
      */
-    abstract public function toOptionArray();
+    abstract public function toOptionArray($withEmpty = true);
 
     /**
      * Retrieve the option hash
      *
+     * @param  bool $withEmpty Flag if empty value should be added
      * @return array
      */
-    public function toOptionHash()
+    public function toOptionHash($withEmpty = true)
     {
-        $options = $this->toOptionArray();
+        $options = $this->toOptionArray($withEmpty);
         $optionHash = array();
 
         foreach ($options as $option) {
@@ -56,4 +58,14 @@ public function toOptionHash()
 
         return $optionHash;
     }
+
+    /**
+     * Retrieve the helper instance
+     *
+     * @return FireGento_AdminMonitoring_Helper_Data
+     */
+    protected function _getHelper()
+    {
+        return Mage::helper('firegento_adminmonitoring');
+    }
 }

src/app/code/community/FireGento/AdminMonitoring/Test/Model/System/Config/Source/Admin/User.php

@@ -66,6 +66,19 @@ public function toOptionArray()
         );
     }
 
+    /**
+     * @test
+     * @loadFixture ~FireGento_AdminMonitoring/default
+     * @loadExpectations
+     */
+    public function toOptionArrayWithoutEmpty()
+    {
+        $this->assertEquals(
+            $this->expected('options')->getResult(),
+            $this->_model->toOptionArray(false)
+        );
+    }
+
     /**
      * @test
      * @loadFixture ~FireGento_AdminMonitoring/default
@@ -78,4 +91,17 @@ public function toOptionHash()
             $this->_model->toOptionHash()
         );
     }
+
+    /**
+     * @test
+     * @loadFixture ~FireGento_AdminMonitoring/default
+     * @loadExpectations
+     */
+    public function toOptionHashWithoutEmpty()
+    {
+        $this->assertEquals(
+            $this->expected('options')->getResult(),
+            $this->_model->toOptionHash(false)
+        );
+    }
 }

src/app/code/community/FireGento/AdminMonitoring/Test/Model/System/Config/Source/Admin/User/_data/ex-toOptionArray.yaml

@@ -1,4 +1,6 @@
 options:
   result:
+    - value: ''
+      label: 'No admin user'
     - value: 1
       label: admin

src/app/code/community/FireGento/AdminMonitoring/Test/Model/System/Config/Source/Admin/User/_data/ex-toOptionArrayWithoutEmpty.yaml

@@ -0,0 +1,4 @@
+options:
+  result:
+    - value: 1
+      label: admin

src/app/code/community/FireGento/AdminMonitoring/Test/Model/System/Config/Source/Admin/User/_data/ex-toOptionHash.yaml

@@ -1,3 +1,4 @@
 options:
   result:
+    '': No admin user
     1: admin

src/app/code/community/FireGento/AdminMonitoring/Test/Model/System/Config/Source/Admin/User/_data/ex-toOptionHashWithoutEmpty.yaml

@@ -0,0 +1,3 @@
+options:
+  result:
+    1: admin