111 lines
3.4 KiB
Ruby
111 lines
3.4 KiB
Ruby
module Devise
|
|
# Responsible for handling devise mappings and routes configuration. Each
|
|
# resource configured by devise_for in routes is actually creating a mapping
|
|
# 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]
|
|
#
|
|
# mapping.name #=> :user
|
|
# # 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.
|
|
#
|
|
# mapping.modules #=> [:authenticatable]
|
|
# # is the modules included in the class
|
|
#
|
|
class Mapping #:nodoc:
|
|
attr_reader :singular, :plural, :path, :controllers, :path_names, :class_name, :sign_out_via
|
|
alias :name :singular
|
|
|
|
# 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)
|
|
case duck
|
|
when String, Symbol
|
|
return duck
|
|
when Class
|
|
Devise.mappings.each_value { |m| return m.name if duck <= m.to }
|
|
else
|
|
Devise.mappings.each_value { |m| return m.name if duck.is_a?(m.to) }
|
|
end
|
|
|
|
raise "Could not find a valid mapping for #{duck}"
|
|
end
|
|
|
|
def self.find_by_path!(path, path_type=:fullpath)
|
|
Devise.mappings.each_value { |m| return m if path.include?(m.send(path_type)) }
|
|
raise "Could not find a valid mapping for path #{path}"
|
|
end
|
|
|
|
def initialize(name, options) #:nodoc:
|
|
@plural = (options[:as] ? "#{options[:as]}_#{name}" : name).to_sym
|
|
@singular = (options[:singular] || @plural.to_s.singularize).to_sym
|
|
|
|
@class_name = (options[:class_name] || name.to_s.classify).to_s
|
|
@ref = ActiveSupport::Dependencies.ref(@class_name)
|
|
|
|
@path = (options[:path] || name).to_s
|
|
@path_prefix = options[:path_prefix]
|
|
|
|
mod = options[:module] || "devise"
|
|
@controllers = Hash.new { |h,k| h[k] = "#{mod}/#{k}" }
|
|
@controllers.merge!(options[:controllers] || {})
|
|
|
|
@path_names = Hash.new { |h,k| h[k] = k.to_s }
|
|
@path_names.merge!(:registration => "")
|
|
@path_names.merge!(options[:path_names] || {})
|
|
|
|
@sign_out_via = options[:sign_out_via] || Devise.sign_out_via
|
|
end
|
|
|
|
# Return modules for the mapping.
|
|
def modules
|
|
@modules ||= to.respond_to?(:devise_modules) ? to.devise_modules : []
|
|
end
|
|
|
|
# Gives the class the mapping points to.
|
|
def to
|
|
@ref.get
|
|
end
|
|
|
|
def strategies
|
|
@strategies ||= STRATEGIES.values_at(*self.modules).compact.uniq.reverse
|
|
end
|
|
|
|
def routes
|
|
@routes ||= ROUTES.values_at(*self.modules).compact.uniq
|
|
end
|
|
|
|
def authenticatable?
|
|
@authenticatable ||= self.modules.any? { |m| m.to_s =~ /authenticatable/ }
|
|
end
|
|
|
|
def fullpath
|
|
"/#{@path_prefix}/#{@path}".squeeze("/")
|
|
end
|
|
|
|
# Create magic predicates for verifying what module is activated by this map.
|
|
# Example:
|
|
#
|
|
# def confirmable?
|
|
# self.modules.include?(:confirmable)
|
|
# end
|
|
#
|
|
def self.add_module(m)
|
|
class_eval <<-METHOD, __FILE__, __LINE__ + 1
|
|
def #{m}?
|
|
self.modules.include?(:#{m})
|
|
end
|
|
METHOD
|
|
end
|
|
end
|
|
end
|