devise 0.4.1 → 0.4.2

data/CHANGELOG.rdoc

@@ -1,3 +1,15 @@
+== 0.4.2
+
+* deprecations
+  * Renamed mail_sender to mailer_sender
+
+* enhancements
+  * skip_before_filter added in Devise controllers
+  * Use home_or_root_path on require_no_authentication as well
+  * Added devise_controller?, useful to select or reject filters in ApplicationController
+  * Allow :path_prefix to be given to devise_for 
+  * Allow default_url_options to be configured through devise (:path_prefix => "/:locale" is now supported)
+
 == 0.4.1
 
 * bug fix

data/README.rdoc

@@ -154,7 +154,7 @@ After signing in a user, confirming it's account or updating it's password, devi
 You also need to setup default url options for the mailer, if you are using confirmable or recoverable. Here's is the configuration for development:
 
   DeviseMailer.sender = "no-reply@yourapp.com"
-  ActionMailer::Base.default_url_options = { :host => 'localhost:3000' }
+  config.action_mailer.default_url_options = { :host => 'localhost:3000' }
 
 == Tidying up
 

data/app/controllers/sessions_controller.rb

@@ -1,17 +1,11 @@
 class SessionsController < ApplicationController
   include Devise::Controllers::Helpers
 
-  # Maps the messages types that comes from warden to a flash type.
-  WARDEN_MESSAGES = {
-    :unauthenticated => :success,
-    :unconfirmed => :failure
-  }
-
   before_filter :require_no_authentication, :only => [ :new, :create ]
 
   # GET /resource/sign_in
   def new
-    WARDEN_MESSAGES.each do |message, type|
+    Devise::FLASH_MESSAGES.each do |message, type|
       set_now_flash_message type, message if params.key?(message)
     end
     build_resource

data/generators/devise/templates/README

@@ -7,12 +7,13 @@ Some setup you must do manually if you haven't yet:
 
     config.action_mailer.default_url_options = { :host => 'localhost:3000' }
 
-It's a Rails required configuration.
-In production it must be the actual host your application is deployed to.
+It's a Rails required configuration. In production it must be the actual host your application is deployed to.
 
-2. Setup default sender for mails.In config/environment.rb:
+2. Setup default sender for mails. In config/environment.rb:
 
-    Notifier.sender = "test@example.com"
+    DeviseMailer.sender = "test@example.com"
+
+You can also configure this value by running script/generate devise_install and setting config.mailer_sender,
 
 3. Ensure you have defined root_url to *something* in your config/routes.rb:
 

data/generators/devise_install/templates/devise.rb

@@ -16,7 +16,7 @@ Devise.setup do |config|
   # config.remember_for = 2.weeks
 
   # Configure the e-mail address which will be shown in DeviseMailer.
-  # config.mail_sender = "foo.bar@yourapp.com"
+  # config.mailer_sender = "foo.bar@yourapp.com"
 
   # If you want to use other strategies, that are not (yet) supported by Devise,
   # you can configure them inside the config.warden block. The example below
@@ -30,4 +30,11 @@ Devise.setup do |config|
   #   end
   #   manager.default_strategies.unshift :twitter_oauth
   # end
+
+  # Configure default_url_options if you are using dynamic segments in :path_prefix
+  # for devise_for.
+  #
+  # config.default_url_options do
+  #   { :locale => I18n.locale }
+  # end
 end

data/lib/devise.rb

@@ -11,9 +11,19 @@ module Devise
   STRATEGIES  = [:rememberable, :authenticatable].freeze
   TRUE_VALUES = [true, 1, '1', 't', 'T', 'true', 'TRUE'].freeze
 
+  # Maps the messages types that comes from warden to a flash type.
+  FLASH_MESSAGES = {
+    :unauthenticated => :success,
+    :unconfirmed => :failure
+  }
+
   # Models configuration
   mattr_accessor :pepper, :stretches, :remember_for, :confirm_within
 
+  # Mappings
+  mattr_accessor :mappings
+  self.mappings = {}
+
   class << self
     # Default way to setup Devise. Run script/generate devise_install to create
     # a fresh initializer with all configuration values.
@@ -21,11 +31,16 @@ module Devise
       yield self
     end
 
+    def mail_sender=(value) #:nodoc:
+      ActiveSupport::Deprecation.warn "Devise.mail_sender= is deprecated, use Devise.mailer_sender instead"
+      DeviseMailer.sender = value
+    end
+
     # Sets the sender in DeviseMailer.
-    def mail_sender=(value)
+    def mailer_sender=(value)
       DeviseMailer.sender = value
     end
-    alias :sender= :mail_sender= 
+    alias :sender= :mailer_sender=
 
     # Sets warden configuration using a block that will be invoked on warden
     # initialization.
@@ -42,6 +57,11 @@ module Devise
       @warden_config = block
     end
 
+    # Configure default url options to be used within Devise and ActionController.
+    def default_url_options(&block)
+      Devise::Mapping.metaclass.send :define_method, :default_url_options, &block
+    end
+
     # A method used internally to setup warden manager from the Rails initialize
     # block.
     def configure_warden_manager(manager) #:nodoc:
@@ -56,5 +76,4 @@ module Devise
 end
 
 require 'devise/warden'
-require 'devise/mapping'
 require 'devise/rails'

data/lib/devise/controllers/filters.rb

@@ -6,8 +6,14 @@ module Devise
 
       def self.included(base)
         base.class_eval do
-          helper_method :warden, :signed_in?,
+          helper_method :warden, :signed_in?, :devise_controller?,
                         *Devise.mappings.keys.map { |m| [:"current_#{m}", :"#{m}_signed_in?"] }.flatten
+
+          # Use devise default_url_options. We have to declare it here to overwrite
+          # default definitions.
+          def default_url_options(options=nil)
+            Devise::Mapping.default_url_options
+          end
         end
       end
 
@@ -16,6 +22,15 @@ module Devise
         request.env['warden']
       end
 
+      # Return true if it's a devise_controller. false to all controllers unless
+      # the controllers defined inside devise. Useful if you want to apply a before
+      # filter to all controller, except the ones in devise:
+      #
+      #   before_filter :my_filter, :unless => { |c| c.devise_controller? }
+      def devise_controller?
+        false
+      end
+
       # Attempts to authenticate the given scope by running authentication hooks,
       # but does not redirect in case of failures.
       def authenticate(scope)

data/lib/devise/controllers/helpers.rb

@@ -7,9 +7,10 @@ module Devise
 
       def self.included(base)
         base.class_eval do
-          helper_method :resource, :resource_name, :resource_class, :devise_mapping
-          hide_action   :resource, :resource_name, :resource_class, :devise_mapping
+          helper_method :resource, :resource_name, :resource_class, :devise_mapping, :devise_controller?
+          hide_action   :resource, :resource_name, :resource_class, :devise_mapping, :devise_controller?
 
+          skip_before_filter *Devise.mappings.keys.map { |m| :"authenticate_#{m}!" }
           before_filter :is_devise_resource?
         end
       end
@@ -31,7 +32,12 @@ module Devise
 
       # Attempt to find the mapped route for devise based on request path
       def devise_mapping
-        @devise_mapping ||= Devise.find_mapping_by_path(request.path)
+        @devise_mapping ||= Devise::Mapping.find_by_path(request.path)
+      end
+
+      # Overwrites devise_controller? to return true
+      def devise_controller?
+        true
       end
 
     protected
@@ -91,7 +97,7 @@ module Devise
       # Example:
       #   before_filter :require_no_authentication, :only => :new
       def require_no_authentication
-        redirect_to root_path if warden.authenticated?(resource_name)
+        redirect_to home_or_root_path if warden.authenticated?(resource_name)
       end
 
       # Sets the flash message with :key, using I18n. By default you are able

data/lib/devise/failure.rb

@@ -19,7 +19,7 @@ module Devise
       end
 
       redirect_path = if mapping = Devise.mappings[scope]
-        "/#{mapping.as}/#{mapping.path_names[:sign_in]}"
+        "#{mapping.parsed_path}/#{mapping.path_names[:sign_in]}"
       else
         "/#{default_url}"
       end

data/lib/devise/mapping.rb

@@ -22,13 +22,33 @@ module Devise
   #   # is the modules included in the class
   #
   class Mapping #:nodoc:
-    attr_reader :name, :as, :path_names
+    attr_reader :name, :as, :path_names, :path_prefix
+
+    # 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
+
+    # Default url options which can be used as prefix.
+    def self.default_url_options
+      {}
+    end
+
+    def initialize(name, options) #:nodoc:
+      options.assert_valid_keys(:class_name, :as, :path_names, :singular, :path_prefix)
 
-    def initialize(name, options)
       @as    = (options[:as] || name).to_sym
       @klass = (options[:class_name] || name.to_s.classify).to_s
       @name  = (options[:singular] || name.to_s.singularize).to_sym
-      @path_names = options[:path_names] || {}
+      @path_names  = options[:path_names] || {}
+      @path_prefix = options[:path_prefix] || ""
+      @path_prefix << "/" unless @path_prefix[-1] == ?/
+
       setup_path_names
     end
 
@@ -50,6 +70,28 @@ module Devise
       self.for.include?(CONTROLLERS[controller.to_sym])
     end
 
+    # 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.
+    #
+    def parsed_path
+      returning raw_path do |path|
+        self.class.default_url_options.each do |key, value|
+          path.gsub!(key.inspect, value.to_s)
+        end
+      end
+    end
+
     # Create magic predicates for verifying what module is activated by this map.
     # Example:
     #
@@ -75,21 +117,4 @@ module Devise
         end
       end
   end
-
-  mattr_accessor :mappings
-  self.mappings = {}
-
-  # Loop through all mappings looking for a map that matches with the requested
-  # path (ie /users/sign_in). The important part here is the key :users. If no
-  # map is found just returns nil.
-  def self.find_mapping_by_path(path)
-    route = path.split("/")[1]
-    return nil unless route
-
-    route = route.to_sym
-    mappings.each do |key, map|
-      return map if map.as == route.to_sym
-    end
-    nil
-  end
 end

data/lib/devise/rails/routes.rb

@@ -59,36 +59,51 @@ module ActionController::Routing
       #  * :path_names => configure different path names to overwrite defaults :sign_in, :sign_out, :password and :confirmation.
       #
       #    map.devise_for :users, :path_names => { :sign_in => 'login', :sign_out => 'logout', :password => 'secret', :confirmation => 'verification' }
+      #
+      #  * :path_prefix => the path prefix to be used in all routes.
+      #
+      #    map.devise_for :users, :path_prefix => "/:locale"
+      #
+      #  If you are using a dynamic prefix, like :locale above, you need to configure default_url_options through Devise. You can do that in config/initializers/devise.rb or setting a Devise.default_url_options:
+      #
+      #    Devise.default_url_options do
+      #      { :locale => I18n.locale }
+      #    end
+      #
       def devise_for(*resources)
         options = resources.extract_options!
 
         resources.map!(&:to_sym)
-        options.assert_valid_keys(:class_name, :as, :path_names, :singular)
-
         resources.each do |resource|
           mapping = Devise::Mapping.new(resource, options)
           Devise.mappings[mapping.name] = mapping
 
-          if mapping.authenticatable?
-            with_options(:controller => 'sessions', :path_prefix => mapping.as) do |session|
-              session.send(:"new_#{mapping.name}_session",     mapping.path_names[:sign_in],  :action => 'new',     :conditions => { :method => :get })
-              session.send(:"#{mapping.name}_session",         mapping.path_names[:sign_in],  :action => 'create',  :conditions => { :method => :post })
-              session.send(:"destroy_#{mapping.name}_session", mapping.path_names[:sign_out], :action => 'destroy', :conditions => { :method => :get })
+          with_options(:path_prefix => mapping.raw_path, :name_prefix => "#{mapping.name}_") do |routes|
+            mapping.for.each do |strategy|
+              send(strategy, routes, mapping) if self.respond_to?(strategy, true)
             end
           end
+        end
+      end
 
-          namespace mapping.name, :namespace => nil, :path_prefix => mapping.as do |m|
-            if mapping.recoverable?
-              m.resource :password, :only => [:new, :create, :edit, :update], :as => mapping.path_names[:password]
-            end
+      protected
 
-            if mapping.confirmable?
-              m.resource :confirmation, :only => [:new, :create, :show], :as => mapping.path_names[:confirmation]
-            end
+        def authenticatable(routes, mapping)
+          routes.with_options(:controller => 'sessions', :name_prefix => nil) do |session|
+            session.send(:"new_#{mapping.name}_session",     mapping.path_names[:sign_in],  :action => 'new',     :conditions => { :method => :get })
+            session.send(:"#{mapping.name}_session",         mapping.path_names[:sign_in],  :action => 'create',  :conditions => { :method => :post })
+            session.send(:"destroy_#{mapping.name}_session", mapping.path_names[:sign_out], :action => 'destroy', :conditions => { :method => :get })
           end
         end
-      end
-    end
 
+        def recoverable(routes, mapping)
+          routes.resource :password, :only => [:new, :create, :edit, :update], :as => mapping.path_names[:password]
+        end
+
+        def confirmable(routes, mapping)
+          routes.resource :confirmation, :only => [:new, :create, :show], :as => mapping.path_names[:confirmation]
+        end
+
+    end
   end
 end

data/lib/devise/version.rb

@@ -1,3 +1,3 @@
 module Devise
-  VERSION = "0.4.1".freeze
+  VERSION = "0.4.2".freeze
 end

data/test/controllers/filters_test.rb

@@ -87,4 +87,17 @@ class ControllerAuthenticableTest < ActionController::TestCase
     @mock_warden.expects(:set_user).with(user = mock, :scope => :user).returns(true)
     @controller.sign_in(:user, user)
   end
+
+  test 'is not a devise controller' do
+    assert_not @controller.devise_controller?
+  end
+
+  test 'default url options are retrieved from devise' do
+    begin
+      Devise.default_url_options {{ :locale => I18n.locale }}
+      assert_equal({ :locale => :en }, @controller.send(:default_url_options))
+    ensure
+      Devise.default_url_options {{ }}
+    end
+  end
 end

data/test/controllers/helpers_test.rb

@@ -43,9 +43,13 @@ class HelpersTest < ActionController::TestCase
   end
 
   test 'require no authentication tests current mapping' do
-    @controller.expects(:resource_name).returns(:user)
+    @controller.expects(:resource_name).returns(:user).twice
     @mock_warden.expects(:authenticated?).with(:user).returns(true)
     @controller.expects(:redirect_to).with(root_path)
     @controller.send :require_no_authentication
   end
+  
+  test 'is a devise controller' do
+    assert @controller.devise_controller?
+  end
 end

data/test/devise_test.rb

@@ -27,7 +27,7 @@ class DeviseTest < ActiveSupport::TestCase
   test 'DeviseMailer.sender can be configured through Devise' do
     swap DeviseMailer, :sender => "foo@bar" do
       assert_equal "foo@bar", DeviseMailer.sender
-      Devise.mail_sender = "bar@foo"
+      Devise.mailer_sender = "bar@foo"
       assert_equal "bar@foo", DeviseMailer.sender
     end
   end

data/test/integration/authenticatable_test.rb

@@ -114,7 +114,7 @@ class AuthenticationTest < ActionController::IntegrationTest
     get new_admin_session_path
 
     assert_response :redirect
-    assert_redirected_to root_path
+    assert_redirected_to admin_root_path
     assert warden.authenticated?(:admin)
   end
 

data/test/mapping_test.rb

@@ -31,12 +31,12 @@ class MappingTest < ActiveSupport::TestCase
   end
 
   test 'return mapping by path' do
-    assert_nil   Devise.find_mapping_by_path("/foo/bar")
-    assert_equal Devise.mappings[:user], Devise.find_mapping_by_path("/users/session")
+    assert_nil   Devise::Mapping.find_by_path("/foo/bar")
+    assert_equal Devise.mappings[:user], Devise::Mapping.find_by_path("/users/session")
   end
 
   test 'return mapping by customized path' do
-    assert_equal Devise.mappings[:admin], Devise.find_mapping_by_path("/admin_area/session")
+    assert_equal Devise.mappings[:admin], Devise::Mapping.find_by_path("/admin_area/session")
   end
 
   test 'return default path names' do
@@ -55,6 +55,36 @@ class MappingTest < ActiveSupport::TestCase
     assert_equal 'verification', mapping.path_names[:confirmation]
   end
 
+  test 'has an empty path as default path prefix' do
+    mapping = Devise.mappings[:account]
+    assert_equal '/', mapping.path_prefix
+  end
+
+  test 'allow path prefix to be configured' do
+    mapping = Devise.mappings[:manager]
+    assert_equal '/:locale/', mapping.path_prefix
+  end
+
+  test 'retrieve as from the proper position' do
+    assert_equal 1, Devise.mappings[:account].as_position
+    assert_equal 2, Devise.mappings[:manager].as_position
+  end
+
+  test 'raw path is returned' do
+    assert_equal '/account', Devise.mappings[:account].raw_path
+    assert_equal '/:locale/organizers', Devise.mappings[:manager].raw_path
+  end
+
+  test 'parsed path is returned' do
+    begin
+      Devise.default_url_options {{ :locale => I18n.locale }}
+      assert_equal '/account', Devise.mappings[:account].parsed_path
+      assert_equal '/en/organizers', Devise.mappings[:manager].parsed_path
+    ensure
+      Devise.default_url_options {{ }}
+    end
+  end
+
   test 'magic predicates' do
     mapping = Devise.mappings[:user]
     assert mapping.authenticatable?

data/test/rails_app/config/routes.rb

@@ -4,7 +4,7 @@ ActionController::Routing::Routes.draw do |map|
   map.devise_for :account, :path_names => {
     :sign_in => 'login', :sign_out => 'logout', :password => 'secret', :confirmation => 'verification'
   }
-  map.devise_for :organizers, :singular => 'manager'
+  map.devise_for :organizers, :singular => 'manager', :path_prefix => '/:locale'
 
   map.resources :users, :only => :index
   map.resources :admins, :only => :index

data/test/routes_test.rb

@@ -69,7 +69,11 @@ class MapRoutingTest < ActionController::TestCase
   end
 
   test 'map organizer with custom singular name' do
-    assert_recognizes({:controller => 'passwords', :action => 'new'}, 'organizers/password/new')
+    assert_recognizes({:controller => 'passwords', :action => 'new', :locale => "en"}, '/en/organizers/password/new')
+  end
+
+  test 'map organizer with path prefix' do
+    assert_recognizes({:controller => 'sessions', :action => 'new', :locale => "en"}, '/en/organizers/sign_in')
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: devise
 version: !ruby/object:Gem::Version 
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors: 
 - "Jos\xC3\xA9 Valim"
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-04 00:00:00 -02:00
+date: 2009-11-06 00:00:00 -02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -112,43 +112,43 @@ signing_key:
 specification_version: 3
 summary: Flexible authentication solution for Rails with Warden
 test_files: 
-- test/controllers/filters_test.rb
-- test/controllers/helpers_test.rb
+- test/rails_app/config/boot.rb
+- test/rails_app/config/routes.rb
+- test/rails_app/config/environments/development.rb
+- test/rails_app/config/environments/production.rb
+- test/rails_app/config/environments/test.rb
+- test/rails_app/config/environment.rb
+- test/rails_app/config/initializers/session_store.rb
+- test/rails_app/config/initializers/new_rails_defaults.rb
+- test/rails_app/app/controllers/users_controller.rb
+- test/rails_app/app/controllers/application_controller.rb
+- test/rails_app/app/controllers/admins_controller.rb
+- test/rails_app/app/controllers/home_controller.rb
+- test/rails_app/app/helpers/application_helper.rb
+- test/rails_app/app/models/admin.rb
+- test/rails_app/app/models/organizer.rb
+- test/rails_app/app/models/account.rb
+- test/rails_app/app/models/user.rb
 - test/controllers/url_helpers_test.rb
-- test/devise_test.rb
-- test/failure_test.rb
+- test/controllers/helpers_test.rb
+- test/controllers/filters_test.rb
+- test/models_test.rb
 - test/integration/authenticatable_test.rb
-- test/integration/confirmable_test.rb
-- test/integration/recoverable_test.rb
 - test/integration/rememberable_test.rb
+- test/integration/recoverable_test.rb
+- test/integration/confirmable_test.rb
 - test/mailers/confirmation_instructions_test.rb
 - test/mailers/reset_password_instructions_test.rb
-- test/mapping_test.rb
 - test/models/authenticatable_test.rb
-- test/models/confirmable_test.rb
-- test/models/recoverable_test.rb
 - test/models/rememberable_test.rb
+- test/models/recoverable_test.rb
 - test/models/validatable_test.rb
-- test/models_test.rb
-- test/rails_app/app/controllers/admins_controller.rb
-- test/rails_app/app/controllers/application_controller.rb
-- test/rails_app/app/controllers/home_controller.rb
-- test/rails_app/app/controllers/users_controller.rb
-- test/rails_app/app/helpers/application_helper.rb
-- test/rails_app/app/models/account.rb
-- test/rails_app/app/models/admin.rb
-- test/rails_app/app/models/organizer.rb
-- test/rails_app/app/models/user.rb
-- test/rails_app/config/boot.rb
-- test/rails_app/config/environment.rb
-- test/rails_app/config/environments/development.rb
-- test/rails_app/config/environments/production.rb
-- test/rails_app/config/environments/test.rb
-- test/rails_app/config/initializers/new_rails_defaults.rb
-- test/rails_app/config/initializers/session_store.rb
-- test/rails_app/config/routes.rb
-- test/routes_test.rb
+- test/models/confirmable_test.rb
+- test/failure_test.rb
+- test/support/model_tests_helper.rb
 - test/support/assertions_helper.rb
 - test/support/integration_tests_helper.rb
-- test/support/model_tests_helper.rb
+- test/devise_test.rb
+- test/routes_test.rb
 - test/test_helper.rb
+- test/mapping_test.rb