W3cubDocs

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

EPOCH

Attributes

parts[RW]

value[RW]

Public Class Methods

parse(iso8601duration) Show source

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.

# File activesupport/lib/active_support/duration.rb, line 143
def self.parse(iso8601duration)
  parts = ISO8601Parser.new(iso8601duration).parse!
  new(EPOCH.advance(parts) - EPOCH, parts)
end

Public Instance Methods

+(other) Show source

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

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

-(other) Show source

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

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

==(other) Show source

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

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

ago(time = ::Time.current) Show source

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

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

Also aliased as: until

eql?(other) Show source

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

# File activesupport/lib/active_support/duration.rb, line 94
def eql?(other)
  Duration === other && other.value.eql?(value)
end

from_now(time = ::Time.current)

Alias for: since

hash() Show source

# File activesupport/lib/active_support/duration.rb, line 98
def hash
  @value.hash
end

iso8601(precision: nil) Show source

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

# File activesupport/lib/active_support/duration.rb, line 150
def iso8601(precision: nil)
  ISO8601Serializer.new(self, precision: precision).serialize
end

since(time = ::Time.current) Show source

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

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

Also aliased as: from_now

to_i() Show source

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.

# File activesupport/lib/active_support/duration.rb, line 88
def to_i
  @value.to_i
end

to_s() Show source

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

1.day.to_s # => "86400"

# File activesupport/lib/active_support/duration.rb, line 64
def to_s
  @value.to_s
end

until(time = ::Time.current)

Alias for: ago