Documentation improvements, more test coverage for Timer

Author: maschmann

Config/Config.php

@@ -45,16 +45,13 @@ public static function factory(array $param, $class = 'ConfigDefault')
 
             // allow config names without ending
             if (empty($param['file'])) {
-                throw new \InvalidArgumentException(
-                    'Config::factory() - config filename missing in param array!'
-                );
+                throw new \InvalidArgumentException('Config::factory() - config filename missing in param array!');
             }
 
             return new $class($param);
         } else {
             throw new \ErrorException(
-                'Config::factory() - could not instantiate ' .
-                $class . ' - not in self::$whitelist'
+                'Config::factory() - could not instantiate ' . $class . ' - not in self::$whitelist'
             );
         }
     }

Config/ConfigTimer.php

@@ -98,7 +98,6 @@ public function setConfig($file)
                     }
                     $config[$timerKey] = $tmpConf;
             }
-
         }
 
         $this->setByArray($config);

Tests/Timer/TimerTest.php

@@ -15,6 +15,7 @@
 
 /**
  * Class TimerTest
+ *
  * @package Asm\Tests\Timer
  * @author marc aschmann <[email protected]>
  */
@@ -29,7 +30,7 @@ public function testConstruct()
     {
         $config = Config::factory(
             array(
-                'file' => TestData::getYamlTimerConfigFile(),
+                'file'      => TestData::getYamlTimerConfigFile(),
                 'filecheck' => false,
             ),
             'ConfigTimer'
@@ -44,13 +45,13 @@ public function testConstruct()
 
     /**
      * @depends testConstruct
-     * @covers \Asm\Timer\Timer::isTimerActive
-     * @covers \Asm\Timer\Timer::checkDate
-     * @covers \Asm\Timer\Timer::checkIntervals
-     * @covers \Asm\Timer\Timer::checkDays
-     * @covers \Asm\Timer\Timer::checkTime
-     * @covers \Asm\Timer\Timer::checkHoliday
-     * @covers \Asm\Timer\Timer::flush
+     * @covers  \Asm\Timer\Timer::isTimerActive
+     * @covers  \Asm\Timer\Timer::checkDate
+     * @covers  \Asm\Timer\Timer::checkIntervals
+     * @covers  \Asm\Timer\Timer::checkDays
+     * @covers  \Asm\Timer\Timer::checkTime
+     * @covers  \Asm\Timer\Timer::checkHoliday
+     * @covers  \Asm\Timer\Timer::flush
      * @param Timer $timer
      */
     public function testIsTimerActive(Timer $timer)
@@ -70,16 +71,19 @@ public function testIsTimerActive(Timer $timer)
 
     /**
      * @depends testConstruct
-     * @covers \Asm\Timer\Timer::isHoliday
-     * @covers \Asm\Timer\Timer::checkHoliday
+     * @covers  \Asm\Timer\Timer::isHoliday
+     * @covers  \Asm\Timer\Timer::getHoliday
+     * @covers  \Asm\Timer\Timer::checkHoliday
      * @param Timer $timer
      */
     public function testIsHoliday(Timer $timer)
     {
-    	$currentYear = date('Y');
+        $currentYear = date('Y');
 
         $this->assertFalse($timer->isHoliday('2014-03-03 00:00:00'), 'failed to check non-holiday date');
         $this->assertTrue($timer->isHoliday($currentYear . '-12-24 12:30:01'), 'failed to validate christmas');
+        $this->assertNotEmpty($timer->getHoliday());
+
         $this->assertTrue(is_bool($timer->isHoliday()), 'failed to validate bool return');
     }
 }

Timer/Timer.php

@@ -22,24 +22,24 @@ final class Timer
     /**
      * @var \Asm\Data\Data
      */
-    private $config = null;
+    private $config;
 
     /**
-     * current timer's config
+     * Current timer's config.
      *
-     * @var array
+     * @var mixed
      */
-    private $currentConf = array();
+    private $currentConf;
 
     /**
-     * if a holiday is in place - here it is
+     * If a holiday is in place - here it is.
      *
      * @var null|\DateTime
      */
-    private $holiday = null;
+    private $holiday;
 
     /**
-     * constructor with dependency injection
+     * Constructor with dependency injection.
      *
      * @param ConfigTimer $config
      */
@@ -51,7 +51,7 @@ public function __construct(ConfigTimer $config)
     }
 
     /**
-     * check if timer is active
+     * Check if timer is active.
      *
      * @param  string $type
      * @return boolean
@@ -62,7 +62,7 @@ public function isTimerActive($type)
         $this->currentConf = $this->config->get('timers', $type);
 
         // pre-check holidays
-        if (isset($this->currentConf['holiday'])) {
+        if (true === isset($this->currentConf['holiday'])) {
             // check if general holidays are to be used
             if (isset($this->currentConf['holiday']['use_general'])
                 && true === (bool)$this->currentConf['holiday']['use_general']
@@ -85,7 +85,7 @@ public function isTimerActive($type)
     }
 
     /**
-     * calculate difference between holiday DateTime objects and current or given time
+     * Calculate difference between holiday DateTime objects and current or given time.
      *
      * @param  string|null $date
      * @return boolean
@@ -96,7 +96,7 @@ public function isHoliday($date = null)
     }
 
     /**
-     * returns holiday object, if set
+     * Returns holiday object, if set.
      *
      * @codeCoverageIgnore
      * @return \DateTime|null
@@ -107,7 +107,7 @@ public function getHoliday()
     }
 
     /**
-     * clear current configuration
+     * Clear current configuration.
      */
     public function flush()
     {
@@ -116,7 +116,7 @@ public function flush()
     }
 
     /**
-     * date checks on config
+     * Date checks on config.
      *
      * @return bool
      */
@@ -148,7 +148,7 @@ private function checkDate()
     }
 
     /**
-     * check for holidays
+     * Check for holidays.
      *
      * @param  string|null $date
      * @return bool
@@ -218,7 +218,7 @@ private function checkHoliday($date = null)
     }
 
     /**
-     * check if current date is in interval
+     * Check if current date is in interval.
      *
      * @param  array $intervals
      * @return bool
@@ -249,7 +249,7 @@ private function checkIntervals(array $intervals = array())
     }
 
     /**
-     * check if today is in days array
+     * Check if today is in days array.
      *
      * @return bool
      */
@@ -265,7 +265,7 @@ private function checkDays()
     }
 
     /**
-     * do time comparison
+     * Do time comparison.
      *
      * @param array $intervals
      * @return bool