dater 0.2.3 → 0.2.4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dater (0.2.2)
+    dater (0.2.4)
 
 GEM
   remote: https://rubygems.org/

data/dater.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["roman.g.rodriguez@gmail.com"]
   spec.description   = %q{This gem aims to help you with dates treatment, specially in regression test where you have to use future dates}
   spec.summary       = %q{Converts periods of time expresed in literal mode to a formatted date from the date of today}
-  spec.homepage      = "http://gitroman.github.io/dater"
+  spec.homepage      = "http://romantestdev.github.io/dater/"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

data/lib/dater/version.rb

@@ -1,3 +1,3 @@
 module Dater
-  VERSION = "0.2.3"
+  VERSION = "0.2.4"
 end

data/lib/dater.rb

@@ -20,8 +20,8 @@ module Dater
 
 		# Creates a Dater::Resolver object
 		#
-		# Param [String] format = date format
-		# Param [String] lang = languaje for matching (en=english, es=spanish, pt=portuguese)
+		# @param [String] format = date format
+		# @param [String] lang = languaje for matching (en=english, es=spanish, pt=portuguese)
 		def initialize(format='%Y-%m-%d', lang="en")
 			@format=format
 			@lang=lang if ["en","es","pt"].include? lang
@@ -29,8 +29,8 @@ module Dater
 
 		# Convert the period of time passed as argument to the configured format
 		#
-		# Param [String] period = a period of time like "in 3 days" or "in 10 months" or "in 2 years". It could be a formatted date to convert to the wanted format
-		# Return [String] converted date to the configured format. If period is nil, returns date for tomorrow 
+		# @param [String] period = a period of time like "in 3 days" or "in 10 months" or "in 2 years". It could be a formatted date to convert to the wanted format
+		# @return [String] converted date to the configured format. If period is nil, returns date for tomorrow 
 		def for(period=nil)
 			return (Time.now).strftime(@format) if period.nil?
 			@date=case period.downcase 	
@@ -51,91 +51,175 @@ module Dater
 			return @date.strftime(@format)
 		end
 
+		# Spanish for 'for' method
+		#
+		#
 		def para(period)
 			self.for(period)
 		end
 
+		# Returns the time for today
+		#
+		# @param [Boolean] formatted = indicates if has to return today time in configured format
+		# @return [Time] today's time (formatted or not)
 		def today(formatted=true)
 			time=Time.now
 			time=time.strftime(@format) if formatted
 			time
 		end
 
+		# Spanish for today method
 		def hoy
 			self.today(true)
 		end
 
+		# Portuguese for today method
+		#
+		#
 		def hoje
 			self.today(true)
 		end
 
+		# Returns the time for yesterday.
+		# 
+		# @param [Boolean] formatted = indicates if has to return the value in configured format
+		# @return [Time] time for yesterday (formatted or not)
 		def yesterday(formatted=true)
-			time=Time.now-(3600*24)
-			time=time.strftime(@format) if formatted
+			time = one_day_diff(false)
+			time = time.strftime(@format) if formatted
 			time
 		end
 
+		# Spanish for yesterday method
+		#
+		#
 		def ayer
 			self.yesterday(true)
 		end
 
+		# Portuges for yesterday method
+		#
+		#
 		def ontem
 			self.yesterday(true)
 		end
 
+
+		# Returns time value for tomorrow. Formated or not according to formatted param
+		#
+		# @param [Boolean] formatted = if true time is returned with format
+		#
 		def tomorrow(formatted=true)
-			time=Time.now+(3600*24)
+			time = one_day_diff(true)
 			time=time.strftime(@format) if formatted
 			time
 		end
 
+		# Spanish for tomorrow method
+		#
+		# 
 		def mañana
 			self.tomorrow(true)
 		end
 
+		# Portugues for tomorrow method
+		#
+		#
 		def manhã
 			self.tomorrow(true)
 		end
 
+		# Return one day of difference. One day more or less according to plus param. It is used by tomorrow and yesterday methods
+		#
+		# @param [Boolean] plus = if true, return one day more, else one day before
+		# @return [Time]
+		def one_day_diff(plus=true)
+			time=Time.now
+			diff = DICTIONARY[:day][:mult]
+			plus ? time+diff : time-diff
+		end
+
 	private
 
+		# Scans if period has day word
+		# 
+		# @param [String] period = a string to convert to configured format
+		# @return [Boolean] true if perdiod contains the word day
+		def is_day?(period)
+			true if period.scan(DICTIONARY[:day][@lang]).size > 0
+		end
+
+		# Multiplication factor for a day
+		# 
+		# @param [String] period = the string to convert to
+		# @return [Fixnum] multiplication factor for a day
 		def day_mult(period)
-			period.scan(DICTIONARY[:day][@lang]).size > 0 ? DICTIONARY[:day][:mult] : nil
+			DICTIONARY[:day][:mult] if is_day?(period)			 
 		end
 
+		# Scans if period has week word
+		# 
+		# @param [String] period = a string to convert to configured format
+		# @return [Boolean] true if perdiod contains the word week
+		def is_week?(period)
+			true if period.scan(DICTIONARY[:week][@lang]).size > 0
+		end
+
+		# Multiplication factor for a week
+		# 
+		# @param [String] period = the string to convert to
+		# @return [Fixnum] multiplication factor for a week
 		def week_mult(period)
-			period.scan(DICTIONARY[:week][@lang]).size > 0 ? DICTIONARY[:week][:mult] : nil
+			DICTIONARY[:week][:mult] if is_week?(period)
 		end
 
+		# Scans if period has week month
+		# 
+		# @param [String] period = a string to convert to configured format
+		# @return [Boolean] true if perdiod contains the word month
+		def is_month?(period)
+			true if period.scan(DICTIONARY[:month][@lang]).size > 0
+		end
+		
+		# Multiplication factor for a month
+		# 
+		# @param [String] period = the string to convert to
+		# @return [Fixnum] multiplication factor for a month
 		def month_mult(period)
-			period.scan(DICTIONARY[:month][@lang]).size > 0 ? DICTIONARY[:month][:mult] : nil
+			DICTIONARY[:month][:mult] if is_month?(period)
+		end
+
+		# Scans if period has week year
+		# 
+		# @param [String] period = a string to convert to configured format
+		# @return [Boolean] true if perdiod contains the word year
+		def is_year?(period)
+			true if period.scan(DICTIONARY[:year][@lang]).size > 0
 		end
 
+		# Multiplication factor for a year
+		# 
+		# @param [String] period = the string to convert to
+		# @return [Fixnum] multiplication factor for a year
 		def year_mult(period)
-			period.scan(DICTIONARY[:year][@lang]).size > 0 ? DICTIONARY[:year][:mult] : nil
+			DICTIONARY[:year][:mult] if is_year?(period)
 		end
 
+
 		# Set true the matched keyword in a given string
 		# 
-		# Param [String] period = the period of time expressed in a literal way
-		# Param [String] lang = the languaje to eval
-		# Return [Hash] times
+		# @param [String] period = the period of time expressed in a literal way
+		# @param [String] lang = the languaje to eval
+		# @return [Hash] times
 		def multiply_by(period)
-
 			return day_mult(period) || week_mult(period) || month_mult(period) || year_mult(period) || 1
-			# mult = 1 
-			# mult = DICTIONARY[:day][:mult] if day_mult(period)
-			# mult = DICTIONARY[:week][:mult] if week_mult(period)
-			# mult = DICTIONARY[:month][:mult] if month_mult(period)
-			# mult = DICTIONARY[:year][:mult] if year_mult(period)
-			# return mult
 		end
 
 		
 		# Return the Time object according to the splitted date in the given array  
 		# |
-		# Param [Array] date = date splitted
-		# Return [Time] 
+		# @param [Array] date = date splitted
+		# @return [Time] 
 		def time_from_date(date)
 			numbers=date.scan(/\d+/).map!{|i| i.to_i}
 			day=numbers[2-numbers.index(numbers.max)]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dater
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-08 00:00:00.000000000 Z
+date: 2013-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -60,7 +60,7 @@ files:
 - dater.gemspec
 - lib/dater.rb
 - lib/dater/version.rb
-homepage: http://gitroman.github.io/dater
+homepage: http://romantestdev.github.io/dater/
 licenses:
 - MIT
 post_install_message: