time-helper 1.0.01 → 1.2

data/lib/time-helper.rb

@@ -1,8 +1,11 @@
-#@version 1.0
+#@version 1.0.0
 #@author Arthur
 class Time
     #class methods
     class << self
+        #@param string [String] a datetime string with many possible formats 
+        #@see Time#valid_datetime? or the feature file for valid format
+        #@return [Time] set in the date of the string passed
         def strtotime string
             abort 'invalid date' unless valid_datetime? string
             h,m,s = 0,0,0
@@ -35,12 +38,20 @@ class Time
             end
             
         end
-
+        #@param string [String] datetime string
+        #@return [Boolean] 
         def valid_datetime? string
             return false unless string.match /\d{2,4}.?\d{2}.?\d{2,4}(?:.?\d{2}:?\d{2}:?\d{2})?/
             return true
         end
-
+        #@return [Time] Time object set 24 hours ago
+        def tomorrow
+            return Time.now.add(:day => 1 )
+        end
+        #@return [Time] return time object 24 hours from now
+        def yesterday
+            return Time.now.substract(:day => 1 )
+        end
         private
             def get_time_array time
                 h,m,s = 0,0,0
@@ -129,11 +140,25 @@ class Time
             end
     end
 
-    #instance methods
+    #@param params [Hash] hash of time to be added {:time => amount } (can take several at once)
+    #@return [Time] new time object with date set to the result 
+    # @example add time
+    #  t = Time.now()
+    #  t.add(:year => 1 ) #=> a time object set for 365 days from now
+    #  t.add(:year => 2, :day => 1 ) #=>  a time object set 731 days from now    
+    #  accepts :year :month :day :minute :hour :second :week
     def add params
         seconds = get_seconds params
         return self + seconds
     end
+
+    #@param params [Hash] hash of time to be added {:time => amount } (can take several at once)
+    #@return [Time] new time object with date set to the result 
+    # @example substract time
+    #  t = Time.now()
+    #  t.substract(:year => 1 ) returns a time object set for 365 days ago
+    #  t.substract(:year => 2, :day => 1 ) returns a time object set 731 ago
+    #  accepts :year :month :day :minute :hour :second :week
     def substract params
         seconds = get_seconds params
         return self - seconds

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: time-helper
 version: !ruby/object:Gem::Version 
-  version: 1.0.01
+  version: "1.2"
 platform: ruby
 authors: 
 - Arthur Silva
@@ -13,12 +13,7 @@ date: 2012-05-02 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
-description: |-
-  Adds a few methods to the Time class, more significant:
-  
-      strtotime which returns a Time object based on a string.
-  
-      also methods add and substract that allow you to do some easy date math (doesn't take leap months/years into account)
+description: "Adds a few methods to the Time class, more significant:\n\n    strtotime which returns a Time object based on a string.\n\n    also methods add and substract that allow you to do some easy date math (doesn't take leap months/years into account)\n also tomorrow and yesterday methods witch are like Time.now +- 1 day "
 email: awls99@gmail.com
 executables: []