Module: QuoVadis

Defined in:
lib/quo_vadis.rb,
lib/quo_vadis/engine.rb,
lib/quo_vadis/version.rb,
app/mailers/quo_vadis/notifier.rb,
lib/generators/quo_vadis/install_generator.rb

Defined Under Namespace

Classes: Engine, InstallGenerator, Notifier, SessionsController

Constant Summary collapse

VERSION =
'1.3.0'
@@model =
'User'
@@signed_in_url =
:root
@@override_original_url =
false
@@signed_in_hook =
nil
@@failed_sign_in_hook =
nil
@@remember_for =
2.weeks
:all
@@blocked =
false
@@signed_out_url =
:root
@@signed_out_hook =
nil
@@from =
'[email protected]'
@@subject_change_password =
'Change your password.'
@@subject_invitation =
'Activate your account'
@@layout =
nil

Class Method Summary collapse

Class Method Details

.blocked?(controller) ⇒ Boolean

:nodoc:

Returns:

  • (Boolean)


69
70
71
# File 'lib/quo_vadis.rb', line 69

def self.blocked?(controller) # :nodoc:
  @@blocked.respond_to?(:call) ? @@blocked.call(controller) : @@blocked
end

.configure {|_self| ... } ⇒ Object

Configure from the initializer.

Yields:

  • (_self)

Yield Parameters:

  • _self (QuoVadis)

    the object that the method was called on



123
124
125
# File 'lib/quo_vadis.rb', line 123

def self.configure
  yield self
end

.failed_sign_in_hook(controller) ⇒ Object

:nodoc:



52
53
54
# File 'lib/quo_vadis.rb', line 52

def self.(controller) # :nodoc:
  @@failed_sign_in_hook.call(controller) if @@failed_sign_in_hook
end

.model_classObject

:nodoc



10
11
12
# File 'lib/quo_vadis.rb', line 10

def self.model_class # :nodoc
  @@model.constantize
end

.model_instance_nameObject

:nodoc



14
15
16
# File 'lib/quo_vadis.rb', line 14

def self.model_instance_name # :nodoc
  @@model.tableize.singularize  # e.g. 'user'
end

.signed_in_hook(user, controller) ⇒ Object

:nodoc:



44
45
46
# File 'lib/quo_vadis.rb', line 44

def self.signed_in_hook(user, controller) # :nodoc:
  @@signed_in_hook.call(user, controller) if @@signed_in_hook
end

.signed_in_url(user, original_url, controller) ⇒ Object

:nodoc:



32
33
34
35
36
37
38
# File 'lib/quo_vadis.rb', line 32

def self.signed_in_url(user, original_url, controller) # :nodoc:
  if original_url && !@@override_original_url
    original_url
  else
    @@signed_in_url.respond_to?(:call) ?  @@signed_in_url.call(user, controller) : @@signed_in_url
  end
end

.signed_out_hook(user, controller) ⇒ Object

:nodoc:



91
92
93
# File 'lib/quo_vadis.rb', line 91

def self.signed_out_hook(user, controller) # :nodoc:
  @@signed_out_hook.call(user, controller) if @@signed_out_hook
end

.signed_out_url(controller) ⇒ Object

:nodoc:



82
83
84
# File 'lib/quo_vadis.rb', line 82

def self.signed_out_url(controller) # :nodoc:
  @@signed_out_url.respond_to?(:call) ? @@signed_out_url.call(controller) : @@signed_out_url
end