clearance 0.8.8 → 0.9.0.rc1

data/CHANGELOG.md

@@ -1,5 +1,13 @@
+0.8.9 (unreleased)
+------------------
+
+* Removed unnecessary db index. (Rich Thornett, doctorzaius)
+* [#79] Allow customization of cookie duration. (Ron Newman, Dan Croak)
+* [#77] rake generator:cleanup needed to be... cleaned up. (Ron Newman)
+
 0.8.8 (02/25/2010)
 ------------------
+
 * Fixed sign_in and sign_out not setting current_user (Joe Ferris)
 
 0.8.7 (02/21/2010)

data/README.md

@@ -3,7 +3,7 @@ Clearance
 
 Rails authentication with email & password.
 
-[We have clearance, Clarence.](http://www.youtube.com/v/mNRXJEE3Nz8)
+[We have clearance, Clarence.](http://www.youtube.com/watch?v=fVq4_HhBK8Y)
 
 Help
 ----
@@ -20,23 +20,23 @@ Fork away and create a [Github Issue](http://github.com/thoughtbot/clearance/iss
 Installation
 ------------
 
-Clearance is a Rails engine. It works with versions of Rails greater than 2.3.
+Clearance is a Rails engine. The latest stable version works with versions of Rails greater than 3.  If you need to run on Rails 2.x, install Clearance Version 0.8.8.
 
-Install it as a gem however you like to install gems. Gem Bundler example:
+Install it as a gem however you like to install gems. Also, uninstall old versions:
 
-    gem "clearance"
+    sudo gem uninstall thoughtbot-clearance
+    sudo gem uninstall clearance
+    sudo gem install clearance
 
-Make sure the development database exists and run the generator:
+Make sure the development database exists, then run the generator:
 
-    script/generate clearance
+    script/rails generate clearance
 
 This:
 
 * inserts Clearance::User into your User model
 * inserts Clearance::Authentication into your ApplicationController
-* inserts Clearance::Routes.draw(map) into your config.routes.rb
 * created a migration that either creates a users table or adds only missing columns
-* prints further instructions
 
 Usage
 -----
@@ -65,11 +65,11 @@ To change any of provided actions, subclass a Clearance controller...
       end
     end
 
-and add your route above (before) Clearance routes in config/routes.rb:
+and add your route in config/routes.rb:
 
-    map.resource :session, :controller => 'sessions'
+    resource :session, :controller => 'sessions'
 
-See lib/clearance/routes.rb for all the routes Clearance provides.
+See config/routes.rb for all the routes Clearance provides.
 
 Actions that redirect (create, update, and destroy) in Clearance controllers
 can be overriden by re-defining url_after_(action) methods as seen above.
@@ -83,33 +83,27 @@ opinion is that you should test its integration with your app using
 
 Run the Cucumber generator and Clearance feature generator:
 
-    script/generate cucumber
-    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 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
-  end
+    script/rails generate cucumber
+    script/rails generate clearance_features
+
+Edit your Gemfile to include:
+
+    gem 'factory_girl'
+
+Edit your config/enviroments/cucumber.rb to include the following:
+
+    ActionMailer::Base.default_url_options = { :host => 'localhost:3000' }
+
+Then run rake!
 
 Optional Formtastic views
 -------------------------
 
-We use & recommend [Formtastic](http://github.com/justinfrench/formtastic].
+We use & recommend [Formtastic](http://github.com/justinfrench/formtastic).
 
 Clearance has another generator to generate Formastic views:
 
-    script/generate clearance_views
+    script/rails generate clearance_views
 
 Its implementation is designed so other view styles (Haml?) can be generated.
 
@@ -126,4 +120,5 @@ Dan Croak, Mike Burns, Jason Morrison, Joe Ferris, Eugene Bolshakov,
 Nick Quaranto, Josh Nichols, Mike Breen, Marcel Görner, Bence Nagy, Ben Mabey,
 Eloy Duran, Tim Pope, Mihai Anca, Mark Cornick, Shay Arnett, Joshua Clayton,
 Mustafa Ekim, Jon Yurek, Anuj Dutta, Chad Pytel, Ben Orenstein, Bobby Wilson,
-Matthew Ford, Ryan McGeary, Claudio Poli, Joseph Holsten, and Peter Haza.
+Matthew Ford, Ryan McGeary, Claudio Poli, Joseph Holsten, Peter Haza,
+Ron Newman, and Rich Thornett.

data/Rakefile

@@ -1,39 +1,46 @@
 # encoding: utf-8
 
+ENV['BUNDLE_GEMFILE'] = File.dirname(__FILE__) + '/test/rails_root/Gemfile'
+
 require 'rake'
 require 'rake/testtask'
 require 'cucumber/rake/task'
 
 namespace :test do
   Rake::TestTask.new(:basic => ["generator:cleanup",
-                                "generator:clearance",
-                                "generator:clearance_features"]) do |task|
+                                "generator:clearance"]) do |task|
     task.libs << "lib"
     task.libs << "test"
-    task.pattern = "test/**/*_test.rb"
+    task.pattern = "test/*/*_test.rb"
     task.verbose = false
   end
 
-  Rake::TestTask.new(:views => ["generator:clearance_views"]) do |task|
+  Rake::TestTask.new(:views => ["generator:cleanup",
+                                "generator:clearance",
+                                "generator:clearance_views"]) do |task|
     task.libs << "lib"
     task.libs << "test"
-    task.pattern = "test/**/*_test.rb"
+    task.pattern = "test/*/*_test.rb"
     task.verbose = false
   end
 
-  Cucumber::Rake::Task.new(:features) do |t|
+
+  Cucumber::Rake::Task.new(:features => ["generator:cleanup",
+                                         "generator:clearance",
+                                         "generator:clearance_features"]) do |t|
     t.cucumber_opts   = "--format progress"
     t.profile = 'features'
   end
 
-  Cucumber::Rake::Task.new(:features_for_views) do |t|
+  Cucumber::Rake::Task.new(:features_for_views => ["generator:cleanup",
+                                                   "generator:clearance",
+                                                   "generator:clearance_features",
+                                                   "generator:clearance_views"]) do |t|
     t.cucumber_opts   = "--format progress"
     t.profile = 'features_for_views'
   end
 end
 
-generators = %w(clearance clearance_features clearance_views)
-
 namespace :generator do
   desc "Cleans up the test app before running the generator"
   task :cleanup do
@@ -42,46 +49,33 @@ namespace :generator do
     end
 
     FileUtils.rm_rf("test/rails_root/vendor/plugins/clearance")
+    FileUtils.rm_rf("test/rails_root/app/views/passwords")
+    FileUtils.rm_rf("test/rails_root/app/views/sessions")
+    FileUtils.rm_rf("test/rails_root/app/views/users")
     FileUtils.mkdir_p("test/rails_root/vendor/plugins")
     clearance_root = File.expand_path(File.dirname(__FILE__))
     system("ln -s #{clearance_root} test/rails_root/vendor/plugins/clearance")
+    FileList["test/rails_root/features/*.feature"].each do |each|
+      FileUtils.rm_rf(each)
+    end
   end
 
   desc "Run the clearance generator"
   task :clearance do
-    system "cd test/rails_root && ./script/generate clearance -f && rake db:migrate db:test:prepare"
+    system "cd test/rails_root && bundle install && ./script/rails generate clearance && rake db:migrate db:test:prepare"
   end
 
   desc "Run the clearance features generator"
   task :clearance_features do
-    system "cd test/rails_root && ./script/generate clearance_features -f"
+    system "cd test/rails_root && ./script/rails generate clearance_features"
   end
 
   desc "Run the clearance views generator"
   task :clearance_views do
-    system "cd test/rails_root && ./script/generate clearance_views -f"
+    system "cd test/rails_root && ./script/rails generate clearance_views"
   end
 end
 
 desc "Run the test suite"
 task :default => ['test:basic', 'test:features',
                   'test:views', 'test:features_for_views']
-
-require 'jeweler'
-
-Jeweler::Tasks.new do |gem|
-  gem.name        = "clearance"
-  gem.summary     = "Rails authentication with email & password."
-  gem.description = "Rails authentication with email & password."
-  gem.email       = "support@thoughtbot.com"
-  gem.homepage    = "http://github.com/thoughtbot/clearance"
-  gem.authors     = ["Dan Croak", "Mike Burns", "Jason Morrison",
-                     "Joe Ferris", "Eugene Bolshakov", "Nick Quaranto",
-                     "Josh Nichols", "Mike Breen", "Marcel Görner",
-                     "Bence Nagy", "Ben Mabey", "Eloy Duran",
-                     "Tim Pope", "Mihai Anca", "Mark Cornick",
-                     "Shay Arnett", "Jon Yurek", "Chad Pytel"]
-  gem.files       = FileList["[A-Z]*", "{app,config,generators,lib,shoulda_macros,rails}/**/*"]
-end
-
-Jeweler::GemcutterTasks.new

data/app/controllers/clearance/passwords_controller.rb

@@ -13,7 +13,7 @@ class Clearance::PasswordsController < ApplicationController
   def create
     if user = ::User.find_by_email(params[:password][:email])
       user.forgot_password!
-      ::ClearanceMailer.deliver_change_password user
+      ::ClearanceMailer.change_password(user).deliver
       flash_notice_after_create
       redirect_to(url_after_create)
     else

data/app/controllers/clearance/sessions_controller.rb

@@ -21,7 +21,7 @@ class Clearance::SessionsController < ApplicationController
         flash_success_after_create
         redirect_back_or(url_after_create)
       else
-        ::ClearanceMailer.deliver_confirmation(@user)
+        ::ClearanceMailer.confirmation(@user).deliver
         flash_notice_after_create
         redirect_to(sign_in_url)
       end

data/app/models/clearance_mailer.rb

@@ -1,21 +1,21 @@
 class ClearanceMailer < ActionMailer::Base
 
   def change_password(user)
+    @user = user
     from       Clearance.configuration.mailer_sender
-    recipients user.email
+    recipients @user.email
     subject    I18n.t(:change_password,
                       :scope   => [:clearance, :models, :clearance_mailer],
                       :default => "Change your password")
-    body       :user => user
   end
 
   def confirmation(user)
+    @user = user
     from       Clearance.configuration.mailer_sender
-    recipients user.email
+    recipients @user.email
     subject    I18n.t(:confirmation,
                       :scope   => [:clearance, :models, :clearance_mailer],
                       :default => "Account confirmation")
-    body      :user => user
   end
 
 end

data/app/views/passwords/edit.html.erb

@@ -6,7 +6,7 @@
 
 <%= error_messages_for :user %>
 
-<% form_for(:user,
+<%= form_for(:user,
             :url => user_password_path(@user, :token => @user.confirmation_token),
             :html => { :method => :put }) do |form| %>
   <div class="password_field">

data/app/views/passwords/new.html.erb

@@ -4,7 +4,7 @@
   We will email you a link to change your password.
 </p>
 
-<% form_for :password, :url => passwords_path do |form| %>
+<%= form_for :password, :url => passwords_path do |form| %>
   <div class="text_field">
     <%= form.label :email, "Email address" %>
     <%= form.text_field :email %>
@@ -12,4 +12,4 @@
   <div class="submit_field">
     <%= form.submit "Reset password", :disable_with => "Please wait..." %>
   </div>
-<% end %>
+<% end %>

data/app/views/sessions/new.html.erb

@@ -1,6 +1,6 @@
 <h2>Sign in</h2>
 
-<% form_for :session, :url => session_path do |form| %>
+<%= form_for :session, :url => session_path do |form| %>
   <div class="text_field">
     <%= form.label :email %>
     <%= form.text_field :email %>

data/app/views/users/_form.html.erb

@@ -10,4 +10,4 @@
 <div class="password_field">
   <%= form.label :password_confirmation, "Confirm password" %>
   <%= form.password_field :password_confirmation %>
-</div>
+</div>

data/app/views/users/new.html.erb

@@ -1,6 +1,6 @@
 <h2>Sign up</h2>
 
-<% form_for @user do |form| %>
+<%= form_for @user do |form| %>
   <%= render :partial => '/users/form', :object => form %>
   <%= form.submit 'Sign up', :disable_with => 'Please wait...' %>
 <% end %>

data/config/routes.rb

@@ -0,0 +1,30 @@
+Rails.application.routes.draw do |map|
+  map.resources :passwords,
+    :controller => 'clearance/passwords',
+    :only       => [:new, :create]
+
+  map.resource  :session,
+    :controller => 'clearance/sessions',
+    :only       => [:new, :create, :destroy]
+
+  map.resources :users, :controller => 'clearance/users' do |users|
+    users.resource :password,
+      :controller => 'clearance/passwords',
+      :only       => [:create, :edit, :update]
+
+    users.resource :confirmation,
+      :controller => 'clearance/confirmations',
+      :only       => [:new, :create]
+  end
+
+  map.sign_up  'sign_up',
+    :controller => 'clearance/users',
+    :action     => 'new'
+  map.sign_in  'sign_in',
+    :controller => 'clearance/sessions',
+    :action     => 'new'
+  map.sign_out 'sign_out',
+    :controller => 'clearance/sessions',
+    :action     => 'destroy',
+    :method     => :delete
+end

data/lib/clearance.rb

@@ -2,6 +2,7 @@ require 'clearance/extensions/errors'
 require 'clearance/extensions/rescue'
 
 require 'clearance/configuration'
-require 'clearance/routes'
 require 'clearance/authentication'
 require 'clearance/user'
+
+require 'clearance/engine'

data/lib/clearance/authentication.rb

@@ -64,7 +64,7 @@ module Clearance
         if user
           cookies[:remember_token] = {
             :value   => user.remember_token,
-            :expires => 1.year.from_now.utc
+            :expires => Clearance.configuration.cookie_expiration.call
           }
           self.current_user = user
         end
@@ -105,7 +105,7 @@ module Clearance
 
       def store_location
         if request.get?
-          session[:return_to] = request.request_uri
+          session[:return_to] = request.fullpath
         end
       end
 

data/lib/clearance/configuration.rb

@@ -1,9 +1,10 @@
 module Clearance
   class Configuration
-    attr_accessor :mailer_sender
+    attr_accessor :mailer_sender, :cookie_expiration
 
     def initialize
-      @mailer_sender = 'donotreply@example.com'
+      @mailer_sender     = 'donotreply@example.com'
+      @cookie_expiration = lambda { 1.year.from_now.utc }
     end
   end
 
@@ -14,9 +15,15 @@ module Clearance
   # Configure Clearance someplace sensible,
   # like config/initializers/clearance.rb
   #
+  # If you want users to only be signed in during the current session
+  # instead of being remembered, do this:
+  #
+  #   config.cookie_expiration = lambda { }
+  #
   # @example
   #   Clearance.configure do |config|
-  #     config.mailer_sender = 'donotreply@example.com'
+  #     config.mailer_sender     = 'me@example.com'
+  #     config.cookie_expiration = lambda { 2.weeks.from_now.utc }
   #   end
   def self.configure
     self.configuration ||= Configuration.new

data/lib/clearance/engine.rb

@@ -0,0 +1,8 @@
+require "clearance"
+require "rails"
+
+module Clearance
+  class Engine < Rails::Engine
+    engine_name :clearance
+  end
+end

data/lib/clearance/user.rb

@@ -16,7 +16,6 @@ module Clearance
     #
     # @see ClassMethods
     # @see InstanceMethods
-    # @see AttrAccessible
     # @see AttrAccessor
     # @see Validations
     # @see Callbacks
@@ -54,7 +53,7 @@ module Clearance
           validates_format_of       :email, :with => %r{.+@.+\..+}, :allow_blank => true
 
           validates_presence_of     :password, :unless => :password_optional?
-          validates_confirmation_of :password, :unless => :password_optional?
+          validates_confirmation_of :password
         end
       end
     end
@@ -99,7 +98,7 @@ module Clearance
       #   user.reset_remember_token!
       def reset_remember_token!
         generate_remember_token
-        save(false)
+        save(:validate => false)
       end
 
       # Confirm my email.
@@ -109,7 +108,7 @@ module Clearance
       def confirm_email!
         self.email_confirmed    = true
         self.confirmation_token = nil
-        save(false)
+        save(:validate => false)
       end
 
       # Mark my account as forgotten password.
@@ -118,7 +117,7 @@ module Clearance
       #   user.forgot_password!
       def forgot_password!
         generate_confirmation_token
-        save(false)
+        save(:validate => false)
       end
 
       # Update my password.
@@ -186,7 +185,7 @@ module Clearance
       end
 
       def send_confirmation_email
-        ClearanceMailer.deliver_confirmation self
+        ClearanceMailer.confirmation(self).deliver
       end
     end