megli_common_helper 1.0.3 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 26681f16a21e628a78982e6ceb0db964e808c6db
-  data.tar.gz: 89e2db73e4df160b41784753b4dec3fa6be4f47e
+  metadata.gz: 04047b0312017627aceefba58ac696f8a4f1e64f
+  data.tar.gz: d2e87a677bad2818399f9b837c09a40dc12c36c5
 SHA512:
-  metadata.gz: 41f35beb21037d9839ca341d2b5bebecd160d00289500f1b1fc59275c6d5c11a3007aa2ba6dc433f8539cd2d2ac650f15e7209f544693da6b5565ddcc457dc20
-  data.tar.gz: f7a21459b0ff201966778c9eb0e295538e1aa728b9e57c884f69d05f54d3a33dfb09096f6736a26738081031038fb1ceb8a2d8c6c6d04a1caedf664efc15ba2c
+  metadata.gz: 7836de0c003887452b08aa39243c3549f0f63262dfbbad9ef8b14180f2ca4cde78ed837b2a497cddff76276c920a596e2c79d9809faa4f066a5215f09a9e8c05
+  data.tar.gz: bf657429923916e875cc5e842f064ad4bc20a5c15f4a91c1b324e9ea93f28a03949d0d1aec4cf046b783c21fe30804d3be501f6a2332e7933319adad3c25a6a1

data/lib/helpers/assert_helper.rb

@@ -0,0 +1,21 @@
+require 'time'
+
+module MegliHelper
+  class AssertHelper
+    # Assert a range of time according to min and max range
+    # @param time to be compared
+    # @param time_base to be a base in the comparison
+    # @param min_range to decrease the base time
+    # @param max_range to increase the base time
+    # If time is not inside the ranges, then it will raise an exception to fail the test.
+    def self.assert_time_range(time, time_base, min_range, max_range)
+      time = Time.parse(time) if time.class == String
+      time_base = Time.parse(time_base) if time_base.class == String
+      time_base ||= Time.now
+      min = (time_base - 60 * min_range)
+      max = (time_base + 60 * max_range)
+      raise("The time #{time} is not inside the range #{min} and #{max}") if time < min || time > max
+      true
+    end
+  end
+end

data/lib/helpers/common_helper.rb

@@ -1,62 +1,64 @@
 require 'json'
 require 'timeout'
 
-class MegliHelper::CommonHelper
-  # Check if text is null or empty
-  # @param text [String] text to be checked
-  # @return [Boolean] true if text is nil or empty and false if not
-  def self.nil_or_empty?(text)
-    (text.nil? || text.to_s.empty? || text.empty?)
-  rescue
-    false
-  end
+module MegliHelper
+  class CommonHelper
+    # Check if text is null or empty
+    # @param text [String] text to be checked
+    # @return [Boolean] true if text is nil or empty and false if not
+    def self.nil_or_empty?(text)
+      (text.nil? || text.to_s.empty? || text.empty?)
+    rescue
+      false
+    end
 
-  # Convert string value to boolean
-  # @param value [String] value to be converted
-  # @return [Boolean][nil] if string is not a valid boolean it will return nil
-  def self.to_boolean(value)
-    return false if nil_or_empty? value
-    return true if %w(true 1 y yes).include? value.to_s.downcase.strip
-    return false if %w(false 0 n no).include? value.to_s.downcase.strip
-    false
-  rescue
-    false
-  end
+    # Convert string value to boolean
+    # @param value [String] value to be converted
+    # @return [Boolean][nil] if string is not a valid boolean it will return nil
+    def self.to_boolean(value)
+      return false if nil_or_empty? value
+      return true if %w(true 1 y yes).include? value.to_s.downcase.strip
+      return false if %w(false 0 n no).include? value.to_s.downcase.strip
+      false
+    rescue
+      false
+    end
 
-  # Transform float value to a decimal formatted
-  # @param decimal [Float] value to be formatted
-  # @param decimal_format formmated used to format the value
-  # @param currency [String] currency signal to be included in the decimal like: $, £, R$, etc.
-  # @param currency_before [Boolean] where the currency must be included (before or after decimal)
-  # @return [String] decimal formatted
-  def self.to_decimal(decimal, decimal_format = '%8.2f', currency = nil, currency_before = true)
-    new_decimal = (decimal_format % decimal).strip
-    unless nil_or_empty?(currency)
-      return currency + new_decimal if currency_before
-      return new_decimal + currency
+    # Transform float value to a decimal formatted
+    # @param decimal [Float] value to be formatted
+    # @param decimal_format formmated used to format the value
+    # @param currency [String] currency signal to be included in the decimal like: $, £, R$, etc.
+    # @param currency_before [Boolean] where the currency must be included (before or after decimal)
+    # @return [String] decimal formatted
+    def self.to_decimal(decimal, decimal_format = '%8.2f', currency = nil, currency_before = true)
+      new_decimal = (decimal_format % decimal).strip
+      unless nil_or_empty?(currency)
+        return currency + new_decimal if currency_before
+        return new_decimal + currency
+      end
+      new_decimal
     end
-    new_decimal
-  end
 
-  # Check if the JSON passed is valid or not
-  # @param json [String] json to be verified
-  # @return [Boolean] is valid or not
-  def self.valid_json?(json)
-    return false if nil_or_empty? json
-    JSON.parse(json)
-    true
-  rescue
-    false
-  end
+    # Check if the JSON passed is valid or not
+    # @param json [String] json to be verified
+    # @return [Boolean] is valid or not
+    def self.valid_json?(json)
+      return false if nil_or_empty? json
+      JSON.parse(json)
+      true
+    rescue
+      false
+    end
 
-  # Wait until a condition passed happen
-  # @param condition [Proc] condition block to be validated
-  # @param condition_status [Boolean] condition status to be used to define if condition is satisfied or not
-  # @param timeout [Integer] timeout to wait for the condition happen
-  # @param sleep_for [Float] value used to call the condition block
-  def self.wait_until_condition(condition, condition_status = true, timeout = 20, sleep_for = 0.25)
-    Timeout.timeout(timeout) do
-      sleep sleep_for until condition.call == condition_status
+    # Wait until a condition passed happen
+    # @param condition [Proc] condition block to be validated
+    # @param condition_status [Boolean] condition status to be used to define if condition is satisfied or not
+    # @param timeout [Integer] timeout to wait for the condition happen
+    # @param sleep_for [Float] value used to call the condition block
+    def self.wait_until_condition(condition, condition_status = true, timeout = 20, sleep_for = 0.25)
+      Timeout.timeout(timeout) do
+        sleep sleep_for until condition.call == condition_status
+      end
     end
   end
 end

data/lib/helpers/time_helper.rb

@@ -1,29 +1,40 @@
 require 'time'
 
-class MegliHelper::TimeHelper
-  # Change timezone of a time passed
-  # @param time [Time][String] time to be changed
-  # @param timezone [String] timezone to be set in the time
-  # @return [Time] time with a new timezone
-  def self.change_timezone(time, timezone = '+00:00')
-    time = Time.parse(time) if time.class == String
-    time.localtime(timezone)
-  end
+module MegliHelper
+  class TimeHelper
+    # Change timezone of a time passed
+    # @param time [Time][String] time to be changed
+    # @param timezone [String] timezone to be set in the time
+    # @return [Time] time with a new timezone
+    def self.change_timezone(time, timezone = '+00:00')
+      time = Time.parse(time) if time.class == String
+      time.localtime(timezone)
+    end
+
+    # Format a time according to format passed by param
+    # @param time [Time | String] time to be formatted
+    # @param format [String] format used
+    # @return [String] time formatted
+    def self.fortmat_date(time, format)
+      time = Time.parse(time) if time.class == String
+      time.strftime(format)
+    end
 
-  # Get time now with addinional minutes and convert it to format passed
-  # @param format [Symbol] time format. Default value: :iso8601
-  # @param add_minutes [Integer] quantity of minutes to sum
-  # @return [String] time formatted
-  def self.get_time(format = :iso8601, add_minutes = 0)
-    return nil if add_minutes.nil?
-    add_minutes = add_minutes.to_i if add_minutes.class == String
-    time = Time.now + (60 * add_minutes)
-    unless format.nil?
-      time = time.iso8601 if format == :iso8601
-      time = time.utc if format == :utc
-      time = time.rfc822 if format == :rfc822 || format == :rfc2822
-      time = time.ctime if format == :ctime
+    # Get time now with addinional minutes and convert it to format passed
+    # @param format [Symbol] time format. Default value: :iso8601
+    # @param add_minutes [Integer] quantity of minutes to sum
+    # @return [String] time formatted
+    def self.get_time(format = :iso8601, add_minutes = 0)
+      return nil if add_minutes.nil?
+      add_minutes = add_minutes.to_i if add_minutes.class == String
+      time = Time.now + (60 * add_minutes)
+      unless format.nil?
+        time = time.iso8601 if format == :iso8601
+        time = time.utc if format == :utc
+        time = time.rfc822 if format == :rfc822 || format == :rfc2822
+        time = time.ctime if format == :ctime
+      end
+      time
     end
-    time
   end
 end

data/lib/megli_helper.rb

@@ -1,5 +1,8 @@
-class MegliHelper
-end
-
+require 'helpers/assert_helper'
 require 'helpers/common_helper'
 require 'helpers/time_helper'
+
+module MegliHelper
+  class << self
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: megli_common_helper
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.5
 platform: ruby
 authors:
 - Eduardo Gomes Heinen
@@ -16,6 +16,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/helpers/assert_helper.rb
 - lib/helpers/common_helper.rb
 - lib/helpers/time_helper.rb
 - lib/megli_helper.rb