Module: Authlogic::ActsAsAuthentic::Login::Config
- Defined in:
- lib/authlogic/acts_as_authentic/login.rb
Overview
Configuration for the login field.
Instance Method Summary collapse
-
#find_by_smart_case_login_field(login) ⇒ Object
This method allows you to find a record with the given login.
-
#login_field(value = nil) ⇒ Object
(also: #login_field=)
The name of the login field in the database.
-
#merge_validates_format_of_login_field_options(options = {}) ⇒ Object
See merge_validates_length_of_login_field_options.
-
#merge_validates_length_of_login_field_options(options = {}) ⇒ Object
A convenience function to merge options into the validates_length_of_login_field_options.
-
#merge_validates_uniqueness_of_login_field_options(options = {}) ⇒ Object
See merge_validates_length_of_login_field_options.
-
#validate_login_field(value = nil) ⇒ Object
(also: #validate_login_field=)
Whether or not to validate the login field.
-
#validates_format_of_login_field_options(value = nil) ⇒ Object
(also: #validates_format_of_login_field_options=)
A hash of options for the validates_format_of call for the login field.
-
#validates_length_of_login_field_options(value = nil) ⇒ Object
(also: #validates_length_of_login_field_options=)
A hash of options for the validates_length_of call for the login field.
-
#validates_uniqueness_of_login_field_options(value = nil) ⇒ Object
(also: #validates_uniqueness_of_login_field_options=)
A hash of options for the validates_uniqueness_of call for the login field.
Instance Method Details
#find_by_smart_case_login_field(login) ⇒ Object
This method allows you to find a record with the given login. If you notice, with Active Record you have the UniquenessValidator class. They give you a :case_sensitive option. I handle this in the same manner that they handle that. If you are using the login field, set false for the :case_sensitive option in validates_uniqueness_of_login_field_options and the column doesn’t have a case-insensitive collation, this method will modify the query to look something like:
"LOWER(#{quoted_table_name}.#{login_field}) = LOWER(#{login})"
If you don’t specify this it just uses a regular case-sensitive search (with the binary modifier if necessary):
"BINARY #{login_field} = #{login}"
The above also applies for using email as your login, except that you need to set the :case_sensitive in validates_uniqueness_of_email_field_options to false.
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 |
# File 'lib/authlogic/acts_as_authentic/login.rb', line 171 def find_by_smart_case_login_field(login) if login_field find_with_case( login_field, login, [:case_sensitive] != false ) else find_with_case( email_field, login, [:case_sensitive] != false ) end end |
#login_field(value = nil) ⇒ Object Also known as: login_field=
The name of the login field in the database.
-
Default:
:login or :username, if they exist -
Accepts:
Symbol
20 21 22 |
# File 'lib/authlogic/acts_as_authentic/login.rb', line 20 def login_field(value = nil) rw_config(:login_field, value, first_column_to_exist(nil, :login, :username)) end |
#merge_validates_format_of_login_field_options(options = {}) ⇒ Object
See merge_validates_length_of_login_field_options. The same thing, except for validates_format_of_login_field_options
107 108 109 110 |
# File 'lib/authlogic/acts_as_authentic/login.rb', line 107 def ( = {}) self. = .merge() end |
#merge_validates_length_of_login_field_options(options = {}) ⇒ Object
A convenience function to merge options into the validates_length_of_login_field_options. So instead of:
self. =
.merge(:my_option => my_value)
You can do this:
:my_option => my_value
61 62 63 64 |
# File 'lib/authlogic/acts_as_authentic/login.rb', line 61 def ( = {}) self. = .merge() end |
#merge_validates_uniqueness_of_login_field_options(options = {}) ⇒ Object
See merge_validates_length_of_login_field_options. The same thing, except for validates_uniqueness_of_login_field_options
145 146 147 148 |
# File 'lib/authlogic/acts_as_authentic/login.rb', line 145 def ( = {}) self. = .merge() end |
#validate_login_field(value = nil) ⇒ Object Also known as: validate_login_field=
Whether or not to validate the login field
-
Default:
true -
Accepts:
Boolean
29 30 31 |
# File 'lib/authlogic/acts_as_authentic/login.rb', line 29 def validate_login_field(value = nil) rw_config(:validate_login_field, value, true) end |
#validates_format_of_login_field_options(value = nil) ⇒ Object Also known as: validates_format_of_login_field_options=
A hash of options for the validates_format_of call for the login field. Allows you to change this however you want.
Keep in mind this is ruby. I wanted to keep this as flexible as possible, so you can completely replace the hash or merge options into it. Checkout the convenience function merge_validates_format_of_login_field_options to merge options.
87 88 89 90 91 92 93 94 95 96 97 98 99 |
# File 'lib/authlogic/acts_as_authentic/login.rb', line 87 def (value = nil) rw_config( :validates_format_of_login_field_options, value, with: Authlogic::Regex::LOGIN, message: proc do I18n.t( "error_messages.login_invalid", default: "should use only letters, numbers, spaces, and .-_@+ please." ) end ) end |
#validates_length_of_login_field_options(value = nil) ⇒ Object Also known as: validates_length_of_login_field_options=
A hash of options for the validates_length_of call for the login field. Allows you to change this however you want.
Keep in mind this is ruby. I wanted to keep this as flexible as possible, so you can completely replace the hash or merge options into it. Checkout the convenience function merge_validates_length_of_login_field_options to merge options.
-
Default:
=> 3..100 -
Accepts:
Hash of options accepted by validates_length_of
44 45 46 |
# File 'lib/authlogic/acts_as_authentic/login.rb', line 44 def (value = nil) rw_config(:validates_length_of_login_field_options, value, within: 3..100) end |
#validates_uniqueness_of_login_field_options(value = nil) ⇒ Object Also known as: validates_uniqueness_of_login_field_options=
A hash of options for the validates_uniqueness_of call for the login field. Allows you to change this however you want.
Keep in mind this is ruby. I wanted to keep this as flexible as possible, so you can completely replace the hash or merge options into it. Checkout the convenience function merge_validates_format_of_login_field_options to merge options.
-
Default:
{ :case_sensitive => false, :scope => validations_scope, :if => "#{login_field}_changed?".to_sym }
-
Accepts:
Hash of options accepted by validates_uniqueness_of
129 130 131 132 133 134 135 136 137 |
# File 'lib/authlogic/acts_as_authentic/login.rb', line 129 def (value = nil) rw_config( :validates_uniqueness_of_login_field_options, value, case_sensitive: false, scope: validations_scope, if: "#{login_field}_changed?".to_sym ) end |