thoughtbot-clearance 0.4.3 → 0.4.4

data/CHANGELOG.textile

@@ -0,0 +1,4 @@
+h2. 0.4.4 (2/2/2009)
+
+* Added a generator for Cucumber features
+* Standarized naming for "Sign up," "Sign in," and "Sign out"

data/Rakefile

@@ -1,41 +1,56 @@
 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.pattern = test_files_pattern
     task.verbose = false
   end
+  
+  Cucumber::Rake::Task.new(:features) do |t|
+    t.cucumber_opts = "--format progress"
+    t.feature_pattern = 'test/rails_root/features/*.feature'
+  end  
 end
 
+generators = %w(clearance clearance_features)
+
 namespace :generator do
   desc "Cleans up the test app before running the generator"
   task :cleanup do
-    FileList["generators/clearance/templates/**/*.*"].each do |each|
-      file = "test/rails_root/#{each.gsub("generators/clearance/templates/",'')}"
-      File.delete(file) if File.exists?(file)
+    generators.each do |generator|
+      FileList["generators/#{generator}/templates/**/*.*"].each do |each|
+        file = "test/rails_root/#{each.gsub("generators/#{generator}/templates/",'')}"
+        File.delete(file) if File.exists?(file)
+      end    
     end
     
-    FileUtils.rm_rf("test/rails_root/db/migrate")
+    FileList["test/rails_root/db/**/*"].each do |each| 
+      FileUtils.rm_rf(each)
+    end
     FileUtils.rm_rf("test/rails_root/vendor/plugins/clearance")
     system "mkdir -p test/rails_root/vendor/plugins/clearance"
     system "cp -R generators test/rails_root/vendor/plugins/clearance"  
   end
-
+  
   desc "Run the generator on the tests"
   task :generate do
-    system "cd test/rails_root && ./script/generate clearance"
+    generators.each do |generator|
+      system "cd test/rails_root && ./script/generate #{generator}"
+    end
   end
 end
 
 desc "Run the test suite"
-task :default => 'test:all'
+task :default => ['test:all', 'test:features']
 
 gem_spec = Gem::Specification.new do |gem_spec|
   gem_spec.name        = "clearance"
-  gem_spec.version     = "0.4.3"
+  gem_spec.version     = "0.4.4"
   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/README

@@ -36,9 +36,9 @@ 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 to
-*something* your config/routes.rb:
+*something* in your config/routes.rb:
 
     map.root :controller => 'home'
     
@@ -51,4 +51,4 @@ test/test_helper.rb:
       include Clearance::Test::TestHelper
     end
 
-*******************************************************************************    
+*******************************************************************************

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

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

data/generators/clearance_features/USAGE

@@ -0,0 +1 @@
+script/generate clearance_stories

data/generators/clearance_features/clearance_features_generator.rb

@@ -0,0 +1,16 @@
+class ClearanceFeaturesGenerator < Rails::Generator::Base
+  
+  def manifest
+    record do |m|
+      m.directory File.join("features", "step_definitions")
+      
+      ["features/step_definitions/clearance_steps.rb",
+       "features/sign_in.feature",
+       "features/sign_out.feature",       
+       "features/sign_up.feature"].each do |file|
+        m.file file, file
+       end
+    end
+  end
+  
+end

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

@@ -0,0 +1,32 @@
+Fature: Password Reset
+  In order to sign in even if he forgot his password
+  A user
+  Should be able to reset it
+  
+    Scenario: User is not registered
+      Given there is no user with "email@person.com"
+      When I request password reset link to be sent to "email@person.com"
+      Then I should see "Unknown email"
+  
+    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"
+      And a password reset message should be sent to "email@person.com"
+      
+    Scenario: User updated his password and types wrong confirmation
+      Given I am signed up and confirmed as "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
+      And I should not be signed in      
+      
+    Scenario: User updates his password
+      Given I am signed up and confirmed as "email@person.com/password"
+      When I follow the password reset link sent to "email@person.com"
+      And I update my password with "newpassword/newpassword"
+      Then I should be signed in
+      When I sign out
+      And I sign in as "email@person.com/newpassword"
+      Then I should be signed in
+      

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

@@ -0,0 +1,41 @@
+Feature: Sign in
+  In order to get access to protected sections of the site
+  A registered user
+  Should be able to sign in
+  
+   Scenario User is not registered
+      Given there is no user with "email@person.com"
+      When I go to the sign in page
+      And I sign in as "email@person.com/password"
+      Then I should see "Bad email or password"
+      And I should not be signed in      
+  
+    Scenario: User is not confirmed
+      Given I signed up with "email@person.com/password"
+      When I go to the sign in page
+      And I sign in as "email@person.com/password"
+      Then I should see "User has not confirmed email"
+      And I should not be signed in
+      
+   Scenario: User enters wrong password
+      Given I am signed up and confirmed as "email@person.com/password"
+      When I go to the sign in page
+      And I sign in as "email@person.com/wrongpassword"
+      Then I should see "Bad email or password"
+      And I should not be signed in
+      
+   Scenario: User signs in successfully
+      Given I am signed up and confirmed as "email@person.com/password"
+      When I go to the sign in page
+      And I sign in as "email@person.com/password"
+      Then I should see "Signed in successfully"
+      And I should be signed in
+      
+   Scenario: User signs in and checks "remember me"
+      Given I am signed up and confirmed as "email@person.com/password"
+      When I go to the sign in page
+      And I sign in with "remember me" as "email@person.com/password"
+      Then I should see "Signed in successfully"
+      And I should be signed in    
+      When I return next time
+      Then I should be signed in

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

@@ -0,0 +1,22 @@
+Feature: Sign out
+  To protect my account from unauthorized access
+  A signed in user
+  Should be able to sign out
+  
+    Scenario: User signs out
+      Given I am signed up and confirmed as "email@person.com/password"
+      When I sign in as "email@person.com/password"
+      Then I should be signed in
+      And I sign out
+      Then I should see "You have been signed out"     
+      And I should not be signed in
+      
+    Scenario: User who was remembered signs out
+      Given I am signed up and confirmed as "email@person.com/password"
+      When I sign in with "remember me" as "email@person.com/password"
+      Then I should be signed in
+      And I sign out
+      Then I should see "You have been signed out"     
+      And I should not be signed in
+      When I return next time
+      Then I should not be signed in  

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

@@ -0,0 +1,30 @@
+Feature: Sign up
+  In order to get access to protected sections of the site
+  A user
+  Should be able to sign up
+  
+    Scenario: User signs up with invalid data
+      When I go to the sign up page
+      And I fill in "Email" with "invalidemail"
+      And I fill in "Password" with "password"
+      And I fill in "Verify Password" with ""
+      And I press "Sign Up"
+      Then I should see error messages
+      
+    Scenario: User signs up with valid data
+      When I go to the sign up page
+      And I fill in "Email" with "email@person.com"
+      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"
+      And a confirmation message should be sent to "email@person.com"
+      
+    Scenario: User confirms his account
+      Given I signed up with "email@person.com/password"
+      When I follow the confirmation link sent to "email@person.com"
+      Then I should see "Confirmed email and signed in"
+      And I should be signed in      
+      
+      
+      

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

@@ -0,0 +1,103 @@
+# General
+
+Then /^I should see error messages$/ do
+  Then %{I should see "error(s)? prohibited"}
+end
+
+# DB
+
+Given /^there is no user with "(.*)"$/ do |email|
+  assert_nil User.find_by_email(email)
+end
+
+Given /^I signed up with "(.*)\/(.*)"$/ do |email, password|
+  user = Factory :user, 
+    :email                 => email, 
+    :password              => password,
+    :password_confirmation => password
+end 
+
+Given /^I am signed up and confirmed as "(.*)\/(.*)"$/ do |email, password|
+  user = Factory :email_confirmed_user,
+    :email                 => email, 
+    :password              => password,
+    :password_confirmation => password
+end
+
+# Session
+
+Then /^I should be signed in$/ do
+  assert_not_nil request.session[:user_id]
+  assert_not_nil request.session[:salt]
+end
+
+Then /^I should not be signed in$/ do
+  assert_nil request.session[:user_id]
+  assert_nil request.session[:salt]
+end
+
+When /^session is cleared$/ do
+  request.session[:user_id] = nil
+  request.session[:salt]    = nil
+end
+
+# Emails
+
+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 !user.token.blank?
+  assert_match /#{user.token}/, sent.body
+end
+
+When /^I follow the confirmation link sent to "(.*)"$/ do |email|
+  user = User.find_by_email(email)
+  visit new_user_confirmation_path(:user_id => user, :token => user.token)
+end
+
+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 !user.token.blank?
+  assert_match /#{user.token}/, sent.body
+end
+
+When /^I follow the password reset link sent to "(.*)"$/ do |email|
+  user = User.find_by_email(email)
+  visit edit_user_password_path(:user_id => user, :token => user.token)
+end
+
+# Actions
+
+When /^I sign in( with "remember me")? as "(.*)\/(.*)"$/ do |remember, email, password|
+  When %{I go to the sign in page}
+  And %{I fill in "Email" with "#{email}"}
+  And %{I fill in "Password" with "#{password}"}
+  And %{I check "Remember me"} if remember
+  And %{I press "Sign In"}
+end
+
+When /^I sign out$/ do
+  visit '/session', :delete    
+end
+
+When /^I request password reset link to be sent to "(.*)"$/ do |email|
+  When %{I go to the password reset request page}
+  And %{I fill in "Email address" with "#{email}"}
+  And %{I press "Reset password"}
+end
+
+When /^I update my password with "(.*)\/(.*)"$/ do |password, confirmation|
+  And %{I fill in "Choose password" with "#{password}"}
+  And %{I fill in "Verify password" with "#{confirmation}"}
+  And %{I press "Save this password"}   
+end
+
+When /^I return next time$/ do
+  When %{session is cleared}
+  And %{I go to the homepage}
+end

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

@@ -9,8 +9,8 @@ module Clearance
             should_filter_params :token
 
             context "Given a user whose email has not been confirmed" do
-              setup { @user = Factory(:registered_user) }
-
+              setup { @user = Factory(:user) }
+              
               context "on GET to #new with correct id and token" do
                 setup do
                   get :new, :user_id => @user.to_param, :token => @user.token

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

@@ -11,7 +11,7 @@ module Clearance
 
             context "with a confirmed user" do
               setup do
-                @user = Factory(:registered_user)
+                @user = Factory(:user)
                 @user.confirm_email!
               end
 

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

@@ -18,8 +18,8 @@ module Clearance
               should_display_a_sign_in_form
             end
 
-            context "Given a registered user" do
-              setup { @user = Factory(:registered_user) }
+            context "Given a user" do
+              setup { @user = Factory(:user) }
 
               context "a POST to #create with good credentials" do
                 setup do
@@ -41,7 +41,7 @@ module Clearance
 
             context "Given an email confirmed user" do
               setup do
-                @user = Factory(:registered_user)
+                @user = Factory(:user)
                 @user.confirm_email!              
               end 
 

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

@@ -16,7 +16,7 @@ module Clearance
                 should_render_template :new
                 should_not_set_the_flash
                 
-                should_display_a_registration_form
+                should_display_a_sign_up_form
               end
               
               context "Given email parameter when getting new User view" do
@@ -32,7 +32,7 @@ module Clearance
 
               context "Given valid attributes when creating a new user" do
                 setup do
-                  user_attributes = Factory.attributes_for(:registered_user)
+                  user_attributes = Factory.attributes_for(:user)
                   post :create, :user => user_attributes
                 end
             

data/lib/clearance/test/test_helper.rb

@@ -7,7 +7,7 @@ module Clearance
           
           def sign_in_as(user = nil)
             unless user
-              user = Factory(:registered_user)
+              user = Factory(:user)
               user.confirm_email!
             end
             @request.session[:user_id] = user.id

data/lib/clearance/test/unit/clearance_mailer_test.rb

@@ -8,7 +8,7 @@ module Clearance
             
             context "A change password email" do
               setup do
-                @user  = Factory(:registered_user)
+                @user  = Factory(:user)
                 @email = ClearanceMailer.create_change_password @user
               end
 
@@ -33,7 +33,7 @@ module Clearance
             
             context "A confirmation email" do
               setup do
-                @user  = Factory(:registered_user)
+                @user  = Factory(:user)
                 @email = ClearanceMailer.create_confirmation @user
               end
 

data/lib/clearance/test/unit/user_test.rb

@@ -10,24 +10,24 @@ module Clearance
               :salt, :encrypted_password, 
               :token, :token_expires_at
             
-            # registering
+            # signing up
             
-            context "When registering" do
+            context "When signing up" do
               should_require_attributes        :email, :password
               should_allow_values_for          :email, "foo@example.com"
               should_not_allow_values_for      :email, "foo"
               should_not_allow_values_for      :email, "example.com"
               
               should_validate_confirmation_of  :password, 
-                :factory => :registered_user
+                :factory => :user
               
               should "initialize salt" do
-                assert_not_nil Factory(:registered_user).salt
+                assert_not_nil Factory(:user).salt
               end
               
               should "initialize token witout expiry date" do
-                assert_not_nil Factory(:registered_user).token
-                assert_nil Factory(:registered_user).token_expires_at
+                assert_not_nil Factory(:user).token
+                assert_nil Factory(:user).token_expires_at
               end
               
               context "encrypt password" do
@@ -35,7 +35,7 @@ module Clearance
                   @salt = "salt"
                   User.any_instance.stubs(:initialize_salt)
 
-                  @user     = Factory(:registered_user, :salt => @salt)
+                  @user     = Factory(:user, :salt => @salt)
                   @password = @user.password
 
                   @user.encrypt(@password)
@@ -49,22 +49,22 @@ module Clearance
               end
               
               should "store email in lower case" do
-                user = Factory(:registered_user, :email => "John.Doe@example.com")
+                user = Factory(:user, :email => "John.Doe@example.com")
                 assert_equal "john.doe@example.com", user.email
               end
             end
             
-            context "When multiple users have registerd" do
-              setup { @user = Factory(:registered_user) }
+            context "When multiple users have signed up" do
+              setup { @user = Factory(:user) }
               
               should_require_unique_attributes :email
             end
             
             # confirming email
             
-            context "A registered user without email confirmation" do
+            context "A user without email confirmation" do
               setup do
-                @user = Factory(:registered_user)
+                @user = Factory(:user)
                 assert ! @user.email_confirmed?
               end
 
@@ -88,7 +88,7 @@ module Clearance
         
             context "A user" do
               setup do
-                @user     = Factory(:registered_user)
+                @user     = Factory(:user)
                 @password = @user.password
               end
               
@@ -176,7 +176,7 @@ module Clearance
             
             context "An email confirmed user" do
               setup do
-                @user = Factory(:registered_user)
+                @user = Factory(:user)
                 @user.confirm_email!
               end
               

data/shoulda_macros/clearance.rb

@@ -61,7 +61,7 @@ module Clearance
     def signed_in_user_context(&blk)
       context "A signed in user" do
         setup do
-          @user = Factory(:registered_user)
+          @user = Factory(:user)
           @user.confirm_email!
           sign_in_as @user
         end
@@ -184,10 +184,10 @@ module Clearance
       end      
     end
     
-    def should_display_a_registration_form
-      should "display a form to register" do
+    def should_display_a_sign_up_form
+      should "display a form to sign up" do
         assert_select "form[action=#{users_path}][method=post]", 
-        true, "There must be a form to register" do
+        true, "There must be a form to sign up" do
           assert_select "input[type=text][name=?]", 
             "user[email]", true, "There must be an email field"
           assert_select "input[type=password][name=?]", 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: thoughtbot-clearance
 version: !ruby/object:Gem::Version 
-  version: 0.4.3
+  version: 0.4.4
 platform: ruby
 authors: 
 - thoughtbot, inc.
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-29 21:00:00 -08:00
+date: 2009-02-01 21:00:00 -08:00
 default_executable: 
 dependencies: []
 
@@ -28,6 +28,7 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- CHANGELOG.textile
 - LICENSE
 - Rakefile
 - README.textile
@@ -78,6 +79,17 @@ files:
 - generators/clearance/templates/test/unit/clearance_mailer_test.rb
 - generators/clearance/templates/test/unit/user_test.rb
 - generators/clearance/USAGE
+- generators/clearance_features
+- generators/clearance_features/clearance_features_generator.rb
+- generators/clearance_features/templates
+- generators/clearance_features/templates/features
+- generators/clearance_features/templates/features/password_reset.feature
+- generators/clearance_features/templates/features/sign_in.feature
+- generators/clearance_features/templates/features/sign_out.feature
+- 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/USAGE
 - lib/clearance
 - lib/clearance/app
 - lib/clearance/app/controllers