Class: Devise::Mapping

Inherits:
Object
  • Object
show all
Defined in:
lib/devise/mapping.rb

Overview

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, options) ⇒ Mapping

:nodoc:



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/devise/mapping.rb', line 48

def initialize(name, options) #:nodoc:
  @scoped_path = options[:as] ? "#{options[:as]}/#{name}" : name.to_s
  @singular = (options[:singular] || @scoped_path.tr('/', '_').singularize).to_sym

  @class_name = (options[:class_name] || name.to_s.classify).to_s
  @ref = Devise.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

Instance Attribute Details

#class_name ⇒ Object (readonly)

:nodoc:



25
26
27
 
# File 'lib/devise/mapping.rb', line 25

def class_name
  @class_name
end

#controllers ⇒ Object (readonly)

:nodoc:



25
26
27
 
# File 'lib/devise/mapping.rb', line 25

def controllers
  @controllers
end

#path ⇒ Object (readonly)

:nodoc:



25
26
27
 
# File 'lib/devise/mapping.rb', line 25

def path
  @path
end

#path_names ⇒ Object (readonly)

:nodoc:



25
26
27
 
# File 'lib/devise/mapping.rb', line 25

def path_names
  @path_names
end

#scoped_path ⇒ Object (readonly)

:nodoc:



25
26
27
 
# File 'lib/devise/mapping.rb', line 25

def scoped_path
  @scoped_path
end

#sign_out_via ⇒ Object (readonly)

:nodoc:



25
26
27
 
# File 'lib/devise/mapping.rb', line 25

def sign_out_via
  @sign_out_via
end

#singular ⇒ Object (readonly) Also known as: name

:nodoc:



25
26
27
 
# File 'lib/devise/mapping.rb', line 25

def singular
  @singular
end

Class Method Details

.add_module(m) ⇒ Object

Create magic predicates for verifying what module is activated by this map. Example:

def confirmable?
  self.modules.include?(:confirmable)
end



106
107
108
109
110
111
112
 
# File 'lib/devise/mapping.rb', line 106

def self.add_module(m)
  class_eval <<-METHOD, __FILE__, __LINE__ + 1
    def #{m}?
      self.modules.include?(:#{m})
    end
  METHOD
end

.find_by_path!(path, path_type = :fullpath) ⇒ Object 



43
44
45
46
 
# File 'lib/devise/mapping.rb', line 43

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.inspect}"
end

.find_scope!(duck) ⇒ Object

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.



30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/devise/mapping.rb', line 30

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.inspect}"
end

Instance Method Details

#authenticatable? ⇒ Boolean

Returns:

  • (Boolean) 


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

def authenticatable?
  @authenticatable ||= self.modules.any? { |m| m.to_s =~ /authenticatable/ }
end

#fullpath ⇒ Object 



95
96
97
 
# File 'lib/devise/mapping.rb', line 95

def fullpath
  "/#{@path_prefix}/#{@path}".squeeze("/")
end

#modules ⇒ Object

Return modules for the mapping.



70
71
72
 
# File 'lib/devise/mapping.rb', line 70

def modules
  @modules ||= to.respond_to?(:devise_modules) ? to.devise_modules : []
end

#routes ⇒ Object 



87
88
89
 
# File 'lib/devise/mapping.rb', line 87

def routes
  @routes ||= ROUTES.values_at(*self.modules).compact.uniq
end

#strategies ⇒ Object 



83
84
85
 
# File 'lib/devise/mapping.rb', line 83

def strategies
  @strategies ||= STRATEGIES.values_at(*self.modules).compact.uniq.reverse
end

#to ⇒ Object

Gives the class the mapping points to.



75
76
77
78
79
80
81
 
# File 'lib/devise/mapping.rb', line 75

def to
  if defined?(ActiveSupport::Dependencies::ClassCache)
    @ref.get @class_name
  else
    @ref.get
  end
end