thoughtbot-clearance 0.4.5 → 0.4.6

data/CHANGELOG.textile

@@ -1,4 +1,9 @@
-h2. 0.4.5 (unreleased)
+h2. 0.4.6 (2/11/2009)
+
+* making the modules behave like mixins again. (hat-tip Eloy Duran)
+* created Actions and PrivateMethods modules on controllers for future RDoc reasons.
+
+h2. 0.4.5 (2/9/2009)
 
 * [#43] Removed email downcasing. (local-part is case sensitive per RFC5321)
 * [#42] Removed dependency on Mocha.

data/KNOWN_ISSUES.textile

@@ -0,0 +1,11 @@
+h1. Known Issues
+
+h2. Rails 2.3
+
+* default_test failures - this is a "Rails 2.3 bug":http://is.gd/iZkY
+* CGI::Cookie.new('token', 'value') returns nil "[#42]":http://is.gd/iZlO
+* application.rb/application_controller.rb "[#44]":http://is.gd/iZl5
+
+h2. i18n
+
+* flash messages are in English-only "[#40]":http://is.gd/iZmq & "[#24]":http://is.gd/iZmz

data/README.textile

@@ -15,7 +15,7 @@ In config/environment.rb:
     config.gem "thoughtbot-clearance", 
       :lib     => 'clearance', 
       :source  => 'http://gems.github.com', 
-      :version => '>= 0.4.3'
+      :version => '>= 0.4.5'
 
 In config/environments/test.rb:
 

data/Rakefile

@@ -50,7 +50,7 @@ task :default => ['test:all', 'test:features']
 
 gem_spec = Gem::Specification.new do |gem_spec|
   gem_spec.name        = "clearance"
-  gem_spec.version     = "0.4.5"
+  gem_spec.version     = "0.4.6"
   gem_spec.summary     = "Rails authentication for developers who write tests."
   gem_spec.email       = "support@thoughtbot.com"
   gem_spec.homepage    = "http://github.com/thoughtbot/clearance"

data/lib/clearance/app/controllers/application_controller.rb

@@ -4,76 +4,77 @@ module Clearance
       module ApplicationController
     
         def self.included(controller)
+          controller.send(:include, InstanceMethods)
+          
           controller.class_eval do
-                      
             helper_method :current_user
             helper_method :signed_in?
             
             hide_action :current_user, :signed_in?
+          end
+        end
         
-            def current_user
-              @_current_user ||= (user_from_session || user_from_cookie)
-            end
+        module InstanceMethods
+          def current_user
+            @_current_user ||= (user_from_session || user_from_cookie)
+          end
 
-            def signed_in?
-              ! current_user.nil?
-            end
-            
-            protected
-            
-            def authenticate
-              deny_access unless signed_in?
-            end
+          def signed_in?
+            ! current_user.nil?
+          end
+          
+          protected
+          
+          def authenticate
+            deny_access unless signed_in?
+          end
 
-            def user_from_session
-              if session[:user_id]
-                user = User.find_by_id(session[:user_id])
-                user && user.email_confirmed? ? user : nil                
-              end
+          def user_from_session
+            if session[:user_id]
+              user = User.find_by_id(session[:user_id])
+              user && user.email_confirmed? ? user : nil                
             end
+          end
 
-            def user_from_cookie
-              if cookies[:remember_token]
-                user = User.find_by_token(cookies[:remember_token])
-                user && user.remember? ? user : nil                
-              end
+          def user_from_cookie
+            if cookies[:remember_token]
+              user = User.find_by_token(cookies[:remember_token])
+              user && user.remember? ? user : nil                
             end
+          end
 
-            # Hook
-            def sign_user_in(user)
-              sign_in(user)
-            end
+          def sign_user_in(user)
+            sign_in(user)
+          end
 
-            def sign_in(user)
-              if user
-                session[:user_id] = user.id
-              end
+          def sign_in(user)
+            if user
+              session[:user_id] = user.id
             end
+          end
 
-            def redirect_back_or(default)
-              session[:return_to] ||= params[:return_to]
-              if session[:return_to] 
-                redirect_to(session[:return_to])
-              else 
-                redirect_to(default)
-              end
-              session[:return_to] = nil
+          def redirect_back_or(default)
+            session[:return_to] ||= params[:return_to]
+            if session[:return_to] 
+              redirect_to(session[:return_to])
+            else 
+              redirect_to(default)
             end
+            session[:return_to] = nil
+          end
 
-            def redirect_to_root
-              redirect_to root_url
-            end
+          def redirect_to_root
+            redirect_to root_url
+          end
 
-            def store_location
-              session[:return_to] = request.request_uri if request.get?
-            end
+          def store_location
+            session[:return_to] = request.request_uri if request.get?
+          end
 
-            def deny_access(flash_message = nil, opts = {})
-              store_location
-              flash[:failure] = flash_message if flash_message
-              render :template => "/sessions/new", :status => :unauthorized 
-            end
-            
+          def deny_access(flash_message = nil, opts = {})
+            store_location
+            flash[:failure] = flash_message if flash_message
+            render :template => "/sessions/new", :status => :unauthorized 
           end
         end
         

data/lib/clearance/app/controllers/confirmations_controller.rb

@@ -4,45 +4,50 @@ module Clearance
       module ConfirmationsController
     
         def self.included(controller)
+          controller.send(:include, Actions)
+          controller.send(:include, PrivateMethods)
+          
           controller.class_eval do
-            
             before_filter :email_confirmed_user?, :only => :new
             before_filter :existing_user?, :only => :new
-            filter_parameter_logging :token
+            filter_parameter_logging :token    
+          end
+        end
         
-            def new
-              create
-            end
+        module Actions
+          def new
+            create
+          end
 
-            def create
-              @user.confirm_email!
-              sign_user_in(@user)
-              flash[:success] = "Confirmed email and signed in."
-              redirect_to url_after_create
-            end
+          def create
+            @user.confirm_email!
+            sign_user_in(@user)
+            flash[:success] = "Confirmed email and signed in."
+            redirect_to url_after_create
+          end
+        end
         
-            private
-            
-            def email_confirmed_user?
-              @user = User.find_by_id(params[:user_id])
-              if @user.nil?
-                render :nothing => true, :status => :not_found
-              elsif @user.email_confirmed?
-                redirect_to new_session_url
-              end
+        module PrivateMethods
+          private
+          
+          def email_confirmed_user?
+            @user = User.find_by_id(params[:user_id])
+            if @user.nil?
+              render :nothing => true, :status => :not_found
+            elsif @user.email_confirmed?
+              redirect_to new_session_url
             end
-            
-            def existing_user?
-              @user = User.find_by_id_and_token(params[:user_id], params[:token])
-              if @user.nil?
-                render :nothing => true, :status => :not_found
-              end
+          end
+          
+          def existing_user?
+            @user = User.find_by_id_and_token(params[:user_id], params[:token])
+            if @user.nil?
+              render :nothing => true, :status => :not_found
             end
+          end
 
-            def url_after_create
-              root_url
-            end
-            
+          def url_after_create
+            root_url
           end
         end
         

data/lib/clearance/app/controllers/passwords_controller.rb

@@ -4,57 +4,62 @@ module Clearance
       module PasswordsController
 
         def self.included(controller)
-          controller.class_eval do
-            
+          controller.send(:include, Actions)
+          controller.send(:include, PrivateMethods)
+          
+          controller.class_eval do  
             before_filter :existing_user?, :only => [:edit, :update]
             filter_parameter_logging :password, :password_confirmation
-            
-            def new
-            end
+          end
+        end
+        
+        module Actions
+          def new
+          end
 
-            def create
-              user = User.find_by_email(params[:password][:email])
-              if user.nil?
-                flash.now[:notice] = "Unknown email"
-                render :action => :new
-              else
-                user.forgot_password!
-                ClearanceMailer.deliver_change_password user
-                flash[:notice] = "Details for changing your password " <<
-                                 "have been sent to #{user.email}"
-                redirect_to url_after_create
-              end
+          def create
+            user = User.find_by_email(params[:password][:email])
+            if user.nil?
+              flash.now[:notice] = "Unknown email"
+              render :action => :new
+            else
+              user.forgot_password!
+              ClearanceMailer.deliver_change_password user
+              flash[:notice] = "Details for changing your password " <<
+                               "have been sent to #{user.email}"
+              redirect_to url_after_create
             end
+          end
 
-            def edit
-            end
+          def edit
+          end
 
-            def update
-              if @user.update_password(params[:user])
-                sign_user_in(@user)
-                redirect_to url_after_update
-              else
-                render :action => :edit
-              end
+          def update
+            if @user.update_password(params[:user])
+              sign_user_in(@user)
+              redirect_to url_after_update
+            else
+              render :action => :edit
             end
-            
-            private
-            
-            def existing_user?
-              @user = User.find_by_id_and_token(params[:user_id], params[:token])
-              if @user.nil?
-                render :nothing => true, :status => :not_found
-              end
+          end
+        end
+        
+        module PrivateMethods  
+          private
+          
+          def existing_user?
+            @user = User.find_by_id_and_token(params[:user_id], params[:token])
+            if @user.nil?
+              render :nothing => true, :status => :not_found
             end
+          end
 
-            def url_after_create
-              new_session_url
-            end
-            
-            def url_after_update
-              root_url
-            end
-            
+          def url_after_create
+            new_session_url
+          end
+          
+          def url_after_update
+            root_url
           end
         end
         

data/lib/clearance/app/controllers/sessions_controller.rb

@@ -4,62 +4,67 @@ module Clearance
       module SessionsController
 
         def self.included(controller)
+          controller.send(:include, Actions)
+          controller.send(:include, PrivateMethods)
+          
           controller.class_eval do
-            
             protect_from_forgery :except => :create
-            filter_parameter_logging :password
+            filter_parameter_logging :password            
+          end
+        end
         
-            def create
-              @user = User.authenticate(params[:session][:email], 
-                                        params[:session][:password])
-              if @user.nil?
-                flash.now[:notice] = "Bad email or password."
-                render :action => :new
+        module Actions
+          def create
+            @user = User.authenticate(params[:session][:email], 
+                                      params[:session][:password])
+            if @user.nil?
+              flash.now[:notice] = "Bad email or password."
+              render :action => :new
+            else
+              if @user.email_confirmed?
+                remember(@user) if remember?
+                sign_user_in(@user)
+                flash[:notice] = "Signed in successfully"
+                redirect_back_or url_after_create
               else
-                if @user.email_confirmed?
-                  remember(@user) if remember?
-                  sign_user_in(@user)
-                  flash[:notice] = "Signed in successfully"
-                  redirect_back_or url_after_create
-                else
-                  ClearanceMailer.deliver_confirmation(@user)
-                  deny_access("User has not confirmed email.  Confirmation email will be resent.")
-                end
+                ClearanceMailer.deliver_confirmation(@user)
+                deny_access("User has not confirmed email.  Confirmation email will be resent.")
               end
             end
+          end
 
-            def destroy
-              forget(current_user)
-              reset_session
-              flash[:notice] = "You have been signed out."
-              redirect_to url_after_destroy
-            end
+          def destroy
+            forget(current_user)
+            reset_session
+            flash[:notice] = "You have been signed out."
+            redirect_to url_after_destroy
+          end
+        end
         
-            private
-            
-            def remember?
-              params[:session] && params[:session][:remember_me] == "1"
-            end
-            
-            def remember(user)
-              user.remember_me!
-              cookies[:remember_token] = { :value   => user.token, 
-                                           :expires => user.token_expires_at }
-            end
+        module PrivateMethods
+          private
+          
+          def remember?
+            params[:session] && params[:session][:remember_me] == "1"
+          end
+          
+          def remember(user)
+            user.remember_me!
+            cookies[:remember_token] = { :value   => user.token, 
+                                         :expires => user.token_expires_at }
+          end
 
-            def forget(user)
-              user.forget_me! if user
-              cookies.delete :remember_token
-            end
+          def forget(user)
+            user.forget_me! if user
+            cookies.delete :remember_token
+          end
 
-            def url_after_create
-              root_url
-            end
+          def url_after_create
+            root_url
+          end
 
-            def url_after_destroy
-              new_session_url
-            end
-            
+          def url_after_destroy
+            new_session_url
           end
         end
           

data/lib/clearance/app/controllers/users_controller.rb

@@ -4,33 +4,38 @@ module Clearance
       module UsersController
 
         def self.included(controller)
+          controller.send(:include, Actions)
+          controller.send(:include, PrivateMethods)
+          
           controller.class_eval do
-            
             before_filter :redirect_to_root, :only => [:new, :create], :if => :signed_in?
-            filter_parameter_logging :password
+            filter_parameter_logging :password      
+          end
+        end
         
-            def new
-              @user = User.new(params[:user])
-            end
+        module Actions
+          def new
+            @user = User.new(params[:user])
+          end
 
-            def create
-              @user = User.new params[:user]
-              if @user.save
-                ClearanceMailer.deliver_confirmation @user
-                flash[:notice] = "You will receive an email within the next few minutes. " <<
-                                 "It contains instructions for you to confirm your account."
-                redirect_to url_after_create
-              else
-                render :action => "new"
-              end
+          def create
+            @user = User.new params[:user]
+            if @user.save
+              ClearanceMailer.deliver_confirmation @user
+              flash[:notice] = "You will receive an email within the next few minutes. " <<
+                               "It contains instructions for you to confirm your account."
+              redirect_to url_after_create
+            else
+              render :action => "new"
             end
+          end
+        end
         
-            private
-            
-            def url_after_create
-              new_session_url
-            end
-            
+        module PrivateMethods
+          private
+          
+          def url_after_create
+            new_session_url
           end
         end
 

data/lib/clearance/app/models/clearance_mailer.rb

@@ -2,25 +2,19 @@ module Clearance
   module App
     module Models
       module ClearanceMailer
-    
-        def self.included(mailer)
-          mailer.class_eval do
         
-            def change_password(user)
-              from       DO_NOT_REPLY
-              recipients user.email
-              subject    "Change your password"
-              body       :user => user
-            end
+        def change_password(user)
+          from       DO_NOT_REPLY
+          recipients user.email
+          subject    "Change your password"
+          body       :user => user
+        end
 
-            def confirmation(user)
-              from       DO_NOT_REPLY
-              recipients user.email
-              subject   "Account confirmation"
-              body      :user => user
-            end
-        
-          end
+        def confirmation(user)
+          from       DO_NOT_REPLY
+          recipients user.email
+          subject   "Account confirmation"
+          body      :user => user
         end
         
       end

data/lib/clearance/app/models/user.rb

@@ -6,8 +6,10 @@ module Clearance
       module User
     
         def self.included(model)
+          model.extend ClassMethods
+          model.send(:include, InstanceMethods)
+          
           model.class_eval do
-        
             attr_accessible :email, :password, :password_confirmation
             attr_accessor :password, :password_confirmation
 
@@ -18,95 +20,98 @@ module Clearance
             validates_format_of       :email, :with => %r{.+@.+\..+}
 
             before_save :initialize_salt, :encrypt_password, :initialize_token
+          end
+        end
         
-            def self.authenticate(email, password)
-              user = find(:first, :conditions => ['email = ?', email.to_s])
-              user && user.authenticated?(password) ? user : nil
-            end
+        module InstanceMethods
+          def authenticated?(password)
+            encrypted_password == encrypt(password)
+          end
 
-            def authenticated?(password)
-              encrypted_password == encrypt(password)
-            end
+          def encrypt(string)
+            generate_hash("--#{salt}--#{string}--")
+          end
 
-            def encrypt(string)
-              generate_hash("--#{salt}--#{string}--")
-            end
+          def remember?
+            token_expires_at && Time.now.utc < token_expires_at
+          end
 
-            def remember?
-              token_expires_at && Time.now.utc < token_expires_at
-            end
+          def remember_me!
+            remember_me_until 2.weeks.from_now.utc
+          end
 
-            def remember_me!
-              remember_me_until 2.weeks.from_now.utc
-            end
+          def remember_me_until(time)
+            self.token_expires_at = time
+            self.token            = encrypt("--#{token_expires_at}--#{password}--")
+            save(false)                
+          end
 
-            def remember_me_until(time)
-              self.token_expires_at = time
-              self.token            = encrypt("--#{token_expires_at}--#{password}--")
-              save(false)                
-            end
+          def forget_me!
+            clear_token
+            save(false)
+          end
 
-            def forget_me!
-              clear_token
-              save(false)
-            end
+          def confirm_email!
+            self.email_confirmed  = true
+            self.token            = nil
+            save(false)
+          end
 
-            def confirm_email!
-              self.email_confirmed  = true
-              self.token            = nil
-              save(false)
-            end
-            
-            def forgot_password!
-              generate_token
-              save(false)
-            end
-            
-            def update_password(attrs)
-              clear_token
-              returning update_attributes(attrs) do |r|
-                reload unless r
-              end                                          
-            end
-        
-            protected
-            
-            def generate_hash(string)
-              Digest::SHA1.hexdigest(string)
-            end
+          def forgot_password!
+            generate_token
+            save(false)
+          end
 
-            def initialize_salt
-              if new_record?
-                self.salt = generate_hash("--#{Time.now.utc.to_s}--#{password}--")
-              end
-            end
+          def update_password(attrs)
+            clear_token
+            returning update_attributes(attrs) do |r|
+              reload unless r
+            end                                          
+          end
+          
+          protected
+          
+          def generate_hash(string)
+            Digest::SHA1.hexdigest(string)
+          end
 
-            def encrypt_password
-              return if password.blank?
-              self.encrypted_password = encrypt(password)
-            end
-            
-            def generate_token
-              self.token = encrypt("--#{Time.now.utc.to_s}--#{password}--")
-              self.token_expires_at = nil              
-            end
-            
-            def clear_token
-              self.token            = nil
-              self.token_expires_at = nil            
-            end
-            
-            def initialize_token
-              generate_token if new_record?
+          def initialize_salt
+            if new_record?
+              self.salt = generate_hash("--#{Time.now.utc.to_s}--#{password}--")
             end
+          end
 
-            def password_required?
-              encrypted_password.blank? || !password.blank?
-            end
-            
+          def encrypt_password
+            return if password.blank?
+            self.encrypted_password = encrypt(password)
+          end
+          
+          def generate_token
+            self.token = encrypt("--#{Time.now.utc.to_s}--#{password}--")
+            self.token_expires_at = nil              
+          end
+          
+          def clear_token
+            self.token            = nil
+            self.token_expires_at = nil            
+          end
+          
+          def initialize_token
+            generate_token if new_record?
+          end
+
+          def password_required?
+            encrypted_password.blank? || !password.blank?
           end
         end
-  
+        
+        module ClassMethods
+          def authenticate(email, password)
+            user = find(:first, :conditions => ['email = ?', email.to_s])
+            user && user.authenticated?(password) ? user : nil
+          end
+        end
+        
       end
     end
   end

data/lib/clearance/test/test_helper.rb

@@ -2,23 +2,17 @@ module Clearance
   module Test
     module TestHelper
     
-      def self.included(test_helper)
-        test_helper.class_eval do
-          
-          def sign_in_as(user = nil)
-            unless user
-              user = Factory(:user)
-              user.confirm_email!
-            end
-            @request.session[:user_id] = user.id
-            return user
-          end
-
-          def sign_out 
-            @request.session[:user_id] = nil
-          end
-          
+      def sign_in_as(user = nil)
+        unless user
+          user = Factory(:user)
+          user.confirm_email!
         end
+        @request.session[:user_id] = user.id
+        return user
+      end
+
+      def sign_out 
+        @request.session[:user_id] = nil
       end
  
     end 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: thoughtbot-clearance
 version: !ruby/object:Gem::Version 
-  version: 0.4.5
+  version: 0.4.6
 platform: ruby
 authors: 
 - thoughtbot, inc.
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-02-08 21:00:00 -08:00
+date: 2009-02-10 21:00:00 -08:00
 default_executable: 
 dependencies: []
 
@@ -29,6 +29,7 @@ extra_rdoc_files: []
 
 files: 
 - CHANGELOG.textile
+- KNOWN_ISSUES.textile
 - LICENSE
 - Rakefile
 - README.textile