kotovalexarian-likes-github/rails--rails
1
0
Fork 0
mirror of https://github.com/rails/rails.git synced 2022-11-09 12:12:34 -05:00
Code Releases Activity

Simplify API documentation of methods that return a Duration

Browse source 
Related to #30972
This commit is contained in:
bogdanvlviv 2017-10-24 21:03:35 +00:00
parent 453ab1758b
commit 08a177ee63
No known key found for this signature in database
GPG key ID: E4ACD76A6DB6DFDD
2 changed files with 10 additions and 33 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
activesupport/lib/active_support/core_ext/integer/time.rb
View file

@ -4,28 +4,17 @@ require "active_support/duration"
require "active_support/core_ext/numeric/time"
class Integer
# Enables the use of time calculations and declarations, like <tt>45.minutes +
# 2.hours + 4.years</tt>.
# Returns a Duration instance matching the number of months provided.
#
# These methods use Time#advance for precise date calculations when using
# <tt>from_now</tt>, +ago+, etc. as well as adding or subtracting their
# results from a Time object.
#
# # equivalent to Time.now.advance(months: 1)
# 1.month.from_now
#
# # equivalent to Time.now.advance(years: 2)
# 2.years.from_now
#
# # equivalent to Time.now.advance(months: 4, years: 5)
# (4.months + 5.years).from_now
#
# For other durations, check the extensions to Numeric.
# 2.months # => 2 months
def months
ActiveSupport::Duration.months(self)
end
alias :month :months
# Returns a Duration instance matching the number of years provided.
#
# 2.years # => 2 years
def years
ActiveSupport::Duration.years(self)
end

22
activesupport/lib/active_support/core_ext/numeric/time.rb
View file

@ -7,21 +7,9 @@ require "active_support/core_ext/date/calculations"
require "active_support/core_ext/date/acts_like"
class Numeric
# Enables the use of time calculations and declarations, like 45.minutes + 2.hours + 4.weeks.
# Returns a Duration instance matching the number of seconds provided.
#
# These methods use Time#advance for precise date calculations when using from_now, ago, etc.
# as well as adding or subtracting their results from a Time object. For example:
#
# # equivalent to Time.current.advance(days: 1)
# 1.month.from_now
#
# # equivalent to Time.current.advance(weeks: 2)
# 2.weeks.from_now
#
# # equivalent to Time.current.advance(days: 4, weeks: 5)
# (4.days + 5.weeks).from_now
#
# For other durations, check the extensions to Integer.
# 2.seconds # => 2 seconds
def seconds
ActiveSupport::Duration.seconds(self)
end
@ -68,10 +56,10 @@ class Numeric
alias :fortnight :fortnights
# Returns the number of milliseconds equivalent to the seconds provided.
# Used with the standard time durations, like 1.hour.in_milliseconds --
# so we can feed them to JavaScript functions like getTime().
# Used with the standard time durations.
#
# 2.in_milliseconds # => 2_000
# 2.in_milliseconds # => 2000
# 1.hour.in_milliseconds # => 3600000
def in_milliseconds
self * 1000
end