thoughtbot-clearance 0.3.7 → 0.3.8

data/generators/clearance/lib/rake_commands.rb

@@ -0,0 +1,22 @@
+Rails::Generator::Commands::Create.class_eval do
+  def rake_db_migrate
+    logger.rake "db:migrate"
+    unless system("rake db:migrate")
+      logger.rake "db:migrate failed. Rolling back"      
+      command(:destroy).invoke!
+    end
+  end
+end
+
+Rails::Generator::Commands::Destroy.class_eval do
+  def rake_db_migrate
+    logger.rake "db:rollback"  
+    system "rake db:rollback"  
+  end
+end
+
+Rails::Generator::Commands::List.class_eval do
+  def rake_db_migrate
+    logger.rake "db:migrate"    
+  end
+end

data/generators/clearance/templates/README

@@ -0,0 +1,37 @@
+*******************************************************************************
+Ok, enough fancy automatic stuff. Time for some old school monkey copy-pasting.
+
+1. For any other file(s) that you already had and didn't want to overwrite, add 
+the corresponding Clearance module. They are namespaced exactly like the 
+directory structure of a Rails app, e.g:
+
+if app/models/user.rb already exists, add:
+
+class User < ActiveRecord::Base
+  include Clearance::App::Models::User
+...
+
+2. You need to define HOST constant in your environments files. In config/environments/test.rb and config/environments/development.rb it can be:
+
+    HOST = "localhost"
+
+While in config/environments/production.rb it must be the actual host your application is deployed to because the constant is used by mailers to generate URLs in emails.
+
+In config/environment.rb:
+
+    DO_NOT_REPLY = "donotreply@example.com"
+    
+3. Clearance depends on root_url, so please make sure that it is defined in 
+your config/routes.rb:
+
+    map.root :controller => 'my_home_controller'
+    
+4. To run tests you need to add the Clearance module to your 
+test/test_helper.rb:
+
+    class Test::Unit::TestCase
+      self.use_transactional_fixtures = true
+      self.use_instantiated_fixtures  = false
+      include Clearance::Test::TestHelper
+    end
+*******************************************************************************    

data/generators/clearance/templates/app/views/clearance_mailer/change_password.html.erb

@@ -1,6 +1,8 @@
 Someone, hopefully you, has requested that we send you a link to change your password.
 
 Here's the link:
-<%= edit_user_password_url @user, :email => @user.email, :password => @user.crypted_password %>
+<%= edit_user_password_url(@user, 
+      :email    => @user.email, 
+      :password => @user.crypted_password) %>
 
 If you didn't request this, no need to freak out, your password hasn't been changed.  You can just ignore this email.

data/generators/clearance/templates/app/views/passwords/edit.html.erb

@@ -3,11 +3,11 @@
 </p>
 
 <%= error_messages_for :user %>
+
 <% form_for(:user,
-            :url => user_password_path(
-              @user,
-              :email => @user.email,
-              :password => @user.crypted_password),
+            :url => user_password_path(@user,
+                      :email    => @user.email,
+                      :password => @user.crypted_password),
             :html => { :method => :put }) do |form| %>
   <div class="password_field">
     <%= form.label :password, 'Choose password' %>

data/generators/clearance/templates/db/migrate/create_users_with_clearance_columns.rb

@@ -0,0 +1,21 @@
+class CreateOrUpdateUsersWithClearanceColumns < ActiveRecord::Migration
+  def self.up
+    create_table(:users) do |t|
+      t.string :email
+      t.string :crypted_password, :limit => 40
+      t.string :salt, :limit => 40
+      t.string :remember_token
+      t.datetime :remember_token_expires_at
+      t.boolean :confirmed, :default => false, :null => false
+    end
+
+    add_index :users, [:email, :crypted_password]
+    add_index :users, [:id, :salt]
+    add_index :users, :email
+    add_index :users, :remember_token    
+  end
+  
+  def self.down
+    drop_table :users  
+  end
+end

data/generators/clearance/templates/db/migrate/update_users_with_clearance_columns.rb

@@ -0,0 +1,41 @@
+class CreateOrUpdateUsersWithClearanceColumns < ActiveRecord::Migration
+  def self.up
+<% 
+      existing_columns = ActiveRecord::Base.connection.columns(:users).map { |column| column.name }
+      columns = [
+        [:email,                     't.string :email'],
+        [:crypted_password,          't.string :crypted_password, :limit => 40'],
+        [:salt,                      't.string :salt, :limit => 40'],
+        [:remember_token,            't.string :remember_token'],
+        [:remember_token_expires_at, 't.datetime :remember_token_expires_at'],
+        [:confirmed,                 't.boolean :confirmed, :default => false, :null => false']
+      ].delete_if {|c| existing_columns.include?(c.first.to_s)} 
+-%>
+    change_table(:users) do |t|
+<% columns.each do |c| -%>
+      <%= c.last %>
+<% end -%>
+    end
+    
+<%
+    existing_indexes = ActiveRecord::Base.connection.indexes(:users).map { |index| index.name }
+    indexes = [
+      [:index_users_on_email_and_crypted_password, 'add_index :users, [:email, :crypted_password]'],
+      [:index_users_on_id_and_salt,                'add_index :users, [:id, :salt]'],
+      [:index_users_on_email,                      'add_index :users, :email'],
+      [:index_users_on_remember_token,             'add_index :users, :remember_token']
+    ].delete_if {|i| existing_indexes.include?(i.first.to_s)}
+-%>
+<% indexes.each do |i| -%>
+    <%= i.last %>
+<% end -%>
+  end
+  
+  def self.down
+    change_table(:users) do |t|
+<% unless columns.empty? -%>
+      t.remove <%= columns.collect {|c| ":#{c.first}" }.join(',') %>
+<% end -%>
+    end
+  end
+end

data/generators/clearance/templates/test/{factories.rb → factories/clearance_user.rb}

@@ -2,7 +2,7 @@ Factory.sequence :email do |n|
   "user#{n}@example.com"
 end
 
-Factory.define :user do |user|
+Factory.define :clearance_user, :class => 'user' do |user|
   user.email { Factory.next :email }
   user.password "password"
   user.password_confirmation "password"

data/lib/clearance.rb

@@ -3,13 +3,12 @@ require 'clearance/app/controllers/confirmations_controller'
 require 'clearance/app/controllers/passwords_controller'
 require 'clearance/app/controllers/sessions_controller'
 require 'clearance/app/controllers/users_controller'
-require 'clearance/app/models/user'
 require 'clearance/app/models/clearance_mailer'
+require 'clearance/app/models/user'
 require 'clearance/test/functional/confirmations_controller_test'
+require 'clearance/test/functional/passwords_controller_test'
 require 'clearance/test/functional/sessions_controller_test'
 require 'clearance/test/functional/users_controller_test'
-require 'clearance/test/functional/passwords_controller_test'
 require 'clearance/test/test_helper'
-require 'clearance/test/unit/user_test'
 require 'clearance/test/unit/clearance_mailer_test'
-require 'clearance/version'
+require 'clearance/test/unit/user_test'

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

@@ -3,79 +3,65 @@ module Clearance
     module Controllers
       module ApplicationController
     
-        def self.included(base)
-          base.class_eval do
+        def self.included(controller)
+          controller.class_eval do
             helper_method :current_user
             helper_method :logged_in?
         
-            include InstanceMethods
+            def current_user
+              user_from_session || user_from_cookie
+            end
 
-         protected
-            include ProtectedInstanceMethods
-          end
-        end
-    
-        module InstanceMethods
-          def current_user
-            @current_user ||= (user_from_session || user_from_cookie)
-          end
-      
-          def logged_in?
-            ! current_user.nil?
-          end
-        end
+            def logged_in?
+              ! current_user.nil?
+            end
+            
+            protected
+            
+            def authenticate
+              deny_access unless logged_in?
+            end
 
-        module ProtectedInstanceMethods
-          def authenticate
-            deny_access unless logged_in?
-          end
+            def user_from_session
+              User.find_by_id session[:user_id]
+            end
 
-          def user_from_session
-            user_model.find_by_id session[:user_id]
-          end
+            def user_from_cookie
+              if cookies[:auth_token]
+                user = User.find_by_remember_token(cookies[:auth_token])
+              end
+              user && user.remember_token? ? user : nil
+            end
 
-          def user_from_cookie
-            user = user_model.find_by_remember_token(cookies[:auth_token]) if cookies[:auth_token]
-            user && user.remember_token? ? user : nil
-          end
+            # Level of indirection so you can easily overwrite this method
+            # but also call #login .
+            def log_user_in(user)
+              login(user)
+            end
 
-          # Level of indirection so you can easily override this method
-          # but also call #login .
-          def log_user_in(user)
-            login(user)
-          end
-
-          def login(user)
-            session[:user_id] = user.id if user
-            @current_user = user
-          end
+            def login(user)
+              session[:user_id] = user.id if user
+            end
 
-          def redirect_back_or(default)
-            session[:return_to] ? redirect_to(session[:return_to]) : redirect_to(default)
-            session[:return_to] = nil
-          end
-      
-          def redirect_to_root
-            redirect_to root_url
-          end
+            def redirect_back_or(default)
+              session[:return_to] ||= params[:return_to]
+              session[:return_to] ? redirect_to(session[:return_to]) : redirect_to(default)
+              session[:return_to] = nil
+            end
 
-          def store_location
-            session[:return_to] = request.request_uri
-          end
+            def redirect_to_root
+              redirect_to root_url
+            end
 
-          def deny_access(flash_message = nil, opts = {})
-            opts[:redirect] ||= new_session_path
-            store_location
-            flash[:error] = flash_message if flash_message
-            redirect_to opts[:redirect]
-          end
-      
-          def user_model
-            User
-          end
+            def store_location
+              session[:return_to] = request.request_uri
+            end
 
-          def mailer_model
-            ClearanceMailer
+            def deny_access(flash_message = nil, opts = {})
+              store_location
+              flash[:failure] = flash_message if flash_message
+              render :template => "/sessions/new",:status => :unauthorized 
+            end
           end
         end
       end

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

@@ -3,44 +3,36 @@ module Clearance
     module Controllers
       module ConfirmationsController
     
-        def self.included(base)
-          base.class_eval do
-            before_filter :existing_user?, :only => [:new, :create]
+        def self.included(controller)
+          controller.class_eval do
+            before_filter :existing_user?, :only => :new
         
-            include InstanceMethods
+            def new
+              create
+            end
+
+            def create
+              @user.confirm!
+              session[:user_id] = @user.id
+              redirect_to url_after_create
+            end
         
-          private
-            include PrivateInstanceMethods
-          end
-        end
-    
-        module InstanceMethods
-          def new
-            @user = User.find_by_id_and_salt(params[:user_id], params[:salt])
-          end
+            private
+            
+            def existing_user?
+              @user = User.find_by_id_and_salt(params[:user_id], params[:salt])
+              if @user.nil?
+                render :nothing => true, :status => :not_found
+              end
+            end
 
-          def create
-            @user = User.find_by_id_and_salt(params[:user_id], params[:salt])
-            @user.confirm!
-            session[:user_id] = @user.id
-            redirect_to url_after_create
-          end
-        end
-    
-        module PrivateInstanceMethods
-          def existing_user?
-            user = User.find_by_id_and_salt(params[:user_id], params[:salt])
-            if user.nil?
-              render :nothing => true, :status => :not_found
+            def url_after_create
+              root_url
             end
+            
           end
-          
-          def url_after_create
-            root_url
-          end
-        end
-    
+        end    
       end
     end
   end
-end
+end

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

@@ -3,64 +3,59 @@ module Clearance
     module Controllers
       module PasswordsController
 
-        def self.included(base)
-          base.class_eval do
+        def self.included(controller)
+          controller.class_eval do
             before_filter :existing_user?, :only => [:edit, :update]
             filter_parameter_logging :password, :password_confirmation
             
-            include InstanceMethods
-            
-          private
-            include PrivateInstanceMethods
-          end
-        end
-
-        module InstanceMethods
-          def new
-          end
+            def new
+            end
 
-          def create
-            user = User.find_by_email params[:password][:email]
-            if user.nil?
-              flash.now[:warning] = 'Unknown email'
-              render :action => :new
-            else
-              ClearanceMailer.deliver_change_password user
-              redirect_to url_after_create
+            def create
+              user = User.find_by_email(params[:password][:email])
+              if user.nil?
+                flash.now[:warning] = 'Unknown email'
+                render :action => :new
+              else
+                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
-          end
 
-          def edit
-            @user = User.find_by_email_and_crypted_password(params[:email],
-                                                            params[:password])
-          end
+            def edit
+              @user = User.find_by_email_and_crypted_password(params[:email],
+                                                              params[:password])
+            end
 
-          def update
-            @user = User.find_by_email_and_crypted_password(params[:email],
-                                                            params[:password])
-            if @user.update_attributes params[:user]
-              session[:user_id] = @user.id
-              redirect_to @user
-            else
-              render :action => :edit
+            def update
+              @user = User.find_by_email_and_crypted_password(params[:email],
+                                                              params[:password])
+              if @user.update_attributes params[:user]
+                session[:user_id] = @user.id
+                redirect_to @user
+              else
+                render :action => :edit
+              end
+            end
+            
+            private
+            
+            def existing_user?
+              user = User.find_by_email_and_crypted_password(params[:email],
+                                                             params[:password])
+              if user.nil?
+                render :nothing => true, :status => :not_found
+              end
             end
-          end
-        end
 
-        module PrivateInstanceMethods
-          def existing_user?
-            user = User.find_by_email_and_crypted_password(params[:email],
-                                                           params[:password])
-            if user.nil?
-              render :nothing => true, :status => :not_found
+            def url_after_create
+              new_session_url
             end
-          end
-          
-          def url_after_create
-            new_session_url
+            
           end
         end
-
       end
     end
   end