thoughtbot-clearance 0.4.7 → 0.4.8

data/CHANGELOG.textile

@@ -1,3 +1,11 @@
+h2. 0.4.8 (2/16/2009)
+
+* adding support paths for Cucumber (bmabey)
+* adding documentation for the flash (bmabey)
+* generators require "test_helper" instead of File.join. for rr compatibility. (Joe Ferris)
+* removed interpolated email address from flash message to make i18n easier. 
+* standardized flash messages that refer to email delivery.
+
 h2. 0.4.7 (2/12/2009)
 
 * removed Clearance::Test::TestHelper. one less setup step. all test helpers now in shoulda_macros.

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.7'
+      :version => '>= 0.4.8'
 
 In config/environments/test.rb:
 
@@ -95,6 +95,20 @@ In config/environment.rb:
 
     DO_NOT_REPLY = "donotreply@example.com"
 
+h2. The flash
+
+You will need to display the success, failure, and notice flash messages in your layout. We recommend creating an app/layouts/_flashes.html.erb partial similar to the _flashes partial in Suspenders:
+
+    <div id="flash">
+      <% flash.each do |key, value| -%>
+        <div id="flash_<%= key -%>"><%= html_escape(value) %></div>
+      <% end -%>
+    </div>
+
+which is then rendered inside the body tag of your application layout:
+
+    <%= render :partial => 'layouts/flashes' -%>
+
 h2. Tests
 
 The tests use "Shoulda":http://thoughtbot.com/projects/shoulda >= 2.9.1 and "Factory Girl":http://thoughtbot.com/projects/factory_girl >= 1.1.5.
@@ -102,6 +116,26 @@ The tests use "Shoulda":http://thoughtbot.com/projects/shoulda >= 2.9.1 and "Fac
 The generator will create a user factory in test/factories/clearance.rb unless
 you have it defined somewhere else.
 
+h2. Features
+
+If you are using Cucumber on your application Clearance comes with a feature generator:
+
+    script/generate clearance_features
+
+All of the files generated should be new with the exception of the features/support/paths.rb file.  If you have not modified your paths.rb then you will be okay to replace it with this one.  If you need to keep your paths.rb file then you will need to add these locations in your paths.rb manually:
+
+    def path_to(page_name)
+      case page_name
+       ...
+      when /the sign up page/i
+       new_user_path
+      when /the sign in page/i
+       new_session_path 
+      when /the password reset request page/i
+       new_password_path
+      ...
+    end
+
 h2. Usage: basic workflow
 
 Rails authentication with Clearance uses the standard approach thoughtbot and our clients have agreed upon. 

data/Rakefile

@@ -1,12 +1,13 @@
 require 'rake'
 require 'rake/testtask'
 require 'cucumber/rake/task'
- 
+
 test_files_pattern = 'test/rails_root/test/{unit,functional,other}/**/*_test.rb'
 
 namespace :test do
   Rake::TestTask.new(:all => ['generator:cleanup', 'generator:generate']) do |task|
     task.libs << 'lib'
+    task.libs << File.join(File.dirname(__FILE__), "test/rails_root/test")
     task.pattern = test_files_pattern
     task.verbose = false
   end
@@ -50,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.4.7"
+  gem_spec.version     = "0.4.8"
   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/generators/clearance/templates/test/functional/confirmations_controller_test.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../test_helper'
+require 'test_helper'
 
 class ConfirmationsControllerTest < ActionController::TestCase
   include Clearance::Test::Functional::ConfirmationsControllerTest

data/generators/clearance/templates/test/functional/passwords_controller_test.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../test_helper'
+require 'test_helper'
 
 class PasswordsControllerTest < ActionController::TestCase
   include Clearance::Test::Functional::PasswordsControllerTest

data/generators/clearance/templates/test/functional/sessions_controller_test.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../test_helper'
+require 'test_helper'
 
 class SessionsControllerTest < ActionController::TestCase
   include Clearance::Test::Functional::SessionsControllerTest

data/generators/clearance/templates/test/functional/users_controller_test.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../test_helper'
+require 'test_helper'
 
 class UsersControllerTest < ActionController::TestCase
   include Clearance::Test::Functional::UsersControllerTest

data/generators/clearance/templates/test/unit/clearance_mailer_test.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../test_helper'
+require 'test_helper'
 
 class ClearanceMailerTest < ActionMailer::TestCase
   tests ClearanceMailer

data/generators/clearance/templates/test/unit/user_test.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../test_helper'
+require 'test_helper'
 
 class UserTest < Test::Unit::TestCase
   include Clearance::Test::Unit::UserTest

data/generators/clearance_features/USAGE

@@ -1 +1 @@
-script/generate clearance_stories
+script/generate clearance_features

data/generators/clearance_features/clearance_features_generator.rb

@@ -5,6 +5,7 @@ class ClearanceFeaturesGenerator < Rails::Generator::Base
       m.directory File.join("features", "step_definitions")
       
       ["features/step_definitions/clearance_steps.rb",
+       "features/support/paths.rb",
        "features/sign_in.feature",
        "features/sign_out.feature",       
        "features/sign_up.feature",

data/generators/clearance_features/templates/features/password_reset.feature

@@ -11,7 +11,7 @@ Fature: Password Reset
     Scenario: User requests password reset
       Given I am signed up and confirmed as "email@person.com/password"
       When I request password reset link to be sent to "email@person.com"
-      Then I should see "Details for changing your password have been sent to email@person.com"
+      Then I should see "instructions for changing your password"
       And a password reset message should be sent to "email@person.com"
       
     Scenario: User updated his password and types wrong confirmation

data/generators/clearance_features/templates/features/sign_up.feature

@@ -17,7 +17,7 @@ Feature: Sign up
       And I fill in "Password" with "password"
       And I fill in "Verify Password" with "password"
       And I press "Sign Up"
-      Then I should see "You will receive an email within the next few minutes"
+      Then I should see "instructions for confirming"
       And a confirmation message should be sent to "email@person.com"
       
     Scenario: User confirms his account

data/generators/clearance_features/templates/features/step_definitions/clearance_steps.rb

@@ -44,7 +44,7 @@ Then /^a confirmation message should be sent to "(.*)"$/ do |email|
   user = User.find_by_email(email)
   sent = ActionMailer::Base.deliveries.first
   assert_equal [user.email], sent.to
-  assert_equal 'Account confirmation', sent.subject
+  assert_match /confirm/i, sent.subject
   assert !user.token.blank?
   assert_match /#{user.token}/, sent.body
 end
@@ -58,7 +58,7 @@ Then /^a password reset message should be sent to "(.*)"$/ do |email|
   user = User.find_by_email(email)
   sent = ActionMailer::Base.deliveries.first
   assert_equal [user.email], sent.to
-  assert_equal 'Change your password', sent.subject
+  assert_match /password/i, sent.subject
   assert !user.token.blank?
   assert_match /#{user.token}/, sent.body
 end

data/generators/clearance_features/templates/features/support/paths.rb

@@ -0,0 +1,26 @@
+module NavigationHelpers
+  def path_to(page_name)
+    case page_name
+    
+    when /the homepage/i
+      root_path
+    when /the sign up page/i
+      new_user_path
+    when /the sign in page/i
+      new_session_path
+    when /the password reset request page/i
+      new_password_path
+ 
+    
+    # Add more page name => path mappings here
+    
+    else
+      raise "Can't find mapping from \"#{page_name}\" to a path."
+    end
+  end
+end
+ 
+World do |world|
+  world.extend NavigationHelpers
+  world
+end

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

@@ -25,8 +25,8 @@ module Clearance
             else
               user.forgot_password!
               ClearanceMailer.deliver_change_password user
-              flash[:notice] = "Details for changing your password " <<
-                               "have been sent to #{user.email}"
+              flash[:notice] = "You will receive an email within the next few minutes. " <<
+                               "It contains instructions for changing your password."
               redirect_to url_after_create
             end
           end

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

@@ -24,11 +24,11 @@ module Clearance
               if @user.email_confirmed?
                 remember(@user) if remember?
                 sign_user_in(@user)
-                flash[:notice] = "Signed in successfully"
+                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.")
+                deny_access("User has not confirmed email. Confirmation email will be resent.")
               end
             end
           end

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

@@ -23,7 +23,7 @@ module Clearance
             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."
+                               "It contains instructions for confirming your account."
               redirect_to url_after_create
             else
               render :action => "new"

data/lib/clearance/test/functional/passwords_controller_test.rb

@@ -30,11 +30,7 @@ module Clearance
                   end
                   
                   should_send_the_change_your_password_email
-                  
-                  should "set a :notice flash with the user email address" do
-                    assert_match /#{@user.email}/, flash[:notice]
-                  end
-
+                  should_set_the_flash_to /password/i
                   should_redirect_to_url_after_create
                 end
 

data/lib/clearance/test/functional/sessions_controller_test.rb

@@ -29,7 +29,7 @@ module Clearance
                                   :password => @user.password }
                 end
 
-                should_deny_access(:flash => /User has not confirmed email.  Confirmation email will be resent./i)
+                should_deny_access(:flash => /User has not confirmed email. Confirmation email will be resent./i)
 
                 should "send the confirmation email" do
                   assert_not_nil email = ActionMailer::Base.deliveries[0]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: thoughtbot-clearance
 version: !ruby/object:Gem::Version 
-  version: 0.4.7
+  version: 0.4.8
 platform: ruby
 authors: 
 - thoughtbot, inc.
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-02-11 21:00:00 -08:00
+date: 2009-02-15 21:00:00 -08:00
 default_executable: 
 dependencies: []
 
@@ -89,6 +89,8 @@ files:
 - generators/clearance_features/templates/features/sign_up.feature
 - generators/clearance_features/templates/features/step_definitions
 - generators/clearance_features/templates/features/step_definitions/clearance_steps.rb
+- generators/clearance_features/templates/features/support
+- generators/clearance_features/templates/features/support/paths.rb
 - generators/clearance_features/USAGE
 - lib/clearance
 - lib/clearance/app