thoughtbot-clearance 0.6.6 → 0.6.7

data/CHANGELOG.textile

@@ -1,9 +1,21 @@
-h2. 0.6.6 (5/18/2009)
+h2. 0.6.7 (06/13/2009)
+
+* [#30] Added sign_up, sign_in, sign_out named routes. (Dan Croak)
+* [#22] Minimizing Reek smell: Duplication in redirect_back_or. (Dan Croak)
+* Deprecated sign_user_in. Told developers to use sign_in instead. (Dan
+Croak)
+* [#16] flash_success_after_create, flash_notice_after_create, flash_failure_after_create, flash_sucess_after_update, flash_success_after_destroy, etc. (Dan Croak)
+* [#17] bug. added #create to forbidden before_filters on confirmations controller. (Dan Croak)
+* [#24] should_be_signed_in_as shouldn't look in the session. (Dan Croak)
+* README improvements. (Dan Croak)
+* Move routes loading to separate file. (Joshua Clayton)
+
+h2. 0.6.6 (05/18/2009)
 
 * [#14] replaced class_eval in Clearance::User with modules. This was needed
 in a thoughtbot client app so we could write our own validations. (Dan Croak)
 
-h2. 0.6.5 (5/17/2009)
+h2. 0.6.5 (05/17/2009)
 
 * [#6] Make Clearance i18n aware. (Timur Vafin, Marcel Goerner, Eugene Bolshakov, Dan Croak)
 

data/README.textile

@@ -8,7 +8,7 @@ h2. Wiki
 
 Most information regarding Clearance is on the "Github Wiki":http://wiki.github.com/thoughtbot/clearance.
 
-h2. Engine
+h2. Installation
 
 Clearance is a Rails engine. It works with versions of Rails greater than 2.3.
 
@@ -18,7 +18,7 @@ In config/environment.rb:
 config.gem "thoughtbot-clearance", 
   :lib     => 'clearance', 
   :source  => 'http://gems.github.com', 
-  :version => '0.6.4'
+  :version => '0.6.6'
 </pre>
 
 Vendor the gem:
@@ -40,8 +40,6 @@ Run the migration:
 
 @rake db:migrate@
 
-h2. Environment
-
 Define a HOST constant in your environment files.
 In config/environments/test.rb and config/environments/development.rb it can be:
 
@@ -82,9 +80,9 @@ rake gems:install RAILS_ENV=test
 rake gems:unpack  RAILS_ENV=test
 </pre>
 
-Don't vendor nokogiri (due to its native extensions):
+We don't vendor nokogiri due to its native extensions, so install it normally on your machine:
 
-@rm -rf vendor/gems/nokogiri-1.2.3@
+@sudo gem install nokogiri@
 
 Run the Cucumber generator (if you haven't already) and Clearance's feature generator:
 
@@ -111,9 +109,9 @@ end
 
 h2. Authors
 
-Clearance was extracted out of "Hoptoad":http://hoptoadapp.com. We merged the authentication code from two of thoughtbot's client's Rails apps and have since used it each time we need authentication. The following people have improved the library. Thank you!
+Clearance was extracted out of "Hoptoad":http://hoptoadapp.com. We merged the authentication code from two of thoughtbot's clients' Rails apps and have since used it each time we need authentication. The following people have improved the library. Thank you!
 
-Dan Croak, Mike Burns, Jason Morrison, Joe Ferris, Eugene Bolshakov, Nick Quaranto, Josh Nichols, Mike Breen, Marcel Görner, Bence Nagy, Ben Mabey, Eloy Duran, Tim Pope, Mihai Anca, Mark Cornick, & Shay Arnett.
+Dan Croak, Mike Burns, Jason Morrison, Joe Ferris, Eugene Bolshakov, Nick Quaranto, Josh Nichols, Mike Breen, Marcel Görner, Bence Nagy, Ben Mabey, Eloy Duran, Tim Pope, Mihai Anca, Mark Cornick, Shay Arnett, Joshua Clayton & Mustafa Ekim.
 
 h2. Questions?
 

data/Rakefile

@@ -51,7 +51,7 @@ task :default => ['test:all', 'test:features']
 
 gem_spec = Gem::Specification.new do |gem_spec|
   gem_spec.name        = "clearance"
-  gem_spec.version     = "0.6.6"
+  gem_spec.version     = "0.6.7"
   gem_spec.summary     = "Rails authentication with email & password."
   gem_spec.email       = "support@thoughtbot.com"
   gem_spec.homepage    = "http://github.com/thoughtbot/clearance"
@@ -71,3 +71,4 @@ task :gemspec do
     f.write gem_spec.to_yaml
   end
 end
+

data/app/controllers/clearance/confirmations_controller.rb

@@ -1,9 +1,9 @@
 class Clearance::ConfirmationsController < ApplicationController
   unloadable
 
-  before_filter :forbid_confirmed_user,    :only => :new
-  before_filter :forbid_missing_token,     :only => :new
-  before_filter :forbid_non_existent_user, :only => :new
+  before_filter :forbid_confirmed_user,    :only => [:new, :create]
+  before_filter :forbid_missing_token,     :only => [:new, :create]
+  before_filter :forbid_non_existent_user, :only => [:new, :create]
   filter_parameter_logging :token
 
   def new
@@ -14,11 +14,9 @@ class Clearance::ConfirmationsController < ApplicationController
     @user = ::User.find_by_id_and_token(params[:user_id], params[:token])
     @user.confirm_email!
 
-    sign_user_in(@user)
-    flash[:success] = translate(:confirmed_email,
-      :scope   => [:clearance, :controllers, :confirmations],
-      :default => "Confirmed email and signed in.")
-    redirect_to url_after_create
+    sign_in(@user)
+    flash_success_after_create
+    redirect_to(url_after_create)
   end
 
   private
@@ -42,6 +40,12 @@ class Clearance::ConfirmationsController < ApplicationController
     end
   end
 
+  def flash_success_after_create
+    flash[:success] = translate(:confirmed_email,
+      :scope   => [:clearance, :controllers, :confirmations],
+      :default => "Confirmed email and signed in.")
+  end
+
   def url_after_create
     root_url
   end

data/app/controllers/clearance/passwords_controller.rb

@@ -13,15 +13,10 @@ class Clearance::PasswordsController < ApplicationController
     if user = ::User.find_by_email(params[:password][:email])
       user.forgot_password!
       ::ClearanceMailer.deliver_change_password user
-      flash[:notice] = translate(:deliver_change_password,
-        :scope   => [:clearance, :controllers, :passwords],
-        :default => "You will receive an email within the next few minutes. " <<
-                    "It contains instructions for changing your password.")
-      redirect_to url_after_create
+      flash_notice_after_create
+      redirect_to(url_after_create)
     else
-      flash.now[:failure] = translate(:unknown_email,
-        :scope   => [:clearance, :controllers, :passwords],
-        :default => "Unknown email.")
+      flash_failure_after_create
       render :template => 'passwords/new'
     end
   end
@@ -36,10 +31,10 @@ class Clearance::PasswordsController < ApplicationController
 
     if @user.update_password(params[:user][:password],
                              params[:user][:password_confirmation])
-      @user.confirm_email! unless @user.email_confirmed?
-      sign_user_in(@user)
-      flash[:success] = translate(:signed_in, :default => "Signed in.")
-      redirect_to url_after_update
+      @user.confirm_email!
+      sign_in(@user)
+      flash_success_after_update
+      redirect_to(url_after_update)
     else
       render :template => 'passwords/edit'
     end
@@ -59,10 +54,27 @@ class Clearance::PasswordsController < ApplicationController
     end
   end
 
+  def flash_notice_after_create
+    flash[:notice] = translate(:deliver_change_password,
+      :scope   => [:clearance, :controllers, :passwords],
+      :default => "You will receive an email within the next few minutes. " <<
+                  "It contains instructions for changing your password.")
+  end
+
+  def flash_failure_after_create
+    flash.now[:failure] = translate(:unknown_email,
+      :scope   => [:clearance, :controllers, :passwords],
+      :default => "Unknown email.")
+  end
+
   def url_after_create
     new_session_url
   end
 
+  def flash_success_after_update
+    flash[:success] = translate(:signed_in, :default => "Signed in.")
+  end
+
   def url_after_update
     root_url
   end

data/app/controllers/clearance/sessions_controller.rb

@@ -10,40 +10,57 @@ class Clearance::SessionsController < ApplicationController
 
   def create
     @user = ::User.authenticate(params[:session][:email],
-                              params[:session][:password])
+                                params[:session][:password])
     if @user.nil?
-      flash.now[:failure] = translate(:bad_email_or_password,
-        :scope   => [:clearance, :controllers, :sessions],
-        :default => "Bad email or password.")
+      flash_failure_after_create
       render :template => 'sessions/new', :status => :unauthorized
     else
       if @user.email_confirmed?
-        sign_user_in(@user)
+        sign_in(@user)
         remember(@user) if remember?
-        flash[:success] = translate(:signed_in, :default =>  "Signed in.")
-        redirect_back_or url_after_create
+        flash_success_after_create
+        redirect_back_or(url_after_create)
       else
         ::ClearanceMailer.deliver_confirmation(@user)
-        deny_access(translate(:unconfirmed_email,
-          :scope   => [:clearance, :controllers, :sessions],
-          :default => "User has not confirmed email. " <<
-                      "Confirmation email will be resent."))
+        flash_notice_after_create
+        redirect_to(new_session_url)
       end
     end
   end
 
   def destroy
     forget(current_user)
-    flash[:success] = translate(:signed_out, :default =>  "Signed out.")
-    redirect_to url_after_destroy
+    flash_success_after_destroy
+    redirect_to(url_after_destroy)
   end
 
   private
 
+  def flash_failure_after_create
+    flash.now[:failure] = translate(:bad_email_or_password,
+      :scope   => [:clearance, :controllers, :sessions],
+      :default => "Bad email or password.")
+  end
+
+  def flash_success_after_create
+    flash[:success] = translate(:signed_in, :default =>  "Signed in.")
+  end
+
+  def flash_notice_after_create
+    flash[:notice] = translate(:unconfirmed_email,
+      :scope   => [:clearance, :controllers, :sessions],
+      :default => "User has not confirmed email. " <<
+                  "Confirmation email will be resent.")
+  end
+
   def url_after_create
     root_url
   end
 
+  def flash_success_after_destroy
+    flash[:success] = translate(:signed_out, :default =>  "Signed out.")
+  end
+
   def url_after_destroy
     new_session_url
   end

data/app/controllers/clearance/users_controller.rb

@@ -13,11 +13,8 @@ class Clearance::UsersController < ApplicationController
     @user = ::User.new params[:user]
     if @user.save
       ::ClearanceMailer.deliver_confirmation @user
-      flash[:notice] = translate(:deliver_confirmation,
-        :scope   => [:clearance, :controllers, :users],
-        :default => "You will receive an email within the next few minutes. " <<
-                    "It contains instructions for confirming your account.")
-      redirect_to url_after_create
+      flash_notice_after_create
+      redirect_to(url_after_create)
     else
       render :template => 'users/new'
     end
@@ -25,6 +22,13 @@ class Clearance::UsersController < ApplicationController
 
   private
 
+  def flash_notice_after_create
+    flash[:notice] = translate(:deliver_confirmation,
+      :scope   => [:clearance, :controllers, :users],
+      :default => "You will receive an email within the next few minutes. " <<
+                  "It contains instructions for confirming your account.")
+  end
+
   def url_after_create
     new_session_url
   end

data/config/clearance_routes.rb

@@ -1,19 +1,30 @@
 ActionController::Routing::Routes.draw do |map|
   map.resources :passwords,
     :controller => 'clearance/passwords',
-    :only => [:new, :create]
+    :only       => [:new, :create]
 
   map.resource  :session,
     :controller => 'clearance/sessions',
-    :only => [:new, :create, :destroy]
+    :only       => [:new, :create, :destroy]
 
   map.resources :users, :controller => 'clearance/users' do |users|
     users.resource :password,
       :controller => 'clearance/passwords',
-      :only => [:create, :edit, :update]
+      :only       => [:create, :edit, :update]
 
     users.resource :confirmation,
       :controller => 'clearance/confirmations',
-      :only => [:new, :create]
+      :only       => [:new, :create]
   end
+
+  map.sign_up  'sign_up',
+    :controller => 'clearance/users',
+    :action     => 'new'
+  map.sign_in  'sign_in',
+    :controller => 'clearance/sessions',
+    :action     => 'new'
+  map.sign_out 'sign_out',
+    :controller => 'clearance/sessions',
+    :action     => 'destroy',
+    :method     => :delete
 end

data/generators/clearance/lib/insert_commands.rb

@@ -7,40 +7,6 @@ Rails::Generator::Commands::Base.class_eval do
 end
 
 Rails::Generator::Commands::Create.class_eval do
-
-  def route_resources(resource_list)
-    sentinel = 'ActionController::Routing::Routes.draw do |map|'
-    
-    logger.route "map.resources #{resource_list}"
-    unless options[:pretend] || file_contains?('config/routes.rb', resource_list)
-      gsub_file 'config/routes.rb', /(#{Regexp.escape(sentinel)})/mi do |match|
-        "#{match}\n  map.resources #{resource_list}"
-      end
-    end
-  end
-
-  def route_resource(resource_list)
-    sentinel = 'ActionController::Routing::Routes.draw do |map|'
-    
-    logger.route "map.resource #{resource_list}"
-    unless options[:pretend] || file_contains?('config/routes.rb', resource_list)
-      gsub_file 'config/routes.rb', /(#{Regexp.escape(sentinel)})/mi do |match|
-        "#{match}\n  map.resource #{resource_list}"
-      end
-    end
-  end
-  
-  def route_name(name, path, route_options = {})
-    sentinel = 'ActionController::Routing::Routes.draw do |map|'
-    
-    logger.route "map.#{name} '#{path}', :controller => '#{route_options[:controller]}', :action => '#{route_options[:action]}'"
-    unless options[:pretend] 
-      gsub_file_once 'config/routes.rb', /(#{Regexp.escape(sentinel)})/mi do |match|
-        "#{match}\n  map.#{name} '#{path}', :controller => '#{route_options[:controller]}', :action => '#{route_options[:action]}'"
-      end
-    end
-  end
-  
   def insert_into(file, line)
     logger.insert "#{line} into #{file}"
     unless options[:pretend] || file_contains?(file, line)
@@ -52,30 +18,6 @@ Rails::Generator::Commands::Create.class_eval do
 end
 
 Rails::Generator::Commands::Destroy.class_eval do
-  def route_resource(resource_list)
-    look_for = "  map.resource #{resource_list}\n".gsub(/[\[\]]/, '\\\\\0')
-    logger.route "map.resource #{resource_list} #{look_for}"
-    unless options[:pretend]
-      gsub_file 'config/routes.rb', /(#{look_for})/mi, ''
-    end
-  end
-  
-  def route_resources(resource_list)
-    look_for = "  map.resources #{resource_list}\n".gsub(/[\[\]]/, '\\\\\0')
-    logger.route "map.resources #{resource_list} #{look_for}"
-    unless options[:pretend]
-      gsub_file 'config/routes.rb', /(#{look_for})/mi, ''
-    end
-  end  
-  
-  def route_name(name, path, route_options = {})
-    look_for =   "\n  map.#{name} '#{path}', :controller => '#{route_options[:controller]}', :action => '#{route_options[:action]}'"
-    logger.route "map.#{name} '#{path}',     :controller => '#{route_options[:controller]}', :action => '#{route_options[:action]}'"
-    unless options[:pretend]
-      gsub_file    'config/routes.rb', /(#{look_for})/mi, ''
-    end
-  end
-  
   def insert_into(file, line)
     logger.remove "#{line} from #{file}"
     unless options[:pretend]
@@ -85,18 +27,6 @@ Rails::Generator::Commands::Destroy.class_eval do
 end
 
 Rails::Generator::Commands::List.class_eval do
-  def route_resource(resources_list)
-    logger.route "map.resource #{resource_list}"
-  end
-  
-  def route_resources(resources_list)
-    logger.route "map.resource #{resource_list}"
-  end  
-  
-  def route_name(name, path, options = {})
-    logger.route "map.#{name} '#{path}', :controller => '{options[:controller]}', :action => '#{options[:action]}'"
-  end
-  
   def insert_into(file, line)
     logger.insert "#{line} into #{file}"
   end

data/lib/clearance.rb

@@ -1,19 +1,6 @@
 require 'clearance/extensions/errors'
 require 'clearance/extensions/rescue'
+require 'clearance/extensions/routes'
 
 require 'clearance/authentication'
 require 'clearance/user'
-
-class ActionController::Routing::RouteSet
-  def load_routes_with_clearance!
-    lib_path = File.dirname(__FILE__)
-    clearance_routes = File.join(lib_path, *%w[.. config clearance_routes.rb])
-    unless configuration_files.include?(clearance_routes)
-      add_configuration_file(clearance_routes)
-    end
-    load_routes_without_clearance!
-  end
-
-  alias_method_chain :load_routes!, :clearance
-end
-

data/lib/clearance/authentication.rb

@@ -42,6 +42,7 @@ module Clearance
       end
 
       def sign_user_in(user)
+        warn "[DEPRECATION] sign_user_in: unnecessary. use sign_in(user) instead."
         sign_in(user)
       end
 
@@ -63,22 +64,25 @@ module Clearance
 
       def forget(user)
         user.forget_me! if user
-        cookies.delete :remember_token
+        cookies.delete(:remember_token)
         reset_session
       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
+        redirect_to(return_to || default)
+        clear_return_to
+      end
+
+      def return_to
+        session[:return_to] || params[:return_to]
+      end
+
+      def clear_return_to
         session[:return_to] = nil
       end
 
       def redirect_to_root
-        redirect_to root_url
+        redirect_to(root_url)
       end
 
       def store_location
@@ -88,7 +92,7 @@ module Clearance
       def deny_access(flash_message = nil, opts = {})
         store_location
         flash[:failure] = flash_message if flash_message
-        redirect_to new_session_url
+        redirect_to(new_session_url)
       end
     end
 

data/lib/clearance/extensions/routes.rb

@@ -0,0 +1,12 @@
+class ActionController::Routing::RouteSet
+  def load_routes_with_clearance!
+    lib_path = File.dirname(__FILE__)
+    clearance_routes = File.join(lib_path, *%w[.. .. .. config clearance_routes.rb])
+    unless configuration_files.include?(clearance_routes)
+      add_configuration_file(clearance_routes)
+    end
+    load_routes_without_clearance!
+  end
+
+  alias_method_chain :load_routes!, :clearance
+end

data/shoulda_macros/clearance.rb

@@ -8,8 +8,9 @@ module Clearance
         user = block.bind(self).call
         assert_not_nil user,
           "please pass a User. try: should_be_signed_in_as { @user }"
-        assert_equal user.id,   session[:user_id],
-          "session[:user_id] is not set to User's id"
+        assert_equal user, @controller.send(:current_user),
+          "#{user.inspect} is not the current_user, " <<
+          "which is #{@controller.send(:current_user).inspect}"
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: thoughtbot-clearance
 version: !ruby/object:Gem::Version 
-  version: 0.6.6
+  version: 0.6.7
 platform: ruby
 authors: 
 - Dan Croak
@@ -24,7 +24,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-17 21:00:00 -07:00
+date: 2009-06-12 21:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -95,6 +95,7 @@ files:
 - lib/clearance/extensions
 - lib/clearance/extensions/errors.rb
 - lib/clearance/extensions/rescue.rb
+- lib/clearance/extensions/routes.rb
 - lib/clearance/user.rb
 - lib/clearance.rb
 - shoulda_macros/clearance.rb