refactoring. "confirmed" attribute was getting confusing when talking…

… about password confirmation, so it became "email_confirmed". pulling out some logical test groups into shoulda macros (getting a good start on a should_validate_confirmation_of, yet depends on Factory Girl). changing generated factory file to be more than one Factory definition for different states of Users

README.textile

@@ -122,7 +122,7 @@ The tests use "Shoulda":http://thoughtbot.com/projects/shoulda >= 2.0.6 and "Fac
       include Clearance::Test::TestHelper
     end
 
-The generator will create a user factory in test/factories/clearance_user.rb unless
+The generator will create a user factory in test/factories/clearance.rb unless
 you have it defined somewhere else.
 
 h2. Usage: basic workflow

clearance.gemspec

@@ -64,7 +64,7 @@ files:
 - generators/clearance/templates/README
 - generators/clearance/templates/test
 - generators/clearance/templates/test/factories
-- generators/clearance/templates/test/factories/clearance_user.rb
+- generators/clearance/templates/test/factories/clearance.rb
 - generators/clearance/templates/test/functional
 - generators/clearance/templates/test/functional/confirmations_controller_test.rb
 - generators/clearance/templates/test/functional/passwords_controller_test.rb

generators/clearance/clearance_generator.rb

@@ -67,7 +67,7 @@ def manifest
       end
 
       m.directory File.join("test", "factories")
-      ["test/factories/clearance_user.rb"].each do |file|
+      ["test/factories/clearance.rb"].each do |file|
         m.file file, file
       end
 

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

@@ -6,7 +6,7 @@ def self.up
       t.string :salt, :limit => 40
       t.string :remember_token
       t.datetime :remember_token_expires_at
-      t.boolean :confirmed, :default => false, :null => false
+      t.boolean :email_confirmed, :default => false, :null => false
     end
 
     add_index :users, [:email, :encrypted_password]

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

@@ -8,7 +8,7 @@ def self.up
         [: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']
+        [:email_confirmed,           't.boolean :email_confirmed, :default => false, :null => false']
       ].delete_if {|c| existing_columns.include?(c.first.to_s)} 
 -%>
     change_table(:users) do |t|

generators/clearance/templates/test/factories/clearance.rb

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

lib/clearance/app/controllers/application_controller.rb

@@ -27,7 +27,7 @@ def user_from_session
               if session[:user_id] && session[:salt]
                 user = User.find_by_id_and_salt(session[:user_id], session[:salt])
               end
-              user && user.confirmed? ? user : nil
+              user && user.email_confirmed? ? user : nil
             end
 
             def user_from_cookie

lib/clearance/app/controllers/confirmations_controller.rb

@@ -14,7 +14,7 @@ def new
             end
 
             def create
-              @user.confirm!
+              @user.confirm_email!
               log_user_in(@user)
               redirect_to url_after_create
             end

lib/clearance/app/controllers/sessions_controller.rb

@@ -15,13 +15,13 @@ def create
               if @user.nil?
                 login_failure
               else
-                if @user.confirmed?
+                if @user.email_confirmed?
                   remember(@user) if remember?
                   log_user_in(@user)
                   login_successful
                 else
                   ClearanceMailer.deliver_confirmation(@user)
-                  deny_access("Account not confirmed. Confirmation email sent.")
+                  deny_access("User has not confirmed email. Confirmation email sent.")
                 end
               end
             end
@@ -35,8 +35,8 @@ def destroy
 
             private
 
-            def login_successful
-              flash[:notice] = "Logged in successfully"
+            def login_successful(message = "Logged in successfully")
+              flash[:notice] = message
               redirect_back_or url_after_create
             end
 

lib/clearance/app/models/user.rb

@@ -51,8 +51,8 @@ def forget_me!
               self.update_attribute :remember_token, nil
             end
 
-            def confirm!
-              self.update_attribute :confirmed, true
+            def confirm_email!
+              self.update_attribute :email_confirmed, true
             end
 
             protected

lib/clearance/test/functional/confirmations_controller_test.rb

@@ -8,15 +8,15 @@ def self.included(controller_test)
 
             should_filter_params :salt
 
-            context "Given a user" do
-              setup { @user = Factory(:clearance_user) }
+            context "Given a user whose email has not been confirmed" do
+              setup { @user = Factory(:authorized_user) }
 
               context "on GET to #new with correct id and salt" do
                 setup do
                   get :new, :user_id => @user.to_param, :salt => @user.salt
                 end
 
-                should_be_logged_in_and_confirmed_as { @user }
+                should_be_logged_in_and_email_confirmed_as { @user }
                 should_redirect_to_url_after_create
               end
 

lib/clearance/test/functional/passwords_controller_test.rb

@@ -10,7 +10,7 @@ def self.included(controller_test)
               :action  => 'edit', :user_id => '1'
 
             context 'with a user' do
-              setup { @user = Factory(:clearance_user) }
+              setup { @user = Factory(:authorized_user) }
 
               context 'A GET to #new' do
                 setup { get :new, :user_id => @user.to_param }

lib/clearance/test/functional/sessions_controller_test.rb

@@ -32,7 +32,7 @@ def self.included(controller_test)
 
             context "Given an unconfirmed user" do
               setup do
-                @user = Factory(:clearance_user, :confirmed => false)
+                @user = Factory(:authorized_user, :email_confirmed => false)
               end
 
               context "a POST to #create with good credentials" do
@@ -53,7 +53,7 @@ def self.included(controller_test)
             end
 
             context "Given a confirmed user" do
-              setup { @user = Factory(:clearance_user, :confirmed => true) }
+              setup { @user = Factory(:authorized_user, :email_confirmed => true) }
 
               context "a POST to #create with good credentials" do
                 setup do

lib/clearance/test/functional/users_controller_test.rb

@@ -46,7 +46,7 @@ def self.included(controller_test)
 
               context "on POST to /users" do
                 setup do
-                  user_attributes = Factory.attributes_for(:clearance_user, 
+                  user_attributes = Factory.attributes_for(:authorized_user, 
                                       :password              => "secret", 
                                       :password_confirmation => "secret")
                   post :create, :user => user_attributes

lib/clearance/test/test_helper.rb

@@ -7,8 +7,8 @@ def self.included(test_helper)
 
           def login_as(user = nil)
             unless user
-              user = Factory(:clearance_user)
-              user.confirm!
+              user = Factory(:authorized_user)
+              user.confirm_email!
             end
             @request.session[:user_id] = user.id
             @request.session[:salt]    = user.salt

lib/clearance/test/unit/clearance_mailer_test.rb

@@ -8,7 +8,7 @@ def self.included(mailer_test)
 
             context "A change password email" do
               setup do
-                @user  = Factory(:clearance_user)
+                @user  = Factory(:authorized_user)
                 @email = ClearanceMailer.create_change_password @user
               end
 
@@ -33,7 +33,7 @@ def self.included(mailer_test)
 
             context "A confirmation email" do
               setup do
-                @user  = Factory(:clearance_user)
+                @user  = Factory(:authorized_user)
                 @email = ClearanceMailer.create_confirmation @user
               end
 

lib/clearance/test/unit/user_test.rb

@@ -7,7 +7,7 @@ def self.included(unit_test)
           unit_test.class_eval do
 
             context "a User" do
-              setup { @user = Factory(:clearance_user) }
+              setup { @user = Factory(:authorized_user) }
 
               should_require_attributes        :email
               should_require_unique_attributes :email
@@ -16,40 +16,26 @@ def self.included(unit_test)
               should_not_allow_values_for      :email, "example.com"
             end
 
-            # registering
+            # registering - confirmation branches
+            # enrypting the user's password
             # not confirming password
             # confirming account
             # remember me
             # forget me
             # recovering password
             # updating password
 
-            context "password is confirmed but encrypted_password is blank" do
-              setup do
-                @user = Factory(:clearance_user, :encrypted_password => nil)
-              end
-
+            context "creating a User" do
+              should_validate_confirmation_of :authorized_user, :password
+
               should "encrypt password" do
-                assert_not_nil @user.encrypted_password
+                assert_not_nil Factory(:authorized_user).encrypted_password
               end
             end
-
-            context "password is not confirmed on create" do
-              setup do
-                @user = Factory.build(:clearance_user, 
-                          :password              => "password", 
-                          :password_confirmation => "unconfirmed_password")
-                assert ! @user.save
-              end
-
-              should "raise error on password" do
-                assert_match(/confirmation/i, @user.errors.on(:password))
-              end
-            end
-
+
             context "password is not confirmed on update" do
               setup do
-                @user = Factory(:clearance_user)
+                @user = Factory(:authorized_user)
                 @user.update_attributes(
                   :password              => "password", 
                   :password_confirmation => "unconfirmed_password")
@@ -61,7 +47,7 @@ def self.included(unit_test)
             end
 
             context "An existing User" do
-              setup { @user = Factory(:clearance_user) }
+              setup { @user = Factory(:authorized_user) }
 
               context "who changes and confirms password" do
                 setup do
@@ -79,7 +65,7 @@ def self.included(unit_test)
                 @salt = "salt"
                 User.any_instance.stubs(:initialize_salt)
 
-                @user     = Factory(:clearance_user, :salt => @salt)
+                @user     = Factory(:authorized_user, :salt => @salt)
                 @password = @user.password
               end
 
@@ -111,7 +97,7 @@ def self.included(unit_test)
 
             context "remember_me!" do
               setup do
-                @user = Factory(:clearance_user)
+                @user = Factory(:authorized_user)
                 assert_nil @user.remember_token
                 assert_nil @user.remember_token_expires_at
                 @user.remember_me!
@@ -155,7 +141,7 @@ def self.included(unit_test)
                 @salt = "salt"
                 User.any_instance.stubs(:initialize_salt)
 
-                @user     = Factory(:clearance_user, :salt => @salt)
+                @user     = Factory(:authorized_user, :salt => @salt)
                 @password = @user.password
 
                 @user.encrypt(@password)
@@ -168,20 +154,20 @@ def self.included(unit_test)
               end
             end
 
-            context "An unconfirmed user" do
+            context "A user who has not confirmed their email" do
               setup do
-                @user = Factory(:clearance_user)
-                assert ! @user.confirmed?
+                @user = Factory(:authorized_user)
+                assert ! @user.email_confirmed?
               end
 
-              context "after #confirm!" do
+              context "after #confirm_email!" do
                 setup do
-                  assert @user.confirm!
+                  assert @user.confirm_email!
                   @user.reload
                 end
 
-                should "be confirmed" do
-                  assert @user.confirmed?
+                should "have confirmed their email" do
+                  assert @user.email_confirmed?
                 end
               end
             end