Class: ActiveSupport::Duration

Inherits:
ProxyObject show all
Defined in:
activesupport/lib/active_support/duration.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)

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ProxyObject

#raise

Constructor Details

#initialize(value, parts) ⇒ Duration

:nodoc:


13
14
15
# File 'activesupport/lib/active_support/duration.rb', line 13

def initialize(value, parts) #:nodoc:
  @value, @parts = value, parts
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

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

:nodoc:


104
105
106
# File 'activesupport/lib/active_support/duration.rb', line 104

def method_missing(method, *args, &block) #:nodoc:
  value.send(method, *args, &block)
end

Instance Attribute Details

#partsObject

Returns the value of attribute parts


11
12
13
# File 'activesupport/lib/active_support/duration.rb', line 11

def parts
  @parts
end

#valueObject

Returns the value of attribute value


11
12
13
# File 'activesupport/lib/active_support/duration.rb', line 11

def value
  @value
end

Class Method Details

.===(other) ⇒ Object

:nodoc:


52
53
54
55
56
# File 'activesupport/lib/active_support/duration.rb', line 52

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

Instance Method Details

#+(other) ⇒ Object

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


19
20
21
22
23
24
25
# File 'activesupport/lib/active_support/duration.rb', line 19

def +(other)
  if Duration === other
    Duration.new(value + other.value, @parts + other.parts)
  else
    Duration.new(value + other, @parts + [[:seconds, other]])
  end
end

#-(other) ⇒ Object

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


29
30
31
# File 'activesupport/lib/active_support/duration.rb', line 29

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

#[email protected]Object

:nodoc:


33
34
35
# File 'activesupport/lib/active_support/duration.rb', line 33

def [email protected] #:nodoc:
  Duration.new(-value, parts.map { |type,number| [type, -number] })
end

#==(other) ⇒ Object

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


44
45
46
47
48
49
50
# File 'activesupport/lib/active_support/duration.rb', line 44

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

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

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


67
68
69
# File 'activesupport/lib/active_support/duration.rb', line 67

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

#as_json(options = nil) ⇒ Object

:nodoc:


82
83
84
# File 'activesupport/lib/active_support/duration.rb', line 82

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

#inspectObject

:nodoc:


72
73
74
75
76
77
78
79
80
# File 'activesupport/lib/active_support/duration.rb', line 72

def inspect #:nodoc:
  consolidated = parts.inject(::Hash.new(0)) { |h,(l,r)| h[l] += r; h }
  parts = [:years, :months, :days, :minutes, :seconds].map do |length|
    n = consolidated[length]
    "#{n} #{n == 1 ? length.to_s.singularize : length.to_s}" if n.nonzero?
  end.compact
  parts = ["0 seconds"] if parts.empty?
  parts.to_sentence(:locale => :en)
end

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

:nodoc:

Returns:

  • (Boolean)

37
38
39
# File 'activesupport/lib/active_support/duration.rb', line 37

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

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

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


60
61
62
# File 'activesupport/lib/active_support/duration.rb', line 60

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