Docs4dev
Docs
rails / 5.0 / activesupport / duration.html

class ActiveSupport::Duration

Parent:
Object

Provides accurate date and time measurements using Date#advance and Time#advance, respectively. It mainly supports the methods on Numeric.

1.month.ago       # equivalent to Time.now.advance(months: -1)

Constants

PARTS_IN_SECONDS
SECONDS_PER_DAY
SECONDS_PER_HOUR
SECONDS_PER_MINUTE
SECONDS_PER_MONTH
SECONDS_PER_WEEK
SECONDS_PER_YEAR

Attributes

parts[RW]
value[RW]

Public Class Methods

parse(iso8601duration) Show source 
# File activesupport/lib/active_support/duration.rb, line 38
def parse(iso8601duration)
  parts = ISO8601Parser.new(iso8601duration).parse!
  new(calculate_total_seconds(parts), parts)
end

Creates a new Duration from string formatted according to ISO 8601 Duration.

See ISO 8601 for more information. This method allows negative parts to be present in pattern. If invalid string is provided, it will raise ActiveSupport::Duration::ISO8601Parser::ParsingError.

Public Instance Methods

+(other) Show source 
# File activesupport/lib/active_support/duration.rb, line 92
def +(other)
  if Duration === other
    Duration.new(value + other.value, @parts + other.parts)
  else
    Duration.new(value + other, @parts + [[:seconds, other]])
  end
end

Adds another Duration or a Numeric to this Duration. Numeric values are treated as seconds.

-(other) Show source 
# File activesupport/lib/active_support/duration.rb, line 102
def -(other)
  self + (-other)
end

Subtracts another Duration or a Numeric from this Duration. Numeric values are treated as seconds.

==(other) Show source 
# File activesupport/lib/active_support/duration.rb, line 121
def ==(other)
  if Duration === other
    other.value == value
  else
    other == value
  end
end

Returns true if other is also a Duration instance with the same value, or if other == value.

ago(time = ::Time.current) Show source 
# File activesupport/lib/active_support/duration.rb, line 180
def ago(time = ::Time.current)
  sum(-1, time)
end

Calculates a new Time or Date that is as far in the past as this Duration represents.

Also aliased as: until
eql?(other) Show source 
# File activesupport/lib/active_support/duration.rb, line 163
def eql?(other)
  Duration === other && other.value.eql?(value)
end

Returns true if other is also a Duration instance, which has the same parts as this one.

from_now(time = ::Time.current)
Alias for: since
hash() Show source 
# File activesupport/lib/active_support/duration.rb, line 167
def hash
  @value.hash
end
iso8601(precision: nil) Show source 
# File activesupport/lib/active_support/duration.rb, line 203
def iso8601(precision: nil)
  ISO8601Serializer.new(self, precision: precision).serialize
end

Build ISO 8601 Duration string for this duration. The precision parameter can be used to limit seconds' precision of duration.

since(time = ::Time.current) Show source 
# File activesupport/lib/active_support/duration.rb, line 173
def since(time = ::Time.current)
  sum(1, time)
end

Calculates a new Time or Date that is as far in the future as this Duration represents.

Also aliased as: from_now
to_i() Show source 
# File activesupport/lib/active_support/duration.rb, line 157
def to_i
  @value.to_i
end

Returns the number of seconds that this Duration represents.

1.minute.to_i   # => 60
1.hour.to_i     # => 3600
1.day.to_i      # => 86400

Note that this conversion makes some assumptions about the duration of some periods, e.g. months are always 30 days and years are 365.25 days:

# equivalent to 30.days.to_i
1.month.to_i    # => 2592000

# equivalent to 365.25.days.to_i
1.year.to_i     # => 31557600

In such cases, Ruby's core Date and Time should be used for precision date and time arithmetic.

to_s() Show source 
# File activesupport/lib/active_support/duration.rb, line 133
def to_s
  @value.to_s
end

Returns the amount of seconds a duration covers as a string. For more information check #to_i method.

1.day.to_s # => "86400"
until(time = ::Time.current)
Alias for: ago

© 2004–2018 David Heinemeier Hansson
Licensed under the MIT License.