time-helper 1.3 → 1.3.1

data/README

@@ -2,6 +2,7 @@ This gem adds a few methods to Time, both instance and class.
 It's not great, but makes my life easier on a few cucumber based projects.
 There's a method Time.strtotime which takes a date(time) string and turns it into a time object.
 Also method add and substract to the instance. (Important, these methods do not account for leap years and months, etc, one month is 30 days and 1 year is 365 days.)
+=~ to see if two Time objects are "close enough"
 
 Usage examples:
 
@@ -41,6 +42,9 @@ Time.parse does not work well with non-American formats, if like me, you're work
 mat like: DD/MM/YYYY Time.parse will not do. In fact, if you rewrite strtotime so it just calls parse a few of the tests 
 included will fail.
 
+New in 1.3.1
+Added =~ method which allows you to see if two time objects are close enough, by default it compares up till the hour, for instance, a =~ b will be true if a and b are both objects with the same year, month, day and hour.
+Removed all the aborts! Replaced be real errors inside the class! Sorry for the mess. 
 
 New in 1.3:
 Added support for time strings in the format you'd usualy pass to Time.parse

data/lib/time-helper.rb

@@ -1,4 +1,5 @@
-#@version 1.3.0
+#encoding: utf-8
+#@version 1.3.1
 #@author Arthur
 class Time
     require 'time'
@@ -92,7 +93,7 @@ class Time
                 separators = string.match( /\d{2,4}(.)?\d{2}(.)?\d{2,4}/ )
                 return nil unless separators[1]
 
-                abort 'separators must be equal'  unless separators[2] == separators[1]
+                raise GenericInputError.new 'separators must be equal'  unless separators[2] == separators[1]
                 return separators[2]
             end
             #@param string [String] datetime string
@@ -108,7 +109,7 @@ class Time
                 return nil if string.match /\d{14}/
                 separators = string.match(/(.)\d{2}:\d{2}:\d{2}$/)
                 return separators[1] if separators[1]
-                abort 'could not find date time separator'
+                raise GenericInputError.new 'could not find date time separator'
             end
             #see Time#get_order
             def get_dt_order string
@@ -132,7 +133,7 @@ class Time
                     elsif year.match( dy ) and day.match( yd )
                         return :ymd
                     else
-                        abort 'can\'t find order'
+                        raise GenericInputError.new 'can\'t find order'
                     end
                 else
                     return no_separator_order string
@@ -150,7 +151,7 @@ class Time
                 elsif string[0..3].to_i >= 1970 and string[4..5].to_i and string[6..7].to_i <= 31
                     return :ymd
                 end
-                abort 'can\'t find order'
+                raise GenericInputError.new 'can\'t find order'
             end
     end
 
@@ -196,6 +197,33 @@ class Time
             return seconds
         end
 
-end
-class InvalidTimeStringFormat < StandardError
+    public
+#compares if two Time objects are close enough to each other
+#@param other_time [Time] time to be compared to
+#@param smallest_unit [Symbol] smallest unit of time to check if it's the same
+# @example
+# a = Time.now
+# b = Time.now.add(:day = 1)
+# a =~ b
+# => false
+# a.=~ b,:month
+# => true
+#@note to compare up to the hour you just need var =~ other_var,
+# but to pass the second argument you must use var.=~(other_var, :min)
+#@note minute is :min seconds is :sec
+    def =~(other_time, smallest_unit = :hour)
+        raise InvalidArgument.new('Argument must be an instance of Time') unless other_time.class == Time
+        equal = true
+        [:year, :month, :day, :hour, :min, :sec].each do |method|
+            self_unit, other_unit = self.method(method).call(), other_time.method(method).call()
+            equal = false unless self_unit == other_unit
+            break if method == smallest_unit
+        end
+        return equal
+    end
+
+##### Errors #####
+    class GenericInputError < StandardError; end
+    class InvalidArgument < GenericInputError; end
+    class InvalidTimeStringFormat < GenericInputError; end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: time-helper
 version: !ruby/object:Gem::Version 
-  version: "1.3"
+  version: 1.3.1
 platform: ruby
 authors: 
 - Arthur Silva
@@ -9,22 +9,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-05-30 00:00:00 +01:00
+date: 2012-08-20 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
-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\n\n\
-  **********************************************\n\
-  *How is this diferent than just \"Time.parse\"?*\n\
-  **********************************************\n\n\
-  Time.parse does not work well with non-American formats, if like me, you're working with strings that have dates in a format like: DD/MM/YYYY Time.parse will not do. In fact, if you rewrite strtotime so it just calls parse a few of the tests included will fail.\n\n\n\
-  New in 1.3:\n\
-  Added support for time strings in the format you'd usualy pass to Time.parse\n\
-  Added utc_parse method for the lazy, it parses the date and converts it to utc\n\n\
-  New in 1.2\n\
-  Tomorrow and Yesterday methods\n\n\
-  New in 1.1 \n\
-  I skiped this version.... because I suck at versioning \n\n"
+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\n\n    =~ to see if two Time objects are \"close enough\"\n"
 email: awls99@gmail.com
 executables: []
 
@@ -62,6 +51,6 @@ rubyforge_project:
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: A few helper functions for the Time class, useful on ruby 1.8
+summary: A few helper functions for the Time class.
 test_files: []