clearance 0.8.4 → 0.8.5

data/CHANGELOG.textile

@@ -1,4 +1,15 @@
-h2. 0.8.4
+h2. 0.8.5 (01/20/2009)
+
+* replaced routing hack with Clearance::Routes.draw(map) to give
+more control to the application developer. (Dan Croak)
+* removed attr_accessible from Clearance::User. (Dan Croak)
+* fixed bug in password reset feature. (Dan Croak)
+* use Jeweler for gemming. (Dan Croak)
+* remove dependency on root_path, use '/' instead. (Dan Croak)
+* use Clearance.configure block to set mailer sender instead of
+DO_NOT_REPLY constant. (Dan Croak)
+
+h2. 0.8.4 (12/08/2009)
 
 * [#48] remove unnecessary require 'factory_girl' in generator (Dan Croak)
 * reference gemcutter (not github) as the gem source in README (Dan Croak)

data/README.textile

@@ -12,30 +12,16 @@ h2. Help
 
 h2. Bugs, Patches
 
-Fork away and create a "Github Issue":http://github.com/thoughtbot/clearance/issues. Please don't send pull requests.
-
-h2. Suspenders
-
-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, representing what we think the current state-of-the-art is in Rails development.
+Fork away and create a "Github Issue":http://github.com/thoughtbot/clearance/issues.
 
 h2. Installation
 
 Clearance is a Rails engine. It works with versions of Rails greater than 2.3.
 
-In config/environment.rb:
+Install it as a gem however you like to install gems. Gem Bundler example:
 
 <pre>
-config.gem "clearance",
-  :lib     => 'clearance',
-  :source  => 'http://gemcutter.org',
-  :version => '0.8.3'
-</pre>
-
-Vendor the gem:
-
-<pre>
-rake gems:install
-rake gems:unpack
+gem "clearance"
 </pre>
 
 Make sure the development database exists and run the generator:
@@ -44,41 +30,38 @@ Make sure the development database exists and run the generator:
 script/generate clearance
 </pre>
 
-A number of files will be created and instructions will be printed.
+This:
 
-You may already have some of these files. Don't worry. You'll be asked if you want to overwrite them.
+* 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
 
-Run the migration:
+h2. Usage
 
-<pre>
-rake db:migrate
-</pre>
+If you want to authenticate users for a controller action, use the authenticate method in a before_filter.
 
-h2. If you aren't on Suspenders, you aren't done
+    class WidgetsController < ApplicationController
+      before_filter :authenticate
 
-Define a HOST constant in your environment files.
-In config/environments/test.rb and config/environments/development.rb it can be:
+      def index
+        @widgets = Widget.all
+      end
+    end
 
-<pre>
-HOST = "localhost"
-</pre>
-
-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/environment.rb:
-
-<pre>
-DO_NOT_REPLY = "donotreply@example.com"
-</pre>
+Subclass and override any Clearance-provided controller as needed:
 
-Define root_url to *something* in your config/routes.rb:
+    class SessionsController < Clearance::SessionsController
+      def url_after_create
+        new_blog_post_path
+      end
+    end
 
-<pre>
-map.root :controller => 'home'
-</pre>
+Actions that redirect (create, update, and destroy) in Clearance controllers
+can be overriden by re-defining url_after_(action) methods as seen above.
 
-h2. Cucumber Features
+h2. Optional Cucumber features
 
 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/.
 
@@ -105,7 +88,7 @@ def path_to(page_name)
 end
 </pre>
 
-h2. Formtastic views
+h2. Optional 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.
 

data/Rakefile

@@ -37,14 +37,7 @@ generators = %w(clearance clearance_features clearance_views)
 namespace :generator do
   desc "Cleans up the test app before running the generator"
   task :cleanup do
-    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
-
-    FileList["test/rails_root/db/**/*"].each do |each| 
+    FileList["test/rails_root/db/**/*"].each do |each|
       FileUtils.rm_rf(each)
     end
 
@@ -52,25 +45,21 @@ namespace :generator do
     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 clearance generator"
   task :clearance do
-    system "cd test/rails_root && ./script/generate clearance && rake db:migrate db:test:prepare"
+    system "cd test/rails_root && ./script/generate clearance -f && 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"
+    system "cd test/rails_root && ./script/generate clearance_features -f"
   end
 
   desc "Run the clearance views generator"
   task :clearance_views do
-    system "cd test/rails_root && ./script/generate clearance_views"
+    system "cd test/rails_root && ./script/generate clearance_views -f"
   end
 end
 
@@ -78,26 +67,21 @@ desc "Run the test suite"
 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.8.4"
-  gem_spec.summary     = "Rails authentication with email & password."
-  gem_spec.email       = "support@thoughtbot.com"
-  gem_spec.homepage    = "http://github.com/thoughtbot/clearance"
-  gem_spec.description = "Rails authentication with email & password."
-  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", "Jon Yurek", "Chad Pytel"]
-  gem_spec.files       = FileList["[A-Z]*", "{app,config,generators,lib,shoulda_macros,rails}/**/*"]
-end
-
-desc "Generate a gemspec file"
-task :gemspec do
-  File.open("#{gem_spec.name}.gemspec", 'w') do |f|
-    f.write gem_spec.to_yaml
-  end
+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/VERSION

@@ -0,0 +1 @@
+0.8.5

data/app/controllers/clearance/confirmations_controller.rb

@@ -66,7 +66,7 @@ class Clearance::ConfirmationsController < ApplicationController
   end
 
   def url_after_create
-    root_url
+    '/'
   end
 
   def url_already_confirmed

data/app/controllers/clearance/passwords_controller.rb

@@ -71,7 +71,7 @@ class Clearance::PasswordsController < ApplicationController
   end
 
   def url_after_create
-    new_session_url
+    sign_in_url
   end
 
   def flash_success_after_update
@@ -79,6 +79,6 @@ class Clearance::PasswordsController < ApplicationController
   end
 
   def url_after_update
-    root_url
+    '/'
   end
 end

data/app/controllers/clearance/sessions_controller.rb

@@ -22,7 +22,7 @@ class Clearance::SessionsController < ApplicationController
       else
         ::ClearanceMailer.deliver_confirmation(@user)
         flash_notice_after_create
-        redirect_to(new_session_url)
+        redirect_to(sign_in_url)
       end
     end
   end
@@ -53,7 +53,7 @@ class Clearance::SessionsController < ApplicationController
   end
 
   def url_after_create
-    root_url
+    '/'
   end
 
   def flash_success_after_destroy
@@ -61,6 +61,6 @@ class Clearance::SessionsController < ApplicationController
   end
 
   def url_after_destroy
-    new_session_url
+    sign_in_url
   end
 end

data/app/controllers/clearance/users_controller.rb

@@ -29,6 +29,6 @@ class Clearance::UsersController < ApplicationController
   end
 
   def url_after_create
-    new_session_url
+    sign_in_url
   end
 end

data/app/models/clearance_mailer.rb

@@ -1,9 +1,7 @@
 class ClearanceMailer < ActionMailer::Base
 
-  default_url_options[:host] = HOST
-
   def change_password(user)
-    from       DO_NOT_REPLY
+    from       Clearance.configuration.mailer_sender
     recipients user.email
     subject    I18n.t(:change_password,
                       :scope   => [:clearance, :models, :clearance_mailer],
@@ -12,7 +10,7 @@ class ClearanceMailer < ActionMailer::Base
   end
 
   def confirmation(user)
-    from       DO_NOT_REPLY
+    from       Clearance.configuration.mailer_sender
     recipients user.email
     subject    I18n.t(:confirmation,
                       :scope   => [:clearance, :models, :clearance_mailer],

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

@@ -16,7 +16,7 @@
 
 <ul>
   <li>
-    <%= link_to "Sign up", new_user_path %>
+    <%= link_to "Sign up", sign_up_path %>
   </li>
   <li>
     <%= link_to "Forgot password?", new_password_path %>

data/generators/clearance/clearance_generator.rb

@@ -5,6 +5,9 @@ class ClearanceGenerator < Rails::Generator::Base
 
   def manifest
     record do |m|
+      m.directory File.join("config", "initializers")
+      m.file "clearance.rb", "config/initializers/clearance.rb"
+
       m.insert_into "app/controllers/application_controller.rb",
                     "include Clearance::Authentication"
 
@@ -16,6 +19,9 @@ class ClearanceGenerator < Rails::Generator::Base
         m.file "user.rb", user_model
       end
 
+      m.insert_into "config/routes.rb",
+                    "Clearance::Routes.draw(map)"
+
       m.directory File.join("test", "factories")
       m.file "factories.rb", "test/factories/clearance.rb"
 

data/generators/clearance/lib/insert_commands.rb

@@ -10,7 +10,7 @@ Rails::Generator::Commands::Create.class_eval do
   def insert_into(file, line)
     logger.insert "#{line} into #{file}"
     unless options[:pretend] || file_contains?(file, line)
-      gsub_file file, /^(class|module) .+$/ do |match|
+      gsub_file file, /^(class|module|.*Routes).*$/ do |match|
         "#{match}\n  #{line}"
       end
     end

data/generators/clearance/templates/README

@@ -1,22 +1,24 @@
 
 *******************************************************************************
 
-Ok, enough fancy automatic stuff. Time for some old school monkey copy-pasting.
+Next:
 
-1. Define a HOST constant in your environments files.
-In config/environments/test.rb and config/environments/development.rb it can be:
+1. Configure default url options for the mailer to generate URLs in emails.
+   In production.rb it must be the actual host your application is deployed to.
+   In config/environments/test.rb and config/environments/development.rb:
 
-    HOST = "localhost"
+     config.action_mailer.default_url_options = { :host => 'localhost:3000' }
 
-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.
+2. Migrate:
 
-2. In config/environment.rb:
+     rake db:migrate
 
-    DO_NOT_REPLY = "donotreply@example.com"
+4. Make sure you're displaying flashes somewhere. For instance, in a layout:
 
-3. Define root_url to *something* in your config/routes.rb:
-
-    map.root :controller => 'home'
+    <div id="flash">
+      <% flash.each do |key, value| -%>
+        <div id="flash_<%= key %>"><%=h value %></div>
+      <% end -%>
+    </div>
 
 *******************************************************************************

data/generators/clearance/templates/clearance.rb

@@ -0,0 +1,3 @@
+Clearance.configure do |config|
+  config.mailer_sender = 'donotreply@example.com'
+end

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

@@ -48,11 +48,14 @@ end
 
 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_match /confirm/i, sent.subject
   assert !user.confirmation_token.blank?
-  assert_match /#{user.confirmation_token}/, sent.body
+  assert !ActionMailer::Base.deliveries.empty?
+  result = ActionMailer::Base.deliveries.any? do |email|
+    email.to == [user.email] &&
+    email.subject =~ /confirm/i &&
+    email.body =~ /#{user.confirmation_token}/
+  end
+  assert result
 end
 
 When /^I follow the confirmation link sent to "(.*)"$/ do |email|
@@ -63,13 +66,14 @@ end
 
 Then /^a password reset message should be sent to "(.*)"$/ do |email|
   user = User.find_by_email(email)
+  assert !user.confirmation_token.blank?
   assert !ActionMailer::Base.deliveries.empty?
-  ActionMailer::Base.deliveries.any? do |email|
-    email.to == user.email && 
+  result = ActionMailer::Base.deliveries.any? do |email|
+    email.to == [user.email] &&
     email.subject =~ /password/i &&
     email.body =~ /#{user.confirmation_token}/
   end
-  assert !user.confirmation_token.blank?
+  assert result
 end
 
 When /^I follow the password reset link sent to "(.*)"$/ do |email|
@@ -97,7 +101,7 @@ When /^I sign in as "(.*)\/(.*)"$/ do |email, password|
 end
 
 When /^I sign out$/ do
-  visit '/session', :delete
+  visit '/sign_out'
 end
 
 When /^I request password reset link to be sent to "(.*)"$/ do |email|

data/generators/clearance_features/templates/features/support/paths.rb

@@ -1,22 +1,23 @@
 module NavigationHelpers
   def path_to(page_name)
     case page_name
-    
-    when /the homepage/i
-      root_path
+
+    when /the home\s?page/
+      '/'
     when /the sign up page/i
-      new_user_path
+      sign_up_path
     when /the sign in page/i
-      new_session_path
+      sign_in_path
     when /the password reset request page/i
       new_password_path
-    
+
     # Add more page name => path mappings here
-    
+
     else
-      raise "Can't find mapping from \"#{page_name}\" to a path."
+      raise "Can't find mapping from \"#{page_name}\" to a path.\n" +
+        "Now, go and add a mapping in #{__FILE__}"
     end
   end
 end
- 
+
 World(NavigationHelpers)