gsterndale-warrant 0.0.0 → 0.2.0

data/test/rails_root/vendor/gems/quietbacktrace-0.1.1/lib/attribute_accessors.rb

@@ -0,0 +1,131 @@
+# :stopdoc:
+#
+# Snipped directly from ActiveSupport from Rails 1.2.3
+# If Quiet Backtrace is run from a Rails app, the actual ActiveSupport
+# methods will be used. That way, mattr_accessor and cattr_accessor will 
+# not be overridden in your Rails app if Quiet Backtrace is installed.
+#
+# Copyright (c) 2005-2006 David Heinemeier Hansson
+# 
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+# activesupport/lib/activesupport/core_ext/module/attribute_accessors.rb
+#
+# Extends the module object with module and instance accessors for class attributes, 
+# just like the native attr* accessors for instance attributes.
+unless defined?(ActiveSupport)
+  class Module # :nodoc:
+    def mattr_reader(*syms)
+      syms.each do |sym|
+        next if sym.is_a?(Hash)
+        class_eval(<<-EOS, __FILE__, __LINE__)
+          unless defined? @@#{sym}
+            @@#{sym} = nil
+          end
+        
+          def self.#{sym}
+            @@#{sym}
+          end
+
+          def #{sym}
+            @@#{sym}
+          end
+        EOS
+      end
+    end
+  
+    def mattr_writer(*syms)
+      options = syms.last.is_a?(Hash) ? syms.pop : {}
+      syms.each do |sym|
+        class_eval(<<-EOS, __FILE__, __LINE__)
+          unless defined? @@#{sym}
+            @@#{sym} = nil
+          end
+        
+          def self.#{sym}=(obj)
+            @@#{sym} = obj
+          end
+        
+          #{"
+          def #{sym}=(obj)
+            @@#{sym} = obj
+          end
+          " unless options[:instance_writer] == false }
+        EOS
+      end
+    end
+  
+    def mattr_accessor(*syms)
+      mattr_reader(*syms)
+      mattr_writer(*syms)
+    end
+  end
+
+  # activesupport/lib/activesupport/core_ext/class/attribute_accessors.rb
+
+  # Extends the class object with class and instance accessors for class attributes,
+  # just like the native attr* accessors for instance attributes.
+  class Class # :nodoc:
+    def cattr_reader(*syms)
+      syms.flatten.each do |sym|
+        next if sym.is_a?(Hash)
+        class_eval(<<-EOS, __FILE__, __LINE__)
+          unless defined? @@#{sym}
+            @@#{sym} = nil
+          end
+
+          def self.#{sym}
+            @@#{sym}
+          end
+
+          def #{sym}
+            @@#{sym}
+          end
+        EOS
+      end
+    end
+
+    def cattr_writer(*syms)
+      options = syms.last.is_a?(Hash) ? syms.pop : {}
+      syms.flatten.each do |sym|
+        class_eval(<<-EOS, __FILE__, __LINE__)
+          unless defined? @@#{sym}
+            @@#{sym} = nil
+          end
+
+          def self.#{sym}=(obj)
+            @@#{sym} = obj
+          end
+
+          #{"
+          def #{sym}=(obj)
+            @@#{sym} = obj
+          end
+          " unless options[:instance_writer] == false }
+        EOS
+      end
+    end
+
+    def cattr_accessor(*syms)
+      cattr_reader(*syms)
+      cattr_writer(*syms)
+    end
+  end
+end

data/test/rails_root/vendor/gems/quietbacktrace-0.1.1/lib/quietbacktrace.rb

@@ -0,0 +1,154 @@
+# = Quiet Backtrace
+# 
+# Quiet Backtrace suppresses the noise in your Test::Unit backtrace.
+# It also provides hooks for you to add additional silencers and filters.
+# 
+# == Install
+# 
+# sudo gem install quietbacktrace
+# 
+# == Usage
+# 
+# Quiet Backtrace works by adding new attributes to Test::Unit::TestCase. 
+# By default, their values are: 
+#   self.quiet_backtrace = true
+#   self.backtrace_silencers = [:test_unit, :gem_root, :e1]
+#   self.backtrace_filters = [:method_name]
+# 
+# Silencers remove lines from the backtrace that return true for given conditions.
+# Filters modify the output of backtrace lines.
+# 
+# Override the defaults by adding your own backtrace_silencers:
+#   class Test::Unit::TestCase
+#     self.backtrace_silencers :shoulda do |line|
+#        line.include? 'vendor/plugins/shoulda'
+#     end
+#   end
+# 
+# Or your own backtrace_filters:
+#   class Test::Unit::TestCase
+#     self.backtrace_filters :ruby_path do |line|
+#        ruby_file_path = '/System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/lib/ruby/1.8'
+#        line.slice!(0..(line =~ ruby_file_path)) if (line =~ ruby_file_path)
+#     end
+#   end
+#
+# Turn Quiet Backtrace off anywhere in your test suite by setting the flag to false:
+#   Test::Unit::TestCase.quiet_backtrace = false
+# 
+# == Rails-specific usage
+# 
+# Install gemsonrails, add it your Rails app, then freeze quietbacktrace:
+# 
+# * gem install gemsonrails
+# * cd rails-app-folder
+# * gemsonrails
+# * rake gems:freeze GEM=quietbacktrace
+# 
+# Quiet Backtrace comes with an excellent Rails-specific silencer and filter.
+# They must be added (usually in test_helper.rb) because they are not turned on by default:
+#   class Test::Unit::TestCase
+#     self.backtrace_silencers << :rails_vendor
+#     self.backtrace_filters   << :rails_root
+#   end
+# 
+# Because Quiet Backtrace works by adding attributes onto Test::Unit::TestCase,
+# you can add and remove silencers and filters at any level in your test suite,
+# down to the individual test.
+#
+# == Resources
+# 
+# * mailing list: http://groups.google.com/group/quiet_backtrace
+# * project site: http://rubyforge.org/projects/quietbacktrace
+# 
+# == Authors
+# 
+# * Dan Croak (dcroak@thoughtbot.com, http://dancroak.com) 
+# * James Golick (james@giraffesoft.ca, http://jamesgolick.com) 
+# * Joe Ferris (jferris@thoughtbot.com)
+# 
+# Special thanks to the Boston.rb group (http://boston.rubygroup.org)
+# for cultivating this idea at our inaugural hackfest. 
+# 
+# == Requirements
+#
+# * Test::Unit 
+# * aliasing.rb and attribute_accessors.rb, which are snipped from ActiveSupport and 
+#   are included in the gem. They allow quiet_backtrace.rb to use alias_method_chain, 
+#   cattr_accessor, and mattr_accessor.
+#
+# == Copyright
+#
+# Copyright (c) 2007 Dan Croak, thoughtbot, inc., released under the MIT license
+
+require 'test/unit'
+require File.expand_path(File.dirname(__FILE__) + '/attribute_accessors')
+require File.expand_path(File.dirname(__FILE__) + '/aliasing')
+
+module QuietBacktrace # :nodoc: all
+  module BacktraceFilter
+    def self.included(klass)
+      klass.class_eval { alias_method_chain :filter_backtrace, :quieting }
+    end
+
+    mattr_accessor :silencers, :filters
+    self.silencers, self.filters = {}, {}
+
+    def filter_backtrace_with_quieting(backtrace)
+      filter_backtrace_without_quieting(backtrace)
+
+      backtrace = backtrace.first.split("\n") if backtrace.size == 1
+
+      if Test::Unit::TestCase.quiet_backtrace
+        backtrace.reject! do |line|
+          [*Test::Unit::TestCase.backtrace_silencers].any? do |silencer_name|
+            QuietBacktrace::BacktraceFilter.silencers[silencer_name].call(line) if silencer_name
+          end
+        end
+
+        backtrace.each do |line|
+          [*Test::Unit::TestCase.backtrace_filters].each do |filter_name|
+            QuietBacktrace::BacktraceFilter.filters[filter_name].call(line) if filter_name
+          end
+        end          
+      end
+      
+      backtrace
+    end
+  end
+  
+  module TestCase
+    def self.included(klass)
+      klass.class_eval do
+        cattr_accessor :quiet_backtrace, :backtrace_silencers, :backtrace_filters
+        self.backtrace_filters, self.backtrace_silencers = [], []
+        
+        extend ClassMethods
+        new_backtrace_silencer(:test_unit)    { |line| (line.include?("ruby") && line.include?("/test/unit")) }
+        new_backtrace_silencer(:gem_root)     { |line| line =~ /ruby\/gems/i }
+        new_backtrace_silencer(:e1)           { |line| line == "-e:1" }
+        new_backtrace_silencer(:rails_vendor) { |line| (line.include?("vendor/plugins") || line.include?("vendor/gems") || line.include?("vendor/rails")) }
+        
+        new_backtrace_filter(:method_name)   { |line| line.slice!((line =~ /:in /)..line.length) if (line =~ /:in /) }
+        new_backtrace_filter(:rails_root)    { |line| line.sub!("#{RAILS_ROOT}/", '') if (defined?(RAILS_ROOT) && line.include?(RAILS_ROOT)) }
+        
+        self.quiet_backtrace = true
+        self.backtrace_silencers = [:test_unit, :gem_root, :e1]
+        self.backtrace_filters = [:method_name]
+      end
+    end
+      
+    module ClassMethods
+      def new_backtrace_silencer(symbol, &block)
+        QuietBacktrace::BacktraceFilter.silencers[symbol] = block
+      end
+    
+      def new_backtrace_filter(symbol, &block)
+        QuietBacktrace::BacktraceFilter.filters[symbol] = block
+      end
+    end
+  end
+end
+
+Test::Unit::Util::BacktraceFilter.module_eval { include QuietBacktrace::BacktraceFilter }
+Test::Unit::TestCase.class_eval { include QuietBacktrace::TestCase }

data/test/rails_root/vendor/gems/quietbacktrace-0.1.1/test/quiet_backtrace_test.rb

@@ -0,0 +1,144 @@
+# = Quiet Backtrace Test 
+#
+# It is worth looking through the Quiet Backtrace test source 
+# to see how Shoulda and Quiet Backtrace play well together.
+#
+# Shoulda's context blocks are perfect spots to turn Quiet Backtrace
+# off if you need a more verbose backtrace to debug a particular problem.
+#
+# For example:
+#   context "Setting quiet backtrace to false" do
+#   
+#     setup do
+#       self.quiet_backtrace = false
+#     end
+#   
+#     should "keep the backtrace noisy" do
+#       assert_equal @backtrace, @unfiltered_backtrace
+#     end
+#   
+#   end
+#
+# For more on Shoulda, see http://thoughtbot.com/projects/shoulda
+
+require File.expand_path('../lib/quietbacktrace', File.dirname(__FILE__))
+require 'test/unit'
+require 'rubygems'
+require 'shoulda'
+
+class MockTestUnit # :nodoc:
+  def filter_backtrace(backtrace); end
+  include QuietBacktrace::BacktraceFilter
+end
+
+class QuietBacktraceTest < Test::Unit::TestCase # :nodoc:
+  def setup
+    @backtrace = [ "/System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/lib/ruby/1.8/test/unit/assertions.rb:48:in `assert_block'", 
+                   "/System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/lib/ruby/1.8/test/unit/assertions.rb:495:in `_wrap_assertion'", 
+                   "/System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/lib/ruby/1.8/test/unit/assertions.rb:46:in `assert_block'", 
+                   "/System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/lib/ruby/1.8/test/unit/assertions.rb:313:in `flunk'", 
+                   "/Users/james/Documents/railsApps/generating_station/app/controllers/photos_controller.rb:315:in `something'",
+                   "/Users/james/Documents/railsApps/generating_station/vendor/plugins/quiet_stacktraces/test/quiet_stacktraces_test.rb:21:in `test_this_plugin'", 
+                   "/Users/james/Documents/railsApps/generating_station/vendor/plugins/quiet_stacktraces/quiet_stacktraces_test.rb:25:in `test_this_plugin'",
+                   "/Library/Ruby/Gems/1.8/gems/activerecord-1.99.0/lib/active_record/connection_adapters/mysql_adapter.rb:471:in `real_connect'",
+                   "/Library/Ruby/Gems/1.8/gems/activerecord-1.99.0/lib/active_record/fixtures.rb:895:in `teardown'",
+                   "/System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/lib/ruby/1.8/test/unit/ui/testrunnermediator.rb:46:in `run_suite'", 
+                   "/System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/lib/ruby/1.8/test/unit/ui/console/testrunner.rb:67:in `start_mediator'", 
+                   "/System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/lib/ruby/1.8/test/unit/ui/console/testrunner.rb:41:in `start'", 
+                   "/System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/lib/ruby/1.8/test/unit/ui/testrunnerutilities.rb:29:in `run'", 
+                   "/System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/lib/ruby/1.8/test/unit/autorunner.rb:216:in `run'", 
+                   "/System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/lib/ruby/1.8/test/unit/autorunner.rb:12:in `run'", 
+                   "/System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/lib/ruby/1.8/test/unit.rb:278", 
+                   "/Users/james/Documents/railsApps/generating_station/vendor/plugins/quiet_stacktraces/test/quiet_stacktraces_test.rb:20"]
+  end
+  
+  context "The default quiet backtrace" do
+    
+    setup do
+      reset_filter!
+      @mock = MockTestUnit.new
+      @default_quiet_backtrace = @mock.filter_backtrace(@backtrace.dup)
+    end
+
+    should "silence any line from the test unit framework" do
+      assert !@default_quiet_backtrace.any? { |line| line.include?('ruby') && line.include?('test/unit') }, "One or more lines from the test/unit framework are not being filtered: #{@default_quiet_backtrace}"
+    end
+
+    should "silence any line that includes ruby slash gems" do
+      assert !@default_quiet_backtrace.any? { |line| line =~ /ruby\/gems/i }, "One or more lines from ruby/gems are not being filtered: #{@default_quiet_backtrace}"
+    end
+    
+    should "silence any line that includes the e1 nonsense" do
+      assert !@default_quiet_backtrace.any? { |line| line == "-e:1" }, "One or more e1 nonsense lines are not being filtered: #{@default_quiet_backtrace}"
+    end
+
+    should "remove in methods from the end of lines" do
+      assert !@default_quiet_backtrace.any? { |line| line =~ /\:in / }, "Method name was not removed from one or more lines: #{@default_quiet_backtrace}"
+    end
+
+    should "not silence or filter a legitimate line" do
+      assert @default_quiet_backtrace.any? { |line| line == '/Users/james/Documents/railsApps/generating_station/app/controllers/photos_controller.rb:315' }, "Rails root is not being filtered: #{@default_quiet_backtrace}"
+    end
+    
+  end
+  
+  context "The quiet backtrace with complementary Rails silencers and filters" do
+    
+    setup do
+      reset_filter!
+      ::RAILS_ROOT = '/Users/james/Documents/railsApps/generating_station'
+      self.backtrace_silencers << :rails_vendor
+      self.backtrace_filters << :rails_root
+      @mock = MockTestUnit.new
+      @rails_quiet_backtrace = @mock.filter_backtrace(@backtrace.dup)
+    end
+    
+    should "silence any line from the RAILS_ROOT/vendor directory" do
+      assert !@rails_quiet_backtrace.any? { |line| (line.include?("vendor/gems") || line.include?("vendor/plugins") || line.include?("vendor/rails")) }, "One or more lines from the vendor directory are not being silenced: #{@rails_quiet_backtrace.inspect}"
+    end
+    
+    should "remove RAILS_ROOT text from the beginning of lines" do
+      assert !@rails_quiet_backtrace.any? { |line| line.include?("#{RAILS_ROOT}") }, "One or more lines that include RAILS_ROOT text are not being filtered: #{@rails_quiet_backtrace.inspect}"
+    end
+    
+  end
+  
+  context "Setting quiet backtrace to false" do
+    
+    setup do
+      reset_filter!
+      self.quiet_backtrace = false
+      @mock = MockTestUnit.new
+      @unfiltered_backtrace = @mock.filter_backtrace(@backtrace.dup)
+    end
+    
+    should "keep the backtrace noisy" do
+      assert_equal @backtrace, @unfiltered_backtrace, "Backtrace was silenced when it was told not to. This tool is a dictator."
+    end
+    
+  end
+  
+  context "Overriding the defaults" do
+    
+    setup do
+      reset_filter!
+      self.backtrace_silencers = [:test_unit, :rails_vendor]
+      @mock = MockTestUnit.new
+      @not_filtering_gem_root = @mock.filter_backtrace(@backtrace.dup)
+    end
+
+    should "not apply a filter when it is not included in silencers" do
+      assert @not_filtering_gem_root.any? { |line| line =~ /ruby\/gems/i }, "One or more lines from ruby/gems were filtered, when that filter was excluded: #{@not_filtering_gem_root}"
+    end
+    
+  end
+  
+  private
+  
+    def reset_filter!
+      self.quiet_backtrace = true
+      self.backtrace_silencers = [:test_unit, :gem_root]
+      self.backtrace_filters = [:method_name]
+    end
+  
+end

data/test/rails_root/vendor/gems/thoughtbot-clearance-0.4.0/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2008 thoughtbot, inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/test/rails_root/vendor/gems/thoughtbot-clearance-0.4.0/README.textile

@@ -0,0 +1,204 @@
+h1. Clearance
+
+Rails authentication for developers who write tests.
+
+"We have clearance, Clarence.":http://www.youtube.com/v/mNRXJEE3Nz8
+
+h2. Integration with Suspenders
+
+Clearance is based on the same conventions and tools as "Suspenders":http://github.com/thoughtbot/suspenders Thus if you use it, you may already have some configuration mentioned below in place.
+
+h2. Gem installation (Rails 2.1+)
+
+In config/environment.rb:
+
+    config.gem 'mocha'
+    config.gem 'thoughtbot-shoulda',
+      :lib     => 'shoulda',
+      :source  => "http://gems.github.com", 
+      :version => '>= 2.0.6'
+    config.gem 'thoughtbot-factory_girl',
+      :lib     => 'factory_girl',
+      :source  => "http://gems.github.com", 
+      :version => '>= 1.1.5'
+    config.gem "thoughtbot-clearance", 
+      :lib     => 'clearance', 
+      :source  => 'http://gems.github.com', 
+      :version => '>= 0.3.9'
+
+Then:
+
+    rake gems:install
+    rake gems:unpack
+
+h2. The generator
+
+Make sure the development database exists and run the generator:
+
+    script/generate clearance
+
+A number of files will be created and instructions will be printed.
+
+You may already have some of these files. Don't worry. You'll be asked if you want to overwrite them.
+
+h2. Modules
+
+Clearance works by mixing behavior into tests, controllers, and models. For any file that you do not want to overwrite, include the corresponding Clearance module. They are namespaced exactly like the directory structure of a Rails app.
+
+Application controller example:
+
+    class ApplicationController < ActionController::Base
+      include Clearance::App::Controllers::ApplicationController
+    end
+
+User model example:
+
+    class User < ActiveRecord::Base
+      include Clearance::App::Models::User
+    end
+
+User test example:
+
+    class UserTest < Test::Unit::TestCase
+      include Clearance::Test::Unit::UserTest
+    end
+
+h2. The migration    
+    
+The generator will also create a migration to add a "users" table and run it. If the table already exists in the database, the migration will just add fields and indexes that are missing and required by Clearance. If the migration fails, the generator will revert all changes back.
+
+h2. Routes
+
+Clearance will add these routes to your routes.rb:
+
+    map.resources :users, :has_one => [:password, :confirmation]
+    map.resource  :session
+    map.resources :passwords
+    
+Please note that Clearance depends on root_url, so please make sure that it is defined to *something* in your config/routes.rb:
+
+    map.root :controller => 'home'
+    
+h2. Environments
+
+You need to define HOST constant in your environments files. In config/environments/test.rb and config/environments/development.rb it can be:
+
+    HOST = "localhost"
+
+While in config/environments/production.rb it must be the actual host your application is deployed to because the constant is used by mailers to generate URLs in emails.
+
+In config/environment.rb:
+
+    DO_NOT_REPLY = "donotreply@example.com"
+
+h2. Tests
+
+The tests use "Shoulda":http://thoughtbot.com/projects/shoulda >= 2.0.6 and "Factory Girl":http://thoughtbot.com/projects/factory_girl >= 1.1.5. There needs to be a Clearance module in your test/test_helper.rb:
+
+    class Test::Unit::TestCase
+      self.use_transactional_fixtures = true
+      self.use_instantiated_fixtures  = false
+      include Clearance::Test::TestHelper
+    end
+
+The generator will create a user factory in test/factories/clearance.rb unless
+you have it defined somewhere else.
+
+h2. Usage: basic workflow
+
+Rails authentication with Clearance uses the standard approach thoughtbot and our clients have agreed upon. 
+
+Users register (UsersController) using an email address and a password (User model). They get an email (ClearanceMailer) with a confirmation link to confirm their registration (ConfirmationController).
+
+Registered users can sign in and out (SessionsController). If they forget their password, they request an email (ClearanceMailer) containing a link to change it (PasswordsController). 
+
+h2. Usage: actions which require an authenticated user
+
+To protect your controllers with authentication add:
+
+    class ProtectedController < ApplicationController
+      before_filter :authenticate
+
+The filter will ensure that only authenticated users can access the controller. If someone who's not signed in tries to access a protected action: 
+
+* the URL is stored in the session, 
+* the user is redirected to sign in page, and
+* after successful authentication will be be redirected back to that URL.
+
+h2. Usage: signed_in?, current_user
+
+Clearance provides two methods that can be used in controllers, helpers, and views to check if current user is authenticated and get the actual user: 
+
+* signed_in?
+* current_user
+   
+    <% if signed_in? -%>
+      Hello, <%= current_user.name %>!
+    <% else -%>
+      Please <%= link_to 'Sign in', new_session_path %>
+    <% end -%>
+    
+h2. Usage: mass assignment
+
+Please note that all User attributes except email, password and password_confirmation are protected from mass assignment by default. Use attr_accessible to enable it for your custom attributes.
+    
+    class User < ActiveRecord::Base
+      include Clearance::App::Models::User
+      attr_accessible :first_name, :last_name
+    end
+
+h2. Hooks: return_to parameter
+
+To specify where to redirect a user (say you want to have a sign in form on every page and redirect the user to the same page) after he/she signs in, you can add a "return_to" parameter to the request (thanks to "Phillippe":http://www.sivarg.com/2009/01/clearance-coming-from-where-your-were.html for the tip):
+
+    <% form_for :session, :url => session_path(:return_to => request.request_uri) do |form| %>
+
+h2. Hooks: url_after_create, url_after_destroy
+    
+Actions that redirect (create and destroy) in Clearance controllers are customizable. If you want to redirect a user to a specific route after signing in, overwrite the "url_after_create" method in the SessionsController:
+
+    class SessionsController < ApplicationController
+      include Clearance::App::Controllers::SessionsController
+      
+      private
+      
+        def url_after_create
+          new_blog_post_path
+        end
+    end
+
+There are similar methods in other controllers as well:
+
+    UsersController#url_after_create (register)
+    SessionsController#url_after_create (sign in)
+    SessionsController#url_after_destroy (sign out)
+    PasswordsController#url_after_create (password request)
+    ConfirmationsController#url_after_create (confirmation)
+
+h2. Hooks: sign_user_in
+
+Say you want to add a last_signed_in_at attribute to your User model. You would want to update it when the User signs in.
+
+Clearance has a method named sign_user_in that you can overwrite with that logic. Be sure to call sign_in(user) at the end (and write tests!).
+
+    class ApplicationController < ActionController::Base
+      include Clearance::App::Controllers::ApplicationController
+      
+      private
+        
+        def sign_user_in(user)
+          # store current time to display "last signed in at" message
+          user.update_attribute(:last_signed_in_at, Time.now)
+          sign_in(user)
+        end
+    end 
+
+h2. Authors
+
+* thoughtbot, inc.
+* Dan Croak
+* Jason Morrison
+* Mike Burns
+* Josh Nichols
+* Mike Breen
+* Eugene Bolshakov