class Faker::Number

Public Class Methods

between(legacy_from = NOT_GIVEN, legacy_to = NOT_GIVEN, from: 1.00, to: 5000.00) click to toggle source

Produces a number between two provided values. Boundaries are inclusive.

@param from [Integer] The lowest number to include. @param to [Integer] The highest number to include. @return [Integer]

@example

Faker::Number.between(from: 1, to: 10) #=> 7

@faker.version 1.0.0

# File lib/faker/default/number.rb, line 178
def between(legacy_from = NOT_GIVEN, legacy_to = NOT_GIVEN, from: 1.00, to: 5000.00)
  warn_for_deprecated_arguments do |keywords|
    keywords << :from if legacy_from != NOT_GIVEN
    keywords << :to if legacy_to != NOT_GIVEN
  end

  Faker::Base.rand_in_range(from, to)
end
decimal(legacy_l_digits = NOT_GIVEN, legacy_r_digits = NOT_GIVEN, l_digits: 5, r_digits: 2) click to toggle source

Produces a float.

@param l_digits [Integer] Number of digits that the generated decimal should have to the left of the decimal point. @param r_digits [Integer] Number of digits that the generated decimal should have to the right of the decimal point. @return [Float]

@example

Faker::Number.decimal(l_digits: 2) #=> 11.88
Faker::Number.decimal(l_digits: 3, r_digits: 3) #=> 181.843

@faker.version 1.0.0

# File lib/faker/default/number.rb, line 81
def decimal(legacy_l_digits = NOT_GIVEN, legacy_r_digits = NOT_GIVEN, l_digits: 5, r_digits: 2)
  warn_for_deprecated_arguments do |keywords|
    keywords << :l_digits if legacy_l_digits != NOT_GIVEN
    keywords << :r_digits if legacy_r_digits != NOT_GIVEN
  end

  l_d = number(digits: l_digits)
  r_d = if r_digits == 1
          generate(r_digits)
        else
          # Ensure the last digit is not zero
          # so it does not get truncated on converting to float
          generate(r_digits - 1).join + non_zero_digit.to_s
        end
  "#{l_d}.#{r_d}".to_f
end
decimal_part(legacy_digits = NOT_GIVEN, digits: 10) click to toggle source

Produce a number with a number of digits, preserves leading zeroes.

@param digits [Integer] Number of digits that the generated number should have. @return [String]

@example

Faker::Number.decimal_part(digits: 2) #=> "09"

@faker.version 1.0.0

# File lib/faker/default/number.rb, line 56
def decimal_part(legacy_digits = NOT_GIVEN, digits: 10)
  warn_for_deprecated_arguments do |keywords|
    keywords << :digits if legacy_digits != NOT_GIVEN
  end

  num = ''
  if digits > 1
    num = non_zero_digit
    digits -= 1
  end
  leading_zero_number(digits: digits) + num.to_s
end
digit() click to toggle source

Produces a single-digit integer.

@return [Integer]

@example

Faker::Number.digit #=> 1

@faker.version 1.0.0

# File lib/faker/default/number.rb, line 120
def digit
  rand(10)
end
hexadecimal(legacy_digits = NOT_GIVEN, digits: 6) click to toggle source

Produces a number in hexadecimal format.

@param digits [Integer] Number of digits in the he @return [String]

@example

Faker::Number.hexadecimal(digits: 3) #=> "e74"

@faker.version 1.0.0

# File lib/faker/default/number.rb, line 134
def hexadecimal(legacy_digits = NOT_GIVEN, digits: 6)
  warn_for_deprecated_arguments do |keywords|
    keywords << :digits if legacy_digits != NOT_GIVEN
  end

  hex = ''
  digits.times { hex += rand(15).to_s(16) }
  hex
end
leading_zero_number(legacy_digits = NOT_GIVEN, digits: 10) click to toggle source

Produce a random number with a leading zero.

@param digits [Integer] Number of digits that the generated number should have. @return [String]

@example

Faker::Number.leading_zero_number(digits: 10) #=> "0669336915"

@faker.version 1.0.0

# File lib/faker/default/number.rb, line 38
def leading_zero_number(legacy_digits = NOT_GIVEN, digits: 10)
  warn_for_deprecated_arguments do |keywords|
    keywords << :digits if legacy_digits != NOT_GIVEN
  end

  '0' + (2..digits).collect { digit }.join
end
negative(legacy_from = NOT_GIVEN, legacy_to = NOT_GIVEN, from: -5000.00, to: -1.00) click to toggle source

Produces a negative float.

@param from [Integer] The lower boundary. @param to [Integer] The higher boundary. @return [Float]

@example

Faker::Number.negative #=> -4480.042585669558

@faker.version 1.0.0

# File lib/faker/default/number.rb, line 238
def negative(legacy_from = NOT_GIVEN, legacy_to = NOT_GIVEN, from: -5000.00, to: -1.00)
  warn_for_deprecated_arguments do |keywords|
    keywords << :from if legacy_from != NOT_GIVEN
    keywords << :to if legacy_to != NOT_GIVEN
  end

  random_number = between(from: from, to: to)

  less_than_zero(random_number)
end
non_zero_digit() click to toggle source

Produces a non-zero single-digit integer.

@return [Integer]

@example

Faker::Number.non_zero_digit #=> 8

@faker.version 1.0.0

# File lib/faker/default/number.rb, line 107
def non_zero_digit
  rand(1..9)
end
normal(legacy_mean = NOT_GIVEN, legacy_standard_deviation = NOT_GIVEN, mean: 1, standard_deviation: 1) click to toggle source

Produces a float given a mean and standard deviation.

@param mean [Integer] @param standard_deviation [Integer, Float] @return [Float]

@example

Faker::Number.normal(mean: 50, standard_deviation: 3.5) #=> 47.14669604069156

@faker.version 1.0.0

# File lib/faker/default/number.rb, line 155
def normal(legacy_mean = NOT_GIVEN, legacy_standard_deviation = NOT_GIVEN, mean: 1, standard_deviation: 1)
  warn_for_deprecated_arguments do |keywords|
    keywords << :mean if legacy_mean != NOT_GIVEN
    keywords << :standard_deviation if legacy_standard_deviation != NOT_GIVEN
  end

  theta = 2 * Math::PI * rand
  rho = Math.sqrt(-2 * Math.log(1 - rand))
  scale = standard_deviation * rho
  mean + scale * Math.cos(theta)
end
number(legacy_digits = NOT_GIVEN, digits: 10) click to toggle source

Produce a random number.

@param digits [Integer] Number of digits that the generated number should have. @return [Integer]

@example

Faker::Number.number(digits: 10) #=> 1968353479

@faker.version 1.0.0

# File lib/faker/default/number.rb, line 16
def number(legacy_digits = NOT_GIVEN, digits: 10)
  warn_for_deprecated_arguments do |keywords|
    keywords << :digits if legacy_digits != NOT_GIVEN
  end

  return if digits < 1
  return rand(0..9).round if digits == 1

  # Ensure the first digit is not zero
  ([non_zero_digit] + generate(digits - 1)).join.to_i
end
positive(legacy_from = NOT_GIVEN, legacy_to = NOT_GIVEN, from: 1.00, to: 5000.00) click to toggle source

Produces a positive float.

@param from [Integer] The lower boundary. @param to [Integer] The higher boundary. @return [Float]

@example

Faker::Number.positive #=> 235.59238499107653

@faker.version 1.0.0

# File lib/faker/default/number.rb, line 216
def positive(legacy_from = NOT_GIVEN, legacy_to = NOT_GIVEN, from: 1.00, to: 5000.00)
  warn_for_deprecated_arguments do |keywords|
    keywords << :from if legacy_from != NOT_GIVEN
    keywords << :to if legacy_to != NOT_GIVEN
  end

  random_number = between(from: from, to: to)

  greater_than_zero(random_number)
end
within(legacy_range = NOT_GIVEN, range: 1.00..5000.00) click to toggle source

Produces a number within two provided values. Boundaries are inclusive or exclusive depending on the range passed.

@param range [Range] The range from which to generate a number. @return [Integer]

@example

Faker::Number.within(range: 1..10) #=> 7

@faker.version 1.0.0

# File lib/faker/default/number.rb, line 197
def within(legacy_range = NOT_GIVEN, range: 1.00..5000.00)
  warn_for_deprecated_arguments do |keywords|
    keywords << :range if legacy_range != NOT_GIVEN
  end

  between(from: range.min, to: range.max)
end

Private Class Methods

generate(count) click to toggle source
# File lib/faker/default/number.rb, line 251
def generate(count)
  return [] if count.zero?

  Array.new(count) { digit }
end
greater_than_zero(number) click to toggle source
# File lib/faker/default/number.rb, line 257
def greater_than_zero(number)
  should_be(number, :>)
end
less_than_zero(number) click to toggle source
# File lib/faker/default/number.rb, line 261
def less_than_zero(number)
  should_be(number, :<)
end
should_be(number, method_to_compare) click to toggle source
# File lib/faker/default/number.rb, line 265
def should_be(number, method_to_compare)
  if number.send(method_to_compare, 0)
    number
  else
    number * -1
  end
end