thoughtbot / clearance
watch download tarball
public
Forks52Right
Watchers718Right
Description: Rails authentication with email & password.
Homepage: http://thoughtbot.com
Clone URL: git://github.com/thoughtbot/clearance.git
name age
history
message
file .gitignore Tue Apr 21 14:44:50 -0700 2009 Updating gemspec for 0.6.0 [qrush]
file CHANGELOG.textile Loading commit data...
file LICENSE Tue Nov 04 08:33:14 -0800 2008 Add license [mike-burns]
file README.textile
file Rakefile
file TODO.textile Mon Mar 30 06:40:37 -0700 2009 updating todo list [dancroak]
directory app/
file clearance.gemspec
directory config/ Tue Apr 21 12:39:36 -0700 2009 Revert "Removing namespaces for controllers" T... [qrush]
directory generators/ Tue Apr 14 10:34:51 -0700 2009 Making the error message feature use a regex S... [qrush]
directory lib/ Tue Apr 21 13:35:03 -0700 2009 Removing the tests for #61 since it doesn't see... [qrush]
directory rails/ Sat Sep 06 13:51:36 -0700 2008 Added test stuff. [technicalpickles]
directory shoulda_macros/ Thu Apr 02 14:36:09 -0700 2009 fixing accounts controller test to meet new sho... [dancroak]
directory test/ Tue Apr 21 13:35:03 -0700 2009 Removing the tests for #61 since it doesn't see... [qrush]
README.textile

Clearance

Rails authentication with email & password.

We have clearance, Clarence.

Engine

Clearance is a Rails engine. It works with versions of Rails greater than 2.3.

Wiki

Most information regarding Clearance is on the Github Wiki.

Integration with Suspenders

Clearance is based on the same conventions and tools as Suspenders If you use it, you already have some configuration mentioned below.

Gem installation

In config/environment.rb:

config.gem “thoughtbot-clearance”, :lib => ‘clearance’, :source => ‘http://gems.github.com’, :version => ‘0.6.1’

In config/environments/test.rb:

config.gem ‘thoughtbot-shoulda’, :lib => ‘shoulda’, :source => “http://gems.github.com”, :version => ‘2.10.1’ config.gem ‘thoughtbot-factory_girl’, :lib => ‘factory_girl’, :source => “http://gems.github.com”, :version => ‘1.2.1’

Then:

rake gems:install rake gems:unpack rake gems:install RAILS_ENV=test rake gems:unpack RAILS_ENV=test

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.

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

Authors

Clearance was extracted out of Hoptoad. We merged the authentication code from two of thoughtbot’s client’s Rails apps. The following people have made significant contributions, suggestions, and generally improved the library. Thank you!

Dan Croak, Mike Burns, Jason Morrison, Joe Ferris, Eugene Bolshakov, Josh Nichols, Mike Breen, Marcel Görner, Bence Nagy, Ben Mabey, Eloy Duran, Tim Pope, Mihai Anca, & Mark Cornick.

Questions?

Bugs?