Spec-Zone.ru › Ruby on Rails 5.0

модуль ActiveModel::SecurePassword::ClassMethods

Включенные модули:
ActiveModel::SecurePassword::InstanceMethodsOnActivation, ActiveModel::Validations

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

has_secure_password(options = {}) Показать исходный код
# File activemodel/lib/active_model/secure_password.rb, line 53
def has_secure_password(options = {})
  # Load bcrypt gem only when has_secure_password is used.
  # This is to avoid ActiveModel (and by extension the entire framework)
  # being dependent on a binary library.
  begin
    require 'bcrypt'
  rescue LoadError
    $stderr.puts "You don't have bcrypt installed in your application. Please add it to your Gemfile and run bundle install"
    raise
  end

  include InstanceMethodsOnActivation

  if options.fetch(:validations, true)
    include ActiveModel::Validations

    # This ensures the model has a password by checking whether the password_digest
    # is present, so that this works with both new and existing records. However,
    # when there is an error, the message is added to the password attribute instead
    # so that the error message will make sense to the end-user.
    validate do |record|
      record.errors.add(:password, :blank) unless record.password_digest.present?
    end

    validates_length_of :password, maximum: ActiveModel::SecurePassword::MAX_PASSWORD_LENGTH_ALLOWED
    validates_confirmation_of :password, allow_blank: true
  end
end

Добавляет методы для установки и аутентификации паролей с помощью BCrypt. Этот механизм требует наличия атрибута password_digest.

Следующие валидации добавляются автоматически:

  • Пароль должен быть задан при создании.

  • Длина пароля должна быть меньше или равна 72 символам.

  • Подтверждение пароля (используя атрибут password_confirmation)

Если валидация подтверждения пароля не требуется, просто опустите значение для password_confirmation (т.е. не предоставляйте поле формы для него). Когда у этого атрибута значение nil, валидация не будет срабатывать.

Для большей настраиваемости можно подавить стандартные валидации, передав validations: false в качестве аргумента.

Добавьте bcrypt (~> 3.1.7) в Gemfile для использования has_secure_password:

gem 'bcrypt', '~> 3.1.7'

Пример использования Active Record (который автоматически включает ActiveModel::SecurePassword):

# Schema: User(name:string, password_digest:string)
class User < ActiveRecord::Base
  has_secure_password
end

user = User.new(name: 'david', password: '', password_confirmation: 'nomatch')
user.save                                                       # => false, password required
user.password = 'mUc3m00RsqyRe'
user.save                                                       # => false, confirmation doesn't match
user.password_confirmation = 'mUc3m00RsqyRe'
user.save                                                       # => true
user.authenticate('notright')                                   # => false
user.authenticate('mUc3m00RsqyRe')                              # => user
User.find_by(name: 'david').try(:authenticate, 'notright')      # => false
User.find_by(name: 'david').try(:authenticate, 'mUc3m00RsqyRe') # => user

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

Spec-Zone.ru

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