clearance 0.8.8 → 0.9.0.rc1

data/lib/rails/generators/clearance_features_generator.rb

@@ -0,0 +1,20 @@
+class ClearanceFeaturesGenerator < Rails::Generators::Base
+  desc "Put the clearance features in place"
+
+  def self.source_root
+    @_clearance_source_root ||= File.join(File.dirname(__FILE__), "clearance_features_templates")
+  end
+
+  def install
+    directory "features"
+
+    inject_into_file "features/support/paths.rb", :after => "# Add more mappings here.\n" do
+"    when /the sign up page/i
+      sign_up_path
+    when /the sign in page/i
+      sign_in_path
+    when /the password reset request page/i
+      new_password_path\n"
+    end
+  end
+end

data/{generators/clearance_features/templates → lib/rails/generators/clearance_features_templates}/features/password_reset.feature

@@ -18,7 +18,7 @@ Feature: Password reset
       Given I signed up with "email@person.com/password"
       When I follow the password reset link sent to "email@person.com"
       And I update my password with "newpassword/wrongconfirmation"
-      Then I should see error messages
+      Then I should see an error message
       And I should be signed out
 
     Scenario: User is signed up and updates his password

data/{generators/clearance_features/templates → lib/rails/generators/clearance_features_templates}/features/step_definitions/clearance_steps.rb

@@ -1,7 +1,11 @@
 # General
 
 Then /^I should see error messages$/ do
-  assert_match /error(s)? prohibited/m, response.body
+  Then %{I should see "errors prohibited"}
+end
+
+Then /^I should see an error message$/ do
+  Then %{I should see "error prohibited"}
 end
 
 # Database
@@ -27,16 +31,20 @@ end
 # Session
 
 Then /^I should be signed in$/ do
-  assert controller.signed_in?
+  Given %{I am on the homepage} 
+  Then %{I should see "Sign out"} 
 end
 
 Then /^I should be signed out$/ do
-  assert ! controller.signed_in?
+  Given %{I am on the homepage} 
+  Then %{I should see "Sign in"} 
 end
 
 When /^session is cleared$/ do
-  request.reset_session
-  controller.instance_variable_set(:@_current_user, nil)
+  # TODO: This doesn't work with Capybara
+  # TODO: I tried Capybara.reset_sessions! but that didn't work
+  #request.reset_session
+  #controller.instance_variable_set(:@_current_user, nil)
 end
 
 Given /^I have signed in with "(.*)\/(.*)"$/ do |email, password|

data/lib/rails/generators/clearance_generator.rb

@@ -0,0 +1,68 @@
+require 'rails/generators/active_record'
+
+class ClearanceGenerator < ActiveRecord::Generators::Base
+  desc "Setup the basic stuff needed for Clearance"
+
+  argument :name, :type => :string, :default => "migration_source_name"
+
+  def self.source_root
+    @_clearance_source_root ||= File.join(File.dirname(__FILE__), "clearance_templates")
+  end
+
+  def install
+    template "clearance.rb", "config/initializers/clearance.rb"
+
+    inject_into_class "app/controllers/application_controller.rb", ApplicationController do
+      "  include Clearance::Authentication\n"
+    end
+
+    user_model = "app/models/user.rb"
+    if File.exists?(user_model)
+      inject_into_class user_model, User do
+        "include Clearance::User"
+      end
+    else
+      template "user.rb", user_model
+    end
+
+    template "factories.rb", "test/factories/clearance.rb"
+
+    migration_template "migrations/#{migration_source_name}.rb",
+                       "db/migrate/clearance_#{migration_target_name}"
+
+    #readme "README"
+  end
+
+  private
+
+  def schema_version_constant
+    if upgrading_clearance_again?
+      "To#{schema_version.gsub('_', '')}"
+    end
+  end
+
+  def migration_source_name
+    if ActiveRecord::Base.connection.table_exists?(:users)
+      'update_users'
+    else
+      'create_users'
+    end
+  end
+
+  def migration_target_name
+    if upgrading_clearance_again?
+      "update_users_to_#{schema_version}"
+    else
+      'create_users'
+    end
+  end
+
+  def schema_version
+    IO.read(File.join(File.dirname(__FILE__), '..', '..', 'VERSION')).strip.gsub(/[^\d]/, '_')
+  end
+
+  def upgrading_clearance_again?
+    ActiveRecord::Base.connection.table_exists?(:users)
+  end
+
+end

data/{generators/clearance/templates → lib/rails/generators/clearance_templates}/migrations/create_users.rb

@@ -10,7 +10,6 @@ class ClearanceCreateUsers < ActiveRecord::Migration
       t.timestamps
     end
 
-    add_index :users, [:id, :confirmation_token]
     add_index :users, :email
     add_index :users, :remember_token
   end

data/{generators/clearance/templates → lib/rails/generators/clearance_templates}/migrations/update_users.rb

@@ -21,7 +21,6 @@ class ClearanceUpdateUsers<%= schema_version_constant %> < ActiveRecord::Migrati
     existing_indexes = ActiveRecord::Base.connection.indexes(:users)
     index_names = existing_indexes.collect { |each| each.name }
     new_indexes = [
-      [:index_users_on_id_and_confirmation_token, 'add_index :users, [:id, :confirmation_token]'],
       [:index_users_on_email,                     'add_index :users, :email'],
       [:index_users_on_remember_token,            'add_index :users, :remember_token']
     ].delete_if { |each| index_names.include?(each.first.to_s) }

data/lib/rails/generators/clearance_views_generator.rb

@@ -0,0 +1,14 @@
+class ClearanceViewsGenerator < Rails::Generators::Base
+  desc "Put the clearance views in place"
+
+  def self.source_root
+    @_clearance_source_root ||= File.join(File.dirname(__FILE__), "clearance_views_templates")
+  end
+
+  def install
+    strategy          = "formtastic"
+    template_strategy = "erb"
+
+    directory "#{strategy}/#{template_strategy}", "app/views"
+  end
+end

data/{generators/clearance_views/templates/formtastic → lib/rails/generators/clearance_views_templates/formtastic/erb}/passwords/edit.html.erb

@@ -4,17 +4,17 @@
   Your password has been reset. Choose a new password below.
 </p>
 
-<% semantic_form_for(:user,
+<%= semantic_form_for(:user,
             :url  => user_password_path(@user, :token => @user.confirmation_token),
             :html => { :method => :put }) do |form| %>
   <%= form.error_messages %>
-  <% form.inputs do -%>
+  <%= form.inputs do -%>
     <%= form.input :password, :as => :password,
                    :label => "Choose password" %>
     <%= form.input :password_confirmation, :as => :password,
                    :label => "Confirm password" %>
   <% end -%>
-  <% form.buttons do -%>
+  <%= form.buttons do -%>
     <%= form.commit_button "Save this password" %>
   <% end -%>
 <% end %>

data/{generators/clearance_views/templates/formtastic → lib/rails/generators/clearance_views_templates/formtastic/erb}/passwords/new.html.erb

@@ -4,11 +4,11 @@
   We will email you a link to reset your password.
 </p>
 
-<% semantic_form_for :password, :url => passwords_path do |form| -%>
-  <% form.inputs do -%>
+<%= semantic_form_for :password, :url => passwords_path do |form| -%>
+  <%= form.inputs do -%>
     <%= form.input :email, :label => "Email address" %>
   <% end -%>
-  <% form.buttons do -%>
+  <%= form.buttons do -%>
     <%= form.commit_button "Reset password" %>
   <% end -%>
 <% end -%>

data/{generators/clearance_views/templates/formtastic → lib/rails/generators/clearance_views_templates/formtastic/erb}/sessions/new.html.erb

@@ -1,11 +1,11 @@
 <h2>Sign in</h2>
 
-<% semantic_form_for :session, :url => session_path do |form| %>
-  <% form.inputs do %>
+<%= semantic_form_for :session, :url => session_path do |form| %>
+  <%= form.inputs do %>
     <%= form.input :email %>
     <%= form.input :password, :as => :password %>
   <% end %>
-  <% form.buttons do %>
+  <%= form.buttons do %>
     <%= form.commit_button "Sign in" %>
   <% end %>
 <% end %>

data/{generators/clearance_views/templates/formtastic → lib/rails/generators/clearance_views_templates/formtastic/erb}/users/_inputs.html.erb

@@ -1,4 +1,4 @@
-<% form.inputs do %>
+<%= form.inputs do %>
   <%= form.input :email %>
   <%= form.input :password %>
   <%= form.input :password_confirmation, :label => "Confirm password" %>

data/{generators/clearance_views/templates/formtastic → lib/rails/generators/clearance_views_templates/formtastic/erb}/users/new.html.erb

@@ -1,9 +1,9 @@
 <h2>Sign up</h2>
 
-<% semantic_form_for @user do |form| %>
+<%= semantic_form_for @user do |form| %>
   <%= form.error_messages %>
   <%= render :partial => "/users/inputs", :locals => { :form => form } %>
-  <% form.buttons do %>
+  <%= form.buttons do %>
     <%= form.commit_button "Sign up" %>
   <% end %>
 <% end %>

data/shoulda_macros/clearance.rb

@@ -49,12 +49,12 @@ module Clearance
 
     def should_deny_access(opts = {})
       if opts[:flash]
-        should_set_the_flash_to opts[:flash]
+        should set_the_flash.to(opts[:flash])
       else
-        should_not_set_the_flash
+        should_not set_the_flash
       end
 
-      should_redirect_to('sign in page') { sign_in_url }
+      should redirect_to('sign in page') { sign_in_url }
     end
 
     # HTTP FLUENCY
@@ -102,7 +102,7 @@ module Clearance
         end
       end
 
-      should_set_the_flash_to /confirm/i
+      should set_the_flash.to(/confirm/i)
       should_redirect_to_url_after_create
     end
 
@@ -117,27 +117,19 @@ module Clearance
     # REDIRECTS
 
     def should_redirect_to_url_after_create
-      should_redirect_to("the post-create url") do
-        @controller.send(:url_after_create)
-      end
+      should redirect_to("the post-create url") { @controller.send(:url_after_create) }
     end
 
     def should_redirect_to_url_after_update
-      should_redirect_to("the post-update url") do
-        @controller.send(:url_after_update)
-      end
+      should redirect_to("the post-update url") { @controller.send(:url_after_update) }
     end
 
     def should_redirect_to_url_after_destroy
-      should_redirect_to("the post-destroy url") do
-        @controller.send(:url_after_destroy)
-      end
+      should redirect_to("the post-destroy url") { @controller.send(:url_after_destroy) }
     end
 
     def should_redirect_to_url_already_confirmed
-      should_redirect_to("the already confirmed url") do
-        @controller.send(:url_already_confirmed)
-      end
+      should redirect_to("the already confirmed url") { @controller.send(:url_already_confirmed) }
     end
 
     # VALIDATIONS
@@ -253,7 +245,7 @@ module Clearance
 
       def assert_confirmation_error(model, attribute, message = "confirmation error")
         warn "[DEPRECATION] assert_confirmation_error: not meant to be public, no longer used internally"
-        assert model.errors.on(attribute).include?("doesn't match confirmation"),
+        assert model.errors[attribute].include?("doesn't match confirmation"),
           message
       end
     end

data/test/controllers/confirmations_controller_test.rb

@@ -4,7 +4,7 @@ class ConfirmationsControllerTest < ActionController::TestCase
 
   tests Clearance::ConfirmationsController
 
-  should_filter_params :token
+  should filter_param(:token)
 
   context "a user whose email has not been confirmed" do
     setup { @user = Factory(:user) }
@@ -20,8 +20,8 @@ class ConfirmationsControllerTest < ActionController::TestCase
                   :token   => @user.confirmation_token
       end
 
-      should_set_the_flash_to /confirmed email/i
-      should_set_the_flash_to /signed in/i
+      should set_the_flash.to(/confirmed email/i)
+      should set_the_flash.to(/signed in/i)
       should_redirect_to_url_after_create
 
       should "set the current user" do
@@ -60,7 +60,7 @@ class ConfirmationsControllerTest < ActionController::TestCase
       get :new, :user_id => @user.to_param, :token => @token
     end
 
-    should_set_the_flash_to /confirmed email/i
+    should set_the_flash.to(/confirmed email/i)
     should_redirect_to_url_after_create
   end
 
@@ -87,8 +87,8 @@ class ConfirmationsControllerTest < ActionController::TestCase
       get :new, :user_id => @user.to_param, :token => @token
     end
 
-    should_set_the_flash_to /already confirmed/i
-    should_set_the_flash_to /sign in/i
+    should set_the_flash.to(/already confirmed/i)
+    should set_the_flash.to(/sign in/i)
     should_not_be_signed_in
     should_redirect_to_url_already_confirmed
   end

data/test/controllers/passwords_controller_test.rb

@@ -15,8 +15,8 @@ class PasswordsControllerTest < ActionController::TestCase
     context "on GET to #new" do
       setup { get :new, :user_id => @user.to_param }
 
-      should_respond_with :success
-      should_render_template "new"
+      should respond_with(:success)
+      should render_template(:new)
     end
 
     context "on POST to #create" do
@@ -36,7 +36,7 @@ class PasswordsControllerTest < ActionController::TestCase
           end
         end
 
-        should_set_the_flash_to /password/i
+        should set_the_flash.to(/password/i)
         should_redirect_to_url_after_create
       end
 
@@ -64,7 +64,7 @@ class PasswordsControllerTest < ActionController::TestCase
           assert_match /unknown email/i, flash.now[:failure]
         end
 
-        should_render_template :new
+        should render_template(:new)
       end
     end
   end
@@ -85,8 +85,8 @@ class PasswordsControllerTest < ActionController::TestCase
         assert_equal @user, assigns(:user)
       end
 
-      should_respond_with :success
-      should_render_template "edit"
+      should respond_with(:success)
+      should render_template(:edit)
       should_display_a_password_update_form
     end
 
@@ -127,7 +127,7 @@ class PasswordsControllerTest < ActionController::TestCase
         assert_not_nil @user.remember_token
       end
 
-      should_set_the_flash_to(/signed in/i)
+      should set_the_flash.to(/signed in/i)
       should_redirect_to_url_after_update
     end
 
@@ -156,9 +156,9 @@ class PasswordsControllerTest < ActionController::TestCase
       end
 
       should_not_be_signed_in
-      should_not_set_the_flash
-      should_respond_with    :success
-      should_render_template :edit
+      should_not set_the_flash
+      should respond_with(:success)
+      should render_template(:edit)
 
       should_display_a_password_update_form
     end

data/test/controllers/sessions_controller_test.rb

@@ -1,17 +1,16 @@
 require 'test_helper'
 
 class SessionsControllerTest < ActionController::TestCase
-
   tests Clearance::SessionsController
 
-  should_filter_params :password
+  should filter_param(:password)
 
   context "on GET to /sessions/new" do
     setup { get :new }
 
-    should_respond_with    :success
-    should_render_template :new
-    should_not_set_the_flash
+    should respond_with(:success)
+    should render_template(:new)
+    should_not set_the_flash
     should_display_a_sign_in_form
   end
 
@@ -41,11 +40,13 @@ class SessionsControllerTest < ActionController::TestCase
                       :password => @user.password }
     end
 
-    should_set_the_flash_to /signed in/i
+    should set_the_flash.to(/signed in/i)
     should_redirect_to_url_after_create
 
-    should 'set the cookie' do
-      assert ! cookies['remember_token'].empty?
+    should_set_cookie("remember_token", "old-token", Clearance.configuration.cookie_expiration.call)
+
+    should "have a default of 1 year from now" do
+      assert_in_delta Clearance.configuration.cookie_expiration.call, 1.year.from_now, 100
     end
 
     should "not change the remember token" do
@@ -53,6 +54,46 @@ class SessionsControllerTest < ActionController::TestCase
     end
   end
 
+  context "on POST to #create with good credentials - cookie duration set to 2 weeks" do
+    custom_duration = 2.weeks.from_now.utc
+
+    setup do
+      Clearance.configuration.cookie_expiration = lambda { custom_duration }
+      @user = Factory(:email_confirmed_user)
+      @user.update_attribute(:remember_token, "old-token2")
+      post :create, :session => {
+                      :email    => @user.email,
+                      :password => @user.password }
+    end
+
+    should_set_cookie("remember_token", "old-token2", custom_duration)
+
+    teardown do
+      # restore default Clearance configuration
+      Clearance.configuration = nil
+      Clearance.configure {}
+    end
+  end
+
+  context "on POST to #create with good credentials - cookie expiration set to nil (session cookie)" do
+    setup do
+      Clearance.configuration.cookie_expiration = lambda { nil }
+      @user = Factory(:email_confirmed_user)
+      @user.update_attribute(:remember_token, "old-token3")
+      post :create, :session => {
+                      :email    => @user.email,
+                      :password => @user.password }
+    end
+
+    should_set_cookie("remember_token", "old-token3", nil)
+
+    teardown do
+      # restore default Clearance configuration
+      Clearance.configuration = nil
+      Clearance.configure {}
+    end
+  end
+
   context "on POST to #create with good credentials and a session return url" do
     setup do
       @user = Factory(:email_confirmed_user)
@@ -63,7 +104,7 @@ class SessionsControllerTest < ActionController::TestCase
                       :password => @user.password }
     end
 
-    should_redirect_to("the return URL") { @return_url }
+    should redirect_to("the return URL") { @return_url }
   end
 
   context "on POST to #create with good credentials and a request return url" do
@@ -76,7 +117,7 @@ class SessionsControllerTest < ActionController::TestCase
                       :return_to => @return_url
     end
 
-    should_redirect_to("the return URL") { @return_url }
+    should redirect_to("the return URL") { @return_url }
   end
 
   context "on POST to #create with good credentials and a session return url and request return url" do
@@ -90,7 +131,7 @@ class SessionsControllerTest < ActionController::TestCase
                       :return_to => '/url_in_the_request'
     end
 
-    should_redirect_to("the return URL") { @return_url }
+    should redirect_to("the return URL") { @return_url }
   end
 
   context "on POST to #create with bad credentials" do
@@ -100,9 +141,9 @@ class SessionsControllerTest < ActionController::TestCase
                       :password    => "bad value" }
     end
 
-    should_set_the_flash_to /bad/i
-    should_respond_with    :unauthorized
-    should_render_template :new
+    should set_the_flash.to(/bad/i)
+    should respond_with(:unauthorized)
+    should render_template(:new)
     should_not_be_signed_in
 
     should 'not create the cookie' do
@@ -115,7 +156,7 @@ class SessionsControllerTest < ActionController::TestCase
       sign_out
       delete :destroy
     end
-    should_set_the_flash_to(/signed out/i)
+    should set_the_flash.to(/signed out/i)
     should_redirect_to_url_after_destroy
   end
 
@@ -127,7 +168,7 @@ class SessionsControllerTest < ActionController::TestCase
       delete :destroy
     end
 
-    should_set_the_flash_to(/signed out/i)
+    should set_the_flash.to(/signed out/i)
     should_redirect_to_url_after_destroy
 
     should "delete the cookie token" do