tonkapark-clearance 0.6.9.3 → 0.7.0

data/CHANGELOG.textile

@@ -1,11 +1,16 @@
-h2. 0.6.9.3 (7/21/09)
+h2. 0.7.1 (unreleased)
 
-* added admin to users. 
-* invitation listing for admins only
+* Documented Clearance::Authentication with YARD. (Dan Croak)
+* Documented Clearance::User with YARD. (Dan Croak)
 
-h2. 0.6.9.2 (7/21/09)
+h2. 0.7.0 (08/04/2009)
 
-* forked and added invitations and clearance.yml (Matt Anderson[http://tonkapark.com])
+* Redirect signed in user who clicks confirmation link again. (Dan Croak)
+* Redirect signed out user who clicks confirmation link again. (Dan Croak)
+* Added signed_out? convenience method for controllers, helpers, views. (Dan
+Croak)
+* Added clearance_views generator. By default, creates formtastic views which
+pass all tests and features. (Dan Croak)
 
 h2. 0.6.9 (07/04/2009)
 
@@ -57,6 +62,7 @@ h2. 0.6.2 (04/22/2009)
 * World(NavigationHelpers) Cucumber 3.0 style. (Shay Arnett & Mark Cornick)
 
 h2. 0.6.1 (04/21/2009)
+
 * Scope operators are necessary to keep Rails happy. Reverting the original
 revert so they're back in the library now for constants referenced inside of
 the gem. (Nick Quaranto)

data/README.textile

@@ -1,12 +1,12 @@
 h1. Clearance
 
-Rails authentication with email & password, *and invitations*.
+Rails authentication with email & password.
 
 "We have clearance, Clarence.":http://www.youtube.com/v/mNRXJEE3Nz8
 
-h2. Wiki
+h2. Suspenders
 
-Most information regarding Clearance is on the "Github Wiki":http://wiki.github.com/thoughtbot/clearance.
+Clearance is included in "Suspenders":http://github.com/thoughtbot/suspenders, which thoughtbot uses on all of our apps. We highly recommend you try it. Suspenders is the "King Gem" in our ecosystem, representating what we think the current state-of-the-art is in Rails development.
 
 h2. Installation
 
@@ -15,10 +15,10 @@ Clearance is a Rails engine. It works with versions of Rails greater than 2.3.
 In config/environment.rb:
 
 <pre>
-config.gem "tonkapark-clearance", 
-  :lib     => 'clearance', 
-  :source  => 'http://gems.github.com', 
-  :version => '0.6.9.3'
+config.gem "thoughtbot-clearance",
+  :lib     => 'clearance',
+  :source  => 'http://gems.github.com',
+  :version => '0.7.0'
 </pre>
 
 Vendor the gem:
@@ -30,7 +30,9 @@ rake gems:unpack
 
 Make sure the development database exists and run the generator:
 
-@script/generate clearance@
+<pre>
+script/generate clearance
+</pre>
 
 A number of files will be created and instructions will be printed.
 
@@ -38,50 +40,37 @@ You may already have some of these files. Don't worry. You'll be asked if you wa
 
 Run the migration:
 
-@rake db:migrate@
+<pre>
+rake db:migrate
+</pre>
+
+h2. If you aren't on Suspenders, you aren't done
 
 Define a HOST constant in your environment files.
-In config/clearance.yml:
+In config/environments/test.rb and config/environments/development.rb it can be:
 
 <pre>
-production:
-  host: you_production_host.com
-  do_not_reply: do_not_reply@you_production_host.com
-  invitation_subject_line: An Invitation
-  invitation_from_email: invitation@you_production_host.com
-</pre>  
-  
-Define root_url to *something* in your config/routes.rb:
-
-@map.root :controller => 'home'@
-
-h2. Cucumber Features
+HOST = "localhost"
+</pre>
 
-As your app evolves, you want to know that authentication still works. Clearance's opinion is that you should test its integration with your app using "Cucumber":http://cukes.info/.
+In production.rb it must be the actual host your application is deployed to.
+The constant is used by mailers to generate URLs in emails.
 
-In config/environments/test.rb:
+In config/environment.rb:
 
 <pre>
-config.gem 'webrat',
-  :version => '= 0.4.4'
-config.gem 'cucumber',
-  :version => '= 0.3.0'
-config.gem 'thoughtbot-factory_girl',
-  :lib     => 'factory_girl',
-  :source  => "http://gems.github.com", 
-  :version => '1.2.1'
+DO_NOT_REPLY = "donotreply@example.com"
 </pre>
 
-Vendor the gems:
+Define root_url to *something* in your config/routes.rb:
 
 <pre>
-rake gems:install RAILS_ENV=test
-rake gems:unpack  RAILS_ENV=test
+map.root :controller => 'home'
 </pre>
 
-We don't vendor nokogiri due to its native extensions, so install it normally on your machine:
+h2. Cucumber Features
 
-@sudo gem install nokogiri@
+As your app evolves, you want to know that authentication still works. thoughtbot's opinion is that you should test its integration with your app using "Cucumber":http://cukes.info/.
 
 Run the Cucumber generator (if you haven't already) and Clearance's feature generator:
 
@@ -106,6 +95,18 @@ def path_to(page_name)
 end
 </pre>
 
+h2. Formtastic views
+
+We have begun standardizing our forms using "Formtastic":http://github.com/justinfrench/formtastic. We highly recommend trying it. It will make your Rails view life more interesting.
+
+Clearance has another generator to generate Formastic views:
+
+<pre>
+script/generate clearance_views
+</pre>
+
+Its implementation is designed so that other view styles can be generated if the community wants it. However, we haven't needed them so you'll have to write the patch and send it back if you want other styles (such as Haml).
+
 h2. Authors
 
 Clearance was extracted out of "Hoptoad":http://hoptoadapp.com. We merged the authentication code from two of thoughtbot's clients' Rails apps and have since used it each time we need authentication. The following people have improved the library. Thank you!

data/Rakefile

@@ -5,8 +5,16 @@ require 'rake/testtask'
 require 'cucumber/rake/task'
 
 namespace :test do
-  Rake::TestTask.new(:all => ["generator:cleanup",
-                              "generator:generate"]) do |task|
+  Rake::TestTask.new(:basic => ["generator:cleanup",
+                                "generator:clearance",
+                                "generator:clearance_features"]) do |task|
+    task.libs << "lib"
+    task.libs << "test"
+    task.pattern = "test/**/*_test.rb"
+    task.verbose = false
+  end
+
+  Rake::TestTask.new(:views => ["generator:clearance_views"]) do |task|
     task.libs << "lib"
     task.libs << "test"
     task.pattern = "test/**/*_test.rb"
@@ -17,9 +25,14 @@ namespace :test do
     t.cucumber_opts   = "--format progress"
     t.feature_pattern = "test/rails_root/features/*.feature"
   end
+
+  Cucumber::Rake::Task.new(:features_for_views) do |t|
+    t.cucumber_opts   = "--format progress"
+    t.feature_pattern = "test/rails_root/features/*.feature"
+  end
 end
 
-generators = %w(clearance clearance_features)
+generators = %w(clearance clearance_features clearance_views)
 
 namespace :generator do
   desc "Cleans up the test app before running the generator"
@@ -34,36 +47,45 @@ namespace :generator do
     FileList["test/rails_root/db/**/*"].each do |each| 
       FileUtils.rm_rf(each)
     end
+
     FileUtils.rm_rf("test/rails_root/vendor/plugins/clearance")
     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")
+
+    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")
   end
 
-  desc "Run the generator on the tests"
-  task :generate do
-    generators.each do |generator|
-      system "cd test/rails_root && ./script/generate #{generator} && rake db:migrate db:test:prepare"
-    end
+  desc "Run the clearance generator"
+  task :clearance do
+    system "cd test/rails_root && ./script/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"
+  end
+
+  desc "Run the clearance views generator"
+  task :clearance_views do
+    system "cd test/rails_root && ./script/generate clearance_views"
   end
 end
 
 desc "Run the test suite"
-task :default => ['test:all', 'test:features']
+task :default => ['test:basic', 'test:features',
+                  'test:views', 'test:features_for_views']
 
 gem_spec = Gem::Specification.new do |gem_spec|
   gem_spec.name        = "clearance"
-  gem_spec.version     = "0.6.9.3"
-  gem_spec.summary     = "Rails authentication with email & password and invitations."
+  gem_spec.version     = "0.7.0"
+  gem_spec.summary     = "Forked thoughbot/clearance. Rails authentication with email & password."
   gem_spec.email       = "matt@tonkapark.com"
-  gem_spec.homepage    = "http://github.com/tonkapark/clearance"
-  gem_spec.description = "Rails authentication with email & password and invitations."
-  gem_spec.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"]
+  gem_spec.homepage    = "http://github.com/thoughtbot/clearance"
+  gem_spec.description = "Rails authentication with email & password."
+  gem_spec.authors     = ["Matt Anderson"]
   gem_spec.files       = FileList["[A-Z]*", "{app,config,generators,lib,shoulda_macros,rails}/**/*"]
 end
 

data/TODO.textile

@@ -1,5 +1,6 @@
+h1. To-do
 
-h1. Tonka Park FORK TODO
+* Make insertion of Clearance::User into User model automatic from the generator.
+* Change generated README to include instruction about running the migration.
+* DO_NOT_REPLY, HOST refactoring.
 
-* Allow users to invite users
-* Resend invitation

data/app/controllers/clearance/confirmations_controller.rb

@@ -1,9 +1,11 @@
 class Clearance::ConfirmationsController < ApplicationController
   unloadable
 
-  before_filter :forbid_confirmed_user,    :only => [:new, :create]
-  before_filter :forbid_missing_token,     :only => [:new, :create]
-  before_filter :forbid_non_existent_user, :only => [:new, :create]
+  before_filter :redirect_signed_in_confirmed_user,  :only => [:new, :create]
+  before_filter :redirect_signed_out_confirmed_user, :only => [:new, :create]
+  before_filter :forbid_missing_token,               :only => [:new, :create]
+  before_filter :forbid_non_existent_user,           :only => [:new, :create]
+
   filter_parameter_logging :token
 
   def new
@@ -21,10 +23,19 @@ class Clearance::ConfirmationsController < ApplicationController
 
   private
 
-  def forbid_confirmed_user
+  def redirect_signed_in_confirmed_user
+    user = ::User.find_by_id(params[:user_id])
+    if user && user.email_confirmed? && current_user == user
+      flash_success_after_create
+      redirect_to(url_after_create)
+    end
+  end
+
+  def redirect_signed_out_confirmed_user
     user = ::User.find_by_id(params[:user_id])
-    if user && user.email_confirmed?
-      raise ActionController::Forbidden, "confirmed user"
+    if user && user.email_confirmed? && signed_out?
+      flash_already_confirmed
+      redirect_to(url_already_confirmed)
     end
   end
 
@@ -46,7 +57,17 @@ class Clearance::ConfirmationsController < ApplicationController
       :default => "Confirmed email and signed in.")
   end
 
+  def flash_already_confirmed
+    flash[:success] = translate(:already_confirmed_email,
+      :scope   => [:clearance, :controllers, :confirmations],
+      :default => "Already confirmed email. Please sign in.")
+  end
+
   def url_after_create
     root_url
   end
+
+  def url_already_confirmed
+    sign_in_url
+  end
 end

data/app/controllers/clearance/passwords_controller.rb

@@ -68,7 +68,7 @@ class Clearance::PasswordsController < ApplicationController
   end
 
   def url_after_create
-    signin_url
+    new_session_url
   end
 
   def flash_success_after_update

data/app/controllers/clearance/sessions_controller.rb

@@ -62,6 +62,6 @@ class Clearance::SessionsController < ApplicationController
   end
 
   def url_after_destroy
-    signin_url
+    new_session_url
   end
 end

data/app/controllers/clearance/users_controller.rb

@@ -4,9 +4,8 @@ class Clearance::UsersController < ApplicationController
   before_filter :redirect_to_root, :only => [:new, :create], :if => :signed_in?
   filter_parameter_logging :password
 
-  def new    
-    @user = ::User.new(:invitation_token => params[:invitation_token])
-    @user.email = @user.invitation.recipient_email if @user.invitation
+  def new
+    @user = ::User.new(params[:user])
     render :template => 'users/new'
   end
 
@@ -31,6 +30,6 @@ class Clearance::UsersController < ApplicationController
   end
 
   def url_after_create
-    signin_url
+    new_session_url
   end
 end

data/app/models/clearance_mailer.rb

@@ -1,22 +1,9 @@
 class ClearanceMailer < ActionMailer::Base
 
-  def self.config_file
-    File.join(RAILS_ROOT, 'config', 'clearance.yml')
-  end
-  
-  def self.config
-    YAML.load(File.read(config_file)).with_indifferent_access[RAILS_ENV]
-  end
-
-  def config
-    self.class.config
-  end
-
-  default_url_options[:host] = config[:host]
-
+  default_url_options[:host] = HOST
 
   def change_password(user)
-    from        config[:do_not_reply]
+    from       DO_NOT_REPLY
     recipients user.email
     subject    I18n.t(:change_password,
                       :scope   => [:clearance, :models, :clearance_mailer],
@@ -25,21 +12,12 @@ class ClearanceMailer < ActionMailer::Base
   end
 
   def confirmation(user)
-    from        config[:do_not_reply]
+    from       DO_NOT_REPLY
     recipients user.email
     subject    I18n.t(:confirmation,
                       :scope   => [:clearance, :models, :clearance_mailer],
                       :default => "Account confirmation")
     body      :user => user
   end
-  
-  def invitation(invitation, url)
-    subject    config[:invitation_subject_line]
-    recipients invitation.recipient_email
-    from        config[:invitation_from_email]        
-    body       :invitation => invitation, :signup_url => url
-    invitation.update_attribute(:invited_at, Time.now)
-  end
-
 
 end

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

@@ -9,17 +9,15 @@
 <% form_for(:user,
             :url => user_password_path(@user, :token    => @user.token),
             :html => { :method => :put }) do |form| %>
-  <ul>
-    <li>
-      <%= form.label :password, "Choose password" %>
-      <%= form.password_field :password, {:class => "big"} %>
-    </li>
-    <li>
-      <%= form.label :password_confirmation, "Confirm password" %>
-      <%= form.password_field :password_confirmation, {:class => "big"} %>
-    </li>
-    <li class="submit">
-      <%= form.submit "Save this password", :disable_with => "Please wait..." %>
-    </li>
-  </ul>
-<% end %>
+  <div class="password_field">
+    <%= form.label :password, "Choose password" %>
+    <%= form.password_field :password %>
+  </div>
+  <div class="password_field">
+    <%= form.label :password_confirmation, "Confirm password" %>
+    <%= form.password_field :password_confirmation %>
+  </div>
+  <div class="submit_field">
+    <%= form.submit "Save this password", :disable_with => "Please wait..." %>
+  </div>
+<% end %>

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

@@ -1,16 +1,15 @@
 <h2>Change your password</h2>
+
 <p>
   We will email you a link to change your password.
 </p>
 
 <% form_for :password, :url => passwords_path do |form| %>
-  <ul>
-    <li>
-      <%= form.label :email, "Email address" %>
-      <%= form.text_field :email, {:class => "big"} %>
-    </li>
-    <li class="submit">
-      <%= form.submit "Reset password", :disable_with => "Please wait..." %>
-    </li>
-  </ul>
-<% end %>
+  <div class="text_field">
+    <%= form.label :email, "Email address" %>
+    <%= form.text_field :email %>
+  </div>
+  <div class="submit_field">
+    <%= form.submit "Reset password", :disable_with => "Please wait..." %>
+  </div>
+<% end %>

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

@@ -1,3 +1,28 @@
 <h2>Sign in</h2>
 
-<%= render :partial => 'sessions/form' %>
+<% form_for :session, :url => session_path do |form| %>
+  <div class="text_field">
+    <%= form.label :email %>
+    <%= form.text_field :email %>  
+  </div>
+  <div class="text_field">
+    <%= form.label :password %>
+    <%= form.password_field :password %>
+  </div>
+  <div class="text_field">
+    <%= form.check_box :remember_me %>
+    <%= form.label :remember_me %>
+  </div>
+  <div class="submit_field">
+    <%= form.submit "Sign in", :disable_with => "Please wait..." %>
+  </div>
+<% end %>
+
+<ul>
+  <li>
+    <%= link_to "Sign up", sign_up_path %>
+  </li>
+  <li>
+    <%= link_to "Forgot password?", recover_password_path %>
+  </li>
+</ul>

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

@@ -0,0 +1,13 @@
+<%= form.error_messages %>
+<div class="text_field">
+  <%= form.label :email %>
+  <%= form.text_field :email %>
+</div>
+<div class="password_field">
+  <%= form.label :password %>
+  <%= form.password_field :password %>
+</div>
+<div class="password_field">
+  <%= form.label :password_confirmation, "Confirm password" %>
+  <%= form.password_field :password_confirmation %>
+</div>

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

@@ -1,4 +1,6 @@
-<h2>Signup</h2>
-
-<%= render :partial => 'users/user', :locals => {:button_name => "Create my account"} %>
+<h2>Sign up</h2>
 
+<% form_for @user do |form| %>
+  <%= render :partial => '/users/form', :object => form %>
+  <%= form.submit 'Sign up', :disable_with => 'Please wait...' %>
+<% end %>

data/clearance.gemspec

@@ -1,34 +1,19 @@
 --- !ruby/object:Gem::Specification 
 name: clearance
 version: !ruby/object:Gem::Version 
-  version: 0.6.9.3
+  version: 0.7.0
 platform: ruby
 authors: 
-- Dan Croak
-- Mike Burns
-- Jason Morrison
-- Joe Ferris
-- Eugene Bolshakov
-- Nick Quaranto
-- Josh Nichols
-- Mike Breen
-- "Marcel G\xC3\xB6rner"
-- Bence Nagy
-- Ben Mabey
-- Eloy Duran
-- Tim Pope
-- Mihai Anca
-- Mark Cornick
-- Shay Arnett
+- Matt Anderson
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-07-16 00:00:00 -05:00
+date: 2009-08-27 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
-description: Rails authentication with email & password and invitations.
+description: Rails authentication with email & password.
 email: matt@tonkapark.com
 executables: []
 
@@ -53,7 +38,6 @@ files:
 - app/controllers
 - app/controllers/clearance
 - app/controllers/clearance/confirmations_controller.rb
-- app/controllers/clearance/invitations_controller.rb
 - app/controllers/clearance/passwords_controller.rb
 - app/controllers/clearance/sessions_controller.rb
 - app/controllers/clearance/users_controller.rb
@@ -63,7 +47,6 @@ files:
 - app/views/clearance_mailer
 - app/views/clearance_mailer/change_password.html.erb
 - app/views/clearance_mailer/confirmation.html.erb
-- app/views/clearance_mailer/invitation.html.erb
 - app/views/passwords
 - app/views/passwords/edit.html.erb
 - app/views/passwords/new.html.erb
@@ -71,10 +54,7 @@ files:
 - app/views/sessions/new.html.erb
 - app/views/users
 - app/views/users/new.html.erb
-- app/views/users/_user.html.erb
-- app/views/invitations
-- app/views/invitations/new.html.erb
-- app/views/invitations/index.html.erb
+- app/views/users/_form.html.erb
 - config/clearance_routes.rb
 - generators/clearance
 - generators/clearance/clearance_generator.rb
@@ -86,11 +66,8 @@ files:
 - generators/clearance/templates/migrations
 - generators/clearance/templates/migrations/create_users.rb
 - generators/clearance/templates/migrations/update_users.rb
-- generators/clearance/templates/migrations/create_invitations.rb
-- generators/clearance/templates/migrations/update_invitations.rb
 - generators/clearance/templates/README
 - generators/clearance/templates/user.rb
-- generators/clearance/templates/invitation.rb
 - generators/clearance/USAGE
 - generators/clearance_features
 - generators/clearance_features/clearance_features_generator.rb
@@ -106,19 +83,31 @@ files:
 - generators/clearance_features/templates/features/support
 - generators/clearance_features/templates/features/support/paths.rb
 - generators/clearance_features/USAGE
+- generators/clearance_views
+- generators/clearance_views/clearance_views_generator.rb
+- generators/clearance_views/templates
+- generators/clearance_views/templates/formtastic
+- generators/clearance_views/templates/formtastic/passwords
+- generators/clearance_views/templates/formtastic/passwords/edit.html.erb
+- generators/clearance_views/templates/formtastic/passwords/new.html.erb
+- generators/clearance_views/templates/formtastic/sessions
+- generators/clearance_views/templates/formtastic/sessions/new.html.erb
+- generators/clearance_views/templates/formtastic/users
+- generators/clearance_views/templates/formtastic/users/new.html.erb
+- generators/clearance_views/templates/formtastic/users/_inputs.html.erb
+- generators/clearance_views/USAGE
 - lib/clearance
 - lib/clearance/authentication.rb
 - lib/clearance/extensions
 - lib/clearance/extensions/errors.rb
 - lib/clearance/extensions/rescue.rb
 - lib/clearance/extensions/routes.rb
-- lib/clearance/invitation.rb
 - lib/clearance/user.rb
 - lib/clearance.rb
 - shoulda_macros/clearance.rb
 - rails/init.rb
 has_rdoc: true
-homepage: http://github.com/tonkapark/clearance
+homepage: http://github.com/thoughtbot/clearance
 licenses: []
 
 post_install_message: 
@@ -144,6 +133,6 @@ rubyforge_project:
 rubygems_version: 1.3.4
 signing_key: 
 specification_version: 3
-summary: Rails authentication with email & password.
+summary: Forked thoughbot/clearance. Rails authentication with email & password.
 test_files: []