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)

Namespace

Class

Methods

Constants

PARTS = [:years, :months, :weeks, :days, :hours, :minutes, :seconds].freeze
PARTS_IN_SECONDS = { seconds: 1, minutes: SECONDS_PER_MINUTE, hours: SECONDS_PER_HOUR, days: SECONDS_PER_DAY, weeks: SECONDS_PER_WEEK, months: SECONDS_PER_MONTH, years: SECONDS_PER_YEAR }.freeze
SECONDS_PER_DAY = 86400
SECONDS_PER_HOUR = 3600
SECONDS_PER_MINUTE = 60
SECONDS_PER_MONTH = 2629746
SECONDS_PER_WEEK = 604800
SECONDS_PER_YEAR = 31556952

Attributes

[RW] parts
[RW] value

Class Public methods

build(value)

Creates a new Duration from a seconds value that is converted to the individual parts:

ActiveSupport::Duration.build(31556952).parts # => {:years=>1}
ActiveSupport::Duration.build(2716146).parts  # => {:months=>1, :days=>1}
📝 Source code 
# File activesupport/lib/active_support/duration.rb, line 184
      def build(value)
        parts = {}
        remainder = value.round(9)

        PARTS.each do |part|
          unless part == :seconds
            part_in_seconds = PARTS_IN_SECONDS[part]
            parts[part] = remainder.div(part_in_seconds)
            remainder %= part_in_seconds
          end
        end unless value == 0

        parts[:seconds] = remainder

        new(value, parts)
      end
🔎 See on GitHub

parse(iso8601duration)

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.

📝 Source code 
# File activesupport/lib/active_support/duration.rb, line 139
      def parse(iso8601duration)
        parts = ISO8601Parser.new(iso8601duration).parse!
        new(calculate_total_seconds(parts), parts)
      end
🔎 See on GitHub

Instance Public methods

%(other)

Returns the modulo of this Duration by another Duration or Numeric. Numeric values are treated as seconds.

📝 Source code 
# File activesupport/lib/active_support/duration.rb, line 281
    def %(other)
      if Duration === other || Scalar === other
        Duration.build(value % other.value)
      elsif Numeric === other
        Duration.build(value % other)
      else
        raise_type_error(other)
      end
    end
🔎 See on GitHub

*(other)

Multiplies this Duration by a Numeric and returns a new Duration.

📝 Source code 
# File activesupport/lib/active_support/duration.rb, line 256
    def *(other)
      if Scalar === other || Duration === other
        Duration.new(value * other.value, parts.map { |type, number| [type, number * other.value] })
      elsif Numeric === other
        Duration.new(value * other, parts.map { |type, number| [type, number * other] })
      else
        raise_type_error(other)
      end
    end
🔎 See on GitHub

+(other)

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

📝 Source code 
# File activesupport/lib/active_support/duration.rb, line 236
    def +(other)
      if Duration === other
        parts = @parts.dup
        other.parts.each do |(key, value)|
          parts[key] += value
        end
        Duration.new(value + other.value, parts)
      else
        seconds = @parts[:seconds] + other
        Duration.new(value + other, @parts.merge(seconds: seconds))
      end
    end
🔎 See on GitHub

-(other)

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

📝 Source code 
# File activesupport/lib/active_support/duration.rb, line 251
    def -(other)
      self + (-other)
    end
🔎 See on GitHub

/(other)

Divides this Duration by a Numeric and returns a new Duration.

📝 Source code 
# File activesupport/lib/active_support/duration.rb, line 267
    def /(other)
      if Scalar === other
        Duration.new(value / other.value, parts.map { |type, number| [type, number / other.value] })
      elsif Duration === other
        value / other.value
      elsif Numeric === other
        Duration.new(value / other, parts.map { |type, number| [type, number / other] })
      else
        raise_type_error(other)
      end
    end
🔎 See on GitHub

<=>(other)

Compares one Duration with another or a Numeric to this Duration. Numeric values are treated as seconds.

📝 Source code 
# File activesupport/lib/active_support/duration.rb, line 226
    def <=>(other)
      if Duration === other
        value <=> other.value
      elsif Numeric === other
        value <=> other
      end
    end
🔎 See on GitHub

==(other)

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

📝 Source code 
# File activesupport/lib/active_support/duration.rb, line 306
    def ==(other)
      if Duration === other
        other.value == value
      else
        other == value
      end
    end
🔎 See on GitHub

after(time = ::Time.current)

Alias for: since

ago(time = ::Time.current)

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

Also aliased as: until, before
📝 Source code 
# File activesupport/lib/active_support/duration.rb, line 366
    def ago(time = ::Time.current)
      sum(-1, time)
    end
🔎 See on GitHub

before(time = ::Time.current)

Alias for: ago

eql?(other)

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

📝 Source code 
# File activesupport/lib/active_support/duration.rb, line 348
    def eql?(other)
      Duration === other && other.value.eql?(value)
    end
🔎 See on GitHub

from_now(time = ::Time.current)

Alias for: since

hash()

📝 Source code 
# File activesupport/lib/active_support/duration.rb, line 352
    def hash
      @value.hash
    end
🔎 See on GitHub

iso8601(precision: nil)

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

📝 Source code 
# File activesupport/lib/active_support/duration.rb, line 396
    def iso8601(precision: nil)
      ISO8601Serializer.new(self, precision: precision).serialize
    end
🔎 See on GitHub

since(time = ::Time.current)

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

Also aliased as: from_now, after
📝 Source code 
# File activesupport/lib/active_support/duration.rb, line 358
    def since(time = ::Time.current)
      sum(1, time)
    end
🔎 See on GitHub

to_i()

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 1/12 of year and years are 365.2425 days:

# equivalent to (1.year / 12).to_i
1.month.to_i    # => 2629746

# equivalent to 365.2425.days.to_i
1.year.to_i     # => 31556952

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

📝 Source code 
# File activesupport/lib/active_support/duration.rb, line 342
    def to_i
      @value.to_i
    end
🔎 See on GitHub

to_s()

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

1.day.to_s # => "86400"
📝 Source code 
# File activesupport/lib/active_support/duration.rb, line 318
    def to_s
      @value.to_s
    end
🔎 See on GitHub

until(time = ::Time.current)

Alias for: ago