Spec-Zone.ru › Ruby on Rails 8.1

модуль ActiveRecord::SecureToken::ClassMethods

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

generate_unique_secure_token (length: MINIMUM_TOKEN_LENGTH) Показать исходный код
# File activerecord/lib/active_record/secure_token.rb, line 61
def generate_unique_secure_token(length: MINIMUM_TOKEN_LENGTH)
  SecureRandom.base58(length)
end
has_secure_token (attribute = :token, length: MINIMUM_TOKEN_LENGTH, on: ActiveRecord.generate_secure_token_on) Показать исходный код
# File activerecord/lib/active_record/secure_token.rb, line 46
def has_secure_token(attribute = :token, length: MINIMUM_TOKEN_LENGTH, on: ActiveRecord.generate_secure_token_on)
  if length < MINIMUM_TOKEN_LENGTH
    raise MinimumLengthError, "Token requires a minimum length of #{MINIMUM_TOKEN_LENGTH} characters."
  end

  # Load securerandom only when has_secure_token is used.
  require "active_support/core_ext/securerandom"
  define_method("regenerate_#{attribute}") { update! attribute => self.class.generate_unique_secure_token(length: length) }
  set_callback on, on == :initialize ? :after : :before do
    if new_record? && !query_attribute(attribute)
      send("#{attribute}=", self.class.generate_unique_secure_token(length: length))
    end
  end
end

Пример использования has_secure_token

# Schema: User(token:string, auth_token:string)
class User < ActiveRecord::Base
  has_secure_token
  has_secure_token :auth_token, length: 36
end

user = User.new
user.save
user.token # => "pX27zsMN2ViQKta1bGfLmVJE"
user.auth_token # => "tU9bLuZseefXQ4yQxQo8wjtBvsAfPc78os6R"
user.regenerate_token # => true
user.regenerate_auth_token # => true

SecureRandom::base58 используется для генерации уникального токена длиной не менее 24 символов, поэтому вероятность коллизий крайне мала.

Обратите внимание, что в базе данных всё ещё может возникнуть состояние гонки — так же, как это возможно при использовании validates_uniqueness_of. Рекомендуется добавить в базу данных уникальный индекс, чтобы учесть даже этот маловероятный сценарий.

Параметры

:length

Длина случайной последовательности, не менее 24 символов. Значение по умолчанию — 24.

:on

Обратный вызов, выполняемый при генерации значения. При вызове с on: :initialize значение генерируется в обратном вызове after_initialize, в противном случае оно будет использоваться в обратном вызове before_. Если параметр не указан, :on будет использовать значение config.active_record.generate_secure_token_on, для которого начиная с Rails 7.1 задано значение по умолчанию :initialize.

© 2004–2021 David Heinemeier Hansson
Licensed under the MIT License.

Spec-Zone.ru

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