2009-10-12 07:37:42 -04:00
|
|
|
module Devise
|
2009-10-17 11:10:15 -04:00
|
|
|
# Responsible for handling devise mappings and routes configuration. Each
|
|
|
|
# resource configured by devise_for in routes is actually creating a mapping
|
2009-10-18 10:54:21 -04:00
|
|
|
# object. You can refer to devise_for in routes for usage options.
|
|
|
|
#
|
|
|
|
# The required value in devise_for is actually not used internally, but it's
|
|
|
|
# inflected to find all other values.
|
|
|
|
#
|
|
|
|
# map.devise_for :users
|
|
|
|
# mapping = Devise.mappings[:user]
|
|
|
|
#
|
2009-10-19 22:31:33 -04:00
|
|
|
# mapping.name #=> :user
|
2009-10-18 10:54:21 -04:00
|
|
|
# # is the scope used in controllers and warden, given in the route as :singular.
|
|
|
|
#
|
|
|
|
# mapping.as #=> "users"
|
|
|
|
# # how the mapping should be search in the path, given in the route as :as.
|
|
|
|
#
|
|
|
|
# mapping.to #=> User
|
|
|
|
# # is the class to be loaded from routes, given in the route as :class_name.
|
|
|
|
#
|
2009-10-30 06:29:10 -04:00
|
|
|
# mapping.for #=> [:authenticatable]
|
2009-10-18 10:54:21 -04:00
|
|
|
# # is the modules included in the class
|
|
|
|
#
|
|
|
|
class Mapping #:nodoc:
|
2009-11-13 05:49:22 -05:00
|
|
|
attr_reader :name, :as, :path_names, :path_prefix, :route_options
|
2009-11-06 11:27:27 -05:00
|
|
|
|
|
|
|
# Loop through all mappings looking for a map that matches with the requested
|
|
|
|
# path (ie /users/sign_in). If a path prefix is given, it's taken into account.
|
|
|
|
def self.find_by_path(path)
|
|
|
|
Devise.mappings.each_value do |mapping|
|
|
|
|
route = path.split("/")[mapping.as_position]
|
|
|
|
return mapping if mapping.as == route.to_sym
|
|
|
|
end
|
|
|
|
nil
|
|
|
|
end
|
2009-10-12 07:37:42 -04:00
|
|
|
|
2009-11-15 09:19:16 -05:00
|
|
|
# Find a mapping by a given class. It takes into account single table inheritance as well.
|
|
|
|
def self.find_by_class(klass)
|
|
|
|
Devise.mappings.values.find { |m| return m if klass <= m.to }
|
|
|
|
end
|
|
|
|
|
2009-11-16 12:07:01 -05:00
|
|
|
# Receives an object and find a scope for it. If a scope cannot be found,
|
|
|
|
# raises an error. If a symbol is given, it's considered to be the scope.
|
|
|
|
def self.find_scope!(duck)
|
|
|
|
if duck.is_a?(Symbol)
|
|
|
|
duck
|
|
|
|
else
|
|
|
|
klass = duck.is_a?(Class) ? duck : duck.class
|
|
|
|
mapping = Devise::Mapping.find_by_class(klass)
|
|
|
|
raise "Could not find a valid mapping for #{duck}" unless mapping
|
|
|
|
mapping.name
|
|
|
|
end
|
2009-11-15 09:19:16 -05:00
|
|
|
end
|
|
|
|
|
2009-11-06 17:59:36 -05:00
|
|
|
# Default url options which can be used as prefix.
|
|
|
|
def self.default_url_options
|
|
|
|
{}
|
|
|
|
end
|
|
|
|
|
|
|
|
def initialize(name, options) #:nodoc:
|
2009-11-13 05:49:22 -05:00
|
|
|
@as = (options.delete(:as) || name).to_sym
|
|
|
|
@klass = (options.delete(:class_name) || name.to_s.classify).to_s
|
2009-11-19 08:43:31 -05:00
|
|
|
@name = (options.delete(:scope) || name.to_s.singularize).to_sym
|
2009-11-13 05:49:22 -05:00
|
|
|
@path_names = options.delete(:path_names) || {}
|
|
|
|
@path_prefix = options.delete(:path_prefix) || ""
|
2009-11-06 11:27:27 -05:00
|
|
|
@path_prefix << "/" unless @path_prefix[-1] == ?/
|
2009-11-13 05:49:22 -05:00
|
|
|
@route_options = options || {}
|
2009-11-06 11:27:27 -05:00
|
|
|
|
2009-10-17 12:06:51 -04:00
|
|
|
setup_path_names
|
2009-10-12 20:49:51 -04:00
|
|
|
end
|
|
|
|
|
|
|
|
# Return modules for the mapping.
|
|
|
|
def for
|
|
|
|
@for ||= to.devise_modules
|
2009-10-12 07:37:42 -04:00
|
|
|
end
|
|
|
|
|
|
|
|
# Reload mapped class each time when cache_classes is false.
|
|
|
|
def to
|
|
|
|
return @to if @to
|
|
|
|
klass = @klass.constantize
|
|
|
|
@to = klass if Rails.configuration.cache_classes
|
|
|
|
klass
|
|
|
|
end
|
|
|
|
|
2009-10-12 20:49:51 -04:00
|
|
|
# Check if the respective controller has a module in the mapping class.
|
|
|
|
def allows?(controller)
|
|
|
|
self.for.include?(CONTROLLERS[controller.to_sym])
|
|
|
|
end
|
|
|
|
|
2009-11-06 11:27:27 -05:00
|
|
|
# Return in which position in the path prefix devise should find the as mapping.
|
|
|
|
def as_position
|
|
|
|
self.path_prefix.count("/")
|
|
|
|
end
|
|
|
|
|
|
|
|
# Returns the raw path using path_prefix and as.
|
|
|
|
def raw_path
|
|
|
|
path_prefix + as.to_s
|
|
|
|
end
|
|
|
|
|
|
|
|
# Returns the parsed path. If you need meta information in your path_prefix,
|
|
|
|
# you should overwrite this method to use it. The only information supported
|
|
|
|
# by default is I18n.locale.
|
2009-11-06 11:56:06 -05:00
|
|
|
#
|
2009-11-06 11:27:27 -05:00
|
|
|
def parsed_path
|
2009-11-06 17:59:36 -05:00
|
|
|
returning raw_path do |path|
|
|
|
|
self.class.default_url_options.each do |key, value|
|
|
|
|
path.gsub!(key.inspect, value.to_s)
|
|
|
|
end
|
|
|
|
end
|
2009-11-06 11:27:27 -05:00
|
|
|
end
|
|
|
|
|
2009-10-17 11:10:15 -04:00
|
|
|
# Create magic predicates for verifying what module is activated by this map.
|
|
|
|
# Example:
|
|
|
|
#
|
|
|
|
# def confirmable?
|
|
|
|
# self.for.include?(:confirmable)
|
|
|
|
# end
|
2009-10-18 10:54:21 -04:00
|
|
|
#
|
2009-10-19 22:31:33 -04:00
|
|
|
ALL.each do |m|
|
2009-10-12 20:06:39 -04:00
|
|
|
class_eval <<-METHOD, __FILE__, __LINE__
|
|
|
|
def #{m}?
|
2009-10-12 20:49:51 -04:00
|
|
|
self.for.include?(:#{m})
|
2009-10-12 20:06:39 -04:00
|
|
|
end
|
|
|
|
METHOD
|
|
|
|
end
|
2009-10-17 11:10:15 -04:00
|
|
|
|
|
|
|
private
|
|
|
|
|
|
|
|
# Configure default path names, allowing the user overwrite defaults by
|
|
|
|
# passing a hash in :path_names.
|
|
|
|
def setup_path_names
|
|
|
|
[:sign_in, :sign_out, :password, :confirmation].each do |path_name|
|
|
|
|
@path_names[path_name] ||= path_name.to_s
|
|
|
|
end
|
|
|
|
end
|
2009-10-12 07:37:42 -04:00
|
|
|
end
|
|
|
|
end
|