clearance 1.0.0.rc2 → 1.0.0.rc3

data/lib/clearance/version.rb

@@ -1,3 +1,3 @@
 module Clearance
-  VERSION = '1.0.0.rc2'
+  VERSION = '1.0.0.rc3'
 end

data/lib/generators/clearance/install/install_generator.rb

@@ -1,46 +1,127 @@
-require 'diesel/generators/install_base'
+require 'rails/generators/base'
+require 'rails/generators/active_record'
 
 module Clearance
   module Generators
-    class InstallGenerator < Diesel::Generators::InstallBase
-      def install
-        template "clearance.rb", "config/initializers/clearance.rb"
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path('../templates', __FILE__)
 
-        inject_into_class "app/controllers/application_controller.rb", ApplicationController do
-          "  include Clearance::Authentication\n"
-        end
+      def create_clearance_initializer
+        copy_file 'clearance.rb', 'config/initializers/clearance.rb'
+      end
 
-        user_model = "app/models/user.rb"
-        if File.exists?(user_model)
-          inject_into_class user_model, User do
-            "include Clearance::User"
-          end
+      def inject_clearance_into_application_controller
+        inject_into(
+          ApplicationController,
+          'app/controllers/application_controller.rb',
+          'include Clearance::Authentication'
+        )
+      end
+
+      def create_or_inject_clearance_into_user_model
+        if File.exists? 'app/models/user.rb'
+          inject_into User, 'app/models/user.rb', 'include Clearance::User'
         else
-          template "user.rb", user_model
+          copy_file 'user.rb', 'app/models/user.rb'
         end
+      end
 
-        if File.exists?("spec")
-          template "spec/factories.rb", "spec/factories/clearance.rb"
+      def create_clearance_migration
+        if users_table_exists?
+          create_add_columns_migration
         else
-          template "spec/factories.rb", "test/factories/clearance.rb"
+          create_migration 'create_users.rb'
         end
+      end
 
-        readme "README"
+      def display_readme_in_terminal
+        readme 'README'
       end
 
       private
 
-      def migrations
-        if users_table_exists?
-          super.reject { |name| name.include?("create") } + ["db/migrate/upgrade_clearance_to_diesel.rb"]
-        else
-          super
+      def create_add_columns_migration
+        if migration_needed?
+          config = {
+            :new_columns => new_columns,
+            :new_indexes => new_indexes
+          }
+
+          create_migration('add_clearance_to_users.rb', config)
         end
       end
 
+      def create_migration(migration_name, config = {})
+        unless migration_exists?(migration_name)
+          migration_template(
+            "db/migrate/#{migration_name}",
+            "db/migrate/#{migration_name}",
+            config
+          )
+        end
+      end
+
+      def inject_into(class_name, file, text)
+        if file_does_not_contain?(file, text)
+          inject_into_class file, class_name, "  #{text}\n"
+        end
+      end
+
+      def file_does_not_contain?(file, text)
+        File.readlines(file).grep(/#{text}/).none?
+      end
+
+      def migration_needed?
+        new_columns.any? || new_indexes.any?
+      end
+
+      def new_columns
+        @new_columns ||= {
+          :email => 't.string :email',
+          :encrypted_password => 't.string :encrypted_password, :limit => 128',
+          :confirmation_token => 't.string :confirmation_token, :limit => 128',
+          :remember_token => 't.string :remember_token, :limit => 128'
+        }.reject { |column| existing_users_columns.include?(column.to_s) }
+      end
+
+      def new_indexes
+        @new_indexes ||= {
+          :index_users_on_email => 'add_index :users, :email',
+          :index_users_on_remember_token => 'add_index :users, :remember_token'
+        }.reject { |index| existing_users_indexes.include?(index.to_s) }
+      end
+
+      def migration_exists?(name)
+        existing_migrations.include?(name)
+      end
+
+      def existing_migrations
+        @existing_migrations ||= Dir.glob("db/migrate/*.rb").map do |file|
+          migration_name_without_timestamp(file)
+        end
+      end
+
+      def migration_name_without_timestamp(file)
+        file.sub(%r{^.*(db/migrate/)(?:\d+_)?}, '')
+      end
+
       def users_table_exists?
         ActiveRecord::Base.connection.table_exists?(:users)
       end
+
+      def existing_users_columns
+        ActiveRecord::Base.connection.columns(:users).map(&:name)
+      end
+
+      def existing_users_indexes
+        ActiveRecord::Base.connection.indexes(:users).map(&:name)
+      end
+
+      # for generating a timestamp when using `create_migration`
+      def self.next_migration_number(dir)
+        ActiveRecord::Generators::Base.next_migration_number(dir)
+      end
     end
   end
 end

data/lib/generators/clearance/install/templates/README

@@ -5,19 +5,26 @@ Next steps:
 
 1. Configure the mailer to create full URLs in emails:
 
-     # config/environments/{development,test}.rb
-     config.action_mailer.default_url_options = { :host => 'localhost:3000' }
+    # config/environments/{development,test}.rb
+    config.action_mailer.default_url_options = { :host => 'localhost:3000' }
 
-   In production it should be your app's domain name.
+    In production it should be your app's domain name.
 
-2. Display flashes. For example, in your application layout:
+2. Display user session and flashes. For example, in your application layout:
 
-    <% flash.each do |key, value| -%>
+    <% if signed_in? %>
+      Signed in as: <%= current_user.email %>
+      <%= link_to 'Sign out', sign_out_path, :method => :delete %>
+    <% else %>
+      <%= link_to 'Sign in', sign_in_path %>
+    <% end %>
+
+    <% flash.each do |key, value| %>
       <div class="flash <%= key %>"><%= value %></div>
-    <% end -%>
+    <% end %>
 
 3. Migrate:
 
-     rake db:migrate
+    rake db:migrate
 
 *******************************************************************************

data/lib/generators/clearance/install/templates/db/migrate/add_clearance_to_users.rb

@@ -0,0 +1,21 @@
+class AddClearanceToUsers < ActiveRecord::Migration
+  def self.up
+    change_table :users  do |t|
+<% config[:new_columns].values.each do |column| -%>
+      <%= column %>
+<% end -%>
+    end
+
+<% config[:new_indexes].values.each do |index| -%>
+    <%= index %>
+<% end -%>
+  end
+
+  def self.down
+    change_table :users do |t|
+<% if config[:new_columns].any? -%>
+      t.remove <%= new_columns.keys.map { |column| ":#{column}" }.join(',') %>
+<% end -%>
+    end
+  end
+end

data/lib/generators/clearance/install/templates/db/migrate/create_users.rb

@@ -0,0 +1,18 @@
+class CreateUsers < ActiveRecord::Migration
+  def self.up
+    create_table :users  do |t|
+      t.timestamps :null => false
+      t.string :email, :null => false
+      t.string :encrypted_password, :limit => 128, :null => false
+      t.string :confirmation_token, :limit => 128
+      t.string :remember_token, :limit => 128, :null => false
+    end
+
+    add_index :users, :email
+    add_index :users, :remember_token
+  end
+
+  def self.down
+    drop_table :users
+  end
+end

data/lib/generators/clearance/specs/USAGE

@@ -0,0 +1,5 @@
+Description:
+  Generate RSpec integration tests
+
+Examples:
+    rails generate clearance:specs

data/lib/generators/clearance/specs/specs_generator.rb

@@ -0,0 +1,13 @@
+require 'rails/generators/base'
+
+module Clearance
+  module Generators
+    class SpecsGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      def create_specs
+        directory '.', 'spec'
+      end
+    end
+  end
+end

data/lib/generators/clearance/specs/templates/factories/clearance.rb

@@ -0,0 +1,10 @@
+FactoryGirl.define do
+  sequence :email do |n|
+    "user#{n}@example.com"
+  end
+
+  factory :user do
+    email
+    password 'password'
+  end
+end

data/lib/generators/clearance/specs/templates/integration/clearance/user_signs_out_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+feature 'User signs out' do
+  scenario 'signs out' do
+    user = signed_in_user
+    sign_out
+
+    user_should_be_signed_out
+  end
+end

data/lib/generators/clearance/specs/templates/integration/clearance/visitor_resets_password_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+feature 'Visitor resets password' do
+  scenario 'with valid email' do
+    user = user_with_reset_password
+
+    page_should_display_change_password_message
+    reset_notification_should_be_sent_to user
+  end
+
+  scenario 'with non-user account' do
+    reset_password_for 'unknown.email@example.com'
+
+    page_should_display_change_password_message
+    mailer_should_have_no_deliveries
+  end
+
+  private
+
+  def reset_notification_should_be_sent_to(user)
+    user.confirmation_token.should_not be_blank
+    mailer_should_have_delivery user.email, 'password', user.confirmation_token
+  end
+
+  def page_should_display_change_password_message
+    page.should have_content('instructions for changing your password')
+  end
+end

data/lib/generators/clearance/specs/templates/integration/clearance/visitor_signs_in_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+feature 'Visitor signs in' do
+  scenario 'with valid email and password' do
+    create_user 'user@example.com', 'password'
+    sign_in_with 'user@example.com', 'password'
+
+    user_should_be_signed_in
+  end
+
+  scenario 'with valid mixed-case email and password ' do
+    create_user 'user.name@example.com', 'password'
+    sign_in_with 'User.Name@example.com', 'password'
+
+    user_should_be_signed_in
+  end
+
+  scenario 'tries with invalid password' do
+    create_user 'user@example.com', 'password'
+    sign_in_with 'user@example.com', 'wrong_password'
+
+    page_should_display_sign_in_error
+    user_should_be_signed_out
+  end
+
+  scenario 'tries with invalid email' do
+    sign_in_with 'unknown.email@example.com', 'password'
+
+    page_should_display_sign_in_error
+    user_should_be_signed_out
+  end
+
+  private
+
+  def create_user(email, password)
+    create(:user, :email => email, :password => password)
+  end
+
+  def page_should_display_sign_in_error
+    page.should have_content('Bad email or password')
+  end
+ end

data/lib/generators/clearance/specs/templates/integration/clearance/visitor_signs_up_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+feature 'Visitor signs up' do
+  scenario 'with valid email and password' do
+    sign_up_with 'valid@example.com', 'password'
+
+    user_should_be_signed_in
+  end
+
+  scenario 'tries with invalid email' do
+    sign_up_with 'invalid_email', 'password'
+
+    user_should_be_signed_out
+  end
+
+  scenario 'tries with blank password' do
+    sign_up_with 'valid@example.com', ''
+
+    user_should_be_signed_out
+  end
+end

data/lib/generators/clearance/specs/templates/integration/clearance/visitor_updates_password_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+feature 'Visitor updates password' do
+  scenario 'with valid password' do
+    user = user_with_reset_password
+    update_password user, 'newpassword'
+
+    user_should_be_signed_in
+  end
+
+  scenario 'signs in with new password' do
+    user = user_with_reset_password
+    update_password user, 'newpassword'
+    sign_out
+    sign_in_with user.email, 'newpassword'
+
+    user_should_be_signed_in
+  end
+
+  scenario 'tries with a blank password' do
+    user = user_with_reset_password
+    visit_password_reset_page_for user
+    change_password_to ''
+
+    page.should have_content("Password can't be blank")
+    user_should_be_signed_out
+  end
+
+  private
+
+  def update_password(user, password)
+    visit_password_reset_page_for user
+    change_password_to password
+  end
+
+  def visit_password_reset_page_for(user)
+    visit edit_user_password_path(
+      :user_id => user,
+      :token => user.confirmation_token
+    )
+  end
+
+  def change_password_to(password)
+    fill_in 'Choose password', :with => password
+    click_button 'Save this password'
+  end
+end

data/lib/generators/clearance/specs/templates/support/action_mailer.rb

@@ -0,0 +1,3 @@
+RSpec.configure do |config|
+  config.before(:each) { ActionMailer::Base.deliveries.clear }
+end

data/lib/generators/clearance/specs/templates/support/clearance.rb

@@ -0,0 +1 @@
+require 'clearance/testing'

data/lib/generators/clearance/specs/templates/support/factory_girl.rb

@@ -0,0 +1,5 @@
+require 'factory_girl_rails'
+
+RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods
+end

data/lib/generators/clearance/specs/templates/support/integration.rb

@@ -0,0 +1,4 @@
+RSpec.configure do |config|
+  config.include Integration::ClearanceHelpers
+  config.include Integration::ActionMailerHelpers
+end

data/lib/generators/clearance/specs/templates/support/integration/action_mailer_helpers.rb

@@ -0,0 +1,19 @@
+module Integration
+  module ActionMailerHelpers
+    def mailer_should_have_delivery(recipient, subject, body)
+      ActionMailer::Base.deliveries.should_not be_empty
+
+      message = ActionMailer::Base.deliveries.any? do |email|
+        email.to == [recipient] &&
+          email.subject =~ /#{subject}/i &&
+          email.body =~ /#{body}/
+      end
+
+      message.should be
+    end
+
+    def mailer_should_have_no_deliveries
+      ActionMailer::Base.deliveries.should be_empty
+    end
+  end
+end