Module: Authlogic::ActsAsAuthentic::Base::Config
- Defined in:
- lib/authlogic/acts_as_authentic/base.rb
Overview
The primary configuration of a model (often, ‘User`) for use with authlogic. These methods become class methods of ::ActiveRecord::Base.
Instance Method Summary collapse
-
#acts_as_authentic {|_self| ... } ⇒ Object
This includes a lot of helpful methods for authenticating records which the Authlogic::Session module relies on.
-
#add_acts_as_authentic_module(mod, action = :append) ⇒ Object
Since this part of Authlogic deals with another class, ActiveRecord, we can’t just start including things in ActiveRecord itself.
-
#remove_acts_as_authentic_module(mod) ⇒ Object
This is the same as add_acts_as_authentic_module, except that it removes the module from the list.
Instance Method Details
#acts_as_authentic {|_self| ... } ⇒ Object
This includes a lot of helpful methods for authenticating records which the Authlogic::Session module relies on. To use it just do:
class User < ApplicationRecord
acts_as_authentic
end
Configuration is easy:
acts_as_authentic do |c|
c.my_configuration_option = my_value
end
See the various sub modules for the configuration they provide.
33 34 35 36 37 |
# File 'lib/authlogic/acts_as_authentic/base.rb', line 33 def acts_as_authentic return unless db_setup? yield self if block_given? acts_as_authentic_modules.each { |mod| include mod } end |
#add_acts_as_authentic_module(mod, action = :append) ⇒ Object
Since this part of Authlogic deals with another class, ActiveRecord, we can’t just start including things in ActiveRecord itself. A lot of these module includes need to be triggered by the acts_as_authentic method call. For example, you don’t want to start adding in email validations and what not into a model that has nothing to do with Authlogic.
That being said, this is your tool for extending Authlogic and “hooking” into the acts_as_authentic call.
48 49 50 51 52 53 54 55 56 57 58 |
# File 'lib/authlogic/acts_as_authentic/base.rb', line 48 def add_acts_as_authentic_module(mod, action = :append) modules = acts_as_authentic_modules.clone case action when :append modules << mod when :prepend modules = [mod] + modules end modules.uniq! self.acts_as_authentic_modules = modules end |
#remove_acts_as_authentic_module(mod) ⇒ Object
This is the same as add_acts_as_authentic_module, except that it removes the module from the list.
62 63 64 65 66 |
# File 'lib/authlogic/acts_as_authentic/base.rb', line 62 def remove_acts_as_authentic_module(mod) modules = acts_as_authentic_modules.clone modules.delete(mod) self.acts_as_authentic_modules = modules end |