Class: ActiveSupport::Duration

Inherits:
Object
  • Object
show all
Defined in:
activesupport/lib/active_support/duration.rb,
activesupport/lib/active_support/duration/iso8601_parser.rb,
activesupport/lib/active_support/duration/iso8601_serializer.rb

Overview

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)

Defined Under Namespace

Classes: ISO8601Parser, ISO8601Serializer, Scalar

Constant Summary collapse

SECONDS_PER_MINUTE =
60
SECONDS_PER_HOUR =
3600
SECONDS_PER_DAY =
86400
SECONDS_PER_WEEK =
604800
SECONDS_PER_MONTH =

1/12 of a gregorian year

2629746
SECONDS_PER_YEAR =

length of a gregorian year (365.2425 days)

31556952
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
PARTS =
[:years, :months, :weeks, :days, :hours, :minutes, :seconds].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(value, parts) ⇒ Duration

:nodoc:


212
213
214
215
# File 'activesupport/lib/active_support/duration.rb', line 212

def initialize(value, parts) #:nodoc:
  @value, @parts = value, parts
  @parts.reject! { |k, v| v.zero? } unless value == 0
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(method, *args, &block) ⇒ Object (private)


433
434
435
# File 'activesupport/lib/active_support/duration.rb', line 433

def method_missing(method, *args, &block)
  value.public_send(method, *args, &block)
end

Instance Attribute Details

#partsObject

Returns the value of attribute parts


127
128
129
# File 'activesupport/lib/active_support/duration.rb', line 127

def parts
  @parts
end

#valueObject

Returns the value of attribute value


127
128
129
# File 'activesupport/lib/active_support/duration.rb', line 127

def value
  @value
end

Class Method Details

.===(other) ⇒ Object

:nodoc:


143
144
145
146
147
# File 'activesupport/lib/active_support/duration.rb', line 143

def ===(other) #:nodoc:
  other.is_a?(Duration)
rescue ::NoMethodError
  false
end

.build(value) ⇒ Object

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}

183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
# File 'activesupport/lib/active_support/duration.rb', line 183

def build(value)
  unless value.is_a?(::Numeric)
    raise TypeError, "can't build an #{self.name} from a #{value.class.name}"
  end

  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

.days(value) ⇒ Object

:nodoc:


161
162
163
# File 'activesupport/lib/active_support/duration.rb', line 161

def days(value) #:nodoc:
  new(value * SECONDS_PER_DAY, days: value)
end

.hours(value) ⇒ Object

:nodoc:


157
158
159
# File 'activesupport/lib/active_support/duration.rb', line 157

def hours(value) #:nodoc:
  new(value * SECONDS_PER_HOUR, hours: value)
end

.minutes(value) ⇒ Object

:nodoc:


153
154
155
# File 'activesupport/lib/active_support/duration.rb', line 153

def minutes(value) #:nodoc:
  new(value * SECONDS_PER_MINUTE, minutes: value)
end

.months(value) ⇒ Object

:nodoc:


169
170
171
# File 'activesupport/lib/active_support/duration.rb', line 169

def months(value) #:nodoc:
  new(value * SECONDS_PER_MONTH, months: value)
end

.parse(iso8601duration) ⇒ Object

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.


138
139
140
141
# File 'activesupport/lib/active_support/duration.rb', line 138

def parse(iso8601duration)
  parts = ISO8601Parser.new(iso8601duration).parse!
  new(calculate_total_seconds(parts), parts)
end

.seconds(value) ⇒ Object

:nodoc:


149
150
151
# File 'activesupport/lib/active_support/duration.rb', line 149

def seconds(value) #:nodoc:
  new(value, seconds: value)
end

.weeks(value) ⇒ Object

:nodoc:


165
166
167
# File 'activesupport/lib/active_support/duration.rb', line 165

def weeks(value) #:nodoc:
  new(value * SECONDS_PER_WEEK, weeks: value)
end

.years(value) ⇒ Object

:nodoc:


173
174
175
# File 'activesupport/lib/active_support/duration.rb', line 173

def years(value) #:nodoc:
  new(value * SECONDS_PER_YEAR, years: value)
end

Instance Method Details

#%(other) ⇒ Object

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


284
285
286
287
288
289
290
291
292
# File 'activesupport/lib/active_support/duration.rb', line 284

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

#*(other) ⇒ Object

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


259
260
261
262
263
264
265
266
267
# File 'activesupport/lib/active_support/duration.rb', line 259

def *(other)
  if Scalar === other || Duration === other
    Duration.new(value * other.value, parts.transform_values { |number| number * other.value })
  elsif Numeric === other
    Duration.new(value * other, parts.transform_values { |number| number * other })
  else
    raise_type_error(other)
  end
end

#+(other) ⇒ Object

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


240
241
242
243
244
245
246
247
248
249
250
# File 'activesupport/lib/active_support/duration.rb', line 240

def +(other)
  if Duration === other
    parts = @parts.merge(other.parts) do |_key, value, other_value|
      value + other_value
    end
    Duration.new(value + other.value, parts)
  else
    seconds = @parts.fetch(:seconds, 0) + other
    Duration.new(value + other, @parts.merge(seconds: seconds))
  end
end

#[email protected]Object

:nodoc:


298
299
300
# File 'activesupport/lib/active_support/duration.rb', line 298

def [email protected] #:nodoc:
  self
end

#-(other) ⇒ Object

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


254
255
256
# File 'activesupport/lib/active_support/duration.rb', line 254

def -(other)
  self + (-other)
end

#[email protected]Object

:nodoc:


294
295
296
# File 'activesupport/lib/active_support/duration.rb', line 294

def [email protected] #:nodoc:
  Duration.new(-value, parts.transform_values(&:[email protected]))
end

#/(other) ⇒ Object

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


270
271
272
273
274
275
276
277
278
279
280
# File 'activesupport/lib/active_support/duration.rb', line 270

def /(other)
  if Scalar === other
    Duration.new(value / other.value, parts.transform_values { |number| number / other.value })
  elsif Duration === other
    value / other.value
  elsif Numeric === other
    Duration.new(value / other, parts.transform_values { |number| number / other })
  else
    raise_type_error(other)
  end
end

#<=>(other) ⇒ Object

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


230
231
232
233
234
235
236
# File 'activesupport/lib/active_support/duration.rb', line 230

def <=>(other)
  if Duration === other
    value <=> other.value
  elsif Numeric === other
    value <=> other
  end
end

#==(other) ⇒ Object

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


313
314
315
316
317
318
319
# File 'activesupport/lib/active_support/duration.rb', line 313

def ==(other)
  if Duration === other
    other.value == value
  else
    other == value
  end
end

#ago(time = ::Time.current) ⇒ Object Also known as: until, before

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


373
374
375
# File 'activesupport/lib/active_support/duration.rb', line 373

def ago(time = ::Time.current)
  sum(-1, time)
end

#as_json(options = nil) ⇒ Object

:nodoc:


388
389
390
# File 'activesupport/lib/active_support/duration.rb', line 388

def as_json(options = nil) #:nodoc:
  to_i
end

#coerce(other) ⇒ Object

:nodoc:


217
218
219
220
221
222
223
224
225
226
# File 'activesupport/lib/active_support/duration.rb', line 217

def coerce(other) #:nodoc:
  case other
  when Scalar
    [other, self]
  when Duration
    [Scalar.new(other.value), self]
  else
    [Scalar.new(other), self]
  end
end

#encode_with(coder) ⇒ Object

:nodoc:


396
397
398
# File 'activesupport/lib/active_support/duration.rb', line 396

def encode_with(coder) #:nodoc:
  coder.map = { "value" => @value, "parts" => @parts }
end

#eql?(other) ⇒ Boolean

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

Returns:

  • (Boolean)

355
356
357
# File 'activesupport/lib/active_support/duration.rb', line 355

def eql?(other)
  Duration === other && other.value.eql?(value)
end

#hashObject


359
360
361
# File 'activesupport/lib/active_support/duration.rb', line 359

def hash
  @value.hash
end

#init_with(coder) ⇒ Object

:nodoc:


392
393
394
# File 'activesupport/lib/active_support/duration.rb', line 392

def init_with(coder) #:nodoc:
  initialize(coder["value"], coder["parts"])
end

#inspectObject

:nodoc:


379
380
381
382
383
384
385
386
# File 'activesupport/lib/active_support/duration.rb', line 379

def inspect #:nodoc:
  return "#{value} seconds" if parts.empty?

  parts.
    sort_by { |unit,  _ | PARTS.index(unit) }.
    map     { |unit, val| "#{val} #{val == 1 ? unit.to_s.chop : unit.to_s}" }.
    to_sentence(locale: ::I18n.default_locale)
end

#instance_of?(klass) ⇒ Boolean

:nodoc:

Returns:

  • (Boolean)

307
308
309
# File 'activesupport/lib/active_support/duration.rb', line 307

def instance_of?(klass) # :nodoc:
  Duration == klass || value.instance_of?(klass)
end

#is_a?(klass) ⇒ Boolean Also known as: kind_of?

:nodoc:

Returns:

  • (Boolean)

302
303
304
# File 'activesupport/lib/active_support/duration.rb', line 302

def is_a?(klass) #:nodoc:
  Duration == klass || value.is_a?(klass)
end

#iso8601(precision: nil) ⇒ Object

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


402
403
404
# File 'activesupport/lib/active_support/duration.rb', line 402

def iso8601(precision: nil)
  ISO8601Serializer.new(self, precision: precision).serialize
end

#since(time = ::Time.current) ⇒ Object Also known as: from_now, after

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


365
366
367
# File 'activesupport/lib/active_support/duration.rb', line 365

def since(time = ::Time.current)
  sum(1, time)
end

#to_iObject

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.


349
350
351
# File 'activesupport/lib/active_support/duration.rb', line 349

def to_i
  @value.to_i
end

#to_sObject

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

1.day.to_s # => "86400"

325
326
327
# File 'activesupport/lib/active_support/duration.rb', line 325

def to_s
  @value.to_s
end