Class: Integer

Inherits:
Object show all
Defined in:
activesupport/lib/active_support/core_ext/integer/time.rb,
activesupport/lib/active_support/core_ext/integer/multiple.rb,
activesupport/lib/active_support/core_ext/integer/inflections.rb

Instance Method Summary (collapse)

Instance Method Details

- (Object) months Also known as: month

Enables the use of time calculations and declarations, like 45.minutes + 2.hours + 4.years.

These methods use Time#advance for precise date calculations when using from_now, ago, etc. as well as adding or subtracting their results from a Time object. For example: 

  # equivalent to Time.now.advance(:months => 1)
  1.month.from_now

  # equivalent to Time.now.advance(:years => 2)
  2.years.from_now

  # equivalent to Time.now.advance(:months => 4, :years => 5)
  (4.months + 5.years).from_now

While these methods provide precise calculation when used as in the examples above, care should be taken to note that this is not true if the result of `months’, `years’, etc is converted before use: 

  # equivalent to 30.days.to_i.from_now
  1.month.to_i.from_now

  # equivalent to 365.25.days.to_f.from_now
  1.year.to_f.from_now

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



30
31
32
 
# File 'activesupport/lib/active_support/core_ext/integer/time.rb', line 30

def months
  ActiveSupport::Duration.new(self * 30.days, [[:months, self]])
end

- (Boolean) multiple_of?(number)

Check whether the integer is evenly divisible by the argument.

Returns:

  • (Boolean) 


3
4
5
 
# File 'activesupport/lib/active_support/core_ext/integer/multiple.rb', line 3

def multiple_of?(number)
  number != 0 ? self % number == 0 : zero?
end

- (Object) ordinalize

Ordinalize turns a number into an ordinal string used to denote the position in an ordered sequence such as 1st, 2nd, 3rd, 4th. 

  1.ordinalize    # => "1st"
  2.ordinalize    # => "2nd"
  1002.ordinalize # => "1002nd"
  1003.ordinalize # => "1003rd"


11
12
13
 
# File 'activesupport/lib/active_support/core_ext/integer/inflections.rb', line 11

def ordinalize
  ActiveSupport::Inflector.ordinalize(self)
end

- (Object) years Also known as: year 



35
36
37
 
# File 'activesupport/lib/active_support/core_ext/integer/time.rb', line 35

def years
  ActiveSupport::Duration.new(self * 365.25.days, [[:years, self]])
end