mirror of
https://github.com/heartcombo/devise.git
synced 2026-04-28 03:00:29 -04:00
Rails 5 will [not have `hide_action` any longer](https://github.com/rails/rails/pull/18371/files), as the Rails convention is to not expose private or protected methods as actions, thus obviating the need for `hide_action`. Presumably, there is code inheriting from `DeviseController` that is calling these helpers, so they cannot be private, so protected seems to be the only way to get Devise working with Rails 5.
199 lines
5.8 KiB
Ruby
199 lines
5.8 KiB
Ruby
# All Devise controllers are inherited from here.
|
|
class DeviseController < Devise.parent_controller.constantize
|
|
include Devise::Controllers::ScopedViews
|
|
|
|
helper DeviseHelper
|
|
|
|
helpers = %w(resource scope_name resource_name signed_in_resource
|
|
resource_class resource_params devise_mapping)
|
|
helper_method(*helpers)
|
|
|
|
prepend_before_filter :assert_is_devise_resource!
|
|
respond_to :html if mimes_for_respond_to.empty?
|
|
|
|
protected
|
|
|
|
# Gets the actual resource stored in the instance variable
|
|
def resource
|
|
instance_variable_get(:"@#{resource_name}")
|
|
end
|
|
|
|
# Proxy to devise map name
|
|
def resource_name
|
|
devise_mapping.name
|
|
end
|
|
alias :scope_name :resource_name
|
|
|
|
# Proxy to devise map class
|
|
def resource_class
|
|
devise_mapping.to
|
|
end
|
|
|
|
# Returns a signed in resource from session (if one exists)
|
|
def signed_in_resource
|
|
warden.authenticate(scope: resource_name)
|
|
end
|
|
|
|
# Attempt to find the mapped route for devise based on request path
|
|
def devise_mapping
|
|
@devise_mapping ||= request.env["devise.mapping"]
|
|
end
|
|
|
|
|
|
# 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.
|
|
def _prefixes #:nodoc:
|
|
@_prefixes ||= if self.class.scoped_views? && request && devise_mapping
|
|
["#{devise_mapping.scoped_path}/#{controller_name}"] + super
|
|
else
|
|
super
|
|
end
|
|
end
|
|
|
|
|
|
# Checks whether it's a devise mapped resource or not.
|
|
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
|
|
|
|
# Returns real navigational formats which are supported by Rails
|
|
def navigational_formats
|
|
@navigational_formats ||= Devise.navigational_formats.select { |format| Mime::EXTENSION_LOOKUP[format.to_s] }
|
|
end
|
|
|
|
def unknown_action!(msg)
|
|
logger.debug "[Devise] #{msg}" if logger
|
|
raise AbstractController::ActionNotFound, msg
|
|
end
|
|
|
|
# Sets the resource creating an instance variable
|
|
def resource=(new_resource)
|
|
instance_variable_set(:"@#{resource_name}", new_resource)
|
|
end
|
|
|
|
# Helper for use in before_filters where no authentication is required.
|
|
#
|
|
# Example:
|
|
# before_filter :require_no_authentication, only: :new
|
|
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 after_sign_in_path_for(resource)
|
|
end
|
|
end
|
|
|
|
# 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.
|
|
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
|
|
|
|
# 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.
|
|
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
|
|
|
|
# Sets minimum password length to show to user
|
|
def set_minimum_password_length
|
|
if devise_mapping.validatable?
|
|
@minimum_password_length = resource_class.password_length.min
|
|
end
|
|
end
|
|
|
|
def devise_i18n_options(options)
|
|
options
|
|
end
|
|
|
|
# Get message for given
|
|
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
|
|
|
|
# Controllers inheriting DeviseController are advised to override this
|
|
# method so that other controllers inheriting from them would use
|
|
# existing translations.
|
|
def translation_scope
|
|
"devise.#{controller_name}"
|
|
end
|
|
|
|
def clean_up_passwords(object)
|
|
object.clean_up_passwords if object.respond_to?(:clean_up_passwords)
|
|
end
|
|
|
|
def respond_with_navigational(*args, &block)
|
|
respond_with(*args) do |format|
|
|
format.any(*navigational_formats, &block)
|
|
end
|
|
end
|
|
|
|
def resource_params
|
|
params.fetch(resource_name, {})
|
|
end
|
|
|
|
ActiveSupport.run_load_hooks(:devise_controller, self)
|
|
end
|