Class: DeviseController

Inherits:
Object
  • Object
show all
Includes:
Devise::Controllers::ScopedViews
Defined in:
app/controllers/devise_controller.rb

Overview

All Devise controllers are inherited from here.

Instance Method Summary collapse

Instance Method Details

#_prefixes ⇒ Object

Override prefixes to consider the scoped view. Notice we need to check for the request due to a bug in Action Controller tests that forces _prefixes to be loaded before even having a request object.

This method should be public as it is is in ActionPack itself. Changing its visibility may break other gems.



21
22
23
24
25
26
27
 
# File 'app/controllers/devise_controller.rb', line 21

def _prefixes #:nodoc:
  @_prefixes ||= if self.class.scoped_views? && request && devise_mapping
    ["#{devise_mapping.scoped_path}/#{controller_name}"] + super
  else
    super
  end
end

#assert_is_devise_resource! ⇒ Object (protected)

Checks whether it’s a devise mapped resource or not.



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'app/controllers/devise_controller.rb', line 58

def assert_is_devise_resource! #:nodoc:
  unknown_action! <<-MESSAGE unless devise_mapping
Could not find devise mapping for path #{request.fullpath.inspect}.
This may happen for two reasons:

1) You forgot to wrap your route inside the scope block. For example:

devise_scope :user do
  get "/some/route" => "some_devise_controller"
end

2) You are testing a Devise controller bypassing the router.
 If so, you can explicitly tell Devise which mapping to use:

 @request.env["devise.mapping"] = Devise.mappings[:user]

MESSAGE
end

#clean_up_passwords(object) ⇒ Object (protected) 



184
185
186
 
# File 'app/controllers/devise_controller.rb', line 184

def clean_up_passwords(object)
  object.clean_up_passwords if object.respond_to?(:clean_up_passwords)
end

#devise_i18n_options(options) ⇒ Object (protected) 



164
165
166
 
# File 'app/controllers/devise_controller.rb', line 164

def devise_i18n_options(options)
  options
end

#devise_mapping ⇒ Object (protected)

Attempt to find the mapped route for devise based on request path



53
54
55
 
# File 'app/controllers/devise_controller.rb', line 53

def devise_mapping
  @devise_mapping ||= request.env["devise.mapping"]
end

#find_message(kind, options = {}) ⇒ Object (protected)

Get message for given



169
170
171
172
173
174
175
 
# File 'app/controllers/devise_controller.rb', line 169

def find_message(kind, options = {})
  options[:scope] ||= translation_scope
  options[:default] = Array(options[:default]).unshift(kind.to_sym)
  options[:resource_name] = resource_name
  options = devise_i18n_options(options)
  I18n.t("#{options[:resource_name]}.#{kind}", options)
end

#navigational_formats ⇒ Object (protected)

Returns real navigational formats which are supported by Rails



78
79
80
 
# File 'app/controllers/devise_controller.rb', line 78

def navigational_formats
  @navigational_formats ||= Devise.navigational_formats.select { |format| Mime::EXTENSION_LOOKUP[format.to_s] }
end

#require_no_authentication ⇒ Object (protected)

Helper for use in before_filters where no authentication is required.

Example:

before_filter :require_no_authentication, only: :new



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'app/controllers/devise_controller.rb', line 96

def require_no_authentication
  assert_is_devise_resource!
  return unless is_navigational_format?
  no_input = devise_mapping.no_input_strategies

  authenticated = if no_input.present?
    args = no_input.dup.push scope: resource_name
    warden.authenticate?(*args)
  else
    warden.authenticated?(resource_name)
  end

  if authenticated && resource = warden.user(resource_name)
    flash[:alert] = I18n.t("devise.failure.already_authenticated")
    redirect_to (resource)
  end
end

#resource ⇒ Object (protected)

Gets the actual resource stored in the instance variable



32
33
34
 
# File 'app/controllers/devise_controller.rb', line 32

def resource
  instance_variable_get(:"@#{resource_name}")
end

#resource=(new_resource) ⇒ Object (protected)

Sets the resource creating an instance variable



88
89
90
 
# File 'app/controllers/devise_controller.rb', line 88

def resource=(new_resource)
  instance_variable_set(:"@#{resource_name}", new_resource)
end

#resource_class ⇒ Object (protected)

Proxy to devise map class



43
44
45
 
# File 'app/controllers/devise_controller.rb', line 43

def resource_class
  devise_mapping.to
end

#resource_name ⇒ Object (protected) Also known as: scope_name

Proxy to devise map name



37
38
39
 
# File 'app/controllers/devise_controller.rb', line 37

def resource_name
  devise_mapping.name
end

#resource_params ⇒ Object (protected) 



194
195
196
 
# File 'app/controllers/devise_controller.rb', line 194

def resource_params
  params.fetch(resource_name, {})
end

#respond_with_navigational(*args, &block) ⇒ Object (protected) 



188
189
190
191
192
 
# File 'app/controllers/devise_controller.rb', line 188

def respond_with_navigational(*args, &block)
  respond_with(*args) do |format|
    format.any(*navigational_formats, &block)
  end
end

#set_flash_message(key, kind, options = {}) ⇒ Object (protected)

Sets the flash message with :key, using I18n. By default you are able to setup your messages using specific resource scope, and if no message is found we look to the default scope. Set the “now” options key to a true value to populate the flash.now hash in lieu of the default flash hash (so the flash message will be available to the current action instead of the next action). Example (i18n locale file):

en:
  devise:
    passwords:
      #default_scope_messages - only if resource_scope is not found
      user:
        #resource_scope_messages

Please refer to README or en.yml locale file to check what messages are available.



148
149
150
151
152
153
154
155
 
# File 'app/controllers/devise_controller.rb', line 148

def set_flash_message(key, kind, options = {})
  message = find_message(kind, options)
  if options[:now]
    flash.now[key] = message if message.present?
  else
    flash[key] = message if message.present?
  end
end

#set_minimum_password_length ⇒ Object (protected)

Sets minimum password length to show to user



158
159
160
161
162
 
# File 'app/controllers/devise_controller.rb', line 158

def set_minimum_password_length
  if devise_mapping.validatable?
    @minimum_password_length = resource_class.password_length.min
  end
end

#signed_in_resource ⇒ Object (protected)

Returns a signed in resource from session (if one exists)



48
49
50
 
# File 'app/controllers/devise_controller.rb', line 48

def signed_in_resource
  warden.authenticate(scope: resource_name)
end

#successfully_sent?(resource) ⇒ Boolean (protected)

Helper for use after calling send_*_instructions methods on a resource. If we are in paranoid mode, we always act as if the resource was valid and instructions were sent.

Returns:

  • (Boolean) 


117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'app/controllers/devise_controller.rb', line 117

def successfully_sent?(resource)
  notice = if Devise.paranoid
    resource.errors.clear
    :send_paranoid_instructions
  elsif resource.errors.empty?
    :send_instructions
  end

  if notice
    set_flash_message :notice, notice if is_flashing_format?
    true
  end
end

#translation_scope ⇒ Object (protected)

Controllers inheriting DeviseController are advised to override this method so that other controllers inheriting from them would use existing translations.



180
181
182
 
# File 'app/controllers/devise_controller.rb', line 180

def translation_scope
  "devise.#{controller_name}"
end

#unknown_action!(msg) ⇒ Object (protected)

Raises:

  • (AbstractController::ActionNotFound) 


82
83
84
85
 
# File 'app/controllers/devise_controller.rb', line 82

def unknown_action!(msg)
  logger.debug "[Devise] #{msg}" if logger
  raise AbstractController::ActionNotFound, msg
end