Merge pull request #10 from xtcat/cleanup

Added some docblocks and use phpunit

.gitignore

@@ -2,3 +2,4 @@
 composer.phar
 composer.lock
 .DS_Store
+.idea/

composer.json

@@ -2,7 +2,7 @@
     "name": "camroncade/timezone",
     "description": "Helps manage timezones in Laravel. Includes <select> form builder for timezones.",
     "homepage": "http://www.camroncade.com/managing-timezones-with-laravel/",
-    "keybords": ["timezone", "timezones"],
+    "keywords": ["timezone", "timezones"],
     "license": "MIT",
     "authors": [
         {
@@ -22,5 +22,8 @@
             "Camroncade\\Timezone\\": "src/"
         }
     },
-    "minimum-stability": "stable"
+    "minimum-stability": "stable",
+    "require-dev": {
+        "phpunit/phpunit": "^5.3"
+    }
 }

src/Camroncade/Timezone/Timezone.php

@@ -150,11 +150,22 @@ class Timezone {
 	    '(UTC+13:00) Nuku\'alofa' => 'Pacific/Tongatapu'
 	);
 
-    public function getTimezones()
+	/**
+	 * @return array
+     */
+	public function getTimezones()
     {
         return $this->timezoneList;
     }
-
+
+	/**
+	 * @param null $selected
+	 * @param null $placeholder
+	 * @param array $selectAttributes
+	 * @param array $optionAttributes
+	 *
+	 * @return string
+     */
 	public function selectForm($selected = null, $placeholder = null, array $selectAttributes = [], array $optionAttributes = [] )
 	{
 		$selectAttributesString = '';
@@ -196,16 +207,30 @@ public function selectForm($selected = null, $placeholder = null, array $selectA
 		return $string;
 	}
 
+	/**
+	 * @param integer $timestamp
+	 * @param string $timezone
+	 * @param string $format
+	 *
+	 * @return string
+     */
 	public function convertFromUTC($timestamp, $timezone, $format = 'Y-m-d H:i:s')
 	{
         $date = new DateTime($timestamp, new DateTimeZone('UTC'));
 
         $date->setTimezone(new DateTimeZone($timezone));
 
         return $date->format($format);
-    } 
+    }
 
-    public function convertToUTC($timestamp, $timezone, $format = 'Y-m-d H:i:s')
+	/**
+	 * @param integer $timestamp
+	 * @param string $timezone
+	 * @param string $format
+	 *
+	 * @return string
+     */
+	public function convertToUTC($timestamp, $timezone, $format = 'Y-m-d H:i:s')
     {
     	$date = new DateTime($timestamp, new DateTimeZone($timezone));
 

src/Camroncade/Timezone/TimezoneServiceProvider.php

@@ -15,21 +15,21 @@ class TimezoneServiceProvider extends ServiceProvider {
 	/**
 	 * Bootstrap the application events.
 	 *
-	 * @return void
+	 * @return null
 	 */
 	public function boot()
 	{
-		AliasLoader::getInstance()->alias('Timezone', 'Camroncade\Timezone\Facades\Timezone');
+		AliasLoader::getInstance()->alias('Timezone', \Camroncade\Timezone\Facades\Timezone::class);
 	}
 
 	/**
 	 * Register the service provider.
 	 *
-	 * @return void
+	 * @return null
 	 */
 	public function register()
 	{
-		$this->app->bind('timezone', 'Camroncade\Timezone\Timezone');
+		$this->app->bind('timezone', Timezone::class);
 	}
 
 	/**

tests/TimezoneTest.php

@@ -0,0 +1,17 @@
+<?php
+
+class TimezoneTest extends PHPUnit_Framework_TestCase{
+    public function testConvertFromUTC(){
+        $timezone = new \Camroncade\Timezone\Timezone();
+
+        $this->assertEquals('2016-01-01 18:00:00',$timezone->convertFromUTC('2016-01-01 18:00:00','UTC'));
+        $this->assertEquals('18:30:20',$timezone->convertFromUTC('2016-01-01 18:30:20','UTC','H:i:s'));
+    }
+
+    public function testConvertToUTC(){
+        $timezone = new \Camroncade\Timezone\Timezone();
+
+        $this->assertEquals('2016-01-01 18:00:00',$timezone->convertToUTC('2016-01-01 18:00:00','UTC'));
+        $this->assertEquals('18:30:20',$timezone->convertToUTC('2016-01-01 18:30:20','UTC','H:i:s'));
+    }
+}