Spec-Zone.ru › Ruby 3.2

модуль Random::Formatter

Форматировщик случайных чисел.

Форматирует сгенерированные случайные числа различными способами. Когда 'random/formatter' требуется, несколько методов добавляются в пустой основной модуль Random::Formatter, делая их доступными как методы экземпляра и модуля класса Random.

Стандартная библиотека SecureRandom также расширяется с помощью модуля, и описанные ниже методы доступны в нём как методы модуля.

Примеры

Генерация случайных шестнадцатеричных строк:

require 'random/formatter'

prng = Random.new
prng.hex(10) #=> "52750b30ffbc7de3b362"
prng.hex(10) #=> "92b15d6c8dc4beb5f559"
prng.hex(13) #=> "39b290146bea6ce975c37cfc23"
# or just
Random.hex #=> "1aed0c631e41be7f77365415541052ee"

Генерация случайных строк base64:

prng.base64(10) #=> "EcmTPZwWRAozdA=="
prng.base64(10) #=> "KO1nIU+p9DKxGg=="
prng.base64(12) #=> "7kJSM/MzBJI+75j8"
Random.base64(4) #=> "bsQ3fQ=="

Генерация случайных двоичных строк:

prng.random_bytes(10) #=> "\016\t{\370g\310pbr\301"
prng.random_bytes(10) #=> "\323U\030TO\234\357\020\a\337"
Random.random_bytes(6) #=> "\xA1\xE6Lr\xC43"

Генерация буквенно-цифровых строк:

prng.alphanumeric(10) #=> "S8baxMJnPl"
prng.alphanumeric(10) #=> "aOxAg8BAJe"
Random.alphanumeric #=> "TmP9OsJHJLtaZYhP"

Генерация UUID:

prng.uuid #=> "2d931510-d99f-494a-8c67-87feb05e1594"
prng.uuid #=> "bad85eb9-0713-4da7-8d36-07a8e4b00eab"
Random.uuid #=> "f14e0271-de96-45cc-8911-8910292a42cd"

Все методы также доступны в стандартной библиотеке SecureRandom:

SecureRandom.hex #=> "05b45376a30c67238eb93b16499e50cf"

Генерирует случайное число в заданном диапазоне, как и Random

prng.random_number       #=> 0.5816771641321361
prng.random_number(1000) #=> 485
prng.random_number(1..6) #=> 3
prng.rand                #=> 0.5816771641321361
prng.rand(1000)          #=> 485
prng.rand(1..6)          #=> 3

Константы

ALPHANUMERIC

Публичные методы экземпляров

alphanumeric(n=nil) Показать исходный код 
# File lib/random/formatter.rb, line 240
def alphanumeric(n=nil)
  n = 16 if n.nil?
  choose(ALPHANUMERIC, n)
end

Генерирует случайную буквенно-цифровую строку.

Аргумент n задаёт длину буквенно-цифровой строки в символах, которая должна быть сгенерирована.

Если n не указан или равен nil, используется значение 16. В будущем оно может быть больше.

Результат может содержать символы A-Z, a-z и 0-9.

require 'random/formatter'

Random.alphanumeric     #=> "2BuBuLf3WfSKyQbR"
# or
prng = Random.new
prng.alphanumeric(10) #=> "i6K93NdqiH"
base64(n=nil) Показать исходный код 
# File lib/random/formatter.rb, line 114
def base64(n=nil)
  [random_bytes(n)].pack("m0")
end

Генерирует случайную строку base64.

Аргумент n задаёт длину, в байтах, случайного числа, которое должно быть сгенерировано. Длина результирующей строки примерно равна 4/3 от n.

Если n не указан или равен nil, используется значение 16. В будущем оно может быть больше.

Результат может содержать символы A-Z, a-z, 0-9, «+», «/» и «=».

require 'random/formatter'

Random.base64 #=> "/2BuBuLf3+WfSKyQbRcc/A=="
# or
prng = Random.new
prng.base64 #=> "6BbW0pxO0YENxn38HMUbcQ=="

См. RFC 3548 для определения base64.

hex(n=nil) Показать исходный код 
# File lib/random/formatter.rb, line 92
def hex(n=nil)
  random_bytes(n).unpack1("H*")
end

Генерирует случайную шестнадцатеричную строку.

Аргумент n задаёт длину, в байтах, случайного числа, которое должно быть сгенерировано. Длина результирующей шестнадцатеричной строки в два раза больше n.

Если n не указан или равен nil, используется значение 16. В будущем оно может быть больше.

Результат может содержать символы 0-9 и a-f.

require 'random/formatter'

Random.hex #=> "eb693ec8252cd630102fd0d0fb7c3485"
# or
prng = Random.new
prng.hex #=> "91dc3bfb4de5b11d029d376634589b61"
rand → float
rand(max) → число
rand(range) → число

Генерирует отформатированное случайное число из исходных случайных байтов. См. Random#rand.

Псевдоним для: random_number
random_bytes(n=nil) Показать исходный код 
# File lib/random/formatter.rb, line 71
def random_bytes(n=nil)
  n = n ? n.to_int : 16
  gen_random(n)
end

Генерирует случайную двоичную строку.

Аргумент n задаёт длину результирующей строки.

Если n не указан или равен nil, используется значение 16. В будущем оно может быть больше.

Результат может содержать любые байты: “x00” - “xff”.

require 'random/formatter'

Random.random_bytes #=> "\xD8\\\xE0\xF4\r\xB2\xFC*WM\xFF\x83\x18\xF45\xB6"
# or
prng = Random.new
prng.random_bytes #=> "m\xDC\xFC/\a\x00Uf\xB2\xB2P\xBD\xFF6S\x97"
random_number → float Показать исходный код
random_number(max) → число
random_number(range) → число 
static VALUE
rand_random_number(int argc, VALUE *argv, VALUE obj)
{
    rb_random_t *rnd = try_get_rnd(obj);
    VALUE v = rand_random(argc, argv, obj, rnd);
    if (NIL_P(v)) v = rand_random(0, 0, obj, rnd);
    else if (!v) invalid_argument(argv[0]);
    return v;
}

Генерирует отформатированное случайное число из исходных случайных байтов. См. Random#rand.

Также алиас для: rand
urlsafe_base64(n=nil, padding=false) Показать исходный код 
# File lib/random/formatter.rb, line 145
def urlsafe_base64(n=nil, padding=false)
  s = [random_bytes(n)].pack("m0")
  s.tr!("+/", "-_")
  s.delete!("=") unless padding
  s
end

Генерирует случайную URL-безопасную строку base64.

Аргумент n задаёт длину, в байтах, случайного числа, которое должно быть сгенерировано. Длина результирующей строки примерно равна 4/3 от n.

Если n не указан или равен nil, используется значение 16. В будущем оно может быть больше.

Булевый аргумент padding задаёт использование заполнения. Если он равен false или nil, заполнение не генерируется. В противном случае заполнение генерируется. По умолчанию заполнение не генерируется, потому что «=» может использоваться в качестве разделителя URL.

Результат может содержать символы A-Z, a-z, 0-9, «-» и «_». «=» также используется, если padding равен true.

require 'random/formatter'

Random.urlsafe_base64 #=> "b4GOKm4pOYU_-BOXcrUGDg"
# or
prng = Random.new
prng.urlsafe_base64 #=> "UZLdOkzop70Ddx-IJR0ABg"

prng.urlsafe_base64(nil, true) #=> "i0XQ-7gglIsHGV2_BNPrdQ=="
prng.urlsafe_base64(nil, true) #=> "-M8rLhr7JEpJlqFGUMmOxg=="

См. RFC 3548 для определения URL-безопасного base64.

uuid() Показать исходный код 
# File lib/random/formatter.rb, line 169
def uuid
  ary = random_bytes(16).unpack("NnnnnN")
  ary[2] = (ary[2] & 0x0fff) | 0x4000
  ary[3] = (ary[3] & 0x3fff) | 0x8000
  "%08x-%04x-%04x-%04x-%04x%08x" % ary
end

Генерирует случайный UUID версии 4 (Универсальный уникальный идентификатор).

require 'random/formatter'

Random.uuid #=> "2d931510-d99f-494a-8c67-87feb05e1594"
Random.uuid #=> "bad85eb9-0713-4da7-8d36-07a8e4b00eab"
# or
prng = Random.new
prng.uuid #=> "62936e70-1815-439b-bf89-8492855a7e6b"

UUID версии 4 полностью случайный (кроме версии). Он не содержит значимой информации, такой как адреса MAC, метки времени и т.д.

Результат содержит 122 случайных бита (15.25 случайных байта).

См. RFC4122 для деталей UUID.

Приватные методы экземпляров

choose(source, n) Показать исходный код 
# File lib/random/formatter.rb, line 194
        def choose(source, n)
  size = source.size
  m = 1
  limit = size
  while limit * size <= 0x100000000
    limit *= size
    m += 1
  end
  result = ''.dup
  while m <= n
    rs = random_number(limit)
    is = rs.digits(size)
    (m-is.length).times { is << 0 }
    result << source.values_at(*is).join('')
    n -= m
  end
  if 0 < n
    rs = random_number(limit)
    is = rs.digits(size)
    if is.length < n
      (n-is.length).times { is << 0 }
    else
      is.pop while n < is.length
    end
    result.concat source.values_at(*is).join('')
  end
  result
end

Генерирует строку, случайным образом выбирая из массива символов.

Аргумент source задаёт массив символов, из которого генерируется строка. Аргумент n задаёт длину строки в символах, которая должна быть сгенерирована.

Результат может содержать любые символы из массива source.

require 'random/formatter'

prng.choose([*'l'..'r'], 16) #=> "lmrqpoonmmlqlron"
prng.choose([*'0'..'9'], 5)  #=> "27309"
gen_random(n) Показать исходный код 
# File lib/random/formatter.rb, line 176
        def gen_random(n)
  self.bytes(n)
end

Ruby Core © 1993–2022 Yukihiro Matsumoto
Licensed under the Ruby License.
Ruby Standard Library © contributors
Licensed under their own licenses.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API